blob: 9547a27868ad49e11151c324c8f60a7db2bc92f6 [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 = {
Dave Chinner1ab6c492013-08-28 10:18:09 +100052 .scan_objects = ubifs_shrink_scan,
53 .count_objects = ubifs_shrink_count,
Artem Bityutskiy1e517642008-07-14 19:08:37 +030054 .seeks = DEFAULT_SEEKS,
55};
56
57/**
58 * validate_inode - validate inode.
59 * @c: UBIFS file-system description object
60 * @inode: the inode to validate
61 *
62 * This is a helper function for 'ubifs_iget()' which validates various fields
63 * of a newly built inode to make sure they contain sane values and prevent
64 * possible vulnerabilities. Returns zero if the inode is all right and
65 * a non-zero error code if not.
66 */
67static int validate_inode(struct ubifs_info *c, const struct inode *inode)
68{
69 int err;
70 const struct ubifs_inode *ui = ubifs_inode(inode);
71
72 if (inode->i_size > c->max_inode_sz) {
Sheng Yong235c3622015-03-20 10:39:42 +000073 ubifs_err(c, "inode is too large (%lld)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +030074 (long long)inode->i_size);
75 return 1;
76 }
77
hujianyangb793a8c2014-06-11 10:42:52 +080078 if (ui->compr_type >= UBIFS_COMPR_TYPES_CNT) {
Sheng Yong235c3622015-03-20 10:39:42 +000079 ubifs_err(c, "unknown compression type %d", ui->compr_type);
Artem Bityutskiy1e517642008-07-14 19:08:37 +030080 return 2;
81 }
82
83 if (ui->xattr_names + ui->xattr_cnt > XATTR_LIST_MAX)
84 return 3;
85
86 if (ui->data_len < 0 || ui->data_len > UBIFS_MAX_INO_DATA)
87 return 4;
88
Artem Bityutskiya29fa9d2011-05-26 09:43:34 +030089 if (ui->xattr && !S_ISREG(inode->i_mode))
Artem Bityutskiy1e517642008-07-14 19:08:37 +030090 return 5;
91
92 if (!ubifs_compr_present(ui->compr_type)) {
Sheng Yong235c3622015-03-20 10:39:42 +000093 ubifs_warn(c, "inode %lu uses '%s' compression, but it was not compiled in",
Artem Bityutskiy79fda512012-08-27 13:34:09 +030094 inode->i_ino, ubifs_compr_name(ui->compr_type));
Artem Bityutskiy1e517642008-07-14 19:08:37 +030095 }
96
Artem Bityutskiy1b51e982011-05-25 17:38:29 +030097 err = dbg_check_dir(c, inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +030098 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);
Miklos Szeredibfe86842011-10-28 14:13:29 +0200132 set_nlink(inode, le32_to_cpu(ino->nlink));
Eric W. Biederman39241be2012-02-07 15:50:56 -0800133 i_uid_write(inode, le32_to_cpu(ino->uid));
134 i_gid_write(inode, le32_to_cpu(ino->gid));
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300135 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 Bityutskiy1e517642008-07-14 19:08:37 +0300159 switch (inode->i_mode & S_IFMT) {
160 case S_IFREG:
161 inode->i_mapping->a_ops = &ubifs_file_address_operations;
162 inode->i_op = &ubifs_file_inode_operations;
163 inode->i_fop = &ubifs_file_operations;
164 if (ui->xattr) {
165 ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
166 if (!ui->data) {
167 err = -ENOMEM;
168 goto out_ino;
169 }
170 memcpy(ui->data, ino->data, ui->data_len);
171 ((char *)ui->data)[ui->data_len] = '\0';
172 } else if (ui->data_len != 0) {
173 err = 10;
174 goto out_invalid;
175 }
176 break;
177 case S_IFDIR:
178 inode->i_op = &ubifs_dir_inode_operations;
179 inode->i_fop = &ubifs_dir_operations;
180 if (ui->data_len != 0) {
181 err = 11;
182 goto out_invalid;
183 }
184 break;
185 case S_IFLNK:
186 inode->i_op = &ubifs_symlink_inode_operations;
187 if (ui->data_len <= 0 || ui->data_len > UBIFS_MAX_INO_DATA) {
188 err = 12;
189 goto out_invalid;
190 }
191 ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
192 if (!ui->data) {
193 err = -ENOMEM;
194 goto out_ino;
195 }
196 memcpy(ui->data, ino->data, ui->data_len);
197 ((char *)ui->data)[ui->data_len] = '\0';
Al Viro0f301bd2015-05-02 10:35:42 -0400198 inode->i_link = ui->data;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300199 break;
200 case S_IFBLK:
201 case S_IFCHR:
202 {
203 dev_t rdev;
204 union ubifs_dev_desc *dev;
205
206 ui->data = kmalloc(sizeof(union ubifs_dev_desc), GFP_NOFS);
207 if (!ui->data) {
208 err = -ENOMEM;
209 goto out_ino;
210 }
211
212 dev = (union ubifs_dev_desc *)ino->data;
213 if (ui->data_len == sizeof(dev->new))
214 rdev = new_decode_dev(le32_to_cpu(dev->new));
215 else if (ui->data_len == sizeof(dev->huge))
216 rdev = huge_decode_dev(le64_to_cpu(dev->huge));
217 else {
218 err = 13;
219 goto out_invalid;
220 }
221 memcpy(ui->data, ino->data, ui->data_len);
222 inode->i_op = &ubifs_file_inode_operations;
223 init_special_inode(inode, inode->i_mode, rdev);
224 break;
225 }
226 case S_IFSOCK:
227 case S_IFIFO:
228 inode->i_op = &ubifs_file_inode_operations;
229 init_special_inode(inode, inode->i_mode, 0);
230 if (ui->data_len != 0) {
231 err = 14;
232 goto out_invalid;
233 }
234 break;
235 default:
236 err = 15;
237 goto out_invalid;
238 }
239
240 kfree(ino);
241 ubifs_set_inode_flags(inode);
242 unlock_new_inode(inode);
243 return inode;
244
245out_invalid:
Sheng Yong235c3622015-03-20 10:39:42 +0000246 ubifs_err(c, "inode %lu validation failed, error %d", inode->i_ino, err);
Artem Bityutskiyedf6be22012-05-16 19:15:56 +0300247 ubifs_dump_node(c, ino);
248 ubifs_dump_inode(c, inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300249 err = -EINVAL;
250out_ino:
251 kfree(ino);
252out:
Sheng Yong235c3622015-03-20 10:39:42 +0000253 ubifs_err(c, "failed to read inode %lu, error %d", inode->i_ino, err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300254 iget_failed(inode);
255 return ERR_PTR(err);
256}
257
258static struct inode *ubifs_alloc_inode(struct super_block *sb)
259{
260 struct ubifs_inode *ui;
261
262 ui = kmem_cache_alloc(ubifs_inode_slab, GFP_NOFS);
263 if (!ui)
264 return NULL;
265
266 memset((void *)ui + sizeof(struct inode), 0,
267 sizeof(struct ubifs_inode) - sizeof(struct inode));
268 mutex_init(&ui->ui_mutex);
269 spin_lock_init(&ui->ui_lock);
270 return &ui->vfs_inode;
271};
272
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100273static void ubifs_i_callback(struct rcu_head *head)
274{
275 struct inode *inode = container_of(head, struct inode, i_rcu);
276 struct ubifs_inode *ui = ubifs_inode(inode);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100277 kmem_cache_free(ubifs_inode_slab, ui);
278}
279
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300280static void ubifs_destroy_inode(struct inode *inode)
281{
282 struct ubifs_inode *ui = ubifs_inode(inode);
283
284 kfree(ui->data);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100285 call_rcu(&inode->i_rcu, ubifs_i_callback);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300286}
287
288/*
289 * Note, Linux write-back code calls this without 'i_mutex'.
290 */
Christoph Hellwiga9185b42010-03-05 09:21:37 +0100291static int ubifs_write_inode(struct inode *inode, struct writeback_control *wbc)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300292{
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300293 int err = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300294 struct ubifs_info *c = inode->i_sb->s_fs_info;
295 struct ubifs_inode *ui = ubifs_inode(inode);
296
297 ubifs_assert(!ui->xattr);
298 if (is_bad_inode(inode))
299 return 0;
300
301 mutex_lock(&ui->ui_mutex);
302 /*
303 * Due to races between write-back forced by budgeting
Artem Bityutskiy5c57f202012-07-25 18:12:14 +0300304 * (see 'sync_some_inodes()') and background write-back, the inode may
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300305 * have already been synchronized, do not do this again. This might
306 * also happen if it was synchronized in an VFS operation, e.g.
307 * 'ubifs_link()'.
308 */
309 if (!ui->dirty) {
310 mutex_unlock(&ui->ui_mutex);
311 return 0;
312 }
313
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300314 /*
315 * As an optimization, do not write orphan inodes to the media just
316 * because this is not needed.
317 */
318 dbg_gen("inode %lu, mode %#x, nlink %u",
319 inode->i_ino, (int)inode->i_mode, inode->i_nlink);
320 if (inode->i_nlink) {
Artem Bityutskiy1f286812008-07-22 12:06:13 +0300321 err = ubifs_jnl_write_inode(c, inode);
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300322 if (err)
Sheng Yong235c3622015-03-20 10:39:42 +0000323 ubifs_err(c, "can't write inode %lu, error %d",
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300324 inode->i_ino, err);
Artem Bityutskiye3c3efc2009-08-27 16:34:19 +0300325 else
326 err = dbg_check_inode_size(c, inode, ui->ui_size);
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300327 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300328
329 ui->dirty = 0;
330 mutex_unlock(&ui->ui_mutex);
331 ubifs_release_dirty_inode_budget(c, ui);
332 return err;
333}
334
Al Virod640e1b2010-06-07 00:34:05 -0400335static void ubifs_evict_inode(struct inode *inode)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300336{
337 int err;
338 struct ubifs_info *c = inode->i_sb->s_fs_info;
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300339 struct ubifs_inode *ui = ubifs_inode(inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300340
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300341 if (ui->xattr)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300342 /*
343 * Extended attribute inode deletions are fully handled in
344 * 'ubifs_removexattr()'. These inodes are special and have
345 * limited usage, so there is nothing to do here.
346 */
347 goto out;
348
Artem Bityutskiy7d32c2b2008-07-18 18:54:29 +0300349 dbg_gen("inode %lu, mode %#x", inode->i_ino, (int)inode->i_mode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300350 ubifs_assert(!atomic_read(&inode->i_count));
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300351
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700352 truncate_inode_pages_final(&inode->i_data);
Al Virod640e1b2010-06-07 00:34:05 -0400353
354 if (inode->i_nlink)
355 goto done;
356
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300357 if (is_bad_inode(inode))
358 goto out;
359
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300360 ui->ui_size = inode->i_size = 0;
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300361 err = ubifs_jnl_delete_inode(c, inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300362 if (err)
363 /*
364 * Worst case we have a lost orphan inode wasting space, so a
Artem Bityutskiy0a883a02008-08-13 14:13:26 +0300365 * simple error message is OK here.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300366 */
Sheng Yong235c3622015-03-20 10:39:42 +0000367 ubifs_err(c, "can't delete inode %lu, error %d",
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300368 inode->i_ino, err);
369
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300370out:
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300371 if (ui->dirty)
372 ubifs_release_dirty_inode_budget(c, ui);
Adrian Hunter6d6cb0d2009-04-08 14:07:57 +0200373 else {
374 /* We've deleted something - clean the "no space" flags */
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300375 c->bi.nospace = c->bi.nospace_rp = 0;
Adrian Hunter6d6cb0d2009-04-08 14:07:57 +0200376 smp_wmb();
377 }
Al Virod640e1b2010-06-07 00:34:05 -0400378done:
Jan Karadbd57682012-05-03 14:48:02 +0200379 clear_inode(inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300380}
381
Christoph Hellwigaa385722011-05-27 06:53:02 -0400382static void ubifs_dirty_inode(struct inode *inode, int flags)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300383{
384 struct ubifs_inode *ui = ubifs_inode(inode);
385
386 ubifs_assert(mutex_is_locked(&ui->ui_mutex));
387 if (!ui->dirty) {
388 ui->dirty = 1;
389 dbg_gen("inode %lu", inode->i_ino);
390 }
391}
392
393static int ubifs_statfs(struct dentry *dentry, struct kstatfs *buf)
394{
395 struct ubifs_info *c = dentry->d_sb->s_fs_info;
396 unsigned long long free;
Artem Bityutskiy7c7cbad2008-09-03 14:16:42 +0300397 __le32 *uuid = (__le32 *)c->uuid;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300398
Artem Bityutskiy7dad1812008-08-25 18:58:19 +0300399 free = ubifs_get_free_space(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300400 dbg_gen("free space %lld bytes (%lld blocks)",
401 free, free >> UBIFS_BLOCK_SHIFT);
402
403 buf->f_type = UBIFS_SUPER_MAGIC;
404 buf->f_bsize = UBIFS_BLOCK_SIZE;
405 buf->f_blocks = c->block_cnt;
406 buf->f_bfree = free >> UBIFS_BLOCK_SHIFT;
407 if (free > c->report_rp_size)
408 buf->f_bavail = (free - c->report_rp_size) >> UBIFS_BLOCK_SHIFT;
409 else
410 buf->f_bavail = 0;
411 buf->f_files = 0;
412 buf->f_ffree = 0;
413 buf->f_namelen = UBIFS_MAX_NLEN;
Artem Bityutskiy7c7cbad2008-09-03 14:16:42 +0300414 buf->f_fsid.val[0] = le32_to_cpu(uuid[0]) ^ le32_to_cpu(uuid[2]);
415 buf->f_fsid.val[1] = le32_to_cpu(uuid[1]) ^ le32_to_cpu(uuid[3]);
Artem Bityutskiyb4978e92009-01-23 18:23:03 +0200416 ubifs_assert(buf->f_bfree <= c->block_cnt);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300417 return 0;
418}
419
Al Viro34c80b12011-12-08 21:32:45 -0500420static int ubifs_show_options(struct seq_file *s, struct dentry *root)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300421{
Al Viro34c80b12011-12-08 21:32:45 -0500422 struct ubifs_info *c = root->d_sb->s_fs_info;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300423
424 if (c->mount_opts.unmount_mode == 2)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200425 seq_puts(s, ",fast_unmount");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300426 else if (c->mount_opts.unmount_mode == 1)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200427 seq_puts(s, ",norm_unmount");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300428
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300429 if (c->mount_opts.bulk_read == 2)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200430 seq_puts(s, ",bulk_read");
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300431 else if (c->mount_opts.bulk_read == 1)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200432 seq_puts(s, ",no_bulk_read");
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300433
Adrian Hunter2953e732008-09-04 16:26:00 +0300434 if (c->mount_opts.chk_data_crc == 2)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200435 seq_puts(s, ",chk_data_crc");
Adrian Hunter2953e732008-09-04 16:26:00 +0300436 else if (c->mount_opts.chk_data_crc == 1)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200437 seq_puts(s, ",no_chk_data_crc");
Adrian Hunter2953e732008-09-04 16:26:00 +0300438
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200439 if (c->mount_opts.override_compr) {
Hunter Adrianfcabb342009-03-18 12:29:39 +0100440 seq_printf(s, ",compr=%s",
441 ubifs_compr_name(c->mount_opts.compr_type));
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200442 }
443
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300444 return 0;
445}
446
447static int ubifs_sync_fs(struct super_block *sb, int wait)
448{
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200449 int i, err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300450 struct ubifs_info *c = sb->s_fs_info;
Artem Bityutskiy304d4272008-12-28 08:04:17 +0200451
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800452 /*
Artem Bityutskiydedb0d42009-01-09 21:02:37 +0200453 * Zero @wait is just an advisory thing to help the file system shove
454 * lots of data into the queues, and there will be the second
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800455 * '->sync_fs()' call, with non-zero @wait.
456 */
Artem Bityutskiydedb0d42009-01-09 21:02:37 +0200457 if (!wait)
458 return 0;
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800459
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200460 /*
Adrian Hunter3eb14292009-01-29 11:17:24 +0200461 * Synchronize write buffers, because 'ubifs_run_commit()' does not
462 * do this if it waits for an already running commit.
463 */
464 for (i = 0; i < c->jhead_cnt; i++) {
465 err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
466 if (err)
467 return err;
468 }
469
Artem Bityutskiy887ee172009-07-20 17:56:19 +0300470 /*
471 * Strictly speaking, it is not necessary to commit the journal here,
472 * synchronizing write-buffers would be enough. But committing makes
473 * UBIFS free space predictions much more accurate, so we want to let
474 * the user be able to get more accurate results of 'statfs()' after
475 * they synchronize the file system.
476 */
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200477 err = ubifs_run_commit(c);
478 if (err)
479 return err;
Artem Bityutskiy403e12a2008-09-09 12:31:37 +0300480
Artem Bityutskiycb5c6a22008-12-28 08:18:43 +0200481 return ubi_sync(c->vi.ubi_num);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300482}
483
484/**
485 * init_constants_early - initialize UBIFS constants.
486 * @c: UBIFS file-system description object
487 *
488 * This function initialize UBIFS constants which do not need the superblock to
489 * be read. It also checks that the UBI volume satisfies basic UBIFS
490 * requirements. Returns zero in case of success and a negative error code in
491 * case of failure.
492 */
493static int init_constants_early(struct ubifs_info *c)
494{
495 if (c->vi.corrupted) {
Sheng Yong235c3622015-03-20 10:39:42 +0000496 ubifs_warn(c, "UBI volume is corrupted - read-only mode");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300497 c->ro_media = 1;
498 }
499
500 if (c->di.ro_mode) {
Sheng Yong235c3622015-03-20 10:39:42 +0000501 ubifs_msg(c, "read-only UBI device");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300502 c->ro_media = 1;
503 }
504
505 if (c->vi.vol_type == UBI_STATIC_VOLUME) {
Sheng Yong235c3622015-03-20 10:39:42 +0000506 ubifs_msg(c, "static UBI volume - read-only mode");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300507 c->ro_media = 1;
508 }
509
510 c->leb_cnt = c->vi.size;
511 c->leb_size = c->vi.usable_leb_size;
Artem Bityutskiyca2ec612011-02-14 15:17:55 +0200512 c->leb_start = c->di.leb_start;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300513 c->half_leb_size = c->leb_size / 2;
514 c->min_io_size = c->di.min_io_size;
515 c->min_io_shift = fls(c->min_io_size) - 1;
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200516 c->max_write_size = c->di.max_write_size;
517 c->max_write_shift = fls(c->max_write_size) - 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300518
519 if (c->leb_size < UBIFS_MIN_LEB_SZ) {
Sheng Yong235c3622015-03-20 10:39:42 +0000520 ubifs_err(c, "too small LEBs (%d bytes), min. is %d bytes",
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300521 c->leb_size, UBIFS_MIN_LEB_SZ);
522 return -EINVAL;
523 }
524
525 if (c->leb_cnt < UBIFS_MIN_LEB_CNT) {
Sheng Yong235c3622015-03-20 10:39:42 +0000526 ubifs_err(c, "too few LEBs (%d), min. is %d",
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300527 c->leb_cnt, UBIFS_MIN_LEB_CNT);
528 return -EINVAL;
529 }
530
531 if (!is_power_of_2(c->min_io_size)) {
Sheng Yong235c3622015-03-20 10:39:42 +0000532 ubifs_err(c, "bad min. I/O size %d", c->min_io_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300533 return -EINVAL;
534 }
535
536 /*
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200537 * Maximum write size has to be greater or equivalent to min. I/O
538 * size, and be multiple of min. I/O size.
539 */
540 if (c->max_write_size < c->min_io_size ||
541 c->max_write_size % c->min_io_size ||
542 !is_power_of_2(c->max_write_size)) {
Sheng Yong235c3622015-03-20 10:39:42 +0000543 ubifs_err(c, "bad write buffer size %d for %d min. I/O unit",
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200544 c->max_write_size, c->min_io_size);
545 return -EINVAL;
546 }
547
548 /*
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300549 * UBIFS aligns all node to 8-byte boundary, so to make function in
550 * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
551 * less than 8.
552 */
553 if (c->min_io_size < 8) {
554 c->min_io_size = 8;
555 c->min_io_shift = 3;
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200556 if (c->max_write_size < c->min_io_size) {
557 c->max_write_size = c->min_io_size;
558 c->max_write_shift = c->min_io_shift;
559 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300560 }
561
562 c->ref_node_alsz = ALIGN(UBIFS_REF_NODE_SZ, c->min_io_size);
563 c->mst_node_alsz = ALIGN(UBIFS_MST_NODE_SZ, c->min_io_size);
564
565 /*
566 * Initialize node length ranges which are mostly needed for node
567 * length validation.
568 */
569 c->ranges[UBIFS_PAD_NODE].len = UBIFS_PAD_NODE_SZ;
570 c->ranges[UBIFS_SB_NODE].len = UBIFS_SB_NODE_SZ;
571 c->ranges[UBIFS_MST_NODE].len = UBIFS_MST_NODE_SZ;
572 c->ranges[UBIFS_REF_NODE].len = UBIFS_REF_NODE_SZ;
573 c->ranges[UBIFS_TRUN_NODE].len = UBIFS_TRUN_NODE_SZ;
574 c->ranges[UBIFS_CS_NODE].len = UBIFS_CS_NODE_SZ;
575
576 c->ranges[UBIFS_INO_NODE].min_len = UBIFS_INO_NODE_SZ;
577 c->ranges[UBIFS_INO_NODE].max_len = UBIFS_MAX_INO_NODE_SZ;
578 c->ranges[UBIFS_ORPH_NODE].min_len =
579 UBIFS_ORPH_NODE_SZ + sizeof(__le64);
580 c->ranges[UBIFS_ORPH_NODE].max_len = c->leb_size;
581 c->ranges[UBIFS_DENT_NODE].min_len = UBIFS_DENT_NODE_SZ;
582 c->ranges[UBIFS_DENT_NODE].max_len = UBIFS_MAX_DENT_NODE_SZ;
583 c->ranges[UBIFS_XENT_NODE].min_len = UBIFS_XENT_NODE_SZ;
584 c->ranges[UBIFS_XENT_NODE].max_len = UBIFS_MAX_XENT_NODE_SZ;
585 c->ranges[UBIFS_DATA_NODE].min_len = UBIFS_DATA_NODE_SZ;
586 c->ranges[UBIFS_DATA_NODE].max_len = UBIFS_MAX_DATA_NODE_SZ;
587 /*
588 * Minimum indexing node size is amended later when superblock is
589 * read and the key length is known.
590 */
591 c->ranges[UBIFS_IDX_NODE].min_len = UBIFS_IDX_NODE_SZ + UBIFS_BRANCH_SZ;
592 /*
593 * Maximum indexing node size is amended later when superblock is
594 * read and the fanout is known.
595 */
596 c->ranges[UBIFS_IDX_NODE].max_len = INT_MAX;
597
598 /*
Artem Bityutskiy70782022009-01-19 19:57:27 +0200599 * Initialize dead and dark LEB space watermarks. See gc.c for comments
600 * about these values.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300601 */
602 c->dead_wm = ALIGN(MIN_WRITE_SZ, c->min_io_size);
603 c->dark_wm = ALIGN(UBIFS_MAX_NODE_SZ, c->min_io_size);
604
Artem Bityutskiy9bbb5722008-08-22 18:23:22 +0300605 /*
606 * Calculate how many bytes would be wasted at the end of LEB if it was
607 * fully filled with data nodes of maximum size. This is used in
608 * calculations when reporting free space.
609 */
610 c->leb_overhead = c->leb_size % UBIFS_MAX_DATA_NODE_SZ;
Artem Bityutskiy39ce81c2008-11-18 18:09:49 +0200611
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300612 /* Buffer size for bulk-reads */
Artem Bityutskiy6c0c42c2008-11-18 20:20:05 +0200613 c->max_bu_buf_len = UBIFS_MAX_BULK_READ * UBIFS_MAX_DATA_NODE_SZ;
614 if (c->max_bu_buf_len > c->leb_size)
615 c->max_bu_buf_len = c->leb_size;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300616 return 0;
617}
618
619/**
620 * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
621 * @c: UBIFS file-system description object
622 * @lnum: LEB the write-buffer was synchronized to
623 * @free: how many free bytes left in this LEB
624 * @pad: how many bytes were padded
625 *
626 * This is a callback function which is called by the I/O unit when the
627 * write-buffer is synchronized. We need this to correctly maintain space
628 * accounting in bud logical eraseblocks. This function returns zero in case of
629 * success and a negative error code in case of failure.
630 *
631 * This function actually belongs to the journal, but we keep it here because
632 * we want to keep it static.
633 */
634static int bud_wbuf_callback(struct ubifs_info *c, int lnum, int free, int pad)
635{
636 return ubifs_update_one_lp(c, lnum, free, pad, 0, 0);
637}
638
639/*
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200640 * init_constants_sb - initialize UBIFS constants.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300641 * @c: UBIFS file-system description object
642 *
643 * This is a helper function which initializes various UBIFS constants after
644 * the superblock has been read. It also checks various UBIFS parameters and
645 * makes sure they are all right. Returns zero in case of success and a
646 * negative error code in case of failure.
647 */
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200648static int init_constants_sb(struct ubifs_info *c)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300649{
650 int tmp, err;
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200651 long long tmp64;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300652
653 c->main_bytes = (long long)c->main_lebs * c->leb_size;
654 c->max_znode_sz = sizeof(struct ubifs_znode) +
655 c->fanout * sizeof(struct ubifs_zbranch);
656
657 tmp = ubifs_idx_node_sz(c, 1);
658 c->ranges[UBIFS_IDX_NODE].min_len = tmp;
659 c->min_idx_node_sz = ALIGN(tmp, 8);
660
661 tmp = ubifs_idx_node_sz(c, c->fanout);
662 c->ranges[UBIFS_IDX_NODE].max_len = tmp;
663 c->max_idx_node_sz = ALIGN(tmp, 8);
664
665 /* Make sure LEB size is large enough to fit full commit */
666 tmp = UBIFS_CS_NODE_SZ + UBIFS_REF_NODE_SZ * c->jhead_cnt;
667 tmp = ALIGN(tmp, c->min_io_size);
668 if (tmp > c->leb_size) {
Sheng Yong235c3622015-03-20 10:39:42 +0000669 ubifs_err(c, "too small LEB size %d, at least %d needed",
Artem Bityutskiya6aae4d2012-05-16 20:11:23 +0300670 c->leb_size, tmp);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300671 return -EINVAL;
672 }
673
674 /*
675 * Make sure that the log is large enough to fit reference nodes for
676 * all buds plus one reserved LEB.
677 */
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200678 tmp64 = c->max_bud_bytes + c->leb_size - 1;
679 c->max_bud_cnt = div_u64(tmp64, c->leb_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300680 tmp = (c->ref_node_alsz * c->max_bud_cnt + c->leb_size - 1);
681 tmp /= c->leb_size;
682 tmp += 1;
683 if (c->log_lebs < tmp) {
Sheng Yong235c3622015-03-20 10:39:42 +0000684 ubifs_err(c, "too small log %d LEBs, required min. %d LEBs",
Artem Bityutskiya6aae4d2012-05-16 20:11:23 +0300685 c->log_lebs, tmp);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300686 return -EINVAL;
687 }
688
689 /*
690 * When budgeting we assume worst-case scenarios when the pages are not
691 * be compressed and direntries are of the maximum size.
692 *
693 * Note, data, which may be stored in inodes is budgeted separately, so
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300694 * it is not included into 'c->bi.inode_budget'.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300695 */
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300696 c->bi.page_budget = UBIFS_MAX_DATA_NODE_SZ * UBIFS_BLOCKS_PER_PAGE;
697 c->bi.inode_budget = UBIFS_INO_NODE_SZ;
698 c->bi.dent_budget = UBIFS_MAX_DENT_NODE_SZ;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300699
700 /*
701 * When the amount of flash space used by buds becomes
702 * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
703 * The writers are unblocked when the commit is finished. To avoid
704 * writers to be blocked UBIFS initiates background commit in advance,
705 * when number of bud bytes becomes above the limit defined below.
706 */
707 c->bg_bud_bytes = (c->max_bud_bytes * 13) >> 4;
708
709 /*
710 * Ensure minimum journal size. All the bytes in the journal heads are
711 * considered to be used, when calculating the current journal usage.
712 * Consequently, if the journal is too small, UBIFS will treat it as
713 * always full.
714 */
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200715 tmp64 = (long long)(c->jhead_cnt + 1) * c->leb_size + 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300716 if (c->bg_bud_bytes < tmp64)
717 c->bg_bud_bytes = tmp64;
718 if (c->max_bud_bytes < tmp64 + c->leb_size)
719 c->max_bud_bytes = tmp64 + c->leb_size;
720
721 err = ubifs_calc_lpt_geom(c);
722 if (err)
723 return err;
724
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +0200725 /* Initialize effective LEB size used in budgeting calculations */
726 c->idx_leb_size = c->leb_size - c->max_idx_node_sz;
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200727 return 0;
728}
729
730/*
731 * init_constants_master - initialize UBIFS constants.
732 * @c: UBIFS file-system description object
733 *
734 * This is a helper function which initializes various UBIFS constants after
735 * the master node has been read. It also checks various UBIFS parameters and
736 * makes sure they are all right.
737 */
738static void init_constants_master(struct ubifs_info *c)
739{
740 long long tmp64;
741
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300742 c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +0200743 c->report_rp_size = ubifs_reported_space(c, c->rp_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300744
745 /*
746 * Calculate total amount of FS blocks. This number is not used
747 * internally because it does not make much sense for UBIFS, but it is
748 * necessary to report something for the 'statfs()' call.
749 *
Artem Bityutskiy7dad1812008-08-25 18:58:19 +0300750 * Subtract the LEB reserved for GC, the LEB which is reserved for
Artem Bityutskiyaf14a1a2008-12-19 19:26:29 +0200751 * deletions, minimum LEBs for the index, and assume only one journal
752 * head is available.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300753 */
Artem Bityutskiyaf14a1a2008-12-19 19:26:29 +0200754 tmp64 = c->main_lebs - 1 - 1 - MIN_INDEX_LEBS - c->jhead_cnt + 1;
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200755 tmp64 *= (long long)c->leb_size - c->leb_overhead;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300756 tmp64 = ubifs_reported_space(c, tmp64);
757 c->block_cnt = tmp64 >> UBIFS_BLOCK_SHIFT;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300758}
759
760/**
761 * take_gc_lnum - reserve GC LEB.
762 * @c: UBIFS file-system description object
763 *
Artem Bityutskiyb4978e92009-01-23 18:23:03 +0200764 * This function ensures that the LEB reserved for garbage collection is marked
765 * as "taken" in lprops. We also have to set free space to LEB size and dirty
766 * space to zero, because lprops may contain out-of-date information if the
767 * file-system was un-mounted before it has been committed. This function
768 * returns zero in case of success and a negative error code in case of
769 * failure.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300770 */
771static int take_gc_lnum(struct ubifs_info *c)
772{
773 int err;
774
775 if (c->gc_lnum == -1) {
Sheng Yong235c3622015-03-20 10:39:42 +0000776 ubifs_err(c, "no LEB for GC");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300777 return -EINVAL;
778 }
779
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300780 /* And we have to tell lprops that this LEB is taken */
781 err = ubifs_change_one_lp(c, c->gc_lnum, c->leb_size, 0,
782 LPROPS_TAKEN, 0, 0);
783 return err;
784}
785
786/**
787 * alloc_wbufs - allocate write-buffers.
788 * @c: UBIFS file-system description object
789 *
790 * This helper function allocates and initializes UBIFS write-buffers. Returns
791 * zero in case of success and %-ENOMEM in case of failure.
792 */
793static int alloc_wbufs(struct ubifs_info *c)
794{
795 int i, err;
796
Fabian Frederick86b4c142014-06-23 18:41:23 +0200797 c->jheads = kcalloc(c->jhead_cnt, sizeof(struct ubifs_jhead),
798 GFP_KERNEL);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300799 if (!c->jheads)
800 return -ENOMEM;
801
802 /* Initialize journal heads */
803 for (i = 0; i < c->jhead_cnt; i++) {
804 INIT_LIST_HEAD(&c->jheads[i].buds_list);
805 err = ubifs_wbuf_init(c, &c->jheads[i].wbuf);
806 if (err)
807 return err;
808
809 c->jheads[i].wbuf.sync_callback = &bud_wbuf_callback;
810 c->jheads[i].wbuf.jhead = i;
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300811 c->jheads[i].grouped = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300812 }
813
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300814 /*
Artem Bityutskiy44156262012-05-14 19:49:35 +0300815 * Garbage Collector head does not need to be synchronized by timer.
816 * Also GC head nodes are not grouped.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300817 */
Artem Bityutskiy0b335b92009-06-23 12:30:43 +0300818 c->jheads[GCHD].wbuf.no_timer = 1;
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300819 c->jheads[GCHD].grouped = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300820
821 return 0;
822}
823
824/**
825 * free_wbufs - free write-buffers.
826 * @c: UBIFS file-system description object
827 */
828static void free_wbufs(struct ubifs_info *c)
829{
830 int i;
831
832 if (c->jheads) {
833 for (i = 0; i < c->jhead_cnt; i++) {
834 kfree(c->jheads[i].wbuf.buf);
835 kfree(c->jheads[i].wbuf.inodes);
836 }
837 kfree(c->jheads);
838 c->jheads = NULL;
839 }
840}
841
842/**
843 * free_orphans - free orphans.
844 * @c: UBIFS file-system description object
845 */
846static void free_orphans(struct ubifs_info *c)
847{
848 struct ubifs_orphan *orph;
849
850 while (c->orph_dnext) {
851 orph = c->orph_dnext;
852 c->orph_dnext = orph->dnext;
853 list_del(&orph->list);
854 kfree(orph);
855 }
856
857 while (!list_empty(&c->orph_list)) {
858 orph = list_entry(c->orph_list.next, struct ubifs_orphan, list);
859 list_del(&orph->list);
860 kfree(orph);
Sheng Yong235c3622015-03-20 10:39:42 +0000861 ubifs_err(c, "orphan list not empty at unmount");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300862 }
863
864 vfree(c->orph_buf);
865 c->orph_buf = NULL;
866}
867
868/**
869 * free_buds - free per-bud objects.
870 * @c: UBIFS file-system description object
871 */
872static void free_buds(struct ubifs_info *c)
873{
Cody P Schaferbb25e492014-01-23 15:56:08 -0800874 struct ubifs_bud *bud, *n;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300875
Cody P Schaferbb25e492014-01-23 15:56:08 -0800876 rbtree_postorder_for_each_entry_safe(bud, n, &c->buds, rb)
877 kfree(bud);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300878}
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 */
889static 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++) {
Artem Bityutskiyd3b25782011-06-03 14:22:05 +0300895 err = ubifs_is_mapped(c, lnum);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300896 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
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300914 * Opt_bulk_read: enable bulk-reads
915 * Opt_no_bulk_read: disable bulk-reads
Adrian Hunter2953e732008-09-04 16:26:00 +0300916 * Opt_chk_data_crc: check CRCs when reading data nodes
917 * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200918 * Opt_override_compr: override default compressor
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300919 * Opt_err: just end of array marker
920 */
921enum {
922 Opt_fast_unmount,
923 Opt_norm_unmount,
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300924 Opt_bulk_read,
925 Opt_no_bulk_read,
Adrian Hunter2953e732008-09-04 16:26:00 +0300926 Opt_chk_data_crc,
927 Opt_no_chk_data_crc,
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200928 Opt_override_compr,
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300929 Opt_err,
930};
931
Steven Whitehousea447c092008-10-13 10:46:57 +0100932static const match_table_t tokens = {
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300933 {Opt_fast_unmount, "fast_unmount"},
934 {Opt_norm_unmount, "norm_unmount"},
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300935 {Opt_bulk_read, "bulk_read"},
936 {Opt_no_bulk_read, "no_bulk_read"},
Adrian Hunter2953e732008-09-04 16:26:00 +0300937 {Opt_chk_data_crc, "chk_data_crc"},
938 {Opt_no_chk_data_crc, "no_chk_data_crc"},
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200939 {Opt_override_compr, "compr=%s"},
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300940 {Opt_err, NULL},
941};
942
943/**
Artem Bityutskiy8379ea32009-05-29 12:34:52 +0300944 * parse_standard_option - parse a standard mount option.
945 * @option: the option to parse
946 *
947 * Normally, standard mount options like "sync" are passed to file-systems as
948 * flags. However, when a "rootflags=" kernel boot parameter is used, they may
949 * be present in the options string. This function tries to deal with this
950 * situation and parse standard options. Returns 0 if the option was not
951 * recognized, and the corresponding integer flag if it was.
952 *
953 * UBIFS is only interested in the "sync" option, so do not check for anything
954 * else.
955 */
956static int parse_standard_option(const char *option)
957{
Sheng Yong235c3622015-03-20 10:39:42 +0000958
959 pr_notice("UBIFS: parse %s\n", option);
Artem Bityutskiy8379ea32009-05-29 12:34:52 +0300960 if (!strcmp(option, "sync"))
961 return MS_SYNCHRONOUS;
962 return 0;
963}
964
965/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300966 * ubifs_parse_options - parse mount parameters.
967 * @c: UBIFS file-system description object
968 * @options: parameters to parse
969 * @is_remount: non-zero if this is FS re-mount
970 *
971 * This function parses UBIFS mount options and returns zero in case success
972 * and a negative error code in case of failure.
973 */
974static int ubifs_parse_options(struct ubifs_info *c, char *options,
975 int is_remount)
976{
977 char *p;
978 substring_t args[MAX_OPT_ARGS];
979
980 if (!options)
981 return 0;
982
983 while ((p = strsep(&options, ","))) {
984 int token;
985
986 if (!*p)
987 continue;
988
989 token = match_token(p, tokens, args);
990 switch (token) {
Artem Bityutskiy27ad2792009-01-29 16:34:30 +0200991 /*
992 * %Opt_fast_unmount and %Opt_norm_unmount options are ignored.
Artem Bityutskiycb54ef82009-06-23 20:30:32 +0300993 * We accept them in order to be backward-compatible. But this
Artem Bityutskiy27ad2792009-01-29 16:34:30 +0200994 * should be removed at some point.
995 */
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300996 case Opt_fast_unmount:
997 c->mount_opts.unmount_mode = 2;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300998 break;
999 case Opt_norm_unmount:
1000 c->mount_opts.unmount_mode = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001001 break;
Adrian Hunter4793e7c2008-09-02 16:29:46 +03001002 case Opt_bulk_read:
1003 c->mount_opts.bulk_read = 2;
1004 c->bulk_read = 1;
1005 break;
1006 case Opt_no_bulk_read:
1007 c->mount_opts.bulk_read = 1;
1008 c->bulk_read = 0;
1009 break;
Adrian Hunter2953e732008-09-04 16:26:00 +03001010 case Opt_chk_data_crc:
1011 c->mount_opts.chk_data_crc = 2;
1012 c->no_chk_data_crc = 0;
1013 break;
1014 case Opt_no_chk_data_crc:
1015 c->mount_opts.chk_data_crc = 1;
1016 c->no_chk_data_crc = 1;
1017 break;
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001018 case Opt_override_compr:
1019 {
1020 char *name = match_strdup(&args[0]);
1021
1022 if (!name)
1023 return -ENOMEM;
1024 if (!strcmp(name, "none"))
1025 c->mount_opts.compr_type = UBIFS_COMPR_NONE;
1026 else if (!strcmp(name, "lzo"))
1027 c->mount_opts.compr_type = UBIFS_COMPR_LZO;
1028 else if (!strcmp(name, "zlib"))
1029 c->mount_opts.compr_type = UBIFS_COMPR_ZLIB;
1030 else {
Sheng Yong235c3622015-03-20 10:39:42 +00001031 ubifs_err(c, "unknown compressor \"%s\"", name); //FIXME: is c ready?
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001032 kfree(name);
1033 return -EINVAL;
1034 }
1035 kfree(name);
1036 c->mount_opts.override_compr = 1;
1037 c->default_compr = c->mount_opts.compr_type;
1038 break;
1039 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001040 default:
Artem Bityutskiy8379ea32009-05-29 12:34:52 +03001041 {
1042 unsigned long flag;
1043 struct super_block *sb = c->vfs_sb;
1044
1045 flag = parse_standard_option(p);
1046 if (!flag) {
Sheng Yong235c3622015-03-20 10:39:42 +00001047 ubifs_err(c, "unrecognized mount option \"%s\" or missing value",
Artem Bityutskiy79fda512012-08-27 13:34:09 +03001048 p);
Artem Bityutskiy8379ea32009-05-29 12:34:52 +03001049 return -EINVAL;
1050 }
1051 sb->s_flags |= flag;
1052 break;
1053 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001054 }
1055 }
1056
1057 return 0;
1058}
1059
1060/**
1061 * destroy_journal - destroy journal data structures.
1062 * @c: UBIFS file-system description object
1063 *
1064 * This function destroys journal data structures including those that may have
1065 * been created by recovery functions.
1066 */
1067static void destroy_journal(struct ubifs_info *c)
1068{
1069 while (!list_empty(&c->unclean_leb_list)) {
1070 struct ubifs_unclean_leb *ucleb;
1071
1072 ucleb = list_entry(c->unclean_leb_list.next,
1073 struct ubifs_unclean_leb, list);
1074 list_del(&ucleb->list);
1075 kfree(ucleb);
1076 }
1077 while (!list_empty(&c->old_buds)) {
1078 struct ubifs_bud *bud;
1079
1080 bud = list_entry(c->old_buds.next, struct ubifs_bud, list);
1081 list_del(&bud->list);
1082 kfree(bud);
1083 }
1084 ubifs_destroy_idx_gc(c);
1085 ubifs_destroy_size_tree(c);
1086 ubifs_tnc_close(c);
1087 free_buds(c);
1088}
1089
1090/**
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001091 * bu_init - initialize bulk-read information.
1092 * @c: UBIFS file-system description object
1093 */
1094static void bu_init(struct ubifs_info *c)
1095{
1096 ubifs_assert(c->bulk_read == 1);
1097
1098 if (c->bu.buf)
1099 return; /* Already initialized */
1100
1101again:
1102 c->bu.buf = kmalloc(c->max_bu_buf_len, GFP_KERNEL | __GFP_NOWARN);
1103 if (!c->bu.buf) {
1104 if (c->max_bu_buf_len > UBIFS_KMALLOC_OK) {
1105 c->max_bu_buf_len = UBIFS_KMALLOC_OK;
1106 goto again;
1107 }
1108
1109 /* Just disable bulk-read */
Sheng Yong235c3622015-03-20 10:39:42 +00001110 ubifs_warn(c, "cannot allocate %d bytes of memory for bulk-read, disabling it",
Artem Bityutskiy79fda512012-08-27 13:34:09 +03001111 c->max_bu_buf_len);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001112 c->mount_opts.bulk_read = 1;
1113 c->bulk_read = 0;
1114 return;
1115 }
1116}
1117
1118/**
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001119 * check_free_space - check if there is enough free space to mount.
1120 * @c: UBIFS file-system description object
1121 *
1122 * This function makes sure UBIFS has enough free space to be mounted in
1123 * read/write mode. UBIFS must always have some free space to allow deletions.
1124 */
1125static int check_free_space(struct ubifs_info *c)
1126{
1127 ubifs_assert(c->dark_wm > 0);
1128 if (c->lst.total_free + c->lst.total_dirty < c->dark_wm) {
Sheng Yong235c3622015-03-20 10:39:42 +00001129 ubifs_err(c, "insufficient free space to mount in R/W mode");
Artem Bityutskiyedf6be22012-05-16 19:15:56 +03001130 ubifs_dump_budg(c, &c->bi);
1131 ubifs_dump_lprops(c);
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001132 return -ENOSPC;
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001133 }
1134 return 0;
1135}
1136
1137/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001138 * mount_ubifs - mount UBIFS file-system.
1139 * @c: UBIFS file-system description object
1140 *
1141 * This function mounts UBIFS file system. Returns zero in case of success and
1142 * a negative error code in case of failure.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001143 */
1144static int mount_ubifs(struct ubifs_info *c)
1145{
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001146 int err;
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001147 long long x, y;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001148 size_t sz;
1149
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001150 c->ro_mount = !!(c->vfs_sb->s_flags & MS_RDONLY);
Daniel Golle90bea5a32014-06-02 15:51:10 +02001151 /* Suppress error messages while probing if MS_SILENT is set */
1152 c->probing = !!(c->vfs_sb->s_flags & MS_SILENT);
1153
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001154 err = init_constants_early(c);
1155 if (err)
1156 return err;
1157
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001158 err = ubifs_debugging_init(c);
1159 if (err)
1160 return err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001161
1162 err = check_volume_empty(c);
1163 if (err)
1164 goto out_free;
1165
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001166 if (c->empty && (c->ro_mount || c->ro_media)) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001167 /*
1168 * This UBI volume is empty, and read-only, or the file system
1169 * is mounted read-only - we cannot format it.
1170 */
Sheng Yong235c3622015-03-20 10:39:42 +00001171 ubifs_err(c, "can't format empty UBI volume: read-only %s",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001172 c->ro_media ? "UBI volume" : "mount");
1173 err = -EROFS;
1174 goto out_free;
1175 }
1176
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001177 if (c->ro_media && !c->ro_mount) {
Sheng Yong235c3622015-03-20 10:39:42 +00001178 ubifs_err(c, "cannot mount read-write - read-only media");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001179 err = -EROFS;
1180 goto out_free;
1181 }
1182
1183 /*
1184 * The requirement for the buffer is that it should fit indexing B-tree
1185 * height amount of integers. We assume the height if the TNC tree will
1186 * never exceed 64.
1187 */
1188 err = -ENOMEM;
1189 c->bottom_up_buf = kmalloc(BOTTOM_UP_HEIGHT * sizeof(int), GFP_KERNEL);
1190 if (!c->bottom_up_buf)
1191 goto out_free;
1192
1193 c->sbuf = vmalloc(c->leb_size);
1194 if (!c->sbuf)
1195 goto out_free;
1196
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001197 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001198 c->ileb_buf = vmalloc(c->leb_size);
1199 if (!c->ileb_buf)
1200 goto out_free;
1201 }
1202
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001203 if (c->bulk_read == 1)
1204 bu_init(c);
1205
Matthew L. Creechd8829622011-03-04 17:55:02 -05001206 if (!c->ro_mount) {
1207 c->write_reserve_buf = kmalloc(COMPRESSED_DATA_NODE_BUF_SZ,
1208 GFP_KERNEL);
1209 if (!c->write_reserve_buf)
1210 goto out_free;
1211 }
1212
Artem Bityutskiy18d1d7f2011-01-17 22:27:56 +02001213 c->mounting = 1;
Adrian Hunter2953e732008-09-04 16:26:00 +03001214
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001215 err = ubifs_read_superblock(c);
1216 if (err)
1217 goto out_free;
1218
Daniel Golle90bea5a32014-06-02 15:51:10 +02001219 c->probing = 0;
1220
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001221 /*
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001222 * Make sure the compressor which is set as default in the superblock
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001223 * or overridden by mount options is actually compiled in.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001224 */
1225 if (!ubifs_compr_present(c->default_compr)) {
Sheng Yong235c3622015-03-20 10:39:42 +00001226 ubifs_err(c, "'compressor \"%s\" is not compiled in",
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001227 ubifs_compr_name(c->default_compr));
Corentin Chary8eec2f32009-05-25 08:49:10 +02001228 err = -ENOTSUPP;
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001229 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001230 }
1231
Artem Bityutskiy79807d02008-12-27 19:18:00 +02001232 err = init_constants_sb(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001233 if (err)
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001234 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001235
1236 sz = ALIGN(c->max_idx_node_sz, c->min_io_size);
1237 sz = ALIGN(sz + c->max_idx_node_sz, c->min_io_size);
1238 c->cbuf = kmalloc(sz, GFP_NOFS);
1239 if (!c->cbuf) {
1240 err = -ENOMEM;
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001241 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001242 }
1243
Artem Bityutskiyb50b9f42011-04-25 18:17:09 +03001244 err = alloc_wbufs(c);
1245 if (err)
1246 goto out_cbuf;
1247
Sebastian Siewior0855f312008-09-09 11:17:29 +02001248 sprintf(c->bgt_name, BGT_NAME_PATTERN, c->vi.ubi_num, c->vi.vol_id);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001249 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001250 /* Create background thread */
Hunter Adrianfcabb342009-03-18 12:29:39 +01001251 c->bgt = kthread_create(ubifs_bg_thread, c, "%s", c->bgt_name);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001252 if (IS_ERR(c->bgt)) {
1253 err = PTR_ERR(c->bgt);
1254 c->bgt = NULL;
Sheng Yong235c3622015-03-20 10:39:42 +00001255 ubifs_err(c, "cannot spawn \"%s\", error %d",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001256 c->bgt_name, err);
1257 goto out_wbufs;
1258 }
1259 wake_up_process(c->bgt);
1260 }
1261
1262 err = ubifs_read_master(c);
1263 if (err)
1264 goto out_master;
1265
Ben Gardiner09801192011-05-30 14:56:16 -04001266 init_constants_master(c);
1267
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001268 if ((c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY)) != 0) {
Sheng Yong235c3622015-03-20 10:39:42 +00001269 ubifs_msg(c, "recovery needed");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001270 c->need_recovery = 1;
Ben Gardiner781c5712011-05-30 14:56:15 -04001271 }
1272
Ben Gardiner781c5712011-05-30 14:56:15 -04001273 if (c->need_recovery && !c->ro_mount) {
1274 err = ubifs_recover_inl_heads(c, c->sbuf);
1275 if (err)
1276 goto out_master;
1277 }
1278
1279 err = ubifs_lpt_init(c, 1, !c->ro_mount);
1280 if (err)
1281 goto out_master;
1282
Ben Gardiner09801192011-05-30 14:56:16 -04001283 if (!c->ro_mount && c->space_fixup) {
1284 err = ubifs_fixup_free_space(c);
1285 if (err)
Sidney Amani56b04e32012-05-18 14:32:37 +03001286 goto out_lpt;
Ben Gardiner09801192011-05-30 14:56:16 -04001287 }
1288
Sheng Yong2c845992015-03-04 10:46:16 +00001289 if (!c->ro_mount && !c->need_recovery) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001290 /*
1291 * Set the "dirty" flag so that if we reboot uncleanly we
1292 * will notice this immediately on the next mount.
1293 */
1294 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1295 err = ubifs_write_master(c);
1296 if (err)
Ben Gardiner781c5712011-05-30 14:56:15 -04001297 goto out_lpt;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001298 }
1299
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001300 err = dbg_check_idx_size(c, c->bi.old_idx_sz);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001301 if (err)
1302 goto out_lpt;
1303
1304 err = ubifs_replay_journal(c);
1305 if (err)
1306 goto out_journal;
1307
Artem Bityutskiy1fb8bd02009-06-28 18:31:58 +03001308 /* Calculate 'min_idx_lebs' after journal replay */
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001309 c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
Artem Bityutskiy1fb8bd02009-06-28 18:31:58 +03001310
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001311 err = ubifs_mount_orphans(c, c->need_recovery, c->ro_mount);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001312 if (err)
1313 goto out_orphans;
1314
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001315 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001316 int lnum;
1317
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001318 err = check_free_space(c);
1319 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001320 goto out_orphans;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001321
1322 /* Check for enough log space */
1323 lnum = c->lhead_lnum + 1;
1324 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1325 lnum = UBIFS_LOG_LNUM;
1326 if (lnum == c->ltail_lnum) {
1327 err = ubifs_consolidate_log(c);
1328 if (err)
1329 goto out_orphans;
1330 }
1331
1332 if (c->need_recovery) {
1333 err = ubifs_recover_size(c);
1334 if (err)
1335 goto out_orphans;
1336 err = ubifs_rcvry_gc_commit(c);
Artem Bityutskiy276de5d2010-05-23 14:16:13 +03001337 if (err)
1338 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001339 } else {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001340 err = take_gc_lnum(c);
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001341 if (err)
1342 goto out_orphans;
1343
1344 /*
1345 * GC LEB may contain garbage if there was an unclean
1346 * reboot, and it should be un-mapped.
1347 */
1348 err = ubifs_leb_unmap(c, c->gc_lnum);
1349 if (err)
Matthieu CASTETc18de722010-08-02 11:36:06 +02001350 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001351 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001352
1353 err = dbg_check_lprops(c);
1354 if (err)
1355 goto out_orphans;
1356 } else if (c->need_recovery) {
1357 err = ubifs_recover_size(c);
1358 if (err)
1359 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001360 } else {
1361 /*
1362 * Even if we mount read-only, we have to set space in GC LEB
1363 * to proper value because this affects UBIFS free space
1364 * reporting. We do not want to have a situation when
1365 * re-mounting from R/O to R/W changes amount of free space.
1366 */
1367 err = take_gc_lnum(c);
1368 if (err)
1369 goto out_orphans;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001370 }
1371
1372 spin_lock(&ubifs_infos_lock);
1373 list_add_tail(&c->infos_list, &ubifs_infos);
1374 spin_unlock(&ubifs_infos_lock);
1375
1376 if (c->need_recovery) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001377 if (c->ro_mount)
Sheng Yong235c3622015-03-20 10:39:42 +00001378 ubifs_msg(c, "recovery deferred");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001379 else {
1380 c->need_recovery = 0;
Sheng Yong235c3622015-03-20 10:39:42 +00001381 ubifs_msg(c, "recovery completed");
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001382 /*
1383 * GC LEB has to be empty and taken at this point. But
1384 * the journal head LEBs may also be accounted as
1385 * "empty taken" if they are empty.
1386 */
1387 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001388 }
Artem Bityutskiy6ba87c92009-01-26 16:12:20 +02001389 } else
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001390 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy552ff312008-10-23 11:49:28 +03001391
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001392 err = dbg_check_filesystem(c);
1393 if (err)
1394 goto out_infos;
1395
Artem Bityutskiy6ba87c92009-01-26 16:12:20 +02001396 err = dbg_debugfs_init_fs(c);
1397 if (err)
1398 goto out_infos;
1399
Artem Bityutskiy18d1d7f2011-01-17 22:27:56 +02001400 c->mounting = 0;
Adrian Hunter2953e732008-09-04 16:26:00 +03001401
Sheng Yong235c3622015-03-20 10:39:42 +00001402 ubifs_msg(c, "UBIFS: mounted UBI device %d, volume %d, name \"%s\"%s",
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001403 c->vi.ubi_num, c->vi.vol_id, c->vi.name,
Richard Genoudbeadadf2013-04-02 12:24:37 +02001404 c->ro_mount ? ", R/O mode" : "");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001405 x = (long long)c->main_lebs * c->leb_size;
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001406 y = (long long)c->log_lebs * c->leb_size + c->max_bud_bytes;
Sheng Yong235c3622015-03-20 10:39:42 +00001407 ubifs_msg(c, "LEB size: %d bytes (%d KiB), min./max. I/O unit sizes: %d bytes/%d bytes",
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001408 c->leb_size, c->leb_size >> 10, c->min_io_size,
1409 c->max_write_size);
Sheng Yong235c3622015-03-20 10:39:42 +00001410 ubifs_msg(c, "FS size: %lld bytes (%lld MiB, %d LEBs), journal size %lld bytes (%lld MiB, %d LEBs)",
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001411 x, x >> 20, c->main_lebs,
1412 y, y >> 20, c->log_lebs + c->max_bud_cnt);
Sheng Yong235c3622015-03-20 10:39:42 +00001413 ubifs_msg(c, "reserved for root: %llu bytes (%llu KiB)",
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001414 c->report_rp_size, c->report_rp_size >> 10);
Sheng Yong235c3622015-03-20 10:39:42 +00001415 ubifs_msg(c, "media format: w%d/r%d (latest is w%d/r%d), UUID %pUB%s",
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001416 c->fmt_version, c->ro_compat_version,
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001417 UBIFS_FORMAT_VERSION, UBIFS_RO_COMPAT_VERSION, c->uuid,
1418 c->big_lpt ? ", big LPT model" : ", small LPT model");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001419
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001420 dbg_gen("default compressor: %s", ubifs_compr_name(c->default_compr));
1421 dbg_gen("data journal heads: %d",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001422 c->jhead_cnt - NONDATA_JHEADS_CNT);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001423 dbg_gen("log LEBs: %d (%d - %d)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001424 c->log_lebs, UBIFS_LOG_LNUM, c->log_last);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001425 dbg_gen("LPT area LEBs: %d (%d - %d)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001426 c->lpt_lebs, c->lpt_first, c->lpt_last);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001427 dbg_gen("orphan area LEBs: %d (%d - %d)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001428 c->orph_lebs, c->orph_first, c->orph_last);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001429 dbg_gen("main area LEBs: %d (%d - %d)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001430 c->main_lebs, c->main_first, c->leb_cnt - 1);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001431 dbg_gen("index LEBs: %d", c->lst.idx_lebs);
1432 dbg_gen("total index bytes: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001433 c->bi.old_idx_sz, c->bi.old_idx_sz >> 10,
1434 c->bi.old_idx_sz >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001435 dbg_gen("key hash type: %d", c->key_hash_type);
1436 dbg_gen("tree fanout: %d", c->fanout);
1437 dbg_gen("reserved GC LEB: %d", c->gc_lnum);
1438 dbg_gen("max. znode size %d", c->max_znode_sz);
1439 dbg_gen("max. index node size %d", c->max_idx_node_sz);
1440 dbg_gen("node sizes: data %zu, inode %zu, dentry %zu",
Artem Bityutskiy8e5033a2008-12-30 18:37:45 +02001441 UBIFS_DATA_NODE_SZ, UBIFS_INO_NODE_SZ, UBIFS_DENT_NODE_SZ);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001442 dbg_gen("node sizes: trun %zu, sb %zu, master %zu",
Artem Bityutskiy8e5033a2008-12-30 18:37:45 +02001443 UBIFS_TRUN_NODE_SZ, UBIFS_SB_NODE_SZ, UBIFS_MST_NODE_SZ);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001444 dbg_gen("node sizes: ref %zu, cmt. start %zu, orph %zu",
Artem Bityutskiy8e5033a2008-12-30 18:37:45 +02001445 UBIFS_REF_NODE_SZ, UBIFS_CS_NODE_SZ, UBIFS_ORPH_NODE_SZ);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001446 dbg_gen("max. node sizes: data %zu, inode %zu dentry %zu, idx %d",
Artem Bityutskiyc4361572011-03-25 15:27:40 +02001447 UBIFS_MAX_DATA_NODE_SZ, UBIFS_MAX_INO_NODE_SZ,
Artem Bityutskiy6342aae2011-03-08 14:26:47 +02001448 UBIFS_MAX_DENT_NODE_SZ, ubifs_idx_node_sz(c, c->fanout));
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001449 dbg_gen("dead watermark: %d", c->dead_wm);
1450 dbg_gen("dark watermark: %d", c->dark_wm);
1451 dbg_gen("LEB overhead: %d", c->leb_overhead);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001452 x = (long long)c->main_lebs * c->dark_wm;
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001453 dbg_gen("max. dark space: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001454 x, x >> 10, x >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001455 dbg_gen("maximum bud bytes: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001456 c->max_bud_bytes, c->max_bud_bytes >> 10,
1457 c->max_bud_bytes >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001458 dbg_gen("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001459 c->bg_bud_bytes, c->bg_bud_bytes >> 10,
1460 c->bg_bud_bytes >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001461 dbg_gen("current bud bytes %lld (%lld KiB, %lld MiB)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001462 c->bud_bytes, c->bud_bytes >> 10, c->bud_bytes >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001463 dbg_gen("max. seq. number: %llu", c->max_sqnum);
1464 dbg_gen("commit number: %llu", c->cmt_no);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001465
1466 return 0;
1467
1468out_infos:
1469 spin_lock(&ubifs_infos_lock);
1470 list_del(&c->infos_list);
1471 spin_unlock(&ubifs_infos_lock);
1472out_orphans:
1473 free_orphans(c);
1474out_journal:
1475 destroy_journal(c);
1476out_lpt:
1477 ubifs_lpt_free(c, 0);
1478out_master:
1479 kfree(c->mst_node);
1480 kfree(c->rcvrd_mst_node);
1481 if (c->bgt)
1482 kthread_stop(c->bgt);
1483out_wbufs:
1484 free_wbufs(c);
1485out_cbuf:
1486 kfree(c->cbuf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001487out_free:
Matthew L. Creechd8829622011-03-04 17:55:02 -05001488 kfree(c->write_reserve_buf);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001489 kfree(c->bu.buf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001490 vfree(c->ileb_buf);
1491 vfree(c->sbuf);
1492 kfree(c->bottom_up_buf);
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001493 ubifs_debugging_exit(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001494 return err;
1495}
1496
1497/**
1498 * ubifs_umount - un-mount UBIFS file-system.
1499 * @c: UBIFS file-system description object
1500 *
1501 * Note, this function is called to free allocated resourced when un-mounting,
1502 * as well as free resources when an error occurred while we were half way
1503 * through mounting (error path cleanup function). So it has to make sure the
1504 * resource was actually allocated before freeing it.
1505 */
1506static void ubifs_umount(struct ubifs_info *c)
1507{
1508 dbg_gen("un-mounting UBI device %d, volume %d", c->vi.ubi_num,
1509 c->vi.vol_id);
1510
Artem Bityutskiy552ff312008-10-23 11:49:28 +03001511 dbg_debugfs_exit_fs(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001512 spin_lock(&ubifs_infos_lock);
1513 list_del(&c->infos_list);
1514 spin_unlock(&ubifs_infos_lock);
1515
1516 if (c->bgt)
1517 kthread_stop(c->bgt);
1518
1519 destroy_journal(c);
1520 free_wbufs(c);
1521 free_orphans(c);
1522 ubifs_lpt_free(c, 0);
1523
1524 kfree(c->cbuf);
1525 kfree(c->rcvrd_mst_node);
1526 kfree(c->mst_node);
Matthew L. Creechd8829622011-03-04 17:55:02 -05001527 kfree(c->write_reserve_buf);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001528 kfree(c->bu.buf);
1529 vfree(c->ileb_buf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001530 vfree(c->sbuf);
1531 kfree(c->bottom_up_buf);
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001532 ubifs_debugging_exit(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001533}
1534
1535/**
1536 * ubifs_remount_rw - re-mount in read-write mode.
1537 * @c: UBIFS file-system description object
1538 *
1539 * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1540 * mode. This function allocates the needed resources and re-mounts UBIFS in
1541 * read-write mode.
1542 */
1543static int ubifs_remount_rw(struct ubifs_info *c)
1544{
1545 int err, lnum;
1546
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001547 if (c->rw_incompat) {
Sheng Yong235c3622015-03-20 10:39:42 +00001548 ubifs_err(c, "the file-system is not R/W-compatible");
1549 ubifs_msg(c, "on-flash format version is w%d/r%d, but software only supports up to version w%d/r%d",
Artem Bityutskiy79fda512012-08-27 13:34:09 +03001550 c->fmt_version, c->ro_compat_version,
1551 UBIFS_FORMAT_VERSION, UBIFS_RO_COMPAT_VERSION);
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001552 return -EROFS;
1553 }
1554
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001555 mutex_lock(&c->umount_mutex);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001556 dbg_save_space_info(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001557 c->remounting_rw = 1;
Artem Bityutskiyc88ac002011-03-29 09:45:21 +03001558 c->ro_mount = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001559
Artem Bityutskiy67e753c2013-03-14 10:49:23 +02001560 if (c->space_fixup) {
1561 err = ubifs_fixup_free_space(c);
1562 if (err)
Artem Bityutskiyfcdd57c2014-04-07 13:39:06 +03001563 goto out;
Artem Bityutskiy67e753c2013-03-14 10:49:23 +02001564 }
1565
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001566 err = check_free_space(c);
1567 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001568 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001569
1570 if (c->old_leb_cnt != c->leb_cnt) {
1571 struct ubifs_sb_node *sup;
1572
1573 sup = ubifs_read_sb_node(c);
1574 if (IS_ERR(sup)) {
1575 err = PTR_ERR(sup);
1576 goto out;
1577 }
1578 sup->leb_cnt = cpu_to_le32(c->leb_cnt);
1579 err = ubifs_write_sb_node(c, sup);
Artem Bityutskiyeaeee242011-05-06 17:08:56 +03001580 kfree(sup);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001581 if (err)
1582 goto out;
1583 }
1584
1585 if (c->need_recovery) {
Sheng Yong235c3622015-03-20 10:39:42 +00001586 ubifs_msg(c, "completing deferred recovery");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001587 err = ubifs_write_rcvrd_mst_node(c);
1588 if (err)
1589 goto out;
1590 err = ubifs_recover_size(c);
1591 if (err)
1592 goto out;
1593 err = ubifs_clean_lebs(c, c->sbuf);
1594 if (err)
1595 goto out;
1596 err = ubifs_recover_inl_heads(c, c->sbuf);
1597 if (err)
1598 goto out;
Adrian Hunter49d128a2009-01-26 10:55:40 +02001599 } else {
1600 /* A readonly mount is not allowed to have orphans */
1601 ubifs_assert(c->tot_orphans == 0);
1602 err = ubifs_clear_orphans(c);
1603 if (err)
1604 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001605 }
1606
1607 if (!(c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY))) {
1608 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1609 err = ubifs_write_master(c);
1610 if (err)
1611 goto out;
1612 }
1613
1614 c->ileb_buf = vmalloc(c->leb_size);
1615 if (!c->ileb_buf) {
1616 err = -ENOMEM;
1617 goto out;
1618 }
1619
Matthew L. Creechd8829622011-03-04 17:55:02 -05001620 c->write_reserve_buf = kmalloc(COMPRESSED_DATA_NODE_BUF_SZ, GFP_KERNEL);
Wei Yongjun7203db92013-06-07 10:17:22 +08001621 if (!c->write_reserve_buf) {
1622 err = -ENOMEM;
Matthew L. Creechd8829622011-03-04 17:55:02 -05001623 goto out;
Wei Yongjun7203db92013-06-07 10:17:22 +08001624 }
Matthew L. Creechd8829622011-03-04 17:55:02 -05001625
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001626 err = ubifs_lpt_init(c, 0, 1);
1627 if (err)
1628 goto out;
1629
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001630 /* Create background thread */
Hunter Adrianfcabb342009-03-18 12:29:39 +01001631 c->bgt = kthread_create(ubifs_bg_thread, c, "%s", c->bgt_name);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001632 if (IS_ERR(c->bgt)) {
1633 err = PTR_ERR(c->bgt);
1634 c->bgt = NULL;
Sheng Yong235c3622015-03-20 10:39:42 +00001635 ubifs_err(c, "cannot spawn \"%s\", error %d",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001636 c->bgt_name, err);
Adrian Hunter2953e732008-09-04 16:26:00 +03001637 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001638 }
1639 wake_up_process(c->bgt);
1640
1641 c->orph_buf = vmalloc(c->leb_size);
Adrian Hunter2953e732008-09-04 16:26:00 +03001642 if (!c->orph_buf) {
1643 err = -ENOMEM;
1644 goto out;
1645 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001646
1647 /* Check for enough log space */
1648 lnum = c->lhead_lnum + 1;
1649 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1650 lnum = UBIFS_LOG_LNUM;
1651 if (lnum == c->ltail_lnum) {
1652 err = ubifs_consolidate_log(c);
1653 if (err)
1654 goto out;
1655 }
1656
1657 if (c->need_recovery)
1658 err = ubifs_rcvry_gc_commit(c);
1659 else
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001660 err = ubifs_leb_unmap(c, c->gc_lnum);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001661 if (err)
1662 goto out;
1663
Artem Bityutskiy8c230d92011-04-20 18:02:45 +03001664 dbg_gen("re-mounted read-write");
1665 c->remounting_rw = 0;
1666
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001667 if (c->need_recovery) {
1668 c->need_recovery = 0;
Sheng Yong235c3622015-03-20 10:39:42 +00001669 ubifs_msg(c, "deferred recovery completed");
Artem Bityutskiy8c230d92011-04-20 18:02:45 +03001670 } else {
1671 /*
1672 * Do not run the debugging space check if the were doing
1673 * recovery, because when we saved the information we had the
1674 * file-system in a state where the TNC and lprops has been
1675 * modified in memory, but all the I/O operations (including a
1676 * commit) were deferred. So the file-system was in
1677 * "non-committed" state. Now the file-system is in committed
1678 * state, and of course the amount of free space will change
1679 * because, for example, the old index size was imprecise.
1680 */
1681 err = dbg_check_space_info(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001682 }
Matthew L. Creech9d510db2011-05-06 18:58:23 -04001683
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001684 mutex_unlock(&c->umount_mutex);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001685 return err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001686
1687out:
Artem Bityutskiyc88ac002011-03-29 09:45:21 +03001688 c->ro_mount = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001689 vfree(c->orph_buf);
1690 c->orph_buf = NULL;
1691 if (c->bgt) {
1692 kthread_stop(c->bgt);
1693 c->bgt = NULL;
1694 }
1695 free_wbufs(c);
Matthew L. Creechd8829622011-03-04 17:55:02 -05001696 kfree(c->write_reserve_buf);
1697 c->write_reserve_buf = NULL;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001698 vfree(c->ileb_buf);
1699 c->ileb_buf = NULL;
1700 ubifs_lpt_free(c, 1);
1701 c->remounting_rw = 0;
1702 mutex_unlock(&c->umount_mutex);
1703 return err;
1704}
1705
1706/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001707 * ubifs_remount_ro - re-mount in read-only mode.
1708 * @c: UBIFS file-system description object
1709 *
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001710 * We assume VFS has stopped writing. Possibly the background thread could be
1711 * running a commit, however kthread_stop will wait in that case.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001712 */
1713static void ubifs_remount_ro(struct ubifs_info *c)
1714{
1715 int i, err;
1716
1717 ubifs_assert(!c->need_recovery);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001718 ubifs_assert(!c->ro_mount);
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001719
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001720 mutex_lock(&c->umount_mutex);
1721 if (c->bgt) {
1722 kthread_stop(c->bgt);
1723 c->bgt = NULL;
1724 }
1725
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001726 dbg_save_space_info(c);
1727
Artem Bityutskiy39037552010-10-18 08:28:50 +03001728 for (i = 0; i < c->jhead_cnt; i++)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001729 ubifs_wbuf_sync(&c->jheads[i].wbuf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001730
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001731 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1732 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1733 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1734 err = ubifs_write_master(c);
1735 if (err)
1736 ubifs_ro_mode(c, err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001737
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001738 vfree(c->orph_buf);
1739 c->orph_buf = NULL;
Matthew L. Creechd8829622011-03-04 17:55:02 -05001740 kfree(c->write_reserve_buf);
1741 c->write_reserve_buf = NULL;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001742 vfree(c->ileb_buf);
1743 c->ileb_buf = NULL;
1744 ubifs_lpt_free(c, 1);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001745 c->ro_mount = 1;
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001746 err = dbg_check_space_info(c);
1747 if (err)
1748 ubifs_ro_mode(c, err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001749 mutex_unlock(&c->umount_mutex);
1750}
1751
1752static void ubifs_put_super(struct super_block *sb)
1753{
1754 int i;
1755 struct ubifs_info *c = sb->s_fs_info;
1756
Sheng Yong235c3622015-03-20 10:39:42 +00001757 ubifs_msg(c, "un-mount UBI device %d", c->vi.ubi_num);
Christoph Hellwig6cfd0142009-05-05 15:40:36 +02001758
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001759 /*
1760 * The following asserts are only valid if there has not been a failure
1761 * of the media. For example, there will be dirty inodes if we failed
1762 * to write them back because of I/O errors.
1763 */
Artem Bityutskiy1a067a22011-04-21 10:39:54 +03001764 if (!c->ro_error) {
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001765 ubifs_assert(c->bi.idx_growth == 0);
1766 ubifs_assert(c->bi.dd_growth == 0);
1767 ubifs_assert(c->bi.data_growth == 0);
Artem Bityutskiy1a067a22011-04-21 10:39:54 +03001768 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001769
1770 /*
1771 * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1772 * and file system un-mount. Namely, it prevents the shrinker from
1773 * picking this superblock for shrinking - it will be just skipped if
1774 * the mutex is locked.
1775 */
1776 mutex_lock(&c->umount_mutex);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001777 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001778 /*
1779 * First of all kill the background thread to make sure it does
1780 * not interfere with un-mounting and freeing resources.
1781 */
1782 if (c->bgt) {
1783 kthread_stop(c->bgt);
1784 c->bgt = NULL;
1785 }
1786
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001787 /*
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001788 * On fatal errors c->ro_error is set to 1, in which case we do
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001789 * not write the master node.
1790 */
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001791 if (!c->ro_error) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001792 int err;
1793
1794 /* Synchronize write-buffers */
Artem Bityutskiy39037552010-10-18 08:28:50 +03001795 for (i = 0; i < c->jhead_cnt; i++)
1796 ubifs_wbuf_sync(&c->jheads[i].wbuf);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001797
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001798 /*
1799 * We are being cleanly unmounted which means the
1800 * orphans were killed - indicate this in the master
1801 * node. Also save the reserved GC LEB number.
1802 */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001803 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1804 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1805 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1806 err = ubifs_write_master(c);
1807 if (err)
1808 /*
1809 * Recovery will attempt to fix the master area
1810 * next mount, so we just print a message and
1811 * continue to unmount normally.
1812 */
Sheng Yong235c3622015-03-20 10:39:42 +00001813 ubifs_err(c, "failed to write master node, error %d",
Artem Bityutskiy79fda512012-08-27 13:34:09 +03001814 err);
Artem Bityutskiy3601ba22010-10-18 08:32:35 +03001815 } else {
1816 for (i = 0; i < c->jhead_cnt; i++)
1817 /* Make sure write-buffer timers are canceled */
1818 hrtimer_cancel(&c->jheads[i].wbuf.timer);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001819 }
1820 }
1821
1822 ubifs_umount(c);
1823 bdi_destroy(&c->bdi);
1824 ubi_close_volume(c->ubi);
1825 mutex_unlock(&c->umount_mutex);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001826}
1827
1828static int ubifs_remount_fs(struct super_block *sb, int *flags, char *data)
1829{
1830 int err;
1831 struct ubifs_info *c = sb->s_fs_info;
1832
Theodore Ts'o02b99842014-03-13 10:14:33 -04001833 sync_filesystem(sb);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001834 dbg_gen("old flags %#lx, new flags %#x", sb->s_flags, *flags);
1835
1836 err = ubifs_parse_options(c, data, 1);
1837 if (err) {
Sheng Yong235c3622015-03-20 10:39:42 +00001838 ubifs_err(c, "invalid or unknown remount parameter");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001839 return err;
1840 }
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001841
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001842 if (c->ro_mount && !(*flags & MS_RDONLY)) {
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001843 if (c->ro_error) {
Sheng Yong235c3622015-03-20 10:39:42 +00001844 ubifs_msg(c, "cannot re-mount R/W due to prior errors");
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001845 return -EROFS;
1846 }
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001847 if (c->ro_media) {
Sheng Yong235c3622015-03-20 10:39:42 +00001848 ubifs_msg(c, "cannot re-mount R/W - UBI volume is R/O");
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001849 return -EROFS;
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001850 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001851 err = ubifs_remount_rw(c);
Artem Bityutskiye9d6bbc2009-07-19 13:51:04 +03001852 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001853 return err;
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001854 } else if (!c->ro_mount && (*flags & MS_RDONLY)) {
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001855 if (c->ro_error) {
Sheng Yong235c3622015-03-20 10:39:42 +00001856 ubifs_msg(c, "cannot re-mount R/O due to prior errors");
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001857 return -EROFS;
Adrian Hunterb466f172009-01-29 12:59:33 +02001858 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001859 ubifs_remount_ro(c);
Adrian Hunterb466f172009-01-29 12:59:33 +02001860 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001861
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001862 if (c->bulk_read == 1)
1863 bu_init(c);
1864 else {
1865 dbg_gen("disable bulk-read");
1866 kfree(c->bu.buf);
1867 c->bu.buf = NULL;
1868 }
1869
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001870 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001871 return 0;
1872}
1873
Artem Bityutskiye8b81562009-01-15 17:43:23 +02001874const struct super_operations ubifs_super_operations = {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001875 .alloc_inode = ubifs_alloc_inode,
1876 .destroy_inode = ubifs_destroy_inode,
1877 .put_super = ubifs_put_super,
1878 .write_inode = ubifs_write_inode,
Al Virod640e1b2010-06-07 00:34:05 -04001879 .evict_inode = ubifs_evict_inode,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001880 .statfs = ubifs_statfs,
1881 .dirty_inode = ubifs_dirty_inode,
1882 .remount_fs = ubifs_remount_fs,
1883 .show_options = ubifs_show_options,
1884 .sync_fs = ubifs_sync_fs,
1885};
1886
1887/**
1888 * open_ubi - parse UBI device name string and open the UBI device.
1889 * @name: UBI volume name
1890 * @mode: UBI volume open mode
1891 *
Corentin Chary97223242009-09-28 21:10:12 +02001892 * The primary method of mounting UBIFS is by specifying the UBI volume
1893 * character device node path. However, UBIFS may also be mounted withoug any
1894 * character device node using one of the following methods:
1895 *
1896 * o ubiX_Y - mount UBI device number X, volume Y;
1897 * o ubiY - mount UBI device number 0, volume Y;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001898 * o ubiX:NAME - mount UBI device X, volume with name NAME;
1899 * o ubi:NAME - mount UBI device 0, volume with name NAME.
1900 *
1901 * Alternative '!' separator may be used instead of ':' (because some shells
1902 * like busybox may interpret ':' as an NFS host name separator). This function
Corentin Chary97223242009-09-28 21:10:12 +02001903 * returns UBI volume description object in case of success and a negative
1904 * error code in case of failure.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001905 */
1906static struct ubi_volume_desc *open_ubi(const char *name, int mode)
1907{
Corentin Chary97223242009-09-28 21:10:12 +02001908 struct ubi_volume_desc *ubi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001909 int dev, vol;
1910 char *endptr;
1911
Corentin Chary97223242009-09-28 21:10:12 +02001912 /* First, try to open using the device node path method */
1913 ubi = ubi_open_volume_path(name, mode);
1914 if (!IS_ERR(ubi))
1915 return ubi;
1916
1917 /* Try the "nodev" method */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001918 if (name[0] != 'u' || name[1] != 'b' || name[2] != 'i')
1919 return ERR_PTR(-EINVAL);
1920
1921 /* ubi:NAME method */
1922 if ((name[3] == ':' || name[3] == '!') && name[4] != '\0')
1923 return ubi_open_volume_nm(0, name + 4, mode);
1924
1925 if (!isdigit(name[3]))
1926 return ERR_PTR(-EINVAL);
1927
1928 dev = simple_strtoul(name + 3, &endptr, 0);
1929
1930 /* ubiY method */
1931 if (*endptr == '\0')
1932 return ubi_open_volume(0, dev, mode);
1933
1934 /* ubiX_Y method */
1935 if (*endptr == '_' && isdigit(endptr[1])) {
1936 vol = simple_strtoul(endptr + 1, &endptr, 0);
1937 if (*endptr != '\0')
1938 return ERR_PTR(-EINVAL);
1939 return ubi_open_volume(dev, vol, mode);
1940 }
1941
1942 /* ubiX:NAME method */
1943 if ((*endptr == ':' || *endptr == '!') && endptr[1] != '\0')
1944 return ubi_open_volume_nm(dev, ++endptr, mode);
1945
1946 return ERR_PTR(-EINVAL);
1947}
1948
Al Virob1c27ab2011-06-12 10:07:03 -04001949static struct ubifs_info *alloc_ubifs_info(struct ubi_volume_desc *ubi)
1950{
1951 struct ubifs_info *c;
1952
1953 c = kzalloc(sizeof(struct ubifs_info), GFP_KERNEL);
1954 if (c) {
1955 spin_lock_init(&c->cnt_lock);
1956 spin_lock_init(&c->cs_lock);
1957 spin_lock_init(&c->buds_lock);
1958 spin_lock_init(&c->space_lock);
1959 spin_lock_init(&c->orphan_lock);
1960 init_rwsem(&c->commit_sem);
1961 mutex_init(&c->lp_mutex);
1962 mutex_init(&c->tnc_mutex);
1963 mutex_init(&c->log_mutex);
Al Virob1c27ab2011-06-12 10:07:03 -04001964 mutex_init(&c->umount_mutex);
1965 mutex_init(&c->bu_mutex);
1966 mutex_init(&c->write_reserve_mutex);
1967 init_waitqueue_head(&c->cmt_wq);
1968 c->buds = RB_ROOT;
1969 c->old_idx = RB_ROOT;
1970 c->size_tree = RB_ROOT;
1971 c->orph_tree = RB_ROOT;
1972 INIT_LIST_HEAD(&c->infos_list);
1973 INIT_LIST_HEAD(&c->idx_gc);
1974 INIT_LIST_HEAD(&c->replay_list);
1975 INIT_LIST_HEAD(&c->replay_buds);
1976 INIT_LIST_HEAD(&c->uncat_list);
1977 INIT_LIST_HEAD(&c->empty_list);
1978 INIT_LIST_HEAD(&c->freeable_list);
1979 INIT_LIST_HEAD(&c->frdi_idx_list);
1980 INIT_LIST_HEAD(&c->unclean_leb_list);
1981 INIT_LIST_HEAD(&c->old_buds);
1982 INIT_LIST_HEAD(&c->orph_list);
1983 INIT_LIST_HEAD(&c->orph_new);
1984 c->no_chk_data_crc = 1;
1985
1986 c->highest_inum = UBIFS_FIRST_INO;
1987 c->lhead_lnum = c->ltail_lnum = UBIFS_LOG_LNUM;
1988
1989 ubi_get_volume_info(ubi, &c->vi);
1990 ubi_get_device_info(c->vi.ubi_num, &c->di);
1991 }
1992 return c;
1993}
1994
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001995static int ubifs_fill_super(struct super_block *sb, void *data, int silent)
1996{
Al Virod251ed22011-06-12 10:24:33 -04001997 struct ubifs_info *c = sb->s_fs_info;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001998 struct inode *root;
1999 int err;
2000
Artem Bityutskiy8379ea32009-05-29 12:34:52 +03002001 c->vfs_sb = sb;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002002 /* Re-open the UBI device in read-write mode */
2003 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READWRITE);
2004 if (IS_ERR(c->ubi)) {
2005 err = PTR_ERR(c->ubi);
Al Virod251ed22011-06-12 10:24:33 -04002006 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002007 }
2008
2009 /*
Artem Bityutskiy0a883a02008-08-13 14:13:26 +03002010 * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002011 * UBIFS, I/O is not deferred, it is done immediately in readpage,
2012 * which means the user would have to wait not just for their own I/O
Artem Bityutskiy0a883a02008-08-13 14:13:26 +03002013 * but the read-ahead I/O as well i.e. completely pointless.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002014 *
2015 * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
2016 */
Jens Axboed9938312009-06-12 14:45:52 +02002017 c->bdi.name = "ubifs",
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01002018 c->bdi.capabilities = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002019 err = bdi_init(&c->bdi);
2020 if (err)
2021 goto out_close;
Daniel Mack7fcd9c32009-07-02 17:15:47 +02002022 err = bdi_register(&c->bdi, NULL, "ubifs_%d_%d",
2023 c->vi.ubi_num, c->vi.vol_id);
Jens Axboea979eff2009-05-29 09:19:23 +02002024 if (err)
2025 goto out_bdi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002026
2027 err = ubifs_parse_options(c, data, 0);
2028 if (err)
2029 goto out_bdi;
2030
Jens Axboe32a88aa2009-09-16 15:02:33 +02002031 sb->s_bdi = &c->bdi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002032 sb->s_fs_info = c;
2033 sb->s_magic = UBIFS_SUPER_MAGIC;
2034 sb->s_blocksize = UBIFS_BLOCK_SIZE;
2035 sb->s_blocksize_bits = UBIFS_BLOCK_SHIFT;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002036 sb->s_maxbytes = c->max_inode_sz = key_max_inode_size(c);
2037 if (c->max_inode_sz > MAX_LFS_FILESIZE)
2038 sb->s_maxbytes = c->max_inode_sz = MAX_LFS_FILESIZE;
2039 sb->s_op = &ubifs_super_operations;
Subodh Nijsured7f0b702014-10-31 13:50:30 -05002040 sb->s_xattr = ubifs_xattr_handlers;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002041
2042 mutex_lock(&c->umount_mutex);
2043 err = mount_ubifs(c);
2044 if (err) {
2045 ubifs_assert(err < 0);
2046 goto out_unlock;
2047 }
2048
2049 /* Read the root inode */
2050 root = ubifs_iget(sb, UBIFS_ROOT_INO);
2051 if (IS_ERR(root)) {
2052 err = PTR_ERR(root);
2053 goto out_umount;
2054 }
2055
Al Viro48fde702012-01-08 22:15:13 -05002056 sb->s_root = d_make_root(root);
Wei Yongjun7203db92013-06-07 10:17:22 +08002057 if (!sb->s_root) {
2058 err = -ENOMEM;
Al Viro48fde702012-01-08 22:15:13 -05002059 goto out_umount;
Wei Yongjun7203db92013-06-07 10:17:22 +08002060 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002061
2062 mutex_unlock(&c->umount_mutex);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002063 return 0;
2064
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002065out_umount:
2066 ubifs_umount(c);
2067out_unlock:
2068 mutex_unlock(&c->umount_mutex);
2069out_bdi:
2070 bdi_destroy(&c->bdi);
2071out_close:
2072 ubi_close_volume(c->ubi);
Al Virod251ed22011-06-12 10:24:33 -04002073out:
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002074 return err;
2075}
2076
2077static int sb_test(struct super_block *sb, void *data)
2078{
Al Virod251ed22011-06-12 10:24:33 -04002079 struct ubifs_info *c1 = data;
Artem Bityutskiy7c83f5c2009-05-25 19:23:04 +03002080 struct ubifs_info *c = sb->s_fs_info;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002081
Al Virod251ed22011-06-12 10:24:33 -04002082 return c->vi.cdev == c1->vi.cdev;
2083}
2084
2085static int sb_set(struct super_block *sb, void *data)
2086{
2087 sb->s_fs_info = data;
2088 return set_anon_super(sb, NULL);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002089}
2090
Al Viro157d81e2010-07-25 23:52:42 +04002091static struct dentry *ubifs_mount(struct file_system_type *fs_type, int flags,
2092 const char *name, void *data)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002093{
2094 struct ubi_volume_desc *ubi;
Al Virod251ed22011-06-12 10:24:33 -04002095 struct ubifs_info *c;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002096 struct super_block *sb;
2097 int err;
2098
2099 dbg_gen("name %s, flags %#x", name, flags);
2100
2101 /*
2102 * Get UBI device number and volume ID. Mount it read-only so far
2103 * because this might be a new mount point, and UBI allows only one
2104 * read-write user at a time.
2105 */
2106 ubi = open_ubi(name, UBI_READONLY);
2107 if (IS_ERR(ubi)) {
Sheng Yong235c3622015-03-20 10:39:42 +00002108 pr_err("UBIFS error (pid: %d): cannot open \"%s\", error %d",
2109 current->pid, name, (int)PTR_ERR(ubi));
Al Viro157d81e2010-07-25 23:52:42 +04002110 return ERR_CAST(ubi);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002111 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002112
Al Virod251ed22011-06-12 10:24:33 -04002113 c = alloc_ubifs_info(ubi);
2114 if (!c) {
2115 err = -ENOMEM;
2116 goto out_close;
2117 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002118
Al Virod251ed22011-06-12 10:24:33 -04002119 dbg_gen("opened ubi%d_%d", c->vi.ubi_num, c->vi.vol_id);
2120
David Howells9249e172012-06-25 12:55:37 +01002121 sb = sget(fs_type, sb_test, sb_set, flags, c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002122 if (IS_ERR(sb)) {
2123 err = PTR_ERR(sb);
Al Virod251ed22011-06-12 10:24:33 -04002124 kfree(c);
Dan Carpenter185bf872011-06-20 10:10:24 +03002125 goto out_close;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002126 }
2127
2128 if (sb->s_root) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03002129 struct ubifs_info *c1 = sb->s_fs_info;
Al Virod251ed22011-06-12 10:24:33 -04002130 kfree(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002131 /* A new mount point for already mounted UBIFS */
2132 dbg_gen("this ubi volume is already mounted");
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03002133 if (!!(flags & MS_RDONLY) != c1->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002134 err = -EBUSY;
2135 goto out_deact;
2136 }
2137 } else {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002138 err = ubifs_fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
2139 if (err)
2140 goto out_deact;
2141 /* We do not support atime */
2142 sb->s_flags |= MS_ACTIVE | MS_NOATIME;
2143 }
2144
2145 /* 'fill_super()' opens ubi again so we must close it here */
2146 ubi_close_volume(ubi);
2147
Al Viro157d81e2010-07-25 23:52:42 +04002148 return dget(sb->s_root);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002149
2150out_deact:
Al Viro6f5bbff2009-05-06 01:34:22 -04002151 deactivate_locked_super(sb);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002152out_close:
2153 ubi_close_volume(ubi);
Al Viro157d81e2010-07-25 23:52:42 +04002154 return ERR_PTR(err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002155}
2156
Al Virod251ed22011-06-12 10:24:33 -04002157static void kill_ubifs_super(struct super_block *s)
2158{
2159 struct ubifs_info *c = s->s_fs_info;
2160 kill_anon_super(s);
2161 kfree(c);
2162}
2163
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002164static struct file_system_type ubifs_fs_type = {
2165 .name = "ubifs",
2166 .owner = THIS_MODULE,
Al Viro157d81e2010-07-25 23:52:42 +04002167 .mount = ubifs_mount,
Al Virod251ed22011-06-12 10:24:33 -04002168 .kill_sb = kill_ubifs_super,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002169};
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002170MODULE_ALIAS_FS("ubifs");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002171
2172/*
2173 * Inode slab cache constructor.
2174 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -07002175static void inode_slab_ctor(void *obj)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002176{
2177 struct ubifs_inode *ui = obj;
2178 inode_init_once(&ui->vfs_inode);
2179}
2180
2181static int __init ubifs_init(void)
2182{
2183 int err;
2184
2185 BUILD_BUG_ON(sizeof(struct ubifs_ch) != 24);
2186
2187 /* Make sure node sizes are 8-byte aligned */
2188 BUILD_BUG_ON(UBIFS_CH_SZ & 7);
2189 BUILD_BUG_ON(UBIFS_INO_NODE_SZ & 7);
2190 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ & 7);
2191 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ & 7);
2192 BUILD_BUG_ON(UBIFS_DATA_NODE_SZ & 7);
2193 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ & 7);
2194 BUILD_BUG_ON(UBIFS_SB_NODE_SZ & 7);
2195 BUILD_BUG_ON(UBIFS_MST_NODE_SZ & 7);
2196 BUILD_BUG_ON(UBIFS_REF_NODE_SZ & 7);
2197 BUILD_BUG_ON(UBIFS_CS_NODE_SZ & 7);
2198 BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ & 7);
2199
2200 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ & 7);
2201 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ & 7);
2202 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ & 7);
2203 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ & 7);
2204 BUILD_BUG_ON(UBIFS_MAX_NODE_SZ & 7);
2205 BUILD_BUG_ON(MIN_WRITE_SZ & 7);
2206
2207 /* Check min. node size */
2208 BUILD_BUG_ON(UBIFS_INO_NODE_SZ < MIN_WRITE_SZ);
2209 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ < MIN_WRITE_SZ);
2210 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ < MIN_WRITE_SZ);
2211 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ < MIN_WRITE_SZ);
2212
2213 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2214 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2215 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ > UBIFS_MAX_NODE_SZ);
2216 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ > UBIFS_MAX_NODE_SZ);
2217
2218 /* Defined node sizes */
2219 BUILD_BUG_ON(UBIFS_SB_NODE_SZ != 4096);
2220 BUILD_BUG_ON(UBIFS_MST_NODE_SZ != 512);
2221 BUILD_BUG_ON(UBIFS_INO_NODE_SZ != 160);
2222 BUILD_BUG_ON(UBIFS_REF_NODE_SZ != 64);
2223
2224 /*
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02002225 * We use 2 bit wide bit-fields to store compression type, which should
2226 * be amended if more compressors are added. The bit-fields are:
Artem Bityutskiy553dea42008-11-01 14:57:49 +02002227 * @compr_type in 'struct ubifs_inode', @default_compr in
2228 * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02002229 */
2230 BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT > 4);
2231
2232 /*
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002233 * We require that PAGE_CACHE_SIZE is greater-than-or-equal-to
2234 * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2235 */
2236 if (PAGE_CACHE_SIZE < UBIFS_BLOCK_SIZE) {
Sheng Yong235c3622015-03-20 10:39:42 +00002237 pr_err("UBIFS error (pid %d): VFS page cache size is %u bytes, but UBIFS requires at least 4096 bytes",
2238 current->pid, (unsigned int)PAGE_CACHE_SIZE);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002239 return -EINVAL;
2240 }
2241
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002242 ubifs_inode_slab = kmem_cache_create("ubifs_inode_slab",
2243 sizeof(struct ubifs_inode), 0,
2244 SLAB_MEM_SPREAD | SLAB_RECLAIM_ACCOUNT,
2245 &inode_slab_ctor);
2246 if (!ubifs_inode_slab)
Al Viro5cc361e2011-12-12 23:58:21 -05002247 return -ENOMEM;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002248
Chao Yua1fe33a2015-05-18 16:43:02 +08002249 err = register_shrinker(&ubifs_shrinker_info);
2250 if (err)
2251 goto out_slab;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002252
2253 err = ubifs_compressors_init();
2254 if (err)
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002255 goto out_shrinker;
2256
2257 err = dbg_debugfs_init();
2258 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002259 goto out_compr;
2260
Al Viro5cc361e2011-12-12 23:58:21 -05002261 err = register_filesystem(&ubifs_fs_type);
2262 if (err) {
Sheng Yong235c3622015-03-20 10:39:42 +00002263 pr_err("UBIFS error (pid %d): cannot register file system, error %d",
2264 current->pid, err);
Al Viro5cc361e2011-12-12 23:58:21 -05002265 goto out_dbg;
2266 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002267 return 0;
2268
Al Viro5cc361e2011-12-12 23:58:21 -05002269out_dbg:
2270 dbg_debugfs_exit();
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002271out_compr:
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002272 ubifs_compressors_exit();
2273out_shrinker:
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002274 unregister_shrinker(&ubifs_shrinker_info);
Chao Yua1fe33a2015-05-18 16:43:02 +08002275out_slab:
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002276 kmem_cache_destroy(ubifs_inode_slab);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002277 return err;
2278}
2279/* late_initcall to let compressors initialize first */
2280late_initcall(ubifs_init);
2281
2282static void __exit ubifs_exit(void)
2283{
2284 ubifs_assert(list_empty(&ubifs_infos));
2285 ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt) == 0);
2286
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002287 dbg_debugfs_exit();
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002288 ubifs_compressors_exit();
2289 unregister_shrinker(&ubifs_shrinker_info);
Kirill A. Shutemov8c0a8532012-09-26 11:33:07 +10002290
2291 /*
2292 * Make sure all delayed rcu free inodes are flushed before we
2293 * destroy cache.
2294 */
2295 rcu_barrier();
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002296 kmem_cache_destroy(ubifs_inode_slab);
2297 unregister_filesystem(&ubifs_fs_type);
2298}
2299module_exit(ubifs_exit);
2300
2301MODULE_LICENSE("GPL");
2302MODULE_VERSION(__stringify(UBIFS_VERSION));
2303MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2304MODULE_DESCRIPTION("UBIFS - UBI File System");