blob: f2d96b5e64f6fa47ee8fd11543156c926779ca0e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * JFFS2 -- Journalling Flash File System, Version 2.
3 *
David Woodhousec00c3102007-04-25 14:16:47 +01004 * Copyright © 2001-2007 Red Hat, Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Created by David Woodhouse <dwmw2@infradead.org>
7 *
8 * For licensing information, see the file 'LICENCE' in this directory.
9 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/kernel.h>
13#include <linux/module.h>
14#include <linux/slab.h>
15#include <linux/init.h>
16#include <linux/list.h>
17#include <linux/fs.h>
Artem Bityutskiy9c740342006-10-11 14:52:47 +030018#include <linux/err.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/mount.h>
Andres Salomon92abc472011-10-16 18:15:16 -070020#include <linux/parser.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/jffs2.h>
22#include <linux/pagemap.h>
David Howellsacaebfd2007-05-10 22:51:50 -070023#include <linux/mtd/super.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/ctype.h>
25#include <linux/namei.h>
Andres Salomon92abc472011-10-16 18:15:16 -070026#include <linux/seq_file.h>
David Woodhouse5f556aa2008-07-31 20:39:25 +010027#include <linux/exportfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include "compr.h"
29#include "nodelist.h"
30
31static void jffs2_put_super(struct super_block *);
32
Christoph Lametere18b8902006-12-06 20:33:20 -080033static struct kmem_cache *jffs2_inode_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35static struct inode *jffs2_alloc_inode(struct super_block *sb)
36{
David Woodhouse4e571ab2008-05-01 12:28:04 +010037 struct jffs2_inode_info *f;
38
39 f = kmem_cache_alloc(jffs2_inode_cachep, GFP_KERNEL);
40 if (!f)
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 return NULL;
David Woodhouse4e571ab2008-05-01 12:28:04 +010042 return &f->vfs_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043}
44
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +110045static void jffs2_i_callback(struct rcu_head *head)
46{
47 struct inode *inode = container_of(head, struct inode, i_rcu);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +110048 kmem_cache_free(jffs2_inode_cachep, JFFS2_INODE_INFO(inode));
49}
50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051static void jffs2_destroy_inode(struct inode *inode)
52{
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +110053 call_rcu(&inode->i_rcu, jffs2_i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054}
55
Alexey Dobriyan51cc5062008-07-25 19:45:34 -070056static void jffs2_i_init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057{
David Woodhouse4e571ab2008-05-01 12:28:04 +010058 struct jffs2_inode_info *f = foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
David Woodhouse4e571ab2008-05-01 12:28:04 +010060 mutex_init(&f->sem);
61 inode_init_once(&f->vfs_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062}
63
Christoph Hellwig01ba6872009-05-11 23:34:27 +020064static void jffs2_write_super(struct super_block *sb)
65{
66 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
Christoph Hellwigebc1ac12009-05-11 23:35:03 +020067
68 lock_super(sb);
Christoph Hellwig01ba6872009-05-11 23:34:27 +020069 sb->s_dirt = 0;
70
Christoph Hellwigebc1ac12009-05-11 23:35:03 +020071 if (!(sb->s_flags & MS_RDONLY)) {
72 D1(printk(KERN_DEBUG "jffs2_write_super()\n"));
Christoph Hellwigebc1ac12009-05-11 23:35:03 +020073 jffs2_flush_wbuf_gc(c, 0);
74 }
Christoph Hellwig01ba6872009-05-11 23:34:27 +020075
Christoph Hellwigebc1ac12009-05-11 23:35:03 +020076 unlock_super(sb);
Christoph Hellwig01ba6872009-05-11 23:34:27 +020077}
78
Andres Salomon92abc472011-10-16 18:15:16 -070079static const char *jffs2_compr_name(unsigned int compr)
80{
81 switch (compr) {
82 case JFFS2_COMPR_MODE_NONE:
83 return "none";
Andres Salomon123005f2011-10-16 18:15:23 -070084#ifdef CONFIG_JFFS2_LZO
85 case JFFS2_COMPR_MODE_FORCELZO:
86 return "lzo";
87#endif
88#ifdef CONFIG_JFFS2_ZLIB
89 case JFFS2_COMPR_MODE_FORCEZLIB:
90 return "zlib";
91#endif
Andres Salomon92abc472011-10-16 18:15:16 -070092 default:
93 /* should never happen; programmer error */
94 WARN_ON(1);
95 return "";
96 }
97}
98
Al Viro34c80b12011-12-08 21:32:45 -050099static int jffs2_show_options(struct seq_file *s, struct dentry *root)
Andres Salomon92abc472011-10-16 18:15:16 -0700100{
Al Viro34c80b12011-12-08 21:32:45 -0500101 struct jffs2_sb_info *c = JFFS2_SB_INFO(root->d_sb);
Andres Salomon92abc472011-10-16 18:15:16 -0700102 struct jffs2_mount_opts *opts = &c->mount_opts;
103
104 if (opts->override_compr)
105 seq_printf(s, ",compr=%s", jffs2_compr_name(opts->compr));
106
107 return 0;
108}
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110static int jffs2_sync_fs(struct super_block *sb, int wait)
111{
112 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
113
Christoph Hellwigd579ed02009-06-08 10:08:21 +0200114 jffs2_write_super(sb);
115
David Woodhouseced22072008-04-22 15:13:40 +0100116 mutex_lock(&c->alloc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 jffs2_flush_wbuf_pad(c);
David Woodhouseced22072008-04-22 15:13:40 +0100118 mutex_unlock(&c->alloc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 return 0;
120}
121
David Woodhouse5f556aa2008-07-31 20:39:25 +0100122static struct inode *jffs2_nfs_get_inode(struct super_block *sb, uint64_t ino,
123 uint32_t generation)
124{
125 /* We don't care about i_generation. We'll destroy the flash
126 before we start re-using inode numbers anyway. And even
127 if that wasn't true, we'd have other problems...*/
128 return jffs2_iget(sb, ino);
129}
130
131static struct dentry *jffs2_fh_to_dentry(struct super_block *sb, struct fid *fid,
132 int fh_len, int fh_type)
133{
134 return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
135 jffs2_nfs_get_inode);
136}
137
138static struct dentry *jffs2_fh_to_parent(struct super_block *sb, struct fid *fid,
139 int fh_len, int fh_type)
140{
141 return generic_fh_to_parent(sb, fid, fh_len, fh_type,
142 jffs2_nfs_get_inode);
143}
144
145static struct dentry *jffs2_get_parent(struct dentry *child)
146{
147 struct jffs2_inode_info *f;
148 uint32_t pino;
149
150 BUG_ON(!S_ISDIR(child->d_inode->i_mode));
151
152 f = JFFS2_INODE_INFO(child->d_inode);
153
154 pino = f->inocache->pino_nlink;
155
156 JFFS2_DEBUG("Parent of directory ino #%u is #%u\n",
157 f->inocache->ino, pino);
158
159 return d_obtain_alias(jffs2_iget(child->d_inode->i_sb, pino));
160}
161
Alexey Dobriyanac4cfdd2009-09-21 17:01:10 -0700162static const struct export_operations jffs2_export_ops = {
David Woodhouse5f556aa2008-07-31 20:39:25 +0100163 .get_parent = jffs2_get_parent,
164 .fh_to_dentry = jffs2_fh_to_dentry,
165 .fh_to_parent = jffs2_fh_to_parent,
166};
167
Andres Salomon92abc472011-10-16 18:15:16 -0700168/*
169 * JFFS2 mount options.
170 *
171 * Opt_override_compr: override default compressor
172 * Opt_err: just end of array marker
173 */
174enum {
175 Opt_override_compr,
176 Opt_err,
177};
178
179static const match_table_t tokens = {
180 {Opt_override_compr, "compr=%s"},
181 {Opt_err, NULL},
182};
183
184static int jffs2_parse_options(struct jffs2_sb_info *c, char *data)
185{
186 substring_t args[MAX_OPT_ARGS];
187 char *p, *name;
188
189 if (!data)
190 return 0;
191
192 while ((p = strsep(&data, ","))) {
193 int token;
194
195 if (!*p)
196 continue;
197
198 token = match_token(p, tokens, args);
199 switch (token) {
200 case Opt_override_compr:
201 name = match_strdup(&args[0]);
202
203 if (!name)
204 return -ENOMEM;
Andres Salomon123005f2011-10-16 18:15:23 -0700205 if (!strcmp(name, "none"))
Andres Salomon92abc472011-10-16 18:15:16 -0700206 c->mount_opts.compr = JFFS2_COMPR_MODE_NONE;
Andres Salomon123005f2011-10-16 18:15:23 -0700207#ifdef CONFIG_JFFS2_LZO
208 else if (!strcmp(name, "lzo"))
209 c->mount_opts.compr = JFFS2_COMPR_MODE_FORCELZO;
210#endif
211#ifdef CONFIG_JFFS2_ZLIB
212 else if (!strcmp(name, "zlib"))
213 c->mount_opts.compr =
214 JFFS2_COMPR_MODE_FORCEZLIB;
215#endif
216 else {
217 printk(KERN_ERR "JFFS2 Error: unknown compressor \"%s\"",
218 name);
219 kfree(name);
220 return -EINVAL;
Andres Salomon92abc472011-10-16 18:15:16 -0700221 }
222 kfree(name);
Andres Salomon123005f2011-10-16 18:15:23 -0700223 c->mount_opts.override_compr = true;
Andres Salomon92abc472011-10-16 18:15:16 -0700224 break;
225 default:
226 printk(KERN_ERR "JFFS2 Error: unrecognized mount option '%s' or missing value\n",
227 p);
228 return -EINVAL;
229 }
230 }
231
232 return 0;
233}
234
235static int jffs2_remount_fs(struct super_block *sb, int *flags, char *data)
236{
237 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
238 int err;
239
240 err = jffs2_parse_options(c, data);
241 if (err)
242 return -EINVAL;
243
244 return jffs2_do_remount_fs(sb, flags, data);
245}
246
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800247static const struct super_operations jffs2_super_operations =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248{
249 .alloc_inode = jffs2_alloc_inode,
250 .destroy_inode =jffs2_destroy_inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 .put_super = jffs2_put_super,
252 .write_super = jffs2_write_super,
253 .statfs = jffs2_statfs,
254 .remount_fs = jffs2_remount_fs,
Al Virob57922d2010-06-07 14:34:48 -0400255 .evict_inode = jffs2_evict_inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 .dirty_inode = jffs2_dirty_inode,
Andres Salomon92abc472011-10-16 18:15:16 -0700257 .show_options = jffs2_show_options,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 .sync_fs = jffs2_sync_fs,
259};
260
David Howellsacaebfd2007-05-10 22:51:50 -0700261/*
262 * fill in the superblock
263 */
264static int jffs2_fill_super(struct super_block *sb, void *data, int silent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 struct jffs2_sb_info *c;
Jan Blunckdb719222010-08-15 22:51:10 +0200267 int ret;
268
David Howellsacaebfd2007-05-10 22:51:50 -0700269 D1(printk(KERN_DEBUG "jffs2_get_sb_mtd():"
270 " New superblock for device %d (\"%s\")\n",
271 sb->s_mtd->index, sb->s_mtd->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Panagiotis Issarisf8314dc2006-09-27 01:49:37 -0700273 c = kzalloc(sizeof(*c), GFP_KERNEL);
Arnd Bergmann1a028dd2010-09-16 16:11:09 +0200274 if (!c)
David Howells454e2392006-06-23 02:02:57 -0700275 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
David Howellsacaebfd2007-05-10 22:51:50 -0700277 c->mtd = sb->s_mtd;
278 c->os_priv = sb;
279 sb->s_fs_info = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
Andres Salomon92abc472011-10-16 18:15:16 -0700281 ret = jffs2_parse_options(c, data);
282 if (ret) {
283 kfree(c);
284 return -EINVAL;
285 }
286
David Howellsacaebfd2007-05-10 22:51:50 -0700287 /* Initialize JFFS2 superblock locks, the further initialization will
288 * be done later */
David Woodhouseced22072008-04-22 15:13:40 +0100289 mutex_init(&c->alloc_sem);
290 mutex_init(&c->erase_free_sem);
Artem B. Bityuckiyb6220592005-07-12 17:37:12 +0100291 init_waitqueue_head(&c->erase_wait);
292 init_waitqueue_head(&c->inocache_wq);
293 spin_lock_init(&c->erase_completion_lock);
294 spin_lock_init(&c->inocache_lock);
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 sb->s_op = &jffs2_super_operations;
David Woodhouse5f556aa2008-07-31 20:39:25 +0100297 sb->s_export_op = &jffs2_export_ops;
David Howellsacaebfd2007-05-10 22:51:50 -0700298 sb->s_flags = sb->s_flags | MS_NOATIME;
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900299 sb->s_xattr = jffs2_xattr_handlers;
300#ifdef CONFIG_JFFS2_FS_POSIX_ACL
301 sb->s_flags |= MS_POSIXACL;
302#endif
Jan Blunckdb719222010-08-15 22:51:10 +0200303 ret = jffs2_do_fill_super(sb, data, silent);
Jan Blunckdb719222010-08-15 22:51:10 +0200304 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305}
306
Al Viro848b83a2010-07-25 00:56:46 +0400307static struct dentry *jffs2_mount(struct file_system_type *fs_type,
David Howells454e2392006-06-23 02:02:57 -0700308 int flags, const char *dev_name,
Al Viro848b83a2010-07-25 00:56:46 +0400309 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310{
Al Viro848b83a2010-07-25 00:56:46 +0400311 return mount_mtd(fs_type, flags, dev_name, data, jffs2_fill_super);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
313
314static void jffs2_put_super (struct super_block *sb)
315{
316 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
317
318 D2(printk(KERN_DEBUG "jffs2: jffs2_put_super()\n"));
319
Christoph Hellwig8c85e122009-04-28 18:00:26 +0200320 if (sb->s_dirt)
321 jffs2_write_super(sb);
322
David Woodhouseced22072008-04-22 15:13:40 +0100323 mutex_lock(&c->alloc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 jffs2_flush_wbuf_pad(c);
David Woodhouseced22072008-04-22 15:13:40 +0100325 mutex_unlock(&c->alloc_sem);
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100326
327 jffs2_sum_exit(c);
328
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 jffs2_free_ino_caches(c);
330 jffs2_free_raw_node_refs(c);
Ferenc Havasi4ce1f562005-08-31 14:51:04 +0100331 if (jffs2_blocks_use_vmalloc(c))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 vfree(c->blocks);
333 else
334 kfree(c->blocks);
335 jffs2_flash_cleanup(c);
336 kfree(c->inocache_list);
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900337 jffs2_clear_xattr_subsystem(c);
Artem Bityutskiy327cf292011-12-30 16:35:35 +0200338 mtd_sync(c->mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 D1(printk(KERN_DEBUG "jffs2_put_super returning\n"));
340}
341
342static void jffs2_kill_sb(struct super_block *sb)
343{
344 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
Artem B. Bityuckiya69dde92005-05-18 12:37:28 +0100345 if (!(sb->s_flags & MS_RDONLY))
346 jffs2_stop_garbage_collect_thread(c);
David Howellsacaebfd2007-05-10 22:51:50 -0700347 kill_mtd_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 kfree(c);
349}
350
351static struct file_system_type jffs2_fs_type = {
352 .owner = THIS_MODULE,
353 .name = "jffs2",
Al Viro848b83a2010-07-25 00:56:46 +0400354 .mount = jffs2_mount,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 .kill_sb = jffs2_kill_sb,
356};
357
358static int __init init_jffs2_fs(void)
359{
360 int ret;
361
David Woodhouse3e68fbb2006-05-15 00:49:43 +0100362 /* Paranoia checks for on-medium structures. If we ask GCC
363 to pack them with __attribute__((packed)) then it _also_
364 assumes that they're not aligned -- so it emits crappy
365 code on some architectures. Ideally we want an attribute
366 which means just 'no padding', without the alignment
367 thing. But GCC doesn't have that -- we have to just
368 hope the structs are the right sizes, instead. */
Alexey Dobriyan2ecd05a2006-10-11 01:22:05 -0700369 BUILD_BUG_ON(sizeof(struct jffs2_unknown_node) != 12);
370 BUILD_BUG_ON(sizeof(struct jffs2_raw_dirent) != 40);
371 BUILD_BUG_ON(sizeof(struct jffs2_raw_inode) != 68);
372 BUILD_BUG_ON(sizeof(struct jffs2_raw_summary) != 32);
David Woodhouse3e68fbb2006-05-15 00:49:43 +0100373
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 printk(KERN_INFO "JFFS2 version 2.2."
Andrew Victor2f82ce12005-02-09 09:24:26 +0000375#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 " (NAND)"
377#endif
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100378#ifdef CONFIG_JFFS2_SUMMARY
379 " (SUMMARY) "
380#endif
David Woodhousec00c3102007-04-25 14:16:47 +0100381 " © 2001-2006 Red Hat, Inc.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 jffs2_inode_cachep = kmem_cache_create("jffs2_i",
384 sizeof(struct jffs2_inode_info),
Paul Jacksonfffb60f2006-03-24 03:16:06 -0800385 0, (SLAB_RECLAIM_ACCOUNT|
386 SLAB_MEM_SPREAD),
Paul Mundt20c2df82007-07-20 10:11:58 +0900387 jffs2_i_init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 if (!jffs2_inode_cachep) {
389 printk(KERN_ERR "JFFS2 error: Failed to initialise inode cache\n");
390 return -ENOMEM;
391 }
392 ret = jffs2_compressors_init();
393 if (ret) {
394 printk(KERN_ERR "JFFS2 error: Failed to initialise compressors\n");
395 goto out;
396 }
397 ret = jffs2_create_slab_caches();
398 if (ret) {
399 printk(KERN_ERR "JFFS2 error: Failed to initialise slab caches\n");
400 goto out_compressors;
401 }
402 ret = register_filesystem(&jffs2_fs_type);
403 if (ret) {
404 printk(KERN_ERR "JFFS2 error: Failed to register filesystem\n");
405 goto out_slab;
406 }
407 return 0;
408
409 out_slab:
410 jffs2_destroy_slab_caches();
411 out_compressors:
412 jffs2_compressors_exit();
413 out:
414 kmem_cache_destroy(jffs2_inode_cachep);
415 return ret;
416}
417
418static void __exit exit_jffs2_fs(void)
419{
420 unregister_filesystem(&jffs2_fs_type);
421 jffs2_destroy_slab_caches();
422 jffs2_compressors_exit();
423 kmem_cache_destroy(jffs2_inode_cachep);
424}
425
426module_init(init_jffs2_fs);
427module_exit(exit_jffs2_fs);
428
429MODULE_DESCRIPTION("The Journalling Flash File System, v2");
430MODULE_AUTHOR("Red Hat, Inc.");
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000431MODULE_LICENSE("GPL"); // Actually dual-licensed, but it doesn't matter for
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 // the sake of this tag. It's Free Software.