UBIFS: fix file-system synchronization
[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         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         struct ubifs_info *c = sb->s_fs_info;
433         int i, ret = 0, err;
434         long long bud_bytes;
435         struct writeback_control wbc = {
436                 .sync_mode   = wait ? WB_SYNC_ALL : WB_SYNC_HOLD,
437                 .range_start = 0,
438                 .range_end   = LLONG_MAX,
439                 .nr_to_write = LONG_MAX,
440         };
441
442         /*
443          * VFS calls '->sync_fs()' before synchronizing all dirty inodes and
444          * pages, so synchronize them first, then commit the journal. Strictly
445          * speaking, it is not necessary to commit the journal here,
446          * synchronizing write-buffers would be enough. But committing makes
447          * UBIFS free space predictions much more accurate, so we want to let
448          * the user be able to get more accurate results of 'statfs()' after
449          * they synchronize the file system.
450          */
451         generic_sync_sb_inodes(sb, &wbc);
452
453         if (c->jheads) {
454                 for (i = 0; i < c->jhead_cnt; i++) {
455                         err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
456                         if (err && !ret)
457                                 ret = err;
458                 }
459
460                 /* Commit the journal unless it has too little data */
461                 spin_lock(&c->buds_lock);
462                 bud_bytes = c->bud_bytes;
463                 spin_unlock(&c->buds_lock);
464                 if (bud_bytes > c->leb_size) {
465                         err = ubifs_run_commit(c);
466                         if (err)
467                                 return err;
468                 }
469         }
470
471         /*
472          * We ought to call sync for c->ubi but it does not have one. If it had
473          * it would in turn call mtd->sync, however mtd operations are
474          * synchronous anyway, so we don't lose any sleep here.
475          */
476         return ret;
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  * mount_ubifs - mount UBIFS file-system.
1085  * @c: UBIFS file-system description object
1086  *
1087  * This function mounts UBIFS file system. Returns zero in case of success and
1088  * a negative error code in case of failure.
1089  *
1090  * Note, the function does not de-allocate resources it it fails half way
1091  * through, and the caller has to do this instead.
1092  */
1093 static int mount_ubifs(struct ubifs_info *c)
1094 {
1095         struct super_block *sb = c->vfs_sb;
1096         int err, mounted_read_only = (sb->s_flags & MS_RDONLY);
1097         long long x;
1098         size_t sz;
1099
1100         err = init_constants_early(c);
1101         if (err)
1102                 return err;
1103
1104         err = ubifs_debugging_init(c);
1105         if (err)
1106                 return err;
1107
1108         err = check_volume_empty(c);
1109         if (err)
1110                 goto out_free;
1111
1112         if (c->empty && (mounted_read_only || c->ro_media)) {
1113                 /*
1114                  * This UBI volume is empty, and read-only, or the file system
1115                  * is mounted read-only - we cannot format it.
1116                  */
1117                 ubifs_err("can't format empty UBI volume: read-only %s",
1118                           c->ro_media ? "UBI volume" : "mount");
1119                 err = -EROFS;
1120                 goto out_free;
1121         }
1122
1123         if (c->ro_media && !mounted_read_only) {
1124                 ubifs_err("cannot mount read-write - read-only media");
1125                 err = -EROFS;
1126                 goto out_free;
1127         }
1128
1129         /*
1130          * The requirement for the buffer is that it should fit indexing B-tree
1131          * height amount of integers. We assume the height if the TNC tree will
1132          * never exceed 64.
1133          */
1134         err = -ENOMEM;
1135         c->bottom_up_buf = kmalloc(BOTTOM_UP_HEIGHT * sizeof(int), GFP_KERNEL);
1136         if (!c->bottom_up_buf)
1137                 goto out_free;
1138
1139         c->sbuf = vmalloc(c->leb_size);
1140         if (!c->sbuf)
1141                 goto out_free;
1142
1143         if (!mounted_read_only) {
1144                 c->ileb_buf = vmalloc(c->leb_size);
1145                 if (!c->ileb_buf)
1146                         goto out_free;
1147         }
1148
1149         if (c->bulk_read == 1)
1150                 bu_init(c);
1151
1152         /*
1153          * We have to check all CRCs, even for data nodes, when we mount the FS
1154          * (specifically, when we are replaying).
1155          */
1156         c->always_chk_crc = 1;
1157
1158         err = ubifs_read_superblock(c);
1159         if (err)
1160                 goto out_free;
1161
1162         /*
1163          * Make sure the compressor which is set as default in the superblock
1164          * or overriden by mount options is actually compiled in.
1165          */
1166         if (!ubifs_compr_present(c->default_compr)) {
1167                 ubifs_err("'compressor \"%s\" is not compiled in",
1168                           ubifs_compr_name(c->default_compr));
1169                 goto out_free;
1170         }
1171
1172         err = init_constants_sb(c);
1173         if (err)
1174                 goto out_free;
1175
1176         sz = ALIGN(c->max_idx_node_sz, c->min_io_size);
1177         sz = ALIGN(sz + c->max_idx_node_sz, c->min_io_size);
1178         c->cbuf = kmalloc(sz, GFP_NOFS);
1179         if (!c->cbuf) {
1180                 err = -ENOMEM;
1181                 goto out_free;
1182         }
1183
1184         sprintf(c->bgt_name, BGT_NAME_PATTERN, c->vi.ubi_num, c->vi.vol_id);
1185         if (!mounted_read_only) {
1186                 err = alloc_wbufs(c);
1187                 if (err)
1188                         goto out_cbuf;
1189
1190                 /* Create background thread */
1191                 c->bgt = kthread_create(ubifs_bg_thread, c, c->bgt_name);
1192                 if (IS_ERR(c->bgt)) {
1193                         err = PTR_ERR(c->bgt);
1194                         c->bgt = NULL;
1195                         ubifs_err("cannot spawn \"%s\", error %d",
1196                                   c->bgt_name, err);
1197                         goto out_wbufs;
1198                 }
1199                 wake_up_process(c->bgt);
1200         }
1201
1202         err = ubifs_read_master(c);
1203         if (err)
1204                 goto out_master;
1205
1206         init_constants_master(c);
1207
1208         if ((c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY)) != 0) {
1209                 ubifs_msg("recovery needed");
1210                 c->need_recovery = 1;
1211                 if (!mounted_read_only) {
1212                         err = ubifs_recover_inl_heads(c, c->sbuf);
1213                         if (err)
1214                                 goto out_master;
1215                 }
1216         } else if (!mounted_read_only) {
1217                 /*
1218                  * Set the "dirty" flag so that if we reboot uncleanly we
1219                  * will notice this immediately on the next mount.
1220                  */
1221                 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1222                 err = ubifs_write_master(c);
1223                 if (err)
1224                         goto out_master;
1225         }
1226
1227         err = ubifs_lpt_init(c, 1, !mounted_read_only);
1228         if (err)
1229                 goto out_lpt;
1230
1231         err = dbg_check_idx_size(c, c->old_idx_sz);
1232         if (err)
1233                 goto out_lpt;
1234
1235         err = ubifs_replay_journal(c);
1236         if (err)
1237                 goto out_journal;
1238
1239         err = ubifs_mount_orphans(c, c->need_recovery, mounted_read_only);
1240         if (err)
1241                 goto out_orphans;
1242
1243         if (!mounted_read_only) {
1244                 int lnum;
1245
1246                 /* Check for enough free space */
1247                 if (ubifs_calc_available(c, c->min_idx_lebs) <= 0) {
1248                         ubifs_err("insufficient available space");
1249                         err = -EINVAL;
1250                         goto out_orphans;
1251                 }
1252
1253                 /* Check for enough log space */
1254                 lnum = c->lhead_lnum + 1;
1255                 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1256                         lnum = UBIFS_LOG_LNUM;
1257                 if (lnum == c->ltail_lnum) {
1258                         err = ubifs_consolidate_log(c);
1259                         if (err)
1260                                 goto out_orphans;
1261                 }
1262
1263                 if (c->need_recovery) {
1264                         err = ubifs_recover_size(c);
1265                         if (err)
1266                                 goto out_orphans;
1267                         err = ubifs_rcvry_gc_commit(c);
1268                 } else
1269                         err = take_gc_lnum(c);
1270                 if (err)
1271                         goto out_orphans;
1272
1273                 err = dbg_check_lprops(c);
1274                 if (err)
1275                         goto out_orphans;
1276         } else if (c->need_recovery) {
1277                 err = ubifs_recover_size(c);
1278                 if (err)
1279                         goto out_orphans;
1280         }
1281
1282         spin_lock(&ubifs_infos_lock);
1283         list_add_tail(&c->infos_list, &ubifs_infos);
1284         spin_unlock(&ubifs_infos_lock);
1285
1286         if (c->need_recovery) {
1287                 if (mounted_read_only)
1288                         ubifs_msg("recovery deferred");
1289                 else {
1290                         c->need_recovery = 0;
1291                         ubifs_msg("recovery completed");
1292                 }
1293         }
1294
1295         err = dbg_debugfs_init_fs(c);
1296         if (err)
1297                 goto out_infos;
1298
1299         err = dbg_check_filesystem(c);
1300         if (err)
1301                 goto out_infos;
1302
1303         c->always_chk_crc = 0;
1304
1305         ubifs_msg("mounted UBI device %d, volume %d, name \"%s\"",
1306                   c->vi.ubi_num, c->vi.vol_id, c->vi.name);
1307         if (mounted_read_only)
1308                 ubifs_msg("mounted read-only");
1309         x = (long long)c->main_lebs * c->leb_size;
1310         ubifs_msg("file system size:   %lld bytes (%lld KiB, %lld MiB, %d "
1311                   "LEBs)", x, x >> 10, x >> 20, c->main_lebs);
1312         x = (long long)c->log_lebs * c->leb_size + c->max_bud_bytes;
1313         ubifs_msg("journal size:       %lld bytes (%lld KiB, %lld MiB, %d "
1314                   "LEBs)", x, x >> 10, x >> 20, c->log_lebs + c->max_bud_cnt);
1315         ubifs_msg("media format:       %d (latest is %d)",
1316                   c->fmt_version, UBIFS_FORMAT_VERSION);
1317         ubifs_msg("default compressor: %s", ubifs_compr_name(c->default_compr));
1318         ubifs_msg("reserved for root:  %llu bytes (%llu KiB)",
1319                 c->report_rp_size, c->report_rp_size >> 10);
1320
1321         dbg_msg("compiled on:         " __DATE__ " at " __TIME__);
1322         dbg_msg("min. I/O unit size:  %d bytes", c->min_io_size);
1323         dbg_msg("LEB size:            %d bytes (%d KiB)",
1324                 c->leb_size, c->leb_size >> 10);
1325         dbg_msg("data journal heads:  %d",
1326                 c->jhead_cnt - NONDATA_JHEADS_CNT);
1327         dbg_msg("UUID:                %02X%02X%02X%02X-%02X%02X"
1328                "-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
1329                c->uuid[0], c->uuid[1], c->uuid[2], c->uuid[3],
1330                c->uuid[4], c->uuid[5], c->uuid[6], c->uuid[7],
1331                c->uuid[8], c->uuid[9], c->uuid[10], c->uuid[11],
1332                c->uuid[12], c->uuid[13], c->uuid[14], c->uuid[15]);
1333         dbg_msg("fast unmount:        %d", c->fast_unmount);
1334         dbg_msg("big_lpt              %d", c->big_lpt);
1335         dbg_msg("log LEBs:            %d (%d - %d)",
1336                 c->log_lebs, UBIFS_LOG_LNUM, c->log_last);
1337         dbg_msg("LPT area LEBs:       %d (%d - %d)",
1338                 c->lpt_lebs, c->lpt_first, c->lpt_last);
1339         dbg_msg("orphan area LEBs:    %d (%d - %d)",
1340                 c->orph_lebs, c->orph_first, c->orph_last);
1341         dbg_msg("main area LEBs:      %d (%d - %d)",
1342                 c->main_lebs, c->main_first, c->leb_cnt - 1);
1343         dbg_msg("index LEBs:          %d", c->lst.idx_lebs);
1344         dbg_msg("total index bytes:   %lld (%lld KiB, %lld MiB)",
1345                 c->old_idx_sz, c->old_idx_sz >> 10, c->old_idx_sz >> 20);
1346         dbg_msg("key hash type:       %d", c->key_hash_type);
1347         dbg_msg("tree fanout:         %d", c->fanout);
1348         dbg_msg("reserved GC LEB:     %d", c->gc_lnum);
1349         dbg_msg("first main LEB:      %d", c->main_first);
1350         dbg_msg("dead watermark:      %d", c->dead_wm);
1351         dbg_msg("dark watermark:      %d", c->dark_wm);
1352         x = (long long)c->main_lebs * c->dark_wm;
1353         dbg_msg("max. dark space:     %lld (%lld KiB, %lld MiB)",
1354                 x, x >> 10, x >> 20);
1355         dbg_msg("maximum bud bytes:   %lld (%lld KiB, %lld MiB)",
1356                 c->max_bud_bytes, c->max_bud_bytes >> 10,
1357                 c->max_bud_bytes >> 20);
1358         dbg_msg("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
1359                 c->bg_bud_bytes, c->bg_bud_bytes >> 10,
1360                 c->bg_bud_bytes >> 20);
1361         dbg_msg("current bud bytes    %lld (%lld KiB, %lld MiB)",
1362                 c->bud_bytes, c->bud_bytes >> 10, c->bud_bytes >> 20);
1363         dbg_msg("max. seq. number:    %llu", c->max_sqnum);
1364         dbg_msg("commit number:       %llu", c->cmt_no);
1365
1366         return 0;
1367
1368 out_infos:
1369         spin_lock(&ubifs_infos_lock);
1370         list_del(&c->infos_list);
1371         spin_unlock(&ubifs_infos_lock);
1372 out_orphans:
1373         free_orphans(c);
1374 out_journal:
1375         destroy_journal(c);
1376 out_lpt:
1377         ubifs_lpt_free(c, 0);
1378 out_master:
1379         kfree(c->mst_node);
1380         kfree(c->rcvrd_mst_node);
1381         if (c->bgt)
1382                 kthread_stop(c->bgt);
1383 out_wbufs:
1384         free_wbufs(c);
1385 out_cbuf:
1386         kfree(c->cbuf);
1387 out_free:
1388         kfree(c->bu.buf);
1389         vfree(c->ileb_buf);
1390         vfree(c->sbuf);
1391         kfree(c->bottom_up_buf);
1392         ubifs_debugging_exit(c);
1393         return err;
1394 }
1395
1396 /**
1397  * ubifs_umount - un-mount UBIFS file-system.
1398  * @c: UBIFS file-system description object
1399  *
1400  * Note, this function is called to free allocated resourced when un-mounting,
1401  * as well as free resources when an error occurred while we were half way
1402  * through mounting (error path cleanup function). So it has to make sure the
1403  * resource was actually allocated before freeing it.
1404  */
1405 static void ubifs_umount(struct ubifs_info *c)
1406 {
1407         dbg_gen("un-mounting UBI device %d, volume %d", c->vi.ubi_num,
1408                 c->vi.vol_id);
1409
1410         dbg_debugfs_exit_fs(c);
1411         spin_lock(&ubifs_infos_lock);
1412         list_del(&c->infos_list);
1413         spin_unlock(&ubifs_infos_lock);
1414
1415         if (c->bgt)
1416                 kthread_stop(c->bgt);
1417
1418         destroy_journal(c);
1419         free_wbufs(c);
1420         free_orphans(c);
1421         ubifs_lpt_free(c, 0);
1422
1423         kfree(c->cbuf);
1424         kfree(c->rcvrd_mst_node);
1425         kfree(c->mst_node);
1426         kfree(c->bu.buf);
1427         vfree(c->ileb_buf);
1428         vfree(c->sbuf);
1429         kfree(c->bottom_up_buf);
1430         ubifs_debugging_exit(c);
1431 }
1432
1433 /**
1434  * ubifs_remount_rw - re-mount in read-write mode.
1435  * @c: UBIFS file-system description object
1436  *
1437  * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1438  * mode. This function allocates the needed resources and re-mounts UBIFS in
1439  * read-write mode.
1440  */
1441 static int ubifs_remount_rw(struct ubifs_info *c)
1442 {
1443         int err, lnum;
1444
1445         if (c->ro_media)
1446                 return -EINVAL;
1447
1448         mutex_lock(&c->umount_mutex);
1449         c->remounting_rw = 1;
1450         c->always_chk_crc = 1;
1451
1452         /* Check for enough free space */
1453         if (ubifs_calc_available(c, c->min_idx_lebs) <= 0) {
1454                 ubifs_err("insufficient available space");
1455                 err = -EINVAL;
1456                 goto out;
1457         }
1458
1459         if (c->old_leb_cnt != c->leb_cnt) {
1460                 struct ubifs_sb_node *sup;
1461
1462                 sup = ubifs_read_sb_node(c);
1463                 if (IS_ERR(sup)) {
1464                         err = PTR_ERR(sup);
1465                         goto out;
1466                 }
1467                 sup->leb_cnt = cpu_to_le32(c->leb_cnt);
1468                 err = ubifs_write_sb_node(c, sup);
1469                 if (err)
1470                         goto out;
1471         }
1472
1473         if (c->need_recovery) {
1474                 ubifs_msg("completing deferred recovery");
1475                 err = ubifs_write_rcvrd_mst_node(c);
1476                 if (err)
1477                         goto out;
1478                 err = ubifs_recover_size(c);
1479                 if (err)
1480                         goto out;
1481                 err = ubifs_clean_lebs(c, c->sbuf);
1482                 if (err)
1483                         goto out;
1484                 err = ubifs_recover_inl_heads(c, c->sbuf);
1485                 if (err)
1486                         goto out;
1487         }
1488
1489         if (!(c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY))) {
1490                 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1491                 err = ubifs_write_master(c);
1492                 if (err)
1493                         goto out;
1494         }
1495
1496         c->ileb_buf = vmalloc(c->leb_size);
1497         if (!c->ileb_buf) {
1498                 err = -ENOMEM;
1499                 goto out;
1500         }
1501
1502         err = ubifs_lpt_init(c, 0, 1);
1503         if (err)
1504                 goto out;
1505
1506         err = alloc_wbufs(c);
1507         if (err)
1508                 goto out;
1509
1510         ubifs_create_buds_lists(c);
1511
1512         /* Create background thread */
1513         c->bgt = kthread_create(ubifs_bg_thread, c, c->bgt_name);
1514         if (IS_ERR(c->bgt)) {
1515                 err = PTR_ERR(c->bgt);
1516                 c->bgt = NULL;
1517                 ubifs_err("cannot spawn \"%s\", error %d",
1518                           c->bgt_name, err);
1519                 goto out;
1520         }
1521         wake_up_process(c->bgt);
1522
1523         c->orph_buf = vmalloc(c->leb_size);
1524         if (!c->orph_buf) {
1525                 err = -ENOMEM;
1526                 goto out;
1527         }
1528
1529         /* Check for enough log space */
1530         lnum = c->lhead_lnum + 1;
1531         if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1532                 lnum = UBIFS_LOG_LNUM;
1533         if (lnum == c->ltail_lnum) {
1534                 err = ubifs_consolidate_log(c);
1535                 if (err)
1536                         goto out;
1537         }
1538
1539         if (c->need_recovery)
1540                 err = ubifs_rcvry_gc_commit(c);
1541         else
1542                 err = take_gc_lnum(c);
1543         if (err)
1544                 goto out;
1545
1546         if (c->need_recovery) {
1547                 c->need_recovery = 0;
1548                 ubifs_msg("deferred recovery completed");
1549         }
1550
1551         dbg_gen("re-mounted read-write");
1552         c->vfs_sb->s_flags &= ~MS_RDONLY;
1553         c->remounting_rw = 0;
1554         c->always_chk_crc = 0;
1555         mutex_unlock(&c->umount_mutex);
1556         return 0;
1557
1558 out:
1559         vfree(c->orph_buf);
1560         c->orph_buf = NULL;
1561         if (c->bgt) {
1562                 kthread_stop(c->bgt);
1563                 c->bgt = NULL;
1564         }
1565         free_wbufs(c);
1566         vfree(c->ileb_buf);
1567         c->ileb_buf = NULL;
1568         ubifs_lpt_free(c, 1);
1569         c->remounting_rw = 0;
1570         c->always_chk_crc = 0;
1571         mutex_unlock(&c->umount_mutex);
1572         return err;
1573 }
1574
1575 /**
1576  * commit_on_unmount - commit the journal when un-mounting.
1577  * @c: UBIFS file-system description object
1578  *
1579  * This function is called during un-mounting and re-mounting, and it commits
1580  * the journal unless the "fast unmount" mode is enabled. It also avoids
1581  * committing the journal if it contains too few data.
1582  */
1583 static void commit_on_unmount(struct ubifs_info *c)
1584 {
1585         if (!c->fast_unmount) {
1586                 long long bud_bytes;
1587
1588                 spin_lock(&c->buds_lock);
1589                 bud_bytes = c->bud_bytes;
1590                 spin_unlock(&c->buds_lock);
1591                 if (bud_bytes > c->leb_size)
1592                         ubifs_run_commit(c);
1593         }
1594 }
1595
1596 /**
1597  * ubifs_remount_ro - re-mount in read-only mode.
1598  * @c: UBIFS file-system description object
1599  *
1600  * We rely on VFS to have stopped writing. Possibly the background thread could
1601  * be running a commit, however kthread_stop will wait in that case.
1602  */
1603 static void ubifs_remount_ro(struct ubifs_info *c)
1604 {
1605         int i, err;
1606
1607         ubifs_assert(!c->need_recovery);
1608         commit_on_unmount(c);
1609
1610         mutex_lock(&c->umount_mutex);
1611         if (c->bgt) {
1612                 kthread_stop(c->bgt);
1613                 c->bgt = NULL;
1614         }
1615
1616         for (i = 0; i < c->jhead_cnt; i++) {
1617                 ubifs_wbuf_sync(&c->jheads[i].wbuf);
1618                 del_timer_sync(&c->jheads[i].wbuf.timer);
1619         }
1620
1621         if (!c->ro_media) {
1622                 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1623                 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1624                 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1625                 err = ubifs_write_master(c);
1626                 if (err)
1627                         ubifs_ro_mode(c, err);
1628         }
1629
1630         ubifs_destroy_idx_gc(c);
1631         free_wbufs(c);
1632         vfree(c->orph_buf);
1633         c->orph_buf = NULL;
1634         vfree(c->ileb_buf);
1635         c->ileb_buf = NULL;
1636         ubifs_lpt_free(c, 1);
1637         mutex_unlock(&c->umount_mutex);
1638 }
1639
1640 static void ubifs_put_super(struct super_block *sb)
1641 {
1642         int i;
1643         struct ubifs_info *c = sb->s_fs_info;
1644
1645         ubifs_msg("un-mount UBI device %d, volume %d", c->vi.ubi_num,
1646                   c->vi.vol_id);
1647         /*
1648          * The following asserts are only valid if there has not been a failure
1649          * of the media. For example, there will be dirty inodes if we failed
1650          * to write them back because of I/O errors.
1651          */
1652         ubifs_assert(atomic_long_read(&c->dirty_pg_cnt) == 0);
1653         ubifs_assert(c->budg_idx_growth == 0);
1654         ubifs_assert(c->budg_dd_growth == 0);
1655         ubifs_assert(c->budg_data_growth == 0);
1656
1657         /*
1658          * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1659          * and file system un-mount. Namely, it prevents the shrinker from
1660          * picking this superblock for shrinking - it will be just skipped if
1661          * the mutex is locked.
1662          */
1663         mutex_lock(&c->umount_mutex);
1664         if (!(c->vfs_sb->s_flags & MS_RDONLY)) {
1665                 /*
1666                  * First of all kill the background thread to make sure it does
1667                  * not interfere with un-mounting and freeing resources.
1668                  */
1669                 if (c->bgt) {
1670                         kthread_stop(c->bgt);
1671                         c->bgt = NULL;
1672                 }
1673
1674                 /* Synchronize write-buffers */
1675                 if (c->jheads)
1676                         for (i = 0; i < c->jhead_cnt; i++) {
1677                                 ubifs_wbuf_sync(&c->jheads[i].wbuf);
1678                                 del_timer_sync(&c->jheads[i].wbuf.timer);
1679                         }
1680
1681                 /*
1682                  * On fatal errors c->ro_media is set to 1, in which case we do
1683                  * not write the master node.
1684                  */
1685                 if (!c->ro_media) {
1686                         /*
1687                          * We are being cleanly unmounted which means the
1688                          * orphans were killed - indicate this in the master
1689                          * node. Also save the reserved GC LEB number.
1690                          */
1691                         int err;
1692
1693                         c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1694                         c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1695                         c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1696                         err = ubifs_write_master(c);
1697                         if (err)
1698                                 /*
1699                                  * Recovery will attempt to fix the master area
1700                                  * next mount, so we just print a message and
1701                                  * continue to unmount normally.
1702                                  */
1703                                 ubifs_err("failed to write master node, "
1704                                           "error %d", err);
1705                 }
1706         }
1707
1708         ubifs_umount(c);
1709         bdi_destroy(&c->bdi);
1710         ubi_close_volume(c->ubi);
1711         mutex_unlock(&c->umount_mutex);
1712         kfree(c);
1713 }
1714
1715 static int ubifs_remount_fs(struct super_block *sb, int *flags, char *data)
1716 {
1717         int err;
1718         struct ubifs_info *c = sb->s_fs_info;
1719
1720         dbg_gen("old flags %#lx, new flags %#x", sb->s_flags, *flags);
1721
1722         err = ubifs_parse_options(c, data, 1);
1723         if (err) {
1724                 ubifs_err("invalid or unknown remount parameter");
1725                 return err;
1726         }
1727
1728         if ((sb->s_flags & MS_RDONLY) && !(*flags & MS_RDONLY)) {
1729                 err = ubifs_remount_rw(c);
1730                 if (err)
1731                         return err;
1732         } else if (!(sb->s_flags & MS_RDONLY) && (*flags & MS_RDONLY))
1733                 ubifs_remount_ro(c);
1734
1735         if (c->bulk_read == 1)
1736                 bu_init(c);
1737         else {
1738                 dbg_gen("disable bulk-read");
1739                 kfree(c->bu.buf);
1740                 c->bu.buf = NULL;
1741         }
1742
1743         return 0;
1744 }
1745
1746 struct super_operations ubifs_super_operations = {
1747         .alloc_inode   = ubifs_alloc_inode,
1748         .destroy_inode = ubifs_destroy_inode,
1749         .put_super     = ubifs_put_super,
1750         .write_inode   = ubifs_write_inode,
1751         .delete_inode  = ubifs_delete_inode,
1752         .statfs        = ubifs_statfs,
1753         .dirty_inode   = ubifs_dirty_inode,
1754         .remount_fs    = ubifs_remount_fs,
1755         .show_options  = ubifs_show_options,
1756         .sync_fs       = ubifs_sync_fs,
1757 };
1758
1759 /**
1760  * open_ubi - parse UBI device name string and open the UBI device.
1761  * @name: UBI volume name
1762  * @mode: UBI volume open mode
1763  *
1764  * There are several ways to specify UBI volumes when mounting UBIFS:
1765  * o ubiX_Y    - UBI device number X, volume Y;
1766  * o ubiY      - UBI device number 0, volume Y;
1767  * o ubiX:NAME - mount UBI device X, volume with name NAME;
1768  * o ubi:NAME  - mount UBI device 0, volume with name NAME.
1769  *
1770  * Alternative '!' separator may be used instead of ':' (because some shells
1771  * like busybox may interpret ':' as an NFS host name separator). This function
1772  * returns ubi volume object in case of success and a negative error code in
1773  * case of failure.
1774  */
1775 static struct ubi_volume_desc *open_ubi(const char *name, int mode)
1776 {
1777         int dev, vol;
1778         char *endptr;
1779
1780         if (name[0] != 'u' || name[1] != 'b' || name[2] != 'i')
1781                 return ERR_PTR(-EINVAL);
1782
1783         /* ubi:NAME method */
1784         if ((name[3] == ':' || name[3] == '!') && name[4] != '\0')
1785                 return ubi_open_volume_nm(0, name + 4, mode);
1786
1787         if (!isdigit(name[3]))
1788                 return ERR_PTR(-EINVAL);
1789
1790         dev = simple_strtoul(name + 3, &endptr, 0);
1791
1792         /* ubiY method */
1793         if (*endptr == '\0')
1794                 return ubi_open_volume(0, dev, mode);
1795
1796         /* ubiX_Y method */
1797         if (*endptr == '_' && isdigit(endptr[1])) {
1798                 vol = simple_strtoul(endptr + 1, &endptr, 0);
1799                 if (*endptr != '\0')
1800                         return ERR_PTR(-EINVAL);
1801                 return ubi_open_volume(dev, vol, mode);
1802         }
1803
1804         /* ubiX:NAME method */
1805         if ((*endptr == ':' || *endptr == '!') && endptr[1] != '\0')
1806                 return ubi_open_volume_nm(dev, ++endptr, mode);
1807
1808         return ERR_PTR(-EINVAL);
1809 }
1810
1811 static int ubifs_fill_super(struct super_block *sb, void *data, int silent)
1812 {
1813         struct ubi_volume_desc *ubi = sb->s_fs_info;
1814         struct ubifs_info *c;
1815         struct inode *root;
1816         int err;
1817
1818         c = kzalloc(sizeof(struct ubifs_info), GFP_KERNEL);
1819         if (!c)
1820                 return -ENOMEM;
1821
1822         spin_lock_init(&c->cnt_lock);
1823         spin_lock_init(&c->cs_lock);
1824         spin_lock_init(&c->buds_lock);
1825         spin_lock_init(&c->space_lock);
1826         spin_lock_init(&c->orphan_lock);
1827         init_rwsem(&c->commit_sem);
1828         mutex_init(&c->lp_mutex);
1829         mutex_init(&c->tnc_mutex);
1830         mutex_init(&c->log_mutex);
1831         mutex_init(&c->mst_mutex);
1832         mutex_init(&c->umount_mutex);
1833         mutex_init(&c->bu_mutex);
1834         init_waitqueue_head(&c->cmt_wq);
1835         c->buds = RB_ROOT;
1836         c->old_idx = RB_ROOT;
1837         c->size_tree = RB_ROOT;
1838         c->orph_tree = RB_ROOT;
1839         INIT_LIST_HEAD(&c->infos_list);
1840         INIT_LIST_HEAD(&c->idx_gc);
1841         INIT_LIST_HEAD(&c->replay_list);
1842         INIT_LIST_HEAD(&c->replay_buds);
1843         INIT_LIST_HEAD(&c->uncat_list);
1844         INIT_LIST_HEAD(&c->empty_list);
1845         INIT_LIST_HEAD(&c->freeable_list);
1846         INIT_LIST_HEAD(&c->frdi_idx_list);
1847         INIT_LIST_HEAD(&c->unclean_leb_list);
1848         INIT_LIST_HEAD(&c->old_buds);
1849         INIT_LIST_HEAD(&c->orph_list);
1850         INIT_LIST_HEAD(&c->orph_new);
1851
1852         c->highest_inum = UBIFS_FIRST_INO;
1853         c->lhead_lnum = c->ltail_lnum = UBIFS_LOG_LNUM;
1854
1855         ubi_get_volume_info(ubi, &c->vi);
1856         ubi_get_device_info(c->vi.ubi_num, &c->di);
1857
1858         /* Re-open the UBI device in read-write mode */
1859         c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READWRITE);
1860         if (IS_ERR(c->ubi)) {
1861                 err = PTR_ERR(c->ubi);
1862                 goto out_free;
1863         }
1864
1865         /*
1866          * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
1867          * UBIFS, I/O is not deferred, it is done immediately in readpage,
1868          * which means the user would have to wait not just for their own I/O
1869          * but the read-ahead I/O as well i.e. completely pointless.
1870          *
1871          * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
1872          */
1873         c->bdi.capabilities = BDI_CAP_MAP_COPY;
1874         c->bdi.unplug_io_fn = default_unplug_io_fn;
1875         err  = bdi_init(&c->bdi);
1876         if (err)
1877                 goto out_close;
1878
1879         err = ubifs_parse_options(c, data, 0);
1880         if (err)
1881                 goto out_bdi;
1882
1883         c->vfs_sb = sb;
1884
1885         sb->s_fs_info = c;
1886         sb->s_magic = UBIFS_SUPER_MAGIC;
1887         sb->s_blocksize = UBIFS_BLOCK_SIZE;
1888         sb->s_blocksize_bits = UBIFS_BLOCK_SHIFT;
1889         sb->s_dev = c->vi.cdev;
1890         sb->s_maxbytes = c->max_inode_sz = key_max_inode_size(c);
1891         if (c->max_inode_sz > MAX_LFS_FILESIZE)
1892                 sb->s_maxbytes = c->max_inode_sz = MAX_LFS_FILESIZE;
1893         sb->s_op = &ubifs_super_operations;
1894
1895         mutex_lock(&c->umount_mutex);
1896         err = mount_ubifs(c);
1897         if (err) {
1898                 ubifs_assert(err < 0);
1899                 goto out_unlock;
1900         }
1901
1902         /* Read the root inode */
1903         root = ubifs_iget(sb, UBIFS_ROOT_INO);
1904         if (IS_ERR(root)) {
1905                 err = PTR_ERR(root);
1906                 goto out_umount;
1907         }
1908
1909         sb->s_root = d_alloc_root(root);
1910         if (!sb->s_root)
1911                 goto out_iput;
1912
1913         mutex_unlock(&c->umount_mutex);
1914         return 0;
1915
1916 out_iput:
1917         iput(root);
1918 out_umount:
1919         ubifs_umount(c);
1920 out_unlock:
1921         mutex_unlock(&c->umount_mutex);
1922 out_bdi:
1923         bdi_destroy(&c->bdi);
1924 out_close:
1925         ubi_close_volume(c->ubi);
1926 out_free:
1927         kfree(c);
1928         return err;
1929 }
1930
1931 static int sb_test(struct super_block *sb, void *data)
1932 {
1933         dev_t *dev = data;
1934
1935         return sb->s_dev == *dev;
1936 }
1937
1938 static int sb_set(struct super_block *sb, void *data)
1939 {
1940         dev_t *dev = data;
1941
1942         sb->s_dev = *dev;
1943         return 0;
1944 }
1945
1946 static int ubifs_get_sb(struct file_system_type *fs_type, int flags,
1947                         const char *name, void *data, struct vfsmount *mnt)
1948 {
1949         struct ubi_volume_desc *ubi;
1950         struct ubi_volume_info vi;
1951         struct super_block *sb;
1952         int err;
1953
1954         dbg_gen("name %s, flags %#x", name, flags);
1955
1956         /*
1957          * Get UBI device number and volume ID. Mount it read-only so far
1958          * because this might be a new mount point, and UBI allows only one
1959          * read-write user at a time.
1960          */
1961         ubi = open_ubi(name, UBI_READONLY);
1962         if (IS_ERR(ubi)) {
1963                 ubifs_err("cannot open \"%s\", error %d",
1964                           name, (int)PTR_ERR(ubi));
1965                 return PTR_ERR(ubi);
1966         }
1967         ubi_get_volume_info(ubi, &vi);
1968
1969         dbg_gen("opened ubi%d_%d", vi.ubi_num, vi.vol_id);
1970
1971         sb = sget(fs_type, &sb_test, &sb_set, &vi.cdev);
1972         if (IS_ERR(sb)) {
1973                 err = PTR_ERR(sb);
1974                 goto out_close;
1975         }
1976
1977         if (sb->s_root) {
1978                 /* A new mount point for already mounted UBIFS */
1979                 dbg_gen("this ubi volume is already mounted");
1980                 if ((flags ^ sb->s_flags) & MS_RDONLY) {
1981                         err = -EBUSY;
1982                         goto out_deact;
1983                 }
1984         } else {
1985                 sb->s_flags = flags;
1986                 /*
1987                  * Pass 'ubi' to 'fill_super()' in sb->s_fs_info where it is
1988                  * replaced by 'c'.
1989                  */
1990                 sb->s_fs_info = ubi;
1991                 err = ubifs_fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
1992                 if (err)
1993                         goto out_deact;
1994                 /* We do not support atime */
1995                 sb->s_flags |= MS_ACTIVE | MS_NOATIME;
1996         }
1997
1998         /* 'fill_super()' opens ubi again so we must close it here */
1999         ubi_close_volume(ubi);
2000
2001         return simple_set_mnt(mnt, sb);
2002
2003 out_deact:
2004         up_write(&sb->s_umount);
2005         deactivate_super(sb);
2006 out_close:
2007         ubi_close_volume(ubi);
2008         return err;
2009 }
2010
2011 static void ubifs_kill_sb(struct super_block *sb)
2012 {
2013         struct ubifs_info *c = sb->s_fs_info;
2014
2015         /*
2016          * We do 'commit_on_unmount()' here instead of 'ubifs_put_super()'
2017          * in order to be outside BKL.
2018          */
2019         if (sb->s_root && !(sb->s_flags & MS_RDONLY))
2020                 commit_on_unmount(c);
2021         /* The un-mount routine is actually done in put_super() */
2022         generic_shutdown_super(sb);
2023 }
2024
2025 static struct file_system_type ubifs_fs_type = {
2026         .name    = "ubifs",
2027         .owner   = THIS_MODULE,
2028         .get_sb  = ubifs_get_sb,
2029         .kill_sb = ubifs_kill_sb
2030 };
2031
2032 /*
2033  * Inode slab cache constructor.
2034  */
2035 static void inode_slab_ctor(void *obj)
2036 {
2037         struct ubifs_inode *ui = obj;
2038         inode_init_once(&ui->vfs_inode);
2039 }
2040
2041 static int __init ubifs_init(void)
2042 {
2043         int err;
2044
2045         BUILD_BUG_ON(sizeof(struct ubifs_ch) != 24);
2046
2047         /* Make sure node sizes are 8-byte aligned */
2048         BUILD_BUG_ON(UBIFS_CH_SZ        & 7);
2049         BUILD_BUG_ON(UBIFS_INO_NODE_SZ  & 7);
2050         BUILD_BUG_ON(UBIFS_DENT_NODE_SZ & 7);
2051         BUILD_BUG_ON(UBIFS_XENT_NODE_SZ & 7);
2052         BUILD_BUG_ON(UBIFS_DATA_NODE_SZ & 7);
2053         BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ & 7);
2054         BUILD_BUG_ON(UBIFS_SB_NODE_SZ   & 7);
2055         BUILD_BUG_ON(UBIFS_MST_NODE_SZ  & 7);
2056         BUILD_BUG_ON(UBIFS_REF_NODE_SZ  & 7);
2057         BUILD_BUG_ON(UBIFS_CS_NODE_SZ   & 7);
2058         BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ & 7);
2059
2060         BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ & 7);
2061         BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ & 7);
2062         BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ & 7);
2063         BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ  & 7);
2064         BUILD_BUG_ON(UBIFS_MAX_NODE_SZ      & 7);
2065         BUILD_BUG_ON(MIN_WRITE_SZ           & 7);
2066
2067         /* Check min. node size */
2068         BUILD_BUG_ON(UBIFS_INO_NODE_SZ  < MIN_WRITE_SZ);
2069         BUILD_BUG_ON(UBIFS_DENT_NODE_SZ < MIN_WRITE_SZ);
2070         BUILD_BUG_ON(UBIFS_XENT_NODE_SZ < MIN_WRITE_SZ);
2071         BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ < MIN_WRITE_SZ);
2072
2073         BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2074         BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2075         BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ > UBIFS_MAX_NODE_SZ);
2076         BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ  > UBIFS_MAX_NODE_SZ);
2077
2078         /* Defined node sizes */
2079         BUILD_BUG_ON(UBIFS_SB_NODE_SZ  != 4096);
2080         BUILD_BUG_ON(UBIFS_MST_NODE_SZ != 512);
2081         BUILD_BUG_ON(UBIFS_INO_NODE_SZ != 160);
2082         BUILD_BUG_ON(UBIFS_REF_NODE_SZ != 64);
2083
2084         /*
2085          * We use 2 bit wide bit-fields to store compression type, which should
2086          * be amended if more compressors are added. The bit-fields are:
2087          * @compr_type in 'struct ubifs_inode', @default_compr in
2088          * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
2089          */
2090         BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT > 4);
2091
2092         /*
2093          * We require that PAGE_CACHE_SIZE is greater-than-or-equal-to
2094          * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2095          */
2096         if (PAGE_CACHE_SIZE < UBIFS_BLOCK_SIZE) {
2097                 ubifs_err("VFS page cache size is %u bytes, but UBIFS requires"
2098                           " at least 4096 bytes",
2099                           (unsigned int)PAGE_CACHE_SIZE);
2100                 return -EINVAL;
2101         }
2102
2103         err = register_filesystem(&ubifs_fs_type);
2104         if (err) {
2105                 ubifs_err("cannot register file system, error %d", err);
2106                 return err;
2107         }
2108
2109         err = -ENOMEM;
2110         ubifs_inode_slab = kmem_cache_create("ubifs_inode_slab",
2111                                 sizeof(struct ubifs_inode), 0,
2112                                 SLAB_MEM_SPREAD | SLAB_RECLAIM_ACCOUNT,
2113                                 &inode_slab_ctor);
2114         if (!ubifs_inode_slab)
2115                 goto out_reg;
2116
2117         register_shrinker(&ubifs_shrinker_info);
2118
2119         err = ubifs_compressors_init();
2120         if (err)
2121                 goto out_shrinker;
2122
2123         err = dbg_debugfs_init();
2124         if (err)
2125                 goto out_compr;
2126
2127         return 0;
2128
2129 out_compr:
2130         ubifs_compressors_exit();
2131 out_shrinker:
2132         unregister_shrinker(&ubifs_shrinker_info);
2133         kmem_cache_destroy(ubifs_inode_slab);
2134 out_reg:
2135         unregister_filesystem(&ubifs_fs_type);
2136         return err;
2137 }
2138 /* late_initcall to let compressors initialize first */
2139 late_initcall(ubifs_init);
2140
2141 static void __exit ubifs_exit(void)
2142 {
2143         ubifs_assert(list_empty(&ubifs_infos));
2144         ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt) == 0);
2145
2146         dbg_debugfs_exit();
2147         ubifs_compressors_exit();
2148         unregister_shrinker(&ubifs_shrinker_info);
2149         kmem_cache_destroy(ubifs_inode_slab);
2150         unregister_filesystem(&ubifs_fs_type);
2151 }
2152 module_exit(ubifs_exit);
2153
2154 MODULE_LICENSE("GPL");
2155 MODULE_VERSION(__stringify(UBIFS_VERSION));
2156 MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2157 MODULE_DESCRIPTION("UBIFS - UBI File System");