1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2007 Red Hat. All rights reserved.
6 #include <linux/init.h>
8 #include <linux/slab.h>
9 #include <linux/rwsem.h>
10 #include <linux/xattr.h>
11 #include <linux/security.h>
12 #include <linux/posix_acl_xattr.h>
13 #include <linux/iversion.h>
14 #include <linux/sched/mm.h>
18 #include "btrfs_inode.h"
19 #include "transaction.h"
24 #include "accessors.h"
27 int btrfs_getxattr(const struct inode
*inode
, const char *name
,
28 void *buffer
, size_t size
)
30 struct btrfs_dir_item
*di
;
31 struct btrfs_root
*root
= BTRFS_I(inode
)->root
;
32 struct btrfs_path
*path
;
33 struct extent_buffer
*leaf
;
35 unsigned long data_ptr
;
37 path
= btrfs_alloc_path();
41 /* lookup the xattr by name */
42 di
= btrfs_lookup_xattr(NULL
, root
, path
, btrfs_ino(BTRFS_I(inode
)),
43 name
, strlen(name
), 0);
47 } else if (IS_ERR(di
)) {
52 leaf
= path
->nodes
[0];
53 /* if size is 0, that means we want the size of the attr */
55 ret
= btrfs_dir_data_len(leaf
, di
);
59 /* now get the data out of our dir_item */
60 if (btrfs_dir_data_len(leaf
, di
) > size
) {
66 * The way things are packed into the leaf is like this
67 * |struct btrfs_dir_item|name|data|
68 * where name is the xattr name, so security.foo, and data is the
69 * content of the xattr. data_ptr points to the location in memory
70 * where the data starts in the in memory leaf
72 data_ptr
= (unsigned long)((char *)(di
+ 1) +
73 btrfs_dir_name_len(leaf
, di
));
74 read_extent_buffer(leaf
, buffer
, data_ptr
,
75 btrfs_dir_data_len(leaf
, di
));
76 ret
= btrfs_dir_data_len(leaf
, di
);
79 btrfs_free_path(path
);
83 int btrfs_setxattr(struct btrfs_trans_handle
*trans
, struct inode
*inode
,
84 const char *name
, const void *value
, size_t size
, int flags
)
86 struct btrfs_dir_item
*di
= NULL
;
87 struct btrfs_root
*root
= BTRFS_I(inode
)->root
;
88 struct btrfs_path
*path
;
89 size_t name_len
= strlen(name
);
94 if (name_len
+ size
> BTRFS_MAX_XATTR_SIZE(root
->fs_info
))
97 path
= btrfs_alloc_path();
100 path
->skip_release_on_error
= 1;
103 di
= btrfs_lookup_xattr(trans
, root
, path
,
104 btrfs_ino(BTRFS_I(inode
)), name
, name_len
, -1);
105 if (!di
&& (flags
& XATTR_REPLACE
))
110 ret
= btrfs_delete_one_dir_name(trans
, root
, path
, di
);
115 * For a replace we can't just do the insert blindly.
116 * Do a lookup first (read-only btrfs_search_slot), and return if xattr
117 * doesn't exist. If it exists, fall down below to the insert/replace
118 * path - we can't race with a concurrent xattr delete, because the VFS
119 * locks the inode's i_mutex before calling setxattr or removexattr.
121 if (flags
& XATTR_REPLACE
) {
122 btrfs_assert_inode_locked(BTRFS_I(inode
));
123 di
= btrfs_lookup_xattr(NULL
, root
, path
,
124 btrfs_ino(BTRFS_I(inode
)), name
, name_len
, 0);
131 btrfs_release_path(path
);
135 ret
= btrfs_insert_xattr_item(trans
, root
, path
, btrfs_ino(BTRFS_I(inode
)),
136 name
, name_len
, value
, size
);
137 if (ret
== -EOVERFLOW
) {
139 * We have an existing item in a leaf, split_leaf couldn't
140 * expand it. That item might have or not a dir_item that
141 * matches our target xattr, so lets check.
144 btrfs_assert_tree_write_locked(path
->nodes
[0]);
145 di
= btrfs_match_dir_item_name(path
, name
, name_len
);
146 if (!di
&& !(flags
& XATTR_REPLACE
)) {
150 } else if (ret
== -EEXIST
) {
152 di
= btrfs_match_dir_item_name(path
, name
, name_len
);
153 ASSERT(di
); /* logic error */
158 if (di
&& (flags
& XATTR_CREATE
)) {
165 * We're doing a replace, and it must be atomic, that is, at
166 * any point in time we have either the old or the new xattr
167 * value in the tree. We don't want readers (getxattr and
168 * listxattrs) to miss a value, this is specially important
171 const int slot
= path
->slots
[0];
172 struct extent_buffer
*leaf
= path
->nodes
[0];
173 const u16 old_data_len
= btrfs_dir_data_len(leaf
, di
);
174 const u32 item_size
= btrfs_item_size(leaf
, slot
);
175 const u32 data_size
= sizeof(*di
) + name_len
+ size
;
176 unsigned long data_ptr
;
179 if (size
> old_data_len
) {
180 if (btrfs_leaf_free_space(leaf
) <
181 (size
- old_data_len
)) {
187 if (old_data_len
+ name_len
+ sizeof(*di
) == item_size
) {
188 /* No other xattrs packed in the same leaf item. */
189 if (size
> old_data_len
)
190 btrfs_extend_item(trans
, path
, size
- old_data_len
);
191 else if (size
< old_data_len
)
192 btrfs_truncate_item(trans
, path
, data_size
, 1);
194 /* There are other xattrs packed in the same item. */
195 ret
= btrfs_delete_one_dir_name(trans
, root
, path
, di
);
198 btrfs_extend_item(trans
, path
, data_size
);
201 ptr
= btrfs_item_ptr(leaf
, slot
, char);
202 ptr
+= btrfs_item_size(leaf
, slot
) - data_size
;
203 di
= (struct btrfs_dir_item
*)ptr
;
204 btrfs_set_dir_data_len(leaf
, di
, size
);
205 data_ptr
= ((unsigned long)(di
+ 1)) + name_len
;
206 write_extent_buffer(leaf
, value
, data_ptr
, size
);
207 btrfs_mark_buffer_dirty(trans
, leaf
);
210 * Insert, and we had space for the xattr, so path->slots[0] is
211 * where our xattr dir_item is and btrfs_insert_xattr_item()
216 btrfs_free_path(path
);
218 set_bit(BTRFS_INODE_COPY_EVERYTHING
,
219 &BTRFS_I(inode
)->runtime_flags
);
220 clear_bit(BTRFS_INODE_NO_XATTRS
, &BTRFS_I(inode
)->runtime_flags
);
226 * @value: "" makes the attribute to empty, NULL removes it
228 int btrfs_setxattr_trans(struct inode
*inode
, const char *name
,
229 const void *value
, size_t size
, int flags
)
231 struct btrfs_root
*root
= BTRFS_I(inode
)->root
;
232 struct btrfs_trans_handle
*trans
;
233 const bool start_trans
= (current
->journal_info
== NULL
);
238 * 1 unit for inserting/updating/deleting the xattr
239 * 1 unit for the inode item update
241 trans
= btrfs_start_transaction(root
, 2);
243 return PTR_ERR(trans
);
246 * This can happen when smack is enabled and a directory is being
247 * created. It happens through d_instantiate_new(), which calls
248 * smack_d_instantiate(), which in turn calls __vfs_setxattr() to
249 * set the transmute xattr (XATTR_NAME_SMACKTRANSMUTE) on the
250 * inode. We have already reserved space for the xattr and inode
251 * update at btrfs_mkdir(), so just use the transaction handle.
252 * We don't join or start a transaction, as that will reset the
253 * block_rsv of the handle and trigger a warning for the start
256 ASSERT(strncmp(name
, XATTR_SECURITY_PREFIX
,
257 XATTR_SECURITY_PREFIX_LEN
) == 0);
258 trans
= current
->journal_info
;
261 ret
= btrfs_setxattr(trans
, inode
, name
, value
, size
, flags
);
265 inode_inc_iversion(inode
);
266 inode_set_ctime_current(inode
);
267 ret
= btrfs_update_inode(trans
, BTRFS_I(inode
));
269 btrfs_abort_transaction(trans
, ret
);
272 btrfs_end_transaction(trans
);
276 ssize_t
btrfs_listxattr(struct dentry
*dentry
, char *buffer
, size_t size
)
278 struct btrfs_key found_key
;
279 struct btrfs_key key
;
280 struct inode
*inode
= d_inode(dentry
);
281 struct btrfs_root
*root
= BTRFS_I(inode
)->root
;
282 struct btrfs_path
*path
;
285 size_t total_size
= 0, size_left
= size
;
288 * ok we want all objects associated with this id.
289 * NOTE: we set key.offset = 0; because we want to start with the
290 * first xattr that we find and walk forward
292 key
.objectid
= btrfs_ino(BTRFS_I(inode
));
293 key
.type
= BTRFS_XATTR_ITEM_KEY
;
296 path
= btrfs_alloc_path();
299 path
->reada
= READA_FORWARD
;
301 /* search for our xattrs */
302 btrfs_for_each_slot(root
, &key
, &found_key
, path
, iter_ret
) {
303 struct extent_buffer
*leaf
;
305 struct btrfs_dir_item
*di
;
309 leaf
= path
->nodes
[0];
310 slot
= path
->slots
[0];
312 /* check to make sure this item is what we want */
313 if (found_key
.objectid
!= key
.objectid
)
315 if (found_key
.type
> BTRFS_XATTR_ITEM_KEY
)
317 if (found_key
.type
< BTRFS_XATTR_ITEM_KEY
)
320 di
= btrfs_item_ptr(leaf
, slot
, struct btrfs_dir_item
);
321 item_size
= btrfs_item_size(leaf
, slot
);
323 while (cur
< item_size
) {
324 u16 name_len
= btrfs_dir_name_len(leaf
, di
);
325 u16 data_len
= btrfs_dir_data_len(leaf
, di
);
326 u32 this_len
= sizeof(*di
) + name_len
+ data_len
;
327 unsigned long name_ptr
= (unsigned long)(di
+ 1);
329 total_size
+= name_len
+ 1;
331 * We are just looking for how big our buffer needs to
337 if (!buffer
|| (name_len
+ 1) > size_left
) {
342 read_extent_buffer(leaf
, buffer
, name_ptr
, name_len
);
343 buffer
[name_len
] = '\0';
345 size_left
-= name_len
+ 1;
346 buffer
+= name_len
+ 1;
349 di
= (struct btrfs_dir_item
*)((char *)di
+ this_len
);
358 btrfs_free_path(path
);
363 static int btrfs_xattr_handler_get(const struct xattr_handler
*handler
,
364 struct dentry
*unused
, struct inode
*inode
,
365 const char *name
, void *buffer
, size_t size
)
367 name
= xattr_full_name(handler
, name
);
368 return btrfs_getxattr(inode
, name
, buffer
, size
);
371 static int btrfs_xattr_handler_set(const struct xattr_handler
*handler
,
372 struct mnt_idmap
*idmap
,
373 struct dentry
*unused
, struct inode
*inode
,
374 const char *name
, const void *buffer
,
375 size_t size
, int flags
)
377 if (btrfs_root_readonly(BTRFS_I(inode
)->root
))
380 name
= xattr_full_name(handler
, name
);
381 return btrfs_setxattr_trans(inode
, name
, buffer
, size
, flags
);
384 static int btrfs_xattr_handler_get_security(const struct xattr_handler
*handler
,
385 struct dentry
*unused
,
387 const char *name
, void *buffer
,
393 name
= xattr_full_name(handler
, name
);
396 * security.capability doesn't cache the results, so calls into us
397 * constantly to see if there's a capability xattr. Cache the result
398 * here in order to avoid wasting time doing lookups for xattrs we know
401 if (strcmp(name
, XATTR_NAME_CAPS
) == 0) {
403 if (test_bit(BTRFS_INODE_NO_CAP_XATTR
, &BTRFS_I(inode
)->runtime_flags
))
407 ret
= btrfs_getxattr(inode
, name
, buffer
, size
);
408 if (ret
== -ENODATA
&& is_cap
)
409 set_bit(BTRFS_INODE_NO_CAP_XATTR
, &BTRFS_I(inode
)->runtime_flags
);
413 static int btrfs_xattr_handler_set_security(const struct xattr_handler
*handler
,
414 struct mnt_idmap
*idmap
,
415 struct dentry
*unused
,
419 size_t size
, int flags
)
421 if (btrfs_root_readonly(BTRFS_I(inode
)->root
))
424 name
= xattr_full_name(handler
, name
);
425 if (strcmp(name
, XATTR_NAME_CAPS
) == 0)
426 clear_bit(BTRFS_INODE_NO_CAP_XATTR
, &BTRFS_I(inode
)->runtime_flags
);
428 return btrfs_setxattr_trans(inode
, name
, buffer
, size
, flags
);
431 static int btrfs_xattr_handler_set_prop(const struct xattr_handler
*handler
,
432 struct mnt_idmap
*idmap
,
433 struct dentry
*unused
, struct inode
*inode
,
434 const char *name
, const void *value
,
435 size_t size
, int flags
)
438 struct btrfs_trans_handle
*trans
;
439 struct btrfs_root
*root
= BTRFS_I(inode
)->root
;
441 name
= xattr_full_name(handler
, name
);
442 ret
= btrfs_validate_prop(BTRFS_I(inode
), name
, value
, size
);
446 if (btrfs_ignore_prop(BTRFS_I(inode
), name
))
449 trans
= btrfs_start_transaction(root
, 2);
451 return PTR_ERR(trans
);
453 ret
= btrfs_set_prop(trans
, BTRFS_I(inode
), name
, value
, size
, flags
);
455 inode_inc_iversion(inode
);
456 inode_set_ctime_current(inode
);
457 ret
= btrfs_update_inode(trans
, BTRFS_I(inode
));
459 btrfs_abort_transaction(trans
, ret
);
462 btrfs_end_transaction(trans
);
467 static const struct xattr_handler btrfs_security_xattr_handler
= {
468 .prefix
= XATTR_SECURITY_PREFIX
,
469 .get
= btrfs_xattr_handler_get_security
,
470 .set
= btrfs_xattr_handler_set_security
,
473 static const struct xattr_handler btrfs_trusted_xattr_handler
= {
474 .prefix
= XATTR_TRUSTED_PREFIX
,
475 .get
= btrfs_xattr_handler_get
,
476 .set
= btrfs_xattr_handler_set
,
479 static const struct xattr_handler btrfs_user_xattr_handler
= {
480 .prefix
= XATTR_USER_PREFIX
,
481 .get
= btrfs_xattr_handler_get
,
482 .set
= btrfs_xattr_handler_set
,
485 static const struct xattr_handler btrfs_btrfs_xattr_handler
= {
486 .prefix
= XATTR_BTRFS_PREFIX
,
487 .get
= btrfs_xattr_handler_get
,
488 .set
= btrfs_xattr_handler_set_prop
,
491 const struct xattr_handler
* const btrfs_xattr_handlers
[] = {
492 &btrfs_security_xattr_handler
,
493 &btrfs_trusted_xattr_handler
,
494 &btrfs_user_xattr_handler
,
495 &btrfs_btrfs_xattr_handler
,
499 static int btrfs_initxattrs(struct inode
*inode
,
500 const struct xattr
*xattr_array
, void *fs_private
)
502 struct btrfs_trans_handle
*trans
= fs_private
;
503 const struct xattr
*xattr
;
504 unsigned int nofs_flag
;
509 * We're holding a transaction handle, so use a NOFS memory allocation
510 * context to avoid deadlock if reclaim happens.
512 nofs_flag
= memalloc_nofs_save();
513 for (xattr
= xattr_array
; xattr
->name
!= NULL
; xattr
++) {
514 name
= kmalloc(XATTR_SECURITY_PREFIX_LEN
+
515 strlen(xattr
->name
) + 1, GFP_KERNEL
);
520 strcpy(name
, XATTR_SECURITY_PREFIX
);
521 strcpy(name
+ XATTR_SECURITY_PREFIX_LEN
, xattr
->name
);
523 if (strcmp(name
, XATTR_NAME_CAPS
) == 0)
524 clear_bit(BTRFS_INODE_NO_CAP_XATTR
, &BTRFS_I(inode
)->runtime_flags
);
526 ret
= btrfs_setxattr(trans
, inode
, name
, xattr
->value
,
527 xattr
->value_len
, 0);
532 memalloc_nofs_restore(nofs_flag
);
536 int btrfs_xattr_security_init(struct btrfs_trans_handle
*trans
,
537 struct inode
*inode
, struct inode
*dir
,
538 const struct qstr
*qstr
)
540 return security_inode_init_security(inode
, dir
, qstr
,
541 &btrfs_initxattrs
, trans
);