1 // SPDX-License-Identifier: GPL-2.0
4 #include "bkey_methods.h"
5 #include "btree_update.h"
12 #include <linux/dcache.h>
13 #include <linux/posix_acl_xattr.h>
14 #include <linux/xattr.h>
16 static const struct xattr_handler *bch2_xattr_type_to_handler(unsigned);
18 static u64 bch2_xattr_hash(const struct bch_hash_info *info,
19 const struct xattr_search_key *key)
21 struct bch_str_hash_ctx ctx;
23 bch2_str_hash_init(&ctx, info);
24 bch2_str_hash_update(&ctx, info, &key->type, sizeof(key->type));
25 bch2_str_hash_update(&ctx, info, key->name.name, key->name.len);
27 return bch2_str_hash_end(&ctx, info);
30 static u64 xattr_hash_key(const struct bch_hash_info *info, const void *key)
32 return bch2_xattr_hash(info, key);
35 static u64 xattr_hash_bkey(const struct bch_hash_info *info, struct bkey_s_c k)
37 struct bkey_s_c_xattr x = bkey_s_c_to_xattr(k);
39 return bch2_xattr_hash(info,
40 &X_SEARCH(x.v->x_type, x.v->x_name, x.v->x_name_len));
43 static bool xattr_cmp_key(struct bkey_s_c _l, const void *_r)
45 struct bkey_s_c_xattr l = bkey_s_c_to_xattr(_l);
46 const struct xattr_search_key *r = _r;
48 return l.v->x_type != r->type ||
49 l.v->x_name_len != r->name.len ||
50 memcmp(l.v->x_name, r->name.name, r->name.len);
53 static bool xattr_cmp_bkey(struct bkey_s_c _l, struct bkey_s_c _r)
55 struct bkey_s_c_xattr l = bkey_s_c_to_xattr(_l);
56 struct bkey_s_c_xattr r = bkey_s_c_to_xattr(_r);
58 return l.v->x_type != r.v->x_type ||
59 l.v->x_name_len != r.v->x_name_len ||
60 memcmp(l.v->x_name, r.v->x_name, r.v->x_name_len);
63 const struct bch_hash_desc bch2_xattr_hash_desc = {
64 .btree_id = BTREE_ID_xattrs,
65 .key_type = KEY_TYPE_xattr,
66 .hash_key = xattr_hash_key,
67 .hash_bkey = xattr_hash_bkey,
68 .cmp_key = xattr_cmp_key,
69 .cmp_bkey = xattr_cmp_bkey,
72 const char *bch2_xattr_invalid(const struct bch_fs *c, struct bkey_s_c k)
74 const struct xattr_handler *handler;
75 struct bkey_s_c_xattr xattr = bkey_s_c_to_xattr(k);
77 if (bkey_val_bytes(k.k) < sizeof(struct bch_xattr))
78 return "value too small";
80 if (bkey_val_u64s(k.k) <
81 xattr_val_u64s(xattr.v->x_name_len,
82 le16_to_cpu(xattr.v->x_val_len)))
83 return "value too small";
85 if (bkey_val_u64s(k.k) >
86 xattr_val_u64s(xattr.v->x_name_len,
87 le16_to_cpu(xattr.v->x_val_len) + 4))
88 return "value too big";
90 handler = bch2_xattr_type_to_handler(xattr.v->x_type);
92 return "invalid type";
94 if (memchr(xattr.v->x_name, '\0', xattr.v->x_name_len))
95 return "xattr name has invalid characters";
100 void bch2_xattr_to_text(struct printbuf *out, struct bch_fs *c,
103 const struct xattr_handler *handler;
104 struct bkey_s_c_xattr xattr = bkey_s_c_to_xattr(k);
106 handler = bch2_xattr_type_to_handler(xattr.v->x_type);
107 if (handler && handler->prefix)
108 pr_buf(out, "%s", handler->prefix);
110 pr_buf(out, "(type %u)", xattr.v->x_type);
112 pr_buf(out, "(unknown type %u)", xattr.v->x_type);
114 bch_scnmemcpy(out, xattr.v->x_name,
115 xattr.v->x_name_len);
117 bch_scnmemcpy(out, xattr_val(xattr.v),
118 le16_to_cpu(xattr.v->x_val_len));
121 int bch2_xattr_get(struct bch_fs *c, struct bch_inode_info *inode,
122 const char *name, void *buffer, size_t size, int type)
124 struct bch_hash_info hash = bch2_hash_info_init(c, &inode->ei_inode);
125 struct btree_trans trans;
126 struct btree_iter *iter;
127 struct bkey_s_c_xattr xattr;
130 bch2_trans_init(&trans, c, 0, 0);
132 iter = bch2_hash_lookup(&trans, bch2_xattr_hash_desc, &hash,
134 &X_SEARCH(type, name, strlen(name)),
136 ret = PTR_ERR_OR_ZERO(iter);
140 xattr = bkey_s_c_to_xattr(bch2_btree_iter_peek_slot(iter));
141 ret = le16_to_cpu(xattr.v->x_val_len);
146 memcpy(buffer, xattr_val(xattr.v), ret);
148 bch2_trans_iter_put(&trans, iter);
150 bch2_trans_exit(&trans);
152 BUG_ON(ret == -EINTR);
153 return ret == -ENOENT ? -ENODATA : ret;
156 int bch2_xattr_set(struct btree_trans *trans, u64 inum,
157 const struct bch_hash_info *hash_info,
158 const char *name, const void *value, size_t size,
164 struct bkey_i_xattr *xattr;
165 unsigned namelen = strlen(name);
166 unsigned u64s = BKEY_U64s +
167 xattr_val_u64s(namelen, size);
172 xattr = bch2_trans_kmalloc(trans, u64s * sizeof(u64));
174 return PTR_ERR(xattr);
176 bkey_xattr_init(&xattr->k_i);
177 xattr->k.u64s = u64s;
178 xattr->v.x_type = type;
179 xattr->v.x_name_len = namelen;
180 xattr->v.x_val_len = cpu_to_le16(size);
181 memcpy(xattr->v.x_name, name, namelen);
182 memcpy(xattr_val(&xattr->v), value, size);
184 ret = bch2_hash_set(trans, bch2_xattr_hash_desc, hash_info,
186 (flags & XATTR_CREATE ? BCH_HASH_SET_MUST_CREATE : 0)|
187 (flags & XATTR_REPLACE ? BCH_HASH_SET_MUST_REPLACE : 0));
189 struct xattr_search_key search =
190 X_SEARCH(type, name, strlen(name));
192 ret = bch2_hash_delete(trans, bch2_xattr_hash_desc,
193 hash_info, inum, &search);
197 ret = flags & XATTR_REPLACE ? -ENODATA : 0;
208 static int __bch2_xattr_emit(const char *prefix,
209 const char *name, size_t name_len,
210 struct xattr_buf *buf)
212 const size_t prefix_len = strlen(prefix);
213 const size_t total_len = prefix_len + name_len + 1;
216 if (buf->used + total_len > buf->len)
219 memcpy(buf->buf + buf->used, prefix, prefix_len);
220 memcpy(buf->buf + buf->used + prefix_len,
222 buf->buf[buf->used + prefix_len + name_len] = '\0';
225 buf->used += total_len;
229 static int bch2_xattr_emit(struct dentry *dentry,
230 const struct bch_xattr *xattr,
231 struct xattr_buf *buf)
233 const struct xattr_handler *handler =
234 bch2_xattr_type_to_handler(xattr->x_type);
236 return handler && (!handler->list || handler->list(dentry))
237 ? __bch2_xattr_emit(handler->prefix ?: handler->name,
238 xattr->x_name, xattr->x_name_len, buf)
242 static int bch2_xattr_list_bcachefs(struct bch_fs *c,
243 struct bch_inode_unpacked *inode,
244 struct xattr_buf *buf,
247 const char *prefix = all ? "bcachefs_effective." : "bcachefs.";
252 for (id = 0; id < Inode_opt_nr; id++) {
253 v = bch2_inode_opt_get(inode, id);
258 !(inode->bi_fields_set & (1 << id)))
261 ret = __bch2_xattr_emit(prefix, bch2_inode_opts[id],
262 strlen(bch2_inode_opts[id]), buf);
270 ssize_t bch2_xattr_list(struct dentry *dentry, char *buffer, size_t buffer_size)
272 struct bch_fs *c = dentry->d_sb->s_fs_info;
273 struct bch_inode_info *inode = to_bch_ei(dentry->d_inode);
274 struct btree_trans trans;
275 struct btree_iter *iter;
277 struct xattr_buf buf = { .buf = buffer, .len = buffer_size };
278 u64 inum = dentry->d_inode->i_ino;
281 bch2_trans_init(&trans, c, 0, 0);
283 for_each_btree_key(&trans, iter, BTREE_ID_xattrs,
284 POS(inum, 0), 0, k, ret) {
285 BUG_ON(k.k->p.inode < inum);
287 if (k.k->p.inode > inum)
290 if (k.k->type != KEY_TYPE_xattr)
293 ret = bch2_xattr_emit(dentry, bkey_s_c_to_xattr(k).v, &buf);
297 bch2_trans_iter_put(&trans, iter);
299 ret = bch2_trans_exit(&trans) ?: ret;
304 ret = bch2_xattr_list_bcachefs(c, &inode->ei_inode, &buf, false);
308 ret = bch2_xattr_list_bcachefs(c, &inode->ei_inode, &buf, true);
315 static int bch2_xattr_get_handler(const struct xattr_handler *handler,
316 struct dentry *dentry, struct inode *vinode,
317 const char *name, void *buffer, size_t size)
319 struct bch_inode_info *inode = to_bch_ei(vinode);
320 struct bch_fs *c = inode->v.i_sb->s_fs_info;
322 return bch2_xattr_get(c, inode, name, buffer, size, handler->flags);
325 static int bch2_xattr_set_handler(const struct xattr_handler *handler,
326 struct user_namespace *mnt_userns,
327 struct dentry *dentry, struct inode *vinode,
328 const char *name, const void *value,
329 size_t size, int flags)
331 struct bch_inode_info *inode = to_bch_ei(vinode);
332 struct bch_fs *c = inode->v.i_sb->s_fs_info;
333 struct bch_hash_info hash = bch2_hash_info_init(c, &inode->ei_inode);
335 return bch2_trans_do(c, NULL, &inode->ei_journal_seq, 0,
336 bch2_xattr_set(&trans, inode->v.i_ino, &hash,
338 handler->flags, flags));
341 static const struct xattr_handler bch_xattr_user_handler = {
342 .prefix = XATTR_USER_PREFIX,
343 .get = bch2_xattr_get_handler,
344 .set = bch2_xattr_set_handler,
345 .flags = KEY_TYPE_XATTR_INDEX_USER,
348 static bool bch2_xattr_trusted_list(struct dentry *dentry)
350 return capable(CAP_SYS_ADMIN);
353 static const struct xattr_handler bch_xattr_trusted_handler = {
354 .prefix = XATTR_TRUSTED_PREFIX,
355 .list = bch2_xattr_trusted_list,
356 .get = bch2_xattr_get_handler,
357 .set = bch2_xattr_set_handler,
358 .flags = KEY_TYPE_XATTR_INDEX_TRUSTED,
361 static const struct xattr_handler bch_xattr_security_handler = {
362 .prefix = XATTR_SECURITY_PREFIX,
363 .get = bch2_xattr_get_handler,
364 .set = bch2_xattr_set_handler,
365 .flags = KEY_TYPE_XATTR_INDEX_SECURITY,
368 #ifndef NO_BCACHEFS_FS
370 static int opt_to_inode_opt(int id)
373 #define x(name, ...) \
374 case Opt_##name: return Inode_opt_##name;
382 static int __bch2_xattr_bcachefs_get(const struct xattr_handler *handler,
383 struct dentry *dentry, struct inode *vinode,
384 const char *name, void *buffer, size_t size,
387 struct bch_inode_info *inode = to_bch_ei(vinode);
388 struct bch_fs *c = inode->v.i_sb->s_fs_info;
389 struct bch_opts opts =
390 bch2_inode_opts_to_opts(bch2_inode_opts_get(&inode->ei_inode));
391 const struct bch_option *opt;
392 int id, inode_opt_id;
394 struct printbuf out = PBUF(buf);
398 id = bch2_opt_lookup(name);
399 if (id < 0 || !bch2_opt_is_inode_opt(id))
402 inode_opt_id = opt_to_inode_opt(id);
403 if (inode_opt_id < 0)
406 opt = bch2_opt_table + id;
408 if (!bch2_opt_defined_by_id(&opts, id))
412 !(inode->ei_inode.bi_fields_set & (1 << inode_opt_id)))
415 v = bch2_opt_get_by_id(&opts, id);
416 bch2_opt_to_text(&out, c, opt, v, 0);
418 val_len = out.pos - buf;
420 if (buffer && val_len > size)
424 memcpy(buffer, buf, val_len);
428 static int bch2_xattr_bcachefs_get(const struct xattr_handler *handler,
429 struct dentry *dentry, struct inode *vinode,
430 const char *name, void *buffer, size_t size)
432 return __bch2_xattr_bcachefs_get(handler, dentry, vinode,
433 name, buffer, size, false);
436 struct inode_opt_set {
442 static int inode_opt_set_fn(struct bch_inode_info *inode,
443 struct bch_inode_unpacked *bi,
446 struct inode_opt_set *s = p;
449 bi->bi_fields_set |= 1U << s->id;
451 bi->bi_fields_set &= ~(1U << s->id);
453 bch2_inode_opt_set(bi, s->id, s->v);
458 static int bch2_xattr_bcachefs_set(const struct xattr_handler *handler,
459 struct user_namespace *mnt_userns,
460 struct dentry *dentry, struct inode *vinode,
461 const char *name, const void *value,
462 size_t size, int flags)
464 struct bch_inode_info *inode = to_bch_ei(vinode);
465 struct bch_fs *c = inode->v.i_sb->s_fs_info;
466 const struct bch_option *opt;
468 struct inode_opt_set s;
469 int opt_id, inode_opt_id, ret;
471 opt_id = bch2_opt_lookup(name);
475 opt = bch2_opt_table + opt_id;
477 inode_opt_id = opt_to_inode_opt(opt_id);
478 if (inode_opt_id < 0)
486 buf = kmalloc(size + 1, GFP_KERNEL);
489 memcpy(buf, value, size);
492 ret = bch2_opt_parse(c, opt, buf, &v);
498 ret = bch2_opt_check_may_set(c, opt_id, v);
505 if (!IS_ROOT(dentry)) {
506 struct bch_inode_info *dir =
507 to_bch_ei(d_inode(dentry->d_parent));
509 s.v = bch2_inode_opt_get(&dir->ei_inode, inode_opt_id);
517 mutex_lock(&inode->ei_update_lock);
518 if (inode_opt_id == Inode_opt_project) {
520 * inode fields accessible via the xattr interface are stored
521 * with a +1 bias, so that 0 means unset:
523 ret = bch2_set_projid(c, inode, s.v ? s.v - 1 : 0);
528 ret = bch2_write_inode(c, inode, inode_opt_set_fn, &s, 0);
530 mutex_unlock(&inode->ei_update_lock);
533 (opt_id == Opt_background_compression ||
534 opt_id == Opt_background_target))
535 bch2_rebalance_add_work(c, inode->v.i_blocks);
540 static const struct xattr_handler bch_xattr_bcachefs_handler = {
541 .prefix = "bcachefs.",
542 .get = bch2_xattr_bcachefs_get,
543 .set = bch2_xattr_bcachefs_set,
546 static int bch2_xattr_bcachefs_get_effective(
547 const struct xattr_handler *handler,
548 struct dentry *dentry, struct inode *vinode,
549 const char *name, void *buffer, size_t size)
551 return __bch2_xattr_bcachefs_get(handler, dentry, vinode,
552 name, buffer, size, true);
555 static const struct xattr_handler bch_xattr_bcachefs_effective_handler = {
556 .prefix = "bcachefs_effective.",
557 .get = bch2_xattr_bcachefs_get_effective,
558 .set = bch2_xattr_bcachefs_set,
561 #endif /* NO_BCACHEFS_FS */
563 const struct xattr_handler *bch2_xattr_handlers[] = {
564 &bch_xattr_user_handler,
565 #ifdef CONFIG_BCACHEFS_POSIX_ACL
566 &posix_acl_access_xattr_handler,
567 &posix_acl_default_xattr_handler,
569 &bch_xattr_trusted_handler,
570 &bch_xattr_security_handler,
571 #ifndef NO_BCACHEFS_FS
572 &bch_xattr_bcachefs_handler,
573 &bch_xattr_bcachefs_effective_handler,
578 static const struct xattr_handler *bch_xattr_handler_map[] = {
579 [KEY_TYPE_XATTR_INDEX_USER] = &bch_xattr_user_handler,
580 [KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS] =
581 &posix_acl_access_xattr_handler,
582 [KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT] =
583 &posix_acl_default_xattr_handler,
584 [KEY_TYPE_XATTR_INDEX_TRUSTED] = &bch_xattr_trusted_handler,
585 [KEY_TYPE_XATTR_INDEX_SECURITY] = &bch_xattr_security_handler,
588 static const struct xattr_handler *bch2_xattr_type_to_handler(unsigned type)
590 return type < ARRAY_SIZE(bch_xattr_handler_map)
591 ? bch_xattr_handler_map[type]