blob: f9916f312bd81e3590fde1c92a025458cb64ab11 [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
Joe Perches5a528952012-02-15 15:56:45 -080012#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#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>
Artem Bityutskiy9c740342006-10-11 14:52:47 +030020#include <linux/err.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/mount.h>
Andres Salomon92abc472011-10-16 18:15:16 -070022#include <linux/parser.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/jffs2.h>
24#include <linux/pagemap.h>
David Howellsacaebfd2007-05-10 22:51:50 -070025#include <linux/mtd/super.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/ctype.h>
27#include <linux/namei.h>
Andres Salomon92abc472011-10-16 18:15:16 -070028#include <linux/seq_file.h>
David Woodhouse5f556aa2008-07-31 20:39:25 +010029#include <linux/exportfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include "compr.h"
31#include "nodelist.h"
32
33static void jffs2_put_super(struct super_block *);
34
Christoph Lametere18b8902006-12-06 20:33:20 -080035static struct kmem_cache *jffs2_inode_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37static struct inode *jffs2_alloc_inode(struct super_block *sb)
38{
David Woodhouse4e571ab2008-05-01 12:28:04 +010039 struct jffs2_inode_info *f;
40
41 f = kmem_cache_alloc(jffs2_inode_cachep, GFP_KERNEL);
42 if (!f)
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 return NULL;
David Woodhouse4e571ab2008-05-01 12:28:04 +010044 return &f->vfs_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045}
46
Nick Pigginfa0d7e32011-01-07 17:49:49 +110047static void jffs2_i_callback(struct rcu_head *head)
48{
49 struct inode *inode = container_of(head, struct inode, i_rcu);
Nick Pigginfa0d7e32011-01-07 17:49:49 +110050 kmem_cache_free(jffs2_inode_cachep, JFFS2_INODE_INFO(inode));
51}
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053static void jffs2_destroy_inode(struct inode *inode)
54{
Nick Pigginfa0d7e32011-01-07 17:49:49 +110055 call_rcu(&inode->i_rcu, jffs2_i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056}
57
Alexey Dobriyan51cc5062008-07-25 19:45:34 -070058static void jffs2_i_init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -070059{
David Woodhouse4e571ab2008-05-01 12:28:04 +010060 struct jffs2_inode_info *f = foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
David Woodhouse4e571ab2008-05-01 12:28:04 +010062 mutex_init(&f->sem);
63 inode_init_once(&f->vfs_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064}
65
Christoph Hellwig01ba6872009-05-11 23:34:27 +020066static void jffs2_write_super(struct super_block *sb)
67{
68 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
Christoph Hellwigebc1ac12009-05-11 23:35:03 +020069
70 lock_super(sb);
Christoph Hellwig01ba6872009-05-11 23:34:27 +020071 sb->s_dirt = 0;
72
Christoph Hellwigebc1ac12009-05-11 23:35:03 +020073 if (!(sb->s_flags & MS_RDONLY)) {
Joe Perches9c261b32012-02-15 15:56:43 -080074 jffs2_dbg(1, "%s()\n", __func__);
Christoph Hellwigebc1ac12009-05-11 23:35:03 +020075 jffs2_flush_wbuf_gc(c, 0);
76 }
Christoph Hellwig01ba6872009-05-11 23:34:27 +020077
Christoph Hellwigebc1ac12009-05-11 23:35:03 +020078 unlock_super(sb);
Christoph Hellwig01ba6872009-05-11 23:34:27 +020079}
80
Andres Salomon92abc472011-10-16 18:15:16 -070081static const char *jffs2_compr_name(unsigned int compr)
82{
83 switch (compr) {
84 case JFFS2_COMPR_MODE_NONE:
85 return "none";
Andres Salomon123005f2011-10-16 18:15:23 -070086#ifdef CONFIG_JFFS2_LZO
87 case JFFS2_COMPR_MODE_FORCELZO:
88 return "lzo";
89#endif
90#ifdef CONFIG_JFFS2_ZLIB
91 case JFFS2_COMPR_MODE_FORCEZLIB:
92 return "zlib";
93#endif
Andres Salomon92abc472011-10-16 18:15:16 -070094 default:
95 /* should never happen; programmer error */
96 WARN_ON(1);
97 return "";
98 }
99}
100
Al Viro34c80b12011-12-08 21:32:45 -0500101static int jffs2_show_options(struct seq_file *s, struct dentry *root)
Andres Salomon92abc472011-10-16 18:15:16 -0700102{
Al Viro34c80b12011-12-08 21:32:45 -0500103 struct jffs2_sb_info *c = JFFS2_SB_INFO(root->d_sb);
Andres Salomon92abc472011-10-16 18:15:16 -0700104 struct jffs2_mount_opts *opts = &c->mount_opts;
105
106 if (opts->override_compr)
107 seq_printf(s, ",compr=%s", jffs2_compr_name(opts->compr));
108
109 return 0;
110}
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112static int jffs2_sync_fs(struct super_block *sb, int wait)
113{
114 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
115
Christoph Hellwigd579ed02009-06-08 10:08:21 +0200116 jffs2_write_super(sb);
117
David Woodhouseced22072008-04-22 15:13:40 +0100118 mutex_lock(&c->alloc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 jffs2_flush_wbuf_pad(c);
David Woodhouseced22072008-04-22 15:13:40 +0100120 mutex_unlock(&c->alloc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 return 0;
122}
123
David Woodhouse5f556aa2008-07-31 20:39:25 +0100124static struct inode *jffs2_nfs_get_inode(struct super_block *sb, uint64_t ino,
125 uint32_t generation)
126{
127 /* We don't care about i_generation. We'll destroy the flash
128 before we start re-using inode numbers anyway. And even
129 if that wasn't true, we'd have other problems...*/
130 return jffs2_iget(sb, ino);
131}
132
133static struct dentry *jffs2_fh_to_dentry(struct super_block *sb, struct fid *fid,
134 int fh_len, int fh_type)
135{
136 return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
137 jffs2_nfs_get_inode);
138}
139
140static struct dentry *jffs2_fh_to_parent(struct super_block *sb, struct fid *fid,
141 int fh_len, int fh_type)
142{
143 return generic_fh_to_parent(sb, fid, fh_len, fh_type,
144 jffs2_nfs_get_inode);
145}
146
147static struct dentry *jffs2_get_parent(struct dentry *child)
148{
149 struct jffs2_inode_info *f;
150 uint32_t pino;
151
152 BUG_ON(!S_ISDIR(child->d_inode->i_mode));
153
154 f = JFFS2_INODE_INFO(child->d_inode);
155
156 pino = f->inocache->pino_nlink;
157
158 JFFS2_DEBUG("Parent of directory ino #%u is #%u\n",
159 f->inocache->ino, pino);
160
161 return d_obtain_alias(jffs2_iget(child->d_inode->i_sb, pino));
162}
163
Alexey Dobriyanac4cfdd2009-09-21 17:01:10 -0700164static const struct export_operations jffs2_export_ops = {
David Woodhouse5f556aa2008-07-31 20:39:25 +0100165 .get_parent = jffs2_get_parent,
166 .fh_to_dentry = jffs2_fh_to_dentry,
167 .fh_to_parent = jffs2_fh_to_parent,
168};
169
Andres Salomon92abc472011-10-16 18:15:16 -0700170/*
171 * JFFS2 mount options.
172 *
173 * Opt_override_compr: override default compressor
174 * Opt_err: just end of array marker
175 */
176enum {
177 Opt_override_compr,
178 Opt_err,
179};
180
181static const match_table_t tokens = {
182 {Opt_override_compr, "compr=%s"},
183 {Opt_err, NULL},
184};
185
186static int jffs2_parse_options(struct jffs2_sb_info *c, char *data)
187{
188 substring_t args[MAX_OPT_ARGS];
189 char *p, *name;
190
191 if (!data)
192 return 0;
193
194 while ((p = strsep(&data, ","))) {
195 int token;
196
197 if (!*p)
198 continue;
199
200 token = match_token(p, tokens, args);
201 switch (token) {
202 case Opt_override_compr:
203 name = match_strdup(&args[0]);
204
205 if (!name)
206 return -ENOMEM;
Andres Salomon123005f2011-10-16 18:15:23 -0700207 if (!strcmp(name, "none"))
Andres Salomon92abc472011-10-16 18:15:16 -0700208 c->mount_opts.compr = JFFS2_COMPR_MODE_NONE;
Andres Salomon123005f2011-10-16 18:15:23 -0700209#ifdef CONFIG_JFFS2_LZO
210 else if (!strcmp(name, "lzo"))
211 c->mount_opts.compr = JFFS2_COMPR_MODE_FORCELZO;
212#endif
213#ifdef CONFIG_JFFS2_ZLIB
214 else if (!strcmp(name, "zlib"))
215 c->mount_opts.compr =
216 JFFS2_COMPR_MODE_FORCEZLIB;
217#endif
218 else {
Joe Perches5a528952012-02-15 15:56:45 -0800219 pr_err("Error: unknown compressor \"%s\"\n",
Joe Perchesda320f02012-02-15 15:56:44 -0800220 name);
Andres Salomon123005f2011-10-16 18:15:23 -0700221 kfree(name);
222 return -EINVAL;
Andres Salomon92abc472011-10-16 18:15:16 -0700223 }
224 kfree(name);
Andres Salomon123005f2011-10-16 18:15:23 -0700225 c->mount_opts.override_compr = true;
Andres Salomon92abc472011-10-16 18:15:16 -0700226 break;
227 default:
Joe Perches5a528952012-02-15 15:56:45 -0800228 pr_err("Error: unrecognized mount option '%s' or missing value\n",
Joe Perchesda320f02012-02-15 15:56:44 -0800229 p);
Andres Salomon92abc472011-10-16 18:15:16 -0700230 return -EINVAL;
231 }
232 }
233
234 return 0;
235}
236
237static int jffs2_remount_fs(struct super_block *sb, int *flags, char *data)
238{
239 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
240 int err;
241
242 err = jffs2_parse_options(c, data);
243 if (err)
244 return -EINVAL;
245
246 return jffs2_do_remount_fs(sb, flags, data);
247}
248
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800249static const struct super_operations jffs2_super_operations =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250{
251 .alloc_inode = jffs2_alloc_inode,
252 .destroy_inode =jffs2_destroy_inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 .put_super = jffs2_put_super,
254 .write_super = jffs2_write_super,
255 .statfs = jffs2_statfs,
256 .remount_fs = jffs2_remount_fs,
Al Virob57922d2010-06-07 14:34:48 -0400257 .evict_inode = jffs2_evict_inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 .dirty_inode = jffs2_dirty_inode,
Andres Salomon92abc472011-10-16 18:15:16 -0700259 .show_options = jffs2_show_options,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 .sync_fs = jffs2_sync_fs,
261};
262
David Howellsacaebfd2007-05-10 22:51:50 -0700263/*
264 * fill in the superblock
265 */
266static int jffs2_fill_super(struct super_block *sb, void *data, int silent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 struct jffs2_sb_info *c;
Jan Blunckdb719222010-08-15 22:51:10 +0200269 int ret;
270
Joe Perches9c261b32012-02-15 15:56:43 -0800271 jffs2_dbg(1, "jffs2_get_sb_mtd():"
David Howellsacaebfd2007-05-10 22:51:50 -0700272 " New superblock for device %d (\"%s\")\n",
Joe Perches9c261b32012-02-15 15:56:43 -0800273 sb->s_mtd->index, sb->s_mtd->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Panagiotis Issarisf8314dc2006-09-27 01:49:37 -0700275 c = kzalloc(sizeof(*c), GFP_KERNEL);
Arnd Bergmann1a028dd2010-09-16 16:11:09 +0200276 if (!c)
David Howells454e2392006-06-23 02:02:57 -0700277 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
David Howellsacaebfd2007-05-10 22:51:50 -0700279 c->mtd = sb->s_mtd;
280 c->os_priv = sb;
281 sb->s_fs_info = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Andres Salomon92abc472011-10-16 18:15:16 -0700283 ret = jffs2_parse_options(c, data);
284 if (ret) {
285 kfree(c);
286 return -EINVAL;
287 }
288
David Howellsacaebfd2007-05-10 22:51:50 -0700289 /* Initialize JFFS2 superblock locks, the further initialization will
290 * be done later */
David Woodhouseced22072008-04-22 15:13:40 +0100291 mutex_init(&c->alloc_sem);
292 mutex_init(&c->erase_free_sem);
Artem B. Bityuckiyb6220592005-07-12 17:37:12 +0100293 init_waitqueue_head(&c->erase_wait);
294 init_waitqueue_head(&c->inocache_wq);
295 spin_lock_init(&c->erase_completion_lock);
296 spin_lock_init(&c->inocache_lock);
297
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 sb->s_op = &jffs2_super_operations;
David Woodhouse5f556aa2008-07-31 20:39:25 +0100299 sb->s_export_op = &jffs2_export_ops;
David Howellsacaebfd2007-05-10 22:51:50 -0700300 sb->s_flags = sb->s_flags | MS_NOATIME;
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900301 sb->s_xattr = jffs2_xattr_handlers;
302#ifdef CONFIG_JFFS2_FS_POSIX_ACL
303 sb->s_flags |= MS_POSIXACL;
304#endif
Jan Blunckdb719222010-08-15 22:51:10 +0200305 ret = jffs2_do_fill_super(sb, data, silent);
Jan Blunckdb719222010-08-15 22:51:10 +0200306 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307}
308
Al Viro848b83a2010-07-25 00:56:46 +0400309static struct dentry *jffs2_mount(struct file_system_type *fs_type,
David Howells454e2392006-06-23 02:02:57 -0700310 int flags, const char *dev_name,
Al Viro848b83a2010-07-25 00:56:46 +0400311 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312{
Al Viro848b83a2010-07-25 00:56:46 +0400313 return mount_mtd(fs_type, flags, dev_name, data, jffs2_fill_super);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314}
315
316static void jffs2_put_super (struct super_block *sb)
317{
318 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
319
Joe Perches9c261b32012-02-15 15:56:43 -0800320 jffs2_dbg(2, "%s()\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
Christoph Hellwig8c85e122009-04-28 18:00:26 +0200322 if (sb->s_dirt)
323 jffs2_write_super(sb);
324
David Woodhouseced22072008-04-22 15:13:40 +0100325 mutex_lock(&c->alloc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 jffs2_flush_wbuf_pad(c);
David Woodhouseced22072008-04-22 15:13:40 +0100327 mutex_unlock(&c->alloc_sem);
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100328
329 jffs2_sum_exit(c);
330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 jffs2_free_ino_caches(c);
332 jffs2_free_raw_node_refs(c);
Ferenc Havasi4ce1f562005-08-31 14:51:04 +0100333 if (jffs2_blocks_use_vmalloc(c))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 vfree(c->blocks);
335 else
336 kfree(c->blocks);
337 jffs2_flash_cleanup(c);
338 kfree(c->inocache_list);
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +0900339 jffs2_clear_xattr_subsystem(c);
Artem Bityutskiy327cf292011-12-30 16:35:35 +0200340 mtd_sync(c->mtd);
Joe Perches9c261b32012-02-15 15:56:43 -0800341 jffs2_dbg(1, "%s(): returning\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342}
343
344static void jffs2_kill_sb(struct super_block *sb)
345{
346 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
Artem B. Bityuckiya69dde92005-05-18 12:37:28 +0100347 if (!(sb->s_flags & MS_RDONLY))
348 jffs2_stop_garbage_collect_thread(c);
David Howellsacaebfd2007-05-10 22:51:50 -0700349 kill_mtd_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 kfree(c);
351}
352
353static struct file_system_type jffs2_fs_type = {
354 .owner = THIS_MODULE,
355 .name = "jffs2",
Al Viro848b83a2010-07-25 00:56:46 +0400356 .mount = jffs2_mount,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 .kill_sb = jffs2_kill_sb,
358};
359
360static int __init init_jffs2_fs(void)
361{
362 int ret;
363
David Woodhouse3e68fbb2006-05-15 00:49:43 +0100364 /* Paranoia checks for on-medium structures. If we ask GCC
365 to pack them with __attribute__((packed)) then it _also_
366 assumes that they're not aligned -- so it emits crappy
367 code on some architectures. Ideally we want an attribute
368 which means just 'no padding', without the alignment
369 thing. But GCC doesn't have that -- we have to just
370 hope the structs are the right sizes, instead. */
Alexey Dobriyan2ecd05a2006-10-11 01:22:05 -0700371 BUILD_BUG_ON(sizeof(struct jffs2_unknown_node) != 12);
372 BUILD_BUG_ON(sizeof(struct jffs2_raw_dirent) != 40);
373 BUILD_BUG_ON(sizeof(struct jffs2_raw_inode) != 68);
374 BUILD_BUG_ON(sizeof(struct jffs2_raw_summary) != 32);
David Woodhouse3e68fbb2006-05-15 00:49:43 +0100375
Joe Perches5a528952012-02-15 15:56:45 -0800376 pr_info("version 2.2."
Andrew Victor2f82ce12005-02-09 09:24:26 +0000377#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 " (NAND)"
379#endif
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100380#ifdef CONFIG_JFFS2_SUMMARY
381 " (SUMMARY) "
382#endif
David Woodhousec00c3102007-04-25 14:16:47 +0100383 " © 2001-2006 Red Hat, Inc.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385 jffs2_inode_cachep = kmem_cache_create("jffs2_i",
386 sizeof(struct jffs2_inode_info),
Paul Jacksonfffb60f2006-03-24 03:16:06 -0800387 0, (SLAB_RECLAIM_ACCOUNT|
388 SLAB_MEM_SPREAD),
Paul Mundt20c2df82007-07-20 10:11:58 +0900389 jffs2_i_init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 if (!jffs2_inode_cachep) {
Joe Perches5a528952012-02-15 15:56:45 -0800391 pr_err("error: Failed to initialise inode cache\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 return -ENOMEM;
393 }
394 ret = jffs2_compressors_init();
395 if (ret) {
Joe Perches5a528952012-02-15 15:56:45 -0800396 pr_err("error: Failed to initialise compressors\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 goto out;
398 }
399 ret = jffs2_create_slab_caches();
400 if (ret) {
Joe Perches5a528952012-02-15 15:56:45 -0800401 pr_err("error: Failed to initialise slab caches\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 goto out_compressors;
403 }
404 ret = register_filesystem(&jffs2_fs_type);
405 if (ret) {
Joe Perches5a528952012-02-15 15:56:45 -0800406 pr_err("error: Failed to register filesystem\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 goto out_slab;
408 }
409 return 0;
410
411 out_slab:
412 jffs2_destroy_slab_caches();
413 out_compressors:
414 jffs2_compressors_exit();
415 out:
416 kmem_cache_destroy(jffs2_inode_cachep);
417 return ret;
418}
419
420static void __exit exit_jffs2_fs(void)
421{
422 unregister_filesystem(&jffs2_fs_type);
423 jffs2_destroy_slab_caches();
424 jffs2_compressors_exit();
425 kmem_cache_destroy(jffs2_inode_cachep);
426}
427
428module_init(init_jffs2_fs);
429module_exit(exit_jffs2_fs);
430
431MODULE_DESCRIPTION("The Journalling Flash File System, v2");
432MODULE_AUTHOR("Red Hat, Inc.");
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000433MODULE_LICENSE("GPL"); // Actually dual-licensed, but it doesn't matter for
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 // the sake of this tag. It's Free Software.