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 = kmalloc(size, GFP_NOFS);
 142         if (!ui->data) {
 143                 err = -ENOMEM;
 144                 goto out_free;
 145         }
 146         memcpy(ui->data, value, size);
 147         inode->i_size = ui->ui_size = size;
 148         ui->data_len = size;
 149
 150         mutex_lock(&host_ui->ui_mutex);
 151         host->i_ctime = ubifs_current_time(host);
 152         host_ui->xattr_cnt += 1;
 153         host_ui->xattr_size += CALC_DENT_SIZE(nm->len);
 154         host_ui->xattr_size += CALC_XATTR_BYTES(size);
 155         host_ui->xattr_names += nm->len;
 156
 157         err = ubifs_jnl_update(c, host, nm, inode, 0, 1);
 158         if (err)
 159                 goto out_cancel;
 160         mutex_unlock(&host_ui->ui_mutex);
 161
 162         ubifs_release_budget(c, &req);
 163         insert_inode_hash(inode);
 164         iput(inode);
 165         return 0;
 166
 167 out_cancel:
 168         host_ui->xattr_cnt -= 1;
 169         host_ui->xattr_size -= CALC_DENT_SIZE(nm->len);
 170         host_ui->xattr_size -= CALC_XATTR_BYTES(size);
 171         host_ui->xattr_names -= nm->len;
 172         mutex_unlock(&host_ui->ui_mutex);
 173 out_free:
 174         make_bad_inode(inode);
 175         iput(inode);
 176 out_budg:
 177         ubifs_release_budget(c, &req);
 178         return err;
 179 }
 180
 181 /**
 182  * change_xattr - change an extended attribute.
 183  * @c: UBIFS file-system description object
 184  * @host: host inode
 185  * @inode: extended attribute inode
 186  * @value: extended attribute value
 187  * @size: size of extended attribute value
 188  *
 189  * This helper function changes the value of extended attribute @inode with new
 190  * data from @value. Returns zero in case of success and a negative error code
 191  * in case of failure.
 192  */
 193 static int change_xattr(struct ubifs_info *c, struct inode *host,
 194                         struct inode *inode, const void *value, int size)
 195 {
 196         int err;
 197         struct ubifs_inode *host_ui = ubifs_inode(host);
 198         struct ubifs_inode *ui = ubifs_inode(inode);
 199         struct ubifs_budget_req req = { .dirtied_ino = 2,
 200                 .dirtied_ino_d = ALIGN(size, 8) + ALIGN(host_ui->data_len, 8) };
 201
 202         ubifs_assert(ui->data_len == inode->i_size);
 203         err = ubifs_budget_space(c, &req);
 204         if (err)
 205                 return err;
 206
 207         kfree(ui->data);
 208         ui->data = kmalloc(size, GFP_NOFS);
 209         if (!ui->data) {
 210                 err = -ENOMEM;
 211                 goto out_free;
 212         }
 213         memcpy(ui->data, value, size);
 214         inode->i_size = ui->ui_size = size;
 215         ui->data_len = size;
 216
 217         mutex_lock(&host_ui->ui_mutex);
 218         host->i_ctime = ubifs_current_time(host);
 219         host_ui->xattr_size -= CALC_XATTR_BYTES(ui->data_len);
 220         host_ui->xattr_size += CALC_XATTR_BYTES(size);
 221
 222         /*
 223          * It is important to write the host inode after the xattr inode
 224          * because if the host inode gets synchronized (via 'fsync()'), then
 225          * the extended attribute inode gets synchronized, because it goes
 226          * before the host inode in the write-buffer.
 227          */
 228         err = ubifs_jnl_change_xattr(c, inode, host);
 229         if (err)
 230                 goto out_cancel;
 231         mutex_unlock(&host_ui->ui_mutex);
 232
 233         ubifs_release_budget(c, &req);
 234         return 0;
 235
 236 out_cancel:
 237         host_ui->xattr_size -= CALC_XATTR_BYTES(size);
 238         host_ui->xattr_size += CALC_XATTR_BYTES(ui->data_len);
 239         mutex_unlock(&host_ui->ui_mutex);
 240         make_bad_inode(inode);
 241 out_free:
 242         ubifs_release_budget(c, &req);
 243         return err;
 244 }
 245
 246 /**
 247  * check_namespace - check extended attribute name-space.
 248  * @nm: extended attribute name
 249  *
 250  * This function makes sure the extended attribute name belongs to one of the
 251  * supported extended attribute name-spaces. Returns name-space index in case
 252  * of success and a negative error code in case of failure.
 253  */
 254 static int check_namespace(const struct qstr *nm)
 255 {
 256         int type;
 257
 258         if (nm->len > UBIFS_MAX_NLEN)
 259                 return -ENAMETOOLONG;
 260
 261         if (!strncmp(nm->name, XATTR_TRUSTED_PREFIX,
 262                      XATTR_TRUSTED_PREFIX_LEN)) {
 263                 if (nm->name[sizeof(XATTR_TRUSTED_PREFIX) - 1] == '\0')
 264                         return -EINVAL;
 265                 type = TRUSTED_XATTR;
 266         } else if (!strncmp(nm->name, XATTR_USER_PREFIX,
 267                                       XATTR_USER_PREFIX_LEN)) {
 268                 if (nm->name[XATTR_USER_PREFIX_LEN] == '\0')
 269                         return -EINVAL;
 270                 type = USER_XATTR;
 271         } else if (!strncmp(nm->name, XATTR_SECURITY_PREFIX,
 272                                      XATTR_SECURITY_PREFIX_LEN)) {
 273                 if (nm->name[sizeof(XATTR_SECURITY_PREFIX) - 1] == '\0')
 274                         return -EINVAL;
 275                 type = SECURITY_XATTR;
 276         } else
 277                 return -EOPNOTSUPP;
 278
 279         return type;
 280 }
 281
 282 static struct inode *iget_xattr(struct ubifs_info *c, ino_t inum)
 283 {
 284         struct inode *inode;
 285
 286         inode = ubifs_iget(c->vfs_sb, inum);
 287         if (IS_ERR(inode)) {
 288                 ubifs_err("dead extended attribute entry, error %d",
 289                           (int)PTR_ERR(inode));
 290                 return inode;
 291         }
 292         if (ubifs_inode(inode)->xattr)
 293                 return inode;
 294         ubifs_err("corrupt extended attribute entry");
 295         iput(inode);
 296         return ERR_PTR(-EINVAL);
 297 }
 298
 299 int ubifs_setxattr(struct dentry *dentry, const char *name,
 300                    const void *value, size_t size, int flags)
 301 {
 302         struct inode *inode, *host = dentry->d_inode;
 303         struct ubifs_info *c = host->i_sb->s_fs_info;
 304         struct qstr nm = { .name = name, .len = strlen(name) };
 305         struct ubifs_dent_node *xent;
 306         union ubifs_key key;
 307         int err, type;
 308
 309         dbg_gen("xattr '%s', host ino %lu ('%.*s'), size %zd", name,
 310                 host->i_ino, dentry->d_name.len, dentry->d_name.name, size);
 311         ubifs_assert(mutex_is_locked(&host->i_mutex));
 312
 313         if (size > UBIFS_MAX_INO_DATA)
 314                 return -ERANGE;
 315
 316         type = check_namespace(&nm);
 317         if (type < 0)
 318                 return type;
 319
 320         xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
 321         if (!xent)
 322                 return -ENOMEM;
 323
 324         /*
 325          * The extended attribute entries are stored in LNC, so multiple
 326          * look-ups do not involve reading the flash.
 327          */
 328         xent_key_init(c, &key, host->i_ino, &nm);
 329         err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
 330         if (err) {
 331                 if (err != -ENOENT)
 332                         goto out_free;
 333
 334                 if (flags & XATTR_REPLACE)
 335                         /* We are asked not to create the xattr */
 336                         err = -ENODATA;
 337                 else
 338                         err = create_xattr(c, host, &nm, value, size);
 339                 goto out_free;
 340         }
 341
 342         if (flags & XATTR_CREATE) {
 343                 /* We are asked not to replace the xattr */
 344                 err = -EEXIST;
 345                 goto out_free;
 346         }
 347
 348         inode = iget_xattr(c, le64_to_cpu(xent->inum));
 349         if (IS_ERR(inode)) {
 350                 err = PTR_ERR(inode);
 351                 goto out_free;
 352         }
 353
 354         err = change_xattr(c, host, inode, value, size);
 355         iput(inode);
 356
 357 out_free:
 358         kfree(xent);
 359         return err;
 360 }
 361
 362 ssize_t ubifs_getxattr(struct dentry *dentry, const char *name, void *buf,
 363                        size_t size)
 364 {
 365         struct inode *inode, *host = dentry->d_inode;
 366         struct ubifs_info *c = host->i_sb->s_fs_info;
 367         struct qstr nm = { .name = name, .len = strlen(name) };
 368         struct ubifs_inode *ui;
 369         struct ubifs_dent_node *xent;
 370         union ubifs_key key;
 371         int err;
 372
 373         dbg_gen("xattr '%s', ino %lu ('%.*s'), buf size %zd", name,
 374                 host->i_ino, dentry->d_name.len, dentry->d_name.name, size);
 375
 376         err = check_namespace(&nm);
 377         if (err < 0)
 378                 return err;
 379
 380         xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
 381         if (!xent)
 382                 return -ENOMEM;
 383
 384         xent_key_init(c, &key, host->i_ino, &nm);
 385         err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
 386         if (err) {
 387                 if (err == -ENOENT)
 388                         err = -ENODATA;
 389                 goto out_unlock;
 390         }
 391
 392         inode = iget_xattr(c, le64_to_cpu(xent->inum));
 393         if (IS_ERR(inode)) {
 394                 err = PTR_ERR(inode);
 395                 goto out_unlock;
 396         }
 397
 398         ui = ubifs_inode(inode);
 399         ubifs_assert(inode->i_size == ui->data_len);
 400         ubifs_assert(ubifs_inode(host)->xattr_size > ui->data_len);
 401
 402         if (buf) {
 403                 /* If @buf is %NULL we are supposed to return the length */
 404                 if (ui->data_len > size) {
 405                         dbg_err("buffer size %zd, xattr len %d",
 406                                 size, ui->data_len);
 407                         err = -ERANGE;
 408                         goto out_iput;
 409                 }
 410
 411                 memcpy(buf, ui->data, ui->data_len);
 412         }
 413         err = ui->data_len;
 414
 415 out_iput:
 416         iput(inode);
 417 out_unlock:
 418         kfree(xent);
 419         return err;
 420 }
 421
 422 ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size)
 423 {
 424         union ubifs_key key;
 425         struct inode *host = dentry->d_inode;
 426         struct ubifs_info *c = host->i_sb->s_fs_info;
 427         struct ubifs_inode *host_ui = ubifs_inode(host);
 428         struct ubifs_dent_node *xent, *pxent = NULL;
 429         int err, len, written = 0;
 430         struct qstr nm = { .name = NULL };
 431
 432         dbg_gen("ino %lu ('%.*s'), buffer size %zd", host->i_ino,
 433                 dentry->d_name.len, dentry->d_name.name, size);
 434
 435         len = host_ui->xattr_names + host_ui->xattr_cnt;
 436         if (!buffer)
 437                 /*
 438                  * We should return the minimum buffer size which will fit a
 439                  * null-terminated list of all the extended attribute names.
 440                  */
 441                 return len;
 442
 443         if (len > size)
 444                 return -ERANGE;
 445
 446         lowest_xent_key(c, &key, host->i_ino);
 447         while (1) {
 448                 int type;
 449
 450                 xent = ubifs_tnc_next_ent(c, &key, &nm);
 451                 if (IS_ERR(xent)) {
 452                         err = PTR_ERR(xent);
 453                         break;
 454                 }
 455
 456                 nm.name = xent->name;
 457                 nm.len = le16_to_cpu(xent->nlen);
 458
 459                 type = check_namespace(&nm);
 460                 if (unlikely(type < 0)) {
 461                         err = type;
 462                         break;
 463                 }
 464
 465                 /* Show trusted namespace only for "power" users */
 466                 if (type != TRUSTED_XATTR || capable(CAP_SYS_ADMIN)) {
 467                         memcpy(buffer + written, nm.name, nm.len + 1);
 468                         written += nm.len + 1;
 469                 }
 470
 471                 kfree(pxent);
 472                 pxent = xent;
 473                 key_read(c, &xent->key, &key);
 474         }
 475
 476         kfree(pxent);
 477         if (err != -ENOENT) {
 478                 ubifs_err("cannot find next direntry, error %d", err);
 479                 return err;
 480         }
 481
 482         ubifs_assert(written <= size);
 483         return written;
 484 }
 485
 486 static int remove_xattr(struct ubifs_info *c, struct inode *host,
 487                         struct inode *inode, const struct qstr *nm)
 488 {
 489         int err;
 490         struct ubifs_inode *host_ui = ubifs_inode(host);
 491         struct ubifs_inode *ui = ubifs_inode(inode);
 492         struct ubifs_budget_req req = { .dirtied_ino = 2, .mod_dent = 1,
 493                                 .dirtied_ino_d = ALIGN(host_ui->data_len, 8) };
 494
 495         ubifs_assert(ui->data_len == inode->i_size);
 496
 497         err = ubifs_budget_space(c, &req);
 498         if (err)
 499                 return err;
 500
 501         mutex_lock(&host_ui->ui_mutex);
 502         host->i_ctime = ubifs_current_time(host);
 503         host_ui->xattr_cnt -= 1;
 504         host_ui->xattr_size -= CALC_DENT_SIZE(nm->len);
 505         host_ui->xattr_size -= CALC_XATTR_BYTES(ui->data_len);
 506         host_ui->xattr_names -= nm->len;
 507
 508         err = ubifs_jnl_delete_xattr(c, host, inode, nm);
 509         if (err)
 510                 goto out_cancel;
 511         mutex_unlock(&host_ui->ui_mutex);
 512
 513         ubifs_release_budget(c, &req);
 514         return 0;
 515
 516 out_cancel:
 517         host_ui->xattr_cnt += 1;
 518         host_ui->xattr_size += CALC_DENT_SIZE(nm->len);
 519         host_ui->xattr_size += CALC_XATTR_BYTES(ui->data_len);
 520         host_ui->xattr_names += nm->len;
 521         mutex_unlock(&host_ui->ui_mutex);
 522         ubifs_release_budget(c, &req);
 523         make_bad_inode(inode);
 524         return err;
 525 }
 526
 527 int ubifs_removexattr(struct dentry *dentry, const char *name)
 528 {
 529         struct inode *inode, *host = dentry->d_inode;
 530         struct ubifs_info *c = host->i_sb->s_fs_info;
 531         struct qstr nm = { .name = name, .len = strlen(name) };
 532         struct ubifs_dent_node *xent;
 533         union ubifs_key key;
 534         int err;
 535
 536         dbg_gen("xattr '%s', ino %lu ('%.*s')", name,
 537                 host->i_ino, dentry->d_name.len, dentry->d_name.name);
 538         ubifs_assert(mutex_is_locked(&host->i_mutex));
 539
 540         err = check_namespace(&nm);
 541         if (err < 0)
 542                 return err;
 543
 544         xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
 545         if (!xent)
 546                 return -ENOMEM;
 547
 548         xent_key_init(c, &key, host->i_ino, &nm);
 549         err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
 550         if (err) {
 551                 if (err == -ENOENT)
 552                         err = -ENODATA;
 553                 goto out_free;
 554         }
 555
 556         inode = iget_xattr(c, le64_to_cpu(xent->inum));
 557         if (IS_ERR(inode)) {
 558                 err = PTR_ERR(inode);
 559                 goto out_free;
 560         }
 561
 562         ubifs_assert(inode->i_nlink == 1);
 563         clear_nlink(inode);
 564         err = remove_xattr(c, host, inode, &nm);
 565         if (err)
 566                 set_nlink(inode, 1);
 567
 568         /* If @i_nlink is 0, 'iput()' will delete the inode */
 569         iput(inode);
 570
 571 out_free:
 572         kfree(xent);
 573         return err;
 574 }