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