fs/ubifs/super.c

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