]> Pileus Git - ~andy/linux/blob - fs/ext4/xattr.h
ext4: add journalled write support for inline data
[~andy/linux] / fs / ext4 / xattr.h
1 /*
2   File: fs/ext4/xattr.h
3
4   On-disk format of extended attributes for the ext4 filesystem.
5
6   (C) 2001 Andreas Gruenbacher, <a.gruenbacher@computer.org>
7 */
8
9 #include <linux/xattr.h>
10
11 /* 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 #define EXT4_XATTR_INDEX_USER                   1
19 #define EXT4_XATTR_INDEX_POSIX_ACL_ACCESS       2
20 #define EXT4_XATTR_INDEX_POSIX_ACL_DEFAULT      3
21 #define EXT4_XATTR_INDEX_TRUSTED                4
22 #define EXT4_XATTR_INDEX_LUSTRE                 5
23 #define EXT4_XATTR_INDEX_SECURITY               6
24 #define EXT4_XATTR_INDEX_SYSTEM                 7
25
26 struct ext4_xattr_header {
27         __le32  h_magic;        /* magic number for identification */
28         __le32  h_refcount;     /* reference count */
29         __le32  h_blocks;       /* number of disk blocks used */
30         __le32  h_hash;         /* hash value of all attributes */
31         __le32  h_checksum;     /* crc32c(uuid+id+xattrblock) */
32                                 /* id = inum if refcount=1, blknum otherwise */
33         __u32   h_reserved[3];  /* zero right now */
34 };
35
36 struct ext4_xattr_ibody_header {
37         __le32  h_magic;        /* magic number for identification */
38 };
39
40 struct ext4_xattr_entry {
41         __u8    e_name_len;     /* length of name */
42         __u8    e_name_index;   /* attribute name index */
43         __le16  e_value_offs;   /* offset in disk block of value */
44         __le32  e_value_block;  /* disk block attribute is stored on (n/i) */
45         __le32  e_value_size;   /* size of attribute value */
46         __le32  e_hash;         /* hash value of name and value */
47         char    e_name[0];      /* attribute name */
48 };
49
50 #define EXT4_XATTR_PAD_BITS             2
51 #define EXT4_XATTR_PAD          (1<<EXT4_XATTR_PAD_BITS)
52 #define EXT4_XATTR_ROUND                (EXT4_XATTR_PAD-1)
53 #define EXT4_XATTR_LEN(name_len) \
54         (((name_len) + EXT4_XATTR_ROUND + \
55         sizeof(struct ext4_xattr_entry)) & ~EXT4_XATTR_ROUND)
56 #define EXT4_XATTR_NEXT(entry) \
57         ((struct ext4_xattr_entry *)( \
58          (char *)(entry) + EXT4_XATTR_LEN((entry)->e_name_len)))
59 #define EXT4_XATTR_SIZE(size) \
60         (((size) + EXT4_XATTR_ROUND) & ~EXT4_XATTR_ROUND)
61
62 #define IHDR(inode, raw_inode) \
63         ((struct ext4_xattr_ibody_header *) \
64                 ((void *)raw_inode + \
65                 EXT4_GOOD_OLD_INODE_SIZE + \
66                 EXT4_I(inode)->i_extra_isize))
67 #define IFIRST(hdr) ((struct ext4_xattr_entry *)((hdr)+1))
68
69 #define BHDR(bh) ((struct ext4_xattr_header *)((bh)->b_data))
70 #define ENTRY(ptr) ((struct ext4_xattr_entry *)(ptr))
71 #define BFIRST(bh) ENTRY(BHDR(bh)+1)
72 #define IS_LAST_ENTRY(entry) (*(__u32 *)(entry) == 0)
73
74
75 struct ext4_xattr_info {
76         int name_index;
77         const char *name;
78         const void *value;
79         size_t value_len;
80 };
81
82 struct ext4_xattr_search {
83         struct ext4_xattr_entry *first;
84         void *base;
85         void *end;
86         struct ext4_xattr_entry *here;
87         int not_found;
88 };
89
90 struct ext4_xattr_ibody_find {
91         struct ext4_xattr_search s;
92         struct ext4_iloc iloc;
93 };
94
95 # ifdef CONFIG_EXT4_FS_XATTR
96
97 extern const struct xattr_handler ext4_xattr_user_handler;
98 extern const struct xattr_handler ext4_xattr_trusted_handler;
99 extern const struct xattr_handler ext4_xattr_acl_access_handler;
100 extern const struct xattr_handler ext4_xattr_acl_default_handler;
101 extern const struct xattr_handler ext4_xattr_security_handler;
102
103 extern ssize_t ext4_listxattr(struct dentry *, char *, size_t);
104
105 extern int ext4_xattr_get(struct inode *, int, const char *, void *, size_t);
106 extern int ext4_xattr_set(struct inode *, int, const char *, const void *, size_t, int);
107 extern int ext4_xattr_set_handle(handle_t *, struct inode *, int, const char *, const void *, size_t, int);
108
109 extern void ext4_xattr_delete_inode(handle_t *, struct inode *);
110 extern void ext4_xattr_put_super(struct super_block *);
111
112 extern int ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
113                             struct ext4_inode *raw_inode, handle_t *handle);
114
115 extern int __init ext4_init_xattr(void);
116 extern void ext4_exit_xattr(void);
117
118 extern const struct xattr_handler *ext4_xattr_handlers[];
119
120 extern int ext4_xattr_ibody_find(struct inode *inode, struct ext4_xattr_info *i,
121                                  struct ext4_xattr_ibody_find *is);
122 extern int ext4_xattr_ibody_get(struct inode *inode, int name_index,
123                                 const char *name,
124                                 void *buffer, size_t buffer_size);
125 extern int ext4_xattr_ibody_set(handle_t *handle, struct inode *inode,
126                                 struct ext4_xattr_info *i,
127                                 struct ext4_xattr_ibody_find *is);
128
129 extern int ext4_has_inline_data(struct inode *inode);
130 extern int ext4_get_inline_size(struct inode *inode);
131 extern int ext4_get_max_inline_size(struct inode *inode);
132 extern int ext4_find_inline_data_nolock(struct inode *inode);
133 extern void ext4_write_inline_data(struct inode *inode,
134                                    struct ext4_iloc *iloc,
135                                    void *buffer, loff_t pos,
136                                    unsigned int len);
137 extern int ext4_prepare_inline_data(handle_t *handle, struct inode *inode,
138                                     unsigned int len);
139 extern int ext4_init_inline_data(handle_t *handle, struct inode *inode,
140                                  unsigned int len);
141 extern int ext4_destroy_inline_data(handle_t *handle, struct inode *inode);
142
143 extern int ext4_readpage_inline(struct inode *inode, struct page *page);
144 extern int ext4_try_to_write_inline_data(struct address_space *mapping,
145                                          struct inode *inode,
146                                          loff_t pos, unsigned len,
147                                          unsigned flags,
148                                          struct page **pagep);
149 extern int ext4_write_inline_data_end(struct inode *inode,
150                                       loff_t pos, unsigned len,
151                                       unsigned copied,
152                                       struct page *page);
153 extern struct buffer_head *
154 ext4_journalled_write_inline_data(struct inode *inode,
155                                   unsigned len,
156                                   struct page *page);
157 # else  /* CONFIG_EXT4_FS_XATTR */
158
159 static inline int
160 ext4_xattr_get(struct inode *inode, int name_index, const char *name,
161                void *buffer, size_t size, int flags)
162 {
163         return -EOPNOTSUPP;
164 }
165
166 static inline int
167 ext4_xattr_set(struct inode *inode, int name_index, const char *name,
168                const void *value, size_t size, int flags)
169 {
170         return -EOPNOTSUPP;
171 }
172
173 static inline int
174 ext4_xattr_set_handle(handle_t *handle, struct inode *inode, int name_index,
175                const char *name, const void *value, size_t size, int flags)
176 {
177         return -EOPNOTSUPP;
178 }
179
180 static inline void
181 ext4_xattr_delete_inode(handle_t *handle, struct inode *inode)
182 {
183 }
184
185 static inline void
186 ext4_xattr_put_super(struct super_block *sb)
187 {
188 }
189
190 static __init inline int
191 ext4_init_xattr(void)
192 {
193         return 0;
194 }
195
196 static inline void
197 ext4_exit_xattr(void)
198 {
199 }
200
201 static inline int
202 ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
203                             struct ext4_inode *raw_inode, handle_t *handle)
204 {
205         return -EOPNOTSUPP;
206 }
207
208 #define ext4_xattr_handlers     NULL
209
210 static inline int
211 ext4_xattr_ibody_find(struct inode *inode, struct ext4_xattr_info *i,
212                       struct ext4_xattr_ibody_find *is)
213 {
214         return -EOPNOTSUPP;
215 }
216
217 static inline int
218 ext4_xattr_ibody_set(handle_t *handle, struct inode *inode,
219                      struct ext4_xattr_info *i,
220                      struct ext4_xattr_ibody_find *is)
221 {
222         return -EOPNOTSUPP;
223 }
224
225 static inline int
226 ext4_xattr_ibody_get(struct inode *inode, int name_index,
227                      const char *name,
228                      void *buffer, size_t buffer_size)
229 {
230         return -EOPNOTSUPP;
231 }
232
233 static inline int ext4_find_inline_data_nolock(struct inode *inode)
234 {
235         return 0;
236 }
237
238 static inline int ext4_has_inline_data(struct inode *inode)
239 {
240         return 0;
241 }
242
243 static inline int ext4_get_inline_size(struct inode *inode)
244 {
245         return 0;
246 }
247
248 static inline int ext4_get_max_inline_size(struct inode *inode)
249 {
250         return 0;
251 }
252
253 static inline void ext4_write_inline_data(struct inode *inode,
254                                           struct ext4_iloc *iloc,
255                                           void *buffer, loff_t pos,
256                                           unsigned int len)
257 {
258         return;
259 }
260
261 static inline int ext4_init_inline_data(handle_t *handle,
262                                         struct inode *inode,
263                                         unsigned int len)
264 {
265         return 0;
266 }
267
268 static inline int ext4_destroy_inline_data(handle_t *handle,
269                                            struct inode *inode)
270 {
271         return 0;
272 }
273
274 static inline int ext4_readpage_inline(struct inode *inode, struct page *page)
275 {
276         return 0;
277 }
278
279 static inline int ext4_try_to_write_inline_data(struct address_space *mapping,
280                                                 struct inode *inode,
281                                                 loff_t pos, unsigned len,
282                                                 unsigned flags,
283                                                 struct page **pagep)
284 {
285         return 0;
286 }
287
288 static inline int ext4_write_inline_data_end(struct inode *inode,
289                                              loff_t pos, unsigned len,
290                                              unsigned copied,
291                                              struct page *page)
292 {
293         return 0;
294 }
295
296 static inline struct buffer_head *
297 ext4_journalled_write_inline_data(struct inode *inode,
298                                   unsigned len,
299                                   struct page *page)
300 {
301         return NULL;
302 }
303 # endif  /* CONFIG_EXT4_FS_XATTR */
304
305 #ifdef CONFIG_EXT4_FS_SECURITY
306 extern int ext4_init_security(handle_t *handle, struct inode *inode,
307                               struct inode *dir, const struct qstr *qstr);
308 #else
309 static inline int ext4_init_security(handle_t *handle, struct inode *inode,
310                                      struct inode *dir, const struct qstr *qstr)
311 {
312         return 0;
313 }
314 #endif