SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/ubifs/super.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 initialization and VFS superblock operations. Some
  25  * initialization stuff which is rather large and complex is placed at
  26  * corresponding subsystems, but most of it is here.
  27  */
  28
  29 #include <linux/init.h>
  30 #include <linux/slab.h>
  31 #include <linux/module.h>
  32 #include <linux/ctype.h>
  33 #include <linux/kthread.h>
  34 #include <linux/parser.h>
  35 #include <linux/seq_file.h>
  36 #include <linux/mount.h>
  37 #include <linux/math64.h>
  38 #include <linux/writeback.h>
  39 #include "ubifs.h"
  40
  41 /*
  42  * Maximum amount of memory we may 'kmalloc()' without worrying that we are
  43  * allocating too much.
  44  */
  45 #define UBIFS_KMALLOC_OK (128*1024)
  46
  47 /* Slab cache for UBIFS inodes */
  48 struct kmem_cache *ubifs_inode_slab;
  49
  50 /* UBIFS TNC shrinker description */
  51 static struct shrinker ubifs_shrinker_info = {
  52         .shrink = ubifs_shrinker,
  53         .seeks = DEFAULT_SEEKS,
  54 };
  55
  56 /**
  57  * validate_inode - validate inode.
  58  * @c: UBIFS file-system description object
  59  * @inode: the inode to validate
  60  *
  61  * This is a helper function for 'ubifs_iget()' which validates various fields
  62  * of a newly built inode to make sure they contain sane values and prevent
  63  * possible vulnerabilities. Returns zero if the inode is all right and
  64  * a non-zero error code if not.
  65  */
  66 static int validate_inode(struct ubifs_info *c, const struct inode *inode)
  67 {
  68         int err;
  69         const struct ubifs_inode *ui = ubifs_inode(inode);
  70
  71         if (inode->i_size > c->max_inode_sz) {
  72                 ubifs_err("inode is too large (%lld)",
  73                           (long long)inode->i_size);
  74                 return 1;
  75         }
  76
  77         if (ui->compr_type < 0 || ui->compr_type >= UBIFS_COMPR_TYPES_CNT) {
  78                 ubifs_err("unknown compression type %d", ui->compr_type);
  79                 return 2;
  80         }
  81
  82         if (ui->xattr_names + ui->xattr_cnt > XATTR_LIST_MAX)
  83                 return 3;
  84
  85         if (ui->data_len < 0 || ui->data_len > UBIFS_MAX_INO_DATA)
  86                 return 4;
  87
  88         if (ui->xattr && (inode->i_mode & S_IFMT) != S_IFREG)
  89                 return 5;
  90
  91         if (!ubifs_compr_present(ui->compr_type)) {
  92                 ubifs_warn("inode %lu uses '%s' compression, but it was not "
  93                            "compiled in", inode->i_ino,
  94                            ubifs_compr_name(ui->compr_type));
  95         }
  96
  97         err = dbg_check_dir_size(c, inode);
  98         return err;
  99 }
 100
 101 struct inode *ubifs_iget(struct super_block *sb, unsigned long inum)
 102 {
 103         int err;
 104         union ubifs_key key;
 105         struct ubifs_ino_node *ino;
 106         struct ubifs_info *c = sb->s_fs_info;
 107         struct inode *inode;
 108         struct ubifs_inode *ui;
 109
 110         dbg_gen("inode %lu", inum);
 111
 112         inode = iget_locked(sb, inum);
 113         if (!inode)
 114                 return ERR_PTR(-ENOMEM);
 115         if (!(inode->i_state & I_NEW))
 116                 return inode;
 117         ui = ubifs_inode(inode);
 118
 119         ino = kmalloc(UBIFS_MAX_INO_NODE_SZ, GFP_NOFS);
 120         if (!ino) {
 121                 err = -ENOMEM;
 122                 goto out;
 123         }
 124
 125         ino_key_init(c, &key, inode->i_ino);
 126
 127         err = ubifs_tnc_lookup(c, &key, ino);
 128         if (err)
 129                 goto out_ino;
 130
 131         inode->i_flags |= (S_NOCMTIME | S_NOATIME);
 132         inode->i_nlink = le32_to_cpu(ino->nlink);
 133         inode->i_uid   = le32_to_cpu(ino->uid);
 134         inode->i_gid   = le32_to_cpu(ino->gid);
 135         inode->i_atime.tv_sec  = (int64_t)le64_to_cpu(ino->atime_sec);
 136         inode->i_atime.tv_nsec = le32_to_cpu(ino->atime_nsec);
 137         inode->i_mtime.tv_sec  = (int64_t)le64_to_cpu(ino->mtime_sec);
 138         inode->i_mtime.tv_nsec = le32_to_cpu(ino->mtime_nsec);
 139         inode->i_ctime.tv_sec  = (int64_t)le64_to_cpu(ino->ctime_sec);
 140         inode->i_ctime.tv_nsec = le32_to_cpu(ino->ctime_nsec);
 141         inode->i_mode = le32_to_cpu(ino->mode);
 142         inode->i_size = le64_to_cpu(ino->size);
 143
 144         ui->data_len    = le32_to_cpu(ino->data_len);
 145         ui->flags       = le32_to_cpu(ino->flags);
 146         ui->compr_type  = le16_to_cpu(ino->compr_type);
 147         ui->creat_sqnum = le64_to_cpu(ino->creat_sqnum);
 148         ui->xattr_cnt   = le32_to_cpu(ino->xattr_cnt);
 149         ui->xattr_size  = le32_to_cpu(ino->xattr_size);
 150         ui->xattr_names = le32_to_cpu(ino->xattr_names);
 151         ui->synced_i_size = ui->ui_size = inode->i_size;
 152
 153         ui->xattr = (ui->flags & UBIFS_XATTR_FL) ? 1 : 0;
 154
 155         err = validate_inode(c, inode);
 156         if (err)
 157                 goto out_invalid;
 158
 159         /* Disable read-ahead */
 160         inode->i_mapping->backing_dev_info = &c->bdi;
 161
 162         switch (inode->i_mode & S_IFMT) {
 163         case S_IFREG:
 164                 inode->i_mapping->a_ops = &ubifs_file_address_operations;
 165                 inode->i_op = &ubifs_file_inode_operations;
 166                 inode->i_fop = &ubifs_file_operations;
 167                 if (ui->xattr) {
 168                         ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
 169                         if (!ui->data) {
 170                                 err = -ENOMEM;
 171                                 goto out_ino;
 172                         }
 173                         memcpy(ui->data, ino->data, ui->data_len);
 174                         ((char *)ui->data)[ui->data_len] = '\0';
 175                 } else if (ui->data_len != 0) {
 176                         err = 10;
 177                         goto out_invalid;
 178                 }
 179                 break;
 180         case S_IFDIR:
 181                 inode->i_op  = &ubifs_dir_inode_operations;
 182                 inode->i_fop = &ubifs_dir_operations;
 183                 if (ui->data_len != 0) {
 184                         err = 11;
 185                         goto out_invalid;
 186                 }
 187                 break;
 188         case S_IFLNK:
 189                 inode->i_op = &ubifs_symlink_inode_operations;
 190                 if (ui->data_len <= 0 || ui->data_len > UBIFS_MAX_INO_DATA) {
 191                         err = 12;
 192                         goto out_invalid;
 193                 }
 194                 ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
 195                 if (!ui->data) {
 196                         err = -ENOMEM;
 197                         goto out_ino;
 198                 }
 199                 memcpy(ui->data, ino->data, ui->data_len);
 200                 ((char *)ui->data)[ui->data_len] = '\0';
 201                 break;
 202         case S_IFBLK:
 203         case S_IFCHR:
 204         {
 205                 dev_t rdev;
 206                 union ubifs_dev_desc *dev;
 207
 208                 ui->data = kmalloc(sizeof(union ubifs_dev_desc), GFP_NOFS);
 209                 if (!ui->data) {
 210                         err = -ENOMEM;
 211                         goto out_ino;
 212                 }
 213
 214                 dev = (union ubifs_dev_desc *)ino->data;
 215                 if (ui->data_len == sizeof(dev->new))
 216                         rdev = new_decode_dev(le32_to_cpu(dev->new));
 217                 else if (ui->data_len == sizeof(dev->huge))
 218                         rdev = huge_decode_dev(le64_to_cpu(dev->huge));
 219                 else {
 220                         err = 13;
 221                         goto out_invalid;
 222                 }
 223                 memcpy(ui->data, ino->data, ui->data_len);
 224                 inode->i_op = &ubifs_file_inode_operations;
 225                 init_special_inode(inode, inode->i_mode, rdev);
 226                 break;
 227         }
 228         case S_IFSOCK:
 229         case S_IFIFO:
 230                 inode->i_op = &ubifs_file_inode_operations;
 231                 init_special_inode(inode, inode->i_mode, 0);
 232                 if (ui->data_len != 0) {
 233                         err = 14;
 234                         goto out_invalid;
 235                 }
 236                 break;
 237         default:
 238                 err = 15;
 239                 goto out_invalid;
 240         }
 241
 242         kfree(ino);
 243         ubifs_set_inode_flags(inode);
 244         unlock_new_inode(inode);
 245         return inode;
 246
 247 out_invalid:
 248         ubifs_err("inode %lu validation failed, error %d", inode->i_ino, err);
 249         dbg_dump_node(c, ino);
 250         dbg_dump_inode(c, inode);
 251         err = -EINVAL;
 252 out_ino:
 253         kfree(ino);
 254 out:
 255         ubifs_err("failed to read inode %lu, error %d", inode->i_ino, err);
 256         iget_failed(inode);
 257         return ERR_PTR(err);
 258 }
 259
 260 static struct inode *ubifs_alloc_inode(struct super_block *sb)
 261 {
 262         struct ubifs_inode *ui;
 263
 264         ui = kmem_cache_alloc(ubifs_inode_slab, GFP_NOFS);
 265         if (!ui)
 266                 return NULL;
 267
 268         memset((void *)ui + sizeof(struct inode), 0,
 269                sizeof(struct ubifs_inode) - sizeof(struct inode));
 270         mutex_init(&ui->ui_mutex);
 271         spin_lock_init(&ui->ui_lock);
 272         return &ui->vfs_inode;
 273 };
 274
 275 static void ubifs_destroy_inode(struct inode *inode)
 276 {
 277         struct ubifs_inode *ui = ubifs_inode(inode);
 278
 279         kfree(ui->data);
 280         kmem_cache_free(ubifs_inode_slab, inode);
 281 }
 282
 283 /*
 284  * Note, Linux write-back code calls this without 'i_mutex'.
 285  */
 286 static int ubifs_write_inode(struct inode *inode, int wait)
 287 {
 288         int err = 0;
 289         struct ubifs_info *c = inode->i_sb->s_fs_info;
 290         struct ubifs_inode *ui = ubifs_inode(inode);
 291
 292         ubifs_assert(!ui->xattr);
 293         if (is_bad_inode(inode))
 294                 return 0;
 295
 296         mutex_lock(&ui->ui_mutex);
 297         /*
 298          * Due to races between write-back forced by budgeting
 299          * (see 'sync_some_inodes()') and pdflush write-back, the inode may
 300          * have already been synchronized, do not do this again. This might
 301          * also happen if it was synchronized in an VFS operation, e.g.
 302          * 'ubifs_link()'.
 303          */
 304         if (!ui->dirty) {
 305                 mutex_unlock(&ui->ui_mutex);
 306                 return 0;
 307         }
 308
 309         /*
 310          * As an optimization, do not write orphan inodes to the media just
 311          * because this is not needed.
 312          */
 313         dbg_gen("inode %lu, mode %#x, nlink %u",
 314                 inode->i_ino, (int)inode->i_mode, inode->i_nlink);
 315         if (inode->i_nlink) {
 316                 err = ubifs_jnl_write_inode(c, inode);
 317                 if (err)
 318                         ubifs_err("can't write inode %lu, error %d",
 319                                   inode->i_ino, err);
 320         }
 321
 322         ui->dirty = 0;
 323         mutex_unlock(&ui->ui_mutex);
 324         ubifs_release_dirty_inode_budget(c, ui);
 325         return err;
 326 }
 327
 328 static void ubifs_delete_inode(struct inode *inode)
 329 {
 330         int err;
 331         struct ubifs_info *c = inode->i_sb->s_fs_info;
 332         struct ubifs_inode *ui = ubifs_inode(inode);
 333
 334         if (ui->xattr)
 335                 /*
 336                  * Extended attribute inode deletions are fully handled in
 337                  * 'ubifs_removexattr()'. These inodes are special and have
 338                  * limited usage, so there is nothing to do here.
 339                  */
 340                 goto out;
 341
 342         dbg_gen("inode %lu, mode %#x", inode->i_ino, (int)inode->i_mode);
 343         ubifs_assert(!atomic_read(&inode->i_count));
 344         ubifs_assert(inode->i_nlink == 0);
 345
 346         truncate_inode_pages(&inode->i_data, 0);
 347         if (is_bad_inode(inode))
 348                 goto out;
 349
 350         ui->ui_size = inode->i_size = 0;
 351         err = ubifs_jnl_delete_inode(c, inode);
 352         if (err)
 353                 /*
 354                  * Worst case we have a lost orphan inode wasting space, so a
 355                  * simple error message is OK here.
 356                  */
 357                 ubifs_err("can't delete inode %lu, error %d",
 358                           inode->i_ino, err);
 359
 360 out:
 361         if (ui->dirty)
 362                 ubifs_release_dirty_inode_budget(c, ui);
 363         else {
 364                 /* We've deleted something - clean the "no space" flags */
 365                 c->nospace = c->nospace_rp = 0;
 366                 smp_wmb();
 367         }
 368         clear_inode(inode);
 369 }
 370
 371 static void ubifs_dirty_inode(struct inode *inode)
 372 {
 373         struct ubifs_inode *ui = ubifs_inode(inode);
 374
 375         ubifs_assert(mutex_is_locked(&ui->ui_mutex));
 376         if (!ui->dirty) {
 377                 ui->dirty = 1;
 378                 dbg_gen("inode %lu",  inode->i_ino);
 379         }
 380 }
 381
 382 static int ubifs_statfs(struct dentry *dentry, struct kstatfs *buf)
 383 {
 384         struct ubifs_info *c = dentry->d_sb->s_fs_info;
 385         unsigned long long free;
 386         __le32 *uuid = (__le32 *)c->uuid;
 387
 388         free = ubifs_get_free_space(c);
 389         dbg_gen("free space %lld bytes (%lld blocks)",
 390                 free, free >> UBIFS_BLOCK_SHIFT);
 391
 392         buf->f_type = UBIFS_SUPER_MAGIC;
 393         buf->f_bsize = UBIFS_BLOCK_SIZE;
 394         buf->f_blocks = c->block_cnt;
 395         buf->f_bfree = free >> UBIFS_BLOCK_SHIFT;
 396         if (free > c->report_rp_size)
 397                 buf->f_bavail = (free - c->report_rp_size) >> UBIFS_BLOCK_SHIFT;
 398         else
 399                 buf->f_bavail = 0;
 400         buf->f_files = 0;
 401         buf->f_ffree = 0;
 402         buf->f_namelen = UBIFS_MAX_NLEN;
 403         buf->f_fsid.val[0] = le32_to_cpu(uuid[0]) ^ le32_to_cpu(uuid[2]);
 404         buf->f_fsid.val[1] = le32_to_cpu(uuid[1]) ^ le32_to_cpu(uuid[3]);
 405         ubifs_assert(buf->f_bfree <= c->block_cnt);
 406         return 0;
 407 }
 408
 409 static int ubifs_show_options(struct seq_file *s, struct vfsmount *mnt)
 410 {
 411         struct ubifs_info *c = mnt->mnt_sb->s_fs_info;
 412
 413         if (c->mount_opts.unmount_mode == 2)
 414                 seq_printf(s, ",fast_unmount");
 415         else if (c->mount_opts.unmount_mode == 1)
 416                 seq_printf(s, ",norm_unmount");
 417
 418         if (c->mount_opts.bulk_read == 2)
 419                 seq_printf(s, ",bulk_read");
 420         else if (c->mount_opts.bulk_read == 1)
 421                 seq_printf(s, ",no_bulk_read");
 422
 423         if (c->mount_opts.chk_data_crc == 2)
 424                 seq_printf(s, ",chk_data_crc");
 425         else if (c->mount_opts.chk_data_crc == 1)
 426                 seq_printf(s, ",no_chk_data_crc");
 427
 428         if (c->mount_opts.override_compr) {
 429                 seq_printf(s, ",compr=%s",
 430                            ubifs_compr_name(c->mount_opts.compr_type));
 431         }
 432
 433         return 0;
 434 }
 435
 436 static int ubifs_sync_fs(struct super_block *sb, int wait)
 437 {
 438         int i, err;
 439         struct ubifs_info *c = sb->s_fs_info;
 440         struct writeback_control wbc = {
 441                 .sync_mode   = WB_SYNC_ALL,
 442                 .range_start = 0,
 443                 .range_end   = LLONG_MAX,
 444                 .nr_to_write = LONG_MAX,
 445         };
 446
 447         /*
 448          * Zero @wait is just an advisory thing to help the file system shove
 449          * lots of data into the queues, and there will be the second
 450          * '->sync_fs()' call, with non-zero @wait.
 451          */
 452         if (!wait)
 453                 return 0;
 454
 455         /*
 456          * VFS calls '->sync_fs()' before synchronizing all dirty inodes and
 457          * pages, so synchronize them first, then commit the journal. Strictly
 458          * speaking, it is not necessary to commit the journal here,
 459          * synchronizing write-buffers would be enough. But committing makes
 460          * UBIFS free space predictions much more accurate, so we want to let
 461          * the user be able to get more accurate results of 'statfs()' after
 462          * they synchronize the file system.
 463          */
 464         generic_sync_sb_inodes(sb, &wbc);
 465
 466         /*
 467          * Synchronize write buffers, because 'ubifs_run_commit()' does not
 468          * do this if it waits for an already running commit.
 469          */
 470         for (i = 0; i < c->jhead_cnt; i++) {
 471                 err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
 472                 if (err)
 473                         return err;
 474         }
 475
 476         err = ubifs_run_commit(c);
 477         if (err)
 478                 return err;
 479
 480         return ubi_sync(c->vi.ubi_num);
 481 }
 482
 483 /**
 484  * init_constants_early - initialize UBIFS constants.
 485  * @c: UBIFS file-system description object
 486  *
 487  * This function initialize UBIFS constants which do not need the superblock to
 488  * be read. It also checks that the UBI volume satisfies basic UBIFS
 489  * requirements. Returns zero in case of success and a negative error code in
 490  * case of failure.
 491  */
 492 static int init_constants_early(struct ubifs_info *c)
 493 {
 494         if (c->vi.corrupted) {
 495                 ubifs_warn("UBI volume is corrupted - read-only mode");
 496                 c->ro_media = 1;
 497         }
 498
 499         if (c->di.ro_mode) {
 500                 ubifs_msg("read-only UBI device");
 501                 c->ro_media = 1;
 502         }
 503
 504         if (c->vi.vol_type == UBI_STATIC_VOLUME) {
 505                 ubifs_msg("static UBI volume - read-only mode");
 506                 c->ro_media = 1;
 507         }
 508
 509         c->leb_cnt = c->vi.size;
 510         c->leb_size = c->vi.usable_leb_size;
 511         c->half_leb_size = c->leb_size / 2;
 512         c->min_io_size = c->di.min_io_size;
 513         c->min_io_shift = fls(c->min_io_size) - 1;
 514
 515         if (c->leb_size < UBIFS_MIN_LEB_SZ) {
 516                 ubifs_err("too small LEBs (%d bytes), min. is %d bytes",
 517                           c->leb_size, UBIFS_MIN_LEB_SZ);
 518                 return -EINVAL;
 519         }
 520
 521         if (c->leb_cnt < UBIFS_MIN_LEB_CNT) {
 522                 ubifs_err("too few LEBs (%d), min. is %d",
 523                           c->leb_cnt, UBIFS_MIN_LEB_CNT);
 524                 return -EINVAL;
 525         }
 526
 527         if (!is_power_of_2(c->min_io_size)) {
 528                 ubifs_err("bad min. I/O size %d", c->min_io_size);
 529                 return -EINVAL;
 530         }
 531
 532         /*
 533          * UBIFS aligns all node to 8-byte boundary, so to make function in
 534          * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
 535          * less than 8.
 536          */
 537         if (c->min_io_size < 8) {
 538                 c->min_io_size = 8;
 539                 c->min_io_shift = 3;
 540         }
 541
 542         c->ref_node_alsz = ALIGN(UBIFS_REF_NODE_SZ, c->min_io_size);
 543         c->mst_node_alsz = ALIGN(UBIFS_MST_NODE_SZ, c->min_io_size);
 544
 545         /*
 546          * Initialize node length ranges which are mostly needed for node
 547          * length validation.
 548          */
 549         c->ranges[UBIFS_PAD_NODE].len  = UBIFS_PAD_NODE_SZ;
 550         c->ranges[UBIFS_SB_NODE].len   = UBIFS_SB_NODE_SZ;
 551         c->ranges[UBIFS_MST_NODE].len  = UBIFS_MST_NODE_SZ;
 552         c->ranges[UBIFS_REF_NODE].len  = UBIFS_REF_NODE_SZ;
 553         c->ranges[UBIFS_TRUN_NODE].len = UBIFS_TRUN_NODE_SZ;
 554         c->ranges[UBIFS_CS_NODE].len   = UBIFS_CS_NODE_SZ;
 555
 556         c->ranges[UBIFS_INO_NODE].min_len  = UBIFS_INO_NODE_SZ;
 557         c->ranges[UBIFS_INO_NODE].max_len  = UBIFS_MAX_INO_NODE_SZ;
 558         c->ranges[UBIFS_ORPH_NODE].min_len =
 559                                 UBIFS_ORPH_NODE_SZ + sizeof(__le64);
 560         c->ranges[UBIFS_ORPH_NODE].max_len = c->leb_size;
 561         c->ranges[UBIFS_DENT_NODE].min_len = UBIFS_DENT_NODE_SZ;
 562         c->ranges[UBIFS_DENT_NODE].max_len = UBIFS_MAX_DENT_NODE_SZ;
 563         c->ranges[UBIFS_XENT_NODE].min_len = UBIFS_XENT_NODE_SZ;
 564         c->ranges[UBIFS_XENT_NODE].max_len = UBIFS_MAX_XENT_NODE_SZ;
 565         c->ranges[UBIFS_DATA_NODE].min_len = UBIFS_DATA_NODE_SZ;
 566         c->ranges[UBIFS_DATA_NODE].max_len = UBIFS_MAX_DATA_NODE_SZ;
 567         /*
 568          * Minimum indexing node size is amended later when superblock is
 569          * read and the key length is known.
 570          */
 571         c->ranges[UBIFS_IDX_NODE].min_len = UBIFS_IDX_NODE_SZ + UBIFS_BRANCH_SZ;
 572         /*
 573          * Maximum indexing node size is amended later when superblock is
 574          * read and the fanout is known.
 575          */
 576         c->ranges[UBIFS_IDX_NODE].max_len = INT_MAX;
 577
 578         /*
 579          * Initialize dead and dark LEB space watermarks. See gc.c for comments
 580          * about these values.
 581          */
 582         c->dead_wm = ALIGN(MIN_WRITE_SZ, c->min_io_size);
 583         c->dark_wm = ALIGN(UBIFS_MAX_NODE_SZ, c->min_io_size);
 584
 585         /*
 586          * Calculate how many bytes would be wasted at the end of LEB if it was
 587          * fully filled with data nodes of maximum size. This is used in
 588          * calculations when reporting free space.
 589          */
 590         c->leb_overhead = c->leb_size % UBIFS_MAX_DATA_NODE_SZ;
 591
 592         /* Buffer size for bulk-reads */
 593         c->max_bu_buf_len = UBIFS_MAX_BULK_READ * UBIFS_MAX_DATA_NODE_SZ;
 594         if (c->max_bu_buf_len > c->leb_size)
 595                 c->max_bu_buf_len = c->leb_size;
 596         return 0;
 597 }
 598
 599 /**
 600  * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
 601  * @c: UBIFS file-system description object
 602  * @lnum: LEB the write-buffer was synchronized to
 603  * @free: how many free bytes left in this LEB
 604  * @pad: how many bytes were padded
 605  *
 606  * This is a callback function which is called by the I/O unit when the
 607  * write-buffer is synchronized. We need this to correctly maintain space
 608  * accounting in bud logical eraseblocks. This function returns zero in case of
 609  * success and a negative error code in case of failure.
 610  *
 611  * This function actually belongs to the journal, but we keep it here because
 612  * we want to keep it static.
 613  */
 614 static int bud_wbuf_callback(struct ubifs_info *c, int lnum, int free, int pad)
 615 {
 616         return ubifs_update_one_lp(c, lnum, free, pad, 0, 0);
 617 }
 618
 619 /*
 620  * init_constants_sb - initialize UBIFS constants.
 621  * @c: UBIFS file-system description object
 622  *
 623  * This is a helper function which initializes various UBIFS constants after
 624  * the superblock has been read. It also checks various UBIFS parameters and
 625  * makes sure they are all right. Returns zero in case of success and a
 626  * negative error code in case of failure.
 627  */
 628 static int init_constants_sb(struct ubifs_info *c)
 629 {
 630         int tmp, err;
 631         long long tmp64;
 632
 633         c->main_bytes = (long long)c->main_lebs * c->leb_size;
 634         c->max_znode_sz = sizeof(struct ubifs_znode) +
 635                                 c->fanout * sizeof(struct ubifs_zbranch);
 636
 637         tmp = ubifs_idx_node_sz(c, 1);
 638         c->ranges[UBIFS_IDX_NODE].min_len = tmp;
 639         c->min_idx_node_sz = ALIGN(tmp, 8);
 640
 641         tmp = ubifs_idx_node_sz(c, c->fanout);
 642         c->ranges[UBIFS_IDX_NODE].max_len = tmp;
 643         c->max_idx_node_sz = ALIGN(tmp, 8);
 644
 645         /* Make sure LEB size is large enough to fit full commit */
 646         tmp = UBIFS_CS_NODE_SZ + UBIFS_REF_NODE_SZ * c->jhead_cnt;
 647         tmp = ALIGN(tmp, c->min_io_size);
 648         if (tmp > c->leb_size) {
 649                 dbg_err("too small LEB size %d, at least %d needed",
 650                         c->leb_size, tmp);
 651                 return -EINVAL;
 652         }
 653
 654         /*
 655          * Make sure that the log is large enough to fit reference nodes for
 656          * all buds plus one reserved LEB.
 657          */
 658         tmp64 = c->max_bud_bytes + c->leb_size - 1;
 659         c->max_bud_cnt = div_u64(tmp64, c->leb_size);
 660         tmp = (c->ref_node_alsz * c->max_bud_cnt + c->leb_size - 1);
 661         tmp /= c->leb_size;
 662         tmp += 1;
 663         if (c->log_lebs < tmp) {
 664                 dbg_err("too small log %d LEBs, required min. %d LEBs",
 665                         c->log_lebs, tmp);
 666                 return -EINVAL;
 667         }
 668
 669         /*
 670          * When budgeting we assume worst-case scenarios when the pages are not
 671          * be compressed and direntries are of the maximum size.
 672          *
 673          * Note, data, which may be stored in inodes is budgeted separately, so
 674          * it is not included into 'c->inode_budget'.
 675          */
 676         c->page_budget = UBIFS_MAX_DATA_NODE_SZ * UBIFS_BLOCKS_PER_PAGE;
 677         c->inode_budget = UBIFS_INO_NODE_SZ;
 678         c->dent_budget = UBIFS_MAX_DENT_NODE_SZ;
 679
 680         /*
 681          * When the amount of flash space used by buds becomes
 682          * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
 683          * The writers are unblocked when the commit is finished. To avoid
 684          * writers to be blocked UBIFS initiates background commit in advance,
 685          * when number of bud bytes becomes above the limit defined below.
 686          */
 687         c->bg_bud_bytes = (c->max_bud_bytes * 13) >> 4;
 688
 689         /*
 690          * Ensure minimum journal size. All the bytes in the journal heads are
 691          * considered to be used, when calculating the current journal usage.
 692          * Consequently, if the journal is too small, UBIFS will treat it as
 693          * always full.
 694          */
 695         tmp64 = (long long)(c->jhead_cnt + 1) * c->leb_size + 1;
 696         if (c->bg_bud_bytes < tmp64)
 697                 c->bg_bud_bytes = tmp64;
 698         if (c->max_bud_bytes < tmp64 + c->leb_size)
 699                 c->max_bud_bytes = tmp64 + c->leb_size;
 700
 701         err = ubifs_calc_lpt_geom(c);
 702         if (err)
 703                 return err;
 704
 705         /* Initialize effective LEB size used in budgeting calculations */
 706         c->idx_leb_size = c->leb_size - c->max_idx_node_sz;
 707         return 0;
 708 }
 709
 710 /*
 711  * init_constants_master - initialize UBIFS constants.
 712  * @c: UBIFS file-system description object
 713  *
 714  * This is a helper function which initializes various UBIFS constants after
 715  * the master node has been read. It also checks various UBIFS parameters and
 716  * makes sure they are all right.
 717  */
 718 static void init_constants_master(struct ubifs_info *c)
 719 {
 720         long long tmp64;
 721
 722         c->min_idx_lebs = ubifs_calc_min_idx_lebs(c);
 723         c->report_rp_size = ubifs_reported_space(c, c->rp_size);
 724
 725         /*
 726          * Calculate total amount of FS blocks. This number is not used
 727          * internally because it does not make much sense for UBIFS, but it is
 728          * necessary to report something for the 'statfs()' call.
 729          *
 730          * Subtract the LEB reserved for GC, the LEB which is reserved for
 731          * deletions, minimum LEBs for the index, and assume only one journal
 732          * head is available.
 733          */
 734         tmp64 = c->main_lebs - 1 - 1 - MIN_INDEX_LEBS - c->jhead_cnt + 1;
 735         tmp64 *= (long long)c->leb_size - c->leb_overhead;
 736         tmp64 = ubifs_reported_space(c, tmp64);
 737         c->block_cnt = tmp64 >> UBIFS_BLOCK_SHIFT;
 738 }
 739
 740 /**
 741  * take_gc_lnum - reserve GC LEB.
 742  * @c: UBIFS file-system description object
 743  *
 744  * This function ensures that the LEB reserved for garbage collection is marked
 745  * as "taken" in lprops. We also have to set free space to LEB size and dirty
 746  * space to zero, because lprops may contain out-of-date information if the
 747  * file-system was un-mounted before it has been committed. This function
 748  * returns zero in case of success and a negative error code in case of
 749  * failure.
 750  */
 751 static int take_gc_lnum(struct ubifs_info *c)
 752 {
 753         int err;
 754
 755         if (c->gc_lnum == -1) {
 756                 ubifs_err("no LEB for GC");
 757                 return -EINVAL;
 758         }
 759
 760         /* And we have to tell lprops that this LEB is taken */
 761         err = ubifs_change_one_lp(c, c->gc_lnum, c->leb_size, 0,
 762                                   LPROPS_TAKEN, 0, 0);
 763         return err;
 764 }
 765
 766 /**
 767  * alloc_wbufs - allocate write-buffers.
 768  * @c: UBIFS file-system description object
 769  *
 770  * This helper function allocates and initializes UBIFS write-buffers. Returns
 771  * zero in case of success and %-ENOMEM in case of failure.
 772  */
 773 static int alloc_wbufs(struct ubifs_info *c)
 774 {
 775         int i, err;
 776
 777         c->jheads = kzalloc(c->jhead_cnt * sizeof(struct ubifs_jhead),
 778                            GFP_KERNEL);
 779         if (!c->jheads)
 780                 return -ENOMEM;
 781
 782         /* Initialize journal heads */
 783         for (i = 0; i < c->jhead_cnt; i++) {
 784                 INIT_LIST_HEAD(&c->jheads[i].buds_list);
 785                 err = ubifs_wbuf_init(c, &c->jheads[i].wbuf);
 786                 if (err)
 787                         return err;
 788
 789                 c->jheads[i].wbuf.sync_callback = &bud_wbuf_callback;
 790                 c->jheads[i].wbuf.jhead = i;
 791         }
 792
 793         c->jheads[BASEHD].wbuf.dtype = UBI_SHORTTERM;
 794         /*
 795          * Garbage Collector head likely contains long-term data and
 796          * does not need to be synchronized by timer.
 797          */
 798         c->jheads[GCHD].wbuf.dtype = UBI_LONGTERM;
 799         c->jheads[GCHD].wbuf.no_timer = 1;
 800
 801         return 0;
 802 }
 803
 804 /**
 805  * free_wbufs - free write-buffers.
 806  * @c: UBIFS file-system description object
 807  */
 808 static void free_wbufs(struct ubifs_info *c)
 809 {
 810         int i;
 811
 812         if (c->jheads) {
 813                 for (i = 0; i < c->jhead_cnt; i++) {
 814                         kfree(c->jheads[i].wbuf.buf);
 815                         kfree(c->jheads[i].wbuf.inodes);
 816                 }
 817                 kfree(c->jheads);
 818                 c->jheads = NULL;
 819         }
 820 }
 821
 822 /**
 823  * free_orphans - free orphans.
 824  * @c: UBIFS file-system description object
 825  */
 826 static void free_orphans(struct ubifs_info *c)
 827 {
 828         struct ubifs_orphan *orph;
 829
 830         while (c->orph_dnext) {
 831                 orph = c->orph_dnext;
 832                 c->orph_dnext = orph->dnext;
 833                 list_del(&orph->list);
 834                 kfree(orph);
 835         }
 836
 837         while (!list_empty(&c->orph_list)) {
 838                 orph = list_entry(c->orph_list.next, struct ubifs_orphan, list);
 839                 list_del(&orph->list);
 840                 kfree(orph);
 841                 dbg_err("orphan list not empty at unmount");
 842         }
 843
 844         vfree(c->orph_buf);
 845         c->orph_buf = NULL;
 846 }
 847
 848 /**
 849  * free_buds - free per-bud objects.
 850  * @c: UBIFS file-system description object
 851  */
 852 static void free_buds(struct ubifs_info *c)
 853 {
 854         struct rb_node *this = c->buds.rb_node;
 855         struct ubifs_bud *bud;
 856
 857         while (this) {
 858                 if (this->rb_left)
 859                         this = this->rb_left;
 860                 else if (this->rb_right)
 861                         this = this->rb_right;
 862                 else {
 863                         bud = rb_entry(this, struct ubifs_bud, rb);
 864                         this = rb_parent(this);
 865                         if (this) {
 866                                 if (this->rb_left == &bud->rb)
 867                                         this->rb_left = NULL;
 868                                 else
 869                                         this->rb_right = NULL;
 870                         }
 871                         kfree(bud);
 872                 }
 873         }
 874 }
 875
 876 /**
 877  * check_volume_empty - check if the UBI volume is empty.
 878  * @c: UBIFS file-system description object
 879  *
 880  * This function checks if the UBIFS volume is empty by looking if its LEBs are
 881  * mapped or not. The result of checking is stored in the @c->empty variable.
 882  * Returns zero in case of success and a negative error code in case of
 883  * failure.
 884  */
 885 static int check_volume_empty(struct ubifs_info *c)
 886 {
 887         int lnum, err;
 888
 889         c->empty = 1;
 890         for (lnum = 0; lnum < c->leb_cnt; lnum++) {
 891                 err = ubi_is_mapped(c->ubi, lnum);
 892                 if (unlikely(err < 0))
 893                         return err;
 894                 if (err == 1) {
 895                         c->empty = 0;
 896                         break;
 897                 }
 898
 899                 cond_resched();
 900         }
 901
 902         return 0;
 903 }
 904
 905 /*
 906  * UBIFS mount options.
 907  *
 908  * Opt_fast_unmount: do not run a journal commit before un-mounting
 909  * Opt_norm_unmount: run a journal commit before un-mounting
 910  * Opt_bulk_read: enable bulk-reads
 911  * Opt_no_bulk_read: disable bulk-reads
 912  * Opt_chk_data_crc: check CRCs when reading data nodes
 913  * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
 914  * Opt_override_compr: override default compressor
 915  * Opt_err: just end of array marker
 916  */
 917 enum {
 918         Opt_fast_unmount,
 919         Opt_norm_unmount,
 920         Opt_bulk_read,
 921         Opt_no_bulk_read,
 922         Opt_chk_data_crc,
 923         Opt_no_chk_data_crc,
 924         Opt_override_compr,
 925         Opt_err,
 926 };
 927
 928 static const match_table_t tokens = {
 929         {Opt_fast_unmount, "fast_unmount"},
 930         {Opt_norm_unmount, "norm_unmount"},
 931         {Opt_bulk_read, "bulk_read"},
 932         {Opt_no_bulk_read, "no_bulk_read"},
 933         {Opt_chk_data_crc, "chk_data_crc"},
 934         {Opt_no_chk_data_crc, "no_chk_data_crc"},
 935         {Opt_override_compr, "compr=%s"},
 936         {Opt_err, NULL},
 937 };
 938
 939 /**
 940  * parse_standard_option - parse a standard mount option.
 941  * @option: the option to parse
 942  *
 943  * Normally, standard mount options like "sync" are passed to file-systems as
 944  * flags. However, when a "rootflags=" kernel boot parameter is used, they may
 945  * be present in the options string. This function tries to deal with this
 946  * situation and parse standard options. Returns 0 if the option was not
 947  * recognized, and the corresponding integer flag if it was.
 948  *
 949  * UBIFS is only interested in the "sync" option, so do not check for anything
 950  * else.
 951  */
 952 static int parse_standard_option(const char *option)
 953 {
 954         ubifs_msg("parse %s", option);
 955         if (!strcmp(option, "sync"))
 956                 return MS_SYNCHRONOUS;
 957         return 0;
 958 }
 959
 960 /**
 961  * ubifs_parse_options - parse mount parameters.
 962  * @c: UBIFS file-system description object
 963  * @options: parameters to parse
 964  * @is_remount: non-zero if this is FS re-mount
 965  *
 966  * This function parses UBIFS mount options and returns zero in case success
 967  * and a negative error code in case of failure.
 968  */
 969 static int ubifs_parse_options(struct ubifs_info *c, char *options,
 970                                int is_remount)
 971 {
 972         char *p;
 973         substring_t args[MAX_OPT_ARGS];
 974
 975         if (!options)
 976                 return 0;
 977
 978         while ((p = strsep(&options, ","))) {
 979                 int token;
 980
 981                 if (!*p)
 982                         continue;
 983
 984                 token = match_token(p, tokens, args);
 985                 switch (token) {
 986                 /*
 987                  * %Opt_fast_unmount and %Opt_norm_unmount options are ignored.
 988                  * We accept them in order to be backward-compatible. But this
 989                  * should be removed at some point.
 990                  */
 991                 case Opt_fast_unmount:
 992                         c->mount_opts.unmount_mode = 2;
 993                         break;
 994                 case Opt_norm_unmount:
 995                         c->mount_opts.unmount_mode = 1;
 996                         break;
 997                 case Opt_bulk_read:
 998                         c->mount_opts.bulk_read = 2;
 999                         c->bulk_read = 1;
1000                         break;
1001                 case Opt_no_bulk_read:
1002                         c->mount_opts.bulk_read = 1;
1003                         c->bulk_read = 0;
1004                         break;
1005                 case Opt_chk_data_crc:
1006                         c->mount_opts.chk_data_crc = 2;
1007                         c->no_chk_data_crc = 0;
1008                         break;
1009                 case Opt_no_chk_data_crc:
1010                         c->mount_opts.chk_data_crc = 1;
1011                         c->no_chk_data_crc = 1;
1012                         break;
1013                 case Opt_override_compr:
1014                 {
1015                         char *name = match_strdup(&args[0]);
1016
1017                         if (!name)
1018                                 return -ENOMEM;
1019                         if (!strcmp(name, "none"))
1020                                 c->mount_opts.compr_type = UBIFS_COMPR_NONE;
1021                         else if (!strcmp(name, "lzo"))
1022                                 c->mount_opts.compr_type = UBIFS_COMPR_LZO;
1023                         else if (!strcmp(name, "zlib"))
1024                                 c->mount_opts.compr_type = UBIFS_COMPR_ZLIB;
1025                         else {
1026                                 ubifs_err("unknown compressor \"%s\"", name);
1027                                 kfree(name);
1028                                 return -EINVAL;
1029                         }
1030                         kfree(name);
1031                         c->mount_opts.override_compr = 1;
1032                         c->default_compr = c->mount_opts.compr_type;
1033                         break;
1034                 }
1035                 default:
1036                 {
1037                         unsigned long flag;
1038                         struct super_block *sb = c->vfs_sb;
1039
1040                         flag = parse_standard_option(p);
1041                         if (!flag) {
1042                                 ubifs_err("unrecognized mount option \"%s\" "
1043                                           "or missing value", p);
1044                                 return -EINVAL;
1045                         }
1046                         sb->s_flags |= flag;
1047                         break;
1048                 }
1049                 }
1050         }
1051
1052         return 0;
1053 }
1054
1055 /**
1056  * destroy_journal - destroy journal data structures.
1057  * @c: UBIFS file-system description object
1058  *
1059  * This function destroys journal data structures including those that may have
1060  * been created by recovery functions.
1061  */
1062 static void destroy_journal(struct ubifs_info *c)
1063 {
1064         while (!list_empty(&c->unclean_leb_list)) {
1065                 struct ubifs_unclean_leb *ucleb;
1066
1067                 ucleb = list_entry(c->unclean_leb_list.next,
1068                                    struct ubifs_unclean_leb, list);
1069                 list_del(&ucleb->list);
1070                 kfree(ucleb);
1071         }
1072         while (!list_empty(&c->old_buds)) {
1073                 struct ubifs_bud *bud;
1074
1075                 bud = list_entry(c->old_buds.next, struct ubifs_bud, list);
1076                 list_del(&bud->list);
1077                 kfree(bud);
1078         }
1079         ubifs_destroy_idx_gc(c);
1080         ubifs_destroy_size_tree(c);
1081         ubifs_tnc_close(c);
1082         free_buds(c);
1083 }
1084
1085 /**
1086  * bu_init - initialize bulk-read information.
1087  * @c: UBIFS file-system description object
1088  */
1089 static void bu_init(struct ubifs_info *c)
1090 {
1091         ubifs_assert(c->bulk_read == 1);
1092
1093         if (c->bu.buf)
1094                 return; /* Already initialized */
1095
1096 again:
1097         c->bu.buf = kmalloc(c->max_bu_buf_len, GFP_KERNEL | __GFP_NOWARN);
1098         if (!c->bu.buf) {
1099                 if (c->max_bu_buf_len > UBIFS_KMALLOC_OK) {
1100                         c->max_bu_buf_len = UBIFS_KMALLOC_OK;
1101                         goto again;
1102                 }
1103
1104                 /* Just disable bulk-read */
1105                 ubifs_warn("Cannot allocate %d bytes of memory for bulk-read, "
1106                            "disabling it", c->max_bu_buf_len);
1107                 c->mount_opts.bulk_read = 1;
1108                 c->bulk_read = 0;
1109                 return;
1110         }
1111 }
1112
1113 /**
1114  * check_free_space - check if there is enough free space to mount.
1115  * @c: UBIFS file-system description object
1116  *
1117  * This function makes sure UBIFS has enough free space to be mounted in
1118  * read/write mode. UBIFS must always have some free space to allow deletions.
1119  */
1120 static int check_free_space(struct ubifs_info *c)
1121 {
1122         ubifs_assert(c->dark_wm > 0);
1123         if (c->lst.total_free + c->lst.total_dirty < c->dark_wm) {
1124                 ubifs_err("insufficient free space to mount in read/write mode");
1125                 dbg_dump_budg(c);
1126                 dbg_dump_lprops(c);
1127                 return -ENOSPC;
1128         }
1129         return 0;
1130 }
1131
1132 /**
1133  * mount_ubifs - mount UBIFS file-system.
1134  * @c: UBIFS file-system description object
1135  *
1136  * This function mounts UBIFS file system. Returns zero in case of success and
1137  * a negative error code in case of failure.
1138  *
1139  * Note, the function does not de-allocate resources it it fails half way
1140  * through, and the caller has to do this instead.
1141  */
1142 static int mount_ubifs(struct ubifs_info *c)
1143 {
1144         struct super_block *sb = c->vfs_sb;
1145         int err, mounted_read_only = (sb->s_flags & MS_RDONLY);
1146         long long x;
1147         size_t sz;
1148
1149         err = init_constants_early(c);
1150         if (err)
1151                 return err;
1152
1153         err = ubifs_debugging_init(c);
1154         if (err)
1155                 return err;
1156
1157         err = check_volume_empty(c);
1158         if (err)
1159                 goto out_free;
1160
1161         if (c->empty && (mounted_read_only || c->ro_media)) {
1162                 /*
1163                  * This UBI volume is empty, and read-only, or the file system
1164                  * is mounted read-only - we cannot format it.
1165                  */
1166                 ubifs_err("can't format empty UBI volume: read-only %s",
1167                           c->ro_media ? "UBI volume" : "mount");
1168                 err = -EROFS;
1169                 goto out_free;
1170         }
1171
1172         if (c->ro_media && !mounted_read_only) {
1173                 ubifs_err("cannot mount read-write - read-only media");
1174                 err = -EROFS;
1175                 goto out_free;
1176         }
1177
1178         /*
1179          * The requirement for the buffer is that it should fit indexing B-tree
1180          * height amount of integers. We assume the height if the TNC tree will
1181          * never exceed 64.
1182          */
1183         err = -ENOMEM;
1184         c->bottom_up_buf = kmalloc(BOTTOM_UP_HEIGHT * sizeof(int), GFP_KERNEL);
1185         if (!c->bottom_up_buf)
1186                 goto out_free;
1187
1188         c->sbuf = vmalloc(c->leb_size);
1189         if (!c->sbuf)
1190                 goto out_free;
1191
1192         if (!mounted_read_only) {
1193                 c->ileb_buf = vmalloc(c->leb_size);
1194                 if (!c->ileb_buf)
1195                         goto out_free;
1196         }
1197
1198         if (c->bulk_read == 1)
1199                 bu_init(c);
1200
1201         /*
1202          * We have to check all CRCs, even for data nodes, when we mount the FS
1203          * (specifically, when we are replaying).
1204          */
1205         c->always_chk_crc = 1;
1206
1207         err = ubifs_read_superblock(c);
1208         if (err)
1209                 goto out_free;
1210
1211         /*
1212          * Make sure the compressor which is set as default in the superblock
1213          * or overridden by mount options is actually compiled in.
1214          */
1215         if (!ubifs_compr_present(c->default_compr)) {
1216                 ubifs_err("'compressor \"%s\" is not compiled in",
1217                           ubifs_compr_name(c->default_compr));
1218                 err = -ENOTSUPP;
1219                 goto out_free;
1220         }
1221
1222         err = init_constants_sb(c);
1223         if (err)
1224                 goto out_free;
1225
1226         sz = ALIGN(c->max_idx_node_sz, c->min_io_size);
1227         sz = ALIGN(sz + c->max_idx_node_sz, c->min_io_size);
1228         c->cbuf = kmalloc(sz, GFP_NOFS);
1229         if (!c->cbuf) {
1230                 err = -ENOMEM;
1231                 goto out_free;
1232         }
1233
1234         sprintf(c->bgt_name, BGT_NAME_PATTERN, c->vi.ubi_num, c->vi.vol_id);
1235         if (!mounted_read_only) {
1236                 err = alloc_wbufs(c);
1237                 if (err)
1238                         goto out_cbuf;
1239
1240                 /* Create background thread */
1241                 c->bgt = kthread_create(ubifs_bg_thread, c, "%s", c->bgt_name);
1242                 if (IS_ERR(c->bgt)) {
1243                         err = PTR_ERR(c->bgt);
1244                         c->bgt = NULL;
1245                         ubifs_err("cannot spawn \"%s\", error %d",
1246                                   c->bgt_name, err);
1247                         goto out_wbufs;
1248                 }
1249                 wake_up_process(c->bgt);
1250         }
1251
1252         err = ubifs_read_master(c);
1253         if (err)
1254                 goto out_master;
1255
1256         init_constants_master(c);
1257
1258         if ((c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY)) != 0) {
1259                 ubifs_msg("recovery needed");
1260                 c->need_recovery = 1;
1261                 if (!mounted_read_only) {
1262                         err = ubifs_recover_inl_heads(c, c->sbuf);
1263                         if (err)
1264                                 goto out_master;
1265                 }
1266         } else if (!mounted_read_only) {
1267                 /*
1268                  * Set the "dirty" flag so that if we reboot uncleanly we
1269                  * will notice this immediately on the next mount.
1270                  */
1271                 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1272                 err = ubifs_write_master(c);
1273                 if (err)
1274                         goto out_master;
1275         }
1276
1277         err = ubifs_lpt_init(c, 1, !mounted_read_only);
1278         if (err)
1279                 goto out_lpt;
1280
1281         err = dbg_check_idx_size(c, c->old_idx_sz);
1282         if (err)
1283                 goto out_lpt;
1284
1285         err = ubifs_replay_journal(c);
1286         if (err)
1287                 goto out_journal;
1288
1289         /* Calculate 'min_idx_lebs' after journal replay */
1290         c->min_idx_lebs = ubifs_calc_min_idx_lebs(c);
1291
1292         err = ubifs_mount_orphans(c, c->need_recovery, mounted_read_only);
1293         if (err)
1294                 goto out_orphans;
1295
1296         if (!mounted_read_only) {
1297                 int lnum;
1298
1299                 err = check_free_space(c);
1300                 if (err)
1301                         goto out_orphans;
1302
1303                 /* Check for enough log space */
1304                 lnum = c->lhead_lnum + 1;
1305                 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1306                         lnum = UBIFS_LOG_LNUM;
1307                 if (lnum == c->ltail_lnum) {
1308                         err = ubifs_consolidate_log(c);
1309                         if (err)
1310                                 goto out_orphans;
1311                 }
1312
1313                 if (c->need_recovery) {
1314                         err = ubifs_recover_size(c);
1315                         if (err)
1316                                 goto out_orphans;
1317                         err = ubifs_rcvry_gc_commit(c);
1318                 } else {
1319                         err = take_gc_lnum(c);
1320                         if (err)
1321                                 goto out_orphans;
1322
1323                         /*
1324                          * GC LEB may contain garbage if there was an unclean
1325                          * reboot, and it should be un-mapped.
1326                          */
1327                         err = ubifs_leb_unmap(c, c->gc_lnum);
1328                         if (err)
1329                                 return err;
1330                 }
1331
1332                 err = dbg_check_lprops(c);
1333                 if (err)
1334                         goto out_orphans;
1335         } else if (c->need_recovery) {
1336                 err = ubifs_recover_size(c);
1337                 if (err)
1338                         goto out_orphans;
1339         } else {
1340                 /*
1341                  * Even if we mount read-only, we have to set space in GC LEB
1342                  * to proper value because this affects UBIFS free space
1343                  * reporting. We do not want to have a situation when
1344                  * re-mounting from R/O to R/W changes amount of free space.
1345                  */
1346                 err = take_gc_lnum(c);
1347                 if (err)
1348                         goto out_orphans;
1349         }
1350
1351         spin_lock(&ubifs_infos_lock);
1352         list_add_tail(&c->infos_list, &ubifs_infos);
1353         spin_unlock(&ubifs_infos_lock);
1354
1355         if (c->need_recovery) {
1356                 if (mounted_read_only)
1357                         ubifs_msg("recovery deferred");
1358                 else {
1359                         c->need_recovery = 0;
1360                         ubifs_msg("recovery completed");
1361                         /*
1362                          * GC LEB has to be empty and taken at this point. But
1363                          * the journal head LEBs may also be accounted as
1364                          * "empty taken" if they are empty.
1365                          */
1366                         ubifs_assert(c->lst.taken_empty_lebs > 0);
1367                 }
1368         } else
1369                 ubifs_assert(c->lst.taken_empty_lebs > 0);
1370
1371         err = dbg_check_filesystem(c);
1372         if (err)
1373                 goto out_infos;
1374
1375         err = dbg_debugfs_init_fs(c);
1376         if (err)
1377                 goto out_infos;
1378
1379         c->always_chk_crc = 0;
1380
1381         ubifs_msg("mounted UBI device %d, volume %d, name \"%s\"",
1382                   c->vi.ubi_num, c->vi.vol_id, c->vi.name);
1383         if (mounted_read_only)
1384                 ubifs_msg("mounted read-only");
1385         x = (long long)c->main_lebs * c->leb_size;
1386         ubifs_msg("file system size:   %lld bytes (%lld KiB, %lld MiB, %d "
1387                   "LEBs)", x, x >> 10, x >> 20, c->main_lebs);
1388         x = (long long)c->log_lebs * c->leb_size + c->max_bud_bytes;
1389         ubifs_msg("journal size:       %lld bytes (%lld KiB, %lld MiB, %d "
1390                   "LEBs)", x, x >> 10, x >> 20, c->log_lebs + c->max_bud_cnt);
1391         ubifs_msg("media format:       w%d/r%d (latest is w%d/r%d)",
1392                   c->fmt_version, c->ro_compat_version,
1393                   UBIFS_FORMAT_VERSION, UBIFS_RO_COMPAT_VERSION);
1394         ubifs_msg("default compressor: %s", ubifs_compr_name(c->default_compr));
1395         ubifs_msg("reserved for root:  %llu bytes (%llu KiB)",
1396                 c->report_rp_size, c->report_rp_size >> 10);
1397
1398         dbg_msg("compiled on:         " __DATE__ " at " __TIME__);
1399         dbg_msg("min. I/O unit size:  %d bytes", c->min_io_size);
1400         dbg_msg("LEB size:            %d bytes (%d KiB)",
1401                 c->leb_size, c->leb_size >> 10);
1402         dbg_msg("data journal heads:  %d",
1403                 c->jhead_cnt - NONDATA_JHEADS_CNT);
1404         dbg_msg("UUID:                %02X%02X%02X%02X-%02X%02X"
1405                "-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
1406                c->uuid[0], c->uuid[1], c->uuid[2], c->uuid[3],
1407                c->uuid[4], c->uuid[5], c->uuid[6], c->uuid[7],
1408                c->uuid[8], c->uuid[9], c->uuid[10], c->uuid[11],
1409                c->uuid[12], c->uuid[13], c->uuid[14], c->uuid[15]);
1410         dbg_msg("big_lpt              %d", c->big_lpt);
1411         dbg_msg("log LEBs:            %d (%d - %d)",
1412                 c->log_lebs, UBIFS_LOG_LNUM, c->log_last);
1413         dbg_msg("LPT area LEBs:       %d (%d - %d)",
1414                 c->lpt_lebs, c->lpt_first, c->lpt_last);
1415         dbg_msg("orphan area LEBs:    %d (%d - %d)",
1416                 c->orph_lebs, c->orph_first, c->orph_last);
1417         dbg_msg("main area LEBs:      %d (%d - %d)",
1418                 c->main_lebs, c->main_first, c->leb_cnt - 1);
1419         dbg_msg("index LEBs:          %d", c->lst.idx_lebs);
1420         dbg_msg("total index bytes:   %lld (%lld KiB, %lld MiB)",
1421                 c->old_idx_sz, c->old_idx_sz >> 10, c->old_idx_sz >> 20);
1422         dbg_msg("key hash type:       %d", c->key_hash_type);
1423         dbg_msg("tree fanout:         %d", c->fanout);
1424         dbg_msg("reserved GC LEB:     %d", c->gc_lnum);
1425         dbg_msg("first main LEB:      %d", c->main_first);
1426         dbg_msg("max. znode size      %d", c->max_znode_sz);
1427         dbg_msg("max. index node size %d", c->max_idx_node_sz);
1428         dbg_msg("node sizes:          data %zu, inode %zu, dentry %zu",
1429                 UBIFS_DATA_NODE_SZ, UBIFS_INO_NODE_SZ, UBIFS_DENT_NODE_SZ);
1430         dbg_msg("node sizes:          trun %zu, sb %zu, master %zu",
1431                 UBIFS_TRUN_NODE_SZ, UBIFS_SB_NODE_SZ, UBIFS_MST_NODE_SZ);
1432         dbg_msg("node sizes:          ref %zu, cmt. start %zu, orph %zu",
1433                 UBIFS_REF_NODE_SZ, UBIFS_CS_NODE_SZ, UBIFS_ORPH_NODE_SZ);
1434         dbg_msg("max. node sizes:     data %zu, inode %zu dentry %zu",
1435                 UBIFS_MAX_DATA_NODE_SZ, UBIFS_MAX_INO_NODE_SZ,
1436                 UBIFS_MAX_DENT_NODE_SZ);
1437         dbg_msg("dead watermark:      %d", c->dead_wm);
1438         dbg_msg("dark watermark:      %d", c->dark_wm);
1439         dbg_msg("LEB overhead:        %d", c->leb_overhead);
1440         x = (long long)c->main_lebs * c->dark_wm;
1441         dbg_msg("max. dark space:     %lld (%lld KiB, %lld MiB)",
1442                 x, x >> 10, x >> 20);
1443         dbg_msg("maximum bud bytes:   %lld (%lld KiB, %lld MiB)",
1444                 c->max_bud_bytes, c->max_bud_bytes >> 10,
1445                 c->max_bud_bytes >> 20);
1446         dbg_msg("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
1447                 c->bg_bud_bytes, c->bg_bud_bytes >> 10,
1448                 c->bg_bud_bytes >> 20);
1449         dbg_msg("current bud bytes    %lld (%lld KiB, %lld MiB)",
1450                 c->bud_bytes, c->bud_bytes >> 10, c->bud_bytes >> 20);
1451         dbg_msg("max. seq. number:    %llu", c->max_sqnum);
1452         dbg_msg("commit number:       %llu", c->cmt_no);
1453
1454         return 0;
1455
1456 out_infos:
1457         spin_lock(&ubifs_infos_lock);
1458         list_del(&c->infos_list);
1459         spin_unlock(&ubifs_infos_lock);
1460 out_orphans:
1461         free_orphans(c);
1462 out_journal:
1463         destroy_journal(c);
1464 out_lpt:
1465         ubifs_lpt_free(c, 0);
1466 out_master:
1467         kfree(c->mst_node);
1468         kfree(c->rcvrd_mst_node);
1469         if (c->bgt)
1470                 kthread_stop(c->bgt);
1471 out_wbufs:
1472         free_wbufs(c);
1473 out_cbuf:
1474         kfree(c->cbuf);
1475 out_free:
1476         kfree(c->bu.buf);
1477         vfree(c->ileb_buf);
1478         vfree(c->sbuf);
1479         kfree(c->bottom_up_buf);
1480         ubifs_debugging_exit(c);
1481         return err;
1482 }
1483
1484 /**
1485  * ubifs_umount - un-mount UBIFS file-system.
1486  * @c: UBIFS file-system description object
1487  *
1488  * Note, this function is called to free allocated resourced when un-mounting,
1489  * as well as free resources when an error occurred while we were half way
1490  * through mounting (error path cleanup function). So it has to make sure the
1491  * resource was actually allocated before freeing it.
1492  */
1493 static void ubifs_umount(struct ubifs_info *c)
1494 {
1495         dbg_gen("un-mounting UBI device %d, volume %d", c->vi.ubi_num,
1496                 c->vi.vol_id);
1497
1498         dbg_debugfs_exit_fs(c);
1499         spin_lock(&ubifs_infos_lock);
1500         list_del(&c->infos_list);
1501         spin_unlock(&ubifs_infos_lock);
1502
1503         if (c->bgt)
1504                 kthread_stop(c->bgt);
1505
1506         destroy_journal(c);
1507         free_wbufs(c);
1508         free_orphans(c);
1509         ubifs_lpt_free(c, 0);
1510
1511         kfree(c->cbuf);
1512         kfree(c->rcvrd_mst_node);
1513         kfree(c->mst_node);
1514         kfree(c->bu.buf);
1515         vfree(c->ileb_buf);
1516         vfree(c->sbuf);
1517         kfree(c->bottom_up_buf);
1518         ubifs_debugging_exit(c);
1519 }
1520
1521 /**
1522  * ubifs_remount_rw - re-mount in read-write mode.
1523  * @c: UBIFS file-system description object
1524  *
1525  * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1526  * mode. This function allocates the needed resources and re-mounts UBIFS in
1527  * read-write mode.
1528  */
1529 static int ubifs_remount_rw(struct ubifs_info *c)
1530 {
1531         int err, lnum;
1532
1533         if (c->rw_incompat) {
1534                 ubifs_err("the file-system is not R/W-compatible");
1535                 ubifs_msg("on-flash format version is w%d/r%d, but software "
1536                           "only supports up to version w%d/r%d", c->fmt_version,
1537                           c->ro_compat_version, UBIFS_FORMAT_VERSION,
1538                           UBIFS_RO_COMPAT_VERSION);
1539                 return -EROFS;
1540         }
1541
1542         mutex_lock(&c->umount_mutex);
1543         dbg_save_space_info(c);
1544         c->remounting_rw = 1;
1545         c->always_chk_crc = 1;
1546
1547         err = check_free_space(c);
1548         if (err)
1549                 goto out;
1550
1551         if (c->old_leb_cnt != c->leb_cnt) {
1552                 struct ubifs_sb_node *sup;
1553
1554                 sup = ubifs_read_sb_node(c);
1555                 if (IS_ERR(sup)) {
1556                         err = PTR_ERR(sup);
1557                         goto out;
1558                 }
1559                 sup->leb_cnt = cpu_to_le32(c->leb_cnt);
1560                 err = ubifs_write_sb_node(c, sup);
1561                 if (err)
1562                         goto out;
1563         }
1564
1565         if (c->need_recovery) {
1566                 ubifs_msg("completing deferred recovery");
1567                 err = ubifs_write_rcvrd_mst_node(c);
1568                 if (err)
1569                         goto out;
1570                 err = ubifs_recover_size(c);
1571                 if (err)
1572                         goto out;
1573                 err = ubifs_clean_lebs(c, c->sbuf);
1574                 if (err)
1575                         goto out;
1576                 err = ubifs_recover_inl_heads(c, c->sbuf);
1577                 if (err)
1578                         goto out;
1579         } else {
1580                 /* A readonly mount is not allowed to have orphans */
1581                 ubifs_assert(c->tot_orphans == 0);
1582                 err = ubifs_clear_orphans(c);
1583                 if (err)
1584                         goto out;
1585         }
1586
1587         if (!(c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY))) {
1588                 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1589                 err = ubifs_write_master(c);
1590                 if (err)
1591                         goto out;
1592         }
1593
1594         c->ileb_buf = vmalloc(c->leb_size);
1595         if (!c->ileb_buf) {
1596                 err = -ENOMEM;
1597                 goto out;
1598         }
1599
1600         err = ubifs_lpt_init(c, 0, 1);
1601         if (err)
1602                 goto out;
1603
1604         err = alloc_wbufs(c);
1605         if (err)
1606                 goto out;
1607
1608         ubifs_create_buds_lists(c);
1609
1610         /* Create background thread */
1611         c->bgt = kthread_create(ubifs_bg_thread, c, "%s", c->bgt_name);
1612         if (IS_ERR(c->bgt)) {
1613                 err = PTR_ERR(c->bgt);
1614                 c->bgt = NULL;
1615                 ubifs_err("cannot spawn \"%s\", error %d",
1616                           c->bgt_name, err);
1617                 goto out;
1618         }
1619         wake_up_process(c->bgt);
1620
1621         c->orph_buf = vmalloc(c->leb_size);
1622         if (!c->orph_buf) {
1623                 err = -ENOMEM;
1624                 goto out;
1625         }
1626
1627         /* Check for enough log space */
1628         lnum = c->lhead_lnum + 1;
1629         if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1630                 lnum = UBIFS_LOG_LNUM;
1631         if (lnum == c->ltail_lnum) {
1632                 err = ubifs_consolidate_log(c);
1633                 if (err)
1634                         goto out;
1635         }
1636
1637         if (c->need_recovery)
1638                 err = ubifs_rcvry_gc_commit(c);
1639         else
1640                 err = ubifs_leb_unmap(c, c->gc_lnum);
1641         if (err)
1642                 goto out;
1643
1644         if (c->need_recovery) {
1645                 c->need_recovery = 0;
1646                 ubifs_msg("deferred recovery completed");
1647         }
1648
1649         dbg_gen("re-mounted read-write");
1650         c->vfs_sb->s_flags &= ~MS_RDONLY;
1651         c->remounting_rw = 0;
1652         c->always_chk_crc = 0;
1653         err = dbg_check_space_info(c);
1654         mutex_unlock(&c->umount_mutex);
1655         return err;
1656
1657 out:
1658         vfree(c->orph_buf);
1659         c->orph_buf = NULL;
1660         if (c->bgt) {
1661                 kthread_stop(c->bgt);
1662                 c->bgt = NULL;
1663         }
1664         free_wbufs(c);
1665         vfree(c->ileb_buf);
1666         c->ileb_buf = NULL;
1667         ubifs_lpt_free(c, 1);
1668         c->remounting_rw = 0;
1669         c->always_chk_crc = 0;
1670         mutex_unlock(&c->umount_mutex);
1671         return err;
1672 }
1673
1674 /**
1675  * ubifs_remount_ro - re-mount in read-only mode.
1676  * @c: UBIFS file-system description object
1677  *
1678  * We assume VFS has stopped writing. Possibly the background thread could be
1679  * running a commit, however kthread_stop will wait in that case.
1680  */
1681 static void ubifs_remount_ro(struct ubifs_info *c)
1682 {
1683         int i, err;
1684
1685         ubifs_assert(!c->need_recovery);
1686         ubifs_assert(!(c->vfs_sb->s_flags & MS_RDONLY));
1687
1688         mutex_lock(&c->umount_mutex);
1689         if (c->bgt) {
1690                 kthread_stop(c->bgt);
1691                 c->bgt = NULL;
1692         }
1693
1694         dbg_save_space_info(c);
1695
1696         for (i = 0; i < c->jhead_cnt; i++) {
1697                 ubifs_wbuf_sync(&c->jheads[i].wbuf);
1698                 hrtimer_cancel(&c->jheads[i].wbuf.timer);
1699         }
1700
1701         c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1702         c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1703         c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1704         err = ubifs_write_master(c);
1705         if (err)
1706                 ubifs_ro_mode(c, err);
1707
1708         free_wbufs(c);
1709         vfree(c->orph_buf);
1710         c->orph_buf = NULL;
1711         vfree(c->ileb_buf);
1712         c->ileb_buf = NULL;
1713         ubifs_lpt_free(c, 1);
1714         err = dbg_check_space_info(c);
1715         if (err)
1716                 ubifs_ro_mode(c, err);
1717         mutex_unlock(&c->umount_mutex);
1718 }
1719
1720 static void ubifs_put_super(struct super_block *sb)
1721 {
1722         int i;
1723         struct ubifs_info *c = sb->s_fs_info;
1724
1725         ubifs_msg("un-mount UBI device %d, volume %d", c->vi.ubi_num,
1726                   c->vi.vol_id);
1727
1728         /*
1729          * The following asserts are only valid if there has not been a failure
1730          * of the media. For example, there will be dirty inodes if we failed
1731          * to write them back because of I/O errors.
1732          */
1733         ubifs_assert(atomic_long_read(&c->dirty_pg_cnt) == 0);
1734         ubifs_assert(c->budg_idx_growth == 0);
1735         ubifs_assert(c->budg_dd_growth == 0);
1736         ubifs_assert(c->budg_data_growth == 0);
1737
1738         /*
1739          * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1740          * and file system un-mount. Namely, it prevents the shrinker from
1741          * picking this superblock for shrinking - it will be just skipped if
1742          * the mutex is locked.
1743          */
1744         mutex_lock(&c->umount_mutex);
1745         if (!(c->vfs_sb->s_flags & MS_RDONLY)) {
1746                 /*
1747                  * First of all kill the background thread to make sure it does
1748                  * not interfere with un-mounting and freeing resources.
1749                  */
1750                 if (c->bgt) {
1751                         kthread_stop(c->bgt);
1752                         c->bgt = NULL;
1753                 }
1754
1755                 /* Synchronize write-buffers */
1756                 if (c->jheads)
1757                         for (i = 0; i < c->jhead_cnt; i++)
1758                                 ubifs_wbuf_sync(&c->jheads[i].wbuf);
1759
1760                 /*
1761                  * On fatal errors c->ro_media is set to 1, in which case we do
1762                  * not write the master node.
1763                  */
1764                 if (!c->ro_media) {
1765                         /*
1766                          * We are being cleanly unmounted which means the
1767                          * orphans were killed - indicate this in the master
1768                          * node. Also save the reserved GC LEB number.
1769                          */
1770                         int err;
1771
1772                         c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1773                         c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1774                         c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1775                         err = ubifs_write_master(c);
1776                         if (err)
1777                                 /*
1778                                  * Recovery will attempt to fix the master area
1779                                  * next mount, so we just print a message and
1780                                  * continue to unmount normally.
1781                                  */
1782                                 ubifs_err("failed to write master node, "
1783                                           "error %d", err);
1784                 }
1785         }
1786
1787         ubifs_umount(c);
1788         bdi_destroy(&c->bdi);
1789         ubi_close_volume(c->ubi);
1790         mutex_unlock(&c->umount_mutex);
1791         kfree(c);
1792 }
1793
1794 static int ubifs_remount_fs(struct super_block *sb, int *flags, char *data)
1795 {
1796         int err;
1797         struct ubifs_info *c = sb->s_fs_info;
1798
1799         dbg_gen("old flags %#lx, new flags %#x", sb->s_flags, *flags);
1800
1801         err = ubifs_parse_options(c, data, 1);
1802         if (err) {
1803                 ubifs_err("invalid or unknown remount parameter");
1804                 return err;
1805         }
1806
1807         if ((sb->s_flags & MS_RDONLY) && !(*flags & MS_RDONLY)) {
1808                 if (c->ro_media) {
1809                         ubifs_msg("cannot re-mount due to prior errors");
1810                         return -EROFS;
1811                 }
1812                 err = ubifs_remount_rw(c);
1813                 if (err)
1814                         return err;
1815         } else if (!(sb->s_flags & MS_RDONLY) && (*flags & MS_RDONLY)) {
1816                 if (c->ro_media) {
1817                         ubifs_msg("cannot re-mount due to prior errors");
1818                         return -EROFS;
1819                 }
1820                 ubifs_remount_ro(c);
1821         }
1822
1823         if (c->bulk_read == 1)
1824                 bu_init(c);
1825         else {
1826                 dbg_gen("disable bulk-read");
1827                 kfree(c->bu.buf);
1828                 c->bu.buf = NULL;
1829         }
1830
1831         ubifs_assert(c->lst.taken_empty_lebs > 0);
1832         return 0;
1833 }
1834
1835 const struct super_operations ubifs_super_operations = {
1836         .alloc_inode   = ubifs_alloc_inode,
1837         .destroy_inode = ubifs_destroy_inode,
1838         .put_super     = ubifs_put_super,
1839         .write_inode   = ubifs_write_inode,
1840         .delete_inode  = ubifs_delete_inode,
1841         .statfs        = ubifs_statfs,
1842         .dirty_inode   = ubifs_dirty_inode,
1843         .remount_fs    = ubifs_remount_fs,
1844         .show_options  = ubifs_show_options,
1845         .sync_fs       = ubifs_sync_fs,
1846 };
1847
1848 /**
1849  * open_ubi - parse UBI device name string and open the UBI device.
1850  * @name: UBI volume name
1851  * @mode: UBI volume open mode
1852  *
1853  * There are several ways to specify UBI volumes when mounting UBIFS:
1854  * o ubiX_Y    - UBI device number X, volume Y;
1855  * o ubiY      - UBI device number 0, volume Y;
1856  * o ubiX:NAME - mount UBI device X, volume with name NAME;
1857  * o ubi:NAME  - mount UBI device 0, volume with name NAME.
1858  *
1859  * Alternative '!' separator may be used instead of ':' (because some shells
1860  * like busybox may interpret ':' as an NFS host name separator). This function
1861  * returns ubi volume object in case of success and a negative error code in
1862  * case of failure.
1863  */
1864 static struct ubi_volume_desc *open_ubi(const char *name, int mode)
1865 {
1866         int dev, vol;
1867         char *endptr;
1868
1869         if (name[0] != 'u' || name[1] != 'b' || name[2] != 'i')
1870                 return ERR_PTR(-EINVAL);
1871
1872         /* ubi:NAME method */
1873         if ((name[3] == ':' || name[3] == '!') && name[4] != '\0')
1874                 return ubi_open_volume_nm(0, name + 4, mode);
1875
1876         if (!isdigit(name[3]))
1877                 return ERR_PTR(-EINVAL);
1878
1879         dev = simple_strtoul(name + 3, &endptr, 0);
1880
1881         /* ubiY method */
1882         if (*endptr == '\0')
1883                 return ubi_open_volume(0, dev, mode);
1884
1885         /* ubiX_Y method */
1886         if (*endptr == '_' && isdigit(endptr[1])) {
1887                 vol = simple_strtoul(endptr + 1, &endptr, 0);
1888                 if (*endptr != '\0')
1889                         return ERR_PTR(-EINVAL);
1890                 return ubi_open_volume(dev, vol, mode);
1891         }
1892
1893         /* ubiX:NAME method */
1894         if ((*endptr == ':' || *endptr == '!') && endptr[1] != '\0')
1895                 return ubi_open_volume_nm(dev, ++endptr, mode);
1896
1897         return ERR_PTR(-EINVAL);
1898 }
1899
1900 static int ubifs_fill_super(struct super_block *sb, void *data, int silent)
1901 {
1902         struct ubi_volume_desc *ubi = sb->s_fs_info;
1903         struct ubifs_info *c;
1904         struct inode *root;
1905         int err;
1906
1907         c = kzalloc(sizeof(struct ubifs_info), GFP_KERNEL);
1908         if (!c)
1909                 return -ENOMEM;
1910
1911         spin_lock_init(&c->cnt_lock);
1912         spin_lock_init(&c->cs_lock);
1913         spin_lock_init(&c->buds_lock);
1914         spin_lock_init(&c->space_lock);
1915         spin_lock_init(&c->orphan_lock);
1916         init_rwsem(&c->commit_sem);
1917         mutex_init(&c->lp_mutex);
1918         mutex_init(&c->tnc_mutex);
1919         mutex_init(&c->log_mutex);
1920         mutex_init(&c->mst_mutex);
1921         mutex_init(&c->umount_mutex);
1922         mutex_init(&c->bu_mutex);
1923         init_waitqueue_head(&c->cmt_wq);
1924         c->buds = RB_ROOT;
1925         c->old_idx = RB_ROOT;
1926         c->size_tree = RB_ROOT;
1927         c->orph_tree = RB_ROOT;
1928         INIT_LIST_HEAD(&c->infos_list);
1929         INIT_LIST_HEAD(&c->idx_gc);
1930         INIT_LIST_HEAD(&c->replay_list);
1931         INIT_LIST_HEAD(&c->replay_buds);
1932         INIT_LIST_HEAD(&c->uncat_list);
1933         INIT_LIST_HEAD(&c->empty_list);
1934         INIT_LIST_HEAD(&c->freeable_list);
1935         INIT_LIST_HEAD(&c->frdi_idx_list);
1936         INIT_LIST_HEAD(&c->unclean_leb_list);
1937         INIT_LIST_HEAD(&c->old_buds);
1938         INIT_LIST_HEAD(&c->orph_list);
1939         INIT_LIST_HEAD(&c->orph_new);
1940
1941         c->vfs_sb = sb;
1942         c->highest_inum = UBIFS_FIRST_INO;
1943         c->lhead_lnum = c->ltail_lnum = UBIFS_LOG_LNUM;
1944
1945         ubi_get_volume_info(ubi, &c->vi);
1946         ubi_get_device_info(c->vi.ubi_num, &c->di);
1947
1948         /* Re-open the UBI device in read-write mode */
1949         c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READWRITE);
1950         if (IS_ERR(c->ubi)) {
1951                 err = PTR_ERR(c->ubi);
1952                 goto out_free;
1953         }
1954
1955         /*
1956          * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
1957          * UBIFS, I/O is not deferred, it is done immediately in readpage,
1958          * which means the user would have to wait not just for their own I/O
1959          * but the read-ahead I/O as well i.e. completely pointless.
1960          *
1961          * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
1962          */
1963         c->bdi.capabilities = BDI_CAP_MAP_COPY;
1964         c->bdi.unplug_io_fn = default_unplug_io_fn;
1965         err  = bdi_init(&c->bdi);
1966         if (err)
1967                 goto out_close;
1968         err = bdi_register(&c->bdi, NULL, "ubifs_%d_%d",
1969                            c->vi.ubi_num, c->vi.vol_id);
1970         if (err)
1971                 goto out_bdi;
1972
1973         err = ubifs_parse_options(c, data, 0);
1974         if (err)
1975                 goto out_bdi;
1976
1977         sb->s_fs_info = c;
1978         sb->s_magic = UBIFS_SUPER_MAGIC;
1979         sb->s_blocksize = UBIFS_BLOCK_SIZE;
1980         sb->s_blocksize_bits = UBIFS_BLOCK_SHIFT;
1981         sb->s_maxbytes = c->max_inode_sz = key_max_inode_size(c);
1982         if (c->max_inode_sz > MAX_LFS_FILESIZE)
1983                 sb->s_maxbytes = c->max_inode_sz = MAX_LFS_FILESIZE;
1984         sb->s_op = &ubifs_super_operations;
1985
1986         mutex_lock(&c->umount_mutex);
1987         err = mount_ubifs(c);
1988         if (err) {
1989                 ubifs_assert(err < 0);
1990                 goto out_unlock;
1991         }
1992
1993         /* Read the root inode */
1994         root = ubifs_iget(sb, UBIFS_ROOT_INO);
1995         if (IS_ERR(root)) {
1996                 err = PTR_ERR(root);
1997                 goto out_umount;
1998         }
1999
2000         sb->s_root = d_alloc_root(root);
2001         if (!sb->s_root)
2002                 goto out_iput;
2003
2004         mutex_unlock(&c->umount_mutex);
2005         return 0;
2006
2007 out_iput:
2008         iput(root);
2009 out_umount:
2010         ubifs_umount(c);
2011 out_unlock:
2012         mutex_unlock(&c->umount_mutex);
2013 out_bdi:
2014         bdi_destroy(&c->bdi);
2015 out_close:
2016         ubi_close_volume(c->ubi);
2017 out_free:
2018         kfree(c);
2019         return err;
2020 }
2021
2022 static int sb_test(struct super_block *sb, void *data)
2023 {
2024         dev_t *dev = data;
2025         struct ubifs_info *c = sb->s_fs_info;
2026
2027         return c->vi.cdev == *dev;
2028 }
2029
2030 static int ubifs_get_sb(struct file_system_type *fs_type, int flags,
2031                         const char *name, void *data, struct vfsmount *mnt)
2032 {
2033         struct ubi_volume_desc *ubi;
2034         struct ubi_volume_info vi;
2035         struct super_block *sb;
2036         int err;
2037
2038         dbg_gen("name %s, flags %#x", name, flags);
2039
2040         /*
2041          * Get UBI device number and volume ID. Mount it read-only so far
2042          * because this might be a new mount point, and UBI allows only one
2043          * read-write user at a time.
2044          */
2045         ubi = open_ubi(name, UBI_READONLY);
2046         if (IS_ERR(ubi)) {
2047                 ubifs_err("cannot open \"%s\", error %d",
2048                           name, (int)PTR_ERR(ubi));
2049                 return PTR_ERR(ubi);
2050         }
2051         ubi_get_volume_info(ubi, &vi);
2052
2053         dbg_gen("opened ubi%d_%d", vi.ubi_num, vi.vol_id);
2054
2055         sb = sget(fs_type, &sb_test, &set_anon_super, &vi.cdev);
2056         if (IS_ERR(sb)) {
2057                 err = PTR_ERR(sb);
2058                 goto out_close;
2059         }
2060
2061         if (sb->s_root) {
2062                 /* A new mount point for already mounted UBIFS */
2063                 dbg_gen("this ubi volume is already mounted");
2064                 if ((flags ^ sb->s_flags) & MS_RDONLY) {
2065                         err = -EBUSY;
2066                         goto out_deact;
2067                 }
2068         } else {
2069                 sb->s_flags = flags;
2070                 /*
2071                  * Pass 'ubi' to 'fill_super()' in sb->s_fs_info where it is
2072                  * replaced by 'c'.
2073                  */
2074                 sb->s_fs_info = ubi;
2075                 err = ubifs_fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
2076                 if (err)
2077                         goto out_deact;
2078                 /* We do not support atime */
2079                 sb->s_flags |= MS_ACTIVE | MS_NOATIME;
2080         }
2081
2082         /* 'fill_super()' opens ubi again so we must close it here */
2083         ubi_close_volume(ubi);
2084
2085         simple_set_mnt(mnt, sb);
2086         return 0;
2087
2088 out_deact:
2089         deactivate_locked_super(sb);
2090 out_close:
2091         ubi_close_volume(ubi);
2092         return err;
2093 }
2094
2095 static struct file_system_type ubifs_fs_type = {
2096         .name    = "ubifs",
2097         .owner   = THIS_MODULE,
2098         .get_sb  = ubifs_get_sb,
2099         .kill_sb = kill_anon_super,
2100 };
2101
2102 /*
2103  * Inode slab cache constructor.
2104  */
2105 static void inode_slab_ctor(void *obj)
2106 {
2107         struct ubifs_inode *ui = obj;
2108         inode_init_once(&ui->vfs_inode);
2109 }
2110
2111 static int __init ubifs_init(void)
2112 {
2113         int err;
2114
2115         BUILD_BUG_ON(sizeof(struct ubifs_ch) != 24);
2116
2117         /* Make sure node sizes are 8-byte aligned */
2118         BUILD_BUG_ON(UBIFS_CH_SZ        & 7);
2119         BUILD_BUG_ON(UBIFS_INO_NODE_SZ  & 7);
2120         BUILD_BUG_ON(UBIFS_DENT_NODE_SZ & 7);
2121         BUILD_BUG_ON(UBIFS_XENT_NODE_SZ & 7);
2122         BUILD_BUG_ON(UBIFS_DATA_NODE_SZ & 7);
2123         BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ & 7);
2124         BUILD_BUG_ON(UBIFS_SB_NODE_SZ   & 7);
2125         BUILD_BUG_ON(UBIFS_MST_NODE_SZ  & 7);
2126         BUILD_BUG_ON(UBIFS_REF_NODE_SZ  & 7);
2127         BUILD_BUG_ON(UBIFS_CS_NODE_SZ   & 7);
2128         BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ & 7);
2129
2130         BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ & 7);
2131         BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ & 7);
2132         BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ & 7);
2133         BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ  & 7);
2134         BUILD_BUG_ON(UBIFS_MAX_NODE_SZ      & 7);
2135         BUILD_BUG_ON(MIN_WRITE_SZ           & 7);
2136
2137         /* Check min. node size */
2138         BUILD_BUG_ON(UBIFS_INO_NODE_SZ  < MIN_WRITE_SZ);
2139         BUILD_BUG_ON(UBIFS_DENT_NODE_SZ < MIN_WRITE_SZ);
2140         BUILD_BUG_ON(UBIFS_XENT_NODE_SZ < MIN_WRITE_SZ);
2141         BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ < MIN_WRITE_SZ);
2142
2143         BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2144         BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2145         BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ > UBIFS_MAX_NODE_SZ);
2146         BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ  > UBIFS_MAX_NODE_SZ);
2147
2148         /* Defined node sizes */
2149         BUILD_BUG_ON(UBIFS_SB_NODE_SZ  != 4096);
2150         BUILD_BUG_ON(UBIFS_MST_NODE_SZ != 512);
2151         BUILD_BUG_ON(UBIFS_INO_NODE_SZ != 160);
2152         BUILD_BUG_ON(UBIFS_REF_NODE_SZ != 64);
2153
2154         /*
2155          * We use 2 bit wide bit-fields to store compression type, which should
2156          * be amended if more compressors are added. The bit-fields are:
2157          * @compr_type in 'struct ubifs_inode', @default_compr in
2158          * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
2159          */
2160         BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT > 4);
2161
2162         /*
2163          * We require that PAGE_CACHE_SIZE is greater-than-or-equal-to
2164          * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2165          */
2166         if (PAGE_CACHE_SIZE < UBIFS_BLOCK_SIZE) {
2167                 ubifs_err("VFS page cache size is %u bytes, but UBIFS requires"
2168                           " at least 4096 bytes",
2169                           (unsigned int)PAGE_CACHE_SIZE);
2170                 return -EINVAL;
2171         }
2172
2173         err = register_filesystem(&ubifs_fs_type);
2174         if (err) {
2175                 ubifs_err("cannot register file system, error %d", err);
2176                 return err;
2177         }
2178
2179         err = -ENOMEM;
2180         ubifs_inode_slab = kmem_cache_create("ubifs_inode_slab",
2181                                 sizeof(struct ubifs_inode), 0,
2182                                 SLAB_MEM_SPREAD | SLAB_RECLAIM_ACCOUNT,
2183                                 &inode_slab_ctor);
2184         if (!ubifs_inode_slab)
2185                 goto out_reg;
2186
2187         register_shrinker(&ubifs_shrinker_info);
2188
2189         err = ubifs_compressors_init();
2190         if (err)
2191                 goto out_shrinker;
2192
2193         err = dbg_debugfs_init();
2194         if (err)
2195                 goto out_compr;
2196
2197         return 0;
2198
2199 out_compr:
2200         ubifs_compressors_exit();
2201 out_shrinker:
2202         unregister_shrinker(&ubifs_shrinker_info);
2203         kmem_cache_destroy(ubifs_inode_slab);
2204 out_reg:
2205         unregister_filesystem(&ubifs_fs_type);
2206         return err;
2207 }
2208 /* late_initcall to let compressors initialize first */
2209 late_initcall(ubifs_init);
2210
2211 static void __exit ubifs_exit(void)
2212 {
2213         ubifs_assert(list_empty(&ubifs_infos));
2214         ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt) == 0);
2215
2216         dbg_debugfs_exit();
2217         ubifs_compressors_exit();
2218         unregister_shrinker(&ubifs_shrinker_info);
2219         kmem_cache_destroy(ubifs_inode_slab);
2220         unregister_filesystem(&ubifs_fs_type);
2221 }
2222 module_exit(ubifs_exit);
2223
2224 MODULE_LICENSE("GPL");
2225 MODULE_VERSION(__stringify(UBIFS_VERSION));
2226 MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2227 MODULE_DESCRIPTION("UBIFS - UBI File System");