fs/libfs.c

   1 /*
   2  *      fs/libfs.c
   3  *      Library for filesystems writers.
   4  */
   5
   6 #include <linux/blkdev.h>
   7 #include <linux/export.h>
   8 #include <linux/pagemap.h>
   9 #include <linux/slab.h>
  10 #include <linux/mount.h>
  11 #include <linux/vfs.h>
  12 #include <linux/quotaops.h>
  13 #include <linux/mutex.h>
  14 #include <linux/namei.h>
  15 #include <linux/exportfs.h>
  16 #include <linux/writeback.h>
  17 #include <linux/buffer_head.h> /* sync_mapping_buffers */
  18
  19 #include <asm/uaccess.h>
  20
  21 #include "internal.h"
  22
  23 int simple_getattr(struct vfsmount *mnt, struct dentry *dentry,
  24                    struct kstat *stat)
  25 {
  26         struct inode *inode = d_inode(dentry);
  27         generic_fillattr(inode, stat);
  28         stat->blocks = inode->i_mapping->nrpages << (PAGE_SHIFT - 9);
  29         return 0;
  30 }
  31 EXPORT_SYMBOL(simple_getattr);
  32
  33 int simple_statfs(struct dentry *dentry, struct kstatfs *buf)
  34 {
  35         buf->f_type = dentry->d_sb->s_magic;
  36         buf->f_bsize = PAGE_SIZE;
  37         buf->f_namelen = NAME_MAX;
  38         return 0;
  39 }
  40 EXPORT_SYMBOL(simple_statfs);
  41
  42 /*
  43  * Retaining negative dentries for an in-memory filesystem just wastes
  44  * memory and lookup time: arrange for them to be deleted immediately.
  45  */
  46 int always_delete_dentry(const struct dentry *dentry)
  47 {
  48         return 1;
  49 }
  50 EXPORT_SYMBOL(always_delete_dentry);
  51
  52 const struct dentry_operations simple_dentry_operations = {
  53         .d_delete = always_delete_dentry,
  54 };
  55 EXPORT_SYMBOL(simple_dentry_operations);
  56
  57 /*
  58  * Lookup the data. This is trivial - if the dentry didn't already
  59  * exist, we know it is negative.  Set d_op to delete negative dentries.
  60  */
  61 struct dentry *simple_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags)
  62 {
  63         if (dentry->d_name.len > NAME_MAX)
  64                 return ERR_PTR(-ENAMETOOLONG);
  65         if (!dentry->d_sb->s_d_op)
  66                 d_set_d_op(dentry, &simple_dentry_operations);
  67         d_add(dentry, NULL);
  68         return NULL;
  69 }
  70 EXPORT_SYMBOL(simple_lookup);
  71
  72 int dcache_dir_open(struct inode *inode, struct file *file)
  73 {
  74         file->private_data = d_alloc_cursor(file->f_path.dentry);
  75
  76         return file->private_data ? 0 : -ENOMEM;
  77 }
  78 EXPORT_SYMBOL(dcache_dir_open);
  79
  80 int dcache_dir_close(struct inode *inode, struct file *file)
  81 {
  82         dput(file->private_data);
  83         return 0;
  84 }
  85 EXPORT_SYMBOL(dcache_dir_close);
  86
  87 /* parent is locked at least shared */
  88 static struct dentry *next_positive(struct dentry *parent,
  89                                     struct list_head *from,
  90                                     int count)
  91 {
  92         unsigned *seq = &parent->d_inode->i_dir_seq, n;
  93         struct dentry *res;
  94         struct list_head *p;
  95         bool skipped;
  96         int i;
  97
  98 retry:
  99         i = count;
 100         skipped = false;
 101         n = smp_load_acquire(seq) & ~1;
 102         res = NULL;
 103         rcu_read_lock();
 104         for (p = from->next; p != &parent->d_subdirs; p = p->next) {
 105                 struct dentry *d = list_entry(p, struct dentry, d_child);
 106                 if (!simple_positive(d)) {
 107                         skipped = true;
 108                 } else if (!--i) {
 109                         res = d;
 110                         break;
 111                 }
 112         }
 113         rcu_read_unlock();
 114         if (skipped) {
 115                 smp_rmb();
 116                 if (unlikely(*seq != n))
 117                         goto retry;
 118         }
 119         return res;
 120 }
 121
 122 static void move_cursor(struct dentry *cursor, struct list_head *after)
 123 {
 124         struct dentry *parent = cursor->d_parent;
 125         unsigned n, *seq = &parent->d_inode->i_dir_seq;
 126         spin_lock(&parent->d_lock);
 127         for (;;) {
 128                 n = *seq;
 129                 if (!(n & 1) && cmpxchg(seq, n, n + 1) == n)
 130                         break;
 131                 cpu_relax();
 132         }
 133         __list_del(cursor->d_child.prev, cursor->d_child.next);
 134         if (after)
 135                 list_add(&cursor->d_child, after);
 136         else
 137                 list_add_tail(&cursor->d_child, &parent->d_subdirs);
 138         smp_store_release(seq, n + 2);
 139         spin_unlock(&parent->d_lock);
 140 }
 141
 142 loff_t dcache_dir_lseek(struct file *file, loff_t offset, int whence)
 143 {
 144         struct dentry *dentry = file->f_path.dentry;
 145         switch (whence) {
 146                 case 1:
 147                         offset += file->f_pos;
 148                 case 0:
 149                         if (offset >= 0)
 150                                 break;
 151                 default:
 152                         return -EINVAL;
 153         }
 154         if (offset != file->f_pos) {
 155                 file->f_pos = offset;
 156                 if (file->f_pos >= 2) {
 157                         struct dentry *cursor = file->private_data;
 158                         struct dentry *to;
 159                         loff_t n = file->f_pos - 2;
 160
 161                         inode_lock_shared(dentry->d_inode);
 162                         to = next_positive(dentry, &dentry->d_subdirs, n);
 163                         move_cursor(cursor, to ? &to->d_child : NULL);
 164                         inode_unlock_shared(dentry->d_inode);
 165                 }
 166         }
 167         return offset;
 168 }
 169 EXPORT_SYMBOL(dcache_dir_lseek);
 170
 171 /* Relationship between i_mode and the DT_xxx types */
 172 static inline unsigned char dt_type(struct inode *inode)
 173 {
 174         return (inode->i_mode >> 12) & 15;
 175 }
 176
 177 /*
 178  * Directory is locked and all positive dentries in it are safe, since
 179  * for ramfs-type trees they can't go away without unlink() or rmdir(),
 180  * both impossible due to the lock on directory.
 181  */
 182
 183 int dcache_readdir(struct file *file, struct dir_context *ctx)
 184 {
 185         struct dentry *dentry = file->f_path.dentry;
 186         struct dentry *cursor = file->private_data;
 187         struct list_head *p = &cursor->d_child;
 188         struct dentry *next;
 189         bool moved = false;
 190
 191         if (!dir_emit_dots(file, ctx))
 192                 return 0;
 193
 194         if (ctx->pos == 2)
 195                 p = &dentry->d_subdirs;
 196         while ((next = next_positive(dentry, p, 1)) != NULL) {
 197                 if (!dir_emit(ctx, next->d_name.name, next->d_name.len,
 198                               d_inode(next)->i_ino, dt_type(d_inode(next))))
 199                         break;
 200                 moved = true;
 201                 p = &next->d_child;
 202                 ctx->pos++;
 203         }
 204         if (moved)
 205                 move_cursor(cursor, p);
 206         return 0;
 207 }
 208 EXPORT_SYMBOL(dcache_readdir);
 209
 210 ssize_t generic_read_dir(struct file *filp, char __user *buf, size_t siz, loff_t *ppos)
 211 {
 212         return -EISDIR;
 213 }
 214 EXPORT_SYMBOL(generic_read_dir);
 215
 216 const struct file_operations simple_dir_operations = {
 217         .open           = dcache_dir_open,
 218         .release        = dcache_dir_close,
 219         .llseek         = dcache_dir_lseek,
 220         .read           = generic_read_dir,
 221         .iterate_shared = dcache_readdir,
 222         .fsync          = noop_fsync,
 223 };
 224 EXPORT_SYMBOL(simple_dir_operations);
 225
 226 const struct inode_operations simple_dir_inode_operations = {
 227         .lookup         = simple_lookup,
 228 };
 229 EXPORT_SYMBOL(simple_dir_inode_operations);
 230
 231 static const struct super_operations simple_super_operations = {
 232         .statfs         = simple_statfs,
 233 };
 234
 235 /*
 236  * Common helper for pseudo-filesystems (sockfs, pipefs, bdev - stuff that
 237  * will never be mountable)
 238  */
 239 struct dentry *mount_pseudo_xattr(struct file_system_type *fs_type, char *name,
 240         const struct super_operations *ops, const struct xattr_handler **xattr,
 241         const struct dentry_operations *dops, unsigned long magic)
 242 {
 243         struct super_block *s;
 244         struct dentry *dentry;
 245         struct inode *root;
 246         struct qstr d_name = QSTR_INIT(name, strlen(name));
 247
 248         s = sget(fs_type, NULL, set_anon_super, MS_NOUSER, NULL);
 249         if (IS_ERR(s))
 250                 return ERR_CAST(s);
 251
 252         s->s_maxbytes = MAX_LFS_FILESIZE;
 253         s->s_blocksize = PAGE_SIZE;
 254         s->s_blocksize_bits = PAGE_SHIFT;
 255         s->s_magic = magic;
 256         s->s_op = ops ? ops : &simple_super_operations;
 257         s->s_xattr = xattr;
 258         s->s_time_gran = 1;
 259         root = new_inode(s);
 260         if (!root)
 261                 goto Enomem;
 262         /*
 263          * since this is the first inode, make it number 1. New inodes created
 264          * after this must take care not to collide with it (by passing
 265          * max_reserved of 1 to iunique).
 266          */
 267         root->i_ino = 1;
 268         root->i_mode = S_IFDIR | S_IRUSR | S_IWUSR;
 269         root->i_atime = root->i_mtime = root->i_ctime = CURRENT_TIME;
 270         dentry = __d_alloc(s, &d_name);
 271         if (!dentry) {
 272                 iput(root);
 273                 goto Enomem;
 274         }
 275         d_instantiate(dentry, root);
 276         s->s_root = dentry;
 277         s->s_d_op = dops;
 278         s->s_flags |= MS_ACTIVE;
 279         return dget(s->s_root);
 280
 281 Enomem:
 282         deactivate_locked_super(s);
 283         return ERR_PTR(-ENOMEM);
 284 }
 285 EXPORT_SYMBOL(mount_pseudo_xattr);
 286
 287 int simple_open(struct inode *inode, struct file *file)
 288 {
 289         if (inode->i_private)
 290                 file->private_data = inode->i_private;
 291         return 0;
 292 }
 293 EXPORT_SYMBOL(simple_open);
 294
 295 int simple_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
 296 {
 297         struct inode *inode = d_inode(old_dentry);
 298
 299         inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
 300         inc_nlink(inode);
 301         ihold(inode);
 302         dget(dentry);
 303         d_instantiate(dentry, inode);
 304         return 0;
 305 }
 306 EXPORT_SYMBOL(simple_link);
 307
 308 int simple_empty(struct dentry *dentry)
 309 {
 310         struct dentry *child;
 311         int ret = 0;
 312
 313         spin_lock(&dentry->d_lock);
 314         list_for_each_entry(child, &dentry->d_subdirs, d_child) {
 315                 spin_lock_nested(&child->d_lock, DENTRY_D_LOCK_NESTED);
 316                 if (simple_positive(child)) {
 317                         spin_unlock(&child->d_lock);
 318                         goto out;
 319                 }
 320                 spin_unlock(&child->d_lock);
 321         }
 322         ret = 1;
 323 out:
 324         spin_unlock(&dentry->d_lock);
 325         return ret;
 326 }
 327 EXPORT_SYMBOL(simple_empty);
 328
 329 int simple_unlink(struct inode *dir, struct dentry *dentry)
 330 {
 331         struct inode *inode = d_inode(dentry);
 332
 333         inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
 334         drop_nlink(inode);
 335         dput(dentry);
 336         return 0;
 337 }
 338 EXPORT_SYMBOL(simple_unlink);
 339
 340 int simple_rmdir(struct inode *dir, struct dentry *dentry)
 341 {
 342         if (!simple_empty(dentry))
 343                 return -ENOTEMPTY;
 344
 345         drop_nlink(d_inode(dentry));
 346         simple_unlink(dir, dentry);
 347         drop_nlink(dir);
 348         return 0;
 349 }
 350 EXPORT_SYMBOL(simple_rmdir);
 351
 352 int simple_rename(struct inode *old_dir, struct dentry *old_dentry,
 353                 struct inode *new_dir, struct dentry *new_dentry)
 354 {
 355         struct inode *inode = d_inode(old_dentry);
 356         int they_are_dirs = d_is_dir(old_dentry);
 357
 358         if (!simple_empty(new_dentry))
 359                 return -ENOTEMPTY;
 360
 361         if (d_really_is_positive(new_dentry)) {
 362                 simple_unlink(new_dir, new_dentry);
 363                 if (they_are_dirs) {
 364                         drop_nlink(d_inode(new_dentry));
 365                         drop_nlink(old_dir);
 366                 }
 367         } else if (they_are_dirs) {
 368                 drop_nlink(old_dir);
 369                 inc_nlink(new_dir);
 370         }
 371
 372         old_dir->i_ctime = old_dir->i_mtime = new_dir->i_ctime =
 373                 new_dir->i_mtime = inode->i_ctime = CURRENT_TIME;
 374
 375         return 0;
 376 }
 377 EXPORT_SYMBOL(simple_rename);
 378
 379 /**
 380  * simple_setattr - setattr for simple filesystem
 381  * @dentry: dentry
 382  * @iattr: iattr structure
 383  *
 384  * Returns 0 on success, -error on failure.
 385  *
 386  * simple_setattr is a simple ->setattr implementation without a proper
 387  * implementation of size changes.
 388  *
 389  * It can either be used for in-memory filesystems or special files
 390  * on simple regular filesystems.  Anything that needs to change on-disk
 391  * or wire state on size changes needs its own setattr method.
 392  */
 393 int simple_setattr(struct dentry *dentry, struct iattr *iattr)
 394 {
 395         struct inode *inode = d_inode(dentry);
 396         int error;
 397
 398         error = setattr_prepare(dentry, iattr);
 399         if (error)
 400                 return error;
 401
 402         if (iattr->ia_valid & ATTR_SIZE)
 403                 truncate_setsize(inode, iattr->ia_size);
 404         setattr_copy(inode, iattr);
 405         mark_inode_dirty(inode);
 406         return 0;
 407 }
 408 EXPORT_SYMBOL(simple_setattr);
 409
 410 int simple_readpage(struct file *file, struct page *page)
 411 {
 412         clear_highpage(page);
 413         flush_dcache_page(page);
 414         SetPageUptodate(page);
 415         unlock_page(page);
 416         return 0;
 417 }
 418 EXPORT_SYMBOL(simple_readpage);
 419
 420 int simple_write_begin(struct file *file, struct address_space *mapping,
 421                         loff_t pos, unsigned len, unsigned flags,
 422                         struct page **pagep, void **fsdata)
 423 {
 424         struct page *page;
 425         pgoff_t index;
 426
 427         index = pos >> PAGE_SHIFT;
 428
 429         page = grab_cache_page_write_begin(mapping, index, flags);
 430         if (!page)
 431                 return -ENOMEM;
 432
 433         *pagep = page;
 434
 435         if (!PageUptodate(page) && (len != PAGE_SIZE)) {
 436                 unsigned from = pos & (PAGE_SIZE - 1);
 437
 438                 zero_user_segments(page, 0, from, from + len, PAGE_SIZE);
 439         }
 440         return 0;
 441 }
 442 EXPORT_SYMBOL(simple_write_begin);
 443
 444 /**
 445  * simple_write_end - .write_end helper for non-block-device FSes
 446  * @available: See .write_end of address_space_operations
 447  * @file:               "
 448  * @mapping:            "
 449  * @pos:                "
 450  * @len:                "
 451  * @copied:             "
 452  * @page:               "
 453  * @fsdata:             "
 454  *
 455  * simple_write_end does the minimum needed for updating a page after writing is
 456  * done. It has the same API signature as the .write_end of
 457  * address_space_operations vector. So it can just be set onto .write_end for
 458  * FSes that don't need any other processing. i_mutex is assumed to be held.
 459  * Block based filesystems should use generic_write_end().
 460  * NOTE: Even though i_size might get updated by this function, mark_inode_dirty
 461  * is not called, so a filesystem that actually does store data in .write_inode
 462  * should extend on what's done here with a call to mark_inode_dirty() in the
 463  * case that i_size has changed.
 464  */
 465 int simple_write_end(struct file *file, struct address_space *mapping,
 466                         loff_t pos, unsigned len, unsigned copied,
 467                         struct page *page, void *fsdata)
 468 {
 469         struct inode *inode = page->mapping->host;
 470         loff_t last_pos = pos + copied;
 471
 472         /* zero the stale part of the page if we did a short copy */
 473         if (copied < len) {
 474                 unsigned from = pos & (PAGE_SIZE - 1);
 475
 476                 zero_user(page, from + copied, len - copied);
 477         }
 478
 479         if (!PageUptodate(page))
 480                 SetPageUptodate(page);
 481         /*
 482          * No need to use i_size_read() here, the i_size
 483          * cannot change under us because we hold the i_mutex.
 484          */
 485         if (last_pos > inode->i_size)
 486                 i_size_write(inode, last_pos);
 487
 488         set_page_dirty(page);
 489         unlock_page(page);
 490         put_page(page);
 491
 492         return copied;
 493 }
 494 EXPORT_SYMBOL(simple_write_end);
 495
 496 /*
 497  * the inodes created here are not hashed. If you use iunique to generate
 498  * unique inode values later for this filesystem, then you must take care
 499  * to pass it an appropriate max_reserved value to avoid collisions.
 500  */
 501 int simple_fill_super(struct super_block *s, unsigned long magic,
 502                       struct tree_descr *files)
 503 {
 504         struct inode *inode;
 505         struct dentry *root;
 506         struct dentry *dentry;
 507         int i;
 508
 509         s->s_blocksize = PAGE_SIZE;
 510         s->s_blocksize_bits = PAGE_SHIFT;
 511         s->s_magic = magic;
 512         s->s_op = &simple_super_operations;
 513         s->s_time_gran = 1;
 514
 515         inode = new_inode(s);
 516         if (!inode)
 517                 return -ENOMEM;
 518         /*
 519          * because the root inode is 1, the files array must not contain an
 520          * entry at index 1
 521          */
 522         inode->i_ino = 1;
 523         inode->i_mode = S_IFDIR | 0755;
 524         inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
 525         inode->i_op = &simple_dir_inode_operations;
 526         inode->i_fop = &simple_dir_operations;
 527         set_nlink(inode, 2);
 528         root = d_make_root(inode);
 529         if (!root)
 530                 return -ENOMEM;
 531         for (i = 0; !files->name || files->name[0]; i++, files++) {
 532                 if (!files->name)
 533                         continue;
 534
 535                 /* warn if it tries to conflict with the root inode */
 536                 if (unlikely(i == 1))
 537                         printk(KERN_WARNING "%s: %s passed in a files array"
 538                                 "with an index of 1!\n", __func__,
 539                                 s->s_type->name);
 540
 541                 dentry = d_alloc_name(root, files->name);
 542                 if (!dentry)
 543                         goto out;
 544                 inode = new_inode(s);
 545                 if (!inode) {
 546                         dput(dentry);
 547                         goto out;
 548                 }
 549                 inode->i_mode = S_IFREG | files->mode;
 550                 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
 551                 inode->i_fop = files->ops;
 552                 inode->i_ino = i;
 553                 d_add(dentry, inode);
 554         }
 555         s->s_root = root;
 556         return 0;
 557 out:
 558         d_genocide(root);
 559         shrink_dcache_parent(root);
 560         dput(root);
 561         return -ENOMEM;
 562 }
 563 EXPORT_SYMBOL(simple_fill_super);
 564
 565 static DEFINE_SPINLOCK(pin_fs_lock);
 566
 567 int simple_pin_fs(struct file_system_type *type, struct vfsmount **mount, int *count)
 568 {
 569         struct vfsmount *mnt = NULL;
 570         spin_lock(&pin_fs_lock);
 571         if (unlikely(!*mount)) {
 572                 spin_unlock(&pin_fs_lock);
 573                 mnt = vfs_kern_mount(type, MS_KERNMOUNT, type->name, NULL);
 574                 if (IS_ERR(mnt))
 575                         return PTR_ERR(mnt);
 576                 spin_lock(&pin_fs_lock);
 577                 if (!*mount)
 578                         *mount = mnt;
 579         }
 580         mntget(*mount);
 581         ++*count;
 582         spin_unlock(&pin_fs_lock);
 583         mntput(mnt);
 584         return 0;
 585 }
 586 EXPORT_SYMBOL(simple_pin_fs);
 587
 588 void simple_release_fs(struct vfsmount **mount, int *count)
 589 {
 590         struct vfsmount *mnt;
 591         spin_lock(&pin_fs_lock);
 592         mnt = *mount;
 593         if (!--*count)
 594                 *mount = NULL;
 595         spin_unlock(&pin_fs_lock);
 596         mntput(mnt);
 597 }
 598 EXPORT_SYMBOL(simple_release_fs);
 599
 600 /**
 601  * simple_read_from_buffer - copy data from the buffer to user space
 602  * @to: the user space buffer to read to
 603  * @count: the maximum number of bytes to read
 604  * @ppos: the current position in the buffer
 605  * @from: the buffer to read from
 606  * @available: the size of the buffer
 607  *
 608  * The simple_read_from_buffer() function reads up to @count bytes from the
 609  * buffer @from at offset @ppos into the user space address starting at @to.
 610  *
 611  * On success, the number of bytes read is returned and the offset @ppos is
 612  * advanced by this number, or negative value is returned on error.
 613  **/
 614 ssize_t simple_read_from_buffer(void __user *to, size_t count, loff_t *ppos,
 615                                 const void *from, size_t available)
 616 {
 617         loff_t pos = *ppos;
 618         size_t ret;
 619
 620         if (pos < 0)
 621                 return -EINVAL;
 622         if (pos >= available || !count)
 623                 return 0;
 624         if (count > available - pos)
 625                 count = available - pos;
 626         ret = copy_to_user(to, from + pos, count);
 627         if (ret == count)
 628                 return -EFAULT;
 629         count -= ret;
 630         *ppos = pos + count;
 631         return count;
 632 }
 633 EXPORT_SYMBOL(simple_read_from_buffer);
 634
 635 /**
 636  * simple_write_to_buffer - copy data from user space to the buffer
 637  * @to: the buffer to write to
 638  * @available: the size of the buffer
 639  * @ppos: the current position in the buffer
 640  * @from: the user space buffer to read from
 641  * @count: the maximum number of bytes to read
 642  *
 643  * The simple_write_to_buffer() function reads up to @count bytes from the user
 644  * space address starting at @from into the buffer @to at offset @ppos.
 645  *
 646  * On success, the number of bytes written is returned and the offset @ppos is
 647  * advanced by this number, or negative value is returned on error.
 648  **/
 649 ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
 650                 const void __user *from, size_t count)
 651 {
 652         loff_t pos = *ppos;
 653         size_t res;
 654
 655         if (pos < 0)
 656                 return -EINVAL;
 657         if (pos >= available || !count)
 658                 return 0;
 659         if (count > available - pos)
 660                 count = available - pos;
 661         res = copy_from_user(to + pos, from, count);
 662         if (res == count)
 663                 return -EFAULT;
 664         count -= res;
 665         *ppos = pos + count;
 666         return count;
 667 }
 668 EXPORT_SYMBOL(simple_write_to_buffer);
 669
 670 /**
 671  * memory_read_from_buffer - copy data from the buffer
 672  * @to: the kernel space buffer to read to
 673  * @count: the maximum number of bytes to read
 674  * @ppos: the current position in the buffer
 675  * @from: the buffer to read from
 676  * @available: the size of the buffer
 677  *
 678  * The memory_read_from_buffer() function reads up to @count bytes from the
 679  * buffer @from at offset @ppos into the kernel space address starting at @to.
 680  *
 681  * On success, the number of bytes read is returned and the offset @ppos is
 682  * advanced by this number, or negative value is returned on error.
 683  **/
 684 ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
 685                                 const void *from, size_t available)
 686 {
 687         loff_t pos = *ppos;
 688
 689         if (pos < 0)
 690                 return -EINVAL;
 691         if (pos >= available)
 692                 return 0;
 693         if (count > available - pos)
 694                 count = available - pos;
 695         memcpy(to, from + pos, count);
 696         *ppos = pos + count;
 697
 698         return count;
 699 }
 700 EXPORT_SYMBOL(memory_read_from_buffer);
 701
 702 /*
 703  * Transaction based IO.
 704  * The file expects a single write which triggers the transaction, and then
 705  * possibly a read which collects the result - which is stored in a
 706  * file-local buffer.
 707  */
 708
 709 void simple_transaction_set(struct file *file, size_t n)
 710 {
 711         struct simple_transaction_argresp *ar = file->private_data;
 712
 713         BUG_ON(n > SIMPLE_TRANSACTION_LIMIT);
 714
 715         /*
 716          * The barrier ensures that ar->size will really remain zero until
 717          * ar->data is ready for reading.
 718          */
 719         smp_mb();
 720         ar->size = n;
 721 }
 722 EXPORT_SYMBOL(simple_transaction_set);
 723
 724 char *simple_transaction_get(struct file *file, const char __user *buf, size_t size)
 725 {
 726         struct simple_transaction_argresp *ar;
 727         static DEFINE_SPINLOCK(simple_transaction_lock);
 728
 729         if (size > SIMPLE_TRANSACTION_LIMIT - 1)
 730                 return ERR_PTR(-EFBIG);
 731
 732         ar = (struct simple_transaction_argresp *)get_zeroed_page(GFP_KERNEL);
 733         if (!ar)
 734                 return ERR_PTR(-ENOMEM);
 735
 736         spin_lock(&simple_transaction_lock);
 737
 738         /* only one write allowed per open */
 739         if (file->private_data) {
 740                 spin_unlock(&simple_transaction_lock);
 741                 free_page((unsigned long)ar);
 742                 return ERR_PTR(-EBUSY);
 743         }
 744
 745         file->private_data = ar;
 746
 747         spin_unlock(&simple_transaction_lock);
 748
 749         if (copy_from_user(ar->data, buf, size))
 750                 return ERR_PTR(-EFAULT);
 751
 752         return ar->data;
 753 }
 754 EXPORT_SYMBOL(simple_transaction_get);
 755
 756 ssize_t simple_transaction_read(struct file *file, char __user *buf, size_t size, loff_t *pos)
 757 {
 758         struct simple_transaction_argresp *ar = file->private_data;
 759
 760         if (!ar)
 761                 return 0;
 762         return simple_read_from_buffer(buf, size, pos, ar->data, ar->size);
 763 }
 764 EXPORT_SYMBOL(simple_transaction_read);
 765
 766 int simple_transaction_release(struct inode *inode, struct file *file)
 767 {
 768         free_page((unsigned long)file->private_data);
 769         return 0;
 770 }
 771 EXPORT_SYMBOL(simple_transaction_release);
 772
 773 /* Simple attribute files */
 774
 775 struct simple_attr {
 776         int (*get)(void *, u64 *);
 777         int (*set)(void *, u64);
 778         char get_buf[24];       /* enough to store a u64 and "\n\0" */
 779         char set_buf[24];
 780         void *data;
 781         const char *fmt;        /* format for read operation */
 782         struct mutex mutex;     /* protects access to these buffers */
 783 };
 784
 785 /* simple_attr_open is called by an actual attribute open file operation
 786  * to set the attribute specific access operations. */
 787 int simple_attr_open(struct inode *inode, struct file *file,
 788                      int (*get)(void *, u64 *), int (*set)(void *, u64),
 789                      const char *fmt)
 790 {
 791         struct simple_attr *attr;
 792
 793         attr = kmalloc(sizeof(*attr), GFP_KERNEL);
 794         if (!attr)
 795                 return -ENOMEM;
 796
 797         attr->get = get;
 798         attr->set = set;
 799         attr->data = inode->i_private;
 800         attr->fmt = fmt;
 801         mutex_init(&attr->mutex);
 802
 803         file->private_data = attr;
 804
 805         return nonseekable_open(inode, file);
 806 }
 807 EXPORT_SYMBOL_GPL(simple_attr_open);
 808
 809 int simple_attr_release(struct inode *inode, struct file *file)
 810 {
 811         kfree(file->private_data);
 812         return 0;
 813 }
 814 EXPORT_SYMBOL_GPL(simple_attr_release); /* GPL-only?  This?  Really? */
 815
 816 /* read from the buffer that is filled with the get function */
 817 ssize_t simple_attr_read(struct file *file, char __user *buf,
 818                          size_t len, loff_t *ppos)
 819 {
 820         struct simple_attr *attr;
 821         size_t size;
 822         ssize_t ret;
 823
 824         attr = file->private_data;
 825
 826         if (!attr->get)
 827                 return -EACCES;
 828
 829         ret = mutex_lock_interruptible(&attr->mutex);
 830         if (ret)
 831                 return ret;
 832
 833         if (*ppos) {            /* continued read */
 834                 size = strlen(attr->get_buf);
 835         } else {                /* first read */
 836                 u64 val;
 837                 ret = attr->get(attr->data, &val);
 838                 if (ret)
 839                         goto out;
 840
 841                 size = scnprintf(attr->get_buf, sizeof(attr->get_buf),
 842                                  attr->fmt, (unsigned long long)val);
 843         }
 844
 845         ret = simple_read_from_buffer(buf, len, ppos, attr->get_buf, size);
 846 out:
 847         mutex_unlock(&attr->mutex);
 848         return ret;
 849 }
 850 EXPORT_SYMBOL_GPL(simple_attr_read);
 851
 852 /* interpret the buffer as a number to call the set function with */
 853 ssize_t simple_attr_write(struct file *file, const char __user *buf,
 854                           size_t len, loff_t *ppos)
 855 {
 856         struct simple_attr *attr;
 857         u64 val;
 858         size_t size;
 859         ssize_t ret;
 860
 861         attr = file->private_data;
 862         if (!attr->set)
 863                 return -EACCES;
 864
 865         ret = mutex_lock_interruptible(&attr->mutex);
 866         if (ret)
 867                 return ret;
 868
 869         ret = -EFAULT;
 870         size = min(sizeof(attr->set_buf) - 1, len);
 871         if (copy_from_user(attr->set_buf, buf, size))
 872                 goto out;
 873
 874         attr->set_buf[size] = '\0';
 875         val = simple_strtoll(attr->set_buf, NULL, 0);
 876         ret = attr->set(attr->data, val);
 877         if (ret == 0)
 878                 ret = len; /* on success, claim we got the whole input */
 879 out:
 880         mutex_unlock(&attr->mutex);
 881         return ret;
 882 }
 883 EXPORT_SYMBOL_GPL(simple_attr_write);
 884
 885 /**
 886  * generic_fh_to_dentry - generic helper for the fh_to_dentry export operation
 887  * @sb:         filesystem to do the file handle conversion on
 888  * @fid:        file handle to convert
 889  * @fh_len:     length of the file handle in bytes
 890  * @fh_type:    type of file handle
 891  * @get_inode:  filesystem callback to retrieve inode
 892  *
 893  * This function decodes @fid as long as it has one of the well-known
 894  * Linux filehandle types and calls @get_inode on it to retrieve the
 895  * inode for the object specified in the file handle.
 896  */
 897 struct dentry *generic_fh_to_dentry(struct super_block *sb, struct fid *fid,
 898                 int fh_len, int fh_type, struct inode *(*get_inode)
 899                         (struct super_block *sb, u64 ino, u32 gen))
 900 {
 901         struct inode *inode = NULL;
 902
 903         if (fh_len < 2)
 904                 return NULL;
 905
 906         switch (fh_type) {
 907         case FILEID_INO32_GEN:
 908         case FILEID_INO32_GEN_PARENT:
 909                 inode = get_inode(sb, fid->i32.ino, fid->i32.gen);
 910                 break;
 911         }
 912
 913         return d_obtain_alias(inode);
 914 }
 915 EXPORT_SYMBOL_GPL(generic_fh_to_dentry);
 916
 917 /**
 918  * generic_fh_to_parent - generic helper for the fh_to_parent export operation
 919  * @sb:         filesystem to do the file handle conversion on
 920  * @fid:        file handle to convert
 921  * @fh_len:     length of the file handle in bytes
 922  * @fh_type:    type of file handle
 923  * @get_inode:  filesystem callback to retrieve inode
 924  *
 925  * This function decodes @fid as long as it has one of the well-known
 926  * Linux filehandle types and calls @get_inode on it to retrieve the
 927  * inode for the _parent_ object specified in the file handle if it
 928  * is specified in the file handle, or NULL otherwise.
 929  */
 930 struct dentry *generic_fh_to_parent(struct super_block *sb, struct fid *fid,
 931                 int fh_len, int fh_type, struct inode *(*get_inode)
 932                         (struct super_block *sb, u64 ino, u32 gen))
 933 {
 934         struct inode *inode = NULL;
 935
 936         if (fh_len <= 2)
 937                 return NULL;
 938
 939         switch (fh_type) {
 940         case FILEID_INO32_GEN_PARENT:
 941                 inode = get_inode(sb, fid->i32.parent_ino,
 942                                   (fh_len > 3 ? fid->i32.parent_gen : 0));
 943                 break;
 944         }
 945
 946         return d_obtain_alias(inode);
 947 }
 948 EXPORT_SYMBOL_GPL(generic_fh_to_parent);
 949
 950 /**
 951  * __generic_file_fsync - generic fsync implementation for simple filesystems
 952  *
 953  * @file:       file to synchronize
 954  * @start:      start offset in bytes
 955  * @end:        end offset in bytes (inclusive)
 956  * @datasync:   only synchronize essential metadata if true
 957  *
 958  * This is a generic implementation of the fsync method for simple
 959  * filesystems which track all non-inode metadata in the buffers list
 960  * hanging off the address_space structure.
 961  */
 962 int __generic_file_fsync(struct file *file, loff_t start, loff_t end,
 963                                  int datasync)
 964 {
 965         struct inode *inode = file->f_mapping->host;
 966         int err;
 967         int ret;
 968
 969         err = filemap_write_and_wait_range(inode->i_mapping, start, end);
 970         if (err)
 971                 return err;
 972
 973         inode_lock(inode);
 974         ret = sync_mapping_buffers(inode->i_mapping);
 975         if (!(inode->i_state & I_DIRTY_ALL))
 976                 goto out;
 977         if (datasync && !(inode->i_state & I_DIRTY_DATASYNC))
 978                 goto out;
 979
 980         err = sync_inode_metadata(inode, 1);
 981         if (ret == 0)
 982                 ret = err;
 983
 984 out:
 985         inode_unlock(inode);
 986         return ret;
 987 }
 988 EXPORT_SYMBOL(__generic_file_fsync);
 989
 990 /**
 991  * generic_file_fsync - generic fsync implementation for simple filesystems
 992  *                      with flush
 993  * @file:       file to synchronize
 994  * @start:      start offset in bytes
 995  * @end:        end offset in bytes (inclusive)
 996  * @datasync:   only synchronize essential metadata if true
 997  *
 998  */
 999
1000 int generic_file_fsync(struct file *file, loff_t start, loff_t end,
1001                        int datasync)
1002 {
1003         struct inode *inode = file->f_mapping->host;
1004         int err;
1005
1006         err = __generic_file_fsync(file, start, end, datasync);
1007         if (err)
1008                 return err;
1009         return blkdev_issue_flush(inode->i_sb->s_bdev, GFP_KERNEL, NULL);
1010 }
1011 EXPORT_SYMBOL(generic_file_fsync);
1012
1013 /**
1014  * generic_check_addressable - Check addressability of file system
1015  * @blocksize_bits:     log of file system block size
1016  * @num_blocks:         number of blocks in file system
1017  *
1018  * Determine whether a file system with @num_blocks blocks (and a
1019  * block size of 2**@blocksize_bits) is addressable by the sector_t
1020  * and page cache of the system.  Return 0 if so and -EFBIG otherwise.
1021  */
1022 int generic_check_addressable(unsigned blocksize_bits, u64 num_blocks)
1023 {
1024         u64 last_fs_block = num_blocks - 1;
1025         u64 last_fs_page =
1026                 last_fs_block >> (PAGE_SHIFT - blocksize_bits);
1027
1028         if (unlikely(num_blocks == 0))
1029                 return 0;
1030
1031         if ((blocksize_bits < 9) || (blocksize_bits > PAGE_SHIFT))
1032                 return -EINVAL;
1033
1034         if ((last_fs_block > (sector_t)(~0ULL) >> (blocksize_bits - 9)) ||
1035             (last_fs_page > (pgoff_t)(~0ULL))) {
1036                 return -EFBIG;
1037         }
1038         return 0;
1039 }
1040 EXPORT_SYMBOL(generic_check_addressable);
1041
1042 /*
1043  * No-op implementation of ->fsync for in-memory filesystems.
1044  */
1045 int noop_fsync(struct file *file, loff_t start, loff_t end, int datasync)
1046 {
1047         return 0;
1048 }
1049 EXPORT_SYMBOL(noop_fsync);
1050
1051 /* Because kfree isn't assignment-compatible with void(void*) ;-/ */
1052 void kfree_link(void *p)
1053 {
1054         kfree(p);
1055 }
1056 EXPORT_SYMBOL(kfree_link);
1057
1058 /*
1059  * nop .set_page_dirty method so that people can use .page_mkwrite on
1060  * anon inodes.
1061  */
1062 static int anon_set_page_dirty(struct page *page)
1063 {
1064         return 0;
1065 };
1066
1067 /*
1068  * A single inode exists for all anon_inode files. Contrary to pipes,
1069  * anon_inode inodes have no associated per-instance data, so we need
1070  * only allocate one of them.
1071  */
1072 struct inode *alloc_anon_inode(struct super_block *s)
1073 {
1074         static const struct address_space_operations anon_aops = {
1075                 .set_page_dirty = anon_set_page_dirty,
1076         };
1077         struct inode *inode = new_inode_pseudo(s);
1078
1079         if (!inode)
1080                 return ERR_PTR(-ENOMEM);
1081
1082         inode->i_ino = get_next_ino();
1083         inode->i_mapping->a_ops = &anon_aops;
1084
1085         /*
1086          * Mark the inode dirty from the very beginning,
1087          * that way it will never be moved to the dirty
1088          * list because mark_inode_dirty() will think
1089          * that it already _is_ on the dirty list.
1090          */
1091         inode->i_state = I_DIRTY;
1092         inode->i_mode = S_IRUSR | S_IWUSR;
1093         inode->i_uid = current_fsuid();
1094         inode->i_gid = current_fsgid();
1095         inode->i_flags |= S_PRIVATE;
1096         inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
1097         return inode;
1098 }
1099 EXPORT_SYMBOL(alloc_anon_inode);
1100
1101 /**
1102  * simple_nosetlease - generic helper for prohibiting leases
1103  * @filp: file pointer
1104  * @arg: type of lease to obtain
1105  * @flp: new lease supplied for insertion
1106  * @priv: private data for lm_setup operation
1107  *
1108  * Generic helper for filesystems that do not wish to allow leases to be set.
1109  * All arguments are ignored and it just returns -EINVAL.
1110  */
1111 int
1112 simple_nosetlease(struct file *filp, long arg, struct file_lock **flp,
1113                   void **priv)
1114 {
1115         return -EINVAL;
1116 }
1117 EXPORT_SYMBOL(simple_nosetlease);
1118
1119 const char *simple_get_link(struct dentry *dentry, struct inode *inode,
1120                             struct delayed_call *done)
1121 {
1122         return inode->i_link;
1123 }
1124 EXPORT_SYMBOL(simple_get_link);
1125
1126 const struct inode_operations simple_symlink_inode_operations = {
1127         .get_link = simple_get_link,
1128         .readlink = generic_readlink
1129 };
1130 EXPORT_SYMBOL(simple_symlink_inode_operations);
1131
1132 /*
1133  * Operations for a permanently empty directory.
1134  */
1135 static struct dentry *empty_dir_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags)
1136 {
1137         return ERR_PTR(-ENOENT);
1138 }
1139
1140 static int empty_dir_getattr(struct vfsmount *mnt, struct dentry *dentry,
1141                                  struct kstat *stat)
1142 {
1143         struct inode *inode = d_inode(dentry);
1144         generic_fillattr(inode, stat);
1145         return 0;
1146 }
1147
1148 static int empty_dir_setattr(struct dentry *dentry, struct iattr *attr)
1149 {
1150         return -EPERM;
1151 }
1152
1153 static ssize_t empty_dir_listxattr(struct dentry *dentry, char *list, size_t size)
1154 {
1155         return -EOPNOTSUPP;
1156 }
1157
1158 static const struct inode_operations empty_dir_inode_operations = {
1159         .lookup         = empty_dir_lookup,
1160         .permission     = generic_permission,
1161         .setattr        = empty_dir_setattr,
1162         .getattr        = empty_dir_getattr,
1163         .listxattr      = empty_dir_listxattr,
1164 };
1165
1166 static loff_t empty_dir_llseek(struct file *file, loff_t offset, int whence)
1167 {
1168         /* An empty directory has two entries . and .. at offsets 0 and 1 */
1169         return generic_file_llseek_size(file, offset, whence, 2, 2);
1170 }
1171
1172 static int empty_dir_readdir(struct file *file, struct dir_context *ctx)
1173 {
1174         dir_emit_dots(file, ctx);
1175         return 0;
1176 }
1177
1178 static const struct file_operations empty_dir_operations = {
1179         .llseek         = empty_dir_llseek,
1180         .read           = generic_read_dir,
1181         .iterate_shared = empty_dir_readdir,
1182         .fsync          = noop_fsync,
1183 };
1184
1185
1186 void make_empty_dir_inode(struct inode *inode)
1187 {
1188         set_nlink(inode, 2);
1189         inode->i_mode = S_IFDIR | S_IRUGO | S_IXUGO;
1190         inode->i_uid = GLOBAL_ROOT_UID;
1191         inode->i_gid = GLOBAL_ROOT_GID;
1192         inode->i_rdev = 0;
1193         inode->i_size = 0;
1194         inode->i_blkbits = PAGE_SHIFT;
1195         inode->i_blocks = 0;
1196
1197         inode->i_op = &empty_dir_inode_operations;
1198         inode->i_opflags &= ~IOP_XATTR;
1199         inode->i_fop = &empty_dir_operations;
1200 }
1201
1202 bool is_empty_dir_inode(struct inode *inode)
1203 {
1204         return (inode->i_fop == &empty_dir_operations) &&
1205                 (inode->i_op == &empty_dir_inode_operations);
1206 }