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