blob: 727a9e3fa806fd6ed6ea9d1799c307cf4acd7ed5 [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
Dongsheng Yang8c1c5f22015-11-07 12:46:11 +0800131 inode->i_flags |= S_NOCMTIME;
132#ifndef CONFIG_UBIFS_ATIME_SUPPORT
133 inode->i_flags |= S_NOATIME;
134#endif
Miklos Szeredibfe86842011-10-28 14:13:29 +0200135 set_nlink(inode, le32_to_cpu(ino->nlink));
Eric W. Biederman39241be2012-02-07 15:50:56 -0800136 i_uid_write(inode, le32_to_cpu(ino->uid));
137 i_gid_write(inode, le32_to_cpu(ino->gid));
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300138 inode->i_atime.tv_sec = (int64_t)le64_to_cpu(ino->atime_sec);
139 inode->i_atime.tv_nsec = le32_to_cpu(ino->atime_nsec);
140 inode->i_mtime.tv_sec = (int64_t)le64_to_cpu(ino->mtime_sec);
141 inode->i_mtime.tv_nsec = le32_to_cpu(ino->mtime_nsec);
142 inode->i_ctime.tv_sec = (int64_t)le64_to_cpu(ino->ctime_sec);
143 inode->i_ctime.tv_nsec = le32_to_cpu(ino->ctime_nsec);
144 inode->i_mode = le32_to_cpu(ino->mode);
145 inode->i_size = le64_to_cpu(ino->size);
146
147 ui->data_len = le32_to_cpu(ino->data_len);
148 ui->flags = le32_to_cpu(ino->flags);
149 ui->compr_type = le16_to_cpu(ino->compr_type);
150 ui->creat_sqnum = le64_to_cpu(ino->creat_sqnum);
151 ui->xattr_cnt = le32_to_cpu(ino->xattr_cnt);
152 ui->xattr_size = le32_to_cpu(ino->xattr_size);
153 ui->xattr_names = le32_to_cpu(ino->xattr_names);
154 ui->synced_i_size = ui->ui_size = inode->i_size;
155
156 ui->xattr = (ui->flags & UBIFS_XATTR_FL) ? 1 : 0;
157
158 err = validate_inode(c, inode);
159 if (err)
160 goto out_invalid;
161
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300162 switch (inode->i_mode & S_IFMT) {
163 case S_IFREG:
164 inode->i_mapping->a_ops = &ubifs_file_address_operations;
165 inode->i_op = &ubifs_file_inode_operations;
166 inode->i_fop = &ubifs_file_operations;
167 if (ui->xattr) {
168 ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
169 if (!ui->data) {
170 err = -ENOMEM;
171 goto out_ino;
172 }
173 memcpy(ui->data, ino->data, ui->data_len);
174 ((char *)ui->data)[ui->data_len] = '\0';
175 } else if (ui->data_len != 0) {
176 err = 10;
177 goto out_invalid;
178 }
179 break;
180 case S_IFDIR:
181 inode->i_op = &ubifs_dir_inode_operations;
182 inode->i_fop = &ubifs_dir_operations;
183 if (ui->data_len != 0) {
184 err = 11;
185 goto out_invalid;
186 }
187 break;
188 case S_IFLNK:
189 inode->i_op = &ubifs_symlink_inode_operations;
190 if (ui->data_len <= 0 || ui->data_len > UBIFS_MAX_INO_DATA) {
191 err = 12;
192 goto out_invalid;
193 }
194 ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
195 if (!ui->data) {
196 err = -ENOMEM;
197 goto out_ino;
198 }
199 memcpy(ui->data, ino->data, ui->data_len);
200 ((char *)ui->data)[ui->data_len] = '\0';
Al Viro0f301bd2015-05-02 10:35:42 -0400201 inode->i_link = ui->data;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300202 break;
203 case S_IFBLK:
204 case S_IFCHR:
205 {
206 dev_t rdev;
207 union ubifs_dev_desc *dev;
208
209 ui->data = kmalloc(sizeof(union ubifs_dev_desc), GFP_NOFS);
210 if (!ui->data) {
211 err = -ENOMEM;
212 goto out_ino;
213 }
214
215 dev = (union ubifs_dev_desc *)ino->data;
216 if (ui->data_len == sizeof(dev->new))
217 rdev = new_decode_dev(le32_to_cpu(dev->new));
218 else if (ui->data_len == sizeof(dev->huge))
219 rdev = huge_decode_dev(le64_to_cpu(dev->huge));
220 else {
221 err = 13;
222 goto out_invalid;
223 }
224 memcpy(ui->data, ino->data, ui->data_len);
225 inode->i_op = &ubifs_file_inode_operations;
226 init_special_inode(inode, inode->i_mode, rdev);
227 break;
228 }
229 case S_IFSOCK:
230 case S_IFIFO:
231 inode->i_op = &ubifs_file_inode_operations;
232 init_special_inode(inode, inode->i_mode, 0);
233 if (ui->data_len != 0) {
234 err = 14;
235 goto out_invalid;
236 }
237 break;
238 default:
239 err = 15;
240 goto out_invalid;
241 }
242
243 kfree(ino);
244 ubifs_set_inode_flags(inode);
245 unlock_new_inode(inode);
246 return inode;
247
248out_invalid:
Sheng Yong235c3622015-03-20 10:39:42 +0000249 ubifs_err(c, "inode %lu validation failed, error %d", inode->i_ino, err);
Artem Bityutskiyedf6be22012-05-16 19:15:56 +0300250 ubifs_dump_node(c, ino);
251 ubifs_dump_inode(c, inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300252 err = -EINVAL;
253out_ino:
254 kfree(ino);
255out:
Sheng Yong235c3622015-03-20 10:39:42 +0000256 ubifs_err(c, "failed to read inode %lu, error %d", inode->i_ino, err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300257 iget_failed(inode);
258 return ERR_PTR(err);
259}
260
261static struct inode *ubifs_alloc_inode(struct super_block *sb)
262{
263 struct ubifs_inode *ui;
264
265 ui = kmem_cache_alloc(ubifs_inode_slab, GFP_NOFS);
266 if (!ui)
267 return NULL;
268
269 memset((void *)ui + sizeof(struct inode), 0,
270 sizeof(struct ubifs_inode) - sizeof(struct inode));
271 mutex_init(&ui->ui_mutex);
272 spin_lock_init(&ui->ui_lock);
273 return &ui->vfs_inode;
274};
275
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100276static void ubifs_i_callback(struct rcu_head *head)
277{
278 struct inode *inode = container_of(head, struct inode, i_rcu);
279 struct ubifs_inode *ui = ubifs_inode(inode);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100280 kmem_cache_free(ubifs_inode_slab, ui);
281}
282
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300283static void ubifs_destroy_inode(struct inode *inode)
284{
285 struct ubifs_inode *ui = ubifs_inode(inode);
286
287 kfree(ui->data);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100288 call_rcu(&inode->i_rcu, ubifs_i_callback);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300289}
290
291/*
292 * Note, Linux write-back code calls this without 'i_mutex'.
293 */
Christoph Hellwiga9185b42010-03-05 09:21:37 +0100294static int ubifs_write_inode(struct inode *inode, struct writeback_control *wbc)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300295{
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300296 int err = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300297 struct ubifs_info *c = inode->i_sb->s_fs_info;
298 struct ubifs_inode *ui = ubifs_inode(inode);
299
300 ubifs_assert(!ui->xattr);
301 if (is_bad_inode(inode))
302 return 0;
303
304 mutex_lock(&ui->ui_mutex);
305 /*
306 * Due to races between write-back forced by budgeting
Artem Bityutskiy5c57f202012-07-25 18:12:14 +0300307 * (see 'sync_some_inodes()') and background write-back, the inode may
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300308 * have already been synchronized, do not do this again. This might
309 * also happen if it was synchronized in an VFS operation, e.g.
310 * 'ubifs_link()'.
311 */
312 if (!ui->dirty) {
313 mutex_unlock(&ui->ui_mutex);
314 return 0;
315 }
316
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300317 /*
318 * As an optimization, do not write orphan inodes to the media just
319 * because this is not needed.
320 */
321 dbg_gen("inode %lu, mode %#x, nlink %u",
322 inode->i_ino, (int)inode->i_mode, inode->i_nlink);
323 if (inode->i_nlink) {
Artem Bityutskiy1f286812008-07-22 12:06:13 +0300324 err = ubifs_jnl_write_inode(c, inode);
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300325 if (err)
Sheng Yong235c3622015-03-20 10:39:42 +0000326 ubifs_err(c, "can't write inode %lu, error %d",
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300327 inode->i_ino, err);
Artem Bityutskiye3c3efc2009-08-27 16:34:19 +0300328 else
329 err = dbg_check_inode_size(c, inode, ui->ui_size);
Artem Bityutskiyfbfa6c82008-07-22 11:52:52 +0300330 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300331
332 ui->dirty = 0;
333 mutex_unlock(&ui->ui_mutex);
334 ubifs_release_dirty_inode_budget(c, ui);
335 return err;
336}
337
Al Virod640e1b2010-06-07 00:34:05 -0400338static void ubifs_evict_inode(struct inode *inode)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300339{
340 int err;
341 struct ubifs_info *c = inode->i_sb->s_fs_info;
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300342 struct ubifs_inode *ui = ubifs_inode(inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300343
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300344 if (ui->xattr)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300345 /*
346 * Extended attribute inode deletions are fully handled in
347 * 'ubifs_removexattr()'. These inodes are special and have
348 * limited usage, so there is nothing to do here.
349 */
350 goto out;
351
Artem Bityutskiy7d32c2b2008-07-18 18:54:29 +0300352 dbg_gen("inode %lu, mode %#x", inode->i_ino, (int)inode->i_mode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300353 ubifs_assert(!atomic_read(&inode->i_count));
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300354
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700355 truncate_inode_pages_final(&inode->i_data);
Al Virod640e1b2010-06-07 00:34:05 -0400356
357 if (inode->i_nlink)
358 goto done;
359
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300360 if (is_bad_inode(inode))
361 goto out;
362
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300363 ui->ui_size = inode->i_size = 0;
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300364 err = ubifs_jnl_delete_inode(c, inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300365 if (err)
366 /*
367 * Worst case we have a lost orphan inode wasting space, so a
Artem Bityutskiy0a883a02008-08-13 14:13:26 +0300368 * simple error message is OK here.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300369 */
Sheng Yong235c3622015-03-20 10:39:42 +0000370 ubifs_err(c, "can't delete inode %lu, error %d",
Artem Bityutskiyde94eb52008-07-22 13:06:20 +0300371 inode->i_ino, err);
372
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300373out:
Artem Bityutskiy1e0f3582008-07-21 10:59:53 +0300374 if (ui->dirty)
375 ubifs_release_dirty_inode_budget(c, ui);
Adrian Hunter6d6cb0d2009-04-08 14:07:57 +0200376 else {
377 /* We've deleted something - clean the "no space" flags */
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300378 c->bi.nospace = c->bi.nospace_rp = 0;
Adrian Hunter6d6cb0d2009-04-08 14:07:57 +0200379 smp_wmb();
380 }
Al Virod640e1b2010-06-07 00:34:05 -0400381done:
Jan Karadbd57682012-05-03 14:48:02 +0200382 clear_inode(inode);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300383}
384
Christoph Hellwigaa385722011-05-27 06:53:02 -0400385static void ubifs_dirty_inode(struct inode *inode, int flags)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300386{
387 struct ubifs_inode *ui = ubifs_inode(inode);
388
389 ubifs_assert(mutex_is_locked(&ui->ui_mutex));
390 if (!ui->dirty) {
391 ui->dirty = 1;
392 dbg_gen("inode %lu", inode->i_ino);
393 }
394}
395
396static int ubifs_statfs(struct dentry *dentry, struct kstatfs *buf)
397{
398 struct ubifs_info *c = dentry->d_sb->s_fs_info;
399 unsigned long long free;
Artem Bityutskiy7c7cbad2008-09-03 14:16:42 +0300400 __le32 *uuid = (__le32 *)c->uuid;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300401
Artem Bityutskiy7dad1812008-08-25 18:58:19 +0300402 free = ubifs_get_free_space(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300403 dbg_gen("free space %lld bytes (%lld blocks)",
404 free, free >> UBIFS_BLOCK_SHIFT);
405
406 buf->f_type = UBIFS_SUPER_MAGIC;
407 buf->f_bsize = UBIFS_BLOCK_SIZE;
408 buf->f_blocks = c->block_cnt;
409 buf->f_bfree = free >> UBIFS_BLOCK_SHIFT;
410 if (free > c->report_rp_size)
411 buf->f_bavail = (free - c->report_rp_size) >> UBIFS_BLOCK_SHIFT;
412 else
413 buf->f_bavail = 0;
414 buf->f_files = 0;
415 buf->f_ffree = 0;
416 buf->f_namelen = UBIFS_MAX_NLEN;
Artem Bityutskiy7c7cbad2008-09-03 14:16:42 +0300417 buf->f_fsid.val[0] = le32_to_cpu(uuid[0]) ^ le32_to_cpu(uuid[2]);
418 buf->f_fsid.val[1] = le32_to_cpu(uuid[1]) ^ le32_to_cpu(uuid[3]);
Artem Bityutskiyb4978e92009-01-23 18:23:03 +0200419 ubifs_assert(buf->f_bfree <= c->block_cnt);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300420 return 0;
421}
422
Al Viro34c80b12011-12-08 21:32:45 -0500423static int ubifs_show_options(struct seq_file *s, struct dentry *root)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300424{
Al Viro34c80b12011-12-08 21:32:45 -0500425 struct ubifs_info *c = root->d_sb->s_fs_info;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300426
427 if (c->mount_opts.unmount_mode == 2)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200428 seq_puts(s, ",fast_unmount");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300429 else if (c->mount_opts.unmount_mode == 1)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200430 seq_puts(s, ",norm_unmount");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300431
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300432 if (c->mount_opts.bulk_read == 2)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200433 seq_puts(s, ",bulk_read");
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300434 else if (c->mount_opts.bulk_read == 1)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200435 seq_puts(s, ",no_bulk_read");
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300436
Adrian Hunter2953e732008-09-04 16:26:00 +0300437 if (c->mount_opts.chk_data_crc == 2)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200438 seq_puts(s, ",chk_data_crc");
Adrian Hunter2953e732008-09-04 16:26:00 +0300439 else if (c->mount_opts.chk_data_crc == 1)
Fabian Frederickd4eb08f2014-07-15 21:26:35 +0200440 seq_puts(s, ",no_chk_data_crc");
Adrian Hunter2953e732008-09-04 16:26:00 +0300441
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200442 if (c->mount_opts.override_compr) {
Hunter Adrianfcabb342009-03-18 12:29:39 +0100443 seq_printf(s, ",compr=%s",
444 ubifs_compr_name(c->mount_opts.compr_type));
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200445 }
446
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300447 return 0;
448}
449
450static int ubifs_sync_fs(struct super_block *sb, int wait)
451{
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200452 int i, err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300453 struct ubifs_info *c = sb->s_fs_info;
Artem Bityutskiy304d4272008-12-28 08:04:17 +0200454
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800455 /*
Artem Bityutskiydedb0d42009-01-09 21:02:37 +0200456 * Zero @wait is just an advisory thing to help the file system shove
457 * lots of data into the queues, and there will be the second
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800458 * '->sync_fs()' call, with non-zero @wait.
459 */
Artem Bityutskiydedb0d42009-01-09 21:02:37 +0200460 if (!wait)
461 return 0;
Artem Bityutskiye8ea1752009-01-06 14:40:23 -0800462
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200463 /*
Adrian Hunter3eb14292009-01-29 11:17:24 +0200464 * Synchronize write buffers, because 'ubifs_run_commit()' does not
465 * do this if it waits for an already running commit.
466 */
467 for (i = 0; i < c->jhead_cnt; i++) {
468 err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
469 if (err)
470 return err;
471 }
472
Artem Bityutskiy887ee172009-07-20 17:56:19 +0300473 /*
474 * Strictly speaking, it is not necessary to commit the journal here,
475 * synchronizing write-buffers would be enough. But committing makes
476 * UBIFS free space predictions much more accurate, so we want to let
477 * the user be able to get more accurate results of 'statfs()' after
478 * they synchronize the file system.
479 */
Artem Bityutskiyf1038302008-12-28 08:16:32 +0200480 err = ubifs_run_commit(c);
481 if (err)
482 return err;
Artem Bityutskiy403e12a2008-09-09 12:31:37 +0300483
Artem Bityutskiycb5c6a22008-12-28 08:18:43 +0200484 return ubi_sync(c->vi.ubi_num);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300485}
486
487/**
488 * init_constants_early - initialize UBIFS constants.
489 * @c: UBIFS file-system description object
490 *
491 * This function initialize UBIFS constants which do not need the superblock to
492 * be read. It also checks that the UBI volume satisfies basic UBIFS
493 * requirements. Returns zero in case of success and a negative error code in
494 * case of failure.
495 */
496static int init_constants_early(struct ubifs_info *c)
497{
498 if (c->vi.corrupted) {
Sheng Yong235c3622015-03-20 10:39:42 +0000499 ubifs_warn(c, "UBI volume is corrupted - read-only mode");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300500 c->ro_media = 1;
501 }
502
503 if (c->di.ro_mode) {
Sheng Yong235c3622015-03-20 10:39:42 +0000504 ubifs_msg(c, "read-only UBI device");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300505 c->ro_media = 1;
506 }
507
508 if (c->vi.vol_type == UBI_STATIC_VOLUME) {
Sheng Yong235c3622015-03-20 10:39:42 +0000509 ubifs_msg(c, "static UBI volume - read-only mode");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300510 c->ro_media = 1;
511 }
512
513 c->leb_cnt = c->vi.size;
514 c->leb_size = c->vi.usable_leb_size;
Artem Bityutskiyca2ec612011-02-14 15:17:55 +0200515 c->leb_start = c->di.leb_start;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300516 c->half_leb_size = c->leb_size / 2;
517 c->min_io_size = c->di.min_io_size;
518 c->min_io_shift = fls(c->min_io_size) - 1;
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200519 c->max_write_size = c->di.max_write_size;
520 c->max_write_shift = fls(c->max_write_size) - 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300521
522 if (c->leb_size < UBIFS_MIN_LEB_SZ) {
Daniel Golledccbc912016-07-19 00:26:55 +0200523 ubifs_errc(c, "too small LEBs (%d bytes), min. is %d bytes",
524 c->leb_size, UBIFS_MIN_LEB_SZ);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300525 return -EINVAL;
526 }
527
528 if (c->leb_cnt < UBIFS_MIN_LEB_CNT) {
Daniel Golledccbc912016-07-19 00:26:55 +0200529 ubifs_errc(c, "too few LEBs (%d), min. is %d",
530 c->leb_cnt, UBIFS_MIN_LEB_CNT);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300531 return -EINVAL;
532 }
533
534 if (!is_power_of_2(c->min_io_size)) {
Daniel Golledccbc912016-07-19 00:26:55 +0200535 ubifs_errc(c, "bad min. I/O size %d", c->min_io_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300536 return -EINVAL;
537 }
538
539 /*
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200540 * Maximum write size has to be greater or equivalent to min. I/O
541 * size, and be multiple of min. I/O size.
542 */
543 if (c->max_write_size < c->min_io_size ||
544 c->max_write_size % c->min_io_size ||
545 !is_power_of_2(c->max_write_size)) {
Daniel Golledccbc912016-07-19 00:26:55 +0200546 ubifs_errc(c, "bad write buffer size %d for %d min. I/O unit",
547 c->max_write_size, c->min_io_size);
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200548 return -EINVAL;
549 }
550
551 /*
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300552 * UBIFS aligns all node to 8-byte boundary, so to make function in
553 * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
554 * less than 8.
555 */
556 if (c->min_io_size < 8) {
557 c->min_io_size = 8;
558 c->min_io_shift = 3;
Artem Bityutskiy3e8e2e02011-01-30 18:58:32 +0200559 if (c->max_write_size < c->min_io_size) {
560 c->max_write_size = c->min_io_size;
561 c->max_write_shift = c->min_io_shift;
562 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300563 }
564
565 c->ref_node_alsz = ALIGN(UBIFS_REF_NODE_SZ, c->min_io_size);
566 c->mst_node_alsz = ALIGN(UBIFS_MST_NODE_SZ, c->min_io_size);
567
568 /*
569 * Initialize node length ranges which are mostly needed for node
570 * length validation.
571 */
572 c->ranges[UBIFS_PAD_NODE].len = UBIFS_PAD_NODE_SZ;
573 c->ranges[UBIFS_SB_NODE].len = UBIFS_SB_NODE_SZ;
574 c->ranges[UBIFS_MST_NODE].len = UBIFS_MST_NODE_SZ;
575 c->ranges[UBIFS_REF_NODE].len = UBIFS_REF_NODE_SZ;
576 c->ranges[UBIFS_TRUN_NODE].len = UBIFS_TRUN_NODE_SZ;
577 c->ranges[UBIFS_CS_NODE].len = UBIFS_CS_NODE_SZ;
578
579 c->ranges[UBIFS_INO_NODE].min_len = UBIFS_INO_NODE_SZ;
580 c->ranges[UBIFS_INO_NODE].max_len = UBIFS_MAX_INO_NODE_SZ;
581 c->ranges[UBIFS_ORPH_NODE].min_len =
582 UBIFS_ORPH_NODE_SZ + sizeof(__le64);
583 c->ranges[UBIFS_ORPH_NODE].max_len = c->leb_size;
584 c->ranges[UBIFS_DENT_NODE].min_len = UBIFS_DENT_NODE_SZ;
585 c->ranges[UBIFS_DENT_NODE].max_len = UBIFS_MAX_DENT_NODE_SZ;
586 c->ranges[UBIFS_XENT_NODE].min_len = UBIFS_XENT_NODE_SZ;
587 c->ranges[UBIFS_XENT_NODE].max_len = UBIFS_MAX_XENT_NODE_SZ;
588 c->ranges[UBIFS_DATA_NODE].min_len = UBIFS_DATA_NODE_SZ;
589 c->ranges[UBIFS_DATA_NODE].max_len = UBIFS_MAX_DATA_NODE_SZ;
590 /*
591 * Minimum indexing node size is amended later when superblock is
592 * read and the key length is known.
593 */
594 c->ranges[UBIFS_IDX_NODE].min_len = UBIFS_IDX_NODE_SZ + UBIFS_BRANCH_SZ;
595 /*
596 * Maximum indexing node size is amended later when superblock is
597 * read and the fanout is known.
598 */
599 c->ranges[UBIFS_IDX_NODE].max_len = INT_MAX;
600
601 /*
Artem Bityutskiy70782022009-01-19 19:57:27 +0200602 * Initialize dead and dark LEB space watermarks. See gc.c for comments
603 * about these values.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300604 */
605 c->dead_wm = ALIGN(MIN_WRITE_SZ, c->min_io_size);
606 c->dark_wm = ALIGN(UBIFS_MAX_NODE_SZ, c->min_io_size);
607
Artem Bityutskiy9bbb5722008-08-22 18:23:22 +0300608 /*
609 * Calculate how many bytes would be wasted at the end of LEB if it was
610 * fully filled with data nodes of maximum size. This is used in
611 * calculations when reporting free space.
612 */
613 c->leb_overhead = c->leb_size % UBIFS_MAX_DATA_NODE_SZ;
Artem Bityutskiy39ce81c2008-11-18 18:09:49 +0200614
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300615 /* Buffer size for bulk-reads */
Artem Bityutskiy6c0c42c2008-11-18 20:20:05 +0200616 c->max_bu_buf_len = UBIFS_MAX_BULK_READ * UBIFS_MAX_DATA_NODE_SZ;
617 if (c->max_bu_buf_len > c->leb_size)
618 c->max_bu_buf_len = c->leb_size;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300619 return 0;
620}
621
622/**
623 * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
624 * @c: UBIFS file-system description object
625 * @lnum: LEB the write-buffer was synchronized to
626 * @free: how many free bytes left in this LEB
627 * @pad: how many bytes were padded
628 *
629 * This is a callback function which is called by the I/O unit when the
630 * write-buffer is synchronized. We need this to correctly maintain space
631 * accounting in bud logical eraseblocks. This function returns zero in case of
632 * success and a negative error code in case of failure.
633 *
634 * This function actually belongs to the journal, but we keep it here because
635 * we want to keep it static.
636 */
637static int bud_wbuf_callback(struct ubifs_info *c, int lnum, int free, int pad)
638{
639 return ubifs_update_one_lp(c, lnum, free, pad, 0, 0);
640}
641
642/*
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200643 * init_constants_sb - initialize UBIFS constants.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300644 * @c: UBIFS file-system description object
645 *
646 * This is a helper function which initializes various UBIFS constants after
647 * the superblock has been read. It also checks various UBIFS parameters and
648 * makes sure they are all right. Returns zero in case of success and a
649 * negative error code in case of failure.
650 */
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200651static int init_constants_sb(struct ubifs_info *c)
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300652{
653 int tmp, err;
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200654 long long tmp64;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300655
656 c->main_bytes = (long long)c->main_lebs * c->leb_size;
657 c->max_znode_sz = sizeof(struct ubifs_znode) +
658 c->fanout * sizeof(struct ubifs_zbranch);
659
660 tmp = ubifs_idx_node_sz(c, 1);
661 c->ranges[UBIFS_IDX_NODE].min_len = tmp;
662 c->min_idx_node_sz = ALIGN(tmp, 8);
663
664 tmp = ubifs_idx_node_sz(c, c->fanout);
665 c->ranges[UBIFS_IDX_NODE].max_len = tmp;
666 c->max_idx_node_sz = ALIGN(tmp, 8);
667
668 /* Make sure LEB size is large enough to fit full commit */
669 tmp = UBIFS_CS_NODE_SZ + UBIFS_REF_NODE_SZ * c->jhead_cnt;
670 tmp = ALIGN(tmp, c->min_io_size);
671 if (tmp > c->leb_size) {
Sheng Yong235c3622015-03-20 10:39:42 +0000672 ubifs_err(c, "too small LEB size %d, at least %d needed",
Artem Bityutskiya6aae4d2012-05-16 20:11:23 +0300673 c->leb_size, tmp);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300674 return -EINVAL;
675 }
676
677 /*
678 * Make sure that the log is large enough to fit reference nodes for
679 * all buds plus one reserved LEB.
680 */
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200681 tmp64 = c->max_bud_bytes + c->leb_size - 1;
682 c->max_bud_cnt = div_u64(tmp64, c->leb_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300683 tmp = (c->ref_node_alsz * c->max_bud_cnt + c->leb_size - 1);
684 tmp /= c->leb_size;
685 tmp += 1;
686 if (c->log_lebs < tmp) {
Sheng Yong235c3622015-03-20 10:39:42 +0000687 ubifs_err(c, "too small log %d LEBs, required min. %d LEBs",
Artem Bityutskiya6aae4d2012-05-16 20:11:23 +0300688 c->log_lebs, tmp);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300689 return -EINVAL;
690 }
691
692 /*
693 * When budgeting we assume worst-case scenarios when the pages are not
694 * be compressed and direntries are of the maximum size.
695 *
696 * Note, data, which may be stored in inodes is budgeted separately, so
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300697 * it is not included into 'c->bi.inode_budget'.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300698 */
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300699 c->bi.page_budget = UBIFS_MAX_DATA_NODE_SZ * UBIFS_BLOCKS_PER_PAGE;
700 c->bi.inode_budget = UBIFS_INO_NODE_SZ;
701 c->bi.dent_budget = UBIFS_MAX_DENT_NODE_SZ;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300702
703 /*
704 * When the amount of flash space used by buds becomes
705 * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
706 * The writers are unblocked when the commit is finished. To avoid
707 * writers to be blocked UBIFS initiates background commit in advance,
708 * when number of bud bytes becomes above the limit defined below.
709 */
710 c->bg_bud_bytes = (c->max_bud_bytes * 13) >> 4;
711
712 /*
713 * Ensure minimum journal size. All the bytes in the journal heads are
714 * considered to be used, when calculating the current journal usage.
715 * Consequently, if the journal is too small, UBIFS will treat it as
716 * always full.
717 */
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200718 tmp64 = (long long)(c->jhead_cnt + 1) * c->leb_size + 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300719 if (c->bg_bud_bytes < tmp64)
720 c->bg_bud_bytes = tmp64;
721 if (c->max_bud_bytes < tmp64 + c->leb_size)
722 c->max_bud_bytes = tmp64 + c->leb_size;
723
724 err = ubifs_calc_lpt_geom(c);
725 if (err)
726 return err;
727
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +0200728 /* Initialize effective LEB size used in budgeting calculations */
729 c->idx_leb_size = c->leb_size - c->max_idx_node_sz;
Artem Bityutskiy79807d02008-12-27 19:18:00 +0200730 return 0;
731}
732
733/*
734 * init_constants_master - initialize UBIFS constants.
735 * @c: UBIFS file-system description object
736 *
737 * This is a helper function which initializes various UBIFS constants after
738 * the master node has been read. It also checks various UBIFS parameters and
739 * makes sure they are all right.
740 */
741static void init_constants_master(struct ubifs_info *c)
742{
743 long long tmp64;
744
Artem Bityutskiyb1375452011-03-29 18:04:05 +0300745 c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
Artem Bityutskiyfb1cd012009-03-16 09:56:57 +0200746 c->report_rp_size = ubifs_reported_space(c, c->rp_size);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300747
748 /*
749 * Calculate total amount of FS blocks. This number is not used
750 * internally because it does not make much sense for UBIFS, but it is
751 * necessary to report something for the 'statfs()' call.
752 *
Artem Bityutskiy7dad1812008-08-25 18:58:19 +0300753 * Subtract the LEB reserved for GC, the LEB which is reserved for
Artem Bityutskiyaf14a1a2008-12-19 19:26:29 +0200754 * deletions, minimum LEBs for the index, and assume only one journal
755 * head is available.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300756 */
Artem Bityutskiyaf14a1a2008-12-19 19:26:29 +0200757 tmp64 = c->main_lebs - 1 - 1 - MIN_INDEX_LEBS - c->jhead_cnt + 1;
Artem Bityutskiy4d61db42008-12-18 14:06:51 +0200758 tmp64 *= (long long)c->leb_size - c->leb_overhead;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300759 tmp64 = ubifs_reported_space(c, tmp64);
760 c->block_cnt = tmp64 >> UBIFS_BLOCK_SHIFT;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300761}
762
763/**
764 * take_gc_lnum - reserve GC LEB.
765 * @c: UBIFS file-system description object
766 *
Artem Bityutskiyb4978e92009-01-23 18:23:03 +0200767 * This function ensures that the LEB reserved for garbage collection is marked
768 * as "taken" in lprops. We also have to set free space to LEB size and dirty
769 * space to zero, because lprops may contain out-of-date information if the
770 * file-system was un-mounted before it has been committed. This function
771 * returns zero in case of success and a negative error code in case of
772 * failure.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300773 */
774static int take_gc_lnum(struct ubifs_info *c)
775{
776 int err;
777
778 if (c->gc_lnum == -1) {
Sheng Yong235c3622015-03-20 10:39:42 +0000779 ubifs_err(c, "no LEB for GC");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300780 return -EINVAL;
781 }
782
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300783 /* And we have to tell lprops that this LEB is taken */
784 err = ubifs_change_one_lp(c, c->gc_lnum, c->leb_size, 0,
785 LPROPS_TAKEN, 0, 0);
786 return err;
787}
788
789/**
790 * alloc_wbufs - allocate write-buffers.
791 * @c: UBIFS file-system description object
792 *
793 * This helper function allocates and initializes UBIFS write-buffers. Returns
794 * zero in case of success and %-ENOMEM in case of failure.
795 */
796static int alloc_wbufs(struct ubifs_info *c)
797{
798 int i, err;
799
Fabian Frederick86b4c142014-06-23 18:41:23 +0200800 c->jheads = kcalloc(c->jhead_cnt, sizeof(struct ubifs_jhead),
801 GFP_KERNEL);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300802 if (!c->jheads)
803 return -ENOMEM;
804
805 /* Initialize journal heads */
806 for (i = 0; i < c->jhead_cnt; i++) {
807 INIT_LIST_HEAD(&c->jheads[i].buds_list);
808 err = ubifs_wbuf_init(c, &c->jheads[i].wbuf);
809 if (err)
810 return err;
811
812 c->jheads[i].wbuf.sync_callback = &bud_wbuf_callback;
813 c->jheads[i].wbuf.jhead = i;
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300814 c->jheads[i].grouped = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300815 }
816
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300817 /*
Artem Bityutskiy44156262012-05-14 19:49:35 +0300818 * Garbage Collector head does not need to be synchronized by timer.
819 * Also GC head nodes are not grouped.
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300820 */
Artem Bityutskiy0b335b92009-06-23 12:30:43 +0300821 c->jheads[GCHD].wbuf.no_timer = 1;
Artem Bityutskiy1a0b0692011-05-26 08:26:05 +0300822 c->jheads[GCHD].grouped = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300823
824 return 0;
825}
826
827/**
828 * free_wbufs - free write-buffers.
829 * @c: UBIFS file-system description object
830 */
831static void free_wbufs(struct ubifs_info *c)
832{
833 int i;
834
835 if (c->jheads) {
836 for (i = 0; i < c->jhead_cnt; i++) {
837 kfree(c->jheads[i].wbuf.buf);
838 kfree(c->jheads[i].wbuf.inodes);
839 }
840 kfree(c->jheads);
841 c->jheads = NULL;
842 }
843}
844
845/**
846 * free_orphans - free orphans.
847 * @c: UBIFS file-system description object
848 */
849static void free_orphans(struct ubifs_info *c)
850{
851 struct ubifs_orphan *orph;
852
853 while (c->orph_dnext) {
854 orph = c->orph_dnext;
855 c->orph_dnext = orph->dnext;
856 list_del(&orph->list);
857 kfree(orph);
858 }
859
860 while (!list_empty(&c->orph_list)) {
861 orph = list_entry(c->orph_list.next, struct ubifs_orphan, list);
862 list_del(&orph->list);
863 kfree(orph);
Sheng Yong235c3622015-03-20 10:39:42 +0000864 ubifs_err(c, "orphan list not empty at unmount");
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300865 }
866
867 vfree(c->orph_buf);
868 c->orph_buf = NULL;
869}
870
871/**
872 * free_buds - free per-bud objects.
873 * @c: UBIFS file-system description object
874 */
875static void free_buds(struct ubifs_info *c)
876{
Cody P Schaferbb25e492014-01-23 15:56:08 -0800877 struct ubifs_bud *bud, *n;
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300878
Cody P Schaferbb25e492014-01-23 15:56:08 -0800879 rbtree_postorder_for_each_entry_safe(bud, n, &c->buds, rb)
880 kfree(bud);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300881}
882
883/**
884 * check_volume_empty - check if the UBI volume is empty.
885 * @c: UBIFS file-system description object
886 *
887 * This function checks if the UBIFS volume is empty by looking if its LEBs are
888 * mapped or not. The result of checking is stored in the @c->empty variable.
889 * Returns zero in case of success and a negative error code in case of
890 * failure.
891 */
892static int check_volume_empty(struct ubifs_info *c)
893{
894 int lnum, err;
895
896 c->empty = 1;
897 for (lnum = 0; lnum < c->leb_cnt; lnum++) {
Artem Bityutskiyd3b25782011-06-03 14:22:05 +0300898 err = ubifs_is_mapped(c, lnum);
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300899 if (unlikely(err < 0))
900 return err;
901 if (err == 1) {
902 c->empty = 0;
903 break;
904 }
905
906 cond_resched();
907 }
908
909 return 0;
910}
911
912/*
913 * UBIFS mount options.
914 *
915 * Opt_fast_unmount: do not run a journal commit before un-mounting
916 * Opt_norm_unmount: run a journal commit before un-mounting
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300917 * Opt_bulk_read: enable bulk-reads
918 * Opt_no_bulk_read: disable bulk-reads
Adrian Hunter2953e732008-09-04 16:26:00 +0300919 * Opt_chk_data_crc: check CRCs when reading data nodes
920 * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200921 * Opt_override_compr: override default compressor
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300922 * Opt_err: just end of array marker
923 */
924enum {
925 Opt_fast_unmount,
926 Opt_norm_unmount,
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300927 Opt_bulk_read,
928 Opt_no_bulk_read,
Adrian Hunter2953e732008-09-04 16:26:00 +0300929 Opt_chk_data_crc,
930 Opt_no_chk_data_crc,
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200931 Opt_override_compr,
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300932 Opt_err,
933};
934
Steven Whitehousea447c092008-10-13 10:46:57 +0100935static const match_table_t tokens = {
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300936 {Opt_fast_unmount, "fast_unmount"},
937 {Opt_norm_unmount, "norm_unmount"},
Adrian Hunter4793e7c2008-09-02 16:29:46 +0300938 {Opt_bulk_read, "bulk_read"},
939 {Opt_no_bulk_read, "no_bulk_read"},
Adrian Hunter2953e732008-09-04 16:26:00 +0300940 {Opt_chk_data_crc, "chk_data_crc"},
941 {Opt_no_chk_data_crc, "no_chk_data_crc"},
Artem Bityutskiy553dea42008-11-01 14:57:49 +0200942 {Opt_override_compr, "compr=%s"},
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300943 {Opt_err, NULL},
944};
945
946/**
Artem Bityutskiy8379ea32009-05-29 12:34:52 +0300947 * parse_standard_option - parse a standard mount option.
948 * @option: the option to parse
949 *
950 * Normally, standard mount options like "sync" are passed to file-systems as
951 * flags. However, when a "rootflags=" kernel boot parameter is used, they may
952 * be present in the options string. This function tries to deal with this
953 * situation and parse standard options. Returns 0 if the option was not
954 * recognized, and the corresponding integer flag if it was.
955 *
956 * UBIFS is only interested in the "sync" option, so do not check for anything
957 * else.
958 */
959static int parse_standard_option(const char *option)
960{
Sheng Yong235c3622015-03-20 10:39:42 +0000961
962 pr_notice("UBIFS: parse %s\n", option);
Artem Bityutskiy8379ea32009-05-29 12:34:52 +0300963 if (!strcmp(option, "sync"))
964 return MS_SYNCHRONOUS;
965 return 0;
966}
967
968/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300969 * ubifs_parse_options - parse mount parameters.
970 * @c: UBIFS file-system description object
971 * @options: parameters to parse
972 * @is_remount: non-zero if this is FS re-mount
973 *
974 * This function parses UBIFS mount options and returns zero in case success
975 * and a negative error code in case of failure.
976 */
977static int ubifs_parse_options(struct ubifs_info *c, char *options,
978 int is_remount)
979{
980 char *p;
981 substring_t args[MAX_OPT_ARGS];
982
983 if (!options)
984 return 0;
985
986 while ((p = strsep(&options, ","))) {
987 int token;
988
989 if (!*p)
990 continue;
991
992 token = match_token(p, tokens, args);
993 switch (token) {
Artem Bityutskiy27ad2792009-01-29 16:34:30 +0200994 /*
995 * %Opt_fast_unmount and %Opt_norm_unmount options are ignored.
Artem Bityutskiycb54ef82009-06-23 20:30:32 +0300996 * We accept them in order to be backward-compatible. But this
Artem Bityutskiy27ad2792009-01-29 16:34:30 +0200997 * should be removed at some point.
998 */
Artem Bityutskiy1e517642008-07-14 19:08:37 +0300999 case Opt_fast_unmount:
1000 c->mount_opts.unmount_mode = 2;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001001 break;
1002 case Opt_norm_unmount:
1003 c->mount_opts.unmount_mode = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001004 break;
Adrian Hunter4793e7c2008-09-02 16:29:46 +03001005 case Opt_bulk_read:
1006 c->mount_opts.bulk_read = 2;
1007 c->bulk_read = 1;
1008 break;
1009 case Opt_no_bulk_read:
1010 c->mount_opts.bulk_read = 1;
1011 c->bulk_read = 0;
1012 break;
Adrian Hunter2953e732008-09-04 16:26:00 +03001013 case Opt_chk_data_crc:
1014 c->mount_opts.chk_data_crc = 2;
1015 c->no_chk_data_crc = 0;
1016 break;
1017 case Opt_no_chk_data_crc:
1018 c->mount_opts.chk_data_crc = 1;
1019 c->no_chk_data_crc = 1;
1020 break;
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001021 case Opt_override_compr:
1022 {
1023 char *name = match_strdup(&args[0]);
1024
1025 if (!name)
1026 return -ENOMEM;
1027 if (!strcmp(name, "none"))
1028 c->mount_opts.compr_type = UBIFS_COMPR_NONE;
1029 else if (!strcmp(name, "lzo"))
1030 c->mount_opts.compr_type = UBIFS_COMPR_LZO;
1031 else if (!strcmp(name, "zlib"))
1032 c->mount_opts.compr_type = UBIFS_COMPR_ZLIB;
1033 else {
Sheng Yong235c3622015-03-20 10:39:42 +00001034 ubifs_err(c, "unknown compressor \"%s\"", name); //FIXME: is c ready?
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001035 kfree(name);
1036 return -EINVAL;
1037 }
1038 kfree(name);
1039 c->mount_opts.override_compr = 1;
1040 c->default_compr = c->mount_opts.compr_type;
1041 break;
1042 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001043 default:
Artem Bityutskiy8379ea32009-05-29 12:34:52 +03001044 {
1045 unsigned long flag;
1046 struct super_block *sb = c->vfs_sb;
1047
1048 flag = parse_standard_option(p);
1049 if (!flag) {
Sheng Yong235c3622015-03-20 10:39:42 +00001050 ubifs_err(c, "unrecognized mount option \"%s\" or missing value",
Artem Bityutskiy79fda512012-08-27 13:34:09 +03001051 p);
Artem Bityutskiy8379ea32009-05-29 12:34:52 +03001052 return -EINVAL;
1053 }
1054 sb->s_flags |= flag;
1055 break;
1056 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001057 }
1058 }
1059
1060 return 0;
1061}
1062
1063/**
1064 * destroy_journal - destroy journal data structures.
1065 * @c: UBIFS file-system description object
1066 *
1067 * This function destroys journal data structures including those that may have
1068 * been created by recovery functions.
1069 */
1070static void destroy_journal(struct ubifs_info *c)
1071{
1072 while (!list_empty(&c->unclean_leb_list)) {
1073 struct ubifs_unclean_leb *ucleb;
1074
1075 ucleb = list_entry(c->unclean_leb_list.next,
1076 struct ubifs_unclean_leb, list);
1077 list_del(&ucleb->list);
1078 kfree(ucleb);
1079 }
1080 while (!list_empty(&c->old_buds)) {
1081 struct ubifs_bud *bud;
1082
1083 bud = list_entry(c->old_buds.next, struct ubifs_bud, list);
1084 list_del(&bud->list);
1085 kfree(bud);
1086 }
1087 ubifs_destroy_idx_gc(c);
1088 ubifs_destroy_size_tree(c);
1089 ubifs_tnc_close(c);
1090 free_buds(c);
1091}
1092
1093/**
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001094 * bu_init - initialize bulk-read information.
1095 * @c: UBIFS file-system description object
1096 */
1097static void bu_init(struct ubifs_info *c)
1098{
1099 ubifs_assert(c->bulk_read == 1);
1100
1101 if (c->bu.buf)
1102 return; /* Already initialized */
1103
1104again:
1105 c->bu.buf = kmalloc(c->max_bu_buf_len, GFP_KERNEL | __GFP_NOWARN);
1106 if (!c->bu.buf) {
1107 if (c->max_bu_buf_len > UBIFS_KMALLOC_OK) {
1108 c->max_bu_buf_len = UBIFS_KMALLOC_OK;
1109 goto again;
1110 }
1111
1112 /* Just disable bulk-read */
Sheng Yong235c3622015-03-20 10:39:42 +00001113 ubifs_warn(c, "cannot allocate %d bytes of memory for bulk-read, disabling it",
Artem Bityutskiy79fda512012-08-27 13:34:09 +03001114 c->max_bu_buf_len);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001115 c->mount_opts.bulk_read = 1;
1116 c->bulk_read = 0;
1117 return;
1118 }
1119}
1120
1121/**
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001122 * check_free_space - check if there is enough free space to mount.
1123 * @c: UBIFS file-system description object
1124 *
1125 * This function makes sure UBIFS has enough free space to be mounted in
1126 * read/write mode. UBIFS must always have some free space to allow deletions.
1127 */
1128static int check_free_space(struct ubifs_info *c)
1129{
1130 ubifs_assert(c->dark_wm > 0);
1131 if (c->lst.total_free + c->lst.total_dirty < c->dark_wm) {
Sheng Yong235c3622015-03-20 10:39:42 +00001132 ubifs_err(c, "insufficient free space to mount in R/W mode");
Artem Bityutskiyedf6be22012-05-16 19:15:56 +03001133 ubifs_dump_budg(c, &c->bi);
1134 ubifs_dump_lprops(c);
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001135 return -ENOSPC;
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001136 }
1137 return 0;
1138}
1139
1140/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001141 * mount_ubifs - mount UBIFS file-system.
1142 * @c: UBIFS file-system description object
1143 *
1144 * This function mounts UBIFS file system. Returns zero in case of success and
1145 * a negative error code in case of failure.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001146 */
1147static int mount_ubifs(struct ubifs_info *c)
1148{
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001149 int err;
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001150 long long x, y;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001151 size_t sz;
1152
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001153 c->ro_mount = !!(c->vfs_sb->s_flags & MS_RDONLY);
Daniel Golle90bea5a32014-06-02 15:51:10 +02001154 /* Suppress error messages while probing if MS_SILENT is set */
1155 c->probing = !!(c->vfs_sb->s_flags & MS_SILENT);
1156
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001157 err = init_constants_early(c);
1158 if (err)
1159 return err;
1160
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001161 err = ubifs_debugging_init(c);
1162 if (err)
1163 return err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001164
1165 err = check_volume_empty(c);
1166 if (err)
1167 goto out_free;
1168
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001169 if (c->empty && (c->ro_mount || c->ro_media)) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001170 /*
1171 * This UBI volume is empty, and read-only, or the file system
1172 * is mounted read-only - we cannot format it.
1173 */
Sheng Yong235c3622015-03-20 10:39:42 +00001174 ubifs_err(c, "can't format empty UBI volume: read-only %s",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001175 c->ro_media ? "UBI volume" : "mount");
1176 err = -EROFS;
1177 goto out_free;
1178 }
1179
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001180 if (c->ro_media && !c->ro_mount) {
Sheng Yong235c3622015-03-20 10:39:42 +00001181 ubifs_err(c, "cannot mount read-write - read-only media");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001182 err = -EROFS;
1183 goto out_free;
1184 }
1185
1186 /*
1187 * The requirement for the buffer is that it should fit indexing B-tree
1188 * height amount of integers. We assume the height if the TNC tree will
1189 * never exceed 64.
1190 */
1191 err = -ENOMEM;
1192 c->bottom_up_buf = kmalloc(BOTTOM_UP_HEIGHT * sizeof(int), GFP_KERNEL);
1193 if (!c->bottom_up_buf)
1194 goto out_free;
1195
1196 c->sbuf = vmalloc(c->leb_size);
1197 if (!c->sbuf)
1198 goto out_free;
1199
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001200 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001201 c->ileb_buf = vmalloc(c->leb_size);
1202 if (!c->ileb_buf)
1203 goto out_free;
1204 }
1205
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001206 if (c->bulk_read == 1)
1207 bu_init(c);
1208
Matthew L. Creechd8829622011-03-04 17:55:02 -05001209 if (!c->ro_mount) {
1210 c->write_reserve_buf = kmalloc(COMPRESSED_DATA_NODE_BUF_SZ,
1211 GFP_KERNEL);
1212 if (!c->write_reserve_buf)
1213 goto out_free;
1214 }
1215
Artem Bityutskiy18d1d7f2011-01-17 22:27:56 +02001216 c->mounting = 1;
Adrian Hunter2953e732008-09-04 16:26:00 +03001217
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001218 err = ubifs_read_superblock(c);
1219 if (err)
1220 goto out_free;
1221
Daniel Golle90bea5a32014-06-02 15:51:10 +02001222 c->probing = 0;
1223
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001224 /*
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001225 * Make sure the compressor which is set as default in the superblock
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001226 * or overridden by mount options is actually compiled in.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001227 */
1228 if (!ubifs_compr_present(c->default_compr)) {
Sheng Yong235c3622015-03-20 10:39:42 +00001229 ubifs_err(c, "'compressor \"%s\" is not compiled in",
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001230 ubifs_compr_name(c->default_compr));
Corentin Chary8eec2f32009-05-25 08:49:10 +02001231 err = -ENOTSUPP;
Artem Bityutskiy553dea42008-11-01 14:57:49 +02001232 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001233 }
1234
Artem Bityutskiy79807d02008-12-27 19:18:00 +02001235 err = init_constants_sb(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001236 if (err)
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001237 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001238
1239 sz = ALIGN(c->max_idx_node_sz, c->min_io_size);
1240 sz = ALIGN(sz + c->max_idx_node_sz, c->min_io_size);
1241 c->cbuf = kmalloc(sz, GFP_NOFS);
1242 if (!c->cbuf) {
1243 err = -ENOMEM;
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001244 goto out_free;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001245 }
1246
Artem Bityutskiyb50b9f42011-04-25 18:17:09 +03001247 err = alloc_wbufs(c);
1248 if (err)
1249 goto out_cbuf;
1250
Sebastian Siewior0855f312008-09-09 11:17:29 +02001251 sprintf(c->bgt_name, BGT_NAME_PATTERN, c->vi.ubi_num, c->vi.vol_id);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001252 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001253 /* Create background thread */
Hunter Adrianfcabb342009-03-18 12:29:39 +01001254 c->bgt = kthread_create(ubifs_bg_thread, c, "%s", c->bgt_name);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001255 if (IS_ERR(c->bgt)) {
1256 err = PTR_ERR(c->bgt);
1257 c->bgt = NULL;
Sheng Yong235c3622015-03-20 10:39:42 +00001258 ubifs_err(c, "cannot spawn \"%s\", error %d",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001259 c->bgt_name, err);
1260 goto out_wbufs;
1261 }
1262 wake_up_process(c->bgt);
1263 }
1264
1265 err = ubifs_read_master(c);
1266 if (err)
1267 goto out_master;
1268
Ben Gardiner09801192011-05-30 14:56:16 -04001269 init_constants_master(c);
1270
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001271 if ((c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY)) != 0) {
Sheng Yong235c3622015-03-20 10:39:42 +00001272 ubifs_msg(c, "recovery needed");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001273 c->need_recovery = 1;
Ben Gardiner781c5712011-05-30 14:56:15 -04001274 }
1275
Ben Gardiner781c5712011-05-30 14:56:15 -04001276 if (c->need_recovery && !c->ro_mount) {
1277 err = ubifs_recover_inl_heads(c, c->sbuf);
1278 if (err)
1279 goto out_master;
1280 }
1281
1282 err = ubifs_lpt_init(c, 1, !c->ro_mount);
1283 if (err)
1284 goto out_master;
1285
Ben Gardiner09801192011-05-30 14:56:16 -04001286 if (!c->ro_mount && c->space_fixup) {
1287 err = ubifs_fixup_free_space(c);
1288 if (err)
Sidney Amani56b04e32012-05-18 14:32:37 +03001289 goto out_lpt;
Ben Gardiner09801192011-05-30 14:56:16 -04001290 }
1291
Sheng Yong2c845992015-03-04 10:46:16 +00001292 if (!c->ro_mount && !c->need_recovery) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001293 /*
1294 * Set the "dirty" flag so that if we reboot uncleanly we
1295 * will notice this immediately on the next mount.
1296 */
1297 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1298 err = ubifs_write_master(c);
1299 if (err)
Ben Gardiner781c5712011-05-30 14:56:15 -04001300 goto out_lpt;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001301 }
1302
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001303 err = dbg_check_idx_size(c, c->bi.old_idx_sz);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001304 if (err)
1305 goto out_lpt;
1306
1307 err = ubifs_replay_journal(c);
1308 if (err)
1309 goto out_journal;
1310
Artem Bityutskiy1fb8bd02009-06-28 18:31:58 +03001311 /* Calculate 'min_idx_lebs' after journal replay */
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001312 c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
Artem Bityutskiy1fb8bd02009-06-28 18:31:58 +03001313
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001314 err = ubifs_mount_orphans(c, c->need_recovery, c->ro_mount);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001315 if (err)
1316 goto out_orphans;
1317
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001318 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001319 int lnum;
1320
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001321 err = check_free_space(c);
1322 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001323 goto out_orphans;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001324
1325 /* Check for enough log space */
1326 lnum = c->lhead_lnum + 1;
1327 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1328 lnum = UBIFS_LOG_LNUM;
1329 if (lnum == c->ltail_lnum) {
1330 err = ubifs_consolidate_log(c);
1331 if (err)
1332 goto out_orphans;
1333 }
1334
1335 if (c->need_recovery) {
1336 err = ubifs_recover_size(c);
1337 if (err)
1338 goto out_orphans;
1339 err = ubifs_rcvry_gc_commit(c);
Artem Bityutskiy276de5d2010-05-23 14:16:13 +03001340 if (err)
1341 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001342 } else {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001343 err = take_gc_lnum(c);
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001344 if (err)
1345 goto out_orphans;
1346
1347 /*
1348 * GC LEB may contain garbage if there was an unclean
1349 * reboot, and it should be un-mapped.
1350 */
1351 err = ubifs_leb_unmap(c, c->gc_lnum);
1352 if (err)
Matthieu CASTETc18de722010-08-02 11:36:06 +02001353 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001354 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001355
1356 err = dbg_check_lprops(c);
1357 if (err)
1358 goto out_orphans;
1359 } else if (c->need_recovery) {
1360 err = ubifs_recover_size(c);
1361 if (err)
1362 goto out_orphans;
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001363 } else {
1364 /*
1365 * Even if we mount read-only, we have to set space in GC LEB
1366 * to proper value because this affects UBIFS free space
1367 * reporting. We do not want to have a situation when
1368 * re-mounting from R/O to R/W changes amount of free space.
1369 */
1370 err = take_gc_lnum(c);
1371 if (err)
1372 goto out_orphans;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001373 }
1374
1375 spin_lock(&ubifs_infos_lock);
1376 list_add_tail(&c->infos_list, &ubifs_infos);
1377 spin_unlock(&ubifs_infos_lock);
1378
1379 if (c->need_recovery) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001380 if (c->ro_mount)
Sheng Yong235c3622015-03-20 10:39:42 +00001381 ubifs_msg(c, "recovery deferred");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001382 else {
1383 c->need_recovery = 0;
Sheng Yong235c3622015-03-20 10:39:42 +00001384 ubifs_msg(c, "recovery completed");
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001385 /*
1386 * GC LEB has to be empty and taken at this point. But
1387 * the journal head LEBs may also be accounted as
1388 * "empty taken" if they are empty.
1389 */
1390 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001391 }
Artem Bityutskiy6ba87c92009-01-26 16:12:20 +02001392 } else
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001393 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy552ff312008-10-23 11:49:28 +03001394
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001395 err = dbg_check_filesystem(c);
1396 if (err)
1397 goto out_infos;
1398
Artem Bityutskiy6ba87c92009-01-26 16:12:20 +02001399 err = dbg_debugfs_init_fs(c);
1400 if (err)
1401 goto out_infos;
1402
Artem Bityutskiy18d1d7f2011-01-17 22:27:56 +02001403 c->mounting = 0;
Adrian Hunter2953e732008-09-04 16:26:00 +03001404
Sheng Yong235c3622015-03-20 10:39:42 +00001405 ubifs_msg(c, "UBIFS: mounted UBI device %d, volume %d, name \"%s\"%s",
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001406 c->vi.ubi_num, c->vi.vol_id, c->vi.name,
Richard Genoudbeadadf2013-04-02 12:24:37 +02001407 c->ro_mount ? ", R/O mode" : "");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001408 x = (long long)c->main_lebs * c->leb_size;
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001409 y = (long long)c->log_lebs * c->leb_size + c->max_bud_bytes;
Sheng Yong235c3622015-03-20 10:39:42 +00001410 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 +03001411 c->leb_size, c->leb_size >> 10, c->min_io_size,
1412 c->max_write_size);
Sheng Yong235c3622015-03-20 10:39:42 +00001413 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 +03001414 x, x >> 20, c->main_lebs,
1415 y, y >> 20, c->log_lebs + c->max_bud_cnt);
Sheng Yong235c3622015-03-20 10:39:42 +00001416 ubifs_msg(c, "reserved for root: %llu bytes (%llu KiB)",
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001417 c->report_rp_size, c->report_rp_size >> 10);
Sheng Yong235c3622015-03-20 10:39:42 +00001418 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 +02001419 c->fmt_version, c->ro_compat_version,
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001420 UBIFS_FORMAT_VERSION, UBIFS_RO_COMPAT_VERSION, c->uuid,
1421 c->big_lpt ? ", big LPT model" : ", small LPT model");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001422
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001423 dbg_gen("default compressor: %s", ubifs_compr_name(c->default_compr));
1424 dbg_gen("data journal heads: %d",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001425 c->jhead_cnt - NONDATA_JHEADS_CNT);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001426 dbg_gen("log LEBs: %d (%d - %d)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001427 c->log_lebs, UBIFS_LOG_LNUM, c->log_last);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001428 dbg_gen("LPT area LEBs: %d (%d - %d)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001429 c->lpt_lebs, c->lpt_first, c->lpt_last);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001430 dbg_gen("orphan area LEBs: %d (%d - %d)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001431 c->orph_lebs, c->orph_first, c->orph_last);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001432 dbg_gen("main area LEBs: %d (%d - %d)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001433 c->main_lebs, c->main_first, c->leb_cnt - 1);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001434 dbg_gen("index LEBs: %d", c->lst.idx_lebs);
1435 dbg_gen("total index bytes: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001436 c->bi.old_idx_sz, c->bi.old_idx_sz >> 10,
1437 c->bi.old_idx_sz >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001438 dbg_gen("key hash type: %d", c->key_hash_type);
1439 dbg_gen("tree fanout: %d", c->fanout);
1440 dbg_gen("reserved GC LEB: %d", c->gc_lnum);
1441 dbg_gen("max. znode size %d", c->max_znode_sz);
1442 dbg_gen("max. index node size %d", c->max_idx_node_sz);
1443 dbg_gen("node sizes: data %zu, inode %zu, dentry %zu",
Artem Bityutskiy8e5033a2008-12-30 18:37:45 +02001444 UBIFS_DATA_NODE_SZ, UBIFS_INO_NODE_SZ, UBIFS_DENT_NODE_SZ);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001445 dbg_gen("node sizes: trun %zu, sb %zu, master %zu",
Artem Bityutskiy8e5033a2008-12-30 18:37:45 +02001446 UBIFS_TRUN_NODE_SZ, UBIFS_SB_NODE_SZ, UBIFS_MST_NODE_SZ);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001447 dbg_gen("node sizes: ref %zu, cmt. start %zu, orph %zu",
Artem Bityutskiy8e5033a2008-12-30 18:37:45 +02001448 UBIFS_REF_NODE_SZ, UBIFS_CS_NODE_SZ, UBIFS_ORPH_NODE_SZ);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001449 dbg_gen("max. node sizes: data %zu, inode %zu dentry %zu, idx %d",
Artem Bityutskiyc4361572011-03-25 15:27:40 +02001450 UBIFS_MAX_DATA_NODE_SZ, UBIFS_MAX_INO_NODE_SZ,
Artem Bityutskiy6342aae2011-03-08 14:26:47 +02001451 UBIFS_MAX_DENT_NODE_SZ, ubifs_idx_node_sz(c, c->fanout));
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001452 dbg_gen("dead watermark: %d", c->dead_wm);
1453 dbg_gen("dark watermark: %d", c->dark_wm);
1454 dbg_gen("LEB overhead: %d", c->leb_overhead);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001455 x = (long long)c->main_lebs * c->dark_wm;
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001456 dbg_gen("max. dark space: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001457 x, x >> 10, x >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001458 dbg_gen("maximum bud bytes: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001459 c->max_bud_bytes, c->max_bud_bytes >> 10,
1460 c->max_bud_bytes >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001461 dbg_gen("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001462 c->bg_bud_bytes, c->bg_bud_bytes >> 10,
1463 c->bg_bud_bytes >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001464 dbg_gen("current bud bytes %lld (%lld KiB, %lld MiB)",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001465 c->bud_bytes, c->bud_bytes >> 10, c->bud_bytes >> 20);
Artem Bityutskiy3668b702012-08-27 16:56:58 +03001466 dbg_gen("max. seq. number: %llu", c->max_sqnum);
1467 dbg_gen("commit number: %llu", c->cmt_no);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001468
1469 return 0;
1470
1471out_infos:
1472 spin_lock(&ubifs_infos_lock);
1473 list_del(&c->infos_list);
1474 spin_unlock(&ubifs_infos_lock);
1475out_orphans:
1476 free_orphans(c);
1477out_journal:
1478 destroy_journal(c);
1479out_lpt:
1480 ubifs_lpt_free(c, 0);
1481out_master:
1482 kfree(c->mst_node);
1483 kfree(c->rcvrd_mst_node);
1484 if (c->bgt)
1485 kthread_stop(c->bgt);
1486out_wbufs:
1487 free_wbufs(c);
1488out_cbuf:
1489 kfree(c->cbuf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001490out_free:
Matthew L. Creechd8829622011-03-04 17:55:02 -05001491 kfree(c->write_reserve_buf);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001492 kfree(c->bu.buf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001493 vfree(c->ileb_buf);
1494 vfree(c->sbuf);
1495 kfree(c->bottom_up_buf);
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001496 ubifs_debugging_exit(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001497 return err;
1498}
1499
1500/**
1501 * ubifs_umount - un-mount UBIFS file-system.
1502 * @c: UBIFS file-system description object
1503 *
1504 * Note, this function is called to free allocated resourced when un-mounting,
1505 * as well as free resources when an error occurred while we were half way
1506 * through mounting (error path cleanup function). So it has to make sure the
1507 * resource was actually allocated before freeing it.
1508 */
1509static void ubifs_umount(struct ubifs_info *c)
1510{
1511 dbg_gen("un-mounting UBI device %d, volume %d", c->vi.ubi_num,
1512 c->vi.vol_id);
1513
Artem Bityutskiy552ff312008-10-23 11:49:28 +03001514 dbg_debugfs_exit_fs(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001515 spin_lock(&ubifs_infos_lock);
1516 list_del(&c->infos_list);
1517 spin_unlock(&ubifs_infos_lock);
1518
1519 if (c->bgt)
1520 kthread_stop(c->bgt);
1521
1522 destroy_journal(c);
1523 free_wbufs(c);
1524 free_orphans(c);
1525 ubifs_lpt_free(c, 0);
1526
1527 kfree(c->cbuf);
1528 kfree(c->rcvrd_mst_node);
1529 kfree(c->mst_node);
Matthew L. Creechd8829622011-03-04 17:55:02 -05001530 kfree(c->write_reserve_buf);
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001531 kfree(c->bu.buf);
1532 vfree(c->ileb_buf);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001533 vfree(c->sbuf);
1534 kfree(c->bottom_up_buf);
Artem Bityutskiy17c2f9f2008-10-17 13:31:39 +03001535 ubifs_debugging_exit(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001536}
1537
1538/**
1539 * ubifs_remount_rw - re-mount in read-write mode.
1540 * @c: UBIFS file-system description object
1541 *
1542 * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1543 * mode. This function allocates the needed resources and re-mounts UBIFS in
1544 * read-write mode.
1545 */
1546static int ubifs_remount_rw(struct ubifs_info *c)
1547{
1548 int err, lnum;
1549
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001550 if (c->rw_incompat) {
Sheng Yong235c3622015-03-20 10:39:42 +00001551 ubifs_err(c, "the file-system is not R/W-compatible");
1552 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 +03001553 c->fmt_version, c->ro_compat_version,
1554 UBIFS_FORMAT_VERSION, UBIFS_RO_COMPAT_VERSION);
Artem Bityutskiy963f0cf2009-03-26 12:51:21 +02001555 return -EROFS;
1556 }
1557
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001558 mutex_lock(&c->umount_mutex);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001559 dbg_save_space_info(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001560 c->remounting_rw = 1;
Artem Bityutskiyc88ac002011-03-29 09:45:21 +03001561 c->ro_mount = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001562
Artem Bityutskiy67e753c2013-03-14 10:49:23 +02001563 if (c->space_fixup) {
1564 err = ubifs_fixup_free_space(c);
1565 if (err)
Artem Bityutskiyfcdd57c2014-04-07 13:39:06 +03001566 goto out;
Artem Bityutskiy67e753c2013-03-14 10:49:23 +02001567 }
1568
Artem Bityutskiy57a450e2008-12-30 16:23:34 +02001569 err = check_free_space(c);
1570 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001571 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001572
1573 if (c->old_leb_cnt != c->leb_cnt) {
1574 struct ubifs_sb_node *sup;
1575
1576 sup = ubifs_read_sb_node(c);
1577 if (IS_ERR(sup)) {
1578 err = PTR_ERR(sup);
1579 goto out;
1580 }
1581 sup->leb_cnt = cpu_to_le32(c->leb_cnt);
1582 err = ubifs_write_sb_node(c, sup);
Artem Bityutskiyeaeee242011-05-06 17:08:56 +03001583 kfree(sup);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001584 if (err)
1585 goto out;
1586 }
1587
1588 if (c->need_recovery) {
Sheng Yong235c3622015-03-20 10:39:42 +00001589 ubifs_msg(c, "completing deferred recovery");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001590 err = ubifs_write_rcvrd_mst_node(c);
1591 if (err)
1592 goto out;
1593 err = ubifs_recover_size(c);
1594 if (err)
1595 goto out;
1596 err = ubifs_clean_lebs(c, c->sbuf);
1597 if (err)
1598 goto out;
1599 err = ubifs_recover_inl_heads(c, c->sbuf);
1600 if (err)
1601 goto out;
Adrian Hunter49d128a2009-01-26 10:55:40 +02001602 } else {
1603 /* A readonly mount is not allowed to have orphans */
1604 ubifs_assert(c->tot_orphans == 0);
1605 err = ubifs_clear_orphans(c);
1606 if (err)
1607 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001608 }
1609
1610 if (!(c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY))) {
1611 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1612 err = ubifs_write_master(c);
1613 if (err)
1614 goto out;
1615 }
1616
1617 c->ileb_buf = vmalloc(c->leb_size);
1618 if (!c->ileb_buf) {
1619 err = -ENOMEM;
1620 goto out;
1621 }
1622
Matthew L. Creechd8829622011-03-04 17:55:02 -05001623 c->write_reserve_buf = kmalloc(COMPRESSED_DATA_NODE_BUF_SZ, GFP_KERNEL);
Wei Yongjun7203db92013-06-07 10:17:22 +08001624 if (!c->write_reserve_buf) {
1625 err = -ENOMEM;
Matthew L. Creechd8829622011-03-04 17:55:02 -05001626 goto out;
Wei Yongjun7203db92013-06-07 10:17:22 +08001627 }
Matthew L. Creechd8829622011-03-04 17:55:02 -05001628
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001629 err = ubifs_lpt_init(c, 0, 1);
1630 if (err)
1631 goto out;
1632
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001633 /* Create background thread */
Hunter Adrianfcabb342009-03-18 12:29:39 +01001634 c->bgt = kthread_create(ubifs_bg_thread, c, "%s", c->bgt_name);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001635 if (IS_ERR(c->bgt)) {
1636 err = PTR_ERR(c->bgt);
1637 c->bgt = NULL;
Sheng Yong235c3622015-03-20 10:39:42 +00001638 ubifs_err(c, "cannot spawn \"%s\", error %d",
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001639 c->bgt_name, err);
Adrian Hunter2953e732008-09-04 16:26:00 +03001640 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001641 }
1642 wake_up_process(c->bgt);
1643
1644 c->orph_buf = vmalloc(c->leb_size);
Adrian Hunter2953e732008-09-04 16:26:00 +03001645 if (!c->orph_buf) {
1646 err = -ENOMEM;
1647 goto out;
1648 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001649
1650 /* Check for enough log space */
1651 lnum = c->lhead_lnum + 1;
1652 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1653 lnum = UBIFS_LOG_LNUM;
1654 if (lnum == c->ltail_lnum) {
1655 err = ubifs_consolidate_log(c);
1656 if (err)
1657 goto out;
1658 }
1659
1660 if (c->need_recovery)
1661 err = ubifs_rcvry_gc_commit(c);
1662 else
Artem Bityutskiyb4978e92009-01-23 18:23:03 +02001663 err = ubifs_leb_unmap(c, c->gc_lnum);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001664 if (err)
1665 goto out;
1666
Artem Bityutskiy8c230d92011-04-20 18:02:45 +03001667 dbg_gen("re-mounted read-write");
1668 c->remounting_rw = 0;
1669
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001670 if (c->need_recovery) {
1671 c->need_recovery = 0;
Sheng Yong235c3622015-03-20 10:39:42 +00001672 ubifs_msg(c, "deferred recovery completed");
Artem Bityutskiy8c230d92011-04-20 18:02:45 +03001673 } else {
1674 /*
1675 * Do not run the debugging space check if the were doing
1676 * recovery, because when we saved the information we had the
1677 * file-system in a state where the TNC and lprops has been
1678 * modified in memory, but all the I/O operations (including a
1679 * commit) were deferred. So the file-system was in
1680 * "non-committed" state. Now the file-system is in committed
1681 * state, and of course the amount of free space will change
1682 * because, for example, the old index size was imprecise.
1683 */
1684 err = dbg_check_space_info(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001685 }
Matthew L. Creech9d510db2011-05-06 18:58:23 -04001686
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001687 mutex_unlock(&c->umount_mutex);
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001688 return err;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001689
1690out:
Artem Bityutskiyc88ac002011-03-29 09:45:21 +03001691 c->ro_mount = 1;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001692 vfree(c->orph_buf);
1693 c->orph_buf = NULL;
1694 if (c->bgt) {
1695 kthread_stop(c->bgt);
1696 c->bgt = NULL;
1697 }
1698 free_wbufs(c);
Matthew L. Creechd8829622011-03-04 17:55:02 -05001699 kfree(c->write_reserve_buf);
1700 c->write_reserve_buf = NULL;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001701 vfree(c->ileb_buf);
1702 c->ileb_buf = NULL;
1703 ubifs_lpt_free(c, 1);
1704 c->remounting_rw = 0;
1705 mutex_unlock(&c->umount_mutex);
1706 return err;
1707}
1708
1709/**
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001710 * ubifs_remount_ro - re-mount in read-only mode.
1711 * @c: UBIFS file-system description object
1712 *
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001713 * We assume VFS has stopped writing. Possibly the background thread could be
1714 * running a commit, however kthread_stop will wait in that case.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001715 */
1716static void ubifs_remount_ro(struct ubifs_info *c)
1717{
1718 int i, err;
1719
1720 ubifs_assert(!c->need_recovery);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001721 ubifs_assert(!c->ro_mount);
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001722
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001723 mutex_lock(&c->umount_mutex);
1724 if (c->bgt) {
1725 kthread_stop(c->bgt);
1726 c->bgt = NULL;
1727 }
1728
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001729 dbg_save_space_info(c);
1730
Richard Weinbergercf1595d2018-01-17 19:12:42 +01001731 for (i = 0; i < c->jhead_cnt; i++) {
1732 err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
1733 if (err)
1734 ubifs_ro_mode(c, err);
1735 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001736
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001737 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1738 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1739 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1740 err = ubifs_write_master(c);
1741 if (err)
1742 ubifs_ro_mode(c, err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001743
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001744 vfree(c->orph_buf);
1745 c->orph_buf = NULL;
Matthew L. Creechd8829622011-03-04 17:55:02 -05001746 kfree(c->write_reserve_buf);
1747 c->write_reserve_buf = NULL;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001748 vfree(c->ileb_buf);
1749 c->ileb_buf = NULL;
1750 ubifs_lpt_free(c, 1);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001751 c->ro_mount = 1;
Artem Bityutskiy84abf972009-01-23 14:54:59 +02001752 err = dbg_check_space_info(c);
1753 if (err)
1754 ubifs_ro_mode(c, err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001755 mutex_unlock(&c->umount_mutex);
1756}
1757
1758static void ubifs_put_super(struct super_block *sb)
1759{
1760 int i;
1761 struct ubifs_info *c = sb->s_fs_info;
1762
Sheng Yong235c3622015-03-20 10:39:42 +00001763 ubifs_msg(c, "un-mount UBI device %d", c->vi.ubi_num);
Christoph Hellwig6cfd0142009-05-05 15:40:36 +02001764
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001765 /*
1766 * The following asserts are only valid if there has not been a failure
1767 * of the media. For example, there will be dirty inodes if we failed
1768 * to write them back because of I/O errors.
1769 */
Artem Bityutskiy1a067a22011-04-21 10:39:54 +03001770 if (!c->ro_error) {
Artem Bityutskiyb1375452011-03-29 18:04:05 +03001771 ubifs_assert(c->bi.idx_growth == 0);
1772 ubifs_assert(c->bi.dd_growth == 0);
1773 ubifs_assert(c->bi.data_growth == 0);
Artem Bityutskiy1a067a22011-04-21 10:39:54 +03001774 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001775
1776 /*
1777 * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1778 * and file system un-mount. Namely, it prevents the shrinker from
1779 * picking this superblock for shrinking - it will be just skipped if
1780 * the mutex is locked.
1781 */
1782 mutex_lock(&c->umount_mutex);
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001783 if (!c->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001784 /*
1785 * First of all kill the background thread to make sure it does
1786 * not interfere with un-mounting and freeing resources.
1787 */
1788 if (c->bgt) {
1789 kthread_stop(c->bgt);
1790 c->bgt = NULL;
1791 }
1792
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001793 /*
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001794 * On fatal errors c->ro_error is set to 1, in which case we do
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001795 * not write the master node.
1796 */
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001797 if (!c->ro_error) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001798 int err;
1799
1800 /* Synchronize write-buffers */
Richard Weinbergercf1595d2018-01-17 19:12:42 +01001801 for (i = 0; i < c->jhead_cnt; i++) {
1802 err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
1803 if (err)
1804 ubifs_ro_mode(c, err);
1805 }
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001806
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001807 /*
1808 * We are being cleanly unmounted which means the
1809 * orphans were killed - indicate this in the master
1810 * node. Also save the reserved GC LEB number.
1811 */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001812 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1813 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1814 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1815 err = ubifs_write_master(c);
1816 if (err)
1817 /*
1818 * Recovery will attempt to fix the master area
1819 * next mount, so we just print a message and
1820 * continue to unmount normally.
1821 */
Sheng Yong235c3622015-03-20 10:39:42 +00001822 ubifs_err(c, "failed to write master node, error %d",
Artem Bityutskiy79fda512012-08-27 13:34:09 +03001823 err);
Artem Bityutskiy3601ba22010-10-18 08:32:35 +03001824 } else {
1825 for (i = 0; i < c->jhead_cnt; i++)
1826 /* Make sure write-buffer timers are canceled */
1827 hrtimer_cancel(&c->jheads[i].wbuf.timer);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001828 }
1829 }
1830
1831 ubifs_umount(c);
1832 bdi_destroy(&c->bdi);
1833 ubi_close_volume(c->ubi);
1834 mutex_unlock(&c->umount_mutex);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001835}
1836
1837static int ubifs_remount_fs(struct super_block *sb, int *flags, char *data)
1838{
1839 int err;
1840 struct ubifs_info *c = sb->s_fs_info;
1841
Theodore Ts'o02b99842014-03-13 10:14:33 -04001842 sync_filesystem(sb);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001843 dbg_gen("old flags %#lx, new flags %#x", sb->s_flags, *flags);
1844
1845 err = ubifs_parse_options(c, data, 1);
1846 if (err) {
Sheng Yong235c3622015-03-20 10:39:42 +00001847 ubifs_err(c, "invalid or unknown remount parameter");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001848 return err;
1849 }
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001850
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001851 if (c->ro_mount && !(*flags & MS_RDONLY)) {
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001852 if (c->ro_error) {
Sheng Yong235c3622015-03-20 10:39:42 +00001853 ubifs_msg(c, "cannot re-mount R/W due to prior errors");
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001854 return -EROFS;
1855 }
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001856 if (c->ro_media) {
Sheng Yong235c3622015-03-20 10:39:42 +00001857 ubifs_msg(c, "cannot re-mount R/W - UBI volume is R/O");
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001858 return -EROFS;
Artem Bityutskiye4d9b6c2009-01-23 14:17:36 +02001859 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001860 err = ubifs_remount_rw(c);
Artem Bityutskiye9d6bbc2009-07-19 13:51:04 +03001861 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001862 return err;
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03001863 } else if (!c->ro_mount && (*flags & MS_RDONLY)) {
Artem Bityutskiy2680d722010-09-17 16:44:28 +03001864 if (c->ro_error) {
Sheng Yong235c3622015-03-20 10:39:42 +00001865 ubifs_msg(c, "cannot re-mount R/O due to prior errors");
Artem Bityutskiya2b9df32009-01-29 16:22:54 +02001866 return -EROFS;
Adrian Hunterb466f172009-01-29 12:59:33 +02001867 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001868 ubifs_remount_ro(c);
Adrian Hunterb466f172009-01-29 12:59:33 +02001869 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001870
Artem Bityutskiy3477d202008-11-19 11:53:15 +02001871 if (c->bulk_read == 1)
1872 bu_init(c);
1873 else {
1874 dbg_gen("disable bulk-read");
1875 kfree(c->bu.buf);
1876 c->bu.buf = NULL;
1877 }
1878
Artem Bityutskiyb2213372009-03-15 17:20:22 +02001879 ubifs_assert(c->lst.taken_empty_lebs > 0);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001880 return 0;
1881}
1882
Artem Bityutskiye8b81562009-01-15 17:43:23 +02001883const struct super_operations ubifs_super_operations = {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001884 .alloc_inode = ubifs_alloc_inode,
1885 .destroy_inode = ubifs_destroy_inode,
1886 .put_super = ubifs_put_super,
1887 .write_inode = ubifs_write_inode,
Al Virod640e1b2010-06-07 00:34:05 -04001888 .evict_inode = ubifs_evict_inode,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001889 .statfs = ubifs_statfs,
1890 .dirty_inode = ubifs_dirty_inode,
1891 .remount_fs = ubifs_remount_fs,
1892 .show_options = ubifs_show_options,
1893 .sync_fs = ubifs_sync_fs,
1894};
1895
1896/**
1897 * open_ubi - parse UBI device name string and open the UBI device.
1898 * @name: UBI volume name
1899 * @mode: UBI volume open mode
1900 *
Corentin Chary97223242009-09-28 21:10:12 +02001901 * The primary method of mounting UBIFS is by specifying the UBI volume
1902 * character device node path. However, UBIFS may also be mounted withoug any
1903 * character device node using one of the following methods:
1904 *
1905 * o ubiX_Y - mount UBI device number X, volume Y;
1906 * o ubiY - mount UBI device number 0, volume Y;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001907 * o ubiX:NAME - mount UBI device X, volume with name NAME;
1908 * o ubi:NAME - mount UBI device 0, volume with name NAME.
1909 *
1910 * Alternative '!' separator may be used instead of ':' (because some shells
1911 * like busybox may interpret ':' as an NFS host name separator). This function
Corentin Chary97223242009-09-28 21:10:12 +02001912 * returns UBI volume description object in case of success and a negative
1913 * error code in case of failure.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001914 */
1915static struct ubi_volume_desc *open_ubi(const char *name, int mode)
1916{
Corentin Chary97223242009-09-28 21:10:12 +02001917 struct ubi_volume_desc *ubi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001918 int dev, vol;
1919 char *endptr;
1920
Richard Weinberger4b934d62018-09-03 23:06:23 +02001921 if (!name || !*name)
1922 return ERR_PTR(-EINVAL);
1923
Corentin Chary97223242009-09-28 21:10:12 +02001924 /* First, try to open using the device node path method */
1925 ubi = ubi_open_volume_path(name, mode);
1926 if (!IS_ERR(ubi))
1927 return ubi;
1928
1929 /* Try the "nodev" method */
Artem Bityutskiy1e517642008-07-14 19:08:37 +03001930 if (name[0] != 'u' || name[1] != 'b' || name[2] != 'i')
1931 return ERR_PTR(-EINVAL);
1932
1933 /* ubi:NAME method */
1934 if ((name[3] == ':' || name[3] == '!') && name[4] != '\0')
1935 return ubi_open_volume_nm(0, name + 4, mode);
1936
1937 if (!isdigit(name[3]))
1938 return ERR_PTR(-EINVAL);
1939
1940 dev = simple_strtoul(name + 3, &endptr, 0);
1941
1942 /* ubiY method */
1943 if (*endptr == '\0')
1944 return ubi_open_volume(0, dev, mode);
1945
1946 /* ubiX_Y method */
1947 if (*endptr == '_' && isdigit(endptr[1])) {
1948 vol = simple_strtoul(endptr + 1, &endptr, 0);
1949 if (*endptr != '\0')
1950 return ERR_PTR(-EINVAL);
1951 return ubi_open_volume(dev, vol, mode);
1952 }
1953
1954 /* ubiX:NAME method */
1955 if ((*endptr == ':' || *endptr == '!') && endptr[1] != '\0')
1956 return ubi_open_volume_nm(dev, ++endptr, mode);
1957
1958 return ERR_PTR(-EINVAL);
1959}
1960
Al Virob1c27ab2011-06-12 10:07:03 -04001961static struct ubifs_info *alloc_ubifs_info(struct ubi_volume_desc *ubi)
1962{
1963 struct ubifs_info *c;
1964
1965 c = kzalloc(sizeof(struct ubifs_info), GFP_KERNEL);
1966 if (c) {
1967 spin_lock_init(&c->cnt_lock);
1968 spin_lock_init(&c->cs_lock);
1969 spin_lock_init(&c->buds_lock);
1970 spin_lock_init(&c->space_lock);
1971 spin_lock_init(&c->orphan_lock);
1972 init_rwsem(&c->commit_sem);
1973 mutex_init(&c->lp_mutex);
1974 mutex_init(&c->tnc_mutex);
1975 mutex_init(&c->log_mutex);
Al Virob1c27ab2011-06-12 10:07:03 -04001976 mutex_init(&c->umount_mutex);
1977 mutex_init(&c->bu_mutex);
1978 mutex_init(&c->write_reserve_mutex);
1979 init_waitqueue_head(&c->cmt_wq);
1980 c->buds = RB_ROOT;
1981 c->old_idx = RB_ROOT;
1982 c->size_tree = RB_ROOT;
1983 c->orph_tree = RB_ROOT;
1984 INIT_LIST_HEAD(&c->infos_list);
1985 INIT_LIST_HEAD(&c->idx_gc);
1986 INIT_LIST_HEAD(&c->replay_list);
1987 INIT_LIST_HEAD(&c->replay_buds);
1988 INIT_LIST_HEAD(&c->uncat_list);
1989 INIT_LIST_HEAD(&c->empty_list);
1990 INIT_LIST_HEAD(&c->freeable_list);
1991 INIT_LIST_HEAD(&c->frdi_idx_list);
1992 INIT_LIST_HEAD(&c->unclean_leb_list);
1993 INIT_LIST_HEAD(&c->old_buds);
1994 INIT_LIST_HEAD(&c->orph_list);
1995 INIT_LIST_HEAD(&c->orph_new);
1996 c->no_chk_data_crc = 1;
1997
1998 c->highest_inum = UBIFS_FIRST_INO;
1999 c->lhead_lnum = c->ltail_lnum = UBIFS_LOG_LNUM;
2000
2001 ubi_get_volume_info(ubi, &c->vi);
2002 ubi_get_device_info(c->vi.ubi_num, &c->di);
2003 }
2004 return c;
2005}
2006
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002007static int ubifs_fill_super(struct super_block *sb, void *data, int silent)
2008{
Al Virod251ed22011-06-12 10:24:33 -04002009 struct ubifs_info *c = sb->s_fs_info;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002010 struct inode *root;
2011 int err;
2012
Artem Bityutskiy8379ea32009-05-29 12:34:52 +03002013 c->vfs_sb = sb;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002014 /* Re-open the UBI device in read-write mode */
2015 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READWRITE);
2016 if (IS_ERR(c->ubi)) {
2017 err = PTR_ERR(c->ubi);
Al Virod251ed22011-06-12 10:24:33 -04002018 goto out;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002019 }
2020
2021 /*
Artem Bityutskiy0a883a02008-08-13 14:13:26 +03002022 * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002023 * UBIFS, I/O is not deferred, it is done immediately in readpage,
2024 * which means the user would have to wait not just for their own I/O
Artem Bityutskiy0a883a02008-08-13 14:13:26 +03002025 * but the read-ahead I/O as well i.e. completely pointless.
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002026 *
2027 * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
2028 */
Jens Axboed9938312009-06-12 14:45:52 +02002029 c->bdi.name = "ubifs",
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01002030 c->bdi.capabilities = 0;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002031 err = bdi_init(&c->bdi);
2032 if (err)
2033 goto out_close;
Daniel Mack7fcd9c32009-07-02 17:15:47 +02002034 err = bdi_register(&c->bdi, NULL, "ubifs_%d_%d",
2035 c->vi.ubi_num, c->vi.vol_id);
Jens Axboea979eff2009-05-29 09:19:23 +02002036 if (err)
2037 goto out_bdi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002038
2039 err = ubifs_parse_options(c, data, 0);
2040 if (err)
2041 goto out_bdi;
2042
Jens Axboe32a88aa2009-09-16 15:02:33 +02002043 sb->s_bdi = &c->bdi;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002044 sb->s_fs_info = c;
2045 sb->s_magic = UBIFS_SUPER_MAGIC;
2046 sb->s_blocksize = UBIFS_BLOCK_SIZE;
2047 sb->s_blocksize_bits = UBIFS_BLOCK_SHIFT;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002048 sb->s_maxbytes = c->max_inode_sz = key_max_inode_size(c);
2049 if (c->max_inode_sz > MAX_LFS_FILESIZE)
2050 sb->s_maxbytes = c->max_inode_sz = MAX_LFS_FILESIZE;
2051 sb->s_op = &ubifs_super_operations;
Andreas Gruenbacher2b88fc22016-04-22 19:14:00 +02002052 sb->s_xattr = ubifs_xattr_handlers;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002053
2054 mutex_lock(&c->umount_mutex);
2055 err = mount_ubifs(c);
2056 if (err) {
2057 ubifs_assert(err < 0);
2058 goto out_unlock;
2059 }
2060
2061 /* Read the root inode */
2062 root = ubifs_iget(sb, UBIFS_ROOT_INO);
2063 if (IS_ERR(root)) {
2064 err = PTR_ERR(root);
2065 goto out_umount;
2066 }
2067
Al Viro48fde702012-01-08 22:15:13 -05002068 sb->s_root = d_make_root(root);
Wei Yongjun7203db92013-06-07 10:17:22 +08002069 if (!sb->s_root) {
2070 err = -ENOMEM;
Al Viro48fde702012-01-08 22:15:13 -05002071 goto out_umount;
Wei Yongjun7203db92013-06-07 10:17:22 +08002072 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002073
2074 mutex_unlock(&c->umount_mutex);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002075 return 0;
2076
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002077out_umount:
2078 ubifs_umount(c);
2079out_unlock:
2080 mutex_unlock(&c->umount_mutex);
2081out_bdi:
2082 bdi_destroy(&c->bdi);
2083out_close:
2084 ubi_close_volume(c->ubi);
Al Virod251ed22011-06-12 10:24:33 -04002085out:
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002086 return err;
2087}
2088
2089static int sb_test(struct super_block *sb, void *data)
2090{
Al Virod251ed22011-06-12 10:24:33 -04002091 struct ubifs_info *c1 = data;
Artem Bityutskiy7c83f5c2009-05-25 19:23:04 +03002092 struct ubifs_info *c = sb->s_fs_info;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002093
Al Virod251ed22011-06-12 10:24:33 -04002094 return c->vi.cdev == c1->vi.cdev;
2095}
2096
2097static int sb_set(struct super_block *sb, void *data)
2098{
2099 sb->s_fs_info = data;
2100 return set_anon_super(sb, NULL);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002101}
2102
Al Viro157d81e2010-07-25 23:52:42 +04002103static struct dentry *ubifs_mount(struct file_system_type *fs_type, int flags,
2104 const char *name, void *data)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002105{
2106 struct ubi_volume_desc *ubi;
Al Virod251ed22011-06-12 10:24:33 -04002107 struct ubifs_info *c;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002108 struct super_block *sb;
2109 int err;
2110
2111 dbg_gen("name %s, flags %#x", name, flags);
2112
2113 /*
2114 * Get UBI device number and volume ID. Mount it read-only so far
2115 * because this might be a new mount point, and UBI allows only one
2116 * read-write user at a time.
2117 */
2118 ubi = open_ubi(name, UBI_READONLY);
2119 if (IS_ERR(ubi)) {
Daniel Golle1ae92642016-06-18 17:53:45 +02002120 if (!(flags & MS_SILENT))
2121 pr_err("UBIFS error (pid: %d): cannot open \"%s\", error %d",
2122 current->pid, name, (int)PTR_ERR(ubi));
Al Viro157d81e2010-07-25 23:52:42 +04002123 return ERR_CAST(ubi);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002124 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002125
Al Virod251ed22011-06-12 10:24:33 -04002126 c = alloc_ubifs_info(ubi);
2127 if (!c) {
2128 err = -ENOMEM;
2129 goto out_close;
2130 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002131
Al Virod251ed22011-06-12 10:24:33 -04002132 dbg_gen("opened ubi%d_%d", c->vi.ubi_num, c->vi.vol_id);
2133
David Howells9249e172012-06-25 12:55:37 +01002134 sb = sget(fs_type, sb_test, sb_set, flags, c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002135 if (IS_ERR(sb)) {
2136 err = PTR_ERR(sb);
Al Virod251ed22011-06-12 10:24:33 -04002137 kfree(c);
Dan Carpenter185bf872011-06-20 10:10:24 +03002138 goto out_close;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002139 }
2140
2141 if (sb->s_root) {
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03002142 struct ubifs_info *c1 = sb->s_fs_info;
Al Virod251ed22011-06-12 10:24:33 -04002143 kfree(c);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002144 /* A new mount point for already mounted UBIFS */
2145 dbg_gen("this ubi volume is already mounted");
Artem Bityutskiy2ef13292010-09-19 18:34:26 +03002146 if (!!(flags & MS_RDONLY) != c1->ro_mount) {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002147 err = -EBUSY;
2148 goto out_deact;
2149 }
2150 } else {
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002151 err = ubifs_fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
2152 if (err)
2153 goto out_deact;
2154 /* We do not support atime */
Dongsheng Yang8c1c5f22015-11-07 12:46:11 +08002155 sb->s_flags |= MS_ACTIVE;
2156#ifndef CONFIG_UBIFS_ATIME_SUPPORT
2157 sb->s_flags |= MS_NOATIME;
2158#else
2159 ubifs_msg(c, "full atime support is enabled.");
2160#endif
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002161 }
2162
2163 /* 'fill_super()' opens ubi again so we must close it here */
2164 ubi_close_volume(ubi);
2165
Al Viro157d81e2010-07-25 23:52:42 +04002166 return dget(sb->s_root);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002167
2168out_deact:
Al Viro6f5bbff2009-05-06 01:34:22 -04002169 deactivate_locked_super(sb);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002170out_close:
2171 ubi_close_volume(ubi);
Al Viro157d81e2010-07-25 23:52:42 +04002172 return ERR_PTR(err);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002173}
2174
Al Virod251ed22011-06-12 10:24:33 -04002175static void kill_ubifs_super(struct super_block *s)
2176{
2177 struct ubifs_info *c = s->s_fs_info;
2178 kill_anon_super(s);
2179 kfree(c);
2180}
2181
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002182static struct file_system_type ubifs_fs_type = {
2183 .name = "ubifs",
2184 .owner = THIS_MODULE,
Al Viro157d81e2010-07-25 23:52:42 +04002185 .mount = ubifs_mount,
Al Virod251ed22011-06-12 10:24:33 -04002186 .kill_sb = kill_ubifs_super,
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002187};
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002188MODULE_ALIAS_FS("ubifs");
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002189
2190/*
2191 * Inode slab cache constructor.
2192 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -07002193static void inode_slab_ctor(void *obj)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002194{
2195 struct ubifs_inode *ui = obj;
2196 inode_init_once(&ui->vfs_inode);
2197}
2198
2199static int __init ubifs_init(void)
2200{
2201 int err;
2202
2203 BUILD_BUG_ON(sizeof(struct ubifs_ch) != 24);
2204
2205 /* Make sure node sizes are 8-byte aligned */
2206 BUILD_BUG_ON(UBIFS_CH_SZ & 7);
2207 BUILD_BUG_ON(UBIFS_INO_NODE_SZ & 7);
2208 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ & 7);
2209 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ & 7);
2210 BUILD_BUG_ON(UBIFS_DATA_NODE_SZ & 7);
2211 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ & 7);
2212 BUILD_BUG_ON(UBIFS_SB_NODE_SZ & 7);
2213 BUILD_BUG_ON(UBIFS_MST_NODE_SZ & 7);
2214 BUILD_BUG_ON(UBIFS_REF_NODE_SZ & 7);
2215 BUILD_BUG_ON(UBIFS_CS_NODE_SZ & 7);
2216 BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ & 7);
2217
2218 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ & 7);
2219 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ & 7);
2220 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ & 7);
2221 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ & 7);
2222 BUILD_BUG_ON(UBIFS_MAX_NODE_SZ & 7);
2223 BUILD_BUG_ON(MIN_WRITE_SZ & 7);
2224
2225 /* Check min. node size */
2226 BUILD_BUG_ON(UBIFS_INO_NODE_SZ < MIN_WRITE_SZ);
2227 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ < MIN_WRITE_SZ);
2228 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ < MIN_WRITE_SZ);
2229 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ < MIN_WRITE_SZ);
2230
2231 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2232 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2233 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ > UBIFS_MAX_NODE_SZ);
2234 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ > UBIFS_MAX_NODE_SZ);
2235
2236 /* Defined node sizes */
2237 BUILD_BUG_ON(UBIFS_SB_NODE_SZ != 4096);
2238 BUILD_BUG_ON(UBIFS_MST_NODE_SZ != 512);
2239 BUILD_BUG_ON(UBIFS_INO_NODE_SZ != 160);
2240 BUILD_BUG_ON(UBIFS_REF_NODE_SZ != 64);
2241
2242 /*
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02002243 * We use 2 bit wide bit-fields to store compression type, which should
2244 * be amended if more compressors are added. The bit-fields are:
Artem Bityutskiy553dea42008-11-01 14:57:49 +02002245 * @compr_type in 'struct ubifs_inode', @default_compr in
2246 * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
Artem Bityutskiya1dc080c22008-11-01 14:20:50 +02002247 */
2248 BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT > 4);
2249
2250 /*
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03002251 * We require that PAGE_SIZE is greater-than-or-equal-to
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002252 * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2253 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002254 if (PAGE_SIZE < UBIFS_BLOCK_SIZE) {
Sheng Yong235c3622015-03-20 10:39:42 +00002255 pr_err("UBIFS error (pid %d): VFS page cache size is %u bytes, but UBIFS requires at least 4096 bytes",
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002256 current->pid, (unsigned int)PAGE_SIZE);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002257 return -EINVAL;
2258 }
2259
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002260 ubifs_inode_slab = kmem_cache_create("ubifs_inode_slab",
2261 sizeof(struct ubifs_inode), 0,
Vladimir Davydov5d097052016-01-14 15:18:21 -08002262 SLAB_MEM_SPREAD | SLAB_RECLAIM_ACCOUNT |
2263 SLAB_ACCOUNT, &inode_slab_ctor);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002264 if (!ubifs_inode_slab)
Al Viro5cc361e2011-12-12 23:58:21 -05002265 return -ENOMEM;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002266
Chao Yua1fe33a2015-05-18 16:43:02 +08002267 err = register_shrinker(&ubifs_shrinker_info);
2268 if (err)
2269 goto out_slab;
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002270
2271 err = ubifs_compressors_init();
2272 if (err)
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002273 goto out_shrinker;
2274
2275 err = dbg_debugfs_init();
2276 if (err)
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002277 goto out_compr;
2278
Al Viro5cc361e2011-12-12 23:58:21 -05002279 err = register_filesystem(&ubifs_fs_type);
2280 if (err) {
Sheng Yong235c3622015-03-20 10:39:42 +00002281 pr_err("UBIFS error (pid %d): cannot register file system, error %d",
2282 current->pid, err);
Al Viro5cc361e2011-12-12 23:58:21 -05002283 goto out_dbg;
2284 }
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002285 return 0;
2286
Al Viro5cc361e2011-12-12 23:58:21 -05002287out_dbg:
2288 dbg_debugfs_exit();
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002289out_compr:
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002290 ubifs_compressors_exit();
2291out_shrinker:
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002292 unregister_shrinker(&ubifs_shrinker_info);
Chao Yua1fe33a2015-05-18 16:43:02 +08002293out_slab:
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002294 kmem_cache_destroy(ubifs_inode_slab);
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002295 return err;
2296}
2297/* late_initcall to let compressors initialize first */
2298late_initcall(ubifs_init);
2299
2300static void __exit ubifs_exit(void)
2301{
2302 ubifs_assert(list_empty(&ubifs_infos));
2303 ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt) == 0);
2304
Artem Bityutskiy552ff312008-10-23 11:49:28 +03002305 dbg_debugfs_exit();
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002306 ubifs_compressors_exit();
2307 unregister_shrinker(&ubifs_shrinker_info);
Kirill A. Shutemov8c0a8532012-09-26 11:33:07 +10002308
2309 /*
2310 * Make sure all delayed rcu free inodes are flushed before we
2311 * destroy cache.
2312 */
2313 rcu_barrier();
Artem Bityutskiy1e517642008-07-14 19:08:37 +03002314 kmem_cache_destroy(ubifs_inode_slab);
2315 unregister_filesystem(&ubifs_fs_type);
2316}
2317module_exit(ubifs_exit);
2318
2319MODULE_LICENSE("GPL");
2320MODULE_VERSION(__stringify(UBIFS_VERSION));
2321MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2322MODULE_DESCRIPTION("UBIFS - UBI File System");