xref: /openbmc/linux/fs/jffs2/super.c (revision e553d2a5)
1 /*
2  * JFFS2 -- Journalling Flash File System, Version 2.
3  *
4  * Copyright © 2001-2007 Red Hat, Inc.
5  *
6  * Created by David Woodhouse <dwmw2@infradead.org>
7  *
8  * For licensing information, see the file 'LICENCE' in this directory.
9  *
10  */
11 
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/slab.h>
17 #include <linux/init.h>
18 #include <linux/list.h>
19 #include <linux/fs.h>
20 #include <linux/err.h>
21 #include <linux/mount.h>
22 #include <linux/fs_context.h>
23 #include <linux/fs_parser.h>
24 #include <linux/jffs2.h>
25 #include <linux/pagemap.h>
26 #include <linux/mtd/super.h>
27 #include <linux/ctype.h>
28 #include <linux/namei.h>
29 #include <linux/seq_file.h>
30 #include <linux/exportfs.h>
31 #include "compr.h"
32 #include "nodelist.h"
33 
34 static void jffs2_put_super(struct super_block *);
35 
36 static struct kmem_cache *jffs2_inode_cachep;
37 
38 static struct inode *jffs2_alloc_inode(struct super_block *sb)
39 {
40 	struct jffs2_inode_info *f;
41 
42 	f = kmem_cache_alloc(jffs2_inode_cachep, GFP_KERNEL);
43 	if (!f)
44 		return NULL;
45 	return &f->vfs_inode;
46 }
47 
48 static void jffs2_free_inode(struct inode *inode)
49 {
50 	struct jffs2_inode_info *f = JFFS2_INODE_INFO(inode);
51 
52 	kfree(f->target);
53 	kmem_cache_free(jffs2_inode_cachep, f);
54 }
55 
56 static void jffs2_i_init_once(void *foo)
57 {
58 	struct jffs2_inode_info *f = foo;
59 
60 	mutex_init(&f->sem);
61 	inode_init_once(&f->vfs_inode);
62 }
63 
64 static const char *jffs2_compr_name(unsigned int compr)
65 {
66 	switch (compr) {
67 	case JFFS2_COMPR_MODE_NONE:
68 		return "none";
69 #ifdef CONFIG_JFFS2_LZO
70 	case JFFS2_COMPR_MODE_FORCELZO:
71 		return "lzo";
72 #endif
73 #ifdef CONFIG_JFFS2_ZLIB
74 	case JFFS2_COMPR_MODE_FORCEZLIB:
75 		return "zlib";
76 #endif
77 	default:
78 		/* should never happen; programmer error */
79 		WARN_ON(1);
80 		return "";
81 	}
82 }
83 
84 static int jffs2_show_options(struct seq_file *s, struct dentry *root)
85 {
86 	struct jffs2_sb_info *c = JFFS2_SB_INFO(root->d_sb);
87 	struct jffs2_mount_opts *opts = &c->mount_opts;
88 
89 	if (opts->override_compr)
90 		seq_printf(s, ",compr=%s", jffs2_compr_name(opts->compr));
91 	if (opts->rp_size)
92 		seq_printf(s, ",rp_size=%u", opts->rp_size / 1024);
93 
94 	return 0;
95 }
96 
97 static int jffs2_sync_fs(struct super_block *sb, int wait)
98 {
99 	struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
100 
101 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER
102 	if (jffs2_is_writebuffered(c))
103 		cancel_delayed_work_sync(&c->wbuf_dwork);
104 #endif
105 
106 	mutex_lock(&c->alloc_sem);
107 	jffs2_flush_wbuf_pad(c);
108 	mutex_unlock(&c->alloc_sem);
109 	return 0;
110 }
111 
112 static struct inode *jffs2_nfs_get_inode(struct super_block *sb, uint64_t ino,
113 					 uint32_t generation)
114 {
115 	/* We don't care about i_generation. We'll destroy the flash
116 	   before we start re-using inode numbers anyway. And even
117 	   if that wasn't true, we'd have other problems...*/
118 	return jffs2_iget(sb, ino);
119 }
120 
121 static struct dentry *jffs2_fh_to_dentry(struct super_block *sb, struct fid *fid,
122 					 int fh_len, int fh_type)
123 {
124         return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
125                                     jffs2_nfs_get_inode);
126 }
127 
128 static struct dentry *jffs2_fh_to_parent(struct super_block *sb, struct fid *fid,
129 					 int fh_len, int fh_type)
130 {
131         return generic_fh_to_parent(sb, fid, fh_len, fh_type,
132                                     jffs2_nfs_get_inode);
133 }
134 
135 static struct dentry *jffs2_get_parent(struct dentry *child)
136 {
137 	struct jffs2_inode_info *f;
138 	uint32_t pino;
139 
140 	BUG_ON(!d_is_dir(child));
141 
142 	f = JFFS2_INODE_INFO(d_inode(child));
143 
144 	pino = f->inocache->pino_nlink;
145 
146 	JFFS2_DEBUG("Parent of directory ino #%u is #%u\n",
147 		    f->inocache->ino, pino);
148 
149 	return d_obtain_alias(jffs2_iget(child->d_sb, pino));
150 }
151 
152 static const struct export_operations jffs2_export_ops = {
153 	.get_parent = jffs2_get_parent,
154 	.fh_to_dentry = jffs2_fh_to_dentry,
155 	.fh_to_parent = jffs2_fh_to_parent,
156 };
157 
158 /*
159  * JFFS2 mount options.
160  *
161  * Opt_source: The source device
162  * Opt_override_compr: override default compressor
163  * Opt_rp_size: size of reserved pool in KiB
164  */
165 enum {
166 	Opt_source,
167 	Opt_override_compr,
168 	Opt_rp_size,
169 };
170 
171 static const struct fs_parameter_spec jffs2_param_specs[] = {
172 	fsparam_string	("source",	Opt_source),
173 	fsparam_enum	("compr",	Opt_override_compr),
174 	fsparam_u32	("rp_size",	Opt_rp_size),
175 	{}
176 };
177 
178 static const struct fs_parameter_enum jffs2_param_enums[] = {
179 	{ Opt_override_compr,	"none",	JFFS2_COMPR_MODE_NONE },
180 #ifdef CONFIG_JFFS2_LZO
181 	{ Opt_override_compr,	"lzo",	JFFS2_COMPR_MODE_FORCELZO },
182 #endif
183 #ifdef CONFIG_JFFS2_ZLIB
184 	{ Opt_override_compr,	"zlib",	JFFS2_COMPR_MODE_FORCEZLIB },
185 #endif
186 	{}
187 };
188 
189 const struct fs_parameter_description jffs2_fs_parameters = {
190 	.name		= "jffs2",
191 	.specs		= jffs2_param_specs,
192 	.enums		= jffs2_param_enums,
193 };
194 
195 static int jffs2_parse_param(struct fs_context *fc, struct fs_parameter *param)
196 {
197 	struct fs_parse_result result;
198 	struct jffs2_sb_info *c = fc->s_fs_info;
199 	int opt;
200 
201 	opt = fs_parse(fc, &jffs2_fs_parameters, param, &result);
202 	if (opt < 0)
203 		return opt;
204 
205 	switch (opt) {
206 	case Opt_override_compr:
207 		c->mount_opts.compr = result.uint_32;
208 		c->mount_opts.override_compr = true;
209 		break;
210 	case Opt_rp_size:
211 		if (result.uint_32 > UINT_MAX / 1024)
212 			return invalf(fc, "jffs2: rp_size unrepresentable");
213 		opt = result.uint_32 * 1024;
214 		if (opt > c->mtd->size)
215 			return invalf(fc, "jffs2: Too large reserve pool specified, max is %llu KB",
216 				      c->mtd->size / 1024);
217 		c->mount_opts.rp_size = opt;
218 		break;
219 	default:
220 		return -EINVAL;
221 	}
222 
223 	return 0;
224 }
225 
226 static int jffs2_reconfigure(struct fs_context *fc)
227 {
228 	struct super_block *sb = fc->root->d_sb;
229 
230 	sync_filesystem(sb);
231 	return jffs2_do_remount_fs(sb, fc);
232 }
233 
234 static const struct super_operations jffs2_super_operations =
235 {
236 	.alloc_inode =	jffs2_alloc_inode,
237 	.free_inode =	jffs2_free_inode,
238 	.put_super =	jffs2_put_super,
239 	.statfs =	jffs2_statfs,
240 	.evict_inode =	jffs2_evict_inode,
241 	.dirty_inode =	jffs2_dirty_inode,
242 	.show_options =	jffs2_show_options,
243 	.sync_fs =	jffs2_sync_fs,
244 };
245 
246 /*
247  * fill in the superblock
248  */
249 static int jffs2_fill_super(struct super_block *sb, struct fs_context *fc)
250 {
251 	struct jffs2_sb_info *c = sb->s_fs_info;
252 
253 	jffs2_dbg(1, "jffs2_get_sb_mtd():"
254 		  " New superblock for device %d (\"%s\")\n",
255 		  sb->s_mtd->index, sb->s_mtd->name);
256 
257 	c->mtd = sb->s_mtd;
258 	c->os_priv = sb;
259 
260 	/* Initialize JFFS2 superblock locks, the further initialization will
261 	 * be done later */
262 	mutex_init(&c->alloc_sem);
263 	mutex_init(&c->erase_free_sem);
264 	init_waitqueue_head(&c->erase_wait);
265 	init_waitqueue_head(&c->inocache_wq);
266 	spin_lock_init(&c->erase_completion_lock);
267 	spin_lock_init(&c->inocache_lock);
268 
269 	sb->s_op = &jffs2_super_operations;
270 	sb->s_export_op = &jffs2_export_ops;
271 	sb->s_flags = sb->s_flags | SB_NOATIME;
272 	sb->s_xattr = jffs2_xattr_handlers;
273 #ifdef CONFIG_JFFS2_FS_POSIX_ACL
274 	sb->s_flags |= SB_POSIXACL;
275 #endif
276 	return jffs2_do_fill_super(sb, fc);
277 }
278 
279 static int jffs2_get_tree(struct fs_context *fc)
280 {
281 	return get_tree_mtd(fc, jffs2_fill_super);
282 }
283 
284 static void jffs2_free_fc(struct fs_context *fc)
285 {
286 	kfree(fc->s_fs_info);
287 }
288 
289 static const struct fs_context_operations jffs2_context_ops = {
290 	.free		= jffs2_free_fc,
291 	.parse_param	= jffs2_parse_param,
292 	.get_tree	= jffs2_get_tree,
293 	.reconfigure	= jffs2_reconfigure,
294 };
295 
296 static int jffs2_init_fs_context(struct fs_context *fc)
297 {
298 	struct jffs2_sb_info *ctx;
299 
300 	ctx = kzalloc(sizeof(struct jffs2_sb_info), GFP_KERNEL);
301 	if (!ctx)
302 		return -ENOMEM;
303 
304 	fc->s_fs_info = ctx;
305 	fc->ops = &jffs2_context_ops;
306 	return 0;
307 }
308 
309 static void jffs2_put_super (struct super_block *sb)
310 {
311 	struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
312 
313 	jffs2_dbg(2, "%s()\n", __func__);
314 
315 	mutex_lock(&c->alloc_sem);
316 	jffs2_flush_wbuf_pad(c);
317 	mutex_unlock(&c->alloc_sem);
318 
319 	jffs2_sum_exit(c);
320 
321 	jffs2_free_ino_caches(c);
322 	jffs2_free_raw_node_refs(c);
323 	kvfree(c->blocks);
324 	jffs2_flash_cleanup(c);
325 	kfree(c->inocache_list);
326 	jffs2_clear_xattr_subsystem(c);
327 	mtd_sync(c->mtd);
328 	jffs2_dbg(1, "%s(): returning\n", __func__);
329 }
330 
331 static void jffs2_kill_sb(struct super_block *sb)
332 {
333 	struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
334 	if (c && !sb_rdonly(sb))
335 		jffs2_stop_garbage_collect_thread(c);
336 	kill_mtd_super(sb);
337 	kfree(c);
338 }
339 
340 static struct file_system_type jffs2_fs_type = {
341 	.owner =	THIS_MODULE,
342 	.name =		"jffs2",
343 	.init_fs_context = jffs2_init_fs_context,
344 	.parameters =	&jffs2_fs_parameters,
345 	.kill_sb =	jffs2_kill_sb,
346 };
347 MODULE_ALIAS_FS("jffs2");
348 
349 static int __init init_jffs2_fs(void)
350 {
351 	int ret;
352 
353 	/* Paranoia checks for on-medium structures. If we ask GCC
354 	   to pack them with __attribute__((packed)) then it _also_
355 	   assumes that they're not aligned -- so it emits crappy
356 	   code on some architectures. Ideally we want an attribute
357 	   which means just 'no padding', without the alignment
358 	   thing. But GCC doesn't have that -- we have to just
359 	   hope the structs are the right sizes, instead. */
360 	BUILD_BUG_ON(sizeof(struct jffs2_unknown_node) != 12);
361 	BUILD_BUG_ON(sizeof(struct jffs2_raw_dirent) != 40);
362 	BUILD_BUG_ON(sizeof(struct jffs2_raw_inode) != 68);
363 	BUILD_BUG_ON(sizeof(struct jffs2_raw_summary) != 32);
364 
365 	pr_info("version 2.2."
366 #ifdef CONFIG_JFFS2_FS_WRITEBUFFER
367 	       " (NAND)"
368 #endif
369 #ifdef CONFIG_JFFS2_SUMMARY
370 	       " (SUMMARY) "
371 #endif
372 	       " © 2001-2006 Red Hat, Inc.\n");
373 
374 	jffs2_inode_cachep = kmem_cache_create("jffs2_i",
375 					     sizeof(struct jffs2_inode_info),
376 					     0, (SLAB_RECLAIM_ACCOUNT|
377 						SLAB_MEM_SPREAD|SLAB_ACCOUNT),
378 					     jffs2_i_init_once);
379 	if (!jffs2_inode_cachep) {
380 		pr_err("error: Failed to initialise inode cache\n");
381 		return -ENOMEM;
382 	}
383 	ret = jffs2_compressors_init();
384 	if (ret) {
385 		pr_err("error: Failed to initialise compressors\n");
386 		goto out;
387 	}
388 	ret = jffs2_create_slab_caches();
389 	if (ret) {
390 		pr_err("error: Failed to initialise slab caches\n");
391 		goto out_compressors;
392 	}
393 	ret = register_filesystem(&jffs2_fs_type);
394 	if (ret) {
395 		pr_err("error: Failed to register filesystem\n");
396 		goto out_slab;
397 	}
398 	return 0;
399 
400  out_slab:
401 	jffs2_destroy_slab_caches();
402  out_compressors:
403 	jffs2_compressors_exit();
404  out:
405 	kmem_cache_destroy(jffs2_inode_cachep);
406 	return ret;
407 }
408 
409 static void __exit exit_jffs2_fs(void)
410 {
411 	unregister_filesystem(&jffs2_fs_type);
412 	jffs2_destroy_slab_caches();
413 	jffs2_compressors_exit();
414 
415 	/*
416 	 * Make sure all delayed rcu free inodes are flushed before we
417 	 * destroy cache.
418 	 */
419 	rcu_barrier();
420 	kmem_cache_destroy(jffs2_inode_cachep);
421 }
422 
423 module_init(init_jffs2_fs);
424 module_exit(exit_jffs2_fs);
425 
426 MODULE_DESCRIPTION("The Journalling Flash File System, v2");
427 MODULE_AUTHOR("Red Hat, Inc.");
428 MODULE_LICENSE("GPL"); // Actually dual-licensed, but it doesn't matter for
429 		       // the sake of this tag. It's Free Software.
430