blob: b5aeb5a8ebed11f0448c8ff8ed20db57b5178a69 [file] [log] [blame]
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001/*
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>
Artem Bityutskiy1e517642008-07-14 19:08:37 +030033#include <linux/kthread.h>
34#include <linux/parser.h>
35#include <linux/seq_file.h>
36#include <linux/mount.h>
Artem Bityutskiy4d61db42008-12-18 14:06:51 +020037#include <linux/math64.h>
Artem Bityutskiy304d4272008-12-28 08:04:17 +020038#include <linux/writeback.h>
Artem Bityutskiy1e517642008-07-14 19:08:37 +030039#include "ubifs.h"
40
Artem Bityutskiy39ce81c2008-11-18 18:09:49 +020041/*
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
Artem Bityutskiy1e517642008-07-14 19:08:37 +030047/* Slab cache for UBIFS inodes */
48struct kmem_cache *ubifs_inode_slab;
49
50/* UBIFS TNC shrinker description */
51static 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 */
66static 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
101struct 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
Artem Bityutskiy0a883a02008-08-13 14:13:26 +0300159 /* Disable read-ahead */
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300160 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
247out_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;
252out_ino:
253 kfree(ino);
254out:
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
260static 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
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100275static void ubifs_i_callback(struct rcu_head *head)
276{
277 struct inode *inode = container_of(head, struct inode, i_rcu);
278 struct ubifs_inode *ui = ubifs_inode(inode);
279 INIT_LIST_HEAD(&inode->i_dentry);
280 kmem_cache_free(ubifs_inode_slab, ui);
281}
282
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300283static void ubifs_destroy_inode(struct inode *inode)
284{
285 struct ubifs_inode *ui = ubifs_inode(inode);
286
287 kfree(ui->data);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100288 call_rcu(&inode->i_rcu, ubifs_i_callback);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300289}
290
291/*
292 * Note, Linux write-back code calls this without 'i_mutex'.
293 */
Christoph Hellwiga9185b42010-03-05 09:21:37 +0100294static int ubifs_write_inode(struct inode *inode, struct writeback_control *wbc)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300295{
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300296 int err = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300297 struct ubifs_info *c = inode->i_sb->s_fs_info;
298 struct ubifs_inode *ui = ubifs_inode(inode);
299
300 ubifs_assert(!ui->xattr);
301 if (is_bad_inode(inode))
302 return 0;
303
304 mutex_lock(&ui->ui_mutex);
305 /*
306 * Due to races between write-back forced by budgeting
307 * (see 'sync_some_inodes()') and pdflush write-back, the inode may
308 * have already been synchronized, do not do this again. This might
309 * also happen if it was synchronized in an VFS operation, e.g.
310 * 'ubifs_link()'.
311 */
312 if (!ui->dirty) {
313 mutex_unlock(&ui->ui_mutex);
314 return 0;
315 }
316
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300317 /*
318 * As an optimization, do not write orphan inodes to the media just
319 * because this is not needed.
320 */
321 dbg_gen("inode %lu, mode %#x, nlink %u",
322 inode->i_ino, (int)inode->i_mode, inode->i_nlink);
323 if (inode->i_nlink) {
Artem Bityutskiy1f286812008-07-22 12:06:13 +0300324 err = ubifs_jnl_write_inode(c, inode);
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300325 if (err)
326 ubifs_err("can't write inode %lu, error %d",
327 inode->i_ino, err);
Artem Bityutskiye3c3efc2009-08-27 16:34:19 +0300328 else
329 err = dbg_check_inode_size(c, inode, ui->ui_size);
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300330 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300331
332 ui->dirty = 0;
333 mutex_unlock(&ui->ui_mutex);
334 ubifs_release_dirty_inode_budget(c, ui);
335 return err;
336}
337
Al Virod640e1b2010-06-07 00:34:05 -0400338static void ubifs_evict_inode(struct inode *inode)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300339{
340 int err;
341 struct ubifs_info *c = inode->i_sb->s_fs_info;
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300342 struct ubifs_inode *ui = ubifs_inode(inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300343
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300344 if (ui->xattr)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300345 /*
346 * Extended attribute inode deletions are fully handled in
347 * 'ubifs_removexattr()'. These inodes are special and have
348 * limited usage, so there is nothing to do here.
349 */
350 goto out;
351
Artem Bityutskiy7d32c2b2008-07-18 18:54:29 +0300352 dbg_gen("inode %lu, mode %#x", inode->i_ino, (int)inode->i_mode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300353 ubifs_assert(!atomic_read(&inode->i_count));
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300354
355 truncate_inode_pages(&inode->i_data, 0);
Al Virod640e1b2010-06-07 00:34:05 -0400356
357 if (inode->i_nlink)
358 goto done;
359
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300360 if (is_bad_inode(inode))
361 goto out;
362
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300363 ui->ui_size = inode->i_size = 0;
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300364 err = ubifs_jnl_delete_inode(c, inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300365 if (err)
366 /*
367 * Worst case we have a lost orphan inode wasting space, so a
Artem Bityutskiy0a883a02008-08-13 14:13:26 +0300368 * simple error message is OK here.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300369 */
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300370 ubifs_err("can't delete inode %lu, error %d",
371 inode->i_ino, err);
372
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300373out:
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300374 if (ui->dirty)
375 ubifs_release_dirty_inode_budget(c, ui);
Adrian Hunter6d6cb0d2009-04-08 14:07:57 +0200376 else {
377 /* We've deleted something - clean the "no space" flags */
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300378 c->bi.nospace = c->bi.nospace_rp = 0;
Adrian Hunter6d6cb0d2009-04-08 14:07:57 +0200379 smp_wmb();
380 }
Al Virod640e1b2010-06-07 00:34:05 -0400381done:
382 end_writeback(inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300383}
384
Christoph Hellwigaa385722011-05-27 06:53:02 -0400385static void ubifs_dirty_inode(struct inode *inode, int flags)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300386{
387 struct ubifs_inode *ui = ubifs_inode(inode);
388
389 ubifs_assert(mutex_is_locked(&ui->ui_mutex));
390 if (!ui->dirty) {
391 ui->dirty = 1;
392 dbg_gen("inode %lu", inode->i_ino);
393 }
394}
395
396static int ubifs_statfs(struct dentry *dentry, struct kstatfs *buf)
397{
398 struct ubifs_info *c = dentry->d_sb->s_fs_info;
399 unsigned long long free;
Artem Bityutskiy7c7cbad2008-09-03 14:16:42 +0300400 __le32 *uuid = (__le32 *)c->uuid;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300401
Artem Bityutskiy7dad1812008-08-25 18:58:19 +0300402 free = ubifs_get_free_space(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300403 dbg_gen("free space %lld bytes (%lld blocks)",
404 free, free >> UBIFS_BLOCK_SHIFT);
405
406 buf->f_type = UBIFS_SUPER_MAGIC;
407 buf->f_bsize = UBIFS_BLOCK_SIZE;
408 buf->f_blocks = c->block_cnt;
409 buf->f_bfree = free >> UBIFS_BLOCK_SHIFT;
410 if (free > c->report_rp_size)
411 buf->f_bavail = (free - c->report_rp_size) >> UBIFS_BLOCK_SHIFT;
412 else
413 buf->f_bavail = 0;
414 buf->f_files = 0;
415 buf->f_ffree = 0;
416 buf->f_namelen = UBIFS_MAX_NLEN;
Artem Bityutskiy7c7cbad2008-09-03 14:16:42 +0300417 buf->f_fsid.val[0] = le32_to_cpu(uuid[0]) ^ le32_to_cpu(uuid[2]);
418 buf->f_fsid.val[1] = le32_to_cpu(uuid[1]) ^ le32_to_cpu(uuid[3]);
Artem Bityutskiyb4978e92009-01-23 18:23:03 +0200419 ubifs_assert(buf->f_bfree <= c->block_cnt);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300420 return 0;
421}
422
423static int ubifs_show_options(struct seq_file *s, struct vfsmount *mnt)
424{
425 struct ubifs_info *c = mnt->mnt_sb->s_fs_info;
426
427 if (c->mount_opts.unmount_mode == 2)
428 seq_printf(s, ",fast_unmount");
429 else if (c->mount_opts.unmount_mode == 1)
430 seq_printf(s, ",norm_unmount");
431
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300432 if (c->mount_opts.bulk_read == 2)
433 seq_printf(s, ",bulk_read");
434 else if (c->mount_opts.bulk_read == 1)
435 seq_printf(s, ",no_bulk_read");
436
Adrian Hunter2953e732008-09-04 16:26:00 +0300437 if (c->mount_opts.chk_data_crc == 2)
438 seq_printf(s, ",chk_data_crc");
439 else if (c->mount_opts.chk_data_crc == 1)
440 seq_printf(s, ",no_chk_data_crc");
441
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200442 if (c->mount_opts.override_compr) {
Hunter Adrianfcabb342009-03-18 12:29:39 +0100443 seq_printf(s, ",compr=%s",
444 ubifs_compr_name(c->mount_opts.compr_type));
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200445 }
446
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300447 return 0;
448}
449
450static int ubifs_sync_fs(struct super_block *sb, int wait)
451{
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200452 int i, err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300453 struct ubifs_info *c = sb->s_fs_info;
Artem Bityutskiy304d4272008-12-28 08:04:17 +0200454
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800455 /*
Artem Bityutskiydedb0d42009-01-09 21:02:37 +0200456 * Zero @wait is just an advisory thing to help the file system shove
457 * lots of data into the queues, and there will be the second
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800458 * '->sync_fs()' call, with non-zero @wait.
459 */
Artem Bityutskiydedb0d42009-01-09 21:02:37 +0200460 if (!wait)
461 return 0;
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800462
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200463 /*
Adrian Hunter3eb14292009-01-29 11:17:24 +0200464 * Synchronize write buffers, because 'ubifs_run_commit()' does not
465 * do this if it waits for an already running commit.
466 */
467 for (i = 0; i < c->jhead_cnt; i++) {
468 err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
469 if (err)
470 return err;
471 }
472
Artem Bityutskiy887ee172009-07-20 17:56:19 +0300473 /*
474 * Strictly speaking, it is not necessary to commit the journal here,
475 * synchronizing write-buffers would be enough. But committing makes
476 * UBIFS free space predictions much more accurate, so we want to let
477 * the user be able to get more accurate results of 'statfs()' after
478 * they synchronize the file system.
479 */
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200480 err = ubifs_run_commit(c);
481 if (err)
482 return err;
Artem Bityutskiy403e12a2008-09-09 12:31:37 +0300483
Artem Bityutskiycb5c6a22008-12-28 08:18:43 +0200484 return ubi_sync(c->vi.ubi_num);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300485}
486
487/**
488 * init_constants_early - initialize UBIFS constants.
489 * @c: UBIFS file-system description object
490 *
491 * This function initialize UBIFS constants which do not need the superblock to
492 * be read. It also checks that the UBI volume satisfies basic UBIFS
493 * requirements. Returns zero in case of success and a negative error code in
494 * case of failure.
495 */
496static int init_constants_early(struct ubifs_info *c)
497{
498 if (c->vi.corrupted) {
499 ubifs_warn("UBI volume is corrupted - read-only mode");
500 c->ro_media = 1;
501 }
502
503 if (c->di.ro_mode) {
504 ubifs_msg("read-only UBI device");
505 c->ro_media = 1;
506 }
507
508 if (c->vi.vol_type == UBI_STATIC_VOLUME) {
509 ubifs_msg("static UBI volume - read-only mode");
510 c->ro_media = 1;
511 }
512
513 c->leb_cnt = c->vi.size;
514 c->leb_size = c->vi.usable_leb_size;
Artem Bityutskiyca2ec612011-02-14 15:17:55 +0200515 c->leb_start = c->di.leb_start;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300516 c->half_leb_size = c->leb_size / 2;
517 c->min_io_size = c->di.min_io_size;
518 c->min_io_shift = fls(c->min_io_size) - 1;
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200519 c->max_write_size = c->di.max_write_size;
520 c->max_write_shift = fls(c->max_write_size) - 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300521
522 if (c->leb_size < UBIFS_MIN_LEB_SZ) {
523 ubifs_err("too small LEBs (%d bytes), min. is %d bytes",
524 c->leb_size, UBIFS_MIN_LEB_SZ);
525 return -EINVAL;
526 }
527
528 if (c->leb_cnt < UBIFS_MIN_LEB_CNT) {
529 ubifs_err("too few LEBs (%d), min. is %d",
530 c->leb_cnt, UBIFS_MIN_LEB_CNT);
531 return -EINVAL;
532 }
533
534 if (!is_power_of_2(c->min_io_size)) {
535 ubifs_err("bad min. I/O size %d", c->min_io_size);
536 return -EINVAL;
537 }
538
539 /*
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200540 * Maximum write size has to be greater or equivalent to min. I/O
541 * size, and be multiple of min. I/O size.
542 */
543 if (c->max_write_size < c->min_io_size ||
544 c->max_write_size % c->min_io_size ||
545 !is_power_of_2(c->max_write_size)) {
546 ubifs_err("bad write buffer size %d for %d min. I/O unit",
547 c->max_write_size, c->min_io_size);
548 return -EINVAL;
549 }
550
551 /*
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300552 * UBIFS aligns all node to 8-byte boundary, so to make function in
553 * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
554 * less than 8.
555 */
556 if (c->min_io_size < 8) {
557 c->min_io_size = 8;
558 c->min_io_shift = 3;
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200559 if (c->max_write_size < c->min_io_size) {
560 c->max_write_size = c->min_io_size;
561 c->max_write_shift = c->min_io_shift;
562 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300563 }
564
565 c->ref_node_alsz = ALIGN(UBIFS_REF_NODE_SZ, c->min_io_size);
566 c->mst_node_alsz = ALIGN(UBIFS_MST_NODE_SZ, c->min_io_size);
567
568 /*
569 * Initialize node length ranges which are mostly needed for node
570 * length validation.
571 */
572 c->ranges[UBIFS_PAD_NODE].len = UBIFS_PAD_NODE_SZ;
573 c->ranges[UBIFS_SB_NODE].len = UBIFS_SB_NODE_SZ;
574 c->ranges[UBIFS_MST_NODE].len = UBIFS_MST_NODE_SZ;
575 c->ranges[UBIFS_REF_NODE].len = UBIFS_REF_NODE_SZ;
576 c->ranges[UBIFS_TRUN_NODE].len = UBIFS_TRUN_NODE_SZ;
577 c->ranges[UBIFS_CS_NODE].len = UBIFS_CS_NODE_SZ;
578
579 c->ranges[UBIFS_INO_NODE].min_len = UBIFS_INO_NODE_SZ;
580 c->ranges[UBIFS_INO_NODE].max_len = UBIFS_MAX_INO_NODE_SZ;
581 c->ranges[UBIFS_ORPH_NODE].min_len =
582 UBIFS_ORPH_NODE_SZ + sizeof(__le64);
583 c->ranges[UBIFS_ORPH_NODE].max_len = c->leb_size;
584 c->ranges[UBIFS_DENT_NODE].min_len = UBIFS_DENT_NODE_SZ;
585 c->ranges[UBIFS_DENT_NODE].max_len = UBIFS_MAX_DENT_NODE_SZ;
586 c->ranges[UBIFS_XENT_NODE].min_len = UBIFS_XENT_NODE_SZ;
587 c->ranges[UBIFS_XENT_NODE].max_len = UBIFS_MAX_XENT_NODE_SZ;
588 c->ranges[UBIFS_DATA_NODE].min_len = UBIFS_DATA_NODE_SZ;
589 c->ranges[UBIFS_DATA_NODE].max_len = UBIFS_MAX_DATA_NODE_SZ;
590 /*
591 * Minimum indexing node size is amended later when superblock is
592 * read and the key length is known.
593 */
594 c->ranges[UBIFS_IDX_NODE].min_len = UBIFS_IDX_NODE_SZ + UBIFS_BRANCH_SZ;
595 /*
596 * Maximum indexing node size is amended later when superblock is
597 * read and the fanout is known.
598 */
599 c->ranges[UBIFS_IDX_NODE].max_len = INT_MAX;
600
601 /*
Artem Bityutskiy70782022009-01-19 19:57:27 +0200602 * Initialize dead and dark LEB space watermarks. See gc.c for comments
603 * about these values.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300604 */
605 c->dead_wm = ALIGN(MIN_WRITE_SZ, c->min_io_size);
606 c->dark_wm = ALIGN(UBIFS_MAX_NODE_SZ, c->min_io_size);
607
Artem Bityutskiy9bbb5722008-08-22 18:23:22 +0300608 /*
609 * Calculate how many bytes would be wasted at the end of LEB if it was
610 * fully filled with data nodes of maximum size. This is used in
611 * calculations when reporting free space.
612 */
613 c->leb_overhead = c->leb_size % UBIFS_MAX_DATA_NODE_SZ;
Artem Bityutskiy39ce81c2008-11-18 18:09:49 +0200614
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300615 /* Buffer size for bulk-reads */
Artem Bityutskiy6c0c42c2008-11-18 20:20:05 +0200616 c->max_bu_buf_len = UBIFS_MAX_BULK_READ * UBIFS_MAX_DATA_NODE_SZ;
617 if (c->max_bu_buf_len > c->leb_size)
618 c->max_bu_buf_len = c->leb_size;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300619 return 0;
620}
621
622/**
623 * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
624 * @c: UBIFS file-system description object
625 * @lnum: LEB the write-buffer was synchronized to
626 * @free: how many free bytes left in this LEB
627 * @pad: how many bytes were padded
628 *
629 * This is a callback function which is called by the I/O unit when the
630 * write-buffer is synchronized. We need this to correctly maintain space
631 * accounting in bud logical eraseblocks. This function returns zero in case of
632 * success and a negative error code in case of failure.
633 *
634 * This function actually belongs to the journal, but we keep it here because
635 * we want to keep it static.
636 */
637static int bud_wbuf_callback(struct ubifs_info *c, int lnum, int free, int pad)
638{
639 return ubifs_update_one_lp(c, lnum, free, pad, 0, 0);
640}
641
642/*
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200643 * init_constants_sb - initialize UBIFS constants.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300644 * @c: UBIFS file-system description object
645 *
646 * This is a helper function which initializes various UBIFS constants after
647 * the superblock has been read. It also checks various UBIFS parameters and
648 * makes sure they are all right. Returns zero in case of success and a
649 * negative error code in case of failure.
650 */
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200651static int init_constants_sb(struct ubifs_info *c)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300652{
653 int tmp, err;
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200654 long long tmp64;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300655
656 c->main_bytes = (long long)c->main_lebs * c->leb_size;
657 c->max_znode_sz = sizeof(struct ubifs_znode) +
658 c->fanout * sizeof(struct ubifs_zbranch);
659
660 tmp = ubifs_idx_node_sz(c, 1);
661 c->ranges[UBIFS_IDX_NODE].min_len = tmp;
662 c->min_idx_node_sz = ALIGN(tmp, 8);
663
664 tmp = ubifs_idx_node_sz(c, c->fanout);
665 c->ranges[UBIFS_IDX_NODE].max_len = tmp;
666 c->max_idx_node_sz = ALIGN(tmp, 8);
667
668 /* Make sure LEB size is large enough to fit full commit */
669 tmp = UBIFS_CS_NODE_SZ + UBIFS_REF_NODE_SZ * c->jhead_cnt;
670 tmp = ALIGN(tmp, c->min_io_size);
671 if (tmp > c->leb_size) {
672 dbg_err("too small LEB size %d, at least %d needed",
673 c->leb_size, tmp);
674 return -EINVAL;
675 }
676
677 /*
678 * Make sure that the log is large enough to fit reference nodes for
679 * all buds plus one reserved LEB.
680 */
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200681 tmp64 = c->max_bud_bytes + c->leb_size - 1;
682 c->max_bud_cnt = div_u64(tmp64, c->leb_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300683 tmp = (c->ref_node_alsz * c->max_bud_cnt + c->leb_size - 1);
684 tmp /= c->leb_size;
685 tmp += 1;
686 if (c->log_lebs < tmp) {
687 dbg_err("too small log %d LEBs, required min. %d LEBs",
688 c->log_lebs, tmp);
689 return -EINVAL;
690 }
691
692 /*
693 * When budgeting we assume worst-case scenarios when the pages are not
694 * be compressed and direntries are of the maximum size.
695 *
696 * Note, data, which may be stored in inodes is budgeted separately, so
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300697 * it is not included into 'c->bi.inode_budget'.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300698 */
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300699 c->bi.page_budget = UBIFS_MAX_DATA_NODE_SZ * UBIFS_BLOCKS_PER_PAGE;
700 c->bi.inode_budget = UBIFS_INO_NODE_SZ;
701 c->bi.dent_budget = UBIFS_MAX_DENT_NODE_SZ;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300702
703 /*
704 * When the amount of flash space used by buds becomes
705 * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
706 * The writers are unblocked when the commit is finished. To avoid
707 * writers to be blocked UBIFS initiates background commit in advance,
708 * when number of bud bytes becomes above the limit defined below.
709 */
710 c->bg_bud_bytes = (c->max_bud_bytes * 13) >> 4;
711
712 /*
713 * Ensure minimum journal size. All the bytes in the journal heads are
714 * considered to be used, when calculating the current journal usage.
715 * Consequently, if the journal is too small, UBIFS will treat it as
716 * always full.
717 */
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200718 tmp64 = (long long)(c->jhead_cnt + 1) * c->leb_size + 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300719 if (c->bg_bud_bytes < tmp64)
720 c->bg_bud_bytes = tmp64;
721 if (c->max_bud_bytes < tmp64 + c->leb_size)
722 c->max_bud_bytes = tmp64 + c->leb_size;
723
724 err = ubifs_calc_lpt_geom(c);
725 if (err)
726 return err;
727
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +0200728 /* Initialize effective LEB size used in budgeting calculations */
729 c->idx_leb_size = c->leb_size - c->max_idx_node_sz;
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200730 return 0;
731}
732
733/*
734 * init_constants_master - initialize UBIFS constants.
735 * @c: UBIFS file-system description object
736 *
737 * This is a helper function which initializes various UBIFS constants after
738 * the master node has been read. It also checks various UBIFS parameters and
739 * makes sure they are all right.
740 */
741static void init_constants_master(struct ubifs_info *c)
742{
743 long long tmp64;
744
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300745 c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +0200746 c->report_rp_size = ubifs_reported_space(c, c->rp_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300747
748 /*
749 * Calculate total amount of FS blocks. This number is not used
750 * internally because it does not make much sense for UBIFS, but it is
751 * necessary to report something for the 'statfs()' call.
752 *
Artem Bityutskiy7dad1812008-08-25 18:58:19 +0300753 * Subtract the LEB reserved for GC, the LEB which is reserved for
Artem Bityutskiyaf14a1a2008-12-19 19:26:29 +0200754 * deletions, minimum LEBs for the index, and assume only one journal
755 * head is available.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300756 */
Artem Bityutskiyaf14a1a2008-12-19 19:26:29 +0200757 tmp64 = c->main_lebs - 1 - 1 - MIN_INDEX_LEBS - c->jhead_cnt + 1;
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200758 tmp64 *= (long long)c->leb_size - c->leb_overhead;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300759 tmp64 = ubifs_reported_space(c, tmp64);
760 c->block_cnt = tmp64 >> UBIFS_BLOCK_SHIFT;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300761}
762
763/**
764 * take_gc_lnum - reserve GC LEB.
765 * @c: UBIFS file-system description object
766 *
Artem Bityutskiyb4978e92009-01-23 18:23:03 +0200767 * This function ensures that the LEB reserved for garbage collection is marked
768 * as "taken" in lprops. We also have to set free space to LEB size and dirty
769 * space to zero, because lprops may contain out-of-date information if the
770 * file-system was un-mounted before it has been committed. This function
771 * returns zero in case of success and a negative error code in case of
772 * failure.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300773 */
774static int take_gc_lnum(struct ubifs_info *c)
775{
776 int err;
777
778 if (c->gc_lnum == -1) {
779 ubifs_err("no LEB for GC");
780 return -EINVAL;
781 }
782
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300783 /* And we have to tell lprops that this LEB is taken */
784 err = ubifs_change_one_lp(c, c->gc_lnum, c->leb_size, 0,
785 LPROPS_TAKEN, 0, 0);
786 return err;
787}
788
789/**
790 * alloc_wbufs - allocate write-buffers.
791 * @c: UBIFS file-system description object
792 *
793 * This helper function allocates and initializes UBIFS write-buffers. Returns
794 * zero in case of success and %-ENOMEM in case of failure.
795 */
796static int alloc_wbufs(struct ubifs_info *c)
797{
798 int i, err;
799
800 c->jheads = kzalloc(c->jhead_cnt * sizeof(struct ubifs_jhead),
801 GFP_KERNEL);
802 if (!c->jheads)
803 return -ENOMEM;
804
805 /* Initialize journal heads */
806 for (i = 0; i < c->jhead_cnt; i++) {
807 INIT_LIST_HEAD(&c->jheads[i].buds_list);
808 err = ubifs_wbuf_init(c, &c->jheads[i].wbuf);
809 if (err)
810 return err;
811
812 c->jheads[i].wbuf.sync_callback = &bud_wbuf_callback;
813 c->jheads[i].wbuf.jhead = i;
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300814 c->jheads[i].grouped = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300815 }
816
817 c->jheads[BASEHD].wbuf.dtype = UBI_SHORTTERM;
818 /*
819 * Garbage Collector head likely contains long-term data and
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300820 * does not need to be synchronized by timer. Also GC head nodes are
821 * not grouped.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300822 */
823 c->jheads[GCHD].wbuf.dtype = UBI_LONGTERM;
Artem Bityutskiy0b335b92009-06-23 12:30:43 +0300824 c->jheads[GCHD].wbuf.no_timer = 1;
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300825 c->jheads[GCHD].grouped = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300826
827 return 0;
828}
829
830/**
831 * free_wbufs - free write-buffers.
832 * @c: UBIFS file-system description object
833 */
834static void free_wbufs(struct ubifs_info *c)
835{
836 int i;
837
838 if (c->jheads) {
839 for (i = 0; i < c->jhead_cnt; i++) {
840 kfree(c->jheads[i].wbuf.buf);
841 kfree(c->jheads[i].wbuf.inodes);
842 }
843 kfree(c->jheads);
844 c->jheads = NULL;
845 }
846}
847
848/**
849 * free_orphans - free orphans.
850 * @c: UBIFS file-system description object
851 */
852static void free_orphans(struct ubifs_info *c)
853{
854 struct ubifs_orphan *orph;
855
856 while (c->orph_dnext) {
857 orph = c->orph_dnext;
858 c->orph_dnext = orph->dnext;
859 list_del(&orph->list);
860 kfree(orph);
861 }
862
863 while (!list_empty(&c->orph_list)) {
864 orph = list_entry(c->orph_list.next, struct ubifs_orphan, list);
865 list_del(&orph->list);
866 kfree(orph);
867 dbg_err("orphan list not empty at unmount");
868 }
869
870 vfree(c->orph_buf);
871 c->orph_buf = NULL;
872}
873
874/**
875 * free_buds - free per-bud objects.
876 * @c: UBIFS file-system description object
877 */
878static void free_buds(struct ubifs_info *c)
879{
880 struct rb_node *this = c->buds.rb_node;
881 struct ubifs_bud *bud;
882
883 while (this) {
884 if (this->rb_left)
885 this = this->rb_left;
886 else if (this->rb_right)
887 this = this->rb_right;
888 else {
889 bud = rb_entry(this, struct ubifs_bud, rb);
890 this = rb_parent(this);
891 if (this) {
892 if (this->rb_left == &bud->rb)
893 this->rb_left = NULL;
894 else
895 this->rb_right = NULL;
896 }
897 kfree(bud);
898 }
899 }
900}
901
902/**
903 * check_volume_empty - check if the UBI volume is empty.
904 * @c: UBIFS file-system description object
905 *
906 * This function checks if the UBIFS volume is empty by looking if its LEBs are
907 * mapped or not. The result of checking is stored in the @c->empty variable.
908 * Returns zero in case of success and a negative error code in case of
909 * failure.
910 */
911static int check_volume_empty(struct ubifs_info *c)
912{
913 int lnum, err;
914
915 c->empty = 1;
916 for (lnum = 0; lnum < c->leb_cnt; lnum++) {
917 err = ubi_is_mapped(c->ubi, lnum);
918 if (unlikely(err < 0))
919 return err;
920 if (err == 1) {
921 c->empty = 0;
922 break;
923 }
924
925 cond_resched();
926 }
927
928 return 0;
929}
930
931/*
932 * UBIFS mount options.
933 *
934 * Opt_fast_unmount: do not run a journal commit before un-mounting
935 * Opt_norm_unmount: run a journal commit before un-mounting
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300936 * Opt_bulk_read: enable bulk-reads
937 * Opt_no_bulk_read: disable bulk-reads
Adrian Hunter2953e732008-09-04 16:26:00 +0300938 * Opt_chk_data_crc: check CRCs when reading data nodes
939 * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200940 * Opt_override_compr: override default compressor
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300941 * Opt_err: just end of array marker
942 */
943enum {
944 Opt_fast_unmount,
945 Opt_norm_unmount,
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300946 Opt_bulk_read,
947 Opt_no_bulk_read,
Adrian Hunter2953e732008-09-04 16:26:00 +0300948 Opt_chk_data_crc,
949 Opt_no_chk_data_crc,
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200950 Opt_override_compr,
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300951 Opt_err,
952};
953
Steven Whitehousea447c092008-10-13 10:46:57 +0100954static const match_table_t tokens = {
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300955 {Opt_fast_unmount, "fast_unmount"},
956 {Opt_norm_unmount, "norm_unmount"},
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300957 {Opt_bulk_read, "bulk_read"},
958 {Opt_no_bulk_read, "no_bulk_read"},
Adrian Hunter2953e732008-09-04 16:26:00 +0300959 {Opt_chk_data_crc, "chk_data_crc"},
960 {Opt_no_chk_data_crc, "no_chk_data_crc"},
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200961 {Opt_override_compr, "compr=%s"},
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300962 {Opt_err, NULL},
963};
964
965/**
Artem Bityutskiy8379ea32009-05-29 12:34:52 +0300966 * parse_standard_option - parse a standard mount option.
967 * @option: the option to parse
968 *
969 * Normally, standard mount options like "sync" are passed to file-systems as
970 * flags. However, when a "rootflags=" kernel boot parameter is used, they may
971 * be present in the options string. This function tries to deal with this
972 * situation and parse standard options. Returns 0 if the option was not
973 * recognized, and the corresponding integer flag if it was.
974 *
975 * UBIFS is only interested in the "sync" option, so do not check for anything
976 * else.
977 */
978static int parse_standard_option(const char *option)
979{
980 ubifs_msg("parse %s", option);
981 if (!strcmp(option, "sync"))
982 return MS_SYNCHRONOUS;
983 return 0;
984}
985
986/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300987 * ubifs_parse_options - parse mount parameters.
988 * @c: UBIFS file-system description object
989 * @options: parameters to parse
990 * @is_remount: non-zero if this is FS re-mount
991 *
992 * This function parses UBIFS mount options and returns zero in case success
993 * and a negative error code in case of failure.
994 */
995static int ubifs_parse_options(struct ubifs_info *c, char *options,
996 int is_remount)
997{
998 char *p;
999 substring_t args[MAX_OPT_ARGS];
1000
1001 if (!options)
1002 return 0;
1003
1004 while ((p = strsep(&options, ","))) {
1005 int token;
1006
1007 if (!*p)
1008 continue;
1009
1010 token = match_token(p, tokens, args);
1011 switch (token) {
Artem Bityutskiy27ad2792009-01-29 16:34:30 +02001012 /*
1013 * %Opt_fast_unmount and %Opt_norm_unmount options are ignored.
Artem Bityutskiycb54ef82009-06-23 20:30:32 +03001014 * We accept them in order to be backward-compatible. But this
Artem Bityutskiy27ad2792009-01-29 16:34:30 +02001015 * should be removed at some point.
1016 */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001017 case Opt_fast_unmount:
1018 c->mount_opts.unmount_mode = 2;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001019 break;
1020 case Opt_norm_unmount:
1021 c->mount_opts.unmount_mode = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001022 break;
Adrian Hunter4793e7c2008-09-02 16:29:46 +03001023 case Opt_bulk_read:
1024 c->mount_opts.bulk_read = 2;
1025 c->bulk_read = 1;
1026 break;
1027 case Opt_no_bulk_read:
1028 c->mount_opts.bulk_read = 1;
1029 c->bulk_read = 0;
1030 break;
Adrian Hunter2953e732008-09-04 16:26:00 +03001031 case Opt_chk_data_crc:
1032 c->mount_opts.chk_data_crc = 2;
1033 c->no_chk_data_crc = 0;
1034 break;
1035 case Opt_no_chk_data_crc:
1036 c->mount_opts.chk_data_crc = 1;
1037 c->no_chk_data_crc = 1;
1038 break;
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001039 case Opt_override_compr:
1040 {
1041 char *name = match_strdup(&args[0]);
1042
1043 if (!name)
1044 return -ENOMEM;
1045 if (!strcmp(name, "none"))
1046 c->mount_opts.compr_type = UBIFS_COMPR_NONE;
1047 else if (!strcmp(name, "lzo"))
1048 c->mount_opts.compr_type = UBIFS_COMPR_LZO;
1049 else if (!strcmp(name, "zlib"))
1050 c->mount_opts.compr_type = UBIFS_COMPR_ZLIB;
1051 else {
1052 ubifs_err("unknown compressor \"%s\"", name);
1053 kfree(name);
1054 return -EINVAL;
1055 }
1056 kfree(name);
1057 c->mount_opts.override_compr = 1;
1058 c->default_compr = c->mount_opts.compr_type;
1059 break;
1060 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001061 default:
Artem Bityutskiy8379ea32009-05-29 12:34:52 +03001062 {
1063 unsigned long flag;
1064 struct super_block *sb = c->vfs_sb;
1065
1066 flag = parse_standard_option(p);
1067 if (!flag) {
1068 ubifs_err("unrecognized mount option \"%s\" "
1069 "or missing value", p);
1070 return -EINVAL;
1071 }
1072 sb->s_flags |= flag;
1073 break;
1074 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001075 }
1076 }
1077
1078 return 0;
1079}
1080
1081/**
1082 * destroy_journal - destroy journal data structures.
1083 * @c: UBIFS file-system description object
1084 *
1085 * This function destroys journal data structures including those that may have
1086 * been created by recovery functions.
1087 */
1088static void destroy_journal(struct ubifs_info *c)
1089{
1090 while (!list_empty(&c->unclean_leb_list)) {
1091 struct ubifs_unclean_leb *ucleb;
1092
1093 ucleb = list_entry(c->unclean_leb_list.next,
1094 struct ubifs_unclean_leb, list);
1095 list_del(&ucleb->list);
1096 kfree(ucleb);
1097 }
1098 while (!list_empty(&c->old_buds)) {
1099 struct ubifs_bud *bud;
1100
1101 bud = list_entry(c->old_buds.next, struct ubifs_bud, list);
1102 list_del(&bud->list);
1103 kfree(bud);
1104 }
1105 ubifs_destroy_idx_gc(c);
1106 ubifs_destroy_size_tree(c);
1107 ubifs_tnc_close(c);
1108 free_buds(c);
1109}
1110
1111/**
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001112 * bu_init - initialize bulk-read information.
1113 * @c: UBIFS file-system description object
1114 */
1115static void bu_init(struct ubifs_info *c)
1116{
1117 ubifs_assert(c->bulk_read == 1);
1118
1119 if (c->bu.buf)
1120 return; /* Already initialized */
1121
1122again:
1123 c->bu.buf = kmalloc(c->max_bu_buf_len, GFP_KERNEL | __GFP_NOWARN);
1124 if (!c->bu.buf) {
1125 if (c->max_bu_buf_len > UBIFS_KMALLOC_OK) {
1126 c->max_bu_buf_len = UBIFS_KMALLOC_OK;
1127 goto again;
1128 }
1129
1130 /* Just disable bulk-read */
1131 ubifs_warn("Cannot allocate %d bytes of memory for bulk-read, "
1132 "disabling it", c->max_bu_buf_len);
1133 c->mount_opts.bulk_read = 1;
1134 c->bulk_read = 0;
1135 return;
1136 }
1137}
1138
1139/**
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001140 * check_free_space - check if there is enough free space to mount.
1141 * @c: UBIFS file-system description object
1142 *
1143 * This function makes sure UBIFS has enough free space to be mounted in
1144 * read/write mode. UBIFS must always have some free space to allow deletions.
1145 */
1146static int check_free_space(struct ubifs_info *c)
1147{
1148 ubifs_assert(c->dark_wm > 0);
1149 if (c->lst.total_free + c->lst.total_dirty < c->dark_wm) {
Artem Bityutskiyc4361572011-03-25 15:27:40 +02001150 ubifs_err("insufficient free space to mount in R/W mode");
Artem Bityutskiyf1bd66a2011-03-29 18:36:21 +03001151 dbg_dump_budg(c, &c->bi);
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001152 dbg_dump_lprops(c);
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001153 return -ENOSPC;
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001154 }
1155 return 0;
1156}
1157
1158/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001159 * mount_ubifs - mount UBIFS file-system.
1160 * @c: UBIFS file-system description object
1161 *
1162 * This function mounts UBIFS file system. Returns zero in case of success and
1163 * a negative error code in case of failure.
1164 *
1165 * Note, the function does not de-allocate resources it it fails half way
1166 * through, and the caller has to do this instead.
1167 */
1168static int mount_ubifs(struct ubifs_info *c)
1169{
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001170 int err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001171 long long x;
1172 size_t sz;
1173
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001174 c->ro_mount = !!(c->vfs_sb->s_flags & MS_RDONLY);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001175 err = init_constants_early(c);
1176 if (err)
1177 return err;
1178
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001179 err = ubifs_debugging_init(c);
1180 if (err)
1181 return err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001182
1183 err = check_volume_empty(c);
1184 if (err)
1185 goto out_free;
1186
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001187 if (c->empty && (c->ro_mount || c->ro_media)) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001188 /*
1189 * This UBI volume is empty, and read-only, or the file system
1190 * is mounted read-only - we cannot format it.
1191 */
1192 ubifs_err("can't format empty UBI volume: read-only %s",
1193 c->ro_media ? "UBI volume" : "mount");
1194 err = -EROFS;
1195 goto out_free;
1196 }
1197
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001198 if (c->ro_media && !c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001199 ubifs_err("cannot mount read-write - read-only media");
1200 err = -EROFS;
1201 goto out_free;
1202 }
1203
1204 /*
1205 * The requirement for the buffer is that it should fit indexing B-tree
1206 * height amount of integers. We assume the height if the TNC tree will
1207 * never exceed 64.
1208 */
1209 err = -ENOMEM;
1210 c->bottom_up_buf = kmalloc(BOTTOM_UP_HEIGHT * sizeof(int), GFP_KERNEL);
1211 if (!c->bottom_up_buf)
1212 goto out_free;
1213
1214 c->sbuf = vmalloc(c->leb_size);
1215 if (!c->sbuf)
1216 goto out_free;
1217
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001218 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001219 c->ileb_buf = vmalloc(c->leb_size);
1220 if (!c->ileb_buf)
1221 goto out_free;
1222 }
1223
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001224 if (c->bulk_read == 1)
1225 bu_init(c);
1226
Matthew L. Creechd8829622011-03-04 17:55:02 -05001227 if (!c->ro_mount) {
1228 c->write_reserve_buf = kmalloc(COMPRESSED_DATA_NODE_BUF_SZ,
1229 GFP_KERNEL);
1230 if (!c->write_reserve_buf)
1231 goto out_free;
1232 }
1233
Artem Bityutskiy18d1d7f2011-01-17 22:27:56 +02001234 c->mounting = 1;
Adrian Hunter2953e732008-09-04 16:26:00 +03001235
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001236 err = ubifs_read_superblock(c);
1237 if (err)
1238 goto out_free;
1239
1240 /*
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001241 * Make sure the compressor which is set as default in the superblock
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001242 * or overridden by mount options is actually compiled in.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001243 */
1244 if (!ubifs_compr_present(c->default_compr)) {
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001245 ubifs_err("'compressor \"%s\" is not compiled in",
1246 ubifs_compr_name(c->default_compr));
Corentin Chary8eec2f32009-05-25 08:49:10 +02001247 err = -ENOTSUPP;
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001248 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001249 }
1250
Artem Bityutskiy79807d02008-12-27 19:18:00 +02001251 err = init_constants_sb(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001252 if (err)
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001253 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001254
1255 sz = ALIGN(c->max_idx_node_sz, c->min_io_size);
1256 sz = ALIGN(sz + c->max_idx_node_sz, c->min_io_size);
1257 c->cbuf = kmalloc(sz, GFP_NOFS);
1258 if (!c->cbuf) {
1259 err = -ENOMEM;
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001260 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001261 }
1262
Artem Bityutskiyb50b9f42011-04-25 18:17:09 +03001263 err = alloc_wbufs(c);
1264 if (err)
1265 goto out_cbuf;
1266
Sebastian Siewior0855f312008-09-09 11:17:29 +02001267 sprintf(c->bgt_name, BGT_NAME_PATTERN, c->vi.ubi_num, c->vi.vol_id);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001268 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001269 /* Create background thread */
Hunter Adrianfcabb342009-03-18 12:29:39 +01001270 c->bgt = kthread_create(ubifs_bg_thread, c, "%s", c->bgt_name);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001271 if (IS_ERR(c->bgt)) {
1272 err = PTR_ERR(c->bgt);
1273 c->bgt = NULL;
1274 ubifs_err("cannot spawn \"%s\", error %d",
1275 c->bgt_name, err);
1276 goto out_wbufs;
1277 }
1278 wake_up_process(c->bgt);
1279 }
1280
1281 err = ubifs_read_master(c);
1282 if (err)
1283 goto out_master;
1284
Ben Gardiner09801192011-05-30 14:56:16 -04001285 init_constants_master(c);
1286
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001287 if ((c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY)) != 0) {
1288 ubifs_msg("recovery needed");
1289 c->need_recovery = 1;
Ben Gardiner781c5712011-05-30 14:56:15 -04001290 }
1291
Ben Gardiner781c5712011-05-30 14:56:15 -04001292 if (c->need_recovery && !c->ro_mount) {
1293 err = ubifs_recover_inl_heads(c, c->sbuf);
1294 if (err)
1295 goto out_master;
1296 }
1297
1298 err = ubifs_lpt_init(c, 1, !c->ro_mount);
1299 if (err)
1300 goto out_master;
1301
Ben Gardiner09801192011-05-30 14:56:16 -04001302 if (!c->ro_mount && c->space_fixup) {
1303 err = ubifs_fixup_free_space(c);
1304 if (err)
1305 goto out_master;
1306 }
1307
Ben Gardiner781c5712011-05-30 14:56:15 -04001308 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001309 /*
1310 * Set the "dirty" flag so that if we reboot uncleanly we
1311 * will notice this immediately on the next mount.
1312 */
1313 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1314 err = ubifs_write_master(c);
1315 if (err)
Ben Gardiner781c5712011-05-30 14:56:15 -04001316 goto out_lpt;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001317 }
1318
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001319 err = dbg_check_idx_size(c, c->bi.old_idx_sz);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001320 if (err)
1321 goto out_lpt;
1322
1323 err = ubifs_replay_journal(c);
1324 if (err)
1325 goto out_journal;
1326
Artem Bityutskiy1fb8bd02009-06-28 18:31:58 +03001327 /* Calculate 'min_idx_lebs' after journal replay */
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001328 c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
Artem Bityutskiy1fb8bd02009-06-28 18:31:58 +03001329
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001330 err = ubifs_mount_orphans(c, c->need_recovery, c->ro_mount);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001331 if (err)
1332 goto out_orphans;
1333
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001334 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001335 int lnum;
1336
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001337 err = check_free_space(c);
1338 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001339 goto out_orphans;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001340
1341 /* Check for enough log space */
1342 lnum = c->lhead_lnum + 1;
1343 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1344 lnum = UBIFS_LOG_LNUM;
1345 if (lnum == c->ltail_lnum) {
1346 err = ubifs_consolidate_log(c);
1347 if (err)
1348 goto out_orphans;
1349 }
1350
1351 if (c->need_recovery) {
1352 err = ubifs_recover_size(c);
1353 if (err)
1354 goto out_orphans;
1355 err = ubifs_rcvry_gc_commit(c);
Artem Bityutskiy276de5d2010-05-23 14:16:13 +03001356 if (err)
1357 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001358 } else {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001359 err = take_gc_lnum(c);
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001360 if (err)
1361 goto out_orphans;
1362
1363 /*
1364 * GC LEB may contain garbage if there was an unclean
1365 * reboot, and it should be un-mapped.
1366 */
1367 err = ubifs_leb_unmap(c, c->gc_lnum);
1368 if (err)
Matthieu CASTETc18de722010-08-02 11:36:06 +02001369 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001370 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001371
1372 err = dbg_check_lprops(c);
1373 if (err)
1374 goto out_orphans;
1375 } else if (c->need_recovery) {
1376 err = ubifs_recover_size(c);
1377 if (err)
1378 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001379 } else {
1380 /*
1381 * Even if we mount read-only, we have to set space in GC LEB
1382 * to proper value because this affects UBIFS free space
1383 * reporting. We do not want to have a situation when
1384 * re-mounting from R/O to R/W changes amount of free space.
1385 */
1386 err = take_gc_lnum(c);
1387 if (err)
1388 goto out_orphans;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001389 }
1390
1391 spin_lock(&ubifs_infos_lock);
1392 list_add_tail(&c->infos_list, &ubifs_infos);
1393 spin_unlock(&ubifs_infos_lock);
1394
1395 if (c->need_recovery) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001396 if (c->ro_mount)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001397 ubifs_msg("recovery deferred");
1398 else {
1399 c->need_recovery = 0;
1400 ubifs_msg("recovery completed");
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001401 /*
1402 * GC LEB has to be empty and taken at this point. But
1403 * the journal head LEBs may also be accounted as
1404 * "empty taken" if they are empty.
1405 */
1406 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001407 }
Artem Bityutskiy6ba87c92009-01-26 16:12:20 +02001408 } else
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001409 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy552ff312008-10-23 11:49:28 +03001410
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001411 err = dbg_check_filesystem(c);
1412 if (err)
1413 goto out_infos;
1414
Artem Bityutskiy6ba87c92009-01-26 16:12:20 +02001415 err = dbg_debugfs_init_fs(c);
1416 if (err)
1417 goto out_infos;
1418
Artem Bityutskiy18d1d7f2011-01-17 22:27:56 +02001419 c->mounting = 0;
Adrian Hunter2953e732008-09-04 16:26:00 +03001420
Artem Bityutskiyce769ca2008-07-18 12:54:21 +03001421 ubifs_msg("mounted UBI device %d, volume %d, name \"%s\"",
1422 c->vi.ubi_num, c->vi.vol_id, c->vi.name);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001423 if (c->ro_mount)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001424 ubifs_msg("mounted read-only");
1425 x = (long long)c->main_lebs * c->leb_size;
Artem Bityutskiy948cfb22008-08-20 11:56:33 +03001426 ubifs_msg("file system size: %lld bytes (%lld KiB, %lld MiB, %d "
1427 "LEBs)", x, x >> 10, x >> 20, c->main_lebs);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001428 x = (long long)c->log_lebs * c->leb_size + c->max_bud_bytes;
Artem Bityutskiy948cfb22008-08-20 11:56:33 +03001429 ubifs_msg("journal size: %lld bytes (%lld KiB, %lld MiB, %d "
1430 "LEBs)", x, x >> 10, x >> 20, c->log_lebs + c->max_bud_cnt);
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001431 ubifs_msg("media format: w%d/r%d (latest is w%d/r%d)",
1432 c->fmt_version, c->ro_compat_version,
1433 UBIFS_FORMAT_VERSION, UBIFS_RO_COMPAT_VERSION);
Artem Bityutskiy948cfb22008-08-20 11:56:33 +03001434 ubifs_msg("default compressor: %s", ubifs_compr_name(c->default_compr));
Artem Bityutskiyfae7fb22008-10-17 18:49:23 +03001435 ubifs_msg("reserved for root: %llu bytes (%llu KiB)",
Artem Bityutskiy948cfb22008-08-20 11:56:33 +03001436 c->report_rp_size, c->report_rp_size >> 10);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001437
1438 dbg_msg("compiled on: " __DATE__ " at " __TIME__);
1439 dbg_msg("min. I/O unit size: %d bytes", c->min_io_size);
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +02001440 dbg_msg("max. write size: %d bytes", c->max_write_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001441 dbg_msg("LEB size: %d bytes (%d KiB)",
Artem Bityutskiy948cfb22008-08-20 11:56:33 +03001442 c->leb_size, c->leb_size >> 10);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001443 dbg_msg("data journal heads: %d",
1444 c->jhead_cnt - NONDATA_JHEADS_CNT);
Joe Perches7f2f4e72009-12-14 18:01:13 -08001445 dbg_msg("UUID: %pUB", c->uuid);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001446 dbg_msg("big_lpt %d", c->big_lpt);
1447 dbg_msg("log LEBs: %d (%d - %d)",
1448 c->log_lebs, UBIFS_LOG_LNUM, c->log_last);
1449 dbg_msg("LPT area LEBs: %d (%d - %d)",
1450 c->lpt_lebs, c->lpt_first, c->lpt_last);
1451 dbg_msg("orphan area LEBs: %d (%d - %d)",
1452 c->orph_lebs, c->orph_first, c->orph_last);
1453 dbg_msg("main area LEBs: %d (%d - %d)",
1454 c->main_lebs, c->main_first, c->leb_cnt - 1);
1455 dbg_msg("index LEBs: %d", c->lst.idx_lebs);
1456 dbg_msg("total index bytes: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001457 c->bi.old_idx_sz, c->bi.old_idx_sz >> 10,
1458 c->bi.old_idx_sz >> 20);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001459 dbg_msg("key hash type: %d", c->key_hash_type);
1460 dbg_msg("tree fanout: %d", c->fanout);
1461 dbg_msg("reserved GC LEB: %d", c->gc_lnum);
1462 dbg_msg("first main LEB: %d", c->main_first);
Artem Bityutskiy8e5033a2008-12-30 18:37:45 +02001463 dbg_msg("max. znode size %d", c->max_znode_sz);
1464 dbg_msg("max. index node size %d", c->max_idx_node_sz);
1465 dbg_msg("node sizes: data %zu, inode %zu, dentry %zu",
1466 UBIFS_DATA_NODE_SZ, UBIFS_INO_NODE_SZ, UBIFS_DENT_NODE_SZ);
1467 dbg_msg("node sizes: trun %zu, sb %zu, master %zu",
1468 UBIFS_TRUN_NODE_SZ, UBIFS_SB_NODE_SZ, UBIFS_MST_NODE_SZ);
1469 dbg_msg("node sizes: ref %zu, cmt. start %zu, orph %zu",
1470 UBIFS_REF_NODE_SZ, UBIFS_CS_NODE_SZ, UBIFS_ORPH_NODE_SZ);
Artem Bityutskiy6342aae2011-03-08 14:26:47 +02001471 dbg_msg("max. node sizes: data %zu, inode %zu dentry %zu, idx %d",
Artem Bityutskiyc4361572011-03-25 15:27:40 +02001472 UBIFS_MAX_DATA_NODE_SZ, UBIFS_MAX_INO_NODE_SZ,
Artem Bityutskiy6342aae2011-03-08 14:26:47 +02001473 UBIFS_MAX_DENT_NODE_SZ, ubifs_idx_node_sz(c, c->fanout));
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001474 dbg_msg("dead watermark: %d", c->dead_wm);
1475 dbg_msg("dark watermark: %d", c->dark_wm);
Artem Bityutskiy8e5033a2008-12-30 18:37:45 +02001476 dbg_msg("LEB overhead: %d", c->leb_overhead);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001477 x = (long long)c->main_lebs * c->dark_wm;
1478 dbg_msg("max. dark space: %lld (%lld KiB, %lld MiB)",
1479 x, x >> 10, x >> 20);
1480 dbg_msg("maximum bud bytes: %lld (%lld KiB, %lld MiB)",
1481 c->max_bud_bytes, c->max_bud_bytes >> 10,
1482 c->max_bud_bytes >> 20);
1483 dbg_msg("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
1484 c->bg_bud_bytes, c->bg_bud_bytes >> 10,
1485 c->bg_bud_bytes >> 20);
1486 dbg_msg("current bud bytes %lld (%lld KiB, %lld MiB)",
1487 c->bud_bytes, c->bud_bytes >> 10, c->bud_bytes >> 20);
1488 dbg_msg("max. seq. number: %llu", c->max_sqnum);
1489 dbg_msg("commit number: %llu", c->cmt_no);
1490
1491 return 0;
1492
1493out_infos:
1494 spin_lock(&ubifs_infos_lock);
1495 list_del(&c->infos_list);
1496 spin_unlock(&ubifs_infos_lock);
1497out_orphans:
1498 free_orphans(c);
1499out_journal:
1500 destroy_journal(c);
1501out_lpt:
1502 ubifs_lpt_free(c, 0);
1503out_master:
1504 kfree(c->mst_node);
1505 kfree(c->rcvrd_mst_node);
1506 if (c->bgt)
1507 kthread_stop(c->bgt);
1508out_wbufs:
1509 free_wbufs(c);
1510out_cbuf:
1511 kfree(c->cbuf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001512out_free:
Matthew L. Creechd8829622011-03-04 17:55:02 -05001513 kfree(c->write_reserve_buf);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001514 kfree(c->bu.buf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001515 vfree(c->ileb_buf);
1516 vfree(c->sbuf);
1517 kfree(c->bottom_up_buf);
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001518 ubifs_debugging_exit(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001519 return err;
1520}
1521
1522/**
1523 * ubifs_umount - un-mount UBIFS file-system.
1524 * @c: UBIFS file-system description object
1525 *
1526 * Note, this function is called to free allocated resourced when un-mounting,
1527 * as well as free resources when an error occurred while we were half way
1528 * through mounting (error path cleanup function). So it has to make sure the
1529 * resource was actually allocated before freeing it.
1530 */
1531static void ubifs_umount(struct ubifs_info *c)
1532{
1533 dbg_gen("un-mounting UBI device %d, volume %d", c->vi.ubi_num,
1534 c->vi.vol_id);
1535
Artem Bityutskiy552ff312008-10-23 11:49:28 +03001536 dbg_debugfs_exit_fs(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001537 spin_lock(&ubifs_infos_lock);
1538 list_del(&c->infos_list);
1539 spin_unlock(&ubifs_infos_lock);
1540
1541 if (c->bgt)
1542 kthread_stop(c->bgt);
1543
1544 destroy_journal(c);
1545 free_wbufs(c);
1546 free_orphans(c);
1547 ubifs_lpt_free(c, 0);
1548
1549 kfree(c->cbuf);
1550 kfree(c->rcvrd_mst_node);
1551 kfree(c->mst_node);
Matthew L. Creechd8829622011-03-04 17:55:02 -05001552 kfree(c->write_reserve_buf);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001553 kfree(c->bu.buf);
1554 vfree(c->ileb_buf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001555 vfree(c->sbuf);
1556 kfree(c->bottom_up_buf);
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001557 ubifs_debugging_exit(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001558}
1559
1560/**
1561 * ubifs_remount_rw - re-mount in read-write mode.
1562 * @c: UBIFS file-system description object
1563 *
1564 * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1565 * mode. This function allocates the needed resources and re-mounts UBIFS in
1566 * read-write mode.
1567 */
1568static int ubifs_remount_rw(struct ubifs_info *c)
1569{
1570 int err, lnum;
1571
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001572 if (c->rw_incompat) {
1573 ubifs_err("the file-system is not R/W-compatible");
1574 ubifs_msg("on-flash format version is w%d/r%d, but software "
1575 "only supports up to version w%d/r%d", c->fmt_version,
1576 c->ro_compat_version, UBIFS_FORMAT_VERSION,
1577 UBIFS_RO_COMPAT_VERSION);
1578 return -EROFS;
1579 }
1580
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001581 mutex_lock(&c->umount_mutex);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001582 dbg_save_space_info(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001583 c->remounting_rw = 1;
Artem Bityutskiyc88ac002011-03-29 09:45:21 +03001584 c->ro_mount = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001585
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001586 err = check_free_space(c);
1587 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001588 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001589
1590 if (c->old_leb_cnt != c->leb_cnt) {
1591 struct ubifs_sb_node *sup;
1592
1593 sup = ubifs_read_sb_node(c);
1594 if (IS_ERR(sup)) {
1595 err = PTR_ERR(sup);
1596 goto out;
1597 }
1598 sup->leb_cnt = cpu_to_le32(c->leb_cnt);
1599 err = ubifs_write_sb_node(c, sup);
Artem Bityutskiyeaeee242011-05-06 17:08:56 +03001600 kfree(sup);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001601 if (err)
1602 goto out;
1603 }
1604
1605 if (c->need_recovery) {
1606 ubifs_msg("completing deferred recovery");
1607 err = ubifs_write_rcvrd_mst_node(c);
1608 if (err)
1609 goto out;
1610 err = ubifs_recover_size(c);
1611 if (err)
1612 goto out;
1613 err = ubifs_clean_lebs(c, c->sbuf);
1614 if (err)
1615 goto out;
1616 err = ubifs_recover_inl_heads(c, c->sbuf);
1617 if (err)
1618 goto out;
Adrian Hunter49d128a2009-01-26 10:55:40 +02001619 } else {
1620 /* A readonly mount is not allowed to have orphans */
1621 ubifs_assert(c->tot_orphans == 0);
1622 err = ubifs_clear_orphans(c);
1623 if (err)
1624 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001625 }
1626
1627 if (!(c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY))) {
1628 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1629 err = ubifs_write_master(c);
1630 if (err)
1631 goto out;
1632 }
1633
1634 c->ileb_buf = vmalloc(c->leb_size);
1635 if (!c->ileb_buf) {
1636 err = -ENOMEM;
1637 goto out;
1638 }
1639
Matthew L. Creechd8829622011-03-04 17:55:02 -05001640 c->write_reserve_buf = kmalloc(COMPRESSED_DATA_NODE_BUF_SZ, GFP_KERNEL);
1641 if (!c->write_reserve_buf)
1642 goto out;
1643
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001644 err = ubifs_lpt_init(c, 0, 1);
1645 if (err)
1646 goto out;
1647
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001648 /* Create background thread */
Hunter Adrianfcabb342009-03-18 12:29:39 +01001649 c->bgt = kthread_create(ubifs_bg_thread, c, "%s", c->bgt_name);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001650 if (IS_ERR(c->bgt)) {
1651 err = PTR_ERR(c->bgt);
1652 c->bgt = NULL;
1653 ubifs_err("cannot spawn \"%s\", error %d",
1654 c->bgt_name, err);
Adrian Hunter2953e732008-09-04 16:26:00 +03001655 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001656 }
1657 wake_up_process(c->bgt);
1658
1659 c->orph_buf = vmalloc(c->leb_size);
Adrian Hunter2953e732008-09-04 16:26:00 +03001660 if (!c->orph_buf) {
1661 err = -ENOMEM;
1662 goto out;
1663 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001664
1665 /* Check for enough log space */
1666 lnum = c->lhead_lnum + 1;
1667 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1668 lnum = UBIFS_LOG_LNUM;
1669 if (lnum == c->ltail_lnum) {
1670 err = ubifs_consolidate_log(c);
1671 if (err)
1672 goto out;
1673 }
1674
1675 if (c->need_recovery)
1676 err = ubifs_rcvry_gc_commit(c);
1677 else
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001678 err = ubifs_leb_unmap(c, c->gc_lnum);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001679 if (err)
1680 goto out;
1681
Artem Bityutskiy8c230d92011-04-20 18:02:45 +03001682 dbg_gen("re-mounted read-write");
1683 c->remounting_rw = 0;
1684
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001685 if (c->need_recovery) {
1686 c->need_recovery = 0;
1687 ubifs_msg("deferred recovery completed");
Artem Bityutskiy8c230d92011-04-20 18:02:45 +03001688 } else {
1689 /*
1690 * Do not run the debugging space check if the were doing
1691 * recovery, because when we saved the information we had the
1692 * file-system in a state where the TNC and lprops has been
1693 * modified in memory, but all the I/O operations (including a
1694 * commit) were deferred. So the file-system was in
1695 * "non-committed" state. Now the file-system is in committed
1696 * state, and of course the amount of free space will change
1697 * because, for example, the old index size was imprecise.
1698 */
1699 err = dbg_check_space_info(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001700 }
Matthew L. Creech9d510db2011-05-06 18:58:23 -04001701
1702 if (c->space_fixup) {
1703 err = ubifs_fixup_free_space(c);
1704 if (err)
1705 goto out;
1706 }
1707
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001708 mutex_unlock(&c->umount_mutex);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001709 return err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001710
1711out:
Artem Bityutskiyc88ac002011-03-29 09:45:21 +03001712 c->ro_mount = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001713 vfree(c->orph_buf);
1714 c->orph_buf = NULL;
1715 if (c->bgt) {
1716 kthread_stop(c->bgt);
1717 c->bgt = NULL;
1718 }
1719 free_wbufs(c);
Matthew L. Creechd8829622011-03-04 17:55:02 -05001720 kfree(c->write_reserve_buf);
1721 c->write_reserve_buf = NULL;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001722 vfree(c->ileb_buf);
1723 c->ileb_buf = NULL;
1724 ubifs_lpt_free(c, 1);
1725 c->remounting_rw = 0;
1726 mutex_unlock(&c->umount_mutex);
1727 return err;
1728}
1729
1730/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001731 * ubifs_remount_ro - re-mount in read-only mode.
1732 * @c: UBIFS file-system description object
1733 *
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001734 * We assume VFS has stopped writing. Possibly the background thread could be
1735 * running a commit, however kthread_stop will wait in that case.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001736 */
1737static void ubifs_remount_ro(struct ubifs_info *c)
1738{
1739 int i, err;
1740
1741 ubifs_assert(!c->need_recovery);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001742 ubifs_assert(!c->ro_mount);
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001743
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001744 mutex_lock(&c->umount_mutex);
1745 if (c->bgt) {
1746 kthread_stop(c->bgt);
1747 c->bgt = NULL;
1748 }
1749
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001750 dbg_save_space_info(c);
1751
Artem Bityutskiy39037552010-10-18 08:28:50 +03001752 for (i = 0; i < c->jhead_cnt; i++)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001753 ubifs_wbuf_sync(&c->jheads[i].wbuf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001754
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001755 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1756 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1757 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1758 err = ubifs_write_master(c);
1759 if (err)
1760 ubifs_ro_mode(c, err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001761
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001762 vfree(c->orph_buf);
1763 c->orph_buf = NULL;
Matthew L. Creechd8829622011-03-04 17:55:02 -05001764 kfree(c->write_reserve_buf);
1765 c->write_reserve_buf = NULL;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001766 vfree(c->ileb_buf);
1767 c->ileb_buf = NULL;
1768 ubifs_lpt_free(c, 1);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001769 c->ro_mount = 1;
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001770 err = dbg_check_space_info(c);
1771 if (err)
1772 ubifs_ro_mode(c, err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001773 mutex_unlock(&c->umount_mutex);
1774}
1775
1776static void ubifs_put_super(struct super_block *sb)
1777{
1778 int i;
1779 struct ubifs_info *c = sb->s_fs_info;
1780
1781 ubifs_msg("un-mount UBI device %d, volume %d", c->vi.ubi_num,
1782 c->vi.vol_id);
Christoph Hellwig6cfd0142009-05-05 15:40:36 +02001783
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001784 /*
1785 * The following asserts are only valid if there has not been a failure
1786 * of the media. For example, there will be dirty inodes if we failed
1787 * to write them back because of I/O errors.
1788 */
Artem Bityutskiy1a067a22011-04-21 10:39:54 +03001789 if (!c->ro_error) {
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001790 ubifs_assert(c->bi.idx_growth == 0);
1791 ubifs_assert(c->bi.dd_growth == 0);
1792 ubifs_assert(c->bi.data_growth == 0);
Artem Bityutskiy1a067a22011-04-21 10:39:54 +03001793 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001794
1795 /*
1796 * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1797 * and file system un-mount. Namely, it prevents the shrinker from
1798 * picking this superblock for shrinking - it will be just skipped if
1799 * the mutex is locked.
1800 */
1801 mutex_lock(&c->umount_mutex);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001802 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001803 /*
1804 * First of all kill the background thread to make sure it does
1805 * not interfere with un-mounting and freeing resources.
1806 */
1807 if (c->bgt) {
1808 kthread_stop(c->bgt);
1809 c->bgt = NULL;
1810 }
1811
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001812 /*
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001813 * On fatal errors c->ro_error is set to 1, in which case we do
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001814 * not write the master node.
1815 */
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001816 if (!c->ro_error) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001817 int err;
1818
1819 /* Synchronize write-buffers */
Artem Bityutskiy39037552010-10-18 08:28:50 +03001820 for (i = 0; i < c->jhead_cnt; i++)
1821 ubifs_wbuf_sync(&c->jheads[i].wbuf);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001822
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001823 /*
1824 * We are being cleanly unmounted which means the
1825 * orphans were killed - indicate this in the master
1826 * node. Also save the reserved GC LEB number.
1827 */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001828 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1829 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1830 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1831 err = ubifs_write_master(c);
1832 if (err)
1833 /*
1834 * Recovery will attempt to fix the master area
1835 * next mount, so we just print a message and
1836 * continue to unmount normally.
1837 */
1838 ubifs_err("failed to write master node, "
1839 "error %d", err);
Artem Bityutskiy3601ba22010-10-18 08:32:35 +03001840 } else {
1841 for (i = 0; i < c->jhead_cnt; i++)
1842 /* Make sure write-buffer timers are canceled */
1843 hrtimer_cancel(&c->jheads[i].wbuf.timer);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001844 }
1845 }
1846
1847 ubifs_umount(c);
1848 bdi_destroy(&c->bdi);
1849 ubi_close_volume(c->ubi);
1850 mutex_unlock(&c->umount_mutex);
1851 kfree(c);
1852}
1853
1854static int ubifs_remount_fs(struct super_block *sb, int *flags, char *data)
1855{
1856 int err;
1857 struct ubifs_info *c = sb->s_fs_info;
1858
1859 dbg_gen("old flags %#lx, new flags %#x", sb->s_flags, *flags);
1860
1861 err = ubifs_parse_options(c, data, 1);
1862 if (err) {
1863 ubifs_err("invalid or unknown remount parameter");
1864 return err;
1865 }
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001866
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001867 if (c->ro_mount && !(*flags & MS_RDONLY)) {
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001868 if (c->ro_error) {
1869 ubifs_msg("cannot re-mount R/W due to prior errors");
1870 return -EROFS;
1871 }
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001872 if (c->ro_media) {
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001873 ubifs_msg("cannot re-mount R/W - UBI volume is R/O");
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001874 return -EROFS;
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001875 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001876 err = ubifs_remount_rw(c);
Artem Bityutskiye9d6bbc2009-07-19 13:51:04 +03001877 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001878 return err;
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001879 } else if (!c->ro_mount && (*flags & MS_RDONLY)) {
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001880 if (c->ro_error) {
1881 ubifs_msg("cannot re-mount R/O due to prior errors");
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001882 return -EROFS;
Adrian Hunterb466f172009-01-29 12:59:33 +02001883 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001884 ubifs_remount_ro(c);
Adrian Hunterb466f172009-01-29 12:59:33 +02001885 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001886
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001887 if (c->bulk_read == 1)
1888 bu_init(c);
1889 else {
1890 dbg_gen("disable bulk-read");
1891 kfree(c->bu.buf);
1892 c->bu.buf = NULL;
1893 }
1894
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001895 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001896 return 0;
1897}
1898
Artem Bityutskiye8b81562009-01-15 17:43:23 +02001899const struct super_operations ubifs_super_operations = {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001900 .alloc_inode = ubifs_alloc_inode,
1901 .destroy_inode = ubifs_destroy_inode,
1902 .put_super = ubifs_put_super,
1903 .write_inode = ubifs_write_inode,
Al Virod640e1b2010-06-07 00:34:05 -04001904 .evict_inode = ubifs_evict_inode,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001905 .statfs = ubifs_statfs,
1906 .dirty_inode = ubifs_dirty_inode,
1907 .remount_fs = ubifs_remount_fs,
1908 .show_options = ubifs_show_options,
1909 .sync_fs = ubifs_sync_fs,
1910};
1911
1912/**
1913 * open_ubi - parse UBI device name string and open the UBI device.
1914 * @name: UBI volume name
1915 * @mode: UBI volume open mode
1916 *
Corentin Chary97223242009-09-28 21:10:12 +02001917 * The primary method of mounting UBIFS is by specifying the UBI volume
1918 * character device node path. However, UBIFS may also be mounted withoug any
1919 * character device node using one of the following methods:
1920 *
1921 * o ubiX_Y - mount UBI device number X, volume Y;
1922 * o ubiY - mount UBI device number 0, volume Y;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001923 * o ubiX:NAME - mount UBI device X, volume with name NAME;
1924 * o ubi:NAME - mount UBI device 0, volume with name NAME.
1925 *
1926 * Alternative '!' separator may be used instead of ':' (because some shells
1927 * like busybox may interpret ':' as an NFS host name separator). This function
Corentin Chary97223242009-09-28 21:10:12 +02001928 * returns UBI volume description object in case of success and a negative
1929 * error code in case of failure.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001930 */
1931static struct ubi_volume_desc *open_ubi(const char *name, int mode)
1932{
Corentin Chary97223242009-09-28 21:10:12 +02001933 struct ubi_volume_desc *ubi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001934 int dev, vol;
1935 char *endptr;
1936
Corentin Chary97223242009-09-28 21:10:12 +02001937 /* First, try to open using the device node path method */
1938 ubi = ubi_open_volume_path(name, mode);
1939 if (!IS_ERR(ubi))
1940 return ubi;
1941
1942 /* Try the "nodev" method */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001943 if (name[0] != 'u' || name[1] != 'b' || name[2] != 'i')
1944 return ERR_PTR(-EINVAL);
1945
1946 /* ubi:NAME method */
1947 if ((name[3] == ':' || name[3] == '!') && name[4] != '\0')
1948 return ubi_open_volume_nm(0, name + 4, mode);
1949
1950 if (!isdigit(name[3]))
1951 return ERR_PTR(-EINVAL);
1952
1953 dev = simple_strtoul(name + 3, &endptr, 0);
1954
1955 /* ubiY method */
1956 if (*endptr == '\0')
1957 return ubi_open_volume(0, dev, mode);
1958
1959 /* ubiX_Y method */
1960 if (*endptr == '_' && isdigit(endptr[1])) {
1961 vol = simple_strtoul(endptr + 1, &endptr, 0);
1962 if (*endptr != '\0')
1963 return ERR_PTR(-EINVAL);
1964 return ubi_open_volume(dev, vol, mode);
1965 }
1966
1967 /* ubiX:NAME method */
1968 if ((*endptr == ':' || *endptr == '!') && endptr[1] != '\0')
1969 return ubi_open_volume_nm(dev, ++endptr, mode);
1970
1971 return ERR_PTR(-EINVAL);
1972}
1973
1974static int ubifs_fill_super(struct super_block *sb, void *data, int silent)
1975{
1976 struct ubi_volume_desc *ubi = sb->s_fs_info;
1977 struct ubifs_info *c;
1978 struct inode *root;
1979 int err;
1980
1981 c = kzalloc(sizeof(struct ubifs_info), GFP_KERNEL);
1982 if (!c)
1983 return -ENOMEM;
1984
1985 spin_lock_init(&c->cnt_lock);
1986 spin_lock_init(&c->cs_lock);
1987 spin_lock_init(&c->buds_lock);
1988 spin_lock_init(&c->space_lock);
1989 spin_lock_init(&c->orphan_lock);
1990 init_rwsem(&c->commit_sem);
1991 mutex_init(&c->lp_mutex);
1992 mutex_init(&c->tnc_mutex);
1993 mutex_init(&c->log_mutex);
1994 mutex_init(&c->mst_mutex);
1995 mutex_init(&c->umount_mutex);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001996 mutex_init(&c->bu_mutex);
Matthew L. Creechd8829622011-03-04 17:55:02 -05001997 mutex_init(&c->write_reserve_mutex);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001998 init_waitqueue_head(&c->cmt_wq);
1999 c->buds = RB_ROOT;
2000 c->old_idx = RB_ROOT;
2001 c->size_tree = RB_ROOT;
2002 c->orph_tree = RB_ROOT;
2003 INIT_LIST_HEAD(&c->infos_list);
2004 INIT_LIST_HEAD(&c->idx_gc);
2005 INIT_LIST_HEAD(&c->replay_list);
2006 INIT_LIST_HEAD(&c->replay_buds);
2007 INIT_LIST_HEAD(&c->uncat_list);
2008 INIT_LIST_HEAD(&c->empty_list);
2009 INIT_LIST_HEAD(&c->freeable_list);
2010 INIT_LIST_HEAD(&c->frdi_idx_list);
2011 INIT_LIST_HEAD(&c->unclean_leb_list);
2012 INIT_LIST_HEAD(&c->old_buds);
2013 INIT_LIST_HEAD(&c->orph_list);
2014 INIT_LIST_HEAD(&c->orph_new);
Artem Bityutskiy2bcf0022011-03-10 16:26:32 +02002015 c->no_chk_data_crc = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002016
Artem Bityutskiy8379ea32009-05-29 12:34:52 +03002017 c->vfs_sb = sb;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002018 c->highest_inum = UBIFS_FIRST_INO;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002019 c->lhead_lnum = c->ltail_lnum = UBIFS_LOG_LNUM;
2020
2021 ubi_get_volume_info(ubi, &c->vi);
2022 ubi_get_device_info(c->vi.ubi_num, &c->di);
2023
2024 /* Re-open the UBI device in read-write mode */
2025 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READWRITE);
2026 if (IS_ERR(c->ubi)) {
2027 err = PTR_ERR(c->ubi);
2028 goto out_free;
2029 }
2030
2031 /*
Artem Bityutskiy0a883a02008-08-13 14:13:26 +03002032 * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002033 * UBIFS, I/O is not deferred, it is done immediately in readpage,
2034 * which means the user would have to wait not just for their own I/O
Artem Bityutskiy0a883a02008-08-13 14:13:26 +03002035 * but the read-ahead I/O as well i.e. completely pointless.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002036 *
2037 * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
2038 */
Jens Axboed9938312009-06-12 14:45:52 +02002039 c->bdi.name = "ubifs",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002040 c->bdi.capabilities = BDI_CAP_MAP_COPY;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002041 err = bdi_init(&c->bdi);
2042 if (err)
2043 goto out_close;
Daniel Mack7fcd9c32009-07-02 17:15:47 +02002044 err = bdi_register(&c->bdi, NULL, "ubifs_%d_%d",
2045 c->vi.ubi_num, c->vi.vol_id);
Jens Axboea979eff2009-05-29 09:19:23 +02002046 if (err)
2047 goto out_bdi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002048
2049 err = ubifs_parse_options(c, data, 0);
2050 if (err)
2051 goto out_bdi;
2052
Jens Axboe32a88aa2009-09-16 15:02:33 +02002053 sb->s_bdi = &c->bdi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002054 sb->s_fs_info = c;
2055 sb->s_magic = UBIFS_SUPER_MAGIC;
2056 sb->s_blocksize = UBIFS_BLOCK_SIZE;
2057 sb->s_blocksize_bits = UBIFS_BLOCK_SHIFT;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002058 sb->s_maxbytes = c->max_inode_sz = key_max_inode_size(c);
2059 if (c->max_inode_sz > MAX_LFS_FILESIZE)
2060 sb->s_maxbytes = c->max_inode_sz = MAX_LFS_FILESIZE;
2061 sb->s_op = &ubifs_super_operations;
2062
2063 mutex_lock(&c->umount_mutex);
2064 err = mount_ubifs(c);
2065 if (err) {
2066 ubifs_assert(err < 0);
2067 goto out_unlock;
2068 }
2069
2070 /* Read the root inode */
2071 root = ubifs_iget(sb, UBIFS_ROOT_INO);
2072 if (IS_ERR(root)) {
2073 err = PTR_ERR(root);
2074 goto out_umount;
2075 }
2076
2077 sb->s_root = d_alloc_root(root);
2078 if (!sb->s_root)
2079 goto out_iput;
2080
2081 mutex_unlock(&c->umount_mutex);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002082 return 0;
2083
2084out_iput:
2085 iput(root);
2086out_umount:
2087 ubifs_umount(c);
2088out_unlock:
2089 mutex_unlock(&c->umount_mutex);
2090out_bdi:
2091 bdi_destroy(&c->bdi);
2092out_close:
2093 ubi_close_volume(c->ubi);
2094out_free:
2095 kfree(c);
2096 return err;
2097}
2098
2099static int sb_test(struct super_block *sb, void *data)
2100{
2101 dev_t *dev = data;
Artem Bityutskiy7c83f5c2009-05-25 19:23:04 +03002102 struct ubifs_info *c = sb->s_fs_info;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002103
Artem Bityutskiy7c83f5c2009-05-25 19:23:04 +03002104 return c->vi.cdev == *dev;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002105}
2106
Al Viro157d81e2010-07-25 23:52:42 +04002107static struct dentry *ubifs_mount(struct file_system_type *fs_type, int flags,
2108 const char *name, void *data)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002109{
2110 struct ubi_volume_desc *ubi;
2111 struct ubi_volume_info vi;
2112 struct super_block *sb;
2113 int err;
2114
2115 dbg_gen("name %s, flags %#x", name, flags);
2116
2117 /*
2118 * Get UBI device number and volume ID. Mount it read-only so far
2119 * because this might be a new mount point, and UBI allows only one
2120 * read-write user at a time.
2121 */
2122 ubi = open_ubi(name, UBI_READONLY);
2123 if (IS_ERR(ubi)) {
Steffen Sledz54dd55a2010-09-27 14:20:26 +02002124 dbg_err("cannot open \"%s\", error %d",
2125 name, (int)PTR_ERR(ubi));
Al Viro157d81e2010-07-25 23:52:42 +04002126 return ERR_CAST(ubi);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002127 }
2128 ubi_get_volume_info(ubi, &vi);
2129
2130 dbg_gen("opened ubi%d_%d", vi.ubi_num, vi.vol_id);
2131
Artem Bityutskiy7c83f5c2009-05-25 19:23:04 +03002132 sb = sget(fs_type, &sb_test, &set_anon_super, &vi.cdev);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002133 if (IS_ERR(sb)) {
2134 err = PTR_ERR(sb);
2135 goto out_close;
2136 }
2137
2138 if (sb->s_root) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03002139 struct ubifs_info *c1 = sb->s_fs_info;
2140
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002141 /* A new mount point for already mounted UBIFS */
2142 dbg_gen("this ubi volume is already mounted");
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03002143 if (!!(flags & MS_RDONLY) != c1->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002144 err = -EBUSY;
2145 goto out_deact;
2146 }
2147 } else {
2148 sb->s_flags = flags;
2149 /*
2150 * Pass 'ubi' to 'fill_super()' in sb->s_fs_info where it is
2151 * replaced by 'c'.
2152 */
2153 sb->s_fs_info = ubi;
2154 err = ubifs_fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
2155 if (err)
2156 goto out_deact;
2157 /* We do not support atime */
2158 sb->s_flags |= MS_ACTIVE | MS_NOATIME;
2159 }
2160
2161 /* 'fill_super()' opens ubi again so we must close it here */
2162 ubi_close_volume(ubi);
2163
Al Viro157d81e2010-07-25 23:52:42 +04002164 return dget(sb->s_root);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002165
2166out_deact:
Al Viro6f5bbff2009-05-06 01:34:22 -04002167 deactivate_locked_super(sb);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002168out_close:
2169 ubi_close_volume(ubi);
Al Viro157d81e2010-07-25 23:52:42 +04002170 return ERR_PTR(err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002171}
2172
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002173static struct file_system_type ubifs_fs_type = {
2174 .name = "ubifs",
2175 .owner = THIS_MODULE,
Al Viro157d81e2010-07-25 23:52:42 +04002176 .mount = ubifs_mount,
Artem Bityutskiy7c83f5c2009-05-25 19:23:04 +03002177 .kill_sb = kill_anon_super,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002178};
2179
2180/*
2181 * Inode slab cache constructor.
2182 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -07002183static void inode_slab_ctor(void *obj)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002184{
2185 struct ubifs_inode *ui = obj;
2186 inode_init_once(&ui->vfs_inode);
2187}
2188
2189static int __init ubifs_init(void)
2190{
2191 int err;
2192
2193 BUILD_BUG_ON(sizeof(struct ubifs_ch) != 24);
2194
2195 /* Make sure node sizes are 8-byte aligned */
2196 BUILD_BUG_ON(UBIFS_CH_SZ & 7);
2197 BUILD_BUG_ON(UBIFS_INO_NODE_SZ & 7);
2198 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ & 7);
2199 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ & 7);
2200 BUILD_BUG_ON(UBIFS_DATA_NODE_SZ & 7);
2201 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ & 7);
2202 BUILD_BUG_ON(UBIFS_SB_NODE_SZ & 7);
2203 BUILD_BUG_ON(UBIFS_MST_NODE_SZ & 7);
2204 BUILD_BUG_ON(UBIFS_REF_NODE_SZ & 7);
2205 BUILD_BUG_ON(UBIFS_CS_NODE_SZ & 7);
2206 BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ & 7);
2207
2208 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ & 7);
2209 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ & 7);
2210 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ & 7);
2211 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ & 7);
2212 BUILD_BUG_ON(UBIFS_MAX_NODE_SZ & 7);
2213 BUILD_BUG_ON(MIN_WRITE_SZ & 7);
2214
2215 /* Check min. node size */
2216 BUILD_BUG_ON(UBIFS_INO_NODE_SZ < MIN_WRITE_SZ);
2217 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ < MIN_WRITE_SZ);
2218 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ < MIN_WRITE_SZ);
2219 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ < MIN_WRITE_SZ);
2220
2221 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2222 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2223 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ > UBIFS_MAX_NODE_SZ);
2224 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ > UBIFS_MAX_NODE_SZ);
2225
2226 /* Defined node sizes */
2227 BUILD_BUG_ON(UBIFS_SB_NODE_SZ != 4096);
2228 BUILD_BUG_ON(UBIFS_MST_NODE_SZ != 512);
2229 BUILD_BUG_ON(UBIFS_INO_NODE_SZ != 160);
2230 BUILD_BUG_ON(UBIFS_REF_NODE_SZ != 64);
2231
2232 /*
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02002233 * We use 2 bit wide bit-fields to store compression type, which should
2234 * be amended if more compressors are added. The bit-fields are:
Artem Bityutskiy553dea42008-11-01 14:57:49 +02002235 * @compr_type in 'struct ubifs_inode', @default_compr in
2236 * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02002237 */
2238 BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT > 4);
2239
2240 /*
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002241 * We require that PAGE_CACHE_SIZE is greater-than-or-equal-to
2242 * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2243 */
2244 if (PAGE_CACHE_SIZE < UBIFS_BLOCK_SIZE) {
2245 ubifs_err("VFS page cache size is %u bytes, but UBIFS requires"
2246 " at least 4096 bytes",
2247 (unsigned int)PAGE_CACHE_SIZE);
2248 return -EINVAL;
2249 }
2250
2251 err = register_filesystem(&ubifs_fs_type);
2252 if (err) {
2253 ubifs_err("cannot register file system, error %d", err);
2254 return err;
2255 }
2256
2257 err = -ENOMEM;
2258 ubifs_inode_slab = kmem_cache_create("ubifs_inode_slab",
2259 sizeof(struct ubifs_inode), 0,
2260 SLAB_MEM_SPREAD | SLAB_RECLAIM_ACCOUNT,
2261 &inode_slab_ctor);
2262 if (!ubifs_inode_slab)
2263 goto out_reg;
2264
2265 register_shrinker(&ubifs_shrinker_info);
2266
2267 err = ubifs_compressors_init();
2268 if (err)
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002269 goto out_shrinker;
2270
2271 err = dbg_debugfs_init();
2272 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002273 goto out_compr;
2274
2275 return 0;
2276
2277out_compr:
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002278 ubifs_compressors_exit();
2279out_shrinker:
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002280 unregister_shrinker(&ubifs_shrinker_info);
2281 kmem_cache_destroy(ubifs_inode_slab);
2282out_reg:
2283 unregister_filesystem(&ubifs_fs_type);
2284 return err;
2285}
2286/* late_initcall to let compressors initialize first */
2287late_initcall(ubifs_init);
2288
2289static void __exit ubifs_exit(void)
2290{
2291 ubifs_assert(list_empty(&ubifs_infos));
2292 ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt) == 0);
2293
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002294 dbg_debugfs_exit();
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002295 ubifs_compressors_exit();
2296 unregister_shrinker(&ubifs_shrinker_info);
2297 kmem_cache_destroy(ubifs_inode_slab);
2298 unregister_filesystem(&ubifs_fs_type);
2299}
2300module_exit(ubifs_exit);
2301
2302MODULE_LICENSE("GPL");
2303MODULE_VERSION(__stringify(UBIFS_VERSION));
2304MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2305MODULE_DESCRIPTION("UBIFS - UBI File System");