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 int f2fs_xattr_generic_get(const struct xattr_handler *handler,
27 struct dentry *unused, struct inode *inode,
28 const char *name, void *buffer, size_t size)
30 struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
32 switch (handler->flags) {
33 case F2FS_XATTR_INDEX_USER:
34 if (!test_opt(sbi, XATTR_USER))
37 case F2FS_XATTR_INDEX_TRUSTED:
38 case F2FS_XATTR_INDEX_SECURITY:
43 return f2fs_getxattr(inode, handler->flags, name,
47 static int f2fs_xattr_generic_set(const struct xattr_handler *handler,
48 struct dentry *unused, struct inode *inode,
49 const char *name, const void *value,
50 size_t size, int flags)
52 struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
54 switch (handler->flags) {
55 case F2FS_XATTR_INDEX_USER:
56 if (!test_opt(sbi, XATTR_USER))
59 case F2FS_XATTR_INDEX_TRUSTED:
60 case F2FS_XATTR_INDEX_SECURITY:
65 return f2fs_setxattr(inode, handler->flags, name,
66 value, size, NULL, flags);
69 static bool f2fs_xattr_user_list(struct dentry *dentry)
71 struct f2fs_sb_info *sbi = F2FS_SB(dentry->d_sb);
73 return test_opt(sbi, XATTR_USER);
76 static bool f2fs_xattr_trusted_list(struct dentry *dentry)
78 return capable(CAP_SYS_ADMIN);
81 static int f2fs_xattr_advise_get(const struct xattr_handler *handler,
82 struct dentry *unused, struct inode *inode,
83 const char *name, void *buffer, size_t size)
86 *((char *)buffer) = F2FS_I(inode)->i_advise;
90 static int f2fs_xattr_advise_set(const struct xattr_handler *handler,
91 struct dentry *unused, struct inode *inode,
92 const char *name, const void *value,
93 size_t size, int flags)
95 unsigned char old_advise = F2FS_I(inode)->i_advise;
96 unsigned char new_advise;
98 if (!inode_owner_or_capable(inode))
103 new_advise = *(char *)value;
104 if (new_advise & ~FADVISE_MODIFIABLE_BITS)
107 new_advise = new_advise & FADVISE_MODIFIABLE_BITS;
108 new_advise |= old_advise & ~FADVISE_MODIFIABLE_BITS;
110 F2FS_I(inode)->i_advise = new_advise;
111 f2fs_mark_inode_dirty_sync(inode, true);
115 #ifdef CONFIG_F2FS_FS_SECURITY
116 static int f2fs_initxattrs(struct inode *inode, const struct xattr *xattr_array,
119 const struct xattr *xattr;
122 for (xattr = xattr_array; xattr->name != NULL; xattr++) {
123 err = f2fs_setxattr(inode, F2FS_XATTR_INDEX_SECURITY,
124 xattr->name, xattr->value,
125 xattr->value_len, (struct page *)page, 0);
132 int f2fs_init_security(struct inode *inode, struct inode *dir,
133 const struct qstr *qstr, struct page *ipage)
135 return security_inode_init_security(inode, dir, qstr,
136 &f2fs_initxattrs, ipage);
140 const struct xattr_handler f2fs_xattr_user_handler = {
141 .prefix = XATTR_USER_PREFIX,
142 .flags = F2FS_XATTR_INDEX_USER,
143 .list = f2fs_xattr_user_list,
144 .get = f2fs_xattr_generic_get,
145 .set = f2fs_xattr_generic_set,
148 const struct xattr_handler f2fs_xattr_trusted_handler = {
149 .prefix = XATTR_TRUSTED_PREFIX,
150 .flags = F2FS_XATTR_INDEX_TRUSTED,
151 .list = f2fs_xattr_trusted_list,
152 .get = f2fs_xattr_generic_get,
153 .set = f2fs_xattr_generic_set,
156 const struct xattr_handler f2fs_xattr_advise_handler = {
157 .name = F2FS_SYSTEM_ADVISE_NAME,
158 .flags = F2FS_XATTR_INDEX_ADVISE,
159 .get = f2fs_xattr_advise_get,
160 .set = f2fs_xattr_advise_set,
163 const struct xattr_handler f2fs_xattr_security_handler = {
164 .prefix = XATTR_SECURITY_PREFIX,
165 .flags = F2FS_XATTR_INDEX_SECURITY,
166 .get = f2fs_xattr_generic_get,
167 .set = f2fs_xattr_generic_set,
170 static const struct xattr_handler *f2fs_xattr_handler_map[] = {
171 [F2FS_XATTR_INDEX_USER] = &f2fs_xattr_user_handler,
172 #ifdef CONFIG_F2FS_FS_POSIX_ACL
173 [F2FS_XATTR_INDEX_POSIX_ACL_ACCESS] = &posix_acl_access_xattr_handler,
174 [F2FS_XATTR_INDEX_POSIX_ACL_DEFAULT] = &posix_acl_default_xattr_handler,
176 [F2FS_XATTR_INDEX_TRUSTED] = &f2fs_xattr_trusted_handler,
177 #ifdef CONFIG_F2FS_FS_SECURITY
178 [F2FS_XATTR_INDEX_SECURITY] = &f2fs_xattr_security_handler,
180 [F2FS_XATTR_INDEX_ADVISE] = &f2fs_xattr_advise_handler,
183 const struct xattr_handler *f2fs_xattr_handlers[] = {
184 &f2fs_xattr_user_handler,
185 #ifdef CONFIG_F2FS_FS_POSIX_ACL
186 &posix_acl_access_xattr_handler,
187 &posix_acl_default_xattr_handler,
189 &f2fs_xattr_trusted_handler,
190 #ifdef CONFIG_F2FS_FS_SECURITY
191 &f2fs_xattr_security_handler,
193 &f2fs_xattr_advise_handler,
197 static inline const struct xattr_handler *f2fs_xattr_handler(int index)
199 const struct xattr_handler *handler = NULL;
201 if (index > 0 && index < ARRAY_SIZE(f2fs_xattr_handler_map))
202 handler = f2fs_xattr_handler_map[index];
206 static struct f2fs_xattr_entry *__find_xattr(void *base_addr,
207 void *last_base_addr, int index,
208 size_t len, const char *name)
210 struct f2fs_xattr_entry *entry;
212 list_for_each_xattr(entry, base_addr) {
213 if ((void *)(entry) + sizeof(__u32) > last_base_addr ||
214 (void *)XATTR_NEXT_ENTRY(entry) > last_base_addr)
217 if (entry->e_name_index != index)
219 if (entry->e_name_len != len)
221 if (!memcmp(entry->e_name, name, len))
227 static struct f2fs_xattr_entry *__find_inline_xattr(struct inode *inode,
228 void *base_addr, void **last_addr, int index,
229 size_t len, const char *name)
231 struct f2fs_xattr_entry *entry;
232 unsigned int inline_size = inline_xattr_size(inode);
233 void *max_addr = base_addr + inline_size;
235 list_for_each_xattr(entry, base_addr) {
236 if ((void *)entry + sizeof(__u32) > max_addr ||
237 (void *)XATTR_NEXT_ENTRY(entry) > max_addr) {
241 if (entry->e_name_index != index)
243 if (entry->e_name_len != len)
245 if (!memcmp(entry->e_name, name, len))
249 /* inline xattr header or entry across max inline xattr size */
250 if (IS_XATTR_LAST_ENTRY(entry) &&
251 (void *)entry + sizeof(__u32) > max_addr) {
258 static int read_inline_xattr(struct inode *inode, struct page *ipage,
261 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
262 unsigned int inline_size = inline_xattr_size(inode);
263 struct page *page = NULL;
267 inline_addr = inline_xattr_addr(inode, ipage);
269 page = f2fs_get_node_page(sbi, inode->i_ino);
271 return PTR_ERR(page);
273 inline_addr = inline_xattr_addr(inode, page);
275 memcpy(txattr_addr, inline_addr, inline_size);
276 f2fs_put_page(page, 1);
281 static int read_xattr_block(struct inode *inode, void *txattr_addr)
283 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
284 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
285 unsigned int inline_size = inline_xattr_size(inode);
289 /* The inode already has an extended attribute block. */
290 xpage = f2fs_get_node_page(sbi, xnid);
292 return PTR_ERR(xpage);
294 xattr_addr = page_address(xpage);
295 memcpy(txattr_addr + inline_size, xattr_addr, VALID_XATTR_BLOCK_SIZE);
296 f2fs_put_page(xpage, 1);
301 static int lookup_all_xattrs(struct inode *inode, struct page *ipage,
302 unsigned int index, unsigned int len,
303 const char *name, struct f2fs_xattr_entry **xe,
304 void **base_addr, int *base_size)
306 void *cur_addr, *txattr_addr, *last_txattr_addr;
307 void *last_addr = NULL;
308 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
309 unsigned int inline_size = inline_xattr_size(inode);
312 if (!xnid && !inline_size)
315 *base_size = XATTR_SIZE(xnid, inode) + XATTR_PADDING_SIZE;
316 txattr_addr = f2fs_kzalloc(F2FS_I_SB(inode), *base_size, GFP_NOFS);
320 last_txattr_addr = (void *)txattr_addr + XATTR_SIZE(xnid, inode);
322 /* read from inline xattr */
324 err = read_inline_xattr(inode, ipage, txattr_addr);
328 *xe = __find_inline_xattr(inode, txattr_addr, &last_addr,
331 *base_size = inline_size;
336 /* read from xattr node block */
338 err = read_xattr_block(inode, txattr_addr);
344 cur_addr = XATTR_HDR(last_addr) - 1;
346 cur_addr = txattr_addr;
348 *xe = __find_xattr(cur_addr, last_txattr_addr, index, len, name);
350 f2fs_err(F2FS_I_SB(inode), "inode (%lu) has corrupted xattr",
352 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
357 if (IS_XATTR_LAST_ENTRY(*xe)) {
362 *base_addr = txattr_addr;
369 static int read_all_xattrs(struct inode *inode, struct page *ipage,
372 struct f2fs_xattr_header *header;
373 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
374 unsigned int size = VALID_XATTR_BLOCK_SIZE;
375 unsigned int inline_size = inline_xattr_size(inode);
379 txattr_addr = f2fs_kzalloc(F2FS_I_SB(inode),
380 inline_size + size + XATTR_PADDING_SIZE, GFP_NOFS);
384 /* read from inline xattr */
386 err = read_inline_xattr(inode, ipage, txattr_addr);
391 /* read from xattr node block */
393 err = read_xattr_block(inode, txattr_addr);
398 header = XATTR_HDR(txattr_addr);
400 /* never been allocated xattrs */
401 if (le32_to_cpu(header->h_magic) != F2FS_XATTR_MAGIC) {
402 header->h_magic = cpu_to_le32(F2FS_XATTR_MAGIC);
403 header->h_refcount = cpu_to_le32(1);
405 *base_addr = txattr_addr;
412 static inline int write_all_xattrs(struct inode *inode, __u32 hsize,
413 void *txattr_addr, struct page *ipage)
415 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
416 size_t inline_size = inline_xattr_size(inode);
417 struct page *in_page = NULL;
419 void *inline_addr = NULL;
424 if (hsize > inline_size && !F2FS_I(inode)->i_xattr_nid)
425 if (!f2fs_alloc_nid(sbi, &new_nid))
428 /* write to inline xattr */
431 inline_addr = inline_xattr_addr(inode, ipage);
433 in_page = f2fs_get_node_page(sbi, inode->i_ino);
434 if (IS_ERR(in_page)) {
435 f2fs_alloc_nid_failed(sbi, new_nid);
436 return PTR_ERR(in_page);
438 inline_addr = inline_xattr_addr(inode, in_page);
441 f2fs_wait_on_page_writeback(ipage ? ipage : in_page,
443 /* no need to use xattr node block */
444 if (hsize <= inline_size) {
445 err = f2fs_truncate_xattr_node(inode);
446 f2fs_alloc_nid_failed(sbi, new_nid);
448 f2fs_put_page(in_page, 1);
451 memcpy(inline_addr, txattr_addr, inline_size);
452 set_page_dirty(ipage ? ipage : in_page);
457 /* write to xattr node block */
458 if (F2FS_I(inode)->i_xattr_nid) {
459 xpage = f2fs_get_node_page(sbi, F2FS_I(inode)->i_xattr_nid);
461 err = PTR_ERR(xpage);
462 f2fs_alloc_nid_failed(sbi, new_nid);
465 f2fs_bug_on(sbi, new_nid);
466 f2fs_wait_on_page_writeback(xpage, NODE, true, true);
468 struct dnode_of_data dn;
469 set_new_dnode(&dn, inode, NULL, NULL, new_nid);
470 xpage = f2fs_new_node_page(&dn, XATTR_NODE_OFFSET);
472 err = PTR_ERR(xpage);
473 f2fs_alloc_nid_failed(sbi, new_nid);
476 f2fs_alloc_nid_done(sbi, new_nid);
478 xattr_addr = page_address(xpage);
481 memcpy(inline_addr, txattr_addr, inline_size);
482 memcpy(xattr_addr, txattr_addr + inline_size, VALID_XATTR_BLOCK_SIZE);
485 set_page_dirty(ipage ? ipage : in_page);
486 set_page_dirty(xpage);
488 f2fs_put_page(xpage, 1);
490 f2fs_put_page(in_page, 1);
494 int f2fs_getxattr(struct inode *inode, int index, const char *name,
495 void *buffer, size_t buffer_size, struct page *ipage)
497 struct f2fs_xattr_entry *entry = NULL;
499 unsigned int size, len;
500 void *base_addr = NULL;
507 if (len > F2FS_NAME_LEN)
510 down_read(&F2FS_I(inode)->i_xattr_sem);
511 error = lookup_all_xattrs(inode, ipage, index, len, name,
512 &entry, &base_addr, &base_size);
513 up_read(&F2FS_I(inode)->i_xattr_sem);
517 size = le16_to_cpu(entry->e_value_size);
519 if (buffer && size > buffer_size) {
525 char *pval = entry->e_name + entry->e_name_len;
527 if (base_size - (pval - (char *)base_addr) < size) {
531 memcpy(buffer, pval, size);
539 ssize_t f2fs_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
541 struct inode *inode = d_inode(dentry);
542 struct f2fs_xattr_entry *entry;
545 size_t rest = buffer_size;
547 down_read(&F2FS_I(inode)->i_xattr_sem);
548 error = read_all_xattrs(inode, NULL, &base_addr);
549 up_read(&F2FS_I(inode)->i_xattr_sem);
553 list_for_each_xattr(entry, base_addr) {
554 const struct xattr_handler *handler =
555 f2fs_xattr_handler(entry->e_name_index);
560 if (!handler || (handler->list && !handler->list(dentry)))
563 prefix = xattr_prefix(handler);
564 prefix_len = strlen(prefix);
565 size = prefix_len + entry->e_name_len + 1;
571 memcpy(buffer, prefix, prefix_len);
572 buffer += prefix_len;
573 memcpy(buffer, entry->e_name, entry->e_name_len);
574 buffer += entry->e_name_len;
579 error = buffer_size - rest;
585 static bool f2fs_xattr_value_same(struct f2fs_xattr_entry *entry,
586 const void *value, size_t size)
588 void *pval = entry->e_name + entry->e_name_len;
590 return (le16_to_cpu(entry->e_value_size) == size) &&
591 !memcmp(pval, value, size);
594 static int __f2fs_setxattr(struct inode *inode, int index,
595 const char *name, const void *value, size_t size,
596 struct page *ipage, int flags)
598 struct f2fs_xattr_entry *here, *last;
599 void *base_addr, *last_base_addr;
600 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
614 if (len > F2FS_NAME_LEN)
617 if (size > MAX_VALUE_LEN(inode))
620 error = read_all_xattrs(inode, ipage, &base_addr);
624 last_base_addr = (void *)base_addr + XATTR_SIZE(xnid, inode);
626 /* find entry with wanted name. */
627 here = __find_xattr(base_addr, last_base_addr, index, len, name);
629 f2fs_err(F2FS_I_SB(inode), "inode (%lu) has corrupted xattr",
631 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
632 error = -EFSCORRUPTED;
636 found = IS_XATTR_LAST_ENTRY(here) ? 0 : 1;
639 if ((flags & XATTR_CREATE)) {
644 if (value && f2fs_xattr_value_same(here, value, size))
646 } else if ((flags & XATTR_REPLACE)) {
652 while (!IS_XATTR_LAST_ENTRY(last))
653 last = XATTR_NEXT_ENTRY(last);
655 newsize = XATTR_ALIGN(sizeof(struct f2fs_xattr_entry) + len + size);
661 * If value is NULL, it is remove operation.
662 * In case of update operation, we calculate free.
664 free = MIN_OFFSET(inode) - ((char *)last - (char *)base_addr);
666 free = free + ENTRY_SIZE(here);
668 if (unlikely(free < newsize)) {
674 /* 2. Remove old entry */
677 * If entry is found, remove old entry.
678 * If not found, remove operation is not needed.
680 struct f2fs_xattr_entry *next = XATTR_NEXT_ENTRY(here);
681 int oldsize = ENTRY_SIZE(here);
683 memmove(here, next, (char *)last - (char *)next);
684 last = (struct f2fs_xattr_entry *)((char *)last - oldsize);
685 memset(last, 0, oldsize);
688 new_hsize = (char *)last - (char *)base_addr;
690 /* 3. Write new entry */
694 * Before we come here, old entry is removed.
695 * We just write new entry.
697 last->e_name_index = index;
698 last->e_name_len = len;
699 memcpy(last->e_name, name, len);
700 pval = last->e_name + len;
701 memcpy(pval, value, size);
702 last->e_value_size = cpu_to_le16(size);
703 new_hsize += newsize;
706 error = write_all_xattrs(inode, new_hsize, base_addr, ipage);
710 if (is_inode_flag_set(inode, FI_ACL_MODE)) {
711 inode->i_mode = F2FS_I(inode)->i_acl_mode;
712 inode->i_ctime = current_time(inode);
713 clear_inode_flag(inode, FI_ACL_MODE);
715 if (index == F2FS_XATTR_INDEX_ENCRYPTION &&
716 !strcmp(name, F2FS_XATTR_NAME_ENCRYPTION_CONTEXT))
717 f2fs_set_encrypted_inode(inode);
718 f2fs_mark_inode_dirty_sync(inode, true);
719 if (!error && S_ISDIR(inode->i_mode))
720 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_CP);
726 int f2fs_setxattr(struct inode *inode, int index, const char *name,
727 const void *value, size_t size,
728 struct page *ipage, int flags)
730 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
733 if (unlikely(f2fs_cp_error(sbi)))
735 if (!f2fs_is_checkpoint_ready(sbi))
738 err = dquot_initialize(inode);
742 /* this case is only from f2fs_init_inode_metadata */
744 return __f2fs_setxattr(inode, index, name, value,
746 f2fs_balance_fs(sbi, true);
749 /* protect xattr_ver */
750 down_write(&F2FS_I(inode)->i_sem);
751 down_write(&F2FS_I(inode)->i_xattr_sem);
752 err = __f2fs_setxattr(inode, index, name, value, size, ipage, flags);
753 up_write(&F2FS_I(inode)->i_xattr_sem);
754 up_write(&F2FS_I(inode)->i_sem);
757 f2fs_update_time(sbi, REQ_TIME);