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 btree_trans trans;
125 struct btree_iter *iter;
126 struct bkey_s_c_xattr xattr;
129 bch2_trans_init(&trans, c, 0, 0);
131 iter = bch2_hash_lookup(&trans, bch2_xattr_hash_desc,
132 &inode->ei_str_hash, inode->v.i_ino,
133 &X_SEARCH(type, name, strlen(name)),
136 bch2_trans_exit(&trans);
137 BUG_ON(PTR_ERR(iter) == -EINTR);
139 return PTR_ERR(iter) == -ENOENT ? -ENODATA : PTR_ERR(iter);
142 xattr = bkey_s_c_to_xattr(bch2_btree_iter_peek_slot(iter));
143 ret = le16_to_cpu(xattr.v->x_val_len);
148 memcpy(buffer, xattr_val(xattr.v), ret);
151 bch2_trans_exit(&trans);
155 int bch2_xattr_set(struct btree_trans *trans, u64 inum,
156 const struct bch_hash_info *hash_info,
157 const char *name, const void *value, size_t size,
163 struct bkey_i_xattr *xattr;
164 unsigned namelen = strlen(name);
165 unsigned u64s = BKEY_U64s +
166 xattr_val_u64s(namelen, size);
171 xattr = bch2_trans_kmalloc(trans, u64s * sizeof(u64));
173 return PTR_ERR(xattr);
175 bkey_xattr_init(&xattr->k_i);
176 xattr->k.u64s = u64s;
177 xattr->v.x_type = type;
178 xattr->v.x_name_len = namelen;
179 xattr->v.x_val_len = cpu_to_le16(size);
180 memcpy(xattr->v.x_name, name, namelen);
181 memcpy(xattr_val(&xattr->v), value, size);
183 ret = bch2_hash_set(trans, bch2_xattr_hash_desc, hash_info,
185 (flags & XATTR_CREATE ? BCH_HASH_SET_MUST_CREATE : 0)|
186 (flags & XATTR_REPLACE ? BCH_HASH_SET_MUST_REPLACE : 0));
188 struct xattr_search_key search =
189 X_SEARCH(type, name, strlen(name));
191 ret = bch2_hash_delete(trans, bch2_xattr_hash_desc,
192 hash_info, inum, &search);
196 ret = flags & XATTR_REPLACE ? -ENODATA : 0;
207 static int __bch2_xattr_emit(const char *prefix,
208 const char *name, size_t name_len,
209 struct xattr_buf *buf)
211 const size_t prefix_len = strlen(prefix);
212 const size_t total_len = prefix_len + name_len + 1;
215 if (buf->used + total_len > buf->len)
218 memcpy(buf->buf + buf->used, prefix, prefix_len);
219 memcpy(buf->buf + buf->used + prefix_len,
221 buf->buf[buf->used + prefix_len + name_len] = '\0';
224 buf->used += total_len;
228 static int bch2_xattr_emit(struct dentry *dentry,
229 const struct bch_xattr *xattr,
230 struct xattr_buf *buf)
232 const struct xattr_handler *handler =
233 bch2_xattr_type_to_handler(xattr->x_type);
235 return handler && (!handler->list || handler->list(dentry))
236 ? __bch2_xattr_emit(handler->prefix ?: handler->name,
237 xattr->x_name, xattr->x_name_len, buf)
241 static int bch2_xattr_list_bcachefs(struct bch_fs *c,
242 struct bch_inode_info *inode,
243 struct xattr_buf *buf,
246 const char *prefix = all ? "bcachefs_effective." : "bcachefs.";
251 for (id = 0; id < Inode_opt_nr; id++) {
252 v = bch2_inode_opt_get(&inode->ei_inode, id);
257 !(inode->ei_inode.bi_fields_set & (1 << id)))
260 ret = __bch2_xattr_emit(prefix, bch2_inode_opts[id],
261 strlen(bch2_inode_opts[id]), buf);
269 ssize_t bch2_xattr_list(struct dentry *dentry, char *buffer, size_t buffer_size)
271 struct bch_fs *c = dentry->d_sb->s_fs_info;
272 struct bch_inode_info *inode = to_bch_ei(dentry->d_inode);
273 struct btree_trans trans;
274 struct btree_iter *iter;
276 struct xattr_buf buf = { .buf = buffer, .len = buffer_size };
277 u64 inum = dentry->d_inode->i_ino;
280 bch2_trans_init(&trans, c, 0, 0);
282 for_each_btree_key(&trans, iter, BTREE_ID_XATTRS,
283 POS(inum, 0), 0, k, ret) {
284 BUG_ON(k.k->p.inode < inum);
286 if (k.k->p.inode > inum)
289 if (k.k->type != KEY_TYPE_xattr)
292 ret = bch2_xattr_emit(dentry, bkey_s_c_to_xattr(k).v, &buf);
296 ret = bch2_trans_exit(&trans) ?: ret;
301 ret = bch2_xattr_list_bcachefs(c, inode, &buf, false);
305 ret = bch2_xattr_list_bcachefs(c, inode, &buf, true);
312 static int bch2_xattr_get_handler(const struct xattr_handler *handler,
313 struct dentry *dentry, struct inode *vinode,
314 const char *name, void *buffer, size_t size)
316 struct bch_inode_info *inode = to_bch_ei(vinode);
317 struct bch_fs *c = inode->v.i_sb->s_fs_info;
319 return bch2_xattr_get(c, inode, name, buffer, size, handler->flags);
322 static int bch2_xattr_set_handler(const struct xattr_handler *handler,
323 struct dentry *dentry, struct inode *vinode,
324 const char *name, const void *value,
325 size_t size, int flags)
327 struct bch_inode_info *inode = to_bch_ei(vinode);
328 struct bch_fs *c = inode->v.i_sb->s_fs_info;
330 return bch2_trans_do(c, NULL, &inode->ei_journal_seq, 0,
331 bch2_xattr_set(&trans, inode->v.i_ino,
334 handler->flags, flags));
337 static const struct xattr_handler bch_xattr_user_handler = {
338 .prefix = XATTR_USER_PREFIX,
339 .get = bch2_xattr_get_handler,
340 .set = bch2_xattr_set_handler,
341 .flags = KEY_TYPE_XATTR_INDEX_USER,
344 static bool bch2_xattr_trusted_list(struct dentry *dentry)
346 return capable(CAP_SYS_ADMIN);
349 static const struct xattr_handler bch_xattr_trusted_handler = {
350 .prefix = XATTR_TRUSTED_PREFIX,
351 .list = bch2_xattr_trusted_list,
352 .get = bch2_xattr_get_handler,
353 .set = bch2_xattr_set_handler,
354 .flags = KEY_TYPE_XATTR_INDEX_TRUSTED,
357 static const struct xattr_handler bch_xattr_security_handler = {
358 .prefix = XATTR_SECURITY_PREFIX,
359 .get = bch2_xattr_get_handler,
360 .set = bch2_xattr_set_handler,
361 .flags = KEY_TYPE_XATTR_INDEX_SECURITY,
364 #ifndef NO_BCACHEFS_FS
366 static int opt_to_inode_opt(int id)
369 #define x(name, ...) \
370 case Opt_##name: return Inode_opt_##name;
378 static int __bch2_xattr_bcachefs_get(const struct xattr_handler *handler,
379 struct dentry *dentry, struct inode *vinode,
380 const char *name, void *buffer, size_t size,
383 struct bch_inode_info *inode = to_bch_ei(vinode);
384 struct bch_fs *c = inode->v.i_sb->s_fs_info;
385 struct bch_opts opts =
386 bch2_inode_opts_to_opts(bch2_inode_opts_get(&inode->ei_inode));
387 const struct bch_option *opt;
388 int id, inode_opt_id;
390 struct printbuf out = PBUF(buf);
394 id = bch2_opt_lookup(name);
395 if (id < 0 || !bch2_opt_is_inode_opt(id))
398 inode_opt_id = opt_to_inode_opt(id);
399 if (inode_opt_id < 0)
402 opt = bch2_opt_table + id;
404 if (!bch2_opt_defined_by_id(&opts, id))
408 !(inode->ei_inode.bi_fields_set & (1 << inode_opt_id)))
411 v = bch2_opt_get_by_id(&opts, id);
412 bch2_opt_to_text(&out, c, opt, v, 0);
414 val_len = out.pos - buf;
416 if (buffer && val_len > size)
420 memcpy(buffer, buf, val_len);
424 static int bch2_xattr_bcachefs_get(const struct xattr_handler *handler,
425 struct dentry *dentry, struct inode *vinode,
426 const char *name, void *buffer, size_t size)
428 return __bch2_xattr_bcachefs_get(handler, dentry, vinode,
429 name, buffer, size, false);
432 struct inode_opt_set {
438 static int inode_opt_set_fn(struct bch_inode_info *inode,
439 struct bch_inode_unpacked *bi,
442 struct inode_opt_set *s = p;
445 bi->bi_fields_set |= 1U << s->id;
447 bi->bi_fields_set &= ~(1U << s->id);
449 bch2_inode_opt_set(bi, s->id, s->v);
454 static int bch2_xattr_bcachefs_set(const struct xattr_handler *handler,
455 struct dentry *dentry, struct inode *vinode,
456 const char *name, const void *value,
457 size_t size, int flags)
459 struct bch_inode_info *inode = to_bch_ei(vinode);
460 struct bch_fs *c = inode->v.i_sb->s_fs_info;
461 const struct bch_option *opt;
463 struct inode_opt_set s;
464 int opt_id, inode_opt_id, ret;
466 opt_id = bch2_opt_lookup(name);
470 opt = bch2_opt_table + opt_id;
472 inode_opt_id = opt_to_inode_opt(opt_id);
473 if (inode_opt_id < 0)
481 buf = kmalloc(size + 1, GFP_KERNEL);
484 memcpy(buf, value, size);
487 ret = bch2_opt_parse(c, opt, buf, &v);
493 ret = bch2_opt_check_may_set(c, opt_id, v);
500 if (!IS_ROOT(dentry)) {
501 struct bch_inode_info *dir =
502 to_bch_ei(d_inode(dentry->d_parent));
504 s.v = bch2_inode_opt_get(&dir->ei_inode, inode_opt_id);
512 mutex_lock(&inode->ei_update_lock);
513 if (inode_opt_id == Inode_opt_project) {
515 * inode fields accessible via the xattr interface are stored
516 * with a +1 bias, so that 0 means unset:
518 ret = bch2_set_projid(c, inode, s.v ? s.v - 1 : 0);
523 ret = bch2_write_inode(c, inode, inode_opt_set_fn, &s, 0);
525 mutex_unlock(&inode->ei_update_lock);
528 (opt_id == Opt_background_compression ||
529 opt_id == Opt_background_target))
530 bch2_rebalance_add_work(c, inode->v.i_blocks);
535 static const struct xattr_handler bch_xattr_bcachefs_handler = {
536 .prefix = "bcachefs.",
537 .get = bch2_xattr_bcachefs_get,
538 .set = bch2_xattr_bcachefs_set,
541 static int bch2_xattr_bcachefs_get_effective(
542 const struct xattr_handler *handler,
543 struct dentry *dentry, struct inode *vinode,
544 const char *name, void *buffer, size_t size)
546 return __bch2_xattr_bcachefs_get(handler, dentry, vinode,
547 name, buffer, size, true);
550 static const struct xattr_handler bch_xattr_bcachefs_effective_handler = {
551 .prefix = "bcachefs_effective.",
552 .get = bch2_xattr_bcachefs_get_effective,
553 .set = bch2_xattr_bcachefs_set,
556 #endif /* NO_BCACHEFS_FS */
558 const struct xattr_handler *bch2_xattr_handlers[] = {
559 &bch_xattr_user_handler,
560 &posix_acl_access_xattr_handler,
561 &posix_acl_default_xattr_handler,
562 &bch_xattr_trusted_handler,
563 &bch_xattr_security_handler,
564 #ifndef NO_BCACHEFS_FS
565 &bch_xattr_bcachefs_handler,
566 &bch_xattr_bcachefs_effective_handler,
571 static const struct xattr_handler *bch_xattr_handler_map[] = {
572 [KEY_TYPE_XATTR_INDEX_USER] = &bch_xattr_user_handler,
573 [KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS] =
574 &posix_acl_access_xattr_handler,
575 [KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT] =
576 &posix_acl_default_xattr_handler,
577 [KEY_TYPE_XATTR_INDEX_TRUSTED] = &bch_xattr_trusted_handler,
578 [KEY_TYPE_XATTR_INDEX_SECURITY] = &bch_xattr_security_handler,
581 static const struct xattr_handler *bch2_xattr_type_to_handler(unsigned type)
583 return type < ARRAY_SIZE(bch_xattr_handler_map)
584 ? bch_xattr_handler_map[type]