fs/ubifs/xattr.c

   1 /*
   2  * This file is part of UBIFS.
   3  *
   4  * Copyright (C) 2006-2008 Nokia Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published by
   8  * the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program; if not, write to the Free Software Foundation, Inc., 51
  17  * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  *
  19  * Authors: Artem Bityutskiy (Битюцкий Артём)
  20  *          Adrian Hunter
  21  */
  22
  23 /*
  24  * This file implements UBIFS extended attributes support.
  25  *
  26  * Extended attributes are implemented as regular inodes with attached data,
  27  * which limits extended attribute size to UBIFS block size (4KiB). Names of
  28  * extended attributes are described by extended attribute entries (xentries),
  29  * which are almost identical to directory entries, but have different key type.
  30  *
  31  * In other words, the situation with extended attributes is very similar to
  32  * directories. Indeed, any inode (but of course not xattr inodes) may have a
  33  * number of associated xentries, just like directory inodes have associated
  34  * directory entries. Extended attribute entries store the name of the extended
  35  * attribute, the host inode number, and the extended attribute inode number.
  36  * Similarly, direntries store the name, the parent and the target inode
  37  * numbers. Thus, most of the common UBIFS mechanisms may be re-used for
  38  * extended attributes.
  39  *
  40  * The number of extended attributes is not limited, but there is Linux
  41  * limitation on the maximum possible size of the list of all extended
  42  * attributes associated with an inode (%XATTR_LIST_MAX), so UBIFS makes sure
  43  * the sum of all extended attribute names of the inode does not exceed that
  44  * limit.
  45  *
  46  * Extended attributes are synchronous, which means they are written to the
  47  * flash media synchronously and there is no write-back for extended attribute
  48  * inodes. The extended attribute values are not stored in compressed form on
  49  * the media.
  50  *
  51  * Since extended attributes are represented by regular inodes, they are cached
  52  * in the VFS inode cache. The xentries are cached in the LNC cache (see
  53  * tnc.c).
  54  *
  55  * ACL support is not implemented.
  56  */
  57
  58 #include "ubifs.h"
  59 #include <linux/fs.h>
  60 #include <linux/slab.h>
  61 #include <linux/xattr.h>
  62 #include <linux/posix_acl_xattr.h>
  63
  64 /*
  65  * Limit the number of extended attributes per inode so that the total size
  66  * (@xattr_size) is guaranteeded to fit in an 'unsigned int'.
  67  */
  68 #define MAX_XATTRS_PER_INODE 65535
  69
  70 /*
  71  * Extended attribute type constants.
  72  *
  73  * USER_XATTR: user extended attribute ("user.*")
  74  * TRUSTED_XATTR: trusted extended attribute ("trusted.*)
  75  * SECURITY_XATTR: security extended attribute ("security.*")
  76  */
  77 enum {
  78         USER_XATTR,
  79         TRUSTED_XATTR,
  80         SECURITY_XATTR,
  81 };
  82
  83 static const struct inode_operations empty_iops;
  84 static const struct file_operations empty_fops;
  85
  86 /**
  87  * create_xattr - create an extended attribute.
  88  * @c: UBIFS file-system description object
  89  * @host: host inode
  90  * @nm: extended attribute name
  91  * @value: extended attribute value
  92  * @size: size of extended attribute value
  93  *
  94  * This is a helper function which creates an extended attribute of name @nm
  95  * and value @value for inode @host. The host inode is also updated on flash
  96  * because the ctime and extended attribute accounting data changes. This
  97  * function returns zero in case of success and a negative error code in case
  98  * of failure.
  99  */
 100 static int create_xattr(struct ubifs_info *c, struct inode *host,
 101                         const struct qstr *nm, const void *value, int size)
 102 {
 103         int err;
 104         struct inode *inode;
 105         struct ubifs_inode *ui, *host_ui = ubifs_inode(host);
 106         struct ubifs_budget_req req = { .new_ino = 1, .new_dent = 1,
 107                                 .new_ino_d = ALIGN(size, 8), .dirtied_ino = 1,
 108                                 .dirtied_ino_d = ALIGN(host_ui->data_len, 8) };
 109
 110         if (host_ui->xattr_cnt >= MAX_XATTRS_PER_INODE)
 111                 return -ENOSPC;
 112         /*
 113          * Linux limits the maximum size of the extended attribute names list
 114          * to %XATTR_LIST_MAX. This means we should not allow creating more
 115          * extended attributes if the name list becomes larger. This limitation
 116          * is artificial for UBIFS, though.
 117          */
 118         if (host_ui->xattr_names + host_ui->xattr_cnt +
 119                                         nm->len + 1 > XATTR_LIST_MAX)
 120                 return -ENOSPC;
 121
 122         err = ubifs_budget_space(c, &req);
 123         if (err)
 124                 return err;
 125
 126         inode = ubifs_new_inode(c, host, S_IFREG | S_IRWXUGO);
 127         if (IS_ERR(inode)) {
 128                 err = PTR_ERR(inode);
 129                 goto out_budg;
 130         }
 131
 132         /* Re-define all operations to be "nothing" */
 133         inode->i_mapping->a_ops = &empty_aops;
 134         inode->i_op = &empty_iops;
 135         inode->i_fop = &empty_fops;
 136
 137         inode->i_flags |= S_SYNC | S_NOATIME | S_NOCMTIME | S_NOQUOTA;
 138         ui = ubifs_inode(inode);
 139         ui->xattr = 1;
 140         ui->flags |= UBIFS_XATTR_FL;
 141         ui->data = kmemdup(value, size, GFP_NOFS);
 142         if (!ui->data) {
 143                 err = -ENOMEM;
 144                 goto out_free;
 145         }
 146         inode->i_size = ui->ui_size = size;
 147         ui->data_len = size;
 148
 149         mutex_lock(&host_ui->ui_mutex);
 150         host->i_ctime = ubifs_current_time(host);
 151         host_ui->xattr_cnt += 1;
 152         host_ui->xattr_size += CALC_DENT_SIZE(nm->len);
 153         host_ui->xattr_size += CALC_XATTR_BYTES(size);
 154         host_ui->xattr_names += nm->len;
 155
 156         err = ubifs_jnl_update(c, host, nm, inode, 0, 1);
 157         if (err)
 158                 goto out_cancel;
 159         mutex_unlock(&host_ui->ui_mutex);
 160
 161         ubifs_release_budget(c, &req);
 162         insert_inode_hash(inode);
 163         iput(inode);
 164         return 0;
 165
 166 out_cancel:
 167         host_ui->xattr_cnt -= 1;
 168         host_ui->xattr_size -= CALC_DENT_SIZE(nm->len);
 169         host_ui->xattr_size -= CALC_XATTR_BYTES(size);
 170         host_ui->xattr_names -= nm->len;
 171         mutex_unlock(&host_ui->ui_mutex);
 172 out_free:
 173         make_bad_inode(inode);
 174         iput(inode);
 175 out_budg:
 176         ubifs_release_budget(c, &req);
 177         return err;
 178 }
 179
 180 /**
 181  * change_xattr - change an extended attribute.
 182  * @c: UBIFS file-system description object
 183  * @host: host inode
 184  * @inode: extended attribute inode
 185  * @value: extended attribute value
 186  * @size: size of extended attribute value
 187  *
 188  * This helper function changes the value of extended attribute @inode with new
 189  * data from @value. Returns zero in case of success and a negative error code
 190  * in case of failure.
 191  */
 192 static int change_xattr(struct ubifs_info *c, struct inode *host,
 193                         struct inode *inode, const void *value, int size)
 194 {
 195         int err;
 196         struct ubifs_inode *host_ui = ubifs_inode(host);
 197         struct ubifs_inode *ui = ubifs_inode(inode);
 198         struct ubifs_budget_req req = { .dirtied_ino = 2,
 199                 .dirtied_ino_d = ALIGN(size, 8) + ALIGN(host_ui->data_len, 8) };
 200
 201         ubifs_assert(ui->data_len == inode->i_size);
 202         err = ubifs_budget_space(c, &req);
 203         if (err)
 204                 return err;
 205
 206         kfree(ui->data);
 207         ui->data = kmemdup(value, size, GFP_NOFS);
 208         if (!ui->data) {
 209                 err = -ENOMEM;
 210                 goto out_free;
 211         }
 212         inode->i_size = ui->ui_size = size;
 213         ui->data_len = size;
 214
 215         mutex_lock(&host_ui->ui_mutex);
 216         host->i_ctime = ubifs_current_time(host);
 217         host_ui->xattr_size -= CALC_XATTR_BYTES(ui->data_len);
 218         host_ui->xattr_size += CALC_XATTR_BYTES(size);
 219
 220         /*
 221          * It is important to write the host inode after the xattr inode
 222          * because if the host inode gets synchronized (via 'fsync()'), then
 223          * the extended attribute inode gets synchronized, because it goes
 224          * before the host inode in the write-buffer.
 225          */
 226         err = ubifs_jnl_change_xattr(c, inode, host);
 227         if (err)
 228                 goto out_cancel;
 229         mutex_unlock(&host_ui->ui_mutex);
 230
 231         ubifs_release_budget(c, &req);
 232         return 0;
 233
 234 out_cancel:
 235         host_ui->xattr_size -= CALC_XATTR_BYTES(size);
 236         host_ui->xattr_size += CALC_XATTR_BYTES(ui->data_len);
 237         mutex_unlock(&host_ui->ui_mutex);
 238         make_bad_inode(inode);
 239 out_free:
 240         ubifs_release_budget(c, &req);
 241         return err;
 242 }
 243
 244 /**
 245  * check_namespace - check extended attribute name-space.
 246  * @nm: extended attribute name
 247  *
 248  * This function makes sure the extended attribute name belongs to one of the
 249  * supported extended attribute name-spaces. Returns name-space index in case
 250  * of success and a negative error code in case of failure.
 251  */
 252 static int check_namespace(const struct qstr *nm)
 253 {
 254         int type;
 255
 256         if (nm->len > UBIFS_MAX_NLEN)
 257                 return -ENAMETOOLONG;
 258
 259         if (!strncmp(nm->name, XATTR_TRUSTED_PREFIX,
 260                      XATTR_TRUSTED_PREFIX_LEN)) {
 261                 if (nm->name[sizeof(XATTR_TRUSTED_PREFIX) - 1] == '\0')
 262                         return -EINVAL;
 263                 type = TRUSTED_XATTR;
 264         } else if (!strncmp(nm->name, XATTR_USER_PREFIX,
 265                                       XATTR_USER_PREFIX_LEN)) {
 266                 if (nm->name[XATTR_USER_PREFIX_LEN] == '\0')
 267                         return -EINVAL;
 268                 type = USER_XATTR;
 269         } else if (!strncmp(nm->name, XATTR_SECURITY_PREFIX,
 270                                      XATTR_SECURITY_PREFIX_LEN)) {
 271                 if (nm->name[sizeof(XATTR_SECURITY_PREFIX) - 1] == '\0')
 272                         return -EINVAL;
 273                 type = SECURITY_XATTR;
 274         } else
 275                 return -EOPNOTSUPP;
 276
 277         return type;
 278 }
 279
 280 static struct inode *iget_xattr(struct ubifs_info *c, ino_t inum)
 281 {
 282         struct inode *inode;
 283
 284         inode = ubifs_iget(c->vfs_sb, inum);
 285         if (IS_ERR(inode)) {
 286                 ubifs_err("dead extended attribute entry, error %d",
 287                           (int)PTR_ERR(inode));
 288                 return inode;
 289         }
 290         if (ubifs_inode(inode)->xattr)
 291                 return inode;
 292         ubifs_err("corrupt extended attribute entry");
 293         iput(inode);
 294         return ERR_PTR(-EINVAL);
 295 }
 296
 297 int ubifs_setxattr(struct dentry *dentry, const char *name,
 298                    const void *value, size_t size, int flags)
 299 {
 300         struct inode *inode, *host = dentry->d_inode;
 301         struct ubifs_info *c = host->i_sb->s_fs_info;
 302         struct qstr nm = { .name = name, .len = strlen(name) };
 303         struct ubifs_dent_node *xent;
 304         union ubifs_key key;
 305         int err, type;
 306
 307         dbg_gen("xattr '%s', host ino %lu ('%.*s'), size %zd", name,
 308                 host->i_ino, dentry->d_name.len, dentry->d_name.name, size);
 309         ubifs_assert(mutex_is_locked(&host->i_mutex));
 310
 311         if (size > UBIFS_MAX_INO_DATA)
 312                 return -ERANGE;
 313
 314         type = check_namespace(&nm);
 315         if (type < 0)
 316                 return type;
 317
 318         xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
 319         if (!xent)
 320                 return -ENOMEM;
 321
 322         /*
 323          * The extended attribute entries are stored in LNC, so multiple
 324          * look-ups do not involve reading the flash.
 325          */
 326         xent_key_init(c, &key, host->i_ino, &nm);
 327         err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
 328         if (err) {
 329                 if (err != -ENOENT)
 330                         goto out_free;
 331
 332                 if (flags & XATTR_REPLACE)
 333                         /* We are asked not to create the xattr */
 334                         err = -ENODATA;
 335                 else
 336                         err = create_xattr(c, host, &nm, value, size);
 337                 goto out_free;
 338         }
 339
 340         if (flags & XATTR_CREATE) {
 341                 /* We are asked not to replace the xattr */
 342                 err = -EEXIST;
 343                 goto out_free;
 344         }
 345
 346         inode = iget_xattr(c, le64_to_cpu(xent->inum));
 347         if (IS_ERR(inode)) {
 348                 err = PTR_ERR(inode);
 349                 goto out_free;
 350         }
 351
 352         err = change_xattr(c, host, inode, value, size);
 353         iput(inode);
 354
 355 out_free:
 356         kfree(xent);
 357         return err;
 358 }
 359
 360 ssize_t ubifs_getxattr(struct dentry *dentry, const char *name, void *buf,
 361                        size_t size)
 362 {
 363         struct inode *inode, *host = dentry->d_inode;
 364         struct ubifs_info *c = host->i_sb->s_fs_info;
 365         struct qstr nm = { .name = name, .len = strlen(name) };
 366         struct ubifs_inode *ui;
 367         struct ubifs_dent_node *xent;
 368         union ubifs_key key;
 369         int err;
 370
 371         dbg_gen("xattr '%s', ino %lu ('%.*s'), buf size %zd", name,
 372                 host->i_ino, dentry->d_name.len, dentry->d_name.name, size);
 373
 374         err = check_namespace(&nm);
 375         if (err < 0)
 376                 return err;
 377
 378         xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
 379         if (!xent)
 380                 return -ENOMEM;
 381
 382         xent_key_init(c, &key, host->i_ino, &nm);
 383         err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
 384         if (err) {
 385                 if (err == -ENOENT)
 386                         err = -ENODATA;
 387                 goto out_unlock;
 388         }
 389
 390         inode = iget_xattr(c, le64_to_cpu(xent->inum));
 391         if (IS_ERR(inode)) {
 392                 err = PTR_ERR(inode);
 393                 goto out_unlock;
 394         }
 395
 396         ui = ubifs_inode(inode);
 397         ubifs_assert(inode->i_size == ui->data_len);
 398         ubifs_assert(ubifs_inode(host)->xattr_size > ui->data_len);
 399
 400         if (buf) {
 401                 /* If @buf is %NULL we are supposed to return the length */
 402                 if (ui->data_len > size) {
 403                         ubifs_err("buffer size %zd, xattr len %d",
 404                                   size, ui->data_len);
 405                         err = -ERANGE;
 406                         goto out_iput;
 407                 }
 408
 409                 memcpy(buf, ui->data, ui->data_len);
 410         }
 411         err = ui->data_len;
 412
 413 out_iput:
 414         iput(inode);
 415 out_unlock:
 416         kfree(xent);
 417         return err;
 418 }
 419
 420 ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size)
 421 {
 422         union ubifs_key key;
 423         struct inode *host = dentry->d_inode;
 424         struct ubifs_info *c = host->i_sb->s_fs_info;
 425         struct ubifs_inode *host_ui = ubifs_inode(host);
 426         struct ubifs_dent_node *xent, *pxent = NULL;
 427         int err, len, written = 0;
 428         struct qstr nm = { .name = NULL };
 429
 430         dbg_gen("ino %lu ('%.*s'), buffer size %zd", host->i_ino,
 431                 dentry->d_name.len, dentry->d_name.name, size);
 432
 433         len = host_ui->xattr_names + host_ui->xattr_cnt;
 434         if (!buffer)
 435                 /*
 436                  * We should return the minimum buffer size which will fit a
 437                  * null-terminated list of all the extended attribute names.
 438                  */
 439                 return len;
 440
 441         if (len > size)
 442                 return -ERANGE;
 443
 444         lowest_xent_key(c, &key, host->i_ino);
 445         while (1) {
 446                 int type;
 447
 448                 xent = ubifs_tnc_next_ent(c, &key, &nm);
 449                 if (IS_ERR(xent)) {
 450                         err = PTR_ERR(xent);
 451                         break;
 452                 }
 453
 454                 nm.name = xent->name;
 455                 nm.len = le16_to_cpu(xent->nlen);
 456
 457                 type = check_namespace(&nm);
 458                 if (unlikely(type < 0)) {
 459                         err = type;
 460                         break;
 461                 }
 462
 463                 /* Show trusted namespace only for "power" users */
 464                 if (type != TRUSTED_XATTR || capable(CAP_SYS_ADMIN)) {
 465                         memcpy(buffer + written, nm.name, nm.len + 1);
 466                         written += nm.len + 1;
 467                 }
 468
 469                 kfree(pxent);
 470                 pxent = xent;
 471                 key_read(c, &xent->key, &key);
 472         }
 473
 474         kfree(pxent);
 475         if (err != -ENOENT) {
 476                 ubifs_err("cannot find next direntry, error %d", err);
 477                 return err;
 478         }
 479
 480         ubifs_assert(written <= size);
 481         return written;
 482 }
 483
 484 /**
 485  * ubifs_evict_xattr_inode - Evict an xattr inode.
 486  * @c: UBIFS file-system description object
 487  * @xattr_inum: xattr inode number
 488  *
 489  * When an inode that hosts xattrs is being removed we have to make sure
 490  * that cached inodes of the xattrs also get removed from the inode cache
 491  * otherwise we'd waste memory. This function looks up an inode from the
 492  * inode cache and clears the link counter such that iput() will evict
 493  * the inode.
 494  */
 495 void ubifs_evict_xattr_inode(struct ubifs_info *c, ino_t xattr_inum)
 496 {
 497         struct inode *inode;
 498
 499         inode = ilookup(c->vfs_sb, xattr_inum);
 500         if (inode) {
 501                 clear_nlink(inode);
 502                 iput(inode);
 503         }
 504 }
 505
 506 static int remove_xattr(struct ubifs_info *c, struct inode *host,
 507                         struct inode *inode, const struct qstr *nm)
 508 {
 509         int err;
 510         struct ubifs_inode *host_ui = ubifs_inode(host);
 511         struct ubifs_inode *ui = ubifs_inode(inode);
 512         struct ubifs_budget_req req = { .dirtied_ino = 2, .mod_dent = 1,
 513                                 .dirtied_ino_d = ALIGN(host_ui->data_len, 8) };
 514
 515         ubifs_assert(ui->data_len == inode->i_size);
 516
 517         err = ubifs_budget_space(c, &req);
 518         if (err)
 519                 return err;
 520
 521         mutex_lock(&host_ui->ui_mutex);
 522         host->i_ctime = ubifs_current_time(host);
 523         host_ui->xattr_cnt -= 1;
 524         host_ui->xattr_size -= CALC_DENT_SIZE(nm->len);
 525         host_ui->xattr_size -= CALC_XATTR_BYTES(ui->data_len);
 526         host_ui->xattr_names -= nm->len;
 527
 528         err = ubifs_jnl_delete_xattr(c, host, inode, nm);
 529         if (err)
 530                 goto out_cancel;
 531         mutex_unlock(&host_ui->ui_mutex);
 532
 533         ubifs_release_budget(c, &req);
 534         return 0;
 535
 536 out_cancel:
 537         host_ui->xattr_cnt += 1;
 538         host_ui->xattr_size += CALC_DENT_SIZE(nm->len);
 539         host_ui->xattr_size += CALC_XATTR_BYTES(ui->data_len);
 540         host_ui->xattr_names += nm->len;
 541         mutex_unlock(&host_ui->ui_mutex);
 542         ubifs_release_budget(c, &req);
 543         make_bad_inode(inode);
 544         return err;
 545 }
 546
 547 int ubifs_removexattr(struct dentry *dentry, const char *name)
 548 {
 549         struct inode *inode, *host = dentry->d_inode;
 550         struct ubifs_info *c = host->i_sb->s_fs_info;
 551         struct qstr nm = { .name = name, .len = strlen(name) };
 552         struct ubifs_dent_node *xent;
 553         union ubifs_key key;
 554         int err;
 555
 556         dbg_gen("xattr '%s', ino %lu ('%.*s')", name,
 557                 host->i_ino, dentry->d_name.len, dentry->d_name.name);
 558         ubifs_assert(mutex_is_locked(&host->i_mutex));
 559
 560         err = check_namespace(&nm);
 561         if (err < 0)
 562                 return err;
 563
 564         xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
 565         if (!xent)
 566                 return -ENOMEM;
 567
 568         xent_key_init(c, &key, host->i_ino, &nm);
 569         err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
 570         if (err) {
 571                 if (err == -ENOENT)
 572                         err = -ENODATA;
 573                 goto out_free;
 574         }
 575
 576         inode = iget_xattr(c, le64_to_cpu(xent->inum));
 577         if (IS_ERR(inode)) {
 578                 err = PTR_ERR(inode);
 579                 goto out_free;
 580         }
 581
 582         ubifs_assert(inode->i_nlink == 1);
 583         clear_nlink(inode);
 584         err = remove_xattr(c, host, inode, &nm);
 585         if (err)
 586                 set_nlink(inode, 1);
 587
 588         /* If @i_nlink is 0, 'iput()' will delete the inode */
 589         iput(inode);
 590
 591 out_free:
 592         kfree(xent);
 593         return err;
 594 }