]> git.ipfire.org Git - thirdparty/kernel/stable.git/blob - fs/bcachefs/xattr.c
KVM: clean up directives to compile out irqfds
[thirdparty/kernel/stable.git] / fs / bcachefs / xattr.c
1 // SPDX-License-Identifier: GPL-2.0
2
3 #include "bcachefs.h"
4 #include "acl.h"
5 #include "bkey_methods.h"
6 #include "btree_update.h"
7 #include "extents.h"
8 #include "fs.h"
9 #include "rebalance.h"
10 #include "str_hash.h"
11 #include "xattr.h"
12
13 #include <linux/dcache.h>
14 #include <linux/posix_acl_xattr.h>
15 #include <linux/xattr.h>
16
17 static const struct xattr_handler *bch2_xattr_type_to_handler(unsigned);
18
19 static u64 bch2_xattr_hash(const struct bch_hash_info *info,
20 const struct xattr_search_key *key)
21 {
22 struct bch_str_hash_ctx ctx;
23
24 bch2_str_hash_init(&ctx, info);
25 bch2_str_hash_update(&ctx, info, &key->type, sizeof(key->type));
26 bch2_str_hash_update(&ctx, info, key->name.name, key->name.len);
27
28 return bch2_str_hash_end(&ctx, info);
29 }
30
31 static u64 xattr_hash_key(const struct bch_hash_info *info, const void *key)
32 {
33 return bch2_xattr_hash(info, key);
34 }
35
36 static u64 xattr_hash_bkey(const struct bch_hash_info *info, struct bkey_s_c k)
37 {
38 struct bkey_s_c_xattr x = bkey_s_c_to_xattr(k);
39
40 return bch2_xattr_hash(info,
41 &X_SEARCH(x.v->x_type, x.v->x_name, x.v->x_name_len));
42 }
43
44 static bool xattr_cmp_key(struct bkey_s_c _l, const void *_r)
45 {
46 struct bkey_s_c_xattr l = bkey_s_c_to_xattr(_l);
47 const struct xattr_search_key *r = _r;
48
49 return l.v->x_type != r->type ||
50 l.v->x_name_len != r->name.len ||
51 memcmp(l.v->x_name, r->name.name, r->name.len);
52 }
53
54 static bool xattr_cmp_bkey(struct bkey_s_c _l, struct bkey_s_c _r)
55 {
56 struct bkey_s_c_xattr l = bkey_s_c_to_xattr(_l);
57 struct bkey_s_c_xattr r = bkey_s_c_to_xattr(_r);
58
59 return l.v->x_type != r.v->x_type ||
60 l.v->x_name_len != r.v->x_name_len ||
61 memcmp(l.v->x_name, r.v->x_name, r.v->x_name_len);
62 }
63
64 const struct bch_hash_desc bch2_xattr_hash_desc = {
65 .btree_id = BTREE_ID_xattrs,
66 .key_type = KEY_TYPE_xattr,
67 .hash_key = xattr_hash_key,
68 .hash_bkey = xattr_hash_bkey,
69 .cmp_key = xattr_cmp_key,
70 .cmp_bkey = xattr_cmp_bkey,
71 };
72
73 int bch2_xattr_invalid(struct bch_fs *c, struct bkey_s_c k,
74 enum bkey_invalid_flags flags,
75 struct printbuf *err)
76 {
77 struct bkey_s_c_xattr xattr = bkey_s_c_to_xattr(k);
78 unsigned val_u64s = xattr_val_u64s(xattr.v->x_name_len,
79 le16_to_cpu(xattr.v->x_val_len));
80 int ret = 0;
81
82 bkey_fsck_err_on(bkey_val_u64s(k.k) < val_u64s, c, err,
83 xattr_val_size_too_small,
84 "value too small (%zu < %u)",
85 bkey_val_u64s(k.k), val_u64s);
86
87 /* XXX why +4 ? */
88 val_u64s = xattr_val_u64s(xattr.v->x_name_len,
89 le16_to_cpu(xattr.v->x_val_len) + 4);
90
91 bkey_fsck_err_on(bkey_val_u64s(k.k) > val_u64s, c, err,
92 xattr_val_size_too_big,
93 "value too big (%zu > %u)",
94 bkey_val_u64s(k.k), val_u64s);
95
96 bkey_fsck_err_on(!bch2_xattr_type_to_handler(xattr.v->x_type), c, err,
97 xattr_invalid_type,
98 "invalid type (%u)", xattr.v->x_type);
99
100 bkey_fsck_err_on(memchr(xattr.v->x_name, '\0', xattr.v->x_name_len), c, err,
101 xattr_name_invalid_chars,
102 "xattr name has invalid characters");
103 fsck_err:
104 return ret;
105 }
106
107 void bch2_xattr_to_text(struct printbuf *out, struct bch_fs *c,
108 struct bkey_s_c k)
109 {
110 const struct xattr_handler *handler;
111 struct bkey_s_c_xattr xattr = bkey_s_c_to_xattr(k);
112
113 handler = bch2_xattr_type_to_handler(xattr.v->x_type);
114 if (handler && handler->prefix)
115 prt_printf(out, "%s", handler->prefix);
116 else if (handler)
117 prt_printf(out, "(type %u)", xattr.v->x_type);
118 else
119 prt_printf(out, "(unknown type %u)", xattr.v->x_type);
120
121 prt_printf(out, "%.*s:%.*s",
122 xattr.v->x_name_len,
123 xattr.v->x_name,
124 le16_to_cpu(xattr.v->x_val_len),
125 (char *) xattr_val(xattr.v));
126
127 if (xattr.v->x_type == KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS ||
128 xattr.v->x_type == KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT) {
129 prt_char(out, ' ');
130 bch2_acl_to_text(out, xattr_val(xattr.v),
131 le16_to_cpu(xattr.v->x_val_len));
132 }
133 }
134
135 static int bch2_xattr_get_trans(struct btree_trans *trans, struct bch_inode_info *inode,
136 const char *name, void *buffer, size_t size, int type)
137 {
138 struct bch_hash_info hash = bch2_hash_info_init(trans->c, &inode->ei_inode);
139 struct xattr_search_key search = X_SEARCH(type, name, strlen(name));
140 struct btree_iter iter;
141 struct bkey_s_c_xattr xattr;
142 struct bkey_s_c k;
143 int ret;
144
145 ret = bch2_hash_lookup(trans, &iter, bch2_xattr_hash_desc, &hash,
146 inode_inum(inode), &search, 0);
147 if (ret)
148 goto err1;
149
150 k = bch2_btree_iter_peek_slot(&iter);
151 ret = bkey_err(k);
152 if (ret)
153 goto err2;
154
155 xattr = bkey_s_c_to_xattr(k);
156 ret = le16_to_cpu(xattr.v->x_val_len);
157 if (buffer) {
158 if (ret > size)
159 ret = -ERANGE;
160 else
161 memcpy(buffer, xattr_val(xattr.v), ret);
162 }
163 err2:
164 bch2_trans_iter_exit(trans, &iter);
165 err1:
166 return ret < 0 && bch2_err_matches(ret, ENOENT) ? -ENODATA : ret;
167 }
168
169 int bch2_xattr_set(struct btree_trans *trans, subvol_inum inum,
170 struct bch_inode_unpacked *inode_u,
171 const struct bch_hash_info *hash_info,
172 const char *name, const void *value, size_t size,
173 int type, int flags)
174 {
175 struct bch_fs *c = trans->c;
176 struct btree_iter inode_iter = { NULL };
177 int ret;
178
179 ret = bch2_inode_peek(trans, &inode_iter, inode_u, inum, BTREE_ITER_INTENT);
180 if (ret)
181 return ret;
182
183 inode_u->bi_ctime = bch2_current_time(c);
184
185 ret = bch2_inode_write(trans, &inode_iter, inode_u);
186 bch2_trans_iter_exit(trans, &inode_iter);
187
188 if (ret)
189 return ret;
190
191 if (value) {
192 struct bkey_i_xattr *xattr;
193 unsigned namelen = strlen(name);
194 unsigned u64s = BKEY_U64s +
195 xattr_val_u64s(namelen, size);
196
197 if (u64s > U8_MAX)
198 return -ERANGE;
199
200 xattr = bch2_trans_kmalloc(trans, u64s * sizeof(u64));
201 if (IS_ERR(xattr))
202 return PTR_ERR(xattr);
203
204 bkey_xattr_init(&xattr->k_i);
205 xattr->k.u64s = u64s;
206 xattr->v.x_type = type;
207 xattr->v.x_name_len = namelen;
208 xattr->v.x_val_len = cpu_to_le16(size);
209 memcpy(xattr->v.x_name, name, namelen);
210 memcpy(xattr_val(&xattr->v), value, size);
211
212 ret = bch2_hash_set(trans, bch2_xattr_hash_desc, hash_info,
213 inum, &xattr->k_i,
214 (flags & XATTR_CREATE ? BCH_HASH_SET_MUST_CREATE : 0)|
215 (flags & XATTR_REPLACE ? BCH_HASH_SET_MUST_REPLACE : 0));
216 } else {
217 struct xattr_search_key search =
218 X_SEARCH(type, name, strlen(name));
219
220 ret = bch2_hash_delete(trans, bch2_xattr_hash_desc,
221 hash_info, inum, &search);
222 }
223
224 if (bch2_err_matches(ret, ENOENT))
225 ret = flags & XATTR_REPLACE ? -ENODATA : 0;
226
227 return ret;
228 }
229
230 struct xattr_buf {
231 char *buf;
232 size_t len;
233 size_t used;
234 };
235
236 static int __bch2_xattr_emit(const char *prefix,
237 const char *name, size_t name_len,
238 struct xattr_buf *buf)
239 {
240 const size_t prefix_len = strlen(prefix);
241 const size_t total_len = prefix_len + name_len + 1;
242
243 if (buf->buf) {
244 if (buf->used + total_len > buf->len)
245 return -ERANGE;
246
247 memcpy(buf->buf + buf->used, prefix, prefix_len);
248 memcpy(buf->buf + buf->used + prefix_len,
249 name, name_len);
250 buf->buf[buf->used + prefix_len + name_len] = '\0';
251 }
252
253 buf->used += total_len;
254 return 0;
255 }
256
257 static int bch2_xattr_emit(struct dentry *dentry,
258 const struct bch_xattr *xattr,
259 struct xattr_buf *buf)
260 {
261 const struct xattr_handler *handler =
262 bch2_xattr_type_to_handler(xattr->x_type);
263
264 return handler && (!handler->list || handler->list(dentry))
265 ? __bch2_xattr_emit(handler->prefix ?: handler->name,
266 xattr->x_name, xattr->x_name_len, buf)
267 : 0;
268 }
269
270 static int bch2_xattr_list_bcachefs(struct bch_fs *c,
271 struct bch_inode_unpacked *inode,
272 struct xattr_buf *buf,
273 bool all)
274 {
275 const char *prefix = all ? "bcachefs_effective." : "bcachefs.";
276 unsigned id;
277 int ret = 0;
278 u64 v;
279
280 for (id = 0; id < Inode_opt_nr; id++) {
281 v = bch2_inode_opt_get(inode, id);
282 if (!v)
283 continue;
284
285 if (!all &&
286 !(inode->bi_fields_set & (1 << id)))
287 continue;
288
289 ret = __bch2_xattr_emit(prefix, bch2_inode_opts[id],
290 strlen(bch2_inode_opts[id]), buf);
291 if (ret)
292 break;
293 }
294
295 return ret;
296 }
297
298 ssize_t bch2_xattr_list(struct dentry *dentry, char *buffer, size_t buffer_size)
299 {
300 struct bch_fs *c = dentry->d_sb->s_fs_info;
301 struct bch_inode_info *inode = to_bch_ei(dentry->d_inode);
302 struct btree_trans *trans = bch2_trans_get(c);
303 struct btree_iter iter;
304 struct bkey_s_c k;
305 struct xattr_buf buf = { .buf = buffer, .len = buffer_size };
306 u64 offset = 0, inum = inode->ei_inode.bi_inum;
307 u32 snapshot;
308 int ret;
309 retry:
310 bch2_trans_begin(trans);
311 iter = (struct btree_iter) { NULL };
312
313 ret = bch2_subvolume_get_snapshot(trans, inode->ei_subvol, &snapshot);
314 if (ret)
315 goto err;
316
317 for_each_btree_key_upto_norestart(trans, iter, BTREE_ID_xattrs,
318 SPOS(inum, offset, snapshot),
319 POS(inum, U64_MAX), 0, k, ret) {
320 if (k.k->type != KEY_TYPE_xattr)
321 continue;
322
323 ret = bch2_xattr_emit(dentry, bkey_s_c_to_xattr(k).v, &buf);
324 if (ret)
325 break;
326 }
327
328 offset = iter.pos.offset;
329 bch2_trans_iter_exit(trans, &iter);
330 err:
331 if (bch2_err_matches(ret, BCH_ERR_transaction_restart))
332 goto retry;
333
334 bch2_trans_put(trans);
335
336 if (ret)
337 goto out;
338
339 ret = bch2_xattr_list_bcachefs(c, &inode->ei_inode, &buf, false);
340 if (ret)
341 goto out;
342
343 ret = bch2_xattr_list_bcachefs(c, &inode->ei_inode, &buf, true);
344 if (ret)
345 goto out;
346
347 return buf.used;
348 out:
349 return bch2_err_class(ret);
350 }
351
352 static int bch2_xattr_get_handler(const struct xattr_handler *handler,
353 struct dentry *dentry, struct inode *vinode,
354 const char *name, void *buffer, size_t size)
355 {
356 struct bch_inode_info *inode = to_bch_ei(vinode);
357 struct bch_fs *c = inode->v.i_sb->s_fs_info;
358 int ret = bch2_trans_do(c, NULL, NULL, 0,
359 bch2_xattr_get_trans(trans, inode, name, buffer, size, handler->flags));
360
361 return bch2_err_class(ret);
362 }
363
364 static int bch2_xattr_set_handler(const struct xattr_handler *handler,
365 struct mnt_idmap *idmap,
366 struct dentry *dentry, struct inode *vinode,
367 const char *name, const void *value,
368 size_t size, int flags)
369 {
370 struct bch_inode_info *inode = to_bch_ei(vinode);
371 struct bch_fs *c = inode->v.i_sb->s_fs_info;
372 struct bch_hash_info hash = bch2_hash_info_init(c, &inode->ei_inode);
373 struct bch_inode_unpacked inode_u;
374 int ret;
375
376 ret = bch2_trans_run(c,
377 commit_do(trans, NULL, NULL, 0,
378 bch2_xattr_set(trans, inode_inum(inode), &inode_u,
379 &hash, name, value, size,
380 handler->flags, flags)) ?:
381 (bch2_inode_update_after_write(trans, inode, &inode_u, ATTR_CTIME), 0));
382
383 return bch2_err_class(ret);
384 }
385
386 static const struct xattr_handler bch_xattr_user_handler = {
387 .prefix = XATTR_USER_PREFIX,
388 .get = bch2_xattr_get_handler,
389 .set = bch2_xattr_set_handler,
390 .flags = KEY_TYPE_XATTR_INDEX_USER,
391 };
392
393 static bool bch2_xattr_trusted_list(struct dentry *dentry)
394 {
395 return capable(CAP_SYS_ADMIN);
396 }
397
398 static const struct xattr_handler bch_xattr_trusted_handler = {
399 .prefix = XATTR_TRUSTED_PREFIX,
400 .list = bch2_xattr_trusted_list,
401 .get = bch2_xattr_get_handler,
402 .set = bch2_xattr_set_handler,
403 .flags = KEY_TYPE_XATTR_INDEX_TRUSTED,
404 };
405
406 static const struct xattr_handler bch_xattr_security_handler = {
407 .prefix = XATTR_SECURITY_PREFIX,
408 .get = bch2_xattr_get_handler,
409 .set = bch2_xattr_set_handler,
410 .flags = KEY_TYPE_XATTR_INDEX_SECURITY,
411 };
412
413 #ifndef NO_BCACHEFS_FS
414
415 static int opt_to_inode_opt(int id)
416 {
417 switch (id) {
418 #define x(name, ...) \
419 case Opt_##name: return Inode_opt_##name;
420 BCH_INODE_OPTS()
421 #undef x
422 default:
423 return -1;
424 }
425 }
426
427 static int __bch2_xattr_bcachefs_get(const struct xattr_handler *handler,
428 struct dentry *dentry, struct inode *vinode,
429 const char *name, void *buffer, size_t size,
430 bool all)
431 {
432 struct bch_inode_info *inode = to_bch_ei(vinode);
433 struct bch_fs *c = inode->v.i_sb->s_fs_info;
434 struct bch_opts opts =
435 bch2_inode_opts_to_opts(&inode->ei_inode);
436 const struct bch_option *opt;
437 int id, inode_opt_id;
438 struct printbuf out = PRINTBUF;
439 int ret;
440 u64 v;
441
442 id = bch2_opt_lookup(name);
443 if (id < 0 || !bch2_opt_is_inode_opt(id))
444 return -EINVAL;
445
446 inode_opt_id = opt_to_inode_opt(id);
447 if (inode_opt_id < 0)
448 return -EINVAL;
449
450 opt = bch2_opt_table + id;
451
452 if (!bch2_opt_defined_by_id(&opts, id))
453 return -ENODATA;
454
455 if (!all &&
456 !(inode->ei_inode.bi_fields_set & (1 << inode_opt_id)))
457 return -ENODATA;
458
459 v = bch2_opt_get_by_id(&opts, id);
460 bch2_opt_to_text(&out, c, c->disk_sb.sb, opt, v, 0);
461
462 ret = out.pos;
463
464 if (out.allocation_failure) {
465 ret = -ENOMEM;
466 } else if (buffer) {
467 if (out.pos > size)
468 ret = -ERANGE;
469 else
470 memcpy(buffer, out.buf, out.pos);
471 }
472
473 printbuf_exit(&out);
474 return ret;
475 }
476
477 static int bch2_xattr_bcachefs_get(const struct xattr_handler *handler,
478 struct dentry *dentry, struct inode *vinode,
479 const char *name, void *buffer, size_t size)
480 {
481 return __bch2_xattr_bcachefs_get(handler, dentry, vinode,
482 name, buffer, size, false);
483 }
484
485 struct inode_opt_set {
486 int id;
487 u64 v;
488 bool defined;
489 };
490
491 static int inode_opt_set_fn(struct btree_trans *trans,
492 struct bch_inode_info *inode,
493 struct bch_inode_unpacked *bi,
494 void *p)
495 {
496 struct inode_opt_set *s = p;
497
498 if (s->defined)
499 bi->bi_fields_set |= 1U << s->id;
500 else
501 bi->bi_fields_set &= ~(1U << s->id);
502
503 bch2_inode_opt_set(bi, s->id, s->v);
504
505 return 0;
506 }
507
508 static int bch2_xattr_bcachefs_set(const struct xattr_handler *handler,
509 struct mnt_idmap *idmap,
510 struct dentry *dentry, struct inode *vinode,
511 const char *name, const void *value,
512 size_t size, int flags)
513 {
514 struct bch_inode_info *inode = to_bch_ei(vinode);
515 struct bch_fs *c = inode->v.i_sb->s_fs_info;
516 const struct bch_option *opt;
517 char *buf;
518 struct inode_opt_set s;
519 int opt_id, inode_opt_id, ret;
520
521 opt_id = bch2_opt_lookup(name);
522 if (opt_id < 0)
523 return -EINVAL;
524
525 opt = bch2_opt_table + opt_id;
526
527 inode_opt_id = opt_to_inode_opt(opt_id);
528 if (inode_opt_id < 0)
529 return -EINVAL;
530
531 s.id = inode_opt_id;
532
533 if (value) {
534 u64 v = 0;
535
536 buf = kmalloc(size + 1, GFP_KERNEL);
537 if (!buf)
538 return -ENOMEM;
539 memcpy(buf, value, size);
540 buf[size] = '\0';
541
542 ret = bch2_opt_parse(c, opt, buf, &v, NULL);
543 kfree(buf);
544
545 if (ret < 0)
546 return ret;
547
548 ret = bch2_opt_check_may_set(c, opt_id, v);
549 if (ret < 0)
550 return ret;
551
552 s.v = v + 1;
553 s.defined = true;
554 } else {
555 if (!IS_ROOT(dentry)) {
556 struct bch_inode_info *dir =
557 to_bch_ei(d_inode(dentry->d_parent));
558
559 s.v = bch2_inode_opt_get(&dir->ei_inode, inode_opt_id);
560 } else {
561 s.v = 0;
562 }
563
564 s.defined = false;
565 }
566
567 mutex_lock(&inode->ei_update_lock);
568 if (inode_opt_id == Inode_opt_project) {
569 /*
570 * inode fields accessible via the xattr interface are stored
571 * with a +1 bias, so that 0 means unset:
572 */
573 ret = bch2_set_projid(c, inode, s.v ? s.v - 1 : 0);
574 if (ret)
575 goto err;
576 }
577
578 ret = bch2_write_inode(c, inode, inode_opt_set_fn, &s, 0);
579 err:
580 mutex_unlock(&inode->ei_update_lock);
581
582 if (value &&
583 (opt_id == Opt_background_compression ||
584 opt_id == Opt_background_target))
585 bch2_set_rebalance_needs_scan(c, inode->ei_inode.bi_inum);
586
587 return bch2_err_class(ret);
588 }
589
590 static const struct xattr_handler bch_xattr_bcachefs_handler = {
591 .prefix = "bcachefs.",
592 .get = bch2_xattr_bcachefs_get,
593 .set = bch2_xattr_bcachefs_set,
594 };
595
596 static int bch2_xattr_bcachefs_get_effective(
597 const struct xattr_handler *handler,
598 struct dentry *dentry, struct inode *vinode,
599 const char *name, void *buffer, size_t size)
600 {
601 return __bch2_xattr_bcachefs_get(handler, dentry, vinode,
602 name, buffer, size, true);
603 }
604
605 static const struct xattr_handler bch_xattr_bcachefs_effective_handler = {
606 .prefix = "bcachefs_effective.",
607 .get = bch2_xattr_bcachefs_get_effective,
608 .set = bch2_xattr_bcachefs_set,
609 };
610
611 #endif /* NO_BCACHEFS_FS */
612
613 const struct xattr_handler *bch2_xattr_handlers[] = {
614 &bch_xattr_user_handler,
615 #ifdef CONFIG_BCACHEFS_POSIX_ACL
616 &nop_posix_acl_access,
617 &nop_posix_acl_default,
618 #endif
619 &bch_xattr_trusted_handler,
620 &bch_xattr_security_handler,
621 #ifndef NO_BCACHEFS_FS
622 &bch_xattr_bcachefs_handler,
623 &bch_xattr_bcachefs_effective_handler,
624 #endif
625 NULL
626 };
627
628 static const struct xattr_handler *bch_xattr_handler_map[] = {
629 [KEY_TYPE_XATTR_INDEX_USER] = &bch_xattr_user_handler,
630 [KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS] =
631 &nop_posix_acl_access,
632 [KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT] =
633 &nop_posix_acl_default,
634 [KEY_TYPE_XATTR_INDEX_TRUSTED] = &bch_xattr_trusted_handler,
635 [KEY_TYPE_XATTR_INDEX_SECURITY] = &bch_xattr_security_handler,
636 };
637
638 static const struct xattr_handler *bch2_xattr_type_to_handler(unsigned type)
639 {
640 return type < ARRAY_SIZE(bch_xattr_handler_map)
641 ? bch_xattr_handler_map[type]
642 : NULL;
643 }