[linux.git] / fs / ext2 / xattr.h

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

  On-disk format of extended attributes for the ext2 filesystem.

  (C) 2001 Andreas Gruenbacher, <[email protected]>
*/

#include <linux/init.h>
#include <linux/xattr.h>

/* Magic value in attribute blocks */
#define EXT2_XATTR_MAGIC		0xEA020000

/* Maximum number of references to one attribute block */
#define EXT2_XATTR_REFCOUNT_MAX		1024

/* Name indexes */
#define EXT2_XATTR_INDEX_USER			1
#define EXT2_XATTR_INDEX_POSIX_ACL_ACCESS	2
#define EXT2_XATTR_INDEX_POSIX_ACL_DEFAULT	3
#define EXT2_XATTR_INDEX_TRUSTED		4
#define	EXT2_XATTR_INDEX_LUSTRE			5
#define EXT2_XATTR_INDEX_SECURITY	        6

struct ext2_xattr_header {
	__le32	h_magic;	/* magic number for identification */
	__le32	h_refcount;	/* reference count */
	__le32	h_blocks;	/* number of disk blocks used */
	__le32	h_hash;		/* hash value of all attributes */
	__u32	h_reserved[4];	/* zero right now */
};

struct ext2_xattr_entry {
	__u8	e_name_len;	/* length of name */
	__u8	e_name_index;	/* attribute name index */
	__le16	e_value_offs;	/* offset in disk block of value */
	__le32	e_value_block;	/* disk block attribute is stored on (n/i) */
	__le32	e_value_size;	/* size of attribute value */
	__le32	e_hash;		/* hash value of name and value */
	char	e_name[0];	/* attribute name */
};

#define EXT2_XATTR_PAD_BITS		2
#define EXT2_XATTR_PAD		(1<<EXT2_XATTR_PAD_BITS)
#define EXT2_XATTR_ROUND		(EXT2_XATTR_PAD-1)
#define EXT2_XATTR_LEN(name_len) \
	(((name_len) + EXT2_XATTR_ROUND + \
	sizeof(struct ext2_xattr_entry)) & ~EXT2_XATTR_ROUND)
#define EXT2_XATTR_NEXT(entry) \
	( (struct ext2_xattr_entry *)( \
	  (char *)(entry) + EXT2_XATTR_LEN((entry)->e_name_len)) )
#define EXT2_XATTR_SIZE(size) \
	(((size) + EXT2_XATTR_ROUND) & ~EXT2_XATTR_ROUND)

struct mb_cache;

# ifdef CONFIG_EXT2_FS_XATTR

extern const struct xattr_handler ext2_xattr_user_handler;
extern const struct xattr_handler ext2_xattr_trusted_handler;
extern const struct xattr_handler ext2_xattr_security_handler;

extern ssize_t ext2_listxattr(struct dentry *, char *, size_t);

extern int ext2_xattr_get(struct inode *, int, const char *, void *, size_t);
extern int ext2_xattr_set(struct inode *, int, const char *, const void *, size_t, int);

extern void ext2_xattr_delete_inode(struct inode *);

extern struct mb_cache *ext2_xattr_create_cache(void);
extern void ext2_xattr_destroy_cache(struct mb_cache *cache);

extern const struct xattr_handler *ext2_xattr_handlers[];

# else  /* CONFIG_EXT2_FS_XATTR */

static inline int
ext2_xattr_get(struct inode *inode, int name_index,
	       const char *name, void *buffer, size_t size)
{
	return -EOPNOTSUPP;
}

static inline int
ext2_xattr_set(struct inode *inode, int name_index, const char *name,
	       const void *value, size_t size, int flags)
{
	return -EOPNOTSUPP;
}

static inline void
ext2_xattr_delete_inode(struct inode *inode)
{
}

static inline void ext2_xattr_destroy_cache(struct mb_cache *cache)
{
}

#define ext2_xattr_handlers NULL

# endif  /* CONFIG_EXT2_FS_XATTR */

#ifdef CONFIG_EXT2_FS_SECURITY
extern int ext2_init_security(struct inode *inode, struct inode *dir,
			      const struct qstr *qstr);
#else
static inline int ext2_init_security(struct inode *inode, struct inode *dir,
				     const struct qstr *qstr)
{
	return 0;
}
#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	File: linux/ext2_xattr.h
	4
	5	On-disk format of extended attributes for the ext2 filesystem.
	6
	7	(C) 2001 Andreas Gruenbacher, <[email protected]>
	8	*/
	9
1da177e4 LT	10	#include <linux/init.h>
	11	#include <linux/xattr.h>
	12
	13	/* Magic value in attribute blocks */
	14	#define EXT2_XATTR_MAGIC 0xEA020000
	15
	16	/* Maximum number of references to one attribute block */
	17	#define EXT2_XATTR_REFCOUNT_MAX 1024
	18
	19	/* Name indexes */
	20	#define EXT2_XATTR_INDEX_USER 1
	21	#define EXT2_XATTR_INDEX_POSIX_ACL_ACCESS 2
	22	#define EXT2_XATTR_INDEX_POSIX_ACL_DEFAULT 3
	23	#define EXT2_XATTR_INDEX_TRUSTED 4
	24	#define EXT2_XATTR_INDEX_LUSTRE 5
	25	#define EXT2_XATTR_INDEX_SECURITY 6
	26
	27	struct ext2_xattr_header {
	28	__le32 h_magic; /* magic number for identification */
	29	__le32 h_refcount; /* reference count */
	30	__le32 h_blocks; /* number of disk blocks used */
	31	__le32 h_hash; /* hash value of all attributes */
	32	__u32 h_reserved[4]; /* zero right now */
	33	};
	34
	35	struct ext2_xattr_entry {
	36	__u8 e_name_len; /* length of name */
	37	__u8 e_name_index; /* attribute name index */
	38	__le16 e_value_offs; /* offset in disk block of value */
	39	__le32 e_value_block; /* disk block attribute is stored on (n/i) */
	40	__le32 e_value_size; /* size of attribute value */
	41	__le32 e_hash; /* hash value of name and value */
	42	char e_name[0]; /* attribute name */
	43	};
	44
	45	#define EXT2_XATTR_PAD_BITS 2
	46	#define EXT2_XATTR_PAD (1<<EXT2_XATTR_PAD_BITS)
	47	#define EXT2_XATTR_ROUND (EXT2_XATTR_PAD-1)
	48	#define EXT2_XATTR_LEN(name_len) \
	49	(((name_len) + EXT2_XATTR_ROUND + \
	50	sizeof(struct ext2_xattr_entry)) & ~EXT2_XATTR_ROUND)
	51	#define EXT2_XATTR_NEXT(entry) \
	52	( (struct ext2_xattr_entry *)( \
	53	(char *)(entry) + EXT2_XATTR_LEN((entry)->e_name_len)) )
	54	#define EXT2_XATTR_SIZE(size) \
	55	(((size) + EXT2_XATTR_ROUND) & ~EXT2_XATTR_ROUND)
	56
7a2508e1	57	struct mb_cache;
be0726d3	58
1da177e4 LT	59	# ifdef CONFIG_EXT2_FS_XATTR
1da177e4 LT	60
749c72ef SH	61	extern const struct xattr_handler ext2_xattr_user_handler;
749c72ef SH	62	extern const struct xattr_handler ext2_xattr_trusted_handler;
749c72ef	63	extern const struct xattr_handler ext2_xattr_security_handler;
1da177e4 LT	64
	65	extern ssize_t ext2_listxattr(struct dentry , char , size_t);
	66
	67	extern int ext2_xattr_get(struct inode , int, const char , void *, size_t);
	68	extern int ext2_xattr_set(struct inode , int, const char , const void *, size_t, int);
	69
	70	extern void ext2_xattr_delete_inode(struct inode *);
1da177e4	71
7a2508e1 JK	72	extern struct mb_cache *ext2_xattr_create_cache(void);
7a2508e1 JK	73	extern void ext2_xattr_destroy_cache(struct mb_cache *cache);
1da177e4	74
749c72ef	75	extern const struct xattr_handler *ext2_xattr_handlers[];
1da177e4 LT	76
	77	# else /* CONFIG_EXT2_FS_XATTR */
	78
	79	static inline int
	80	ext2_xattr_get(struct inode *inode, int name_index,
	81	const char name, void buffer, size_t size)
	82	{
	83	return -EOPNOTSUPP;
	84	}
	85
	86	static inline int
	87	ext2_xattr_set(struct inode inode, int name_index, const char name,
	88	const void *value, size_t size, int flags)
	89	{
	90	return -EOPNOTSUPP;
	91	}
	92
	93	static inline void
	94	ext2_xattr_delete_inode(struct inode *inode)
	95	{
	96	}
	97
7a2508e1	98	static inline void ext2_xattr_destroy_cache(struct mb_cache *cache)
1da177e4 LT	99	{
	100	}
	101
	102	#define ext2_xattr_handlers NULL
	103
	104	# endif /* CONFIG_EXT2_FS_XATTR */
	105
10f47e6a	106	#ifdef CONFIG_EXT2_FS_SECURITY
2a7dba39 EP	107	extern int ext2_init_security(struct inode inode, struct inode dir,
2a7dba39 EP	108	const struct qstr *qstr);
10f47e6a	109	#else
2a7dba39 EP	110	static inline int ext2_init_security(struct inode inode, struct inode dir,
2a7dba39 EP	111	const struct qstr *qstr)
10f47e6a SS	112	{
	113	return 0;
	114	}
	115	#endif