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/kernel.h>
13 #include <linux/slab.h>
14 #include <linux/mtd/mtd.h>
15 #include <linux/compiler.h>
16 #include <linux/crc32.h>
17 #include <linux/sched.h>
18 #include <linux/pagemap.h>
21 struct erase_priv_struct {
22 struct jffs2_eraseblock *jeb;
23 struct jffs2_sb_info *c;
27 static void jffs2_erase_callback(struct erase_info *);
29 static void jffs2_erase_failed(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
30 static void jffs2_erase_succeeded(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
31 static void jffs2_mark_erased_block(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
33 static void jffs2_erase_block(struct jffs2_sb_info *c,
34 struct jffs2_eraseblock *jeb)
39 ret = jffs2_flash_erase(c, jeb);
41 jffs2_erase_succeeded(c, jeb);
44 bad_offset = jeb->offset;
46 struct erase_info *instr;
48 D1(printk(KERN_DEBUG "jffs2_erase_block(): erase block %#08x (range %#08x-%#08x)\n",
49 jeb->offset, jeb->offset, jeb->offset + c->sector_size));
50 instr = kmalloc(sizeof(struct erase_info) + sizeof(struct erase_priv_struct), GFP_KERNEL);
52 printk(KERN_WARNING "kmalloc for struct erase_info in jffs2_erase_block failed. Refiling block for later\n");
53 mutex_lock(&c->erase_free_sem);
54 spin_lock(&c->erase_completion_lock);
55 list_move(&jeb->list, &c->erase_pending_list);
56 c->erasing_size -= c->sector_size;
57 c->dirty_size += c->sector_size;
58 jeb->dirty_size = c->sector_size;
59 spin_unlock(&c->erase_completion_lock);
60 mutex_unlock(&c->erase_free_sem);
64 memset(instr, 0, sizeof(*instr));
67 instr->addr = jeb->offset;
68 instr->len = c->sector_size;
69 instr->callback = jffs2_erase_callback;
70 instr->priv = (unsigned long)(&instr[1]);
71 instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
73 ((struct erase_priv_struct *)instr->priv)->jeb = jeb;
74 ((struct erase_priv_struct *)instr->priv)->c = c;
76 ret = c->mtd->erase(c->mtd, instr);
80 bad_offset = instr->fail_addr;
84 if (ret == -ENOMEM || ret == -EAGAIN) {
85 /* Erase failed immediately. Refile it on the list */
86 D1(printk(KERN_DEBUG "Erase at 0x%08x failed: %d. Refiling on erase_pending_list\n", jeb->offset, ret));
87 mutex_lock(&c->erase_free_sem);
88 spin_lock(&c->erase_completion_lock);
89 list_move(&jeb->list, &c->erase_pending_list);
90 c->erasing_size -= c->sector_size;
91 c->dirty_size += c->sector_size;
92 jeb->dirty_size = c->sector_size;
93 spin_unlock(&c->erase_completion_lock);
94 mutex_unlock(&c->erase_free_sem);
99 printk(KERN_WARNING "Erase at 0x%08x failed immediately: -EROFS. Is the sector locked?\n", jeb->offset);
101 printk(KERN_WARNING "Erase at 0x%08x failed immediately: errno %d\n", jeb->offset, ret);
103 jffs2_erase_failed(c, jeb, bad_offset);
106 int jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count)
108 struct jffs2_eraseblock *jeb;
111 mutex_lock(&c->erase_free_sem);
113 spin_lock(&c->erase_completion_lock);
115 while (!list_empty(&c->erase_complete_list) ||
116 !list_empty(&c->erase_pending_list)) {
118 if (!list_empty(&c->erase_complete_list)) {
119 jeb = list_entry(c->erase_complete_list.next, struct jffs2_eraseblock, list);
120 list_move(&jeb->list, &c->erase_checking_list);
121 spin_unlock(&c->erase_completion_lock);
122 mutex_unlock(&c->erase_free_sem);
123 jffs2_mark_erased_block(c, jeb);
127 D1(printk(KERN_DEBUG "Count reached. jffs2_erase_pending_blocks leaving\n"));
131 } else if (!list_empty(&c->erase_pending_list)) {
132 jeb = list_entry(c->erase_pending_list.next, struct jffs2_eraseblock, list);
133 D1(printk(KERN_DEBUG "Starting erase of pending block 0x%08x\n", jeb->offset));
134 list_del(&jeb->list);
135 c->erasing_size += c->sector_size;
136 c->wasted_size -= jeb->wasted_size;
137 c->free_size -= jeb->free_size;
138 c->used_size -= jeb->used_size;
139 c->dirty_size -= jeb->dirty_size;
140 jeb->wasted_size = jeb->used_size = jeb->dirty_size = jeb->free_size = 0;
141 jffs2_free_jeb_node_refs(c, jeb);
142 list_add(&jeb->list, &c->erasing_list);
143 spin_unlock(&c->erase_completion_lock);
144 mutex_unlock(&c->erase_free_sem);
146 jffs2_erase_block(c, jeb);
154 mutex_lock(&c->erase_free_sem);
155 spin_lock(&c->erase_completion_lock);
158 spin_unlock(&c->erase_completion_lock);
159 mutex_unlock(&c->erase_free_sem);
161 D1(printk(KERN_DEBUG "jffs2_erase_pending_blocks completed\n"));
165 static void jffs2_erase_succeeded(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb)
167 D1(printk(KERN_DEBUG "Erase completed successfully at 0x%08x\n", jeb->offset));
168 mutex_lock(&c->erase_free_sem);
169 spin_lock(&c->erase_completion_lock);
170 list_move_tail(&jeb->list, &c->erase_complete_list);
171 spin_unlock(&c->erase_completion_lock);
172 mutex_unlock(&c->erase_free_sem);
173 /* Ensure that kupdated calls us again to mark them clean */
174 jffs2_erase_pending_trigger(c);
177 static void jffs2_erase_failed(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset)
179 /* For NAND, if the failure did not occur at the device level for a
180 specific physical page, don't bother updating the bad block table. */
181 if (jffs2_cleanmarker_oob(c) && (bad_offset != (uint32_t)MTD_FAIL_ADDR_UNKNOWN)) {
182 /* We had a device-level failure to erase. Let's see if we've
183 failed too many times. */
184 if (!jffs2_write_nand_badblock(c, jeb, bad_offset)) {
185 /* We'd like to give this block another try. */
186 mutex_lock(&c->erase_free_sem);
187 spin_lock(&c->erase_completion_lock);
188 list_move(&jeb->list, &c->erase_pending_list);
189 c->erasing_size -= c->sector_size;
190 c->dirty_size += c->sector_size;
191 jeb->dirty_size = c->sector_size;
192 spin_unlock(&c->erase_completion_lock);
193 mutex_unlock(&c->erase_free_sem);
198 mutex_lock(&c->erase_free_sem);
199 spin_lock(&c->erase_completion_lock);
200 c->erasing_size -= c->sector_size;
201 c->bad_size += c->sector_size;
202 list_move(&jeb->list, &c->bad_list);
203 c->nr_erasing_blocks--;
204 spin_unlock(&c->erase_completion_lock);
205 mutex_unlock(&c->erase_free_sem);
206 wake_up(&c->erase_wait);
210 static void jffs2_erase_callback(struct erase_info *instr)
212 struct erase_priv_struct *priv = (void *)instr->priv;
214 if(instr->state != MTD_ERASE_DONE) {
215 printk(KERN_WARNING "Erase at 0x%08llx finished, but state != MTD_ERASE_DONE. State is 0x%x instead.\n",
216 (unsigned long long)instr->addr, instr->state);
217 jffs2_erase_failed(priv->c, priv->jeb, instr->fail_addr);
219 jffs2_erase_succeeded(priv->c, priv->jeb);
225 /* Hmmm. Maybe we should accept the extra space it takes and make
226 this a standard doubly-linked list? */
227 static inline void jffs2_remove_node_refs_from_ino_list(struct jffs2_sb_info *c,
228 struct jffs2_raw_node_ref *ref, struct jffs2_eraseblock *jeb)
230 struct jffs2_inode_cache *ic = NULL;
231 struct jffs2_raw_node_ref **prev;
233 prev = &ref->next_in_ino;
235 /* Walk the inode's list once, removing any nodes from this eraseblock */
237 if (!(*prev)->next_in_ino) {
238 /* We're looking at the jffs2_inode_cache, which is
239 at the end of the linked list. Stash it and continue
240 from the beginning of the list */
241 ic = (struct jffs2_inode_cache *)(*prev);
246 if (SECTOR_ADDR((*prev)->flash_offset) == jeb->offset) {
247 /* It's in the block we're erasing */
248 struct jffs2_raw_node_ref *this;
251 *prev = this->next_in_ino;
252 this->next_in_ino = NULL;
259 /* Not to be deleted. Skip */
260 prev = &((*prev)->next_in_ino);
265 JFFS2_WARNING("inode_cache/xattr_datum/xattr_ref"
266 " not found in remove_node_refs()!!\n");
270 D1(printk(KERN_DEBUG "Removed nodes in range 0x%08x-0x%08x from ino #%u\n",
271 jeb->offset, jeb->offset + c->sector_size, ic->ino));
275 struct jffs2_raw_node_ref *this;
276 printk(KERN_DEBUG "After remove_node_refs_from_ino_list: \n");
282 printk(KERN_CONT "0x%08x(%d)->",
283 ref_offset(this), ref_flags(this));
288 this = this->next_in_ino;
290 printk(KERN_CONT "\n");
294 #ifdef CONFIG_JFFS2_FS_XATTR
295 case RAWNODE_CLASS_XATTR_DATUM:
296 jffs2_release_xattr_datum(c, (struct jffs2_xattr_datum *)ic);
298 case RAWNODE_CLASS_XATTR_REF:
299 jffs2_release_xattr_ref(c, (struct jffs2_xattr_ref *)ic);
303 if (ic->nodes == (void *)ic && ic->pino_nlink == 0)
304 jffs2_del_ino_cache(c, ic);
308 void jffs2_free_jeb_node_refs(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb)
310 struct jffs2_raw_node_ref *block, *ref;
311 D1(printk(KERN_DEBUG "Freeing all node refs for eraseblock offset 0x%08x\n", jeb->offset));
313 block = ref = jeb->first_node;
316 if (ref->flash_offset == REF_LINK_NODE) {
317 ref = ref->next_in_ino;
318 jffs2_free_refblock(block);
322 if (ref->flash_offset != REF_EMPTY_NODE && ref->next_in_ino)
323 jffs2_remove_node_refs_from_ino_list(c, ref, jeb);
324 /* else it was a non-inode node or already removed, so don't bother */
328 jeb->first_node = jeb->last_node = NULL;
331 static int jffs2_block_check_erase(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t *bad_offset)
339 unsigned long *wordebuf;
341 ret = c->mtd->point(c->mtd, jeb->offset, c->sector_size,
342 &retlen, &ebuf, NULL);
344 D1(printk(KERN_DEBUG "MTD point failed %d\n", ret));
347 if (retlen < c->sector_size) {
348 /* Don't muck about if it won't let us point to the whole erase sector */
349 D1(printk(KERN_DEBUG "MTD point returned len too short: 0x%zx\n", retlen));
350 c->mtd->unpoint(c->mtd, jeb->offset, retlen);
353 wordebuf = ebuf-sizeof(*wordebuf);
354 retlen /= sizeof(*wordebuf);
356 if (*++wordebuf != ~0)
359 c->mtd->unpoint(c->mtd, jeb->offset, c->sector_size);
361 printk(KERN_WARNING "Newly-erased block contained word 0x%lx at offset 0x%08tx\n",
362 *wordebuf, jeb->offset + c->sector_size-retlen*sizeof(*wordebuf));
368 ebuf = kmalloc(PAGE_SIZE, GFP_KERNEL);
370 printk(KERN_WARNING "Failed to allocate page buffer for verifying erase at 0x%08x. Refiling\n", jeb->offset);
374 D1(printk(KERN_DEBUG "Verifying erase at 0x%08x\n", jeb->offset));
376 for (ofs = jeb->offset; ofs < jeb->offset + c->sector_size; ) {
377 uint32_t readlen = min((uint32_t)PAGE_SIZE, jeb->offset + c->sector_size - ofs);
382 ret = c->mtd->read(c->mtd, ofs, readlen, &retlen, ebuf);
384 printk(KERN_WARNING "Read of newly-erased block at 0x%08x failed: %d. Putting on bad_list\n", ofs, ret);
388 if (retlen != readlen) {
389 printk(KERN_WARNING "Short read from newly-erased block at 0x%08x. Wanted %d, got %zd\n", ofs, readlen, retlen);
393 for (i=0; i<readlen; i += sizeof(unsigned long)) {
394 /* It's OK. We know it's properly aligned */
395 unsigned long *datum = ebuf + i;
398 printk(KERN_WARNING "Newly-erased block contained word 0x%lx at offset 0x%08x\n", *datum, *bad_offset);
412 static void jffs2_mark_erased_block(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb)
416 uint32_t uninitialized_var(bad_offset);
418 switch (jffs2_block_check_erase(c, jeb, &bad_offset)) {
419 case -EAGAIN: goto refile;
420 case -EIO: goto filebad;
423 /* Write the erase complete marker */
424 D1(printk(KERN_DEBUG "Writing erased marker to block at 0x%08x\n", jeb->offset));
425 bad_offset = jeb->offset;
427 /* Cleanmarker in oob area or no cleanmarker at all ? */
428 if (jffs2_cleanmarker_oob(c) || c->cleanmarker_size == 0) {
430 if (jffs2_cleanmarker_oob(c)) {
431 if (jffs2_write_nand_cleanmarker(c, jeb))
437 struct jffs2_unknown_node marker = {
438 .magic = cpu_to_je16(JFFS2_MAGIC_BITMASK),
439 .nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER),
440 .totlen = cpu_to_je32(c->cleanmarker_size)
443 jffs2_prealloc_raw_node_refs(c, jeb, 1);
445 marker.hdr_crc = cpu_to_je32(crc32(0, &marker, sizeof(struct jffs2_unknown_node)-4));
447 vecs[0].iov_base = (unsigned char *) ▮
448 vecs[0].iov_len = sizeof(marker);
449 ret = jffs2_flash_direct_writev(c, vecs, 1, jeb->offset, &retlen);
451 if (ret || retlen != sizeof(marker)) {
453 printk(KERN_WARNING "Write clean marker to block at 0x%08x failed: %d\n",
456 printk(KERN_WARNING "Short write to newly-erased block at 0x%08x: Wanted %zd, got %zd\n",
457 jeb->offset, sizeof(marker), retlen);
462 /* Everything else got zeroed before the erase */
463 jeb->free_size = c->sector_size;
465 mutex_lock(&c->erase_free_sem);
466 spin_lock(&c->erase_completion_lock);
468 c->erasing_size -= c->sector_size;
469 c->free_size += c->sector_size;
471 /* Account for cleanmarker now, if it's in-band */
472 if (c->cleanmarker_size && !jffs2_cleanmarker_oob(c))
473 jffs2_link_node_ref(c, jeb, jeb->offset | REF_NORMAL, c->cleanmarker_size, NULL);
475 list_move_tail(&jeb->list, &c->free_list);
476 c->nr_erasing_blocks--;
479 jffs2_dbg_acct_sanity_check_nolock(c, jeb);
480 jffs2_dbg_acct_paranoia_check_nolock(c, jeb);
482 spin_unlock(&c->erase_completion_lock);
483 mutex_unlock(&c->erase_free_sem);
484 wake_up(&c->erase_wait);
488 jffs2_erase_failed(c, jeb, bad_offset);
492 /* Stick it back on the list from whence it came and come back later */
493 jffs2_erase_pending_trigger(c);
494 mutex_lock(&c->erase_free_sem);
495 spin_lock(&c->erase_completion_lock);
496 list_move(&jeb->list, &c->erase_complete_list);
497 spin_unlock(&c->erase_completion_lock);
498 mutex_unlock(&c->erase_free_sem);