2 * JFFS2 -- Journalling Flash File System, Version 2.
4 * Copyright © 2001-2007 Red Hat, Inc.
5 * Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
7 * Created by David Woodhouse <dwmw2@infradead.org>
9 * For licensing information, see the file 'LICENCE' in this directory.
13 #include <linux/capability.h>
14 #include <linux/kernel.h>
15 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/mtd/mtd.h>
19 #include <linux/pagemap.h>
20 #include <linux/slab.h>
21 #include <linux/vmalloc.h>
22 #include <linux/vfs.h>
23 #include <linux/crc32.h>
24 #include <linux/smp_lock.h>
27 static int jffs2_flash_setup(struct jffs2_sb_info *c);
29 int jffs2_do_setattr (struct inode *inode, struct iattr *iattr)
31 struct jffs2_full_dnode *old_metadata, *new_metadata;
32 struct jffs2_inode_info *f = JFFS2_INODE_INFO(inode);
33 struct jffs2_sb_info *c = JFFS2_SB_INFO(inode->i_sb);
34 struct jffs2_raw_inode *ri;
35 union jffs2_device_node dev;
36 unsigned char *mdata = NULL;
41 int alloc_type = ALLOC_NORMAL;
43 D1(printk(KERN_DEBUG "jffs2_setattr(): ino #%lu\n", inode->i_ino));
45 /* Special cases - we don't want more than one data node
46 for these types on the medium at any time. So setattr
47 must read the original data associated with the node
48 (i.e. the device numbers or the target name) and write
49 it out again with the appropriate data attached */
50 if (S_ISBLK(inode->i_mode) || S_ISCHR(inode->i_mode)) {
51 /* For these, we don't actually need to read the old node */
52 mdatalen = jffs2_encode_dev(&dev, inode->i_rdev);
54 D1(printk(KERN_DEBUG "jffs2_setattr(): Writing %d bytes of kdev_t\n", mdatalen));
55 } else if (S_ISLNK(inode->i_mode)) {
57 mdatalen = f->metadata->size;
58 mdata = kmalloc(f->metadata->size, GFP_USER);
60 mutex_unlock(&f->sem);
63 ret = jffs2_read_dnode(c, f, f->metadata, mdata, 0, mdatalen);
65 mutex_unlock(&f->sem);
69 mutex_unlock(&f->sem);
70 D1(printk(KERN_DEBUG "jffs2_setattr(): Writing %d bytes of symlink target\n", mdatalen));
73 ri = jffs2_alloc_raw_inode();
75 if (S_ISLNK(inode->i_mode))
80 ret = jffs2_reserve_space(c, sizeof(*ri) + mdatalen, &alloclen,
81 ALLOC_NORMAL, JFFS2_SUMMARY_INODE_SIZE);
83 jffs2_free_raw_inode(ri);
84 if (S_ISLNK(inode->i_mode & S_IFMT))
89 ivalid = iattr->ia_valid;
91 ri->magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
92 ri->nodetype = cpu_to_je16(JFFS2_NODETYPE_INODE);
93 ri->totlen = cpu_to_je32(sizeof(*ri) + mdatalen);
94 ri->hdr_crc = cpu_to_je32(crc32(0, ri, sizeof(struct jffs2_unknown_node)-4));
96 ri->ino = cpu_to_je32(inode->i_ino);
97 ri->version = cpu_to_je32(++f->highest_version);
99 ri->uid = cpu_to_je16((ivalid & ATTR_UID)?iattr->ia_uid:inode->i_uid);
100 ri->gid = cpu_to_je16((ivalid & ATTR_GID)?iattr->ia_gid:inode->i_gid);
102 if (ivalid & ATTR_MODE)
103 ri->mode = cpu_to_jemode(iattr->ia_mode);
105 ri->mode = cpu_to_jemode(inode->i_mode);
108 ri->isize = cpu_to_je32((ivalid & ATTR_SIZE)?iattr->ia_size:inode->i_size);
109 ri->atime = cpu_to_je32(I_SEC((ivalid & ATTR_ATIME)?iattr->ia_atime:inode->i_atime));
110 ri->mtime = cpu_to_je32(I_SEC((ivalid & ATTR_MTIME)?iattr->ia_mtime:inode->i_mtime));
111 ri->ctime = cpu_to_je32(I_SEC((ivalid & ATTR_CTIME)?iattr->ia_ctime:inode->i_ctime));
113 ri->offset = cpu_to_je32(0);
114 ri->csize = ri->dsize = cpu_to_je32(mdatalen);
115 ri->compr = JFFS2_COMPR_NONE;
116 if (ivalid & ATTR_SIZE && inode->i_size < iattr->ia_size) {
117 /* It's an extension. Make it a hole node */
118 ri->compr = JFFS2_COMPR_ZERO;
119 ri->dsize = cpu_to_je32(iattr->ia_size - inode->i_size);
120 ri->offset = cpu_to_je32(inode->i_size);
121 } else if (ivalid & ATTR_SIZE && !iattr->ia_size) {
122 /* For truncate-to-zero, treat it as deletion because
123 it'll always be obsoleting all previous nodes */
124 alloc_type = ALLOC_DELETION;
126 ri->node_crc = cpu_to_je32(crc32(0, ri, sizeof(*ri)-8));
128 ri->data_crc = cpu_to_je32(crc32(0, mdata, mdatalen));
130 ri->data_crc = cpu_to_je32(0);
132 new_metadata = jffs2_write_dnode(c, f, ri, mdata, mdatalen, alloc_type);
133 if (S_ISLNK(inode->i_mode))
136 if (IS_ERR(new_metadata)) {
137 jffs2_complete_reservation(c);
138 jffs2_free_raw_inode(ri);
139 mutex_unlock(&f->sem);
140 return PTR_ERR(new_metadata);
142 /* It worked. Update the inode */
143 inode->i_atime = ITIME(je32_to_cpu(ri->atime));
144 inode->i_ctime = ITIME(je32_to_cpu(ri->ctime));
145 inode->i_mtime = ITIME(je32_to_cpu(ri->mtime));
146 inode->i_mode = jemode_to_cpu(ri->mode);
147 inode->i_uid = je16_to_cpu(ri->uid);
148 inode->i_gid = je16_to_cpu(ri->gid);
151 old_metadata = f->metadata;
153 if (ivalid & ATTR_SIZE && inode->i_size > iattr->ia_size)
154 jffs2_truncate_fragtree (c, &f->fragtree, iattr->ia_size);
156 if (ivalid & ATTR_SIZE && inode->i_size < iattr->ia_size) {
157 jffs2_add_full_dnode_to_inode(c, f, new_metadata);
158 inode->i_size = iattr->ia_size;
159 inode->i_blocks = (inode->i_size + 511) >> 9;
162 f->metadata = new_metadata;
165 jffs2_mark_node_obsolete(c, old_metadata->raw);
166 jffs2_free_full_dnode(old_metadata);
168 jffs2_free_raw_inode(ri);
170 mutex_unlock(&f->sem);
171 jffs2_complete_reservation(c);
173 /* We have to do the vmtruncate() without f->sem held, since
174 some pages may be locked and waiting for it in readpage().
175 We are protected from a simultaneous write() extending i_size
176 back past iattr->ia_size, because do_truncate() holds the
177 generic inode semaphore. */
178 if (ivalid & ATTR_SIZE && inode->i_size > iattr->ia_size) {
179 vmtruncate(inode, iattr->ia_size);
180 inode->i_blocks = (inode->i_size + 511) >> 9;
186 int jffs2_setattr(struct dentry *dentry, struct iattr *iattr)
190 rc = inode_change_ok(dentry->d_inode, iattr);
194 rc = jffs2_do_setattr(dentry->d_inode, iattr);
195 if (!rc && (iattr->ia_valid & ATTR_MODE))
196 rc = jffs2_acl_chmod(dentry->d_inode);
201 int jffs2_statfs(struct dentry *dentry, struct kstatfs *buf)
203 struct jffs2_sb_info *c = JFFS2_SB_INFO(dentry->d_sb);
206 buf->f_type = JFFS2_SUPER_MAGIC;
207 buf->f_bsize = 1 << PAGE_SHIFT;
208 buf->f_blocks = c->flash_size >> PAGE_SHIFT;
211 buf->f_namelen = JFFS2_MAX_NAME_LEN;
212 buf->f_fsid.val[0] = JFFS2_SUPER_MAGIC;
213 buf->f_fsid.val[1] = c->mtd->index;
215 spin_lock(&c->erase_completion_lock);
216 avail = c->dirty_size + c->free_size;
217 if (avail > c->sector_size * c->resv_blocks_write)
218 avail -= c->sector_size * c->resv_blocks_write;
221 spin_unlock(&c->erase_completion_lock);
223 buf->f_bavail = buf->f_bfree = avail >> PAGE_SHIFT;
229 void jffs2_clear_inode (struct inode *inode)
231 /* We can forget about this inode for now - drop all
232 * the nodelists associated with it, etc.
234 struct jffs2_sb_info *c = JFFS2_SB_INFO(inode->i_sb);
235 struct jffs2_inode_info *f = JFFS2_INODE_INFO(inode);
237 D1(printk(KERN_DEBUG "jffs2_clear_inode(): ino #%lu mode %o\n", inode->i_ino, inode->i_mode));
238 jffs2_do_clear_inode(c, f);
241 struct inode *jffs2_iget(struct super_block *sb, unsigned long ino)
243 struct jffs2_inode_info *f;
244 struct jffs2_sb_info *c;
245 struct jffs2_raw_inode latest_node;
246 union jffs2_device_node jdev;
251 D1(printk(KERN_DEBUG "jffs2_iget(): ino == %lu\n", ino));
253 inode = iget_locked(sb, ino);
255 return ERR_PTR(-ENOMEM);
256 if (!(inode->i_state & I_NEW))
259 f = JFFS2_INODE_INFO(inode);
260 c = JFFS2_SB_INFO(inode->i_sb);
262 jffs2_init_inode_info(f);
265 ret = jffs2_do_read_inode(c, f, inode->i_ino, &latest_node);
268 mutex_unlock(&f->sem);
272 inode->i_mode = jemode_to_cpu(latest_node.mode);
273 inode->i_uid = je16_to_cpu(latest_node.uid);
274 inode->i_gid = je16_to_cpu(latest_node.gid);
275 inode->i_size = je32_to_cpu(latest_node.isize);
276 inode->i_atime = ITIME(je32_to_cpu(latest_node.atime));
277 inode->i_mtime = ITIME(je32_to_cpu(latest_node.mtime));
278 inode->i_ctime = ITIME(je32_to_cpu(latest_node.ctime));
280 inode->i_nlink = f->inocache->pino_nlink;
282 inode->i_blocks = (inode->i_size + 511) >> 9;
284 switch (inode->i_mode & S_IFMT) {
287 inode->i_op = &jffs2_symlink_inode_operations;
292 struct jffs2_full_dirent *fd;
293 inode->i_nlink = 2; /* parent and '.' */
295 for (fd=f->dents; fd; fd = fd->next) {
296 if (fd->type == DT_DIR && fd->ino)
299 /* Root dir gets i_nlink 3 for some reason */
300 if (inode->i_ino == 1)
303 inode->i_op = &jffs2_dir_inode_operations;
304 inode->i_fop = &jffs2_dir_operations;
308 inode->i_op = &jffs2_file_inode_operations;
309 inode->i_fop = &jffs2_file_operations;
310 inode->i_mapping->a_ops = &jffs2_file_address_operations;
311 inode->i_mapping->nrpages = 0;
316 /* Read the device numbers from the media */
317 if (f->metadata->size != sizeof(jdev.old_id) &&
318 f->metadata->size != sizeof(jdev.new_id)) {
319 printk(KERN_NOTICE "Device node has strange size %d\n", f->metadata->size);
322 D1(printk(KERN_DEBUG "Reading device numbers from flash\n"));
323 ret = jffs2_read_dnode(c, f, f->metadata, (char *)&jdev, 0, f->metadata->size);
326 printk(KERN_NOTICE "Read device numbers for inode %lu failed\n", (unsigned long)inode->i_ino);
329 if (f->metadata->size == sizeof(jdev.old_id))
330 rdev = old_decode_dev(je16_to_cpu(jdev.old_id));
332 rdev = new_decode_dev(je32_to_cpu(jdev.new_id));
336 inode->i_op = &jffs2_file_inode_operations;
337 init_special_inode(inode, inode->i_mode, rdev);
341 printk(KERN_WARNING "jffs2_read_inode(): Bogus imode %o for ino %lu\n", inode->i_mode, (unsigned long)inode->i_ino);
344 mutex_unlock(&f->sem);
346 D1(printk(KERN_DEBUG "jffs2_read_inode() returning\n"));
347 unlock_new_inode(inode);
353 mutex_unlock(&f->sem);
354 jffs2_do_clear_inode(c, f);
359 void jffs2_dirty_inode(struct inode *inode)
363 if (!(inode->i_state & I_DIRTY_DATASYNC)) {
364 D2(printk(KERN_DEBUG "jffs2_dirty_inode() not calling setattr() for ino #%lu\n", inode->i_ino));
368 D1(printk(KERN_DEBUG "jffs2_dirty_inode() calling setattr() for ino #%lu\n", inode->i_ino));
370 iattr.ia_valid = ATTR_MODE|ATTR_UID|ATTR_GID|ATTR_ATIME|ATTR_MTIME|ATTR_CTIME;
371 iattr.ia_mode = inode->i_mode;
372 iattr.ia_uid = inode->i_uid;
373 iattr.ia_gid = inode->i_gid;
374 iattr.ia_atime = inode->i_atime;
375 iattr.ia_mtime = inode->i_mtime;
376 iattr.ia_ctime = inode->i_ctime;
378 jffs2_do_setattr(inode, &iattr);
381 int jffs2_remount_fs (struct super_block *sb, int *flags, char *data)
383 struct jffs2_sb_info *c = JFFS2_SB_INFO(sb);
385 if (c->flags & JFFS2_SB_FLAG_RO && !(sb->s_flags & MS_RDONLY))
388 /* We stop if it was running, then restart if it needs to.
389 This also catches the case where it was stopped and this
390 is just a remount to restart it.
391 Flush the writebuffer, if neccecary, else we loose it */
393 if (!(sb->s_flags & MS_RDONLY)) {
394 jffs2_stop_garbage_collect_thread(c);
395 mutex_lock(&c->alloc_sem);
396 jffs2_flush_wbuf_pad(c);
397 mutex_unlock(&c->alloc_sem);
400 if (!(*flags & MS_RDONLY))
401 jffs2_start_garbage_collect_thread(c);
403 *flags |= MS_NOATIME;
409 /* jffs2_new_inode: allocate a new inode and inocache, add it to the hash,
410 fill in the raw_inode while you're at it. */
411 struct inode *jffs2_new_inode (struct inode *dir_i, int mode, struct jffs2_raw_inode *ri)
414 struct super_block *sb = dir_i->i_sb;
415 struct jffs2_sb_info *c;
416 struct jffs2_inode_info *f;
419 D1(printk(KERN_DEBUG "jffs2_new_inode(): dir_i %ld, mode 0x%x\n", dir_i->i_ino, mode));
421 c = JFFS2_SB_INFO(sb);
423 inode = new_inode(sb);
426 return ERR_PTR(-ENOMEM);
428 f = JFFS2_INODE_INFO(inode);
429 jffs2_init_inode_info(f);
432 memset(ri, 0, sizeof(*ri));
433 /* Set OS-specific defaults for new inodes */
434 ri->uid = cpu_to_je16(current_fsuid());
436 if (dir_i->i_mode & S_ISGID) {
437 ri->gid = cpu_to_je16(dir_i->i_gid);
441 ri->gid = cpu_to_je16(current_fsgid());
444 /* POSIX ACLs have to be processed now, at least partly.
445 The umask is only applied if there's no default ACL */
446 ret = jffs2_init_acl_pre(dir_i, inode, &mode);
448 make_bad_inode(inode);
452 ret = jffs2_do_new_inode (c, f, mode, ri);
454 make_bad_inode(inode);
459 inode->i_ino = je32_to_cpu(ri->ino);
460 inode->i_mode = jemode_to_cpu(ri->mode);
461 inode->i_gid = je16_to_cpu(ri->gid);
462 inode->i_uid = je16_to_cpu(ri->uid);
463 inode->i_atime = inode->i_ctime = inode->i_mtime = CURRENT_TIME_SEC;
464 ri->atime = ri->mtime = ri->ctime = cpu_to_je32(I_SEC(inode->i_mtime));
469 if (insert_inode_locked(inode) < 0) {
470 make_bad_inode(inode);
471 unlock_new_inode(inode);
473 return ERR_PTR(-EINVAL);
480 int jffs2_do_fill_super(struct super_block *sb, void *data, int silent)
482 struct jffs2_sb_info *c;
483 struct inode *root_i;
487 c = JFFS2_SB_INFO(sb);
489 #ifndef CONFIG_JFFS2_FS_WRITEBUFFER
490 if (c->mtd->type == MTD_NANDFLASH) {
491 printk(KERN_ERR "jffs2: Cannot operate on NAND flash unless jffs2 NAND support is compiled in.\n");
494 if (c->mtd->type == MTD_DATAFLASH) {
495 printk(KERN_ERR "jffs2: Cannot operate on DataFlash unless jffs2 DataFlash support is compiled in.\n");
500 c->flash_size = c->mtd->size;
501 c->sector_size = c->mtd->erasesize;
502 blocks = c->flash_size / c->sector_size;
505 * Size alignment check
507 if ((c->sector_size * blocks) != c->flash_size) {
508 c->flash_size = c->sector_size * blocks;
509 printk(KERN_INFO "jffs2: Flash size not aligned to erasesize, reducing to %dKiB\n",
510 c->flash_size / 1024);
513 if (c->flash_size < 5*c->sector_size) {
514 printk(KERN_ERR "jffs2: Too few erase blocks (%d)\n", c->flash_size / c->sector_size);
518 c->cleanmarker_size = sizeof(struct jffs2_unknown_node);
520 /* NAND (or other bizarre) flash... do setup accordingly */
521 ret = jffs2_flash_setup(c);
525 c->inocache_list = kcalloc(INOCACHE_HASHSIZE, sizeof(struct jffs2_inode_cache *), GFP_KERNEL);
526 if (!c->inocache_list) {
531 jffs2_init_xattr_subsystem(c);
533 if ((ret = jffs2_do_mount_fs(c)))
536 D1(printk(KERN_DEBUG "jffs2_do_fill_super(): Getting root inode\n"));
537 root_i = jffs2_iget(sb, 1);
538 if (IS_ERR(root_i)) {
539 D1(printk(KERN_WARNING "get root inode failed\n"));
540 ret = PTR_ERR(root_i);
546 D1(printk(KERN_DEBUG "jffs2_do_fill_super(): d_alloc_root()\n"));
547 sb->s_root = d_alloc_root(root_i);
551 sb->s_maxbytes = 0xFFFFFFFF;
552 sb->s_blocksize = PAGE_CACHE_SIZE;
553 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
554 sb->s_magic = JFFS2_SUPER_MAGIC;
555 if (!(sb->s_flags & MS_RDONLY))
556 jffs2_start_garbage_collect_thread(c);
562 jffs2_free_ino_caches(c);
563 jffs2_free_raw_node_refs(c);
564 if (jffs2_blocks_use_vmalloc(c))
569 jffs2_clear_xattr_subsystem(c);
570 kfree(c->inocache_list);
572 jffs2_flash_cleanup(c);
577 void jffs2_gc_release_inode(struct jffs2_sb_info *c,
578 struct jffs2_inode_info *f)
580 iput(OFNI_EDONI_2SFFJ(f));
583 struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
584 int inum, int unlinked)
587 struct jffs2_inode_cache *ic;
590 /* The inode has zero nlink but its nodes weren't yet marked
591 obsolete. This has to be because we're still waiting for
592 the final (close() and) iput() to happen.
594 There's a possibility that the final iput() could have
595 happened while we were contemplating. In order to ensure
596 that we don't cause a new read_inode() (which would fail)
597 for the inode in question, we use ilookup() in this case
600 The nlink can't _become_ zero at this point because we're
601 holding the alloc_sem, and jffs2_do_unlink() would also
602 need that while decrementing nlink on any inode.
604 inode = ilookup(OFNI_BS_2SFFJ(c), inum);
606 D1(printk(KERN_DEBUG "ilookup() failed for ino #%u; inode is probably deleted.\n",
609 spin_lock(&c->inocache_lock);
610 ic = jffs2_get_ino_cache(c, inum);
612 D1(printk(KERN_DEBUG "Inode cache for ino #%u is gone.\n", inum));
613 spin_unlock(&c->inocache_lock);
616 if (ic->state != INO_STATE_CHECKEDABSENT) {
617 /* Wait for progress. Don't just loop */
618 D1(printk(KERN_DEBUG "Waiting for ino #%u in state %d\n",
619 ic->ino, ic->state));
620 sleep_on_spinunlock(&c->inocache_wq, &c->inocache_lock);
622 spin_unlock(&c->inocache_lock);
628 /* Inode has links to it still; they're not going away because
629 jffs2_do_unlink() would need the alloc_sem and we have it.
630 Just iget() it, and if read_inode() is necessary that's OK.
632 inode = jffs2_iget(OFNI_BS_2SFFJ(c), inum);
634 return ERR_CAST(inode);
636 if (is_bad_inode(inode)) {
637 printk(KERN_NOTICE "Eep. read_inode() failed for ino #%u. unlinked %d\n",
639 /* NB. This will happen again. We need to do something appropriate here. */
641 return ERR_PTR(-EIO);
644 return JFFS2_INODE_INFO(inode);
647 unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
648 struct jffs2_inode_info *f,
649 unsigned long offset,
652 struct inode *inode = OFNI_EDONI_2SFFJ(f);
655 pg = read_cache_page_async(inode->i_mapping, offset >> PAGE_CACHE_SHIFT,
656 (void *)jffs2_do_readpage_unlock, inode);
660 *priv = (unsigned long)pg;
664 void jffs2_gc_release_page(struct jffs2_sb_info *c,
668 struct page *pg = (void *)*priv;
671 page_cache_release(pg);
674 static int jffs2_flash_setup(struct jffs2_sb_info *c) {
677 if (jffs2_cleanmarker_oob(c)) {
678 /* NAND flash... do setup accordingly */
679 ret = jffs2_nand_flash_setup(c);
685 if (jffs2_dataflash(c)) {
686 ret = jffs2_dataflash_setup(c);
691 /* and Intel "Sibley" flash */
692 if (jffs2_nor_wbuf_flash(c)) {
693 ret = jffs2_nor_wbuf_flash_setup(c);
698 /* and an UBI volume */
699 if (jffs2_ubivol(c)) {
700 ret = jffs2_ubivol_setup(c);
708 void jffs2_flash_cleanup(struct jffs2_sb_info *c) {
710 if (jffs2_cleanmarker_oob(c)) {
711 jffs2_nand_flash_cleanup(c);
715 if (jffs2_dataflash(c)) {
716 jffs2_dataflash_cleanup(c);
719 /* and Intel "Sibley" flash */
720 if (jffs2_nor_wbuf_flash(c)) {
721 jffs2_nor_wbuf_flash_cleanup(c);
724 /* and an UBI volume */
725 if (jffs2_ubivol(c)) {
726 jffs2_ubivol_cleanup(c);