xattr.h 5.89 KB
Newer Older
1
/*
2
  File: fs/ext4/xattr.h
3

4
  On-disk format of extended attributes for the ext4 filesystem.
5
6
7
8
9
10
11

  (C) 2001 Andreas Gruenbacher, <a.gruenbacher@computer.org>
*/

#include <linux/xattr.h>

/* Magic value in attribute blocks */
12
#define EXT4_XATTR_MAGIC		0xEA020000
13
14

/* Maximum number of references to one attribute block */
15
#define EXT4_XATTR_REFCOUNT_MAX		1024
16
17

/* Name indexes */
18
19
20
21
22
23
24
25
#define EXT4_XATTR_INDEX_USER			1
#define EXT4_XATTR_INDEX_POSIX_ACL_ACCESS	2
#define EXT4_XATTR_INDEX_POSIX_ACL_DEFAULT	3
#define EXT4_XATTR_INDEX_TRUSTED		4
#define	EXT4_XATTR_INDEX_LUSTRE			5
#define EXT4_XATTR_INDEX_SECURITY	        6

struct ext4_xattr_header {
26
27
28
29
	__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 */
30
31
32
	__le32	h_checksum;	/* crc32c(uuid+id+xattrblock) */
				/* id = inum if refcount=1, blknum otherwise */
	__u32	h_reserved[3];	/* zero right now */
33
34
};

35
struct ext4_xattr_ibody_header {
36
37
38
	__le32	h_magic;	/* magic number for identification */
};

39
struct ext4_xattr_entry {
40
41
42
43
44
45
46
47
48
	__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 */
};

49
50
51
52
53
54
55
#define EXT4_XATTR_PAD_BITS		2
#define EXT4_XATTR_PAD		(1<<EXT4_XATTR_PAD_BITS)
#define EXT4_XATTR_ROUND		(EXT4_XATTR_PAD-1)
#define EXT4_XATTR_LEN(name_len) \
	(((name_len) + EXT4_XATTR_ROUND + \
	sizeof(struct ext4_xattr_entry)) & ~EXT4_XATTR_ROUND)
#define EXT4_XATTR_NEXT(entry) \
56
57
	((struct ext4_xattr_entry *)( \
	 (char *)(entry) + EXT4_XATTR_LEN((entry)->e_name_len)))
58
59
#define EXT4_XATTR_SIZE(size) \
	(((size) + EXT4_XATTR_ROUND) & ~EXT4_XATTR_ROUND)
60

61
62
63
64
65
66
67
#define IHDR(inode, raw_inode) \
	((struct ext4_xattr_ibody_header *) \
		((void *)raw_inode + \
		EXT4_GOOD_OLD_INODE_SIZE + \
		EXT4_I(inode)->i_extra_isize))
#define IFIRST(hdr) ((struct ext4_xattr_entry *)((hdr)+1))

Tao Ma's avatar
Tao Ma committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
#define BHDR(bh) ((struct ext4_xattr_header *)((bh)->b_data))
#define ENTRY(ptr) ((struct ext4_xattr_entry *)(ptr))
#define BFIRST(bh) ENTRY(BHDR(bh)+1)
#define IS_LAST_ENTRY(entry) (*(__u32 *)(entry) == 0)


struct ext4_xattr_info {
	int name_index;
	const char *name;
	const void *value;
	size_t value_len;
};

struct ext4_xattr_search {
	struct ext4_xattr_entry *first;
	void *base;
	void *end;
	struct ext4_xattr_entry *here;
	int not_found;
};

struct ext4_xattr_ibody_find {
	struct ext4_xattr_search s;
	struct ext4_iloc iloc;
};

Theodore Ts'o's avatar
Theodore Ts'o committed
94
# ifdef CONFIG_EXT4_FS_XATTR
95

96
97
98
99
100
extern const struct xattr_handler ext4_xattr_user_handler;
extern const struct xattr_handler ext4_xattr_trusted_handler;
extern const struct xattr_handler ext4_xattr_acl_access_handler;
extern const struct xattr_handler ext4_xattr_acl_default_handler;
extern const struct xattr_handler ext4_xattr_security_handler;
101

102
extern ssize_t ext4_listxattr(struct dentry *, char *, size_t);
103

104
105
106
extern int ext4_xattr_get(struct inode *, int, const char *, void *, size_t);
extern int ext4_xattr_set(struct inode *, int, const char *, const void *, size_t, int);
extern int ext4_xattr_set_handle(handle_t *, struct inode *, int, const char *, const void *, size_t, int);
107

108
109
extern void ext4_xattr_delete_inode(handle_t *, struct inode *);
extern void ext4_xattr_put_super(struct super_block *);
110

111
112
113
extern int ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
			    struct ext4_inode *raw_inode, handle_t *handle);

114
115
extern int __init ext4_init_xattr(void);
extern void ext4_exit_xattr(void);
116

117
extern const struct xattr_handler *ext4_xattr_handlers[];
118

Tao Ma's avatar
Tao Ma committed
119
120
121
122
123
124
125
126
127
extern int ext4_xattr_ibody_find(struct inode *inode, struct ext4_xattr_info *i,
				 struct ext4_xattr_ibody_find *is);
extern int ext4_xattr_ibody_get(struct inode *inode, int name_index,
				const char *name,
				void *buffer, size_t buffer_size);
extern int ext4_xattr_ibody_set(handle_t *handle, struct inode *inode,
				struct ext4_xattr_info *i,
				struct ext4_xattr_ibody_find *is);

Theodore Ts'o's avatar
Theodore Ts'o committed
128
# else  /* CONFIG_EXT4_FS_XATTR */
129
130

static inline int
131
ext4_xattr_get(struct inode *inode, int name_index, const char *name,
132
133
134
135
136
137
	       void *buffer, size_t size, int flags)
{
	return -EOPNOTSUPP;
}

static inline int
138
ext4_xattr_set(struct inode *inode, int name_index, const char *name,
139
140
141
142
143
144
	       const void *value, size_t size, int flags)
{
	return -EOPNOTSUPP;
}

static inline int
145
ext4_xattr_set_handle(handle_t *handle, struct inode *inode, int name_index,
146
147
148
149
150
151
	       const char *name, const void *value, size_t size, int flags)
{
	return -EOPNOTSUPP;
}

static inline void
152
ext4_xattr_delete_inode(handle_t *handle, struct inode *inode)
153
154
155
156
{
}

static inline void
157
ext4_xattr_put_super(struct super_block *sb)
158
159
160
{
}

161
static __init inline int
162
ext4_init_xattr(void)
163
164
165
166
167
{
	return 0;
}

static inline void
168
ext4_exit_xattr(void)
169
170
171
{
}

172
173
174
175
176
177
178
static inline int
ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
			    struct ext4_inode *raw_inode, handle_t *handle)
{
	return -EOPNOTSUPP;
}

179
#define ext4_xattr_handlers	NULL
180

Tao Ma's avatar
Tao Ma committed
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
static inline int
ext4_xattr_ibody_find(struct inode *inode, struct ext4_xattr_info *i,
		      struct ext4_xattr_ibody_find *is)
{
	return -EOPNOTSUPP;
}

static inline int
ext4_xattr_ibody_set(handle_t *handle, struct inode *inode,
		     struct ext4_xattr_info *i,
		     struct ext4_xattr_ibody_find *is)
{
	return -EOPNOTSUPP;
}

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

Theodore Ts'o's avatar
Theodore Ts'o committed
204
# endif  /* CONFIG_EXT4_FS_XATTR */
205

Theodore Ts'o's avatar
Theodore Ts'o committed
206
#ifdef CONFIG_EXT4_FS_SECURITY
207
extern int ext4_init_security(handle_t *handle, struct inode *inode,
208
			      struct inode *dir, const struct qstr *qstr);
209
#else
210
static inline int ext4_init_security(handle_t *handle, struct inode *inode,
211
				     struct inode *dir, const struct qstr *qstr)
212
213
214
215
{
	return 0;
}
#endif