[mirror_ubuntu-eoan-kernel.git] / include / linux / xattr.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
  File: linux/xattr.h

  Extended attributes handling.

  Copyright (C) 2001 by Andreas Gruenbacher <a.gruenbacher@computer.org>
  Copyright (c) 2001-2002 Silicon Graphics, Inc.  All Rights Reserved.
  Copyright (c) 2004 Red Hat, Inc., James Morris <jmorris@redhat.com>
*/
#ifndef _LINUX_XATTR_H
#define _LINUX_XATTR_H


#include <linux/slab.h>
#include <linux/types.h>
#include <linux/spinlock.h>
#include <uapi/linux/xattr.h>

struct inode;
struct dentry;

/*
 * struct xattr_handler: When @name is set, match attributes with exactly that
 * name.  When @prefix is set instead, match attributes with that prefix and
 * with a non-empty suffix.
 */
struct xattr_handler {
	const char *name;
	const char *prefix;
	int flags;      /* fs private flags */
	bool (*list)(struct dentry *dentry);
	int (*get)(const struct xattr_handler *, struct dentry *dentry,
		   struct inode *inode, const char *name, void *buffer,
		   size_t size);
	int (*set)(const struct xattr_handler *, struct dentry *dentry,
		   struct inode *inode, const char *name, const void *buffer,
		   size_t size, int flags);
};

const char *xattr_full_name(const struct xattr_handler *, const char *);

struct xattr {
	const char *name;
	void *value;
	size_t value_len;
};

ssize_t __vfs_getxattr(struct dentry *, struct inode *, const char *, void *, size_t);
ssize_t vfs_getxattr(struct dentry *, const char *, void *, size_t);
ssize_t vfs_listxattr(struct dentry *d, char *list, size_t size);
int __vfs_setxattr(struct dentry *, struct inode *, const char *, const void *, size_t, int);
int __vfs_setxattr_noperm(struct dentry *, const char *, const void *, size_t, int);
int vfs_setxattr(struct dentry *, const char *, const void *, size_t, int);
int __vfs_removexattr(struct dentry *, const char *);
int vfs_removexattr(struct dentry *, const char *);

ssize_t generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size);
ssize_t vfs_getxattr_alloc(struct dentry *dentry, const char *name,
			   char **xattr_value, size_t size, gfp_t flags);

static inline const char *xattr_prefix(const struct xattr_handler *handler)
{
	return handler->prefix ?: handler->name;
}

struct simple_xattrs {
	struct list_head head;
	spinlock_t lock;
};

struct simple_xattr {
	struct list_head list;
	char *name;
	size_t size;
	char value[0];
};

/*
 * initialize the simple_xattrs structure
 */
static inline void simple_xattrs_init(struct simple_xattrs *xattrs)
{
	INIT_LIST_HEAD(&xattrs->head);
	spin_lock_init(&xattrs->lock);
}

/*
 * free all the xattrs
 */
static inline void simple_xattrs_free(struct simple_xattrs *xattrs)
{
	struct simple_xattr *xattr, *node;

	list_for_each_entry_safe(xattr, node, &xattrs->head, list) {
		kfree(xattr->name);
		kfree(xattr);
	}
}

struct simple_xattr *simple_xattr_alloc(const void *value, size_t size);
int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
		     void *buffer, size_t size);
int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
		     const void *value, size_t size, int flags);
ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs, char *buffer,
			  size_t size);
void simple_xattr_list_add(struct simple_xattrs *xattrs,
			   struct simple_xattr *new_xattr);

#endif	/* _LINUX_XATTR_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	File: linux/xattr.h
	4
	5	Extended attributes handling.
	6
	7	Copyright (C) 2001 by Andreas Gruenbacher <a.gruenbacher@computer.org>
	8	Copyright (c) 2001-2002 Silicon Graphics, Inc. All Rights Reserved.
	9	Copyright (c) 2004 Red Hat, Inc., James Morris <jmorris@redhat.com>
	10	*/
	11	#ifndef _LINUX_XATTR_H
	12	#define _LINUX_XATTR_H
	13
1dbe3942	14
38f38657	15	#include <linux/slab.h>
1dbe3942	16	#include <linux/types.h>
38f38657	17	#include <linux/spinlock.h>
607ca46e	18	#include <uapi/linux/xattr.h>
1dbe3942	19
5b0a2075 AB	20	struct inode;
5b0a2075 AB	21	struct dentry;
1da177e4	22
98e9cb57 AG	23	/*
	24	* struct xattr_handler: When @name is set, match attributes with exactly that
	25	* name. When @prefix is set instead, match attributes with that prefix and
	26	* with a non-empty suffix.
	27	*/
1da177e4	28	struct xattr_handler {
98e9cb57	29	const char *name;
bb435453	30	const char *prefix;
e409de99	31	int flags; /* fs private flags */
764a5c6b	32	bool (list)(struct dentry dentry);
e409de99	33	int (get)(const struct xattr_handler , struct dentry *dentry,
b296821a AV	34	struct inode inode, const char name, void *buffer,
b296821a AV	35	size_t size);
e409de99	36	int (set)(const struct xattr_handler , struct dentry *dentry,
59301226 AV	37	struct inode inode, const char name, const void *buffer,
59301226 AV	38	size_t size, int flags);
1da177e4 LT	39	};
1da177e4 LT	40
e409de99 AG	41	const char xattr_full_name(const struct xattr_handler , const char *);
e409de99 AG	42
9d8f13ba	43	struct xattr {
9548906b	44	const char *name;
9d8f13ba MZ	45	void *value;
	46	size_t value_len;
	47	};
	48
5d6c3191	49	ssize_t __vfs_getxattr(struct dentry , struct inode , const char , void , size_t);
8f0cfa52	50	ssize_t vfs_getxattr(struct dentry , const char , void *, size_t);
659564c8	51	ssize_t vfs_listxattr(struct dentry d, char list, size_t size);
5d6c3191	52	int __vfs_setxattr(struct dentry , struct inode , const char , const void , size_t, int);
b1ab7e4b	53	int __vfs_setxattr_noperm(struct dentry , const char , const void *, size_t, int);
8f0cfa52	54	int vfs_setxattr(struct dentry , const char , const void *, size_t, int);
5d6c3191	55	int __vfs_removexattr(struct dentry , const char );
8f0cfa52	56	int vfs_removexattr(struct dentry , const char );
5be196e5	57
1da177e4	58	ssize_t generic_listxattr(struct dentry dentry, char buffer, size_t buffer_size);
1601fbad MZ	59	ssize_t vfs_getxattr_alloc(struct dentry dentry, const char name,
1601fbad MZ	60	char **xattr_value, size_t size, gfp_t flags);
38f38657	61
98e9cb57 AG	62	static inline const char xattr_prefix(const struct xattr_handler handler)
	63	{
	64	return handler->prefix ?: handler->name;
	65	}
	66
38f38657 AR	67	struct simple_xattrs {
	68	struct list_head head;
	69	spinlock_t lock;
	70	};
	71
	72	struct simple_xattr {
	73	struct list_head list;
	74	char *name;
	75	size_t size;
	76	char value[0];
	77	};
	78
	79	/*
	80	* initialize the simple_xattrs structure
	81	*/
	82	static inline void simple_xattrs_init(struct simple_xattrs *xattrs)
	83	{
	84	INIT_LIST_HEAD(&xattrs->head);
	85	spin_lock_init(&xattrs->lock);
	86	}
	87
	88	/*
	89	* free all the xattrs
	90	*/
	91	static inline void simple_xattrs_free(struct simple_xattrs *xattrs)
	92	{
	93	struct simple_xattr xattr, node;
	94
	95	list_for_each_entry_safe(xattr, node, &xattrs->head, list) {
	96	kfree(xattr->name);
	97	kfree(xattr);
	98	}
	99	}
	100
	101	struct simple_xattr simple_xattr_alloc(const void value, size_t size);
	102	int simple_xattr_get(struct simple_xattrs xattrs, const char name,
	103	void *buffer, size_t size);
	104	int simple_xattr_set(struct simple_xattrs xattrs, const char name,
	105	const void *value, size_t size, int flags);
786534b9 AG	106	ssize_t simple_xattr_list(struct inode inode, struct simple_xattrs xattrs, char *buffer,
786534b9 AG	107	size_t size);
38f38657 AR	108	void simple_xattr_list_add(struct simple_xattrs *xattrs,
	109	struct simple_xattr *new_xattr);
	110
1da177e4	111	#endif /* _LINUX_XATTR_H */