4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
7 * Portions of this code from linux/fs/ext2/xattr.c
9 * Copyright (C) 2001-2003 Andreas Gruenbacher <agruen@suse.de>
11 * Fix by Harrison Xing <harrison@mountainviewdata.com>.
12 * Extended attributes for symlinks and special files added per
13 * suggestion of Luka Renko <luka.renko@hermes.si>.
14 * xattr consolidation Copyright (c) 2004 James Morris <jmorris@redhat.com>,
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License version 2 as
19 * published by the Free Software Foundation.
21 #include <linux/rwsem.h>
22 #include <linux/f2fs_fs.h>
23 #include <linux/security.h>
24 #include <linux/posix_acl_xattr.h>
28 static int f2fs_xattr_generic_get(const struct xattr_handler *handler,
29 struct dentry *unused, struct inode *inode,
30 const char *name, void *buffer, size_t size)
32 struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
34 switch (handler->flags) {
35 case F2FS_XATTR_INDEX_USER:
36 if (!test_opt(sbi, XATTR_USER))
39 case F2FS_XATTR_INDEX_TRUSTED:
40 case F2FS_XATTR_INDEX_SECURITY:
45 return f2fs_getxattr(inode, handler->flags, name,
49 static int f2fs_xattr_generic_set(const struct xattr_handler *handler,
50 struct dentry *unused, struct inode *inode,
51 const char *name, const void *value,
52 size_t size, int flags)
54 struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
56 switch (handler->flags) {
57 case F2FS_XATTR_INDEX_USER:
58 if (!test_opt(sbi, XATTR_USER))
61 case F2FS_XATTR_INDEX_TRUSTED:
62 case F2FS_XATTR_INDEX_SECURITY:
67 return f2fs_setxattr(inode, handler->flags, name,
68 value, size, NULL, flags);
71 static bool f2fs_xattr_user_list(struct dentry *dentry)
73 struct f2fs_sb_info *sbi = F2FS_SB(dentry->d_sb);
75 return test_opt(sbi, XATTR_USER);
78 static bool f2fs_xattr_trusted_list(struct dentry *dentry)
80 return capable(CAP_SYS_ADMIN);
83 static int f2fs_xattr_advise_get(const struct xattr_handler *handler,
84 struct dentry *unused, struct inode *inode,
85 const char *name, void *buffer, size_t size)
88 *((char *)buffer) = F2FS_I(inode)->i_advise;
92 static int f2fs_xattr_advise_set(const struct xattr_handler *handler,
93 struct dentry *unused, struct inode *inode,
94 const char *name, const void *value,
95 size_t size, int flags)
97 unsigned char old_advise = F2FS_I(inode)->i_advise;
98 unsigned char new_advise;
100 if (!inode_owner_or_capable(inode))
105 new_advise = *(char *)value;
106 if (new_advise & ~FADVISE_MODIFIABLE_BITS)
109 new_advise = new_advise & FADVISE_MODIFIABLE_BITS;
110 new_advise |= old_advise & ~FADVISE_MODIFIABLE_BITS;
112 F2FS_I(inode)->i_advise = new_advise;
113 f2fs_mark_inode_dirty_sync(inode, true);
117 #ifdef CONFIG_F2FS_FS_SECURITY
118 static int f2fs_initxattrs(struct inode *inode, const struct xattr *xattr_array,
121 const struct xattr *xattr;
124 for (xattr = xattr_array; xattr->name != NULL; xattr++) {
125 err = f2fs_setxattr(inode, F2FS_XATTR_INDEX_SECURITY,
126 xattr->name, xattr->value,
127 xattr->value_len, (struct page *)page, 0);
134 int f2fs_init_security(struct inode *inode, struct inode *dir,
135 const struct qstr *qstr, struct page *ipage)
137 return security_inode_init_security(inode, dir, qstr,
138 &f2fs_initxattrs, ipage);
142 const struct xattr_handler f2fs_xattr_user_handler = {
143 .prefix = XATTR_USER_PREFIX,
144 .flags = F2FS_XATTR_INDEX_USER,
145 .list = f2fs_xattr_user_list,
146 .get = f2fs_xattr_generic_get,
147 .set = f2fs_xattr_generic_set,
150 const struct xattr_handler f2fs_xattr_trusted_handler = {
151 .prefix = XATTR_TRUSTED_PREFIX,
152 .flags = F2FS_XATTR_INDEX_TRUSTED,
153 .list = f2fs_xattr_trusted_list,
154 .get = f2fs_xattr_generic_get,
155 .set = f2fs_xattr_generic_set,
158 const struct xattr_handler f2fs_xattr_advise_handler = {
159 .name = F2FS_SYSTEM_ADVISE_NAME,
160 .flags = F2FS_XATTR_INDEX_ADVISE,
161 .get = f2fs_xattr_advise_get,
162 .set = f2fs_xattr_advise_set,
165 const struct xattr_handler f2fs_xattr_security_handler = {
166 .prefix = XATTR_SECURITY_PREFIX,
167 .flags = F2FS_XATTR_INDEX_SECURITY,
168 .get = f2fs_xattr_generic_get,
169 .set = f2fs_xattr_generic_set,
172 static const struct xattr_handler *f2fs_xattr_handler_map[] = {
173 [F2FS_XATTR_INDEX_USER] = &f2fs_xattr_user_handler,
174 #ifdef CONFIG_F2FS_FS_POSIX_ACL
175 [F2FS_XATTR_INDEX_POSIX_ACL_ACCESS] = &posix_acl_access_xattr_handler,
176 [F2FS_XATTR_INDEX_POSIX_ACL_DEFAULT] = &posix_acl_default_xattr_handler,
178 [F2FS_XATTR_INDEX_TRUSTED] = &f2fs_xattr_trusted_handler,
179 #ifdef CONFIG_F2FS_FS_SECURITY
180 [F2FS_XATTR_INDEX_SECURITY] = &f2fs_xattr_security_handler,
182 [F2FS_XATTR_INDEX_ADVISE] = &f2fs_xattr_advise_handler,
185 const struct xattr_handler *f2fs_xattr_handlers[] = {
186 &f2fs_xattr_user_handler,
187 #ifdef CONFIG_F2FS_FS_POSIX_ACL
188 &posix_acl_access_xattr_handler,
189 &posix_acl_default_xattr_handler,
191 &f2fs_xattr_trusted_handler,
192 #ifdef CONFIG_F2FS_FS_SECURITY
193 &f2fs_xattr_security_handler,
195 &f2fs_xattr_advise_handler,
199 static inline const struct xattr_handler *f2fs_xattr_handler(int index)
201 const struct xattr_handler *handler = NULL;
203 if (index > 0 && index < ARRAY_SIZE(f2fs_xattr_handler_map))
204 handler = f2fs_xattr_handler_map[index];
208 static struct f2fs_xattr_entry *__find_xattr(void *base_addr,
209 void *last_base_addr, int index,
210 size_t len, const char *name)
212 struct f2fs_xattr_entry *entry;
214 list_for_each_xattr(entry, base_addr) {
215 if ((void *)(entry) + sizeof(__u32) > last_base_addr ||
216 (void *)XATTR_NEXT_ENTRY(entry) > last_base_addr)
219 if (entry->e_name_index != index)
221 if (entry->e_name_len != len)
223 if (!memcmp(entry->e_name, name, len))
229 static struct f2fs_xattr_entry *__find_inline_xattr(struct inode *inode,
230 void *base_addr, void **last_addr, int index,
231 size_t len, const char *name)
233 struct f2fs_xattr_entry *entry;
234 unsigned int inline_size = inline_xattr_size(inode);
235 void *max_addr = base_addr + inline_size;
237 list_for_each_xattr(entry, base_addr) {
238 if ((void *)entry + sizeof(__u32) > max_addr ||
239 (void *)XATTR_NEXT_ENTRY(entry) > max_addr) {
243 if (entry->e_name_index != index)
245 if (entry->e_name_len != len)
247 if (!memcmp(entry->e_name, name, len))
251 /* inline xattr header or entry across max inline xattr size */
252 if (IS_XATTR_LAST_ENTRY(entry) &&
253 (void *)entry + sizeof(__u32) > max_addr) {
260 static int read_inline_xattr(struct inode *inode, struct page *ipage,
263 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
264 unsigned int inline_size = inline_xattr_size(inode);
265 struct page *page = NULL;
269 inline_addr = inline_xattr_addr(inode, ipage);
271 page = f2fs_get_node_page(sbi, inode->i_ino);
273 return PTR_ERR(page);
275 inline_addr = inline_xattr_addr(inode, page);
277 memcpy(txattr_addr, inline_addr, inline_size);
278 f2fs_put_page(page, 1);
283 static int read_xattr_block(struct inode *inode, void *txattr_addr)
285 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
286 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
287 unsigned int inline_size = inline_xattr_size(inode);
291 /* The inode already has an extended attribute block. */
292 xpage = f2fs_get_node_page(sbi, xnid);
294 return PTR_ERR(xpage);
296 xattr_addr = page_address(xpage);
297 memcpy(txattr_addr + inline_size, xattr_addr, VALID_XATTR_BLOCK_SIZE);
298 f2fs_put_page(xpage, 1);
303 static int lookup_all_xattrs(struct inode *inode, struct page *ipage,
304 unsigned int index, unsigned int len,
305 const char *name, struct f2fs_xattr_entry **xe,
306 void **base_addr, int *base_size)
308 void *cur_addr, *txattr_addr, *last_txattr_addr;
309 void *last_addr = NULL;
310 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
311 unsigned int inline_size = inline_xattr_size(inode);
314 if (!xnid && !inline_size)
317 *base_size = XATTR_SIZE(xnid, inode) + XATTR_PADDING_SIZE;
318 txattr_addr = f2fs_kzalloc(F2FS_I_SB(inode), *base_size, GFP_NOFS);
322 last_txattr_addr = (void *)txattr_addr + XATTR_SIZE(xnid, inode);
324 /* read from inline xattr */
326 err = read_inline_xattr(inode, ipage, txattr_addr);
330 *xe = __find_inline_xattr(inode, txattr_addr, &last_addr,
333 *base_size = inline_size;
338 /* read from xattr node block */
340 err = read_xattr_block(inode, txattr_addr);
346 cur_addr = XATTR_HDR(last_addr) - 1;
348 cur_addr = txattr_addr;
350 *xe = __find_xattr(cur_addr, last_txattr_addr, index, len, name);
356 if (IS_XATTR_LAST_ENTRY(*xe)) {
361 *base_addr = txattr_addr;
368 static int read_all_xattrs(struct inode *inode, struct page *ipage,
371 struct f2fs_xattr_header *header;
372 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
373 unsigned int size = VALID_XATTR_BLOCK_SIZE;
374 unsigned int inline_size = inline_xattr_size(inode);
378 txattr_addr = f2fs_kzalloc(F2FS_I_SB(inode),
379 inline_size + size + XATTR_PADDING_SIZE, GFP_NOFS);
383 /* read from inline xattr */
385 err = read_inline_xattr(inode, ipage, txattr_addr);
390 /* read from xattr node block */
392 err = read_xattr_block(inode, txattr_addr);
397 header = XATTR_HDR(txattr_addr);
399 /* never been allocated xattrs */
400 if (le32_to_cpu(header->h_magic) != F2FS_XATTR_MAGIC) {
401 header->h_magic = cpu_to_le32(F2FS_XATTR_MAGIC);
402 header->h_refcount = cpu_to_le32(1);
404 *base_addr = txattr_addr;
411 static inline int write_all_xattrs(struct inode *inode, __u32 hsize,
412 void *txattr_addr, struct page *ipage)
414 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
415 size_t inline_size = inline_xattr_size(inode);
416 struct page *in_page = NULL;
418 void *inline_addr = NULL;
423 if (hsize > inline_size && !F2FS_I(inode)->i_xattr_nid)
424 if (!f2fs_alloc_nid(sbi, &new_nid))
427 /* write to inline xattr */
430 inline_addr = inline_xattr_addr(inode, ipage);
432 in_page = f2fs_get_node_page(sbi, inode->i_ino);
433 if (IS_ERR(in_page)) {
434 f2fs_alloc_nid_failed(sbi, new_nid);
435 return PTR_ERR(in_page);
437 inline_addr = inline_xattr_addr(inode, in_page);
440 f2fs_wait_on_page_writeback(ipage ? ipage : in_page,
442 /* no need to use xattr node block */
443 if (hsize <= inline_size) {
444 err = f2fs_truncate_xattr_node(inode);
445 f2fs_alloc_nid_failed(sbi, new_nid);
447 f2fs_put_page(in_page, 1);
450 memcpy(inline_addr, txattr_addr, inline_size);
451 set_page_dirty(ipage ? ipage : in_page);
456 /* write to xattr node block */
457 if (F2FS_I(inode)->i_xattr_nid) {
458 xpage = f2fs_get_node_page(sbi, F2FS_I(inode)->i_xattr_nid);
460 err = PTR_ERR(xpage);
461 f2fs_alloc_nid_failed(sbi, new_nid);
464 f2fs_bug_on(sbi, new_nid);
465 f2fs_wait_on_page_writeback(xpage, NODE, true);
467 struct dnode_of_data dn;
468 set_new_dnode(&dn, inode, NULL, NULL, new_nid);
469 xpage = f2fs_new_node_page(&dn, XATTR_NODE_OFFSET);
471 err = PTR_ERR(xpage);
472 f2fs_alloc_nid_failed(sbi, new_nid);
475 f2fs_alloc_nid_done(sbi, new_nid);
477 xattr_addr = page_address(xpage);
480 memcpy(inline_addr, txattr_addr, inline_size);
481 memcpy(xattr_addr, txattr_addr + inline_size, VALID_XATTR_BLOCK_SIZE);
484 set_page_dirty(ipage ? ipage : in_page);
485 set_page_dirty(xpage);
487 f2fs_put_page(xpage, 1);
489 f2fs_put_page(in_page, 1);
493 int f2fs_getxattr(struct inode *inode, int index, const char *name,
494 void *buffer, size_t buffer_size, struct page *ipage)
496 struct f2fs_xattr_entry *entry = NULL;
498 unsigned int size, len;
499 void *base_addr = NULL;
506 if (len > F2FS_NAME_LEN)
509 down_read(&F2FS_I(inode)->i_xattr_sem);
510 error = lookup_all_xattrs(inode, ipage, index, len, name,
511 &entry, &base_addr, &base_size);
512 up_read(&F2FS_I(inode)->i_xattr_sem);
516 size = le16_to_cpu(entry->e_value_size);
518 if (buffer && size > buffer_size) {
524 char *pval = entry->e_name + entry->e_name_len;
526 if (base_size - (pval - (char *)base_addr) < size) {
530 memcpy(buffer, pval, size);
538 ssize_t f2fs_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
540 struct inode *inode = d_inode(dentry);
541 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
542 struct f2fs_xattr_entry *entry;
543 void *base_addr, *last_base_addr;
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 last_base_addr = (void *)base_addr + XATTR_SIZE(xnid, inode);
555 list_for_each_xattr(entry, base_addr) {
556 const struct xattr_handler *handler =
557 f2fs_xattr_handler(entry->e_name_index);
562 if ((void *)(entry) + sizeof(__u32) > last_base_addr ||
563 (void *)XATTR_NEXT_ENTRY(entry) > last_base_addr) {
564 f2fs_msg(dentry->d_sb, KERN_ERR,
565 "inode (%lu) has corrupted xattr",
567 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_FSCK);
568 error = -EFSCORRUPTED;
572 if (!handler || (handler->list && !handler->list(dentry)))
575 prefix = handler->prefix ?: handler->name;
576 prefix_len = strlen(prefix);
577 size = prefix_len + entry->e_name_len + 1;
583 memcpy(buffer, prefix, prefix_len);
584 buffer += prefix_len;
585 memcpy(buffer, entry->e_name, entry->e_name_len);
586 buffer += entry->e_name_len;
591 error = buffer_size - rest;
597 static bool f2fs_xattr_value_same(struct f2fs_xattr_entry *entry,
598 const void *value, size_t size)
600 void *pval = entry->e_name + entry->e_name_len;
602 return (le16_to_cpu(entry->e_value_size) == size) &&
603 !memcmp(pval, value, size);
606 static int __f2fs_setxattr(struct inode *inode, int index,
607 const char *name, const void *value, size_t size,
608 struct page *ipage, int flags)
610 struct f2fs_xattr_entry *here, *last;
611 void *base_addr, *last_base_addr;
612 nid_t xnid = F2FS_I(inode)->i_xattr_nid;
626 if (len > F2FS_NAME_LEN)
629 if (size > MAX_VALUE_LEN(inode))
632 error = read_all_xattrs(inode, ipage, &base_addr);
636 last_base_addr = (void *)base_addr + XATTR_SIZE(xnid, inode);
638 /* find entry with wanted name. */
639 here = __find_xattr(base_addr, last_base_addr, index, len, name);
641 error = -EFSCORRUPTED;
645 found = IS_XATTR_LAST_ENTRY(here) ? 0 : 1;
648 if ((flags & XATTR_CREATE)) {
653 if (value && f2fs_xattr_value_same(here, value, size))
655 } else if ((flags & XATTR_REPLACE)) {
661 while (!IS_XATTR_LAST_ENTRY(last))
662 last = XATTR_NEXT_ENTRY(last);
664 newsize = XATTR_ALIGN(sizeof(struct f2fs_xattr_entry) + len + size);
670 * If value is NULL, it is remove operation.
671 * In case of update operation, we calculate free.
673 free = MIN_OFFSET(inode) - ((char *)last - (char *)base_addr);
675 free = free + ENTRY_SIZE(here);
677 if (unlikely(free < newsize)) {
683 /* 2. Remove old entry */
686 * If entry is found, remove old entry.
687 * If not found, remove operation is not needed.
689 struct f2fs_xattr_entry *next = XATTR_NEXT_ENTRY(here);
690 int oldsize = ENTRY_SIZE(here);
692 memmove(here, next, (char *)last - (char *)next);
693 last = (struct f2fs_xattr_entry *)((char *)last - oldsize);
694 memset(last, 0, oldsize);
697 new_hsize = (char *)last - (char *)base_addr;
699 /* 3. Write new entry */
703 * Before we come here, old entry is removed.
704 * We just write new entry.
706 last->e_name_index = index;
707 last->e_name_len = len;
708 memcpy(last->e_name, name, len);
709 pval = last->e_name + len;
710 memcpy(pval, value, size);
711 last->e_value_size = cpu_to_le16(size);
712 new_hsize += newsize;
715 error = write_all_xattrs(inode, new_hsize, base_addr, ipage);
719 if (is_inode_flag_set(inode, FI_ACL_MODE)) {
720 inode->i_mode = F2FS_I(inode)->i_acl_mode;
721 inode->i_ctime = current_time(inode);
722 clear_inode_flag(inode, FI_ACL_MODE);
724 if (index == F2FS_XATTR_INDEX_ENCRYPTION &&
725 !strcmp(name, F2FS_XATTR_NAME_ENCRYPTION_CONTEXT))
726 f2fs_set_encrypted_inode(inode);
727 f2fs_mark_inode_dirty_sync(inode, true);
728 if (!error && S_ISDIR(inode->i_mode))
729 set_sbi_flag(F2FS_I_SB(inode), SBI_NEED_CP);
735 int f2fs_setxattr(struct inode *inode, int index, const char *name,
736 const void *value, size_t size,
737 struct page *ipage, int flags)
739 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
742 err = dquot_initialize(inode);
746 /* this case is only from f2fs_init_inode_metadata */
748 return __f2fs_setxattr(inode, index, name, value,
750 f2fs_balance_fs(sbi, true);
753 /* protect xattr_ver */
754 down_write(&F2FS_I(inode)->i_sem);
755 down_write(&F2FS_I(inode)->i_xattr_sem);
756 err = __f2fs_setxattr(inode, index, name, value, size, ipage, flags);
757 up_write(&F2FS_I(inode)->i_xattr_sem);
758 up_write(&F2FS_I(inode)->i_sem);
761 f2fs_update_time(sbi, REQ_TIME);