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
13 * Extended attributes for symlinks and special files added per
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 user_namespace *mnt_userns,
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 user_namespace *mnt_userns,
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(&init_user_ns, 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] = &posix_acl_access_xattr_handler,
196 [F2FS_XATTR_INDEX_POSIX_ACL_DEFAULT] = &posix_acl_default_xattr_handler,
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 #ifdef CONFIG_F2FS_FS_POSIX_ACL
208 &posix_acl_access_xattr_handler,
209 &posix_acl_default_xattr_handler,
211 &f2fs_xattr_trusted_handler,
212 #ifdef CONFIG_F2FS_FS_SECURITY
213 &f2fs_xattr_security_handler,
215 &f2fs_xattr_advise_handler,
219 static inline const struct xattr_handler *f2fs_xattr_handler(int index)
221 const struct xattr_handler *handler = NULL;
223 if (index > 0 && index < ARRAY_SIZE(f2fs_xattr_handler_map))
224 handler = f2fs_xattr_handler_map[index];
228 static struct f2fs_xattr_entry *__find_xattr(void *base_addr,
229 void *last_base_addr, void **last_addr,
230 int index, size_t len, const char *name)
232 struct f2fs_xattr_entry *entry;
234 list_for_each_xattr(entry, base_addr) {
235 if ((void *)(entry) + sizeof(__u32) > last_base_addr ||
236 (void *)XATTR_NEXT_ENTRY(entry) > last_base_addr) {
242 if (entry->e_name_index != index)
244 if (entry->e_name_len != len)
246 if (!memcmp(entry->e_name, name, len))
252 static struct f2fs_xattr_entry *__find_inline_xattr(struct inode *inode,
253 void *base_addr, void **last_addr, int index,
254 size_t len, const char *name)
256 struct f2fs_xattr_entry *entry;
257 unsigned int inline_size = inline_xattr_size(inode);
258 void *max_addr = base_addr + inline_size;
260 entry = __find_xattr(base_addr, max_addr, last_addr, index, len, name);
264 /* inline xattr header or entry across max inline xattr size */
265 if (IS_XATTR_LAST_ENTRY(entry) &&
266 (void *)entry + sizeof(__u32) > max_addr) {
273 static int read_inline_xattr(struct inode *inode, struct page *ipage,
276 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
277 unsigned int inline_size = inline_xattr_size(inode);
278 struct page *page = NULL;
282 inline_addr = inline_xattr_addr(inode, ipage);
284 page = f2fs_get_node_page(sbi, inode->i_ino);
286 return PTR_ERR(page);
288 inline_addr = inline_xattr_addr(inode, page);
290 memcpy(txattr_addr, inline_addr, inline_size);
291 f2fs_put_page(page, 1);
296 static int read_xattr_block(struct inode *inode, void *txattr_addr)
298 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
299 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
300 unsigned int inline_size = inline_xattr_size(inode);
304 /* The inode already has an extended attribute block. */
305 xpage = f2fs_get_node_page(sbi, xnid);
307 return PTR_ERR(xpage);
309 xattr_addr = page_address(xpage);
310 memcpy(txattr_addr + inline_size, xattr_addr, VALID_XATTR_BLOCK_SIZE);
311 f2fs_put_page(xpage, 1);
316 static int lookup_all_xattrs(struct inode *inode, struct page *ipage,
317 unsigned int index, unsigned int len,
318 const char *name, struct f2fs_xattr_entry **xe,
319 void **base_addr, int *base_size,
322 void *cur_addr, *txattr_addr, *last_txattr_addr;
323 void *last_addr = NULL;
324 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
325 unsigned int inline_size = inline_xattr_size(inode);
328 if (!xnid && !inline_size)
331 *base_size = XATTR_SIZE(inode) + XATTR_PADDING_SIZE;
332 txattr_addr = xattr_alloc(F2FS_I_SB(inode), *base_size, is_inline);
336 last_txattr_addr = (void *)txattr_addr + XATTR_SIZE(inode);
338 /* read from inline xattr */
340 err = read_inline_xattr(inode, ipage, txattr_addr);
344 *xe = __find_inline_xattr(inode, txattr_addr, &last_addr,
347 *base_size = inline_size;
352 /* read from xattr node block */
354 err = read_xattr_block(inode, txattr_addr);
360 cur_addr = XATTR_HDR(last_addr) - 1;
362 cur_addr = txattr_addr;
364 *xe = __find_xattr(cur_addr, last_txattr_addr, NULL, index, len, name);
366 f2fs_err(F2FS_I_SB(inode), "inode (%lu) has corrupted xattr",
368 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
370 f2fs_handle_error(F2FS_I_SB(inode),
371 ERROR_CORRUPTED_XATTR);
375 if (IS_XATTR_LAST_ENTRY(*xe)) {
380 *base_addr = txattr_addr;
383 xattr_free(F2FS_I_SB(inode), txattr_addr, *is_inline);
387 static int read_all_xattrs(struct inode *inode, struct page *ipage,
390 struct f2fs_xattr_header *header;
391 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
392 unsigned int size = VALID_XATTR_BLOCK_SIZE;
393 unsigned int inline_size = inline_xattr_size(inode);
397 txattr_addr = f2fs_kzalloc(F2FS_I_SB(inode),
398 inline_size + size + XATTR_PADDING_SIZE, GFP_NOFS);
402 /* read from inline xattr */
404 err = read_inline_xattr(inode, ipage, txattr_addr);
409 /* read from xattr node block */
411 err = read_xattr_block(inode, txattr_addr);
416 header = XATTR_HDR(txattr_addr);
418 /* never been allocated xattrs */
419 if (le32_to_cpu(header->h_magic) != F2FS_XATTR_MAGIC) {
420 header->h_magic = cpu_to_le32(F2FS_XATTR_MAGIC);
421 header->h_refcount = cpu_to_le32(1);
423 *base_addr = txattr_addr;
430 static inline int write_all_xattrs(struct inode *inode, __u32 hsize,
431 void *txattr_addr, struct page *ipage)
433 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
434 size_t inline_size = inline_xattr_size(inode);
435 struct page *in_page = NULL;
437 void *inline_addr = NULL;
442 if (hsize > inline_size && !F2FS_I(inode)->i_xattr_nid)
443 if (!f2fs_alloc_nid(sbi, &new_nid))
446 /* write to inline xattr */
449 inline_addr = inline_xattr_addr(inode, ipage);
451 in_page = f2fs_get_node_page(sbi, inode->i_ino);
452 if (IS_ERR(in_page)) {
453 f2fs_alloc_nid_failed(sbi, new_nid);
454 return PTR_ERR(in_page);
456 inline_addr = inline_xattr_addr(inode, in_page);
459 f2fs_wait_on_page_writeback(ipage ? ipage : in_page,
461 /* no need to use xattr node block */
462 if (hsize <= inline_size) {
463 err = f2fs_truncate_xattr_node(inode);
464 f2fs_alloc_nid_failed(sbi, new_nid);
466 f2fs_put_page(in_page, 1);
469 memcpy(inline_addr, txattr_addr, inline_size);
470 set_page_dirty(ipage ? ipage : in_page);
475 /* write to xattr node block */
476 if (F2FS_I(inode)->i_xattr_nid) {
477 xpage = f2fs_get_node_page(sbi, F2FS_I(inode)->i_xattr_nid);
479 err = PTR_ERR(xpage);
480 f2fs_alloc_nid_failed(sbi, new_nid);
483 f2fs_bug_on(sbi, new_nid);
484 f2fs_wait_on_page_writeback(xpage, NODE, true, true);
486 struct dnode_of_data dn;
488 set_new_dnode(&dn, inode, NULL, NULL, new_nid);
489 xpage = f2fs_new_node_page(&dn, XATTR_NODE_OFFSET);
491 err = PTR_ERR(xpage);
492 f2fs_alloc_nid_failed(sbi, new_nid);
495 f2fs_alloc_nid_done(sbi, new_nid);
497 xattr_addr = page_address(xpage);
500 memcpy(inline_addr, txattr_addr, inline_size);
501 memcpy(xattr_addr, txattr_addr + inline_size, VALID_XATTR_BLOCK_SIZE);
504 set_page_dirty(ipage ? ipage : in_page);
505 set_page_dirty(xpage);
507 f2fs_put_page(xpage, 1);
509 f2fs_put_page(in_page, 1);
513 int f2fs_getxattr(struct inode *inode, int index, const char *name,
514 void *buffer, size_t buffer_size, struct page *ipage)
516 struct f2fs_xattr_entry *entry = NULL;
518 unsigned int size, len;
519 void *base_addr = NULL;
527 if (len > F2FS_NAME_LEN)
530 f2fs_down_read(&F2FS_I(inode)->i_xattr_sem);
531 error = lookup_all_xattrs(inode, ipage, index, len, name,
532 &entry, &base_addr, &base_size, &is_inline);
533 f2fs_up_read(&F2FS_I(inode)->i_xattr_sem);
537 size = le16_to_cpu(entry->e_value_size);
539 if (buffer && size > buffer_size) {
545 char *pval = entry->e_name + entry->e_name_len;
547 if (base_size - (pval - (char *)base_addr) < size) {
551 memcpy(buffer, pval, size);
555 xattr_free(F2FS_I_SB(inode), base_addr, is_inline);
559 ssize_t f2fs_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
561 struct inode *inode = d_inode(dentry);
562 struct f2fs_xattr_entry *entry;
563 void *base_addr, *last_base_addr;
565 size_t rest = buffer_size;
567 f2fs_down_read(&F2FS_I(inode)->i_xattr_sem);
568 error = read_all_xattrs(inode, NULL, &base_addr);
569 f2fs_up_read(&F2FS_I(inode)->i_xattr_sem);
573 last_base_addr = (void *)base_addr + XATTR_SIZE(inode);
575 list_for_each_xattr(entry, base_addr) {
576 const struct xattr_handler *handler =
577 f2fs_xattr_handler(entry->e_name_index);
582 if ((void *)(entry) + sizeof(__u32) > last_base_addr ||
583 (void *)XATTR_NEXT_ENTRY(entry) > last_base_addr) {
584 f2fs_err(F2FS_I_SB(inode), "inode (%lu) has corrupted xattr",
586 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
587 error = -EFSCORRUPTED;
588 f2fs_handle_error(F2FS_I_SB(inode),
589 ERROR_CORRUPTED_XATTR);
593 if (!handler || (handler->list && !handler->list(dentry)))
596 prefix = xattr_prefix(handler);
597 prefix_len = strlen(prefix);
598 size = prefix_len + entry->e_name_len + 1;
604 memcpy(buffer, prefix, prefix_len);
605 buffer += prefix_len;
606 memcpy(buffer, entry->e_name, entry->e_name_len);
607 buffer += entry->e_name_len;
612 error = buffer_size - rest;
618 static bool f2fs_xattr_value_same(struct f2fs_xattr_entry *entry,
619 const void *value, size_t size)
621 void *pval = entry->e_name + entry->e_name_len;
623 return (le16_to_cpu(entry->e_value_size) == size) &&
624 !memcmp(pval, value, size);
627 static int __f2fs_setxattr(struct inode *inode, int index,
628 const char *name, const void *value, size_t size,
629 struct page *ipage, int flags)
631 struct f2fs_xattr_entry *here, *last;
632 void *base_addr, *last_base_addr;
646 if (len > F2FS_NAME_LEN)
649 if (size > MAX_VALUE_LEN(inode))
652 error = read_all_xattrs(inode, ipage, &base_addr);
656 last_base_addr = (void *)base_addr + XATTR_SIZE(inode);
658 /* find entry with wanted name. */
659 here = __find_xattr(base_addr, last_base_addr, NULL, index, len, name);
661 f2fs_err(F2FS_I_SB(inode), "inode (%lu) has corrupted xattr",
663 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
664 error = -EFSCORRUPTED;
665 f2fs_handle_error(F2FS_I_SB(inode),
666 ERROR_CORRUPTED_XATTR);
670 found = IS_XATTR_LAST_ENTRY(here) ? 0 : 1;
673 if ((flags & XATTR_CREATE)) {
678 if (value && f2fs_xattr_value_same(here, value, size))
680 } else if ((flags & XATTR_REPLACE)) {
686 while (!IS_XATTR_LAST_ENTRY(last)) {
687 if ((void *)(last) + sizeof(__u32) > last_base_addr ||
688 (void *)XATTR_NEXT_ENTRY(last) > last_base_addr) {
689 f2fs_err(F2FS_I_SB(inode), "inode (%lu) has invalid last xattr entry, entry_size: %zu",
690 inode->i_ino, ENTRY_SIZE(last));
691 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
692 error = -EFSCORRUPTED;
693 f2fs_handle_error(F2FS_I_SB(inode),
694 ERROR_CORRUPTED_XATTR);
697 last = XATTR_NEXT_ENTRY(last);
700 newsize = XATTR_ALIGN(sizeof(struct f2fs_xattr_entry) + len + size);
706 * If value is NULL, it is remove operation.
707 * In case of update operation, we calculate free.
709 free = MIN_OFFSET(inode) - ((char *)last - (char *)base_addr);
711 free = free + ENTRY_SIZE(here);
713 if (unlikely(free < newsize)) {
719 /* 2. Remove old entry */
722 * If entry is found, remove old entry.
723 * If not found, remove operation is not needed.
725 struct f2fs_xattr_entry *next = XATTR_NEXT_ENTRY(here);
726 int oldsize = ENTRY_SIZE(here);
728 memmove(here, next, (char *)last - (char *)next);
729 last = (struct f2fs_xattr_entry *)((char *)last - oldsize);
730 memset(last, 0, oldsize);
733 new_hsize = (char *)last - (char *)base_addr;
735 /* 3. Write new entry */
739 * Before we come here, old entry is removed.
740 * We just write new entry.
742 last->e_name_index = index;
743 last->e_name_len = len;
744 memcpy(last->e_name, name, len);
745 pval = last->e_name + len;
746 memcpy(pval, value, size);
747 last->e_value_size = cpu_to_le16(size);
748 new_hsize += newsize;
751 error = write_all_xattrs(inode, new_hsize, base_addr, ipage);
755 if (index == F2FS_XATTR_INDEX_ENCRYPTION &&
756 !strcmp(name, F2FS_XATTR_NAME_ENCRYPTION_CONTEXT))
757 f2fs_set_encrypted_inode(inode);
758 f2fs_mark_inode_dirty_sync(inode, true);
759 if (!error && S_ISDIR(inode->i_mode))
760 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_CP);
763 if (is_inode_flag_set(inode, FI_ACL_MODE)) {
764 inode->i_mode = F2FS_I(inode)->i_acl_mode;
765 inode->i_ctime = current_time(inode);
766 clear_inode_flag(inode, FI_ACL_MODE);
774 int f2fs_setxattr(struct inode *inode, int index, const char *name,
775 const void *value, size_t size,
776 struct page *ipage, int flags)
778 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
781 if (unlikely(f2fs_cp_error(sbi)))
783 if (!f2fs_is_checkpoint_ready(sbi))
786 err = f2fs_dquot_initialize(inode);
790 /* this case is only from f2fs_init_inode_metadata */
792 return __f2fs_setxattr(inode, index, name, value,
794 f2fs_balance_fs(sbi, true);
797 f2fs_down_write(&F2FS_I(inode)->i_xattr_sem);
798 err = __f2fs_setxattr(inode, index, name, value, size, ipage, flags);
799 f2fs_up_write(&F2FS_I(inode)->i_xattr_sem);
802 f2fs_update_time(sbi, REQ_TIME);
806 int f2fs_init_xattr_caches(struct f2fs_sb_info *sbi)
808 dev_t dev = sbi->sb->s_bdev->bd_dev;
811 sprintf(slab_name, "f2fs_xattr_entry-%u:%u", MAJOR(dev), MINOR(dev));
813 sbi->inline_xattr_slab_size = F2FS_OPTION(sbi).inline_xattr_size *
814 sizeof(__le32) + XATTR_PADDING_SIZE;
816 sbi->inline_xattr_slab = f2fs_kmem_cache_create(slab_name,
817 sbi->inline_xattr_slab_size);
818 if (!sbi->inline_xattr_slab)
824 void f2fs_destroy_xattr_caches(struct f2fs_sb_info *sbi)
826 kmem_cache_destroy(sbi->inline_xattr_slab);