6a4c0a3685daf41bce5b054719ef104b42ef7c3a
[linux-2.6.git] / fs / jffs2 / erase.c
1 /*
2  * JFFS2 -- Journalling Flash File System, Version 2.
3  *
4  * Copyright (C) 2001-2003 Red Hat, Inc.
5  *
6  * Created by David Woodhouse <dwmw2@infradead.org>
7  *
8  * For licensing information, see the file 'LICENCE' in this directory.
9  *
10  * $Id: erase.c,v 1.76 2005/05/03 15:11:40 dedekind Exp $
11  *
12  */
13
14 #include <linux/kernel.h>
15 #include <linux/slab.h>
16 #include <linux/mtd/mtd.h>
17 #include <linux/compiler.h>
18 #include <linux/crc32.h>
19 #include <linux/sched.h>
20 #include <linux/pagemap.h>
21 #include "nodelist.h"
22
23 struct erase_priv_struct {
24         struct jffs2_eraseblock *jeb;
25         struct jffs2_sb_info *c;
26 };
27       
28 #ifndef __ECOS
29 static void jffs2_erase_callback(struct erase_info *);
30 #endif
31 static void jffs2_erase_failed(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
32 static void jffs2_erase_succeeded(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
33 static void jffs2_free_all_node_refs(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
34 static void jffs2_mark_erased_block(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
35
36 static void jffs2_erase_block(struct jffs2_sb_info *c,
37                               struct jffs2_eraseblock *jeb)
38 {
39         int ret;
40         uint32_t bad_offset;
41 #ifdef __ECOS
42        ret = jffs2_flash_erase(c, jeb);
43        if (!ret) {
44                jffs2_erase_succeeded(c, jeb);
45                return;
46        }
47        bad_offset = jeb->offset;
48 #else /* Linux */
49         struct erase_info *instr;
50
51         D1(printk(KERN_DEBUG "jffs2_erase_block(): erase block %#x (range %#x-%#x)\n", jeb->offset, jeb->offset, jeb->offset + c->sector_size));
52         instr = kmalloc(sizeof(struct erase_info) + sizeof(struct erase_priv_struct), GFP_KERNEL);
53         if (!instr) {
54                 printk(KERN_WARNING "kmalloc for struct erase_info in jffs2_erase_block failed. Refiling block for later\n");
55                 spin_lock(&c->erase_completion_lock);
56                 list_del(&jeb->list);
57                 list_add(&jeb->list, &c->erase_pending_list);
58                 c->erasing_size -= c->sector_size;
59                 c->dirty_size += c->sector_size;
60                 jeb->dirty_size = c->sector_size;
61                 spin_unlock(&c->erase_completion_lock);
62                 return;
63         }
64
65         memset(instr, 0, sizeof(*instr));
66
67         instr->mtd = c->mtd;
68         instr->addr = jeb->offset;
69         instr->len = c->sector_size;
70         instr->callback = jffs2_erase_callback;
71         instr->priv = (unsigned long)(&instr[1]);
72         instr->fail_addr = 0xffffffff;
73         
74         ((struct erase_priv_struct *)instr->priv)->jeb = jeb;
75         ((struct erase_priv_struct *)instr->priv)->c = c;
76
77         ret = c->mtd->erase(c->mtd, instr);
78         if (!ret)
79                 return;
80
81         bad_offset = instr->fail_addr;
82         kfree(instr);
83 #endif /* __ECOS */
84
85         if (ret == -ENOMEM || ret == -EAGAIN) {
86                 /* Erase failed immediately. Refile it on the list */
87                 D1(printk(KERN_DEBUG "Erase at 0x%08x failed: %d. Refiling on erase_pending_list\n", jeb->offset, ret));
88                 spin_lock(&c->erase_completion_lock);
89                 list_del(&jeb->list);
90                 list_add(&jeb->list, &c->erase_pending_list);
91                 c->erasing_size -= c->sector_size;
92                 c->dirty_size += c->sector_size;
93                 jeb->dirty_size = c->sector_size;
94                 spin_unlock(&c->erase_completion_lock);
95                 return;
96         }
97
98         if (ret == -EROFS) 
99                 printk(KERN_WARNING "Erase at 0x%08x failed immediately: -EROFS. Is the sector locked?\n", jeb->offset);
100         else
101                 printk(KERN_WARNING "Erase at 0x%08x failed immediately: errno %d\n", jeb->offset, ret);
102
103         jffs2_erase_failed(c, jeb, bad_offset);
104 }
105
106 void jffs2_erase_pending_blocks(struct jffs2_sb_info *c, int count)
107 {
108         struct jffs2_eraseblock *jeb;
109
110         down(&c->erase_free_sem);
111
112         spin_lock(&c->erase_completion_lock);
113
114         while (!list_empty(&c->erase_complete_list) ||
115                !list_empty(&c->erase_pending_list)) {
116
117                 if (!list_empty(&c->erase_complete_list)) {
118                         jeb = list_entry(c->erase_complete_list.next, struct jffs2_eraseblock, list);
119                         list_del(&jeb->list);
120                         spin_unlock(&c->erase_completion_lock);
121                         jffs2_mark_erased_block(c, jeb);
122
123                         if (!--count) {
124                                 D1(printk(KERN_DEBUG "Count reached. jffs2_erase_pending_blocks leaving\n"));
125                                 goto done;
126                         }
127
128                 } else if (!list_empty(&c->erase_pending_list)) {
129                         jeb = list_entry(c->erase_pending_list.next, struct jffs2_eraseblock, list);
130                         D1(printk(KERN_DEBUG "Starting erase of pending block 0x%08x\n", jeb->offset));
131                         list_del(&jeb->list);
132                         c->erasing_size += c->sector_size;
133                         c->wasted_size -= jeb->wasted_size;
134                         c->free_size -= jeb->free_size;
135                         c->used_size -= jeb->used_size;
136                         c->dirty_size -= jeb->dirty_size;
137                         jeb->wasted_size = jeb->used_size = jeb->dirty_size = jeb->free_size = 0;
138                         jffs2_free_all_node_refs(c, jeb);
139                         list_add(&jeb->list, &c->erasing_list);
140                         spin_unlock(&c->erase_completion_lock);
141
142                         jffs2_erase_block(c, jeb);
143
144                 } else {
145                         BUG();
146                 }
147
148                 /* Be nice */
149                 cond_resched();
150                 spin_lock(&c->erase_completion_lock);
151         }
152
153         spin_unlock(&c->erase_completion_lock);
154  done:
155         D1(printk(KERN_DEBUG "jffs2_erase_pending_blocks completed\n"));
156
157         up(&c->erase_free_sem);
158 }
159
160 static void jffs2_erase_succeeded(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb)
161 {
162         D1(printk(KERN_DEBUG "Erase completed successfully at 0x%08x\n", jeb->offset));
163         spin_lock(&c->erase_completion_lock);
164         list_del(&jeb->list);
165         list_add_tail(&jeb->list, &c->erase_complete_list);
166         spin_unlock(&c->erase_completion_lock);
167         /* Ensure that kupdated calls us again to mark them clean */
168         jffs2_erase_pending_trigger(c);
169 }
170
171 static void jffs2_erase_failed(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset)
172 {
173         /* For NAND, if the failure did not occur at the device level for a
174            specific physical page, don't bother updating the bad block table. */
175         if (jffs2_cleanmarker_oob(c) && (bad_offset != 0xffffffff)) {
176                 /* We had a device-level failure to erase.  Let's see if we've
177                    failed too many times. */
178                 if (!jffs2_write_nand_badblock(c, jeb, bad_offset)) {
179                         /* We'd like to give this block another try. */
180                         spin_lock(&c->erase_completion_lock);
181                         list_del(&jeb->list);
182                         list_add(&jeb->list, &c->erase_pending_list);
183                         c->erasing_size -= c->sector_size;
184                         c->dirty_size += c->sector_size;
185                         jeb->dirty_size = c->sector_size;
186                         spin_unlock(&c->erase_completion_lock);
187                         return;
188                 }
189         }
190
191         spin_lock(&c->erase_completion_lock);
192         c->erasing_size -= c->sector_size;
193         c->bad_size += c->sector_size;
194         list_del(&jeb->list);
195         list_add(&jeb->list, &c->bad_list);
196         c->nr_erasing_blocks--;
197         spin_unlock(&c->erase_completion_lock);
198         wake_up(&c->erase_wait);
199 }        
200
201 #ifndef __ECOS
202 static void jffs2_erase_callback(struct erase_info *instr)
203 {
204         struct erase_priv_struct *priv = (void *)instr->priv;
205
206         if(instr->state != MTD_ERASE_DONE) {
207                 printk(KERN_WARNING "Erase at 0x%08x finished, but state != MTD_ERASE_DONE. State is 0x%x instead.\n", instr->addr, instr->state);
208                 jffs2_erase_failed(priv->c, priv->jeb, instr->fail_addr);
209         } else {
210                 jffs2_erase_succeeded(priv->c, priv->jeb);
211         }       
212         kfree(instr);
213 }
214 #endif /* !__ECOS */
215
216 /* Hmmm. Maybe we should accept the extra space it takes and make
217    this a standard doubly-linked list? */
218 static inline void jffs2_remove_node_refs_from_ino_list(struct jffs2_sb_info *c,
219                         struct jffs2_raw_node_ref *ref, struct jffs2_eraseblock *jeb)
220 {
221         struct jffs2_inode_cache *ic = NULL;
222         struct jffs2_raw_node_ref **prev;
223
224         prev = &ref->next_in_ino;
225
226         /* Walk the inode's list once, removing any nodes from this eraseblock */
227         while (1) {
228                 if (!(*prev)->next_in_ino) {
229                         /* We're looking at the jffs2_inode_cache, which is 
230                            at the end of the linked list. Stash it and continue
231                            from the beginning of the list */
232                         ic = (struct jffs2_inode_cache *)(*prev);
233                         prev = &ic->nodes;
234                         continue;
235                 } 
236
237                 if (SECTOR_ADDR((*prev)->flash_offset) == jeb->offset) {
238                         /* It's in the block we're erasing */
239                         struct jffs2_raw_node_ref *this;
240
241                         this = *prev;
242                         *prev = this->next_in_ino;
243                         this->next_in_ino = NULL;
244
245                         if (this == ref)
246                                 break;
247
248                         continue;
249                 }
250                 /* Not to be deleted. Skip */
251                 prev = &((*prev)->next_in_ino);
252         }
253
254         /* PARANOIA */
255         if (!ic) {
256                 printk(KERN_WARNING "inode_cache not found in remove_node_refs()!!\n");
257                 return;
258         }
259
260         D1(printk(KERN_DEBUG "Removed nodes in range 0x%08x-0x%08x from ino #%u\n",
261                   jeb->offset, jeb->offset + c->sector_size, ic->ino));
262
263         D2({
264                 int i=0;
265                 struct jffs2_raw_node_ref *this;
266                 printk(KERN_DEBUG "After remove_node_refs_from_ino_list: \n" KERN_DEBUG);
267
268                 this = ic->nodes;
269            
270                 while(this) {
271                         printk( "0x%08x(%d)->", ref_offset(this), ref_flags(this));
272                         if (++i == 5) {
273                                 printk("\n" KERN_DEBUG);
274                                 i=0;
275                         }
276                         this = this->next_in_ino;
277                 }
278                 printk("\n");
279         });
280
281         if (ic->nodes == (void *)ic && ic->nlink == 0)
282                 jffs2_del_ino_cache(c, ic);
283 }
284
285 static void jffs2_free_all_node_refs(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb)
286 {
287         struct jffs2_raw_node_ref *ref;
288         D1(printk(KERN_DEBUG "Freeing all node refs for eraseblock offset 0x%08x\n", jeb->offset));
289         while(jeb->first_node) {
290                 ref = jeb->first_node;
291                 jeb->first_node = ref->next_phys;
292                 
293                 /* Remove from the inode-list */
294                 if (ref->next_in_ino)
295                         jffs2_remove_node_refs_from_ino_list(c, ref, jeb);
296                 /* else it was a non-inode node or already removed, so don't bother */
297
298                 jffs2_free_raw_node_ref(ref);
299         }
300         jeb->last_node = NULL;
301 }
302
303 static void jffs2_mark_erased_block(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb)
304 {
305         struct jffs2_raw_node_ref *marker_ref = NULL;
306         unsigned char *ebuf;
307         size_t retlen;
308         int ret;
309         uint32_t bad_offset;
310
311         if ((!jffs2_cleanmarker_oob(c)) && (c->cleanmarker_size > 0)) {
312                 marker_ref = jffs2_alloc_raw_node_ref();
313                 if (!marker_ref) {
314                         printk(KERN_WARNING "Failed to allocate raw node ref for clean marker\n");
315                         /* Stick it back on the list from whence it came and come back later */
316                         jffs2_erase_pending_trigger(c);
317                         spin_lock(&c->erase_completion_lock);
318                         list_add(&jeb->list, &c->erase_complete_list);
319                         spin_unlock(&c->erase_completion_lock);
320                         return;
321                 }
322         }
323         ebuf = kmalloc(PAGE_SIZE, GFP_KERNEL);
324         if (!ebuf) {
325                 printk(KERN_WARNING "Failed to allocate page buffer for verifying erase at 0x%08x. Assuming it worked\n", jeb->offset);
326         } else {
327                 uint32_t ofs = jeb->offset;
328
329                 D1(printk(KERN_DEBUG "Verifying erase at 0x%08x\n", jeb->offset));
330                 while(ofs < jeb->offset + c->sector_size) {
331                         uint32_t readlen = min((uint32_t)PAGE_SIZE, jeb->offset + c->sector_size - ofs);
332                         int i;
333
334                         bad_offset = ofs;
335
336                         ret = c->mtd->read(c->mtd, ofs, readlen, &retlen, ebuf);
337
338                         if (ret) {
339                                 printk(KERN_WARNING "Read of newly-erased block at 0x%08x failed: %d. Putting on bad_list\n", ofs, ret);
340                                 goto bad;
341                         }
342                         if (retlen != readlen) {
343                                 printk(KERN_WARNING "Short read from newly-erased block at 0x%08x. Wanted %d, got %zd\n", ofs, readlen, retlen);
344                                 goto bad;
345                         }
346                         for (i=0; i<readlen; i += sizeof(unsigned long)) {
347                                 /* It's OK. We know it's properly aligned */
348                                 unsigned long datum = *(unsigned long *)(&ebuf[i]);
349                                 if (datum + 1) {
350                                         bad_offset += i;
351                                         printk(KERN_WARNING "Newly-erased block contained word 0x%lx at offset 0x%08x\n", datum, bad_offset);
352                                 bad: 
353                                         if ((!jffs2_cleanmarker_oob(c)) && (c->cleanmarker_size > 0))
354                                                 jffs2_free_raw_node_ref(marker_ref);
355                                         kfree(ebuf);
356                                 bad2:
357                                         spin_lock(&c->erase_completion_lock);
358                                         /* Stick it on a list (any list) so
359                                            erase_failed can take it right off
360                                            again.  Silly, but shouldn't happen
361                                            often. */
362                                         list_add(&jeb->list, &c->erasing_list);
363                                         spin_unlock(&c->erase_completion_lock);
364                                         jffs2_erase_failed(c, jeb, bad_offset);
365                                         return;
366                                 }
367                         }
368                         ofs += readlen;
369                         cond_resched();
370                 }
371                 kfree(ebuf);
372         }
373
374         bad_offset = jeb->offset;
375
376         /* Write the erase complete marker */   
377         D1(printk(KERN_DEBUG "Writing erased marker to block at 0x%08x\n", jeb->offset));
378         if (jffs2_cleanmarker_oob(c)) {
379
380                 if (jffs2_write_nand_cleanmarker(c, jeb))
381                         goto bad2;
382                         
383                 jeb->first_node = jeb->last_node = NULL;
384
385                 jeb->free_size = c->sector_size;
386                 jeb->used_size = 0;
387                 jeb->dirty_size = 0;
388                 jeb->wasted_size = 0;
389         } else if (c->cleanmarker_size == 0) {
390                 jeb->first_node = jeb->last_node = NULL;
391
392                 jeb->free_size = c->sector_size;
393                 jeb->used_size = 0;
394                 jeb->dirty_size = 0;
395                 jeb->wasted_size = 0;
396         } else {
397                 struct kvec vecs[1];
398                 struct jffs2_unknown_node marker = {
399                         .magic =        cpu_to_je16(JFFS2_MAGIC_BITMASK),
400                         .nodetype =     cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER),
401                         .totlen =       cpu_to_je32(c->cleanmarker_size)
402                 };
403
404                 marker.hdr_crc = cpu_to_je32(crc32(0, &marker, sizeof(struct jffs2_unknown_node)-4));
405
406                 vecs[0].iov_base = (unsigned char *) &marker;
407                 vecs[0].iov_len = sizeof(marker);
408                 ret = jffs2_flash_direct_writev(c, vecs, 1, jeb->offset, &retlen);
409                 
410                 if (ret) {
411                         printk(KERN_WARNING "Write clean marker to block at 0x%08x failed: %d\n",
412                                jeb->offset, ret);
413                         goto bad2;
414                 }
415                 if (retlen != sizeof(marker)) {
416                         printk(KERN_WARNING "Short write to newly-erased block at 0x%08x: Wanted %zd, got %zd\n",
417                                jeb->offset, sizeof(marker), retlen);
418                         goto bad2;
419                 }
420
421                 marker_ref->next_in_ino = NULL;
422                 marker_ref->next_phys = NULL;
423                 marker_ref->flash_offset = jeb->offset | REF_NORMAL;
424                 marker_ref->__totlen = c->cleanmarker_size;
425                         
426                 jeb->first_node = jeb->last_node = marker_ref;
427                         
428                 jeb->free_size = c->sector_size - c->cleanmarker_size;
429                 jeb->used_size = c->cleanmarker_size;
430                 jeb->dirty_size = 0;
431                 jeb->wasted_size = 0;
432         }
433
434         spin_lock(&c->erase_completion_lock);
435         c->erasing_size -= c->sector_size;
436         c->free_size += jeb->free_size;
437         c->used_size += jeb->used_size;
438
439         ACCT_SANITY_CHECK(c,jeb);
440         D1(ACCT_PARANOIA_CHECK(jeb));
441
442         list_add_tail(&jeb->list, &c->free_list);
443         c->nr_erasing_blocks--;
444         c->nr_free_blocks++;
445         spin_unlock(&c->erase_completion_lock);
446         wake_up(&c->erase_wait);
447 }
448