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