1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
6 * http://www.samsung.com/
8 * Portions of this code from linux/fs/ext2/xattr.c
10 * Copyright (C) 2001-2003 Andreas Gruenbacher <agruen@suse.de>
12 * Fix by Harrison Xing <harrison@mountainviewdata.com>.
13 * Extended attributes for symlinks and special files added per
14 * suggestion of Luka Renko <luka.renko@hermes.si>.
15 * xattr consolidation Copyright (c) 2004 James Morris <jmorris@redhat.com>,
18 #include <linux/rwsem.h>
19 #include <linux/f2fs_fs.h>
20 #include <linux/security.h>
21 #include <linux/posix_acl_xattr.h>
26 static void *xattr_alloc(struct f2fs_sb_info *sbi, int size, bool *is_inline)
28 if (likely(size == sbi->inline_xattr_slab_size)) {
30 return f2fs_kmem_cache_alloc(sbi->inline_xattr_slab,
31 GFP_F2FS_ZERO, false, sbi);
34 return f2fs_kzalloc(sbi, size, GFP_NOFS);
37 static void xattr_free(struct f2fs_sb_info *sbi, void *xattr_addr,
41 kmem_cache_free(sbi->inline_xattr_slab, xattr_addr);
46 static int f2fs_xattr_generic_get(const struct xattr_handler *handler,
47 struct dentry *unused, struct inode *inode,
48 const char *name, void *buffer, size_t size)
50 struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
52 switch (handler->flags) {
53 case F2FS_XATTR_INDEX_USER:
54 if (!test_opt(sbi, XATTR_USER))
57 case F2FS_XATTR_INDEX_TRUSTED:
58 case F2FS_XATTR_INDEX_SECURITY:
63 return f2fs_getxattr(inode, handler->flags, name,
67 static int f2fs_xattr_generic_set(const struct xattr_handler *handler,
68 struct mnt_idmap *idmap,
69 struct dentry *unused, struct inode *inode,
70 const char *name, const void *value,
71 size_t size, int flags)
73 struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
75 switch (handler->flags) {
76 case F2FS_XATTR_INDEX_USER:
77 if (!test_opt(sbi, XATTR_USER))
80 case F2FS_XATTR_INDEX_TRUSTED:
81 case F2FS_XATTR_INDEX_SECURITY:
86 return f2fs_setxattr(inode, handler->flags, name,
87 value, size, NULL, flags);
90 static bool f2fs_xattr_user_list(struct dentry *dentry)
92 struct f2fs_sb_info *sbi = F2FS_SB(dentry->d_sb);
94 return test_opt(sbi, XATTR_USER);
97 static bool f2fs_xattr_trusted_list(struct dentry *dentry)
99 return capable(CAP_SYS_ADMIN);
102 static int f2fs_xattr_advise_get(const struct xattr_handler *handler,
103 struct dentry *unused, struct inode *inode,
104 const char *name, void *buffer, size_t size)
107 *((char *)buffer) = F2FS_I(inode)->i_advise;
111 static int f2fs_xattr_advise_set(const struct xattr_handler *handler,
112 struct mnt_idmap *idmap,
113 struct dentry *unused, struct inode *inode,
114 const char *name, const void *value,
115 size_t size, int flags)
117 unsigned char old_advise = F2FS_I(inode)->i_advise;
118 unsigned char new_advise;
120 if (!inode_owner_or_capable(&nop_mnt_idmap, inode))
125 new_advise = *(char *)value;
126 if (new_advise & ~FADVISE_MODIFIABLE_BITS)
129 new_advise = new_advise & FADVISE_MODIFIABLE_BITS;
130 new_advise |= old_advise & ~FADVISE_MODIFIABLE_BITS;
132 F2FS_I(inode)->i_advise = new_advise;
133 f2fs_mark_inode_dirty_sync(inode, true);
137 #ifdef CONFIG_F2FS_FS_SECURITY
138 static int f2fs_initxattrs(struct inode *inode, const struct xattr *xattr_array,
141 const struct xattr *xattr;
144 for (xattr = xattr_array; xattr->name != NULL; xattr++) {
145 err = f2fs_setxattr(inode, F2FS_XATTR_INDEX_SECURITY,
146 xattr->name, xattr->value,
147 xattr->value_len, (struct page *)page, 0);
154 int f2fs_init_security(struct inode *inode, struct inode *dir,
155 const struct qstr *qstr, struct page *ipage)
157 return security_inode_init_security(inode, dir, qstr,
158 &f2fs_initxattrs, ipage);
162 const struct xattr_handler f2fs_xattr_user_handler = {
163 .prefix = XATTR_USER_PREFIX,
164 .flags = F2FS_XATTR_INDEX_USER,
165 .list = f2fs_xattr_user_list,
166 .get = f2fs_xattr_generic_get,
167 .set = f2fs_xattr_generic_set,
170 const struct xattr_handler f2fs_xattr_trusted_handler = {
171 .prefix = XATTR_TRUSTED_PREFIX,
172 .flags = F2FS_XATTR_INDEX_TRUSTED,
173 .list = f2fs_xattr_trusted_list,
174 .get = f2fs_xattr_generic_get,
175 .set = f2fs_xattr_generic_set,
178 const struct xattr_handler f2fs_xattr_advise_handler = {
179 .name = F2FS_SYSTEM_ADVISE_NAME,
180 .flags = F2FS_XATTR_INDEX_ADVISE,
181 .get = f2fs_xattr_advise_get,
182 .set = f2fs_xattr_advise_set,
185 const struct xattr_handler f2fs_xattr_security_handler = {
186 .prefix = XATTR_SECURITY_PREFIX,
187 .flags = F2FS_XATTR_INDEX_SECURITY,
188 .get = f2fs_xattr_generic_get,
189 .set = f2fs_xattr_generic_set,
192 static const struct xattr_handler *f2fs_xattr_handler_map[] = {
193 [F2FS_XATTR_INDEX_USER] = &f2fs_xattr_user_handler,
194 #ifdef CONFIG_F2FS_FS_POSIX_ACL
195 [F2FS_XATTR_INDEX_POSIX_ACL_ACCESS] = &nop_posix_acl_access,
196 [F2FS_XATTR_INDEX_POSIX_ACL_DEFAULT] = &nop_posix_acl_default,
198 [F2FS_XATTR_INDEX_TRUSTED] = &f2fs_xattr_trusted_handler,
199 #ifdef CONFIG_F2FS_FS_SECURITY
200 [F2FS_XATTR_INDEX_SECURITY] = &f2fs_xattr_security_handler,
202 [F2FS_XATTR_INDEX_ADVISE] = &f2fs_xattr_advise_handler,
205 const struct xattr_handler *f2fs_xattr_handlers[] = {
206 &f2fs_xattr_user_handler,
207 &f2fs_xattr_trusted_handler,
208 #ifdef CONFIG_F2FS_FS_SECURITY
209 &f2fs_xattr_security_handler,
211 &f2fs_xattr_advise_handler,
215 static inline const char *f2fs_xattr_prefix(int index,
216 struct dentry *dentry)
218 const struct xattr_handler *handler = NULL;
220 if (index > 0 && index < ARRAY_SIZE(f2fs_xattr_handler_map))
221 handler = f2fs_xattr_handler_map[index];
223 if (!xattr_handler_can_list(handler, dentry))
226 return xattr_prefix(handler);
229 static struct f2fs_xattr_entry *__find_xattr(void *base_addr,
230 void *last_base_addr, void **last_addr,
231 int index, size_t len, const char *name)
233 struct f2fs_xattr_entry *entry;
235 list_for_each_xattr(entry, base_addr) {
236 if ((void *)(entry) + sizeof(__u32) > last_base_addr ||
237 (void *)XATTR_NEXT_ENTRY(entry) > last_base_addr) {
243 if (entry->e_name_index != index)
245 if (entry->e_name_len != len)
247 if (!memcmp(entry->e_name, name, len))
253 static struct f2fs_xattr_entry *__find_inline_xattr(struct inode *inode,
254 void *base_addr, void **last_addr, int index,
255 size_t len, const char *name)
257 struct f2fs_xattr_entry *entry;
258 unsigned int inline_size = inline_xattr_size(inode);
259 void *max_addr = base_addr + inline_size;
261 entry = __find_xattr(base_addr, max_addr, last_addr, index, len, name);
265 /* inline xattr header or entry across max inline xattr size */
266 if (IS_XATTR_LAST_ENTRY(entry) &&
267 (void *)entry + sizeof(__u32) > max_addr) {
274 static int read_inline_xattr(struct inode *inode, struct page *ipage,
277 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
278 unsigned int inline_size = inline_xattr_size(inode);
279 struct page *page = NULL;
283 inline_addr = inline_xattr_addr(inode, ipage);
285 page = f2fs_get_node_page(sbi, inode->i_ino);
287 return PTR_ERR(page);
289 inline_addr = inline_xattr_addr(inode, page);
291 memcpy(txattr_addr, inline_addr, inline_size);
292 f2fs_put_page(page, 1);
297 static int read_xattr_block(struct inode *inode, void *txattr_addr)
299 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
300 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
301 unsigned int inline_size = inline_xattr_size(inode);
305 /* The inode already has an extended attribute block. */
306 xpage = f2fs_get_node_page(sbi, xnid);
308 return PTR_ERR(xpage);
310 xattr_addr = page_address(xpage);
311 memcpy(txattr_addr + inline_size, xattr_addr, VALID_XATTR_BLOCK_SIZE);
312 f2fs_put_page(xpage, 1);
317 static int lookup_all_xattrs(struct inode *inode, struct page *ipage,
318 unsigned int index, unsigned int len,
319 const char *name, struct f2fs_xattr_entry **xe,
320 void **base_addr, int *base_size,
323 void *cur_addr, *txattr_addr, *last_txattr_addr;
324 void *last_addr = NULL;
325 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
326 unsigned int inline_size = inline_xattr_size(inode);
329 if (!xnid && !inline_size)
332 *base_size = XATTR_SIZE(inode) + XATTR_PADDING_SIZE;
333 txattr_addr = xattr_alloc(F2FS_I_SB(inode), *base_size, is_inline);
337 last_txattr_addr = (void *)txattr_addr + XATTR_SIZE(inode);
339 /* read from inline xattr */
341 err = read_inline_xattr(inode, ipage, txattr_addr);
345 *xe = __find_inline_xattr(inode, txattr_addr, &last_addr,
348 *base_size = inline_size;
353 /* read from xattr node block */
355 err = read_xattr_block(inode, txattr_addr);
361 cur_addr = XATTR_HDR(last_addr) - 1;
363 cur_addr = txattr_addr;
365 *xe = __find_xattr(cur_addr, last_txattr_addr, NULL, index, len, name);
367 f2fs_err(F2FS_I_SB(inode), "lookup inode (%lu) has corrupted xattr",
369 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
371 f2fs_handle_error(F2FS_I_SB(inode),
372 ERROR_CORRUPTED_XATTR);
376 if (IS_XATTR_LAST_ENTRY(*xe)) {
381 *base_addr = txattr_addr;
384 xattr_free(F2FS_I_SB(inode), txattr_addr, *is_inline);
388 static int read_all_xattrs(struct inode *inode, struct page *ipage,
391 struct f2fs_xattr_header *header;
392 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
393 unsigned int size = VALID_XATTR_BLOCK_SIZE;
394 unsigned int inline_size = inline_xattr_size(inode);
398 txattr_addr = f2fs_kzalloc(F2FS_I_SB(inode),
399 inline_size + size + XATTR_PADDING_SIZE, GFP_NOFS);
403 /* read from inline xattr */
405 err = read_inline_xattr(inode, ipage, txattr_addr);
410 /* read from xattr node block */
412 err = read_xattr_block(inode, txattr_addr);
417 header = XATTR_HDR(txattr_addr);
419 /* never been allocated xattrs */
420 if (le32_to_cpu(header->h_magic) != F2FS_XATTR_MAGIC) {
421 header->h_magic = cpu_to_le32(F2FS_XATTR_MAGIC);
422 header->h_refcount = cpu_to_le32(1);
424 *base_addr = txattr_addr;
431 static inline int write_all_xattrs(struct inode *inode, __u32 hsize,
432 void *txattr_addr, struct page *ipage)
434 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
435 size_t inline_size = inline_xattr_size(inode);
436 struct page *in_page = NULL;
438 void *inline_addr = NULL;
443 if (hsize > inline_size && !F2FS_I(inode)->i_xattr_nid)
444 if (!f2fs_alloc_nid(sbi, &new_nid))
447 /* write to inline xattr */
450 inline_addr = inline_xattr_addr(inode, ipage);
452 in_page = f2fs_get_node_page(sbi, inode->i_ino);
453 if (IS_ERR(in_page)) {
454 f2fs_alloc_nid_failed(sbi, new_nid);
455 return PTR_ERR(in_page);
457 inline_addr = inline_xattr_addr(inode, in_page);
460 f2fs_wait_on_page_writeback(ipage ? ipage : in_page,
462 /* no need to use xattr node block */
463 if (hsize <= inline_size) {
464 err = f2fs_truncate_xattr_node(inode);
465 f2fs_alloc_nid_failed(sbi, new_nid);
467 f2fs_put_page(in_page, 1);
470 memcpy(inline_addr, txattr_addr, inline_size);
471 set_page_dirty(ipage ? ipage : in_page);
476 /* write to xattr node block */
477 if (F2FS_I(inode)->i_xattr_nid) {
478 xpage = f2fs_get_node_page(sbi, F2FS_I(inode)->i_xattr_nid);
480 err = PTR_ERR(xpage);
481 f2fs_alloc_nid_failed(sbi, new_nid);
484 f2fs_bug_on(sbi, new_nid);
485 f2fs_wait_on_page_writeback(xpage, NODE, true, true);
487 struct dnode_of_data dn;
489 set_new_dnode(&dn, inode, NULL, NULL, new_nid);
490 xpage = f2fs_new_node_page(&dn, XATTR_NODE_OFFSET);
492 err = PTR_ERR(xpage);
493 f2fs_alloc_nid_failed(sbi, new_nid);
496 f2fs_alloc_nid_done(sbi, new_nid);
498 xattr_addr = page_address(xpage);
501 memcpy(inline_addr, txattr_addr, inline_size);
502 memcpy(xattr_addr, txattr_addr + inline_size, VALID_XATTR_BLOCK_SIZE);
505 set_page_dirty(ipage ? ipage : in_page);
506 set_page_dirty(xpage);
508 f2fs_put_page(xpage, 1);
510 f2fs_put_page(in_page, 1);
514 int f2fs_getxattr(struct inode *inode, int index, const char *name,
515 void *buffer, size_t buffer_size, struct page *ipage)
517 struct f2fs_xattr_entry *entry = NULL;
519 unsigned int size, len;
520 void *base_addr = NULL;
528 if (len > F2FS_NAME_LEN)
532 f2fs_down_read(&F2FS_I(inode)->i_xattr_sem);
533 error = lookup_all_xattrs(inode, ipage, index, len, name,
534 &entry, &base_addr, &base_size, &is_inline);
536 f2fs_up_read(&F2FS_I(inode)->i_xattr_sem);
540 size = le16_to_cpu(entry->e_value_size);
542 if (buffer && size > buffer_size) {
548 char *pval = entry->e_name + entry->e_name_len;
550 if (base_size - (pval - (char *)base_addr) < size) {
554 memcpy(buffer, pval, size);
558 xattr_free(F2FS_I_SB(inode), base_addr, is_inline);
562 ssize_t f2fs_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
564 struct inode *inode = d_inode(dentry);
565 struct f2fs_xattr_entry *entry;
566 void *base_addr, *last_base_addr;
568 size_t rest = buffer_size;
570 f2fs_down_read(&F2FS_I(inode)->i_xattr_sem);
571 error = read_all_xattrs(inode, NULL, &base_addr);
572 f2fs_up_read(&F2FS_I(inode)->i_xattr_sem);
576 last_base_addr = (void *)base_addr + XATTR_SIZE(inode);
578 list_for_each_xattr(entry, base_addr) {
583 prefix = f2fs_xattr_prefix(entry->e_name_index, dentry);
585 if ((void *)(entry) + sizeof(__u32) > last_base_addr ||
586 (void *)XATTR_NEXT_ENTRY(entry) > last_base_addr) {
587 f2fs_err(F2FS_I_SB(inode), "list inode (%lu) has corrupted xattr",
589 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
590 f2fs_handle_error(F2FS_I_SB(inode),
591 ERROR_CORRUPTED_XATTR);
598 prefix_len = strlen(prefix);
599 size = prefix_len + entry->e_name_len + 1;
605 memcpy(buffer, prefix, prefix_len);
606 buffer += prefix_len;
607 memcpy(buffer, entry->e_name, entry->e_name_len);
608 buffer += entry->e_name_len;
613 error = buffer_size - rest;
619 static bool f2fs_xattr_value_same(struct f2fs_xattr_entry *entry,
620 const void *value, size_t size)
622 void *pval = entry->e_name + entry->e_name_len;
624 return (le16_to_cpu(entry->e_value_size) == size) &&
625 !memcmp(pval, value, size);
628 static int __f2fs_setxattr(struct inode *inode, int index,
629 const char *name, const void *value, size_t size,
630 struct page *ipage, int flags)
632 struct f2fs_xattr_entry *here, *last;
633 void *base_addr, *last_base_addr;
647 if (len > F2FS_NAME_LEN)
650 if (size > MAX_VALUE_LEN(inode))
653 error = read_all_xattrs(inode, ipage, &base_addr);
657 last_base_addr = (void *)base_addr + XATTR_SIZE(inode);
659 /* find entry with wanted name. */
660 here = __find_xattr(base_addr, last_base_addr, NULL, index, len, name);
662 if (!F2FS_I(inode)->i_xattr_nid) {
663 f2fs_notice(F2FS_I_SB(inode),
664 "recover xattr in inode (%lu)", inode->i_ino);
665 f2fs_recover_xattr_data(inode, NULL);
669 f2fs_err(F2FS_I_SB(inode), "set inode (%lu) has corrupted xattr",
671 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
672 error = -EFSCORRUPTED;
673 f2fs_handle_error(F2FS_I_SB(inode),
674 ERROR_CORRUPTED_XATTR);
678 found = IS_XATTR_LAST_ENTRY(here) ? 0 : 1;
681 if ((flags & XATTR_CREATE)) {
686 if (value && f2fs_xattr_value_same(here, value, size))
688 } else if ((flags & XATTR_REPLACE)) {
694 while (!IS_XATTR_LAST_ENTRY(last)) {
695 if ((void *)(last) + sizeof(__u32) > last_base_addr ||
696 (void *)XATTR_NEXT_ENTRY(last) > last_base_addr) {
697 f2fs_err(F2FS_I_SB(inode), "inode (%lu) has invalid last xattr entry, entry_size: %zu",
698 inode->i_ino, ENTRY_SIZE(last));
699 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
700 error = -EFSCORRUPTED;
701 f2fs_handle_error(F2FS_I_SB(inode),
702 ERROR_CORRUPTED_XATTR);
705 last = XATTR_NEXT_ENTRY(last);
708 newsize = XATTR_ALIGN(sizeof(struct f2fs_xattr_entry) + len + size);
714 * If value is NULL, it is remove operation.
715 * In case of update operation, we calculate free.
717 free = MIN_OFFSET(inode) - ((char *)last - (char *)base_addr);
719 free = free + ENTRY_SIZE(here);
721 if (unlikely(free < newsize)) {
727 /* 2. Remove old entry */
730 * If entry is found, remove old entry.
731 * If not found, remove operation is not needed.
733 struct f2fs_xattr_entry *next = XATTR_NEXT_ENTRY(here);
734 int oldsize = ENTRY_SIZE(here);
736 memmove(here, next, (char *)last - (char *)next);
737 last = (struct f2fs_xattr_entry *)((char *)last - oldsize);
738 memset(last, 0, oldsize);
741 new_hsize = (char *)last - (char *)base_addr;
743 /* 3. Write new entry */
747 * Before we come here, old entry is removed.
748 * We just write new entry.
750 last->e_name_index = index;
751 last->e_name_len = len;
752 memcpy(last->e_name, name, len);
753 pval = last->e_name + len;
754 memcpy(pval, value, size);
755 last->e_value_size = cpu_to_le16(size);
756 new_hsize += newsize;
758 * Explicitly add the null terminator. The unused xattr space
759 * is supposed to always be zeroed, which would make this
760 * unnecessary, but don't depend on that.
762 *(u32 *)((u8 *)last + newsize) = 0;
765 error = write_all_xattrs(inode, new_hsize, base_addr, ipage);
769 if (index == F2FS_XATTR_INDEX_ENCRYPTION &&
770 !strcmp(name, F2FS_XATTR_NAME_ENCRYPTION_CONTEXT))
771 f2fs_set_encrypted_inode(inode);
772 if (S_ISDIR(inode->i_mode))
773 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_CP);
776 if (is_inode_flag_set(inode, FI_ACL_MODE)) {
777 inode->i_mode = F2FS_I(inode)->i_acl_mode;
778 clear_inode_flag(inode, FI_ACL_MODE);
781 inode_set_ctime_current(inode);
782 f2fs_mark_inode_dirty_sync(inode, true);
788 int f2fs_setxattr(struct inode *inode, int index, const char *name,
789 const void *value, size_t size,
790 struct page *ipage, int flags)
792 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
795 if (unlikely(f2fs_cp_error(sbi)))
797 if (!f2fs_is_checkpoint_ready(sbi))
800 err = f2fs_dquot_initialize(inode);
804 /* this case is only from f2fs_init_inode_metadata */
806 return __f2fs_setxattr(inode, index, name, value,
808 f2fs_balance_fs(sbi, true);
811 f2fs_down_write(&F2FS_I(inode)->i_xattr_sem);
812 err = __f2fs_setxattr(inode, index, name, value, size, ipage, flags);
813 f2fs_up_write(&F2FS_I(inode)->i_xattr_sem);
816 f2fs_update_time(sbi, REQ_TIME);
820 int f2fs_init_xattr_caches(struct f2fs_sb_info *sbi)
822 dev_t dev = sbi->sb->s_bdev->bd_dev;
825 sprintf(slab_name, "f2fs_xattr_entry-%u:%u", MAJOR(dev), MINOR(dev));
827 sbi->inline_xattr_slab_size = F2FS_OPTION(sbi).inline_xattr_size *
828 sizeof(__le32) + XATTR_PADDING_SIZE;
830 sbi->inline_xattr_slab = f2fs_kmem_cache_create(slab_name,
831 sbi->inline_xattr_slab_size);
832 if (!sbi->inline_xattr_slab)
838 void f2fs_destroy_xattr_caches(struct f2fs_sb_info *sbi)
840 kmem_cache_destroy(sbi->inline_xattr_slab);