Write object headers with stored file extents
[yaffs2.git] / yaffs_yaffs2.c
1 /*
2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
3  *
4  * Copyright (C) 2002-2011 Aleph One Ltd.
5  *   for Toby Churchill Ltd and Brightstar Engineering
6  *
7  * Created by Charles Manning <charles@aleph1.co.uk>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  */
13
14 #include "yaffs_guts.h"
15 #include "yaffs_trace.h"
16 #include "yaffs_yaffs2.h"
17 #include "yaffs_checkptrw.h"
18 #include "yaffs_bitmap.h"
19 #include "yaffs_nand.h"
20 #include "yaffs_getblockinfo.h"
21 #include "yaffs_verify.h"
22 #include "yaffs_attribs.h"
23 #include "yaffs_summary.h"
24
25 /*
26  * Checkpoints are really no benefit on very small partitions.
27  *
28  * To save space on small partitions don't bother with checkpoints unless
29  * the partition is at least this big.
30  */
31 #define YAFFS_CHECKPOINT_MIN_BLOCKS 60
32 #define YAFFS_SMALL_HOLE_THRESHOLD 4
33
34 /*
35  * Oldest Dirty Sequence Number handling.
36  */
37
38 /* yaffs_calc_oldest_dirty_seq()
39  * yaffs2_find_oldest_dirty_seq()
40  * Calculate the oldest dirty sequence number if we don't know it.
41  */
42 void yaffs_calc_oldest_dirty_seq(struct yaffs_dev *dev)
43 {
44         int i;
45         unsigned seq;
46         unsigned block_no = 0;
47         struct yaffs_block_info *b;
48
49         if (!dev->param.is_yaffs2)
50                 return;
51
52         /* Find the oldest dirty sequence number. */
53         seq = dev->seq_number + 1;
54         b = dev->block_info;
55         for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
56                 if (b->block_state == YAFFS_BLOCK_STATE_FULL &&
57                     (b->pages_in_use - b->soft_del_pages) <
58                     dev->param.chunks_per_block &&
59                     b->seq_number < seq) {
60                         seq = b->seq_number;
61                         block_no = i;
62                 }
63                 b++;
64         }
65
66         if (block_no) {
67                 dev->oldest_dirty_seq = seq;
68                 dev->oldest_dirty_block = block_no;
69         }
70 }
71
72 void yaffs2_find_oldest_dirty_seq(struct yaffs_dev *dev)
73 {
74         if (!dev->param.is_yaffs2)
75                 return;
76
77         if (!dev->oldest_dirty_seq)
78                 yaffs_calc_oldest_dirty_seq(dev);
79 }
80
81 /*
82  * yaffs_clear_oldest_dirty_seq()
83  * Called when a block is erased or marked bad. (ie. when its seq_number
84  * becomes invalid). If the value matches the oldest then we clear
85  * dev->oldest_dirty_seq to force its recomputation.
86  */
87 void yaffs2_clear_oldest_dirty_seq(struct yaffs_dev *dev,
88                                    struct yaffs_block_info *bi)
89 {
90
91         if (!dev->param.is_yaffs2)
92                 return;
93
94         if (!bi || bi->seq_number == dev->oldest_dirty_seq) {
95                 dev->oldest_dirty_seq = 0;
96                 dev->oldest_dirty_block = 0;
97         }
98 }
99
100 /*
101  * yaffs2_update_oldest_dirty_seq()
102  * Update the oldest dirty sequence number whenever we dirty a block.
103  * Only do this if the oldest_dirty_seq is actually being tracked.
104  */
105 void yaffs2_update_oldest_dirty_seq(struct yaffs_dev *dev, unsigned block_no,
106                                     struct yaffs_block_info *bi)
107 {
108         if (!dev->param.is_yaffs2)
109                 return;
110
111         if (dev->oldest_dirty_seq) {
112                 if (dev->oldest_dirty_seq > bi->seq_number) {
113                         dev->oldest_dirty_seq = bi->seq_number;
114                         dev->oldest_dirty_block = block_no;
115                 }
116         }
117 }
118
119 int yaffs_block_ok_for_gc(struct yaffs_dev *dev, struct yaffs_block_info *bi)
120 {
121
122         if (!dev->param.is_yaffs2)
123                 return 1;       /* disqualification only applies to yaffs2. */
124
125         if (!bi->has_shrink_hdr)
126                 return 1;       /* can gc */
127
128         yaffs2_find_oldest_dirty_seq(dev);
129
130         /* Can't do gc of this block if there are any blocks older than this
131          * one that have discarded pages.
132          */
133         return (bi->seq_number <= dev->oldest_dirty_seq);
134 }
135
136 /*
137  * yaffs2_find_refresh_block()
138  * periodically finds the oldest full block by sequence number for refreshing.
139  * Only for yaffs2.
140  */
141 u32 yaffs2_find_refresh_block(struct yaffs_dev *dev)
142 {
143         u32 b;
144         u32 oldest = 0;
145         u32 oldest_seq = 0;
146         struct yaffs_block_info *bi;
147
148         if (!dev->param.is_yaffs2)
149                 return oldest;
150
151         /*
152          * If refresh period < 10 then refreshing is disabled.
153          */
154         if (dev->param.refresh_period < 10)
155                 return oldest;
156
157         /*
158          * Fix broken values.
159          */
160         if (dev->refresh_skip > dev->param.refresh_period)
161                 dev->refresh_skip = dev->param.refresh_period;
162
163         if (dev->refresh_skip > 0)
164                 return oldest;
165
166         /*
167          * Refresh skip is now zero.
168          * We'll do a refresh this time around....
169          * Update the refresh skip and find the oldest block.
170          */
171         dev->refresh_skip = dev->param.refresh_period;
172         dev->refresh_count++;
173         bi = dev->block_info;
174         for (b = dev->internal_start_block; b <= dev->internal_end_block; b++) {
175
176                 if (bi->block_state == YAFFS_BLOCK_STATE_FULL) {
177
178                         if (oldest < 1 || bi->seq_number < oldest_seq) {
179                                 oldest = b;
180                                 oldest_seq = bi->seq_number;
181                         }
182                 }
183                 bi++;
184         }
185
186         if (oldest > 0) {
187                 yaffs_trace(YAFFS_TRACE_GC,
188                         "GC refresh count %d selected block %d with seq_number %d",
189                         dev->refresh_count, oldest, oldest_seq);
190         }
191
192         return oldest;
193 }
194
195 int yaffs2_checkpt_required(struct yaffs_dev *dev)
196 {
197         int nblocks;
198
199         if (!dev->param.is_yaffs2)
200                 return 0;
201
202         nblocks = dev->internal_end_block - dev->internal_start_block + 1;
203
204         return !dev->param.skip_checkpt_wr &&
205             !dev->read_only && (nblocks >= YAFFS_CHECKPOINT_MIN_BLOCKS);
206 }
207
208 int yaffs_calc_checkpt_blocks_required(struct yaffs_dev *dev)
209 {
210         int retval;
211         int n_bytes = 0;
212         int n_blocks;
213         int dev_blocks;
214
215         if (!dev->param.is_yaffs2)
216                 return 0;
217
218         if (!dev->checkpoint_blocks_required && yaffs2_checkpt_required(dev)) {
219                 /* Not a valid value so recalculate */
220                 dev_blocks = dev->param.end_block - dev->param.start_block + 1;
221                 n_bytes += sizeof(struct yaffs_checkpt_validity);
222                 n_bytes += sizeof(struct yaffs_checkpt_dev);
223                 n_bytes += dev_blocks * sizeof(struct yaffs_block_info);
224                 n_bytes += dev_blocks * dev->chunk_bit_stride;
225                 n_bytes +=
226                     (sizeof(struct yaffs_checkpt_obj) + sizeof(u32)) *
227                     dev->n_obj;
228                 n_bytes += (dev->tnode_size + sizeof(u32)) * dev->n_tnodes;
229                 n_bytes += sizeof(struct yaffs_checkpt_validity);
230                 n_bytes += sizeof(u32); /* checksum */
231
232                 /* Round up and add 2 blocks to allow for some bad blocks,
233                  * so add 3 */
234
235                 n_blocks =
236                     (n_bytes /
237                      (dev->data_bytes_per_chunk *
238                       dev->param.chunks_per_block)) + 3;
239
240                 dev->checkpoint_blocks_required = n_blocks;
241         }
242
243         retval = dev->checkpoint_blocks_required - dev->blocks_in_checkpt;
244         if (retval < 0)
245                 retval = 0;
246         return retval;
247 }
248
249 /*--------------------- Checkpointing --------------------*/
250
251 static int yaffs2_wr_checkpt_validity_marker(struct yaffs_dev *dev, int head)
252 {
253         struct yaffs_checkpt_validity cp;
254
255         memset(&cp, 0, sizeof(cp));
256
257         cp.struct_type = sizeof(cp);
258         cp.magic = YAFFS_MAGIC;
259         cp.version = YAFFS_CHECKPOINT_VERSION;
260         cp.head = (head) ? 1 : 0;
261
262         return (yaffs2_checkpt_wr(dev, &cp, sizeof(cp)) == sizeof(cp)) ? 1 : 0;
263 }
264
265 static int yaffs2_rd_checkpt_validity_marker(struct yaffs_dev *dev, int head)
266 {
267         struct yaffs_checkpt_validity cp;
268         int ok;
269
270         ok = (yaffs2_checkpt_rd(dev, &cp, sizeof(cp)) == sizeof(cp));
271
272         if (ok)
273                 ok = (cp.struct_type == sizeof(cp)) &&
274                     (cp.magic == YAFFS_MAGIC) &&
275                     (cp.version == YAFFS_CHECKPOINT_VERSION) &&
276                     (cp.head == ((head) ? 1 : 0));
277         return ok ? 1 : 0;
278 }
279
280 static void yaffs2_dev_to_checkpt_dev(struct yaffs_checkpt_dev *cp,
281                                       struct yaffs_dev *dev)
282 {
283         cp->n_erased_blocks = dev->n_erased_blocks;
284         cp->alloc_block = dev->alloc_block;
285         cp->alloc_page = dev->alloc_page;
286         cp->n_free_chunks = dev->n_free_chunks;
287
288         cp->n_deleted_files = dev->n_deleted_files;
289         cp->n_unlinked_files = dev->n_unlinked_files;
290         cp->n_bg_deletions = dev->n_bg_deletions;
291         cp->seq_number = dev->seq_number;
292
293 }
294
295 static void yaffs_checkpt_dev_to_dev(struct yaffs_dev *dev,
296                                      struct yaffs_checkpt_dev *cp)
297 {
298         dev->n_erased_blocks = cp->n_erased_blocks;
299         dev->alloc_block = cp->alloc_block;
300         dev->alloc_page = cp->alloc_page;
301         dev->n_free_chunks = cp->n_free_chunks;
302
303         dev->n_deleted_files = cp->n_deleted_files;
304         dev->n_unlinked_files = cp->n_unlinked_files;
305         dev->n_bg_deletions = cp->n_bg_deletions;
306         dev->seq_number = cp->seq_number;
307 }
308
309 static int yaffs2_wr_checkpt_dev(struct yaffs_dev *dev)
310 {
311         struct yaffs_checkpt_dev cp;
312         u32 n_bytes;
313         u32 n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
314         int ok;
315
316         /* Write device runtime values */
317         yaffs2_dev_to_checkpt_dev(&cp, dev);
318         cp.struct_type = sizeof(cp);
319
320         ok = (yaffs2_checkpt_wr(dev, &cp, sizeof(cp)) == sizeof(cp));
321         if (!ok)
322                 return 0;
323
324         /* Write block info */
325         n_bytes = n_blocks * sizeof(struct yaffs_block_info);
326         ok = (yaffs2_checkpt_wr(dev, dev->block_info, n_bytes) == n_bytes);
327         if (!ok)
328                 return 0;
329
330         /* Write chunk bits */
331         n_bytes = n_blocks * dev->chunk_bit_stride;
332         ok = (yaffs2_checkpt_wr(dev, dev->chunk_bits, n_bytes) == n_bytes);
333
334         return ok ? 1 : 0;
335 }
336
337 static int yaffs2_rd_checkpt_dev(struct yaffs_dev *dev)
338 {
339         struct yaffs_checkpt_dev cp;
340         u32 n_bytes;
341         u32 n_blocks =
342             (dev->internal_end_block - dev->internal_start_block + 1);
343         int ok;
344
345         ok = (yaffs2_checkpt_rd(dev, &cp, sizeof(cp)) == sizeof(cp));
346         if (!ok)
347                 return 0;
348
349         if (cp.struct_type != sizeof(cp))
350                 return 0;
351
352         yaffs_checkpt_dev_to_dev(dev, &cp);
353
354         n_bytes = n_blocks * sizeof(struct yaffs_block_info);
355
356         ok = (yaffs2_checkpt_rd(dev, dev->block_info, n_bytes) == n_bytes);
357
358         if (!ok)
359                 return 0;
360
361         n_bytes = n_blocks * dev->chunk_bit_stride;
362
363         ok = (yaffs2_checkpt_rd(dev, dev->chunk_bits, n_bytes) == n_bytes);
364
365         return ok ? 1 : 0;
366 }
367
368 static void yaffs2_obj_checkpt_obj(struct yaffs_checkpt_obj *cp,
369                                    struct yaffs_obj *obj)
370 {
371         cp->obj_id = obj->obj_id;
372         cp->parent_id = (obj->parent) ? obj->parent->obj_id : 0;
373         cp->hdr_chunk = obj->hdr_chunk;
374         cp->variant_type = obj->variant_type;
375         cp->deleted = obj->deleted;
376         cp->soft_del = obj->soft_del;
377         cp->unlinked = obj->unlinked;
378         cp->fake = obj->fake;
379         cp->rename_allowed = obj->rename_allowed;
380         cp->unlink_allowed = obj->unlink_allowed;
381         cp->serial = obj->serial;
382         cp->n_data_chunks = obj->n_data_chunks;
383
384         if (obj->variant_type == YAFFS_OBJECT_TYPE_FILE)
385                 cp->size_or_equiv_obj = obj->variant.file_variant.file_size;
386         else if (obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK)
387                 cp->size_or_equiv_obj = obj->variant.hardlink_variant.equiv_id;
388 }
389
390 static int yaffs2_checkpt_obj_to_obj(struct yaffs_obj *obj,
391                                      struct yaffs_checkpt_obj *cp)
392 {
393         struct yaffs_obj *parent;
394
395         if (obj->variant_type != cp->variant_type) {
396                 yaffs_trace(YAFFS_TRACE_ERROR,
397                         "Checkpoint read object %d type %d chunk %d does not match existing object type %d",
398                         cp->obj_id, cp->variant_type, cp->hdr_chunk,
399                         obj->variant_type);
400                 return 0;
401         }
402
403         obj->obj_id = cp->obj_id;
404
405         if (cp->parent_id)
406                 parent = yaffs_find_or_create_by_number(obj->my_dev,
407                                                 cp->parent_id,
408                                                 YAFFS_OBJECT_TYPE_DIRECTORY);
409         else
410                 parent = NULL;
411
412         if (parent) {
413                 if (parent->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
414                         yaffs_trace(YAFFS_TRACE_ALWAYS,
415                                 "Checkpoint read object %d parent %d type %d chunk %d Parent type, %d, not directory",
416                                 cp->obj_id, cp->parent_id,
417                                 cp->variant_type, cp->hdr_chunk,
418                                 parent->variant_type);
419                         return 0;
420                 }
421                 yaffs_add_obj_to_dir(parent, obj);
422         }
423
424         obj->hdr_chunk = cp->hdr_chunk;
425         obj->variant_type = cp->variant_type;
426         obj->deleted = cp->deleted;
427         obj->soft_del = cp->soft_del;
428         obj->unlinked = cp->unlinked;
429         obj->fake = cp->fake;
430         obj->rename_allowed = cp->rename_allowed;
431         obj->unlink_allowed = cp->unlink_allowed;
432         obj->serial = cp->serial;
433         obj->n_data_chunks = cp->n_data_chunks;
434
435         if (obj->variant_type == YAFFS_OBJECT_TYPE_FILE) {
436                 obj->variant.file_variant.file_size = cp->size_or_equiv_obj;
437                 obj->variant.file_variant.stored_size = cp->size_or_equiv_obj;
438         } else if (obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
439                 obj->variant.hardlink_variant.equiv_id = cp->size_or_equiv_obj;
440         }
441         if (obj->hdr_chunk > 0)
442                 obj->lazy_loaded = 1;
443         return 1;
444 }
445
446 static int yaffs2_checkpt_tnode_worker(struct yaffs_obj *in,
447                                        struct yaffs_tnode *tn, u32 level,
448                                        int chunk_offset)
449 {
450         int i;
451         struct yaffs_dev *dev = in->my_dev;
452         int ok = 1;
453         u32 base_offset;
454
455         if (!tn)
456                 return 1;
457
458         if (level > 0) {
459                 for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++) {
460                         if (!tn->internal[i])
461                                 continue;
462                         ok = yaffs2_checkpt_tnode_worker(in,
463                                  tn->internal[i],
464                                  level - 1,
465                                  (chunk_offset <<
466                                   YAFFS_TNODES_INTERNAL_BITS) + i);
467                 }
468                 return ok;
469         }
470
471         /* Level 0 tnode */
472         base_offset = chunk_offset << YAFFS_TNODES_LEVEL0_BITS;
473         ok = (yaffs2_checkpt_wr(dev, &base_offset, sizeof(base_offset)) ==
474                         sizeof(base_offset));
475         if (ok)
476                 ok = (yaffs2_checkpt_wr(dev, tn, dev->tnode_size) ==
477                         dev->tnode_size);
478
479         return ok;
480 }
481
482 static int yaffs2_wr_checkpt_tnodes(struct yaffs_obj *obj)
483 {
484         u32 end_marker = ~0;
485         int ok = 1;
486
487         if (obj->variant_type != YAFFS_OBJECT_TYPE_FILE)
488                 return ok;
489
490         ok = yaffs2_checkpt_tnode_worker(obj,
491                                          obj->variant.file_variant.top,
492                                          obj->variant.file_variant.
493                                          top_level, 0);
494         if (ok)
495                 ok = (yaffs2_checkpt_wr(obj->my_dev, &end_marker,
496                                 sizeof(end_marker)) == sizeof(end_marker));
497
498         return ok ? 1 : 0;
499 }
500
501 static int yaffs2_rd_checkpt_tnodes(struct yaffs_obj *obj)
502 {
503         u32 base_chunk;
504         int ok = 1;
505         struct yaffs_dev *dev = obj->my_dev;
506         struct yaffs_file_var *file_stuct_ptr = &obj->variant.file_variant;
507         struct yaffs_tnode *tn;
508         int nread = 0;
509
510         ok = (yaffs2_checkpt_rd(dev, &base_chunk, sizeof(base_chunk)) ==
511               sizeof(base_chunk));
512
513         while (ok && (~base_chunk)) {
514                 nread++;
515                 /* Read level 0 tnode */
516
517                 tn = yaffs_get_tnode(dev);
518                 if (tn)
519                         ok = (yaffs2_checkpt_rd(dev, tn, dev->tnode_size) ==
520                                 dev->tnode_size);
521                 else
522                         ok = 0;
523
524                 if (tn && ok)
525                         ok = yaffs_add_find_tnode_0(dev,
526                                                     file_stuct_ptr,
527                                                     base_chunk, tn) ? 1 : 0;
528
529                 if (ok)
530                         ok = (yaffs2_checkpt_rd
531                               (dev, &base_chunk,
532                                sizeof(base_chunk)) == sizeof(base_chunk));
533         }
534
535         yaffs_trace(YAFFS_TRACE_CHECKPOINT,
536                 "Checkpoint read tnodes %d records, last %d. ok %d",
537                 nread, base_chunk, ok);
538
539         return ok ? 1 : 0;
540 }
541
542 static int yaffs2_wr_checkpt_objs(struct yaffs_dev *dev)
543 {
544         struct yaffs_obj *obj;
545         struct yaffs_checkpt_obj cp;
546         int i;
547         int ok = 1;
548         struct list_head *lh;
549
550         /* Iterate through the objects in each hash entry,
551          * dumping them to the checkpointing stream.
552          */
553
554         for (i = 0; ok && i < YAFFS_NOBJECT_BUCKETS; i++) {
555                 list_for_each(lh, &dev->obj_bucket[i].list) {
556                         obj = list_entry(lh, struct yaffs_obj, hash_link);
557                         if (!obj->defered_free) {
558                                 yaffs2_obj_checkpt_obj(&cp, obj);
559                                 cp.struct_type = sizeof(cp);
560
561                                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
562                                         "Checkpoint write object %d parent %d type %d chunk %d obj addr %p",
563                                         cp.obj_id, cp.parent_id,
564                                         cp.variant_type, cp.hdr_chunk, obj);
565
566                                 ok = (yaffs2_checkpt_wr(dev, &cp,
567                                                 sizeof(cp)) == sizeof(cp));
568
569                                 if (ok &&
570                                         obj->variant_type ==
571                                         YAFFS_OBJECT_TYPE_FILE)
572                                         ok = yaffs2_wr_checkpt_tnodes(obj);
573                         }
574                 }
575         }
576
577         /* Dump end of list */
578         memset(&cp, 0xff, sizeof(struct yaffs_checkpt_obj));
579         cp.struct_type = sizeof(cp);
580
581         if (ok)
582                 ok = (yaffs2_checkpt_wr(dev, &cp, sizeof(cp)) == sizeof(cp));
583
584         return ok ? 1 : 0;
585 }
586
587 static int yaffs2_rd_checkpt_objs(struct yaffs_dev *dev)
588 {
589         struct yaffs_obj *obj;
590         struct yaffs_checkpt_obj cp;
591         int ok = 1;
592         int done = 0;
593         LIST_HEAD(hard_list);
594
595
596         while (ok && !done) {
597                 ok = (yaffs2_checkpt_rd(dev, &cp, sizeof(cp)) == sizeof(cp));
598                 if (cp.struct_type != sizeof(cp)) {
599                         yaffs_trace(YAFFS_TRACE_CHECKPOINT,
600                                 "struct size %d instead of %d ok %d",
601                                 cp.struct_type, (int)sizeof(cp), ok);
602                         ok = 0;
603                 }
604
605                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
606                         "Checkpoint read object %d parent %d type %d chunk %d ",
607                         cp.obj_id, cp.parent_id, cp.variant_type,
608                         cp.hdr_chunk);
609
610                 if (ok && cp.obj_id == ~0) {
611                         done = 1;
612                 } else if (ok) {
613                         obj =
614                             yaffs_find_or_create_by_number(dev, cp.obj_id,
615                                                            cp.variant_type);
616                         if (obj) {
617                                 ok = yaffs2_checkpt_obj_to_obj(obj, &cp);
618                                 if (!ok)
619                                         break;
620                                 if (obj->variant_type ==
621                                         YAFFS_OBJECT_TYPE_FILE) {
622                                         ok = yaffs2_rd_checkpt_tnodes(obj);
623                                 } else if (obj->variant_type ==
624                                         YAFFS_OBJECT_TYPE_HARDLINK) {
625                                         list_add(&obj->hard_links, &hard_list);
626                                 }
627                         } else {
628                                 ok = 0;
629                         }
630                 }
631         }
632
633         if (ok)
634                 yaffs_link_fixup(dev, &hard_list);
635
636         return ok ? 1 : 0;
637 }
638
639 static int yaffs2_wr_checkpt_sum(struct yaffs_dev *dev)
640 {
641         u32 checkpt_sum;
642         int ok;
643
644         yaffs2_get_checkpt_sum(dev, &checkpt_sum);
645
646         ok = (yaffs2_checkpt_wr(dev, &checkpt_sum, sizeof(checkpt_sum)) ==
647                 sizeof(checkpt_sum));
648
649         if (!ok)
650                 return 0;
651
652         return 1;
653 }
654
655 static int yaffs2_rd_checkpt_sum(struct yaffs_dev *dev)
656 {
657         u32 checkpt_sum0;
658         u32 checkpt_sum1;
659         int ok;
660
661         yaffs2_get_checkpt_sum(dev, &checkpt_sum0);
662
663         ok = (yaffs2_checkpt_rd(dev, &checkpt_sum1, sizeof(checkpt_sum1)) ==
664                 sizeof(checkpt_sum1));
665
666         if (!ok)
667                 return 0;
668
669         if (checkpt_sum0 != checkpt_sum1)
670                 return 0;
671
672         return 1;
673 }
674
675 static int yaffs2_wr_checkpt_data(struct yaffs_dev *dev)
676 {
677         int ok = 1;
678
679         if (!yaffs2_checkpt_required(dev)) {
680                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
681                         "skipping checkpoint write");
682                 ok = 0;
683         }
684
685         if (ok)
686                 ok = yaffs2_checkpt_open(dev, 1);
687
688         if (ok) {
689                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
690                         "write checkpoint validity");
691                 ok = yaffs2_wr_checkpt_validity_marker(dev, 1);
692         }
693         if (ok) {
694                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
695                         "write checkpoint device");
696                 ok = yaffs2_wr_checkpt_dev(dev);
697         }
698         if (ok) {
699                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
700                         "write checkpoint objects");
701                 ok = yaffs2_wr_checkpt_objs(dev);
702         }
703         if (ok) {
704                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
705                         "write checkpoint validity");
706                 ok = yaffs2_wr_checkpt_validity_marker(dev, 0);
707         }
708
709         if (ok)
710                 ok = yaffs2_wr_checkpt_sum(dev);
711
712         if (!yaffs_checkpt_close(dev))
713                 ok = 0;
714
715         if (ok)
716                 dev->is_checkpointed = 1;
717         else
718                 dev->is_checkpointed = 0;
719
720         return dev->is_checkpointed;
721 }
722
723 static int yaffs2_rd_checkpt_data(struct yaffs_dev *dev)
724 {
725         int ok = 1;
726
727         if (!dev->param.is_yaffs2)
728                 ok = 0;
729
730         if (ok && dev->param.skip_checkpt_rd) {
731                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
732                         "skipping checkpoint read");
733                 ok = 0;
734         }
735
736         if (ok)
737                 ok = yaffs2_checkpt_open(dev, 0); /* open for read */
738
739         if (ok) {
740                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
741                         "read checkpoint validity");
742                 ok = yaffs2_rd_checkpt_validity_marker(dev, 1);
743         }
744         if (ok) {
745                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
746                         "read checkpoint device");
747                 ok = yaffs2_rd_checkpt_dev(dev);
748         }
749         if (ok) {
750                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
751                         "read checkpoint objects");
752                 ok = yaffs2_rd_checkpt_objs(dev);
753         }
754         if (ok) {
755                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
756                         "read checkpoint validity");
757                 ok = yaffs2_rd_checkpt_validity_marker(dev, 0);
758         }
759
760         if (ok) {
761                 ok = yaffs2_rd_checkpt_sum(dev);
762                 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
763                         "read checkpoint checksum %d", ok);
764         }
765
766         if (!yaffs_checkpt_close(dev))
767                 ok = 0;
768
769         if (ok)
770                 dev->is_checkpointed = 1;
771         else
772                 dev->is_checkpointed = 0;
773
774         return ok ? 1 : 0;
775 }
776
777 void yaffs2_checkpt_invalidate(struct yaffs_dev *dev)
778 {
779         if (dev->is_checkpointed || dev->blocks_in_checkpt > 0) {
780                 dev->is_checkpointed = 0;
781                 yaffs2_checkpt_invalidate_stream(dev);
782         }
783         if (dev->param.sb_dirty_fn)
784                 dev->param.sb_dirty_fn(dev);
785 }
786
787 int yaffs_checkpoint_save(struct yaffs_dev *dev)
788 {
789         yaffs_trace(YAFFS_TRACE_CHECKPOINT,
790                 "save entry: is_checkpointed %d",
791                 dev->is_checkpointed);
792
793         yaffs_verify_objects(dev);
794         yaffs_verify_blocks(dev);
795         yaffs_verify_free_chunks(dev);
796
797         if (!dev->is_checkpointed) {
798                 yaffs2_checkpt_invalidate(dev);
799                 yaffs2_wr_checkpt_data(dev);
800         }
801
802         yaffs_trace(YAFFS_TRACE_CHECKPOINT | YAFFS_TRACE_MOUNT,
803                 "save exit: is_checkpointed %d",
804                 dev->is_checkpointed);
805
806         return dev->is_checkpointed;
807 }
808
809 int yaffs2_checkpt_restore(struct yaffs_dev *dev)
810 {
811         int retval;
812
813         yaffs_trace(YAFFS_TRACE_CHECKPOINT,
814                 "restore entry: is_checkpointed %d",
815                 dev->is_checkpointed);
816
817         retval = yaffs2_rd_checkpt_data(dev);
818
819         if (dev->is_checkpointed) {
820                 yaffs_verify_objects(dev);
821                 yaffs_verify_blocks(dev);
822                 yaffs_verify_free_chunks(dev);
823         }
824
825         yaffs_trace(YAFFS_TRACE_CHECKPOINT,
826                 "restore exit: is_checkpointed %d",
827                 dev->is_checkpointed);
828
829         return retval;
830 }
831
832 int yaffs2_handle_hole(struct yaffs_obj *obj, loff_t new_size)
833 {
834         /* if new_size > old_file_size.
835          * We're going to be writing a hole.
836          * If the hole is small then write zeros otherwise write a start
837          * of hole marker.
838          */
839         loff_t old_file_size;
840         loff_t increase;
841         int small_hole;
842         int result = YAFFS_OK;
843         struct yaffs_dev *dev = NULL;
844         u8 *local_buffer = NULL;
845         int small_increase_ok = 0;
846
847         if (!obj)
848                 return YAFFS_FAIL;
849
850         if (obj->variant_type != YAFFS_OBJECT_TYPE_FILE)
851                 return YAFFS_FAIL;
852
853         dev = obj->my_dev;
854
855         /* Bail out if not yaffs2 mode */
856         if (!dev->param.is_yaffs2)
857                 return YAFFS_OK;
858
859         old_file_size = obj->variant.file_variant.file_size;
860
861         if (new_size <= old_file_size)
862                 return YAFFS_OK;
863
864         increase = new_size - old_file_size;
865
866         if (increase < YAFFS_SMALL_HOLE_THRESHOLD * dev->data_bytes_per_chunk &&
867             yaffs_check_alloc_available(dev, YAFFS_SMALL_HOLE_THRESHOLD + 1))
868                 small_hole = 1;
869         else
870                 small_hole = 0;
871
872         if (small_hole)
873                 local_buffer = yaffs_get_temp_buffer(dev);
874
875         if (local_buffer) {
876                 /* fill hole with zero bytes */
877                 loff_t pos = old_file_size;
878                 int this_write;
879                 int written;
880                 memset(local_buffer, 0, dev->data_bytes_per_chunk);
881                 small_increase_ok = 1;
882
883                 while (increase > 0 && small_increase_ok) {
884                         this_write = increase;
885                         if (this_write > dev->data_bytes_per_chunk)
886                                 this_write = dev->data_bytes_per_chunk;
887                         written =
888                             yaffs_do_file_wr(obj, local_buffer, pos, this_write,
889                                              0);
890                         if (written == this_write) {
891                                 pos += this_write;
892                                 increase -= this_write;
893                         } else {
894                                 small_increase_ok = 0;
895                         }
896                 }
897
898                 yaffs_release_temp_buffer(dev, local_buffer);
899
900                 /* If out of space then reverse any chunks we've added */
901                 if (!small_increase_ok)
902                         yaffs_resize_file_down(obj, old_file_size);
903         }
904
905         if (!small_increase_ok &&
906             obj->parent &&
907             obj->parent->obj_id != YAFFS_OBJECTID_UNLINKED &&
908             obj->parent->obj_id != YAFFS_OBJECTID_DELETED) {
909                 /* Write a hole start header with the old file size */
910                 yaffs_update_oh(obj, NULL, 0, 1, 0, NULL);
911         }
912
913         return result;
914 }
915
916 struct yaffs_block_index {
917         int seq;
918         int block;
919 };
920
921 static int yaffs2_ybicmp(const void *a, const void *b)
922 {
923         int aseq = ((struct yaffs_block_index *)a)->seq;
924         int bseq = ((struct yaffs_block_index *)b)->seq;
925         int ablock = ((struct yaffs_block_index *)a)->block;
926         int bblock = ((struct yaffs_block_index *)b)->block;
927
928         if (aseq == bseq)
929                 return ablock - bblock;
930
931         return aseq - bseq;
932 }
933
934 static inline int yaffs2_scan_chunk(struct yaffs_dev *dev,
935                 struct yaffs_block_info *bi,
936                 int blk, int chunk_in_block,
937                 int *found_chunks,
938                 u8 *chunk_data,
939                 struct list_head *hard_list,
940                 int summary_available)
941 {
942         struct yaffs_obj_hdr *oh;
943         struct yaffs_obj *in;
944         struct yaffs_obj *parent;
945         int equiv_id;
946         loff_t file_size;
947         int is_shrink;
948         int is_unlinked;
949         struct yaffs_ext_tags tags;
950         int result;
951         int alloc_failed = 0;
952         int chunk = blk * dev->param.chunks_per_block + chunk_in_block;
953         struct yaffs_file_var *file_var;
954         struct yaffs_hardlink_var *hl_var;
955         struct yaffs_symlink_var *sl_var;
956
957         if (summary_available) {
958                 result = yaffs_summary_fetch(dev, &tags, chunk_in_block);
959                 tags.seq_number = bi->seq_number;
960         }
961
962         if (!summary_available || tags.obj_id == 0) {
963                 result = yaffs_rd_chunk_tags_nand(dev, chunk, NULL, &tags);
964                 dev->tags_used++;
965         } else {
966                 dev->summary_used++;
967         }
968
969         /* Let's have a good look at this chunk... */
970
971         if (!tags.chunk_used) {
972                 /* An unassigned chunk in the block.
973                  * If there are used chunks after this one, then
974                  * it is a chunk that was skipped due to failing
975                  * the erased check. Just skip it so that it can
976                  * be deleted.
977                  * But, more typically, We get here when this is
978                  * an unallocated chunk and his means that
979                  * either the block is empty or this is the one
980                  * being allocated from
981                  */
982
983                 if (*found_chunks) {
984                         /* This is a chunk that was skipped due
985                          * to failing the erased check */
986                 } else if (chunk_in_block == 0) {
987                         /* We're looking at the first chunk in
988                          * the block so the block is unused */
989                         bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
990                         dev->n_erased_blocks++;
991                 } else {
992                         if (bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCAN ||
993                             bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING) {
994                                 if (dev->seq_number == bi->seq_number) {
995                                         /* Allocating from this block*/
996                                         yaffs_trace(YAFFS_TRACE_SCAN,
997                                             " Allocating from %d %d",
998                                             blk, chunk_in_block);
999
1000                                         bi->block_state =
1001                                                 YAFFS_BLOCK_STATE_ALLOCATING;
1002                                         dev->alloc_block = blk;
1003                                         dev->alloc_page = chunk_in_block;
1004                                         dev->alloc_block_finder = blk;
1005                                 } else {
1006                                         /* This is a partially written block
1007                                          * that is not the current
1008                                          * allocation block.
1009                                          */
1010                                         yaffs_trace(YAFFS_TRACE_SCAN,
1011                                                 "Partially written block %d detected. gc will fix this.",
1012                                                 blk);
1013                                 }
1014                         }
1015                 }
1016
1017                 dev->n_free_chunks++;
1018
1019         } else if (tags.ecc_result ==
1020                 YAFFS_ECC_RESULT_UNFIXED) {
1021                 yaffs_trace(YAFFS_TRACE_SCAN,
1022                         " Unfixed ECC in chunk(%d:%d), chunk ignored",
1023                         blk, chunk_in_block);
1024                         dev->n_free_chunks++;
1025         } else if (tags.obj_id > YAFFS_MAX_OBJECT_ID ||
1026                    tags.chunk_id > YAFFS_MAX_CHUNK_ID ||
1027                    tags.obj_id == YAFFS_OBJECTID_SUMMARY ||
1028                    (tags.chunk_id > 0 &&
1029                      tags.n_bytes > dev->data_bytes_per_chunk) ||
1030                    tags.seq_number != bi->seq_number) {
1031                 yaffs_trace(YAFFS_TRACE_SCAN,
1032                         "Chunk (%d:%d) with bad tags:obj = %d, chunk_id = %d, n_bytes = %d, ignored",
1033                         blk, chunk_in_block, tags.obj_id,
1034                         tags.chunk_id, tags.n_bytes);
1035                 dev->n_free_chunks++;
1036         } else if (tags.chunk_id > 0) {
1037                 /* chunk_id > 0 so it is a data chunk... */
1038                 loff_t endpos;
1039                 loff_t chunk_base = (tags.chunk_id - 1) *
1040                                         dev->data_bytes_per_chunk;
1041
1042                 *found_chunks = 1;
1043
1044                 yaffs_set_chunk_bit(dev, blk, chunk_in_block);
1045                 bi->pages_in_use++;
1046
1047                 in = yaffs_find_or_create_by_number(dev,
1048                                         tags.obj_id,
1049                                         YAFFS_OBJECT_TYPE_FILE);
1050                 if (!in)
1051                         /* Out of memory */
1052                         alloc_failed = 1;
1053
1054                 if (in &&
1055                     in->variant_type == YAFFS_OBJECT_TYPE_FILE &&
1056                     chunk_base < in->variant.file_variant.shrink_size) {
1057                         /* This has not been invalidated by
1058                          * a resize */
1059                         if (!yaffs_put_chunk_in_file(in, tags.chunk_id,
1060                                                                 chunk, -1))
1061                                 alloc_failed = 1;
1062
1063                         /* File size is calculated by looking at
1064                          * the data chunks if we have not
1065                          * seen an object header yet.
1066                          * Stop this practice once we find an
1067                          * object header.
1068                          */
1069                         endpos = chunk_base + tags.n_bytes;
1070
1071                         if (!in->valid &&
1072                             in->variant.file_variant.stored_size < endpos) {
1073                                 in->variant.file_variant.
1074                                     stored_size = endpos;
1075                                 in->variant.file_variant.
1076                                     file_size = endpos;
1077                         }
1078                 } else if (in) {
1079                         /* This chunk has been invalidated by a
1080                          * resize, or a past file deletion
1081                          * so delete the chunk*/
1082                         yaffs_chunk_del(dev, chunk, 1, __LINE__);
1083                 }
1084         } else {
1085                 /* chunk_id == 0, so it is an ObjectHeader.
1086                  * Thus, we read in the object header and make
1087                  * the object
1088                  */
1089                 *found_chunks = 1;
1090
1091                 yaffs_set_chunk_bit(dev, blk, chunk_in_block);
1092                 bi->pages_in_use++;
1093
1094                 oh = NULL;
1095                 in = NULL;
1096
1097                 if (tags.extra_available) {
1098                         in = yaffs_find_or_create_by_number(dev,
1099                                         tags.obj_id,
1100                                         tags.extra_obj_type);
1101                         if (!in)
1102                                 alloc_failed = 1;
1103                 }
1104
1105                 if (!in ||
1106                     (!in->valid && dev->param.disable_lazy_load) ||
1107                     tags.extra_shadows ||
1108                     (!in->valid && (tags.obj_id == YAFFS_OBJECTID_ROOT ||
1109                                  tags.obj_id == YAFFS_OBJECTID_LOSTNFOUND))) {
1110
1111                         /* If we don't have  valid info then we
1112                          * need to read the chunk
1113                          * TODO In future we can probably defer
1114                          * reading the chunk and living with
1115                          * invalid data until needed.
1116                          */
1117
1118                         result = yaffs_rd_chunk_tags_nand(dev,
1119                                                   chunk,
1120                                                   chunk_data,
1121                                                   NULL);
1122
1123                         oh = (struct yaffs_obj_hdr *)chunk_data;
1124
1125                         if (dev->param.inband_tags) {
1126                                 /* Fix up the header if they got
1127                                  * corrupted by inband tags */
1128                                 oh->shadows_obj =
1129                                     oh->inband_shadowed_obj_id;
1130                                 oh->is_shrink =
1131                                     oh->inband_is_shrink;
1132                         }
1133
1134                         if (!in) {
1135                                 in = yaffs_find_or_create_by_number(dev,
1136                                                         tags.obj_id, oh->type);
1137                                 if (!in)
1138                                         alloc_failed = 1;
1139                         }
1140                 }
1141
1142                 if (!in) {
1143                         /* TODO Hoosterman we have a problem! */
1144                         yaffs_trace(YAFFS_TRACE_ERROR,
1145                                 "yaffs tragedy: Could not make object for object  %d at chunk %d during scan",
1146                                 tags.obj_id, chunk);
1147                         return YAFFS_FAIL;
1148                 }
1149
1150                 if (in->valid) {
1151                         /* We have already filled this one.
1152                          * We have a duplicate that will be
1153                          * discarded, but we first have to suck
1154                          * out resize info if it is a file.
1155                          */
1156                         if ((in->variant_type == YAFFS_OBJECT_TYPE_FILE) &&
1157                                 ((oh && oh->type == YAFFS_OBJECT_TYPE_FILE) ||
1158                                  (tags.extra_available &&
1159                                   tags.extra_obj_type == YAFFS_OBJECT_TYPE_FILE)
1160                                 )) {
1161                                 loff_t this_size = (oh) ?
1162                                         yaffs_oh_to_size(oh) :
1163                                         tags.extra_file_size;
1164                                 u32 parent_obj_id = (oh) ?
1165                                         oh->parent_obj_id :
1166                                         tags.extra_parent_id;
1167
1168                                 is_shrink = (oh) ?
1169                                         oh->is_shrink :
1170                                         tags.extra_is_shrink;
1171
1172                                 /* If it is deleted (unlinked
1173                                  * at start also means deleted)
1174                                  * we treat the file size as
1175                                  * being zeroed at this point.
1176                                  */
1177                                 if (parent_obj_id == YAFFS_OBJECTID_DELETED ||
1178                                     parent_obj_id == YAFFS_OBJECTID_UNLINKED) {
1179                                         this_size = 0;
1180                                         is_shrink = 1;
1181                                 }
1182
1183                                 if (is_shrink &&
1184                                     in->variant.file_variant.shrink_size >
1185                                     this_size)
1186                                         in->variant.file_variant.shrink_size =
1187                                         this_size;
1188
1189                                 if (is_shrink)
1190                                         bi->has_shrink_hdr = 1;
1191                         }
1192                         /* Use existing - destroy this one. */
1193                         yaffs_chunk_del(dev, chunk, 1, __LINE__);
1194                 }
1195
1196                 if (!in->valid && in->variant_type !=
1197                     (oh ? oh->type : tags.extra_obj_type)) {
1198                         yaffs_trace(YAFFS_TRACE_ERROR,
1199                                 "yaffs tragedy: Bad type, %d != %d, for object %d at chunk %d during scan",
1200                                 oh ? oh->type : tags.extra_obj_type,
1201                                 in->variant_type, tags.obj_id,
1202                                 chunk);
1203                         in = yaffs_retype_obj(in, oh ? oh->type : tags.extra_obj_type);
1204                 }
1205
1206                 if (!in->valid &&
1207                     (tags.obj_id == YAFFS_OBJECTID_ROOT ||
1208                      tags.obj_id == YAFFS_OBJECTID_LOSTNFOUND)) {
1209                         /* We only load some info, don't fiddle
1210                          * with directory structure */
1211                         in->valid = 1;
1212
1213                         if (oh) {
1214                                 in->yst_mode = oh->yst_mode;
1215                                 yaffs_load_attribs(in, oh);
1216                                 in->lazy_loaded = 0;
1217                         } else {
1218                                 in->lazy_loaded = 1;
1219                         }
1220                         in->hdr_chunk = chunk;
1221
1222                 } else if (!in->valid) {
1223                         /* we need to load this info */
1224                         in->valid = 1;
1225                         in->hdr_chunk = chunk;
1226                         if (oh) {
1227                                 in->variant_type = oh->type;
1228                                 in->yst_mode = oh->yst_mode;
1229                                 yaffs_load_attribs(in, oh);
1230
1231                                 if (oh->shadows_obj > 0)
1232                                         yaffs_handle_shadowed_obj(dev,
1233                                              oh->shadows_obj, 1);
1234
1235                                 yaffs_set_obj_name_from_oh(in, oh);
1236                                 parent = yaffs_find_or_create_by_number(dev,
1237                                                 oh->parent_obj_id,
1238                                                 YAFFS_OBJECT_TYPE_DIRECTORY);
1239                                 file_size = yaffs_oh_to_size(oh);
1240                                 is_shrink = oh->is_shrink;
1241                                 equiv_id = oh->equiv_id;
1242                         } else {
1243                                 in->variant_type = tags.extra_obj_type;
1244                                 parent = yaffs_find_or_create_by_number(dev,
1245                                                 tags.extra_parent_id,
1246                                                 YAFFS_OBJECT_TYPE_DIRECTORY);
1247                                 file_size = tags.extra_file_size;
1248                                 is_shrink = tags.extra_is_shrink;
1249                                 equiv_id = tags.extra_equiv_id;
1250                                 in->lazy_loaded = 1;
1251                         }
1252                         in->dirty = 0;
1253
1254                         if (!parent)
1255                                 alloc_failed = 1;
1256
1257                         /* directory stuff...
1258                          * hook up to parent
1259                          */
1260
1261                         if (parent &&
1262                             parent->variant_type == YAFFS_OBJECT_TYPE_UNKNOWN) {
1263                                 /* Set up as a directory */
1264                                 parent->variant_type =
1265                                         YAFFS_OBJECT_TYPE_DIRECTORY;
1266                                 INIT_LIST_HEAD(&parent->
1267                                                 variant.dir_variant.children);
1268                         } else if (!parent ||
1269                                    parent->variant_type !=
1270                                         YAFFS_OBJECT_TYPE_DIRECTORY) {
1271                                 /* Hoosterman, another problem....
1272                                  * Trying to use a non-directory as a directory
1273                                  */
1274
1275                                 yaffs_trace(YAFFS_TRACE_ERROR,
1276                                         "yaffs tragedy: attempting to use non-directory as a directory in scan. Put in lost+found."
1277                                         );
1278                                 parent = dev->lost_n_found;
1279                         }
1280                         yaffs_add_obj_to_dir(parent, in);
1281
1282                         is_unlinked = (parent == dev->del_dir) ||
1283                                         (parent == dev->unlinked_dir);
1284
1285                         if (is_shrink)
1286                                 /* Mark the block */
1287                                 bi->has_shrink_hdr = 1;
1288
1289                         /* Note re hardlinks.
1290                          * Since we might scan a hardlink before its equivalent
1291                          * object is scanned we put them all in a list.
1292                          * After scanning is complete, we should have all the
1293                          * objects, so we run through this list and fix up all
1294                          * the chains.
1295                          */
1296
1297                         switch (in->variant_type) {
1298                         case YAFFS_OBJECT_TYPE_UNKNOWN:
1299                                 /* Todo got a problem */
1300                                 break;
1301                         case YAFFS_OBJECT_TYPE_FILE:
1302                                 file_var = &in->variant.file_variant;
1303                                 if (file_var->stored_size < file_size) {
1304                                         /* This covers the case where the file
1305                                          * size is greater than the data held.
1306                                          * This will happen if the file is
1307                                          * resized to be larger than its
1308                                          * current data extents.
1309                                          */
1310                                         file_var->file_size = file_size;
1311                                         file_var->stored_size = file_size;
1312                                 }
1313
1314                                 if (file_var->shrink_size > file_size)
1315                                         file_var->shrink_size = file_size;
1316
1317                                 break;
1318                         case YAFFS_OBJECT_TYPE_HARDLINK:
1319                                 hl_var = &in->variant.hardlink_variant;
1320                                 if (!is_unlinked) {
1321                                         hl_var->equiv_id = equiv_id;
1322                                         list_add(&in->hard_links, hard_list);
1323                                 }
1324                                 break;
1325                         case YAFFS_OBJECT_TYPE_DIRECTORY:
1326                                 /* Do nothing */
1327                                 break;
1328                         case YAFFS_OBJECT_TYPE_SPECIAL:
1329                                 /* Do nothing */
1330                                 break;
1331                         case YAFFS_OBJECT_TYPE_SYMLINK:
1332                                 sl_var = &in->variant.symlink_variant;
1333                                 if (oh) {
1334                                         sl_var->alias =
1335                                             yaffs_clone_str(oh->alias);
1336                                         if (!sl_var->alias)
1337                                                 alloc_failed = 1;
1338                                 }
1339                                 break;
1340                         }
1341                 }
1342         }
1343         return alloc_failed ? YAFFS_FAIL : YAFFS_OK;
1344 }
1345
1346 int yaffs2_scan_backwards(struct yaffs_dev *dev)
1347 {
1348         int blk;
1349         int block_iter;
1350         int start_iter;
1351         int end_iter;
1352         int n_to_scan = 0;
1353         enum yaffs_block_state state;
1354         int c;
1355         LIST_HEAD(hard_list);
1356         struct yaffs_block_info *bi;
1357         u32 seq_number;
1358         int n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
1359         u8 *chunk_data;
1360         int found_chunks;
1361         int alloc_failed = 0;
1362         struct yaffs_block_index *block_index = NULL;
1363         int alt_block_index = 0;
1364         int summary_available;
1365
1366         yaffs_trace(YAFFS_TRACE_SCAN,
1367                 "yaffs2_scan_backwards starts  intstartblk %d intendblk %d...",
1368                 dev->internal_start_block, dev->internal_end_block);
1369
1370         dev->seq_number = YAFFS_LOWEST_SEQUENCE_NUMBER;
1371
1372         block_index =
1373                 kmalloc(n_blocks * sizeof(struct yaffs_block_index), GFP_NOFS);
1374
1375         if (!block_index) {
1376                 block_index =
1377                     vmalloc(n_blocks * sizeof(struct yaffs_block_index));
1378                 alt_block_index = 1;
1379         }
1380
1381         if (!block_index) {
1382                 yaffs_trace(YAFFS_TRACE_SCAN,
1383                         "yaffs2_scan_backwards() could not allocate block index!"
1384                         );
1385                 return YAFFS_FAIL;
1386         }
1387
1388         dev->blocks_in_checkpt = 0;
1389
1390         chunk_data = yaffs_get_temp_buffer(dev);
1391
1392         /* Scan all the blocks to determine their state */
1393         bi = dev->block_info;
1394         for (blk = dev->internal_start_block; blk <= dev->internal_end_block;
1395              blk++) {
1396                 yaffs_clear_chunk_bits(dev, blk);
1397                 bi->pages_in_use = 0;
1398                 bi->soft_del_pages = 0;
1399
1400                 yaffs_query_init_block_state(dev, blk, &state, &seq_number);
1401
1402                 bi->block_state = state;
1403                 bi->seq_number = seq_number;
1404
1405                 if (bi->seq_number == YAFFS_SEQUENCE_CHECKPOINT_DATA)
1406                         bi->block_state = YAFFS_BLOCK_STATE_CHECKPOINT;
1407                 if (bi->seq_number == YAFFS_SEQUENCE_BAD_BLOCK)
1408                         bi->block_state = YAFFS_BLOCK_STATE_DEAD;
1409
1410                 yaffs_trace(YAFFS_TRACE_SCAN_DEBUG,
1411                         "Block scanning block %d state %d seq %d",
1412                         blk, bi->block_state, seq_number);
1413
1414                 if (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT) {
1415                         dev->blocks_in_checkpt++;
1416
1417                 } else if (bi->block_state == YAFFS_BLOCK_STATE_DEAD) {
1418                         yaffs_trace(YAFFS_TRACE_BAD_BLOCKS,
1419                                 "block %d is bad", blk);
1420                 } else if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
1421                         yaffs_trace(YAFFS_TRACE_SCAN_DEBUG, "Block empty ");
1422                         dev->n_erased_blocks++;
1423                         dev->n_free_chunks += dev->param.chunks_per_block;
1424                 } else if (bi->block_state ==
1425                                 YAFFS_BLOCK_STATE_NEEDS_SCAN) {
1426                         /* Determine the highest sequence number */
1427                         if (seq_number >= YAFFS_LOWEST_SEQUENCE_NUMBER &&
1428                             seq_number < YAFFS_HIGHEST_SEQUENCE_NUMBER) {
1429                                 block_index[n_to_scan].seq = seq_number;
1430                                 block_index[n_to_scan].block = blk;
1431                                 n_to_scan++;
1432                                 if (seq_number >= dev->seq_number)
1433                                         dev->seq_number = seq_number;
1434                         } else {
1435                                 /* TODO: Nasty sequence number! */
1436                                 yaffs_trace(YAFFS_TRACE_SCAN,
1437                                         "Block scanning block %d has bad sequence number %d",
1438                                         blk, seq_number);
1439                         }
1440                 }
1441                 bi++;
1442         }
1443
1444         yaffs_trace(YAFFS_TRACE_ALWAYS, "%d blocks to be sorted...", n_to_scan);
1445
1446         cond_resched();
1447
1448         /* Sort the blocks by sequence number */
1449         sort(block_index, n_to_scan, sizeof(struct yaffs_block_index),
1450                    yaffs2_ybicmp, NULL);
1451
1452         cond_resched();
1453
1454         yaffs_trace(YAFFS_TRACE_SCAN, "...done");
1455
1456         /* Now scan the blocks looking at the data. */
1457         start_iter = 0;
1458         end_iter = n_to_scan - 1;
1459         yaffs_trace(YAFFS_TRACE_SCAN_DEBUG, "%d blocks to scan", n_to_scan);
1460
1461         /* For each block.... backwards */
1462         for (block_iter = end_iter;
1463              !alloc_failed && block_iter >= start_iter;
1464              block_iter--) {
1465                 /* Cooperative multitasking! This loop can run for so
1466                    long that watchdog timers expire. */
1467                 cond_resched();
1468
1469                 /* get the block to scan in the correct order */
1470                 blk = block_index[block_iter].block;
1471                 bi = yaffs_get_block_info(dev, blk);
1472
1473                 summary_available = yaffs_summary_read(dev, dev->sum_tags, blk);
1474
1475                 /* For each chunk in each block that needs scanning.... */
1476                 found_chunks = 0;
1477                 if (summary_available)
1478                         c = dev->chunks_per_summary - 1;
1479                 else
1480                         c = dev->param.chunks_per_block - 1;
1481
1482                 for (/* c is already initialised */;
1483                      !alloc_failed && c >= 0 &&
1484                      (bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCAN ||
1485                       bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING);
1486                       c--) {
1487                         /* Scan backwards...
1488                          * Read the tags and decide what to do
1489                          */
1490                         if (yaffs2_scan_chunk(dev, bi, blk, c,
1491                                         &found_chunks, chunk_data,
1492                                         &hard_list, summary_available) ==
1493                                         YAFFS_FAIL)
1494                                 alloc_failed = 1;
1495                 }
1496
1497                 if (bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCAN) {
1498                         /* If we got this far while scanning, then the block
1499                          * is fully allocated. */
1500                         bi->block_state = YAFFS_BLOCK_STATE_FULL;
1501                 }
1502
1503                 /* Now let's see if it was dirty */
1504                 if (bi->pages_in_use == 0 &&
1505                     !bi->has_shrink_hdr &&
1506                     bi->block_state == YAFFS_BLOCK_STATE_FULL) {
1507                         yaffs_block_became_dirty(dev, blk);
1508                 }
1509         }
1510
1511         yaffs_skip_rest_of_block(dev);
1512
1513         if (alt_block_index)
1514                 vfree(block_index);
1515         else
1516                 kfree(block_index);
1517
1518         /* Ok, we've done all the scanning.
1519          * Fix up the hard link chains.
1520          * We have scanned all the objects, now it's time to add these
1521          * hardlinks.
1522          */
1523         yaffs_link_fixup(dev, &hard_list);
1524
1525         yaffs_release_temp_buffer(dev, chunk_data);
1526
1527         if (alloc_failed)
1528                 return YAFFS_FAIL;
1529
1530         yaffs_trace(YAFFS_TRACE_SCAN, "yaffs2_scan_backwards ends");
1531
1532         return YAFFS_OK;
1533 }