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