fs/f2fs/xattr.c

   1 /*
   2  * fs/f2fs/xattr.c
   3  *
   4  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   5  *             http://www.samsung.com/
   6  *
   7  * Portions of this code from linux/fs/ext2/xattr.c
   8  *
   9  * Copyright (C) 2001-2003 Andreas Gruenbacher <agruen@suse.de>
  10  *
  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>,
  15  *  Red Hat Inc.
  16  *
  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.
  20  */
  21 #include <linux/rwsem.h>
  22 #include <linux/f2fs_fs.h>
  23 #include "f2fs.h"
  24 #include "xattr.h"
  25
  26 static size_t f2fs_xattr_generic_list(struct dentry *dentry, char *list,
  27                 size_t list_size, const char *name, size_t name_len, int type)
  28 {
  29         struct f2fs_sb_info *sbi = F2FS_SB(dentry->d_sb);
  30         int total_len, prefix_len = 0;
  31         const char *prefix = NULL;
  32
  33         switch (type) {
  34         case F2FS_XATTR_INDEX_USER:
  35                 if (!test_opt(sbi, XATTR_USER))
  36                         return -EOPNOTSUPP;
  37                 prefix = XATTR_USER_PREFIX;
  38                 prefix_len = XATTR_USER_PREFIX_LEN;
  39                 break;
  40         case F2FS_XATTR_INDEX_TRUSTED:
  41                 if (!capable(CAP_SYS_ADMIN))
  42                         return -EPERM;
  43                 prefix = XATTR_TRUSTED_PREFIX;
  44                 prefix_len = XATTR_TRUSTED_PREFIX_LEN;
  45                 break;
  46         default:
  47                 return -EINVAL;
  48         }
  49
  50         total_len = prefix_len + name_len + 1;
  51         if (list && total_len <= list_size) {
  52                 memcpy(list, prefix, prefix_len);
  53                 memcpy(list+prefix_len, name, name_len);
  54                 list[prefix_len + name_len] = '\0';
  55         }
  56         return total_len;
  57 }
  58
  59 static int f2fs_xattr_generic_get(struct dentry *dentry, const char *name,
  60                 void *buffer, size_t size, int type)
  61 {
  62         struct f2fs_sb_info *sbi = F2FS_SB(dentry->d_sb);
  63
  64         switch (type) {
  65         case F2FS_XATTR_INDEX_USER:
  66                 if (!test_opt(sbi, XATTR_USER))
  67                         return -EOPNOTSUPP;
  68                 break;
  69         case F2FS_XATTR_INDEX_TRUSTED:
  70                 if (!capable(CAP_SYS_ADMIN))
  71                         return -EPERM;
  72                 break;
  73         default:
  74                 return -EINVAL;
  75         }
  76         if (strcmp(name, "") == 0)
  77                 return -EINVAL;
  78         return f2fs_getxattr(dentry->d_inode, type, name,
  79                         buffer, size);
  80 }
  81
  82 static int f2fs_xattr_generic_set(struct dentry *dentry, const char *name,
  83                 const void *value, size_t size, int flags, int type)
  84 {
  85         struct f2fs_sb_info *sbi = F2FS_SB(dentry->d_sb);
  86
  87         switch (type) {
  88         case F2FS_XATTR_INDEX_USER:
  89                 if (!test_opt(sbi, XATTR_USER))
  90                         return -EOPNOTSUPP;
  91                 break;
  92         case F2FS_XATTR_INDEX_TRUSTED:
  93                 if (!capable(CAP_SYS_ADMIN))
  94                         return -EPERM;
  95                 break;
  96         default:
  97                 return -EINVAL;
  98         }
  99         if (strcmp(name, "") == 0)
 100                 return -EINVAL;
 101
 102         return f2fs_setxattr(dentry->d_inode, type, name, value, size);
 103 }
 104
 105 static size_t f2fs_xattr_advise_list(struct dentry *dentry, char *list,
 106                 size_t list_size, const char *name, size_t name_len, int type)
 107 {
 108         const char *xname = F2FS_SYSTEM_ADVISE_PREFIX;
 109         size_t size;
 110
 111         if (type != F2FS_XATTR_INDEX_ADVISE)
 112                 return 0;
 113
 114         size = strlen(xname) + 1;
 115         if (list && size <= list_size)
 116                 memcpy(list, xname, size);
 117         return size;
 118 }
 119
 120 static int f2fs_xattr_advise_get(struct dentry *dentry, const char *name,
 121                 void *buffer, size_t size, int type)
 122 {
 123         struct inode *inode = dentry->d_inode;
 124
 125         if (strcmp(name, "") != 0)
 126                 return -EINVAL;
 127
 128         *((char *)buffer) = F2FS_I(inode)->i_advise;
 129         return sizeof(char);
 130 }
 131
 132 static int f2fs_xattr_advise_set(struct dentry *dentry, const char *name,
 133                 const void *value, size_t size, int flags, int type)
 134 {
 135         struct inode *inode = dentry->d_inode;
 136
 137         if (strcmp(name, "") != 0)
 138                 return -EINVAL;
 139         if (!inode_owner_or_capable(inode))
 140                 return -EPERM;
 141         if (value == NULL)
 142                 return -EINVAL;
 143
 144         F2FS_I(inode)->i_advise |= *(char *)value;
 145         return 0;
 146 }
 147
 148 const struct xattr_handler f2fs_xattr_user_handler = {
 149         .prefix = XATTR_USER_PREFIX,
 150         .flags  = F2FS_XATTR_INDEX_USER,
 151         .list   = f2fs_xattr_generic_list,
 152         .get    = f2fs_xattr_generic_get,
 153         .set    = f2fs_xattr_generic_set,
 154 };
 155
 156 const struct xattr_handler f2fs_xattr_trusted_handler = {
 157         .prefix = XATTR_TRUSTED_PREFIX,
 158         .flags  = F2FS_XATTR_INDEX_TRUSTED,
 159         .list   = f2fs_xattr_generic_list,
 160         .get    = f2fs_xattr_generic_get,
 161         .set    = f2fs_xattr_generic_set,
 162 };
 163
 164 const struct xattr_handler f2fs_xattr_advise_handler = {
 165         .prefix = F2FS_SYSTEM_ADVISE_PREFIX,
 166         .flags  = F2FS_XATTR_INDEX_ADVISE,
 167         .list   = f2fs_xattr_advise_list,
 168         .get    = f2fs_xattr_advise_get,
 169         .set    = f2fs_xattr_advise_set,
 170 };
 171
 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] = &f2fs_xattr_acl_access_handler,
 176         [F2FS_XATTR_INDEX_POSIX_ACL_DEFAULT] = &f2fs_xattr_acl_default_handler,
 177 #endif
 178         [F2FS_XATTR_INDEX_TRUSTED] = &f2fs_xattr_trusted_handler,
 179         [F2FS_XATTR_INDEX_ADVISE] = &f2fs_xattr_advise_handler,
 180 };
 181
 182 const struct xattr_handler *f2fs_xattr_handlers[] = {
 183         &f2fs_xattr_user_handler,
 184 #ifdef CONFIG_F2FS_FS_POSIX_ACL
 185         &f2fs_xattr_acl_access_handler,
 186         &f2fs_xattr_acl_default_handler,
 187 #endif
 188         &f2fs_xattr_trusted_handler,
 189         &f2fs_xattr_advise_handler,
 190         NULL,
 191 };
 192
 193 static inline const struct xattr_handler *f2fs_xattr_handler(int name_index)
 194 {
 195         const struct xattr_handler *handler = NULL;
 196
 197         if (name_index > 0 && name_index < ARRAY_SIZE(f2fs_xattr_handler_map))
 198                 handler = f2fs_xattr_handler_map[name_index];
 199         return handler;
 200 }
 201
 202 int f2fs_getxattr(struct inode *inode, int name_index, const char *name,
 203                 void *buffer, size_t buffer_size)
 204 {
 205         struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
 206         struct f2fs_inode_info *fi = F2FS_I(inode);
 207         struct f2fs_xattr_entry *entry;
 208         struct page *page;
 209         void *base_addr;
 210         int error = 0, found = 0;
 211         size_t value_len, name_len;
 212
 213         if (name == NULL)
 214                 return -EINVAL;
 215         name_len = strlen(name);
 216
 217         if (!fi->i_xattr_nid)
 218                 return -ENODATA;
 219
 220         page = get_node_page(sbi, fi->i_xattr_nid);
 221         if (IS_ERR(page))
 222                 return PTR_ERR(page);
 223         base_addr = page_address(page);
 224
 225         list_for_each_xattr(entry, base_addr) {
 226                 if (entry->e_name_index != name_index)
 227                         continue;
 228                 if (entry->e_name_len != name_len)
 229                         continue;
 230                 if (!memcmp(entry->e_name, name, name_len)) {
 231                         found = 1;
 232                         break;
 233                 }
 234         }
 235         if (!found) {
 236                 error = -ENODATA;
 237                 goto cleanup;
 238         }
 239
 240         value_len = le16_to_cpu(entry->e_value_size);
 241
 242         if (buffer && value_len > buffer_size) {
 243                 error = -ERANGE;
 244                 goto cleanup;
 245         }
 246
 247         if (buffer) {
 248                 char *pval = entry->e_name + entry->e_name_len;
 249                 memcpy(buffer, pval, value_len);
 250         }
 251         error = value_len;
 252
 253 cleanup:
 254         f2fs_put_page(page, 1);
 255         return error;
 256 }
 257
 258 ssize_t f2fs_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
 259 {
 260         struct inode *inode = dentry->d_inode;
 261         struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
 262         struct f2fs_inode_info *fi = F2FS_I(inode);
 263         struct f2fs_xattr_entry *entry;
 264         struct page *page;
 265         void *base_addr;
 266         int error = 0;
 267         size_t rest = buffer_size;
 268
 269         if (!fi->i_xattr_nid)
 270                 return 0;
 271
 272         page = get_node_page(sbi, fi->i_xattr_nid);
 273         if (IS_ERR(page))
 274                 return PTR_ERR(page);
 275         base_addr = page_address(page);
 276
 277         list_for_each_xattr(entry, base_addr) {
 278                 const struct xattr_handler *handler =
 279                         f2fs_xattr_handler(entry->e_name_index);
 280                 size_t size;
 281
 282                 if (!handler)
 283                         continue;
 284
 285                 size = handler->list(dentry, buffer, rest, entry->e_name,
 286                                 entry->e_name_len, handler->flags);
 287                 if (buffer && size > rest) {
 288                         error = -ERANGE;
 289                         goto cleanup;
 290                 }
 291
 292                 if (buffer)
 293                         buffer += size;
 294                 rest -= size;
 295         }
 296         error = buffer_size - rest;
 297 cleanup:
 298         f2fs_put_page(page, 1);
 299         return error;
 300 }
 301
 302 int f2fs_setxattr(struct inode *inode, int name_index, const char *name,
 303                                         const void *value, size_t value_len)
 304 {
 305         struct f2fs_sb_info *sbi = F2FS_SB(inode->i_sb);
 306         struct f2fs_inode_info *fi = F2FS_I(inode);
 307         struct f2fs_xattr_header *header = NULL;
 308         struct f2fs_xattr_entry *here, *last;
 309         struct page *page;
 310         void *base_addr;
 311         int error, found, free, newsize;
 312         size_t name_len;
 313         char *pval;
 314         int ilock;
 315
 316         if (name == NULL)
 317                 return -EINVAL;
 318
 319         if (value == NULL)
 320                 value_len = 0;
 321
 322         name_len = strlen(name);
 323
 324         if (name_len > F2FS_NAME_LEN || value_len > MAX_VALUE_LEN)
 325                 return -ERANGE;
 326
 327         f2fs_balance_fs(sbi);
 328
 329         ilock = mutex_lock_op(sbi);
 330
 331         if (!fi->i_xattr_nid) {
 332                 /* Allocate new attribute block */
 333                 struct dnode_of_data dn;
 334
 335                 if (!alloc_nid(sbi, &fi->i_xattr_nid)) {
 336                         error = -ENOSPC;
 337                         goto exit;
 338                 }
 339                 set_new_dnode(&dn, inode, NULL, NULL, fi->i_xattr_nid);
 340                 mark_inode_dirty(inode);
 341
 342                 page = new_node_page(&dn, XATTR_NODE_OFFSET);
 343                 if (IS_ERR(page)) {
 344                         alloc_nid_failed(sbi, fi->i_xattr_nid);
 345                         fi->i_xattr_nid = 0;
 346                         error = PTR_ERR(page);
 347                         goto exit;
 348                 }
 349
 350                 alloc_nid_done(sbi, fi->i_xattr_nid);
 351                 base_addr = page_address(page);
 352                 header = XATTR_HDR(base_addr);
 353                 header->h_magic = cpu_to_le32(F2FS_XATTR_MAGIC);
 354                 header->h_refcount = cpu_to_le32(1);
 355         } else {
 356                 /* The inode already has an extended attribute block. */
 357                 page = get_node_page(sbi, fi->i_xattr_nid);
 358                 if (IS_ERR(page)) {
 359                         error = PTR_ERR(page);
 360                         goto exit;
 361                 }
 362
 363                 base_addr = page_address(page);
 364                 header = XATTR_HDR(base_addr);
 365         }
 366
 367         if (le32_to_cpu(header->h_magic) != F2FS_XATTR_MAGIC) {
 368                 error = -EIO;
 369                 goto cleanup;
 370         }
 371
 372         /* find entry with wanted name. */
 373         found = 0;
 374         list_for_each_xattr(here, base_addr) {
 375                 if (here->e_name_index != name_index)
 376                         continue;
 377                 if (here->e_name_len != name_len)
 378                         continue;
 379                 if (!memcmp(here->e_name, name, name_len)) {
 380                         found = 1;
 381                         break;
 382                 }
 383         }
 384
 385         last = here;
 386
 387         while (!IS_XATTR_LAST_ENTRY(last))
 388                 last = XATTR_NEXT_ENTRY(last);
 389
 390         newsize = XATTR_ALIGN(sizeof(struct f2fs_xattr_entry) +
 391                         name_len + value_len);
 392
 393         /* 1. Check space */
 394         if (value) {
 395                 /* If value is NULL, it is remove operation.
 396                  * In case of update operation, we caculate free.
 397                  */
 398                 free = MIN_OFFSET - ((char *)last - (char *)header);
 399                 if (found)
 400                         free = free - ENTRY_SIZE(here);
 401
 402                 if (free < newsize) {
 403                         error = -ENOSPC;
 404                         goto cleanup;
 405                 }
 406         }
 407
 408         /* 2. Remove old entry */
 409         if (found) {
 410                 /* If entry is found, remove old entry.
 411                  * If not found, remove operation is not needed.
 412                  */
 413                 struct f2fs_xattr_entry *next = XATTR_NEXT_ENTRY(here);
 414                 int oldsize = ENTRY_SIZE(here);
 415
 416                 memmove(here, next, (char *)last - (char *)next);
 417                 last = (struct f2fs_xattr_entry *)((char *)last - oldsize);
 418                 memset(last, 0, oldsize);
 419         }
 420
 421         /* 3. Write new entry */
 422         if (value) {
 423                 /* Before we come here, old entry is removed.
 424                  * We just write new entry. */
 425                 memset(last, 0, newsize);
 426                 last->e_name_index = name_index;
 427                 last->e_name_len = name_len;
 428                 memcpy(last->e_name, name, name_len);
 429                 pval = last->e_name + name_len;
 430                 memcpy(pval, value, value_len);
 431                 last->e_value_size = cpu_to_le16(value_len);
 432         }
 433
 434         set_page_dirty(page);
 435         f2fs_put_page(page, 1);
 436
 437         if (is_inode_flag_set(fi, FI_ACL_MODE)) {
 438                 inode->i_mode = fi->i_acl_mode;
 439                 inode->i_ctime = CURRENT_TIME;
 440                 clear_inode_flag(fi, FI_ACL_MODE);
 441         }
 442         update_inode_page(inode);
 443         mutex_unlock_op(sbi, ilock);
 444
 445         return 0;
 446 cleanup:
 447         f2fs_put_page(page, 1);
 448 exit:
 449         mutex_unlock_op(sbi, ilock);
 450         return error;
 451 }