2 * JFFS2 -- Journalling Flash File System, Version 2.
4 * Copyright © 2001-2007 Red Hat, Inc.
6 * Created by David Woodhouse <dwmw2@infradead.org>
8 * For licensing information, see the file 'LICENCE' in this directory.
12 #include <linux/capability.h>
13 #include <linux/kernel.h>
14 #include <linux/sched.h>
16 #include <linux/list.h>
17 #include <linux/mtd/mtd.h>
18 #include <linux/pagemap.h>
19 #include <linux/slab.h>
20 #include <linux/vmalloc.h>
21 #include <linux/vfs.h>
22 #include <linux/crc32.h>
25 static int jffs2_flash_setup(struct jffs2_sb_info *c);
27 int jffs2_do_setattr (struct inode *inode, struct iattr *iattr)
29 struct jffs2_full_dnode *old_metadata, *new_metadata;
30 struct jffs2_inode_info *f = JFFS2_INODE_INFO(inode);
31 struct jffs2_sb_info *c = JFFS2_SB_INFO(inode->i_sb);
32 struct jffs2_raw_inode *ri;
33 union jffs2_device_node dev;
34 unsigned char *mdata = NULL;
39 int alloc_type = ALLOC_NORMAL;
41 D1(printk(KERN_DEBUG "jffs2_setattr(): ino #%lu\n", inode->i_ino));
43 /* Special cases - we don't want more than one data node
44 for these types on the medium at any time. So setattr
45 must read the original data associated with the node
46 (i.e. the device numbers or the target name) and write
47 it out again with the appropriate data attached */
48 if (S_ISBLK(inode->i_mode) || S_ISCHR(inode->i_mode)) {
49 /* For these, we don't actually need to read the old node */
50 mdatalen = jffs2_encode_dev(&dev, inode->i_rdev);
52 D1(printk(KERN_DEBUG "jffs2_setattr(): Writing %d bytes of kdev_t\n", mdatalen));
53 } else if (S_ISLNK(inode->i_mode)) {
55 mdatalen = f->metadata->size;
56 mdata = kmalloc(f->metadata->size, GFP_USER);
58 mutex_unlock(&f->sem);
61 ret = jffs2_read_dnode(c, f, f->metadata, mdata, 0, mdatalen);
63 mutex_unlock(&f->sem);
67 mutex_unlock(&f->sem);
68 D1(printk(KERN_DEBUG "jffs2_setattr(): Writing %d bytes of symlink target\n", mdatalen));
71 ri = jffs2_alloc_raw_inode();
73 if (S_ISLNK(inode->i_mode))
78 ret = jffs2_reserve_space(c, sizeof(*ri) + mdatalen, &alloclen,
79 ALLOC_NORMAL, JFFS2_SUMMARY_INODE_SIZE);
81 jffs2_free_raw_inode(ri);
82 if (S_ISLNK(inode->i_mode & S_IFMT))
87 ivalid = iattr->ia_valid;
89 ri->magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
90 ri->nodetype = cpu_to_je16(JFFS2_NODETYPE_INODE);
91 ri->totlen = cpu_to_je32(sizeof(*ri) + mdatalen);
92 ri->hdr_crc = cpu_to_je32(crc32(0, ri, sizeof(struct jffs2_unknown_node)-4));
94 ri->ino = cpu_to_je32(inode->i_ino);
95 ri->version = cpu_to_je32(++f->highest_version);
97 ri->uid = cpu_to_je16((ivalid & ATTR_UID)?iattr->ia_uid:inode->i_uid);
98 ri->gid = cpu_to_je16((ivalid & ATTR_GID)?iattr->ia_gid:inode->i_gid);
100 if (ivalid & ATTR_MODE)
101 ri->mode = cpu_to_jemode(iattr->ia_mode);
103 ri->mode = cpu_to_jemode(inode->i_mode);
106 ri->isize = cpu_to_je32((ivalid & ATTR_SIZE)?iattr->ia_size:inode->i_size);
107 ri->atime = cpu_to_je32(I_SEC((ivalid & ATTR_ATIME)?iattr->ia_atime:inode->i_atime));
108 ri->mtime = cpu_to_je32(I_SEC((ivalid & ATTR_MTIME)?iattr->ia_mtime:inode->i_mtime));
109 ri->ctime = cpu_to_je32(I_SEC((ivalid & ATTR_CTIME)?iattr->ia_ctime:inode->i_ctime));
111 ri->offset = cpu_to_je32(0);
112 ri->csize = ri->dsize = cpu_to_je32(mdatalen);
113 ri->compr = JFFS2_COMPR_NONE;
114 if (ivalid & ATTR_SIZE && inode->i_size < iattr->ia_size) {
115 /* It's an extension. Make it a hole node */
116 ri->compr = JFFS2_COMPR_ZERO;
117 ri->dsize = cpu_to_je32(iattr->ia_size - inode->i_size);
118 ri->offset = cpu_to_je32(inode->i_size);
119 } else if (ivalid & ATTR_SIZE && !iattr->ia_size) {
120 /* For truncate-to-zero, treat it as deletion because
121 it'll always be obsoleting all previous nodes */
122 alloc_type = ALLOC_DELETION;
124 ri->node_crc = cpu_to_je32(crc32(0, ri, sizeof(*ri)-8));
126 ri->data_crc = cpu_to_je32(crc32(0, mdata, mdatalen));
128 ri->data_crc = cpu_to_je32(0);
130 new_metadata = jffs2_write_dnode(c, f, ri, mdata, mdatalen, alloc_type);
131 if (S_ISLNK(inode->i_mode))
134 if (IS_ERR(new_metadata)) {
135 jffs2_complete_reservation(c);
136 jffs2_free_raw_inode(ri);
137 mutex_unlock(&f->sem);
138 return PTR_ERR(new_metadata);
140 /* It worked. Update the inode */
141 inode->i_atime = ITIME(je32_to_cpu(ri->atime));
142 inode->i_ctime = ITIME(je32_to_cpu(ri->ctime));
143 inode->i_mtime = ITIME(je32_to_cpu(ri->mtime));
144 inode->i_mode = jemode_to_cpu(ri->mode);
145 inode->i_uid = je16_to_cpu(ri->uid);
146 inode->i_gid = je16_to_cpu(ri->gid);
149 old_metadata = f->metadata;
151 if (ivalid & ATTR_SIZE && inode->i_size > iattr->ia_size)
152 jffs2_truncate_fragtree (c, &f->fragtree, iattr->ia_size);
154 if (ivalid & ATTR_SIZE && inode->i_size < iattr->ia_size) {
155 jffs2_add_full_dnode_to_inode(c, f, new_metadata);
156 inode->i_size = iattr->ia_size;
157 inode->i_blocks = (inode->i_size + 511) >> 9;
160 f->metadata = new_metadata;
163 jffs2_mark_node_obsolete(c, old_metadata->raw);
164 jffs2_free_full_dnode(old_metadata);
166 jffs2_free_raw_inode(ri);
168 mutex_unlock(&f->sem);
169 jffs2_complete_reservation(c);
171 /* We have to do the vmtruncate() without f->sem held, since
172 some pages may be locked and waiting for it in readpage().
173 We are protected from a simultaneous write() extending i_size
174 back past iattr->ia_size, because do_truncate() holds the
175 generic inode semaphore. */
176 if (ivalid & ATTR_SIZE && inode->i_size > iattr->ia_size) {
177 vmtruncate(inode, iattr->ia_size);
178 inode->i_blocks = (inode->i_size + 511) >> 9;
184 int jffs2_setattr(struct dentry *dentry, struct iattr *iattr)
188 rc = inode_change_ok(dentry->d_inode, iattr);
192 rc = jffs2_do_setattr(dentry->d_inode, iattr);
193 if (!rc && (iattr->ia_valid & ATTR_MODE))
194 rc = jffs2_acl_chmod(dentry->d_inode);
199 int jffs2_statfs(struct dentry *dentry, struct kstatfs *buf)
201 struct jffs2_sb_info *c = JFFS2_SB_INFO(dentry->d_sb);
204 buf->f_type = JFFS2_SUPER_MAGIC;
205 buf->f_bsize = 1 << PAGE_SHIFT;
206 buf->f_blocks = c->flash_size >> PAGE_SHIFT;
209 buf->f_namelen = JFFS2_MAX_NAME_LEN;
211 spin_lock(&c->erase_completion_lock);
212 avail = c->dirty_size + c->free_size;
213 if (avail > c->sector_size * c->resv_blocks_write)
214 avail -= c->sector_size * c->resv_blocks_write;
217 spin_unlock(&c->erase_completion_lock);
219 buf->f_bavail = buf->f_bfree = avail >> PAGE_SHIFT;
225 void jffs2_clear_inode (struct inode *inode)
227 /* We can forget about this inode for now - drop all
228 * the nodelists associated with it, etc.
230 struct jffs2_sb_info *c = JFFS2_SB_INFO(inode->i_sb);
231 struct jffs2_inode_info *f = JFFS2_INODE_INFO(inode);
233 D1(printk(KERN_DEBUG "jffs2_clear_inode(): ino #%lu mode %o\n", inode->i_ino, inode->i_mode));
234 jffs2_do_clear_inode(c, f);
237 struct inode *jffs2_iget(struct super_block *sb, unsigned long ino)
239 struct jffs2_inode_info *f;
240 struct jffs2_sb_info *c;
241 struct jffs2_raw_inode latest_node;
242 union jffs2_device_node jdev;
247 D1(printk(KERN_DEBUG "jffs2_iget(): ino == %lu\n", ino));
249 inode = iget_locked(sb, ino);
251 return ERR_PTR(-ENOMEM);
252 if (!(inode->i_state & I_NEW))
255 f = JFFS2_INODE_INFO(inode);
256 c = JFFS2_SB_INFO(inode->i_sb);
258 jffs2_init_inode_info(f);
261 ret = jffs2_do_read_inode(c, f, inode->i_ino, &latest_node);
264 mutex_unlock(&f->sem);
268 inode->i_mode = jemode_to_cpu(latest_node.mode);
269 inode->i_uid = je16_to_cpu(latest_node.uid);
270 inode->i_gid = je16_to_cpu(latest_node.gid);
271 inode->i_size = je32_to_cpu(latest_node.isize);
272 inode->i_atime = ITIME(je32_to_cpu(latest_node.atime));
273 inode->i_mtime = ITIME(je32_to_cpu(latest_node.mtime));
274 inode->i_ctime = ITIME(je32_to_cpu(latest_node.ctime));
276 inode->i_nlink = f->inocache->nlink;
278 inode->i_blocks = (inode->i_size + 511) >> 9;
280 switch (inode->i_mode & S_IFMT) {
283 inode->i_op = &jffs2_symlink_inode_operations;
288 struct jffs2_full_dirent *fd;
290 for (fd=f->dents; fd; fd = fd->next) {
291 if (fd->type == DT_DIR && fd->ino)
296 /* Root dir gets i_nlink 3 for some reason */
297 if (inode->i_ino == 1)
300 inode->i_op = &jffs2_dir_inode_operations;
301 inode->i_fop = &jffs2_dir_operations;
305 inode->i_op = &jffs2_file_inode_operations;
306 inode->i_fop = &jffs2_file_operations;
307 inode->i_mapping->a_ops = &jffs2_file_address_operations;
308 inode->i_mapping->nrpages = 0;
313 /* Read the device numbers from the media */
314 if (f->metadata->size != sizeof(jdev.old) &&
315 f->metadata->size != sizeof(jdev.new)) {
316 printk(KERN_NOTICE "Device node has strange size %d\n", f->metadata->size);
319 D1(printk(KERN_DEBUG "Reading device numbers from flash\n"));
320 ret = jffs2_read_dnode(c, f, f->metadata, (char *)&jdev, 0, f->metadata->size);
323 printk(KERN_NOTICE "Read device numbers for inode %lu failed\n", (unsigned long)inode->i_ino);
326 if (f->metadata->size == sizeof(jdev.old))
327 rdev = old_decode_dev(je16_to_cpu(jdev.old));
329 rdev = new_decode_dev(je32_to_cpu(jdev.new));
333 inode->i_op = &jffs2_file_inode_operations;
334 init_special_inode(inode, inode->i_mode, rdev);
338 printk(KERN_WARNING "jffs2_read_inode(): Bogus imode %o for ino %lu\n", inode->i_mode, (unsigned long)inode->i_ino);
341 mutex_unlock(&f->sem);
343 D1(printk(KERN_DEBUG "jffs2_read_inode() returning\n"));
344 unlock_new_inode(inode);
350 mutex_unlock(&f->sem);
351 jffs2_do_clear_inode(c, f);
356 void jffs2_dirty_inode(struct inode *inode)
360 if (!(inode->i_state & I_DIRTY_DATASYNC)) {
361 D2(printk(KERN_DEBUG "jffs2_dirty_inode() not calling setattr() for ino #%lu\n", inode->i_ino));
365 D1(printk(KERN_DEBUG "jffs2_dirty_inode() calling setattr() for ino #%lu\n", inode->i_ino));
367 iattr.ia_valid = ATTR_MODE|ATTR_UID|ATTR_GID|ATTR_ATIME|ATTR_MTIME|ATTR_CTIME;
368 iattr.ia_mode = inode->i_mode;
369 iattr.ia_uid = inode->i_uid;
370 iattr.ia_gid = inode->i_gid;
371 iattr.ia_atime = inode->i_atime;
372 iattr.ia_mtime = inode->i_mtime;
373 iattr.ia_ctime = inode->i_ctime;
375 jffs2_do_setattr(inode, &iattr);
378 int jffs2_remount_fs (struct super_block *sb, int *flags, char *data)
380 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
382 if (c->flags & JFFS2_SB_FLAG_RO && !(sb->s_flags & MS_RDONLY))
385 /* We stop if it was running, then restart if it needs to.
386 This also catches the case where it was stopped and this
387 is just a remount to restart it.
388 Flush the writebuffer, if neccecary, else we loose it */
389 if (!(sb->s_flags & MS_RDONLY)) {
390 jffs2_stop_garbage_collect_thread(c);
391 mutex_lock(&c->alloc_sem);
392 jffs2_flush_wbuf_pad(c);
393 mutex_unlock(&c->alloc_sem);
396 if (!(*flags & MS_RDONLY))
397 jffs2_start_garbage_collect_thread(c);
399 *flags |= MS_NOATIME;
404 void jffs2_write_super (struct super_block *sb)
406 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
409 if (sb->s_flags & MS_RDONLY)
412 D1(printk(KERN_DEBUG "jffs2_write_super()\n"));
413 jffs2_garbage_collect_trigger(c);
414 jffs2_erase_pending_blocks(c, 0);
415 jffs2_flush_wbuf_gc(c, 0);
419 /* jffs2_new_inode: allocate a new inode and inocache, add it to the hash,
420 fill in the raw_inode while you're at it. */
421 struct inode *jffs2_new_inode (struct inode *dir_i, int mode, struct jffs2_raw_inode *ri)
424 struct super_block *sb = dir_i->i_sb;
425 struct jffs2_sb_info *c;
426 struct jffs2_inode_info *f;
429 D1(printk(KERN_DEBUG "jffs2_new_inode(): dir_i %ld, mode 0x%x\n", dir_i->i_ino, mode));
431 c = JFFS2_SB_INFO(sb);
433 inode = new_inode(sb);
436 return ERR_PTR(-ENOMEM);
438 f = JFFS2_INODE_INFO(inode);
439 jffs2_init_inode_info(f);
442 memset(ri, 0, sizeof(*ri));
443 /* Set OS-specific defaults for new inodes */
444 ri->uid = cpu_to_je16(current->fsuid);
446 if (dir_i->i_mode & S_ISGID) {
447 ri->gid = cpu_to_je16(dir_i->i_gid);
451 ri->gid = cpu_to_je16(current->fsgid);
454 /* POSIX ACLs have to be processed now, at least partly.
455 The umask is only applied if there's no default ACL */
456 ret = jffs2_init_acl_pre(dir_i, inode, &mode);
458 make_bad_inode(inode);
462 ret = jffs2_do_new_inode (c, f, mode, ri);
464 make_bad_inode(inode);
469 inode->i_ino = je32_to_cpu(ri->ino);
470 inode->i_mode = jemode_to_cpu(ri->mode);
471 inode->i_gid = je16_to_cpu(ri->gid);
472 inode->i_uid = je16_to_cpu(ri->uid);
473 inode->i_atime = inode->i_ctime = inode->i_mtime = CURRENT_TIME_SEC;
474 ri->atime = ri->mtime = ri->ctime = cpu_to_je32(I_SEC(inode->i_mtime));
479 insert_inode_hash(inode);
485 int jffs2_do_fill_super(struct super_block *sb, void *data, int silent)
487 struct jffs2_sb_info *c;
488 struct inode *root_i;
492 c = JFFS2_SB_INFO(sb);
494 #ifndef CONFIG_JFFS2_FS_WRITEBUFFER
495 if (c->mtd->type == MTD_NANDFLASH) {
496 printk(KERN_ERR "jffs2: Cannot operate on NAND flash unless jffs2 NAND support is compiled in.\n");
499 if (c->mtd->type == MTD_DATAFLASH) {
500 printk(KERN_ERR "jffs2: Cannot operate on DataFlash unless jffs2 DataFlash support is compiled in.\n");
505 c->flash_size = c->mtd->size;
506 c->sector_size = c->mtd->erasesize;
507 blocks = c->flash_size / c->sector_size;
510 * Size alignment check
512 if ((c->sector_size * blocks) != c->flash_size) {
513 c->flash_size = c->sector_size * blocks;
514 printk(KERN_INFO "jffs2: Flash size not aligned to erasesize, reducing to %dKiB\n",
515 c->flash_size / 1024);
518 if (c->flash_size < 5*c->sector_size) {
519 printk(KERN_ERR "jffs2: Too few erase blocks (%d)\n", c->flash_size / c->sector_size);
523 c->cleanmarker_size = sizeof(struct jffs2_unknown_node);
525 /* NAND (or other bizarre) flash... do setup accordingly */
526 ret = jffs2_flash_setup(c);
530 c->inocache_list = kcalloc(INOCACHE_HASHSIZE, sizeof(struct jffs2_inode_cache *), GFP_KERNEL);
531 if (!c->inocache_list) {
536 jffs2_init_xattr_subsystem(c);
538 if ((ret = jffs2_do_mount_fs(c)))
541 D1(printk(KERN_DEBUG "jffs2_do_fill_super(): Getting root inode\n"));
542 root_i = jffs2_iget(sb, 1);
543 if (IS_ERR(root_i)) {
544 D1(printk(KERN_WARNING "get root inode failed\n"));
545 ret = PTR_ERR(root_i);
551 D1(printk(KERN_DEBUG "jffs2_do_fill_super(): d_alloc_root()\n"));
552 sb->s_root = d_alloc_root(root_i);
556 sb->s_maxbytes = 0xFFFFFFFF;
557 sb->s_blocksize = PAGE_CACHE_SIZE;
558 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
559 sb->s_magic = JFFS2_SUPER_MAGIC;
560 if (!(sb->s_flags & MS_RDONLY))
561 jffs2_start_garbage_collect_thread(c);
567 jffs2_free_ino_caches(c);
568 jffs2_free_raw_node_refs(c);
569 if (jffs2_blocks_use_vmalloc(c))
574 jffs2_clear_xattr_subsystem(c);
575 kfree(c->inocache_list);
577 jffs2_flash_cleanup(c);
582 void jffs2_gc_release_inode(struct jffs2_sb_info *c,
583 struct jffs2_inode_info *f)
585 iput(OFNI_EDONI_2SFFJ(f));
588 struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
589 int inum, int unlinked)
592 struct jffs2_inode_cache *ic;
595 /* The inode has zero nlink but its nodes weren't yet marked
596 obsolete. This has to be because we're still waiting for
597 the final (close() and) iput() to happen.
599 There's a possibility that the final iput() could have
600 happened while we were contemplating. In order to ensure
601 that we don't cause a new read_inode() (which would fail)
602 for the inode in question, we use ilookup() in this case
605 The nlink can't _become_ zero at this point because we're
606 holding the alloc_sem, and jffs2_do_unlink() would also
607 need that while decrementing nlink on any inode.
609 inode = ilookup(OFNI_BS_2SFFJ(c), inum);
611 D1(printk(KERN_DEBUG "ilookup() failed for ino #%u; inode is probably deleted.\n",
614 spin_lock(&c->inocache_lock);
615 ic = jffs2_get_ino_cache(c, inum);
617 D1(printk(KERN_DEBUG "Inode cache for ino #%u is gone.\n", inum));
618 spin_unlock(&c->inocache_lock);
621 if (ic->state != INO_STATE_CHECKEDABSENT) {
622 /* Wait for progress. Don't just loop */
623 D1(printk(KERN_DEBUG "Waiting for ino #%u in state %d\n",
624 ic->ino, ic->state));
625 sleep_on_spinunlock(&c->inocache_wq, &c->inocache_lock);
627 spin_unlock(&c->inocache_lock);
633 /* Inode has links to it still; they're not going away because
634 jffs2_do_unlink() would need the alloc_sem and we have it.
635 Just iget() it, and if read_inode() is necessary that's OK.
637 inode = jffs2_iget(OFNI_BS_2SFFJ(c), inum);
639 return ERR_CAST(inode);
641 if (is_bad_inode(inode)) {
642 printk(KERN_NOTICE "Eep. read_inode() failed for ino #%u. unlinked %d\n",
644 /* NB. This will happen again. We need to do something appropriate here. */
646 return ERR_PTR(-EIO);
649 return JFFS2_INODE_INFO(inode);
652 unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
653 struct jffs2_inode_info *f,
654 unsigned long offset,
657 struct inode *inode = OFNI_EDONI_2SFFJ(f);
660 pg = read_cache_page_async(inode->i_mapping, offset >> PAGE_CACHE_SHIFT,
661 (void *)jffs2_do_readpage_unlock, inode);
665 *priv = (unsigned long)pg;
669 void jffs2_gc_release_page(struct jffs2_sb_info *c,
673 struct page *pg = (void *)*priv;
676 page_cache_release(pg);
679 static int jffs2_flash_setup(struct jffs2_sb_info *c) {
682 if (jffs2_cleanmarker_oob(c)) {
683 /* NAND flash... do setup accordingly */
684 ret = jffs2_nand_flash_setup(c);
690 if (jffs2_dataflash(c)) {
691 ret = jffs2_dataflash_setup(c);
696 /* and Intel "Sibley" flash */
697 if (jffs2_nor_wbuf_flash(c)) {
698 ret = jffs2_nor_wbuf_flash_setup(c);
703 /* and an UBI volume */
704 if (jffs2_ubivol(c)) {
705 ret = jffs2_ubivol_setup(c);
713 void jffs2_flash_cleanup(struct jffs2_sb_info *c) {
715 if (jffs2_cleanmarker_oob(c)) {
716 jffs2_nand_flash_cleanup(c);
720 if (jffs2_dataflash(c)) {
721 jffs2_dataflash_cleanup(c);
724 /* and Intel "Sibley" flash */
725 if (jffs2_nor_wbuf_flash(c)) {
726 jffs2_nor_wbuf_flash_cleanup(c);
729 /* and an UBI volume */
730 if (jffs2_ubivol(c)) {
731 jffs2_ubivol_cleanup(c);