81ae37a400425ae696818bfa0cdd2180f6e4ba58
[yaffs2.git] / yaffs_guts.c
1 /*
2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
3  *
4  * Copyright (C) 2002-2007 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 const char *yaffs_guts_c_version =
15     "$Id: yaffs_guts.c,v 1.86 2009-07-28 03:04:54 charles Exp $";
16
17 #include "yportenv.h"
18
19 #include "yaffsinterface.h"
20 #include "yaffs_guts.h"
21 #include "yaffs_tagsvalidity.h"
22 #include "yaffs_getblockinfo.h"
23
24 #include "yaffs_tagscompat.h"
25 #ifndef CONFIG_YAFFS_USE_OWN_SORT
26 #include "yaffs_qsort.h"
27 #endif
28 #include "yaffs_nand.h"
29
30 #include "yaffs_checkptrw.h"
31
32 #include "yaffs_nand.h"
33 #include "yaffs_packedtags2.h"
34
35
36 #define YAFFS_PASSIVE_GC_CHUNKS 2
37
38 #include "yaffs_ecc.h"
39
40
41 /* Robustification (if it ever comes about...) */
42 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND);
43 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
44                 int erasedOk);
45 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
46                                 const __u8 *data,
47                                 const yaffs_ExtendedTags *tags);
48 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
49                                 const yaffs_ExtendedTags *tags);
50
51 /* Other local prototypes */
52 static void yaffs_UpdateParent(yaffs_Object *obj);
53 static int yaffs_UnlinkObject(yaffs_Object *obj);
54 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj);
55
56 static void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList);
57
58 static int yaffs_WriteNewChunkWithTagsToNAND(yaffs_Device *dev,
59                                         const __u8 *buffer,
60                                         yaffs_ExtendedTags *tags,
61                                         int useReserve);
62 static int yaffs_PutChunkIntoFile(yaffs_Object *in, int chunkInInode,
63                                 int chunkInNAND, int inScan);
64
65 static yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
66                                         yaffs_ObjectType type);
67 static void yaffs_AddObjectToDirectory(yaffs_Object *directory,
68                                 yaffs_Object *obj);
69 static int yaffs_UpdateObjectHeader(yaffs_Object *in, const YCHAR *name,
70                                 int force, int isShrink, int shadows);
71 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj);
72 static int yaffs_CheckStructures(void);
73 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level,
74                         int chunkOffset, int *limit);
75 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in);
76
77 static yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device *dev, int blockNo);
78
79
80 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
81                                 int chunkInNAND);
82
83 static int yaffs_UnlinkWorker(yaffs_Object *obj);
84
85 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId,
86                         int chunkInObject);
87
88 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
89                                 yaffs_BlockInfo **blockUsedPtr);
90
91 static void yaffs_VerifyFreeChunks(yaffs_Device *dev);
92
93 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in);
94
95 static void yaffs_VerifyDirectory(yaffs_Object *directory);
96 #ifdef YAFFS_PARANOID
97 static int yaffs_CheckFileSanity(yaffs_Object *in);
98 #else
99 #define yaffs_CheckFileSanity(in)
100 #endif
101
102 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in);
103 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId);
104
105 static void yaffs_InvalidateCheckpoint(yaffs_Device *dev);
106
107 static int yaffs_FindChunkInFile(yaffs_Object *in, int chunkInInode,
108                                 yaffs_ExtendedTags *tags);
109
110 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
111                 unsigned pos);
112 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
113                                         yaffs_FileStructure *fStruct,
114                                         __u32 chunkId);
115
116
117 /* Function to calculate chunk and offset */
118
119 static void yaffs_AddrToChunk(yaffs_Device *dev, loff_t addr, int *chunkOut,
120                 __u32 *offsetOut)
121 {
122         int chunk;
123         __u32 offset;
124
125         chunk  = (__u32)(addr >> dev->chunkShift);
126
127         if (dev->chunkDiv == 1) {
128                 /* easy power of 2 case */
129                 offset = (__u32)(addr & dev->chunkMask);
130         } else {
131                 /* Non power-of-2 case */
132
133                 loff_t chunkBase;
134
135                 chunk /= dev->chunkDiv;
136
137                 chunkBase = ((loff_t)chunk) * dev->nDataBytesPerChunk;
138                 offset = (__u32)(addr - chunkBase);
139         }
140
141         *chunkOut = chunk;
142         *offsetOut = offset;
143 }
144
145 /* Function to return the number of shifts for a power of 2 greater than or
146  * equal to the given number
147  * Note we don't try to cater for all possible numbers and this does not have to
148  * be hellishly efficient.
149  */
150
151 static __u32 ShiftsGE(__u32 x)
152 {
153         int extraBits;
154         int nShifts;
155
156         nShifts = extraBits = 0;
157
158         while (x > 1) {
159                 if (x & 1)
160                         extraBits++;
161                 x >>= 1;
162                 nShifts++;
163         }
164
165         if (extraBits)
166                 nShifts++;
167
168         return nShifts;
169 }
170
171 /* Function to return the number of shifts to get a 1 in bit 0
172  */
173
174 static __u32 Shifts(__u32 x)
175 {
176         int nShifts;
177
178         nShifts =  0;
179
180         if (!x)
181                 return 0;
182
183         while (!(x&1)) {
184                 x >>= 1;
185                 nShifts++;
186         }
187
188         return nShifts;
189 }
190
191
192
193 /*
194  * Temporary buffer manipulations.
195  */
196
197 static int yaffs_InitialiseTempBuffers(yaffs_Device *dev)
198 {
199         int i;
200         __u8 *buf = (__u8 *)1;
201
202         memset(dev->tempBuffer, 0, sizeof(dev->tempBuffer));
203
204         for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
205                 dev->tempBuffer[i].line = 0;    /* not in use */
206                 dev->tempBuffer[i].buffer = buf =
207                     YMALLOC_DMA(dev->totalBytesPerChunk);
208         }
209
210         return buf ? YAFFS_OK : YAFFS_FAIL;
211 }
212
213 __u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo)
214 {
215         int i, j;
216
217         dev->tempInUse++;
218         if (dev->tempInUse > dev->maxTemp)
219                 dev->maxTemp = dev->tempInUse;
220
221         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
222                 if (dev->tempBuffer[i].line == 0) {
223                         dev->tempBuffer[i].line = lineNo;
224                         if ((i + 1) > dev->maxTemp) {
225                                 dev->maxTemp = i + 1;
226                                 for (j = 0; j <= i; j++)
227                                         dev->tempBuffer[j].maxLine =
228                                             dev->tempBuffer[j].line;
229                         }
230
231                         return dev->tempBuffer[i].buffer;
232                 }
233         }
234
235         T(YAFFS_TRACE_BUFFERS,
236           (TSTR("Out of temp buffers at line %d, other held by lines:"),
237            lineNo));
238         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
239                 T(YAFFS_TRACE_BUFFERS, (TSTR(" %d "), dev->tempBuffer[i].line));
240
241         T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
242
243         /*
244          * If we got here then we have to allocate an unmanaged one
245          * This is not good.
246          */
247
248         dev->unmanagedTempAllocations++;
249         return YMALLOC(dev->nDataBytesPerChunk);
250
251 }
252
253 void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer,
254                                     int lineNo)
255 {
256         int i;
257
258         dev->tempInUse--;
259
260         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
261                 if (dev->tempBuffer[i].buffer == buffer) {
262                         dev->tempBuffer[i].line = 0;
263                         return;
264                 }
265         }
266
267         if (buffer) {
268                 /* assume it is an unmanaged one. */
269                 T(YAFFS_TRACE_BUFFERS,
270                   (TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),
271                    lineNo));
272                 YFREE(buffer);
273                 dev->unmanagedTempDeallocations++;
274         }
275
276 }
277
278 /*
279  * Determine if we have a managed buffer.
280  */
281 int yaffs_IsManagedTempBuffer(yaffs_Device *dev, const __u8 *buffer)
282 {
283         int i;
284
285         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
286                 if (dev->tempBuffer[i].buffer == buffer)
287                         return 1;
288         }
289
290         for (i = 0; i < dev->nShortOpCaches; i++) {
291                 if (dev->srCache[i].data == buffer)
292                         return 1;
293         }
294
295         if (buffer == dev->checkpointBuffer)
296                 return 1;
297
298         T(YAFFS_TRACE_ALWAYS,
299                 (TSTR("yaffs: unmaged buffer detected.\n" TENDSTR)));
300         return 0;
301 }
302
303
304
305 /*
306  * Chunk bitmap manipulations
307  */
308
309 static Y_INLINE __u8 *yaffs_BlockBits(yaffs_Device *dev, int blk)
310 {
311         if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
312                 T(YAFFS_TRACE_ERROR,
313                         (TSTR("**>> yaffs: BlockBits block %d is not valid" TENDSTR),
314                         blk));
315                 YBUG();
316         }
317         return dev->chunkBits +
318                 (dev->chunkBitmapStride * (blk - dev->internalStartBlock));
319 }
320
321 static Y_INLINE void yaffs_VerifyChunkBitId(yaffs_Device *dev, int blk, int chunk)
322 {
323         if (blk < dev->internalStartBlock || blk > dev->internalEndBlock ||
324                         chunk < 0 || chunk >= dev->nChunksPerBlock) {
325                 T(YAFFS_TRACE_ERROR,
326                 (TSTR("**>> yaffs: Chunk Id (%d:%d) invalid"TENDSTR),
327                         blk, chunk));
328                 YBUG();
329         }
330 }
331
332 static Y_INLINE void yaffs_ClearChunkBits(yaffs_Device *dev, int blk)
333 {
334         __u8 *blkBits = yaffs_BlockBits(dev, blk);
335
336         memset(blkBits, 0, dev->chunkBitmapStride);
337 }
338
339 static Y_INLINE void yaffs_ClearChunkBit(yaffs_Device *dev, int blk, int chunk)
340 {
341         __u8 *blkBits = yaffs_BlockBits(dev, blk);
342
343         yaffs_VerifyChunkBitId(dev, blk, chunk);
344
345         blkBits[chunk / 8] &= ~(1 << (chunk & 7));
346 }
347
348 static Y_INLINE void yaffs_SetChunkBit(yaffs_Device *dev, int blk, int chunk)
349 {
350         __u8 *blkBits = yaffs_BlockBits(dev, blk);
351
352         yaffs_VerifyChunkBitId(dev, blk, chunk);
353
354         blkBits[chunk / 8] |= (1 << (chunk & 7));
355 }
356
357 static Y_INLINE int yaffs_CheckChunkBit(yaffs_Device *dev, int blk, int chunk)
358 {
359         __u8 *blkBits = yaffs_BlockBits(dev, blk);
360         yaffs_VerifyChunkBitId(dev, blk, chunk);
361
362         return (blkBits[chunk / 8] & (1 << (chunk & 7))) ? 1 : 0;
363 }
364
365 static Y_INLINE int yaffs_StillSomeChunkBits(yaffs_Device *dev, int blk)
366 {
367         __u8 *blkBits = yaffs_BlockBits(dev, blk);
368         int i;
369         for (i = 0; i < dev->chunkBitmapStride; i++) {
370                 if (*blkBits)
371                         return 1;
372                 blkBits++;
373         }
374         return 0;
375 }
376
377 static int yaffs_CountChunkBits(yaffs_Device *dev, int blk)
378 {
379         __u8 *blkBits = yaffs_BlockBits(dev, blk);
380         int i;
381         int n = 0;
382         for (i = 0; i < dev->chunkBitmapStride; i++) {
383                 __u8 x = *blkBits;
384                 while (x) {
385                         if (x & 1)
386                                 n++;
387                         x >>= 1;
388                 }
389
390                 blkBits++;
391         }
392         return n;
393 }
394
395 /*
396  * Verification code
397  */
398
399 static int yaffs_SkipVerification(yaffs_Device *dev)
400 {
401         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY | YAFFS_TRACE_VERIFY_FULL));
402 }
403
404 static int yaffs_SkipFullVerification(yaffs_Device *dev)
405 {
406         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_FULL));
407 }
408
409 static int yaffs_SkipNANDVerification(yaffs_Device *dev)
410 {
411         return !(yaffs_traceMask & (YAFFS_TRACE_VERIFY_NAND));
412 }
413
414 static const char *blockStateName[] = {
415 "Unknown",
416 "Needs scanning",
417 "Scanning",
418 "Empty",
419 "Allocating",
420 "Full",
421 "Dirty",
422 "Checkpoint",
423 "Collecting",
424 "Dead"
425 };
426
427 static void yaffs_VerifyBlock(yaffs_Device *dev, yaffs_BlockInfo *bi, int n)
428 {
429         int actuallyUsed;
430         int inUse;
431
432         if (yaffs_SkipVerification(dev))
433                 return;
434
435         /* Report illegal runtime states */
436         if (bi->blockState >= YAFFS_NUMBER_OF_BLOCK_STATES)
437                 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has undefined state %d"TENDSTR), n, bi->blockState));
438
439         switch (bi->blockState) {
440         case YAFFS_BLOCK_STATE_UNKNOWN:
441         case YAFFS_BLOCK_STATE_SCANNING:
442         case YAFFS_BLOCK_STATE_NEEDS_SCANNING:
443                 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has bad run-state %s"TENDSTR),
444                 n, blockStateName[bi->blockState]));
445         }
446
447         /* Check pages in use and soft deletions are legal */
448
449         actuallyUsed = bi->pagesInUse - bi->softDeletions;
450
451         if (bi->pagesInUse < 0 || bi->pagesInUse > dev->nChunksPerBlock ||
452            bi->softDeletions < 0 || bi->softDeletions > dev->nChunksPerBlock ||
453            actuallyUsed < 0 || actuallyUsed > dev->nChunksPerBlock)
454                 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has illegal values pagesInUsed %d softDeletions %d"TENDSTR),
455                 n, bi->pagesInUse, bi->softDeletions));
456
457
458         /* Check chunk bitmap legal */
459         inUse = yaffs_CountChunkBits(dev, n);
460         if (inUse != bi->pagesInUse)
461                 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has inconsistent values pagesInUse %d counted chunk bits %d"TENDSTR),
462                         n, bi->pagesInUse, inUse));
463
464         /* Check that the sequence number is valid.
465          * Ten million is legal, but is very unlikely
466          */
467         if (dev->isYaffs2 &&
468            (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING || bi->blockState == YAFFS_BLOCK_STATE_FULL) &&
469            (bi->sequenceNumber < YAFFS_LOWEST_SEQUENCE_NUMBER || bi->sequenceNumber > 10000000))
470                 T(YAFFS_TRACE_VERIFY, (TSTR("Block %d has suspect sequence number of %d"TENDSTR),
471                 n, bi->sequenceNumber));
472 }
473
474 static void yaffs_VerifyCollectedBlock(yaffs_Device *dev, yaffs_BlockInfo *bi,
475                 int n)
476 {
477         yaffs_VerifyBlock(dev, bi, n);
478
479         /* After collection the block should be in the erased state */
480         /* This will need to change if we do partial gc */
481
482         if (bi->blockState != YAFFS_BLOCK_STATE_COLLECTING &&
483                         bi->blockState != YAFFS_BLOCK_STATE_EMPTY) {
484                 T(YAFFS_TRACE_ERROR, (TSTR("Block %d is in state %d after gc, should be erased"TENDSTR),
485                         n, bi->blockState));
486         }
487 }
488
489 static void yaffs_VerifyBlocks(yaffs_Device *dev)
490 {
491         int i;
492         int nBlocksPerState[YAFFS_NUMBER_OF_BLOCK_STATES];
493         int nIllegalBlockStates = 0;
494
495         if (yaffs_SkipVerification(dev))
496                 return;
497
498         memset(nBlocksPerState, 0, sizeof(nBlocksPerState));
499
500         for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
501                 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, i);
502                 yaffs_VerifyBlock(dev, bi, i);
503
504                 if (bi->blockState < YAFFS_NUMBER_OF_BLOCK_STATES)
505                         nBlocksPerState[bi->blockState]++;
506                 else
507                         nIllegalBlockStates++;
508         }
509
510         T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
511         T(YAFFS_TRACE_VERIFY, (TSTR("Block summary"TENDSTR)));
512
513         T(YAFFS_TRACE_VERIFY, (TSTR("%d blocks have illegal states"TENDSTR), nIllegalBlockStates));
514         if (nBlocksPerState[YAFFS_BLOCK_STATE_ALLOCATING] > 1)
515                 T(YAFFS_TRACE_VERIFY, (TSTR("Too many allocating blocks"TENDSTR)));
516
517         for (i = 0; i < YAFFS_NUMBER_OF_BLOCK_STATES; i++)
518                 T(YAFFS_TRACE_VERIFY,
519                   (TSTR("%s %d blocks"TENDSTR),
520                   blockStateName[i], nBlocksPerState[i]));
521
522         if (dev->blocksInCheckpoint != nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT])
523                 T(YAFFS_TRACE_VERIFY,
524                  (TSTR("Checkpoint block count wrong dev %d count %d"TENDSTR),
525                  dev->blocksInCheckpoint, nBlocksPerState[YAFFS_BLOCK_STATE_CHECKPOINT]));
526
527         if (dev->nErasedBlocks != nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY])
528                 T(YAFFS_TRACE_VERIFY,
529                  (TSTR("Erased block count wrong dev %d count %d"TENDSTR),
530                  dev->nErasedBlocks, nBlocksPerState[YAFFS_BLOCK_STATE_EMPTY]));
531
532         if (nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING] > 1)
533                 T(YAFFS_TRACE_VERIFY,
534                  (TSTR("Too many collecting blocks %d (max is 1)"TENDSTR),
535                  nBlocksPerState[YAFFS_BLOCK_STATE_COLLECTING]));
536
537         T(YAFFS_TRACE_VERIFY, (TSTR(""TENDSTR)));
538
539 }
540
541 /*
542  * Verify the object header. oh must be valid, but obj and tags may be NULL in which
543  * case those tests will not be performed.
544  */
545 static void yaffs_VerifyObjectHeader(yaffs_Object *obj, yaffs_ObjectHeader *oh, yaffs_ExtendedTags *tags, int parentCheck)
546 {
547         if (obj && yaffs_SkipVerification(obj->myDev))
548                 return;
549
550         if (!(tags && obj && oh)) {
551                 T(YAFFS_TRACE_VERIFY,
552                                 (TSTR("Verifying object header tags %x obj %x oh %x"TENDSTR),
553                                 (__u32)tags, (__u32)obj, (__u32)oh));
554                 return;
555         }
556
557         if (oh->type <= YAFFS_OBJECT_TYPE_UNKNOWN ||
558                         oh->type > YAFFS_OBJECT_TYPE_MAX)
559                 T(YAFFS_TRACE_VERIFY,
560                         (TSTR("Obj %d header type is illegal value 0x%x"TENDSTR),
561                         tags->objectId, oh->type));
562
563         if (tags->objectId != obj->objectId)
564                 T(YAFFS_TRACE_VERIFY,
565                         (TSTR("Obj %d header mismatch objectId %d"TENDSTR),
566                         tags->objectId, obj->objectId));
567
568
569         /*
570          * Check that the object's parent ids match if parentCheck requested.
571          *
572          * Tests do not apply to the root object.
573          */
574
575         if (parentCheck && tags->objectId > 1 && !obj->parent)
576                 T(YAFFS_TRACE_VERIFY,
577                         (TSTR("Obj %d header mismatch parentId %d obj->parent is NULL"TENDSTR),
578                         tags->objectId, oh->parentObjectId));
579
580         if (parentCheck && obj->parent &&
581                         oh->parentObjectId != obj->parent->objectId &&
582                         (oh->parentObjectId != YAFFS_OBJECTID_UNLINKED ||
583                         obj->parent->objectId != YAFFS_OBJECTID_DELETED))
584                 T(YAFFS_TRACE_VERIFY,
585                         (TSTR("Obj %d header mismatch parentId %d parentObjectId %d"TENDSTR),
586                         tags->objectId, oh->parentObjectId, obj->parent->objectId));
587
588         if (tags->objectId > 1 && oh->name[0] == 0) /* Null name */
589                 T(YAFFS_TRACE_VERIFY,
590                         (TSTR("Obj %d header name is NULL"TENDSTR),
591                         obj->objectId));
592
593         if (tags->objectId > 1 && ((__u8)(oh->name[0])) == 0xff) /* Trashed name */
594                 T(YAFFS_TRACE_VERIFY,
595                         (TSTR("Obj %d header name is 0xFF"TENDSTR),
596                         obj->objectId));
597 }
598
599
600
601 static int yaffs_VerifyTnodeWorker(yaffs_Object *obj, yaffs_Tnode *tn,
602                                         __u32 level, int chunkOffset)
603 {
604         int i;
605         yaffs_Device *dev = obj->myDev;
606         int ok = 1;
607
608         if (tn) {
609                 if (level > 0) {
610
611                         for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++) {
612                                 if (tn->internal[i]) {
613                                         ok = yaffs_VerifyTnodeWorker(obj,
614                                                         tn->internal[i],
615                                                         level - 1,
616                                                         (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
617                                 }
618                         }
619                 } else if (level == 0) {
620                         yaffs_ExtendedTags tags;
621                         __u32 objectId = obj->objectId;
622
623                         chunkOffset <<=  YAFFS_TNODES_LEVEL0_BITS;
624
625                         for (i = 0; i < YAFFS_NTNODES_LEVEL0; i++) {
626                                 __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
627
628                                 if (theChunk > 0) {
629                                         /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),tags.objectId,tags.chunkId,theChunk)); */
630                                         yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL, &tags);
631                                         if (tags.objectId != objectId || tags.chunkId != chunkOffset) {
632                                                 T(~0, (TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
633                                                         objectId, chunkOffset, theChunk,
634                                                         tags.objectId, tags.chunkId));
635                                         }
636                                 }
637                                 chunkOffset++;
638                         }
639                 }
640         }
641
642         return ok;
643
644 }
645
646
647 static void yaffs_VerifyFile(yaffs_Object *obj)
648 {
649         int requiredTallness;
650         int actualTallness;
651         __u32 lastChunk;
652         __u32 x;
653         __u32 i;
654         yaffs_Device *dev;
655         yaffs_ExtendedTags tags;
656         yaffs_Tnode *tn;
657         __u32 objectId;
658
659         if (!obj)
660                 return;
661
662         if (yaffs_SkipVerification(obj->myDev))
663                 return;
664
665         dev = obj->myDev;
666         objectId = obj->objectId;
667
668         /* Check file size is consistent with tnode depth */
669         lastChunk =  obj->variant.fileVariant.fileSize / dev->nDataBytesPerChunk + 1;
670         x = lastChunk >> YAFFS_TNODES_LEVEL0_BITS;
671         requiredTallness = 0;
672         while (x > 0) {
673                 x >>= YAFFS_TNODES_INTERNAL_BITS;
674                 requiredTallness++;
675         }
676
677         actualTallness = obj->variant.fileVariant.topLevel;
678
679         if (requiredTallness > actualTallness)
680                 T(YAFFS_TRACE_VERIFY,
681                 (TSTR("Obj %d had tnode tallness %d, needs to be %d"TENDSTR),
682                  obj->objectId, actualTallness, requiredTallness));
683
684
685         /* Check that the chunks in the tnode tree are all correct.
686          * We do this by scanning through the tnode tree and
687          * checking the tags for every chunk match.
688          */
689
690         if (yaffs_SkipNANDVerification(dev))
691                 return;
692
693         for (i = 1; i <= lastChunk; i++) {
694                 tn = yaffs_FindLevel0Tnode(dev, &obj->variant.fileVariant, i);
695
696                 if (tn) {
697                         __u32 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
698                         if (theChunk > 0) {
699                                 /* T(~0,(TSTR("verifying (%d:%d) %d"TENDSTR),objectId,i,theChunk)); */
700                                 yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL, &tags);
701                                 if (tags.objectId != objectId || tags.chunkId != i) {
702                                         T(~0, (TSTR("Object %d chunkId %d NAND mismatch chunk %d tags (%d:%d)"TENDSTR),
703                                                 objectId, i, theChunk,
704                                                 tags.objectId, tags.chunkId));
705                                 }
706                         }
707                 }
708         }
709 }
710
711
712 static void yaffs_VerifyHardLink(yaffs_Object *obj)
713 {
714         if (obj && yaffs_SkipVerification(obj->myDev))
715                 return;
716
717         /* Verify sane equivalent object */
718 }
719
720 static void yaffs_VerifySymlink(yaffs_Object *obj)
721 {
722         if (obj && yaffs_SkipVerification(obj->myDev))
723                 return;
724
725         /* Verify symlink string */
726 }
727
728 static void yaffs_VerifySpecial(yaffs_Object *obj)
729 {
730         if (obj && yaffs_SkipVerification(obj->myDev))
731                 return;
732 }
733
734 static void yaffs_VerifyObject(yaffs_Object *obj)
735 {
736         yaffs_Device *dev;
737
738         __u32 chunkMin;
739         __u32 chunkMax;
740
741         __u32 chunkIdOk;
742         __u32 chunkInRange;
743         __u32 chunkShouldNotBeDeleted;
744         __u32 chunkValid;
745
746         if (!obj)
747                 return;
748
749         if (obj->beingCreated)
750                 return;
751
752         dev = obj->myDev;
753
754         if (yaffs_SkipVerification(dev))
755                 return;
756
757         /* Check sane object header chunk */
758
759         chunkMin = dev->internalStartBlock * dev->nChunksPerBlock;
760         chunkMax = (dev->internalEndBlock+1) * dev->nChunksPerBlock - 1;
761
762         chunkInRange = (((unsigned)(obj->hdrChunk)) >= chunkMin && ((unsigned)(obj->hdrChunk)) <= chunkMax);
763         chunkIdOk = chunkInRange || (obj->hdrChunk == 0);
764         chunkValid = chunkInRange &&
765                         yaffs_CheckChunkBit(dev,
766                                         obj->hdrChunk / dev->nChunksPerBlock,
767                                         obj->hdrChunk % dev->nChunksPerBlock);
768         chunkShouldNotBeDeleted = chunkInRange && !chunkValid;
769
770         if (!obj->fake &&
771                         (!chunkIdOk || chunkShouldNotBeDeleted)) {
772                 T(YAFFS_TRACE_VERIFY,
773                         (TSTR("Obj %d has chunkId %d %s %s"TENDSTR),
774                         obj->objectId, obj->hdrChunk,
775                         chunkIdOk ? "" : ",out of range",
776                         chunkShouldNotBeDeleted ? ",marked as deleted" : ""));
777         }
778
779         if (chunkValid && !yaffs_SkipNANDVerification(dev)) {
780                 yaffs_ExtendedTags tags;
781                 yaffs_ObjectHeader *oh;
782                 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
783
784                 oh = (yaffs_ObjectHeader *)buffer;
785
786                 yaffs_ReadChunkWithTagsFromNAND(dev, obj->hdrChunk, buffer,
787                                 &tags);
788
789                 yaffs_VerifyObjectHeader(obj, oh, &tags, 1);
790
791                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
792         }
793
794         /* Verify it has a parent */
795         if (obj && !obj->fake &&
796                         (!obj->parent || obj->parent->myDev != dev)) {
797                 T(YAFFS_TRACE_VERIFY,
798                         (TSTR("Obj %d has parent pointer %p which does not look like an object"TENDSTR),
799                         obj->objectId, obj->parent));
800         }
801
802         /* Verify parent is a directory */
803         if (obj->parent && obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
804                 T(YAFFS_TRACE_VERIFY,
805                         (TSTR("Obj %d's parent is not a directory (type %d)"TENDSTR),
806                         obj->objectId, obj->parent->variantType));
807         }
808
809         switch (obj->variantType) {
810         case YAFFS_OBJECT_TYPE_FILE:
811                 yaffs_VerifyFile(obj);
812                 break;
813         case YAFFS_OBJECT_TYPE_SYMLINK:
814                 yaffs_VerifySymlink(obj);
815                 break;
816         case YAFFS_OBJECT_TYPE_DIRECTORY:
817                 yaffs_VerifyDirectory(obj);
818                 break;
819         case YAFFS_OBJECT_TYPE_HARDLINK:
820                 yaffs_VerifyHardLink(obj);
821                 break;
822         case YAFFS_OBJECT_TYPE_SPECIAL:
823                 yaffs_VerifySpecial(obj);
824                 break;
825         case YAFFS_OBJECT_TYPE_UNKNOWN:
826         default:
827                 T(YAFFS_TRACE_VERIFY,
828                 (TSTR("Obj %d has illegaltype %d"TENDSTR),
829                 obj->objectId, obj->variantType));
830                 break;
831         }
832 }
833
834 static void yaffs_VerifyObjects(yaffs_Device *dev)
835 {
836         yaffs_Object *obj;
837         int i;
838         struct ylist_head *lh;
839
840         if (yaffs_SkipVerification(dev))
841                 return;
842
843         /* Iterate through the objects in each hash entry */
844
845         for (i = 0; i <  YAFFS_NOBJECT_BUCKETS; i++) {
846                 ylist_for_each(lh, &dev->objectBucket[i].list) {
847                         if (lh) {
848                                 obj = ylist_entry(lh, yaffs_Object, hashLink);
849                                 yaffs_VerifyObject(obj);
850                         }
851                 }
852         }
853 }
854
855
856 /*
857  *  Simple hash function. Needs to have a reasonable spread
858  */
859
860 static Y_INLINE int yaffs_HashFunction(int n)
861 {
862         n = abs(n);
863         return n % YAFFS_NOBJECT_BUCKETS;
864 }
865
866 /*
867  * Access functions to useful fake objects.
868  * Note that root might have a presence in NAND if permissions are set.
869  */
870
871 yaffs_Object *yaffs_Root(yaffs_Device *dev)
872 {
873         return dev->rootDir;
874 }
875
876 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev)
877 {
878         return dev->lostNFoundDir;
879 }
880
881
882 /*
883  *  Erased NAND checking functions
884  */
885
886 int yaffs_CheckFF(__u8 *buffer, int nBytes)
887 {
888         /* Horrible, slow implementation */
889         while (nBytes--) {
890                 if (*buffer != 0xFF)
891                         return 0;
892                 buffer++;
893         }
894         return 1;
895 }
896
897 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,
898                                 int chunkInNAND)
899 {
900         int retval = YAFFS_OK;
901         __u8 *data = yaffs_GetTempBuffer(dev, __LINE__);
902         yaffs_ExtendedTags tags;
903         int result;
904
905         result = yaffs_ReadChunkWithTagsFromNAND(dev, chunkInNAND, data, &tags);
906
907         if (tags.eccResult > YAFFS_ECC_RESULT_NO_ERROR)
908                 retval = YAFFS_FAIL;
909
910         if (!yaffs_CheckFF(data, dev->nDataBytesPerChunk) || tags.chunkUsed) {
911                 T(YAFFS_TRACE_NANDACCESS,
912                   (TSTR("Chunk %d not erased" TENDSTR), chunkInNAND));
913                 retval = YAFFS_FAIL;
914         }
915
916         yaffs_ReleaseTempBuffer(dev, data, __LINE__);
917
918         return retval;
919
920 }
921
922 static int yaffs_WriteNewChunkWithTagsToNAND(struct yaffs_DeviceStruct *dev,
923                                         const __u8 *data,
924                                         yaffs_ExtendedTags *tags,
925                                         int useReserve)
926 {
927         int attempts = 0;
928         int writeOk = 0;
929         int chunk;
930
931         yaffs_InvalidateCheckpoint(dev);
932
933         do {
934                 yaffs_BlockInfo *bi = 0;
935                 int erasedOk = 0;
936
937                 chunk = yaffs_AllocateChunk(dev, useReserve, &bi);
938                 if (chunk < 0) {
939                         /* no space */
940                         break;
941                 }
942
943                 /* First check this chunk is erased, if it needs
944                  * checking.  The checking policy (unless forced
945                  * always on) is as follows:
946                  *
947                  * Check the first page we try to write in a block.
948                  * If the check passes then we don't need to check any
949                  * more.        If the check fails, we check again...
950                  * If the block has been erased, we don't need to check.
951                  *
952                  * However, if the block has been prioritised for gc,
953                  * then we think there might be something odd about
954                  * this block and stop using it.
955                  *
956                  * Rationale: We should only ever see chunks that have
957                  * not been erased if there was a partially written
958                  * chunk due to power loss.  This checking policy should
959                  * catch that case with very few checks and thus save a
960                  * lot of checks that are most likely not needed.
961                  */
962                 if (bi->gcPrioritise) {
963                         yaffs_DeleteChunk(dev, chunk, 1, __LINE__);
964                         /* try another chunk */
965                         continue;
966                 }
967
968                 /* let's give it a try */
969                 attempts++;
970
971 #ifdef CONFIG_YAFFS_ALWAYS_CHECK_CHUNK_ERASED
972                 bi->skipErasedCheck = 0;
973 #endif
974                 if (!bi->skipErasedCheck) {
975                         erasedOk = yaffs_CheckChunkErased(dev, chunk);
976                         if (erasedOk != YAFFS_OK) {
977                                 T(YAFFS_TRACE_ERROR,
978                                 (TSTR("**>> yaffs chunk %d was not erased"
979                                 TENDSTR), chunk));
980
981                                 /* try another chunk */
982                                 continue;
983                         }
984                         bi->skipErasedCheck = 1;
985                 }
986
987                 writeOk = yaffs_WriteChunkWithTagsToNAND(dev, chunk,
988                                 data, tags);
989                 if (writeOk != YAFFS_OK) {
990                         yaffs_HandleWriteChunkError(dev, chunk, erasedOk);
991                         /* try another chunk */
992                         continue;
993                 }
994
995                 /* Copy the data into the robustification buffer */
996                 yaffs_HandleWriteChunkOk(dev, chunk, data, tags);
997
998         } while (writeOk != YAFFS_OK &&
999                 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
1000
1001         if (!writeOk)
1002                 chunk = -1;
1003
1004         if (attempts > 1) {
1005                 T(YAFFS_TRACE_ERROR,
1006                         (TSTR("**>> yaffs write required %d attempts" TENDSTR),
1007                         attempts));
1008
1009                 dev->nRetriedWrites += (attempts - 1);
1010         }
1011
1012         return chunk;
1013 }
1014
1015 /*
1016  * Block retiring for handling a broken block.
1017  */
1018
1019 static void yaffs_RetireBlock(yaffs_Device *dev, int blockInNAND)
1020 {
1021         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1022
1023         yaffs_InvalidateCheckpoint(dev);
1024
1025         if (yaffs_MarkBlockBad(dev, blockInNAND) != YAFFS_OK) {
1026                 if (yaffs_EraseBlockInNAND(dev, blockInNAND) != YAFFS_OK) {
1027                         T(YAFFS_TRACE_ALWAYS, (TSTR(
1028                                 "yaffs: Failed to mark bad and erase block %d"
1029                                 TENDSTR), blockInNAND));
1030                 } else {
1031                         yaffs_ExtendedTags tags;
1032                         int chunkId = blockInNAND * dev->nChunksPerBlock;
1033
1034                         __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
1035
1036                         memset(buffer, 0xff, dev->nDataBytesPerChunk);
1037                         yaffs_InitialiseTags(&tags);
1038                         tags.sequenceNumber = YAFFS_SEQUENCE_BAD_BLOCK;
1039                         if (dev->writeChunkWithTagsToNAND(dev, chunkId -
1040                                 dev->chunkOffset, buffer, &tags) != YAFFS_OK)
1041                                 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Failed to "
1042                                         TCONT("write bad block marker to block %d")
1043                                         TENDSTR), blockInNAND));
1044
1045                         yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
1046                 }
1047         }
1048
1049         bi->blockState = YAFFS_BLOCK_STATE_DEAD;
1050         bi->gcPrioritise = 0;
1051         bi->needsRetiring = 0;
1052
1053         dev->nRetiredBlocks++;
1054 }
1055
1056 /*
1057  * Functions for robustisizing TODO
1058  *
1059  */
1060
1061 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev, int chunkInNAND,
1062                                 const __u8 *data,
1063                                 const yaffs_ExtendedTags *tags)
1064 {
1065 }
1066
1067 static void yaffs_HandleUpdateChunk(yaffs_Device *dev, int chunkInNAND,
1068                                 const yaffs_ExtendedTags *tags)
1069 {
1070 }
1071
1072 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi)
1073 {
1074         if (!bi->gcPrioritise) {
1075                 bi->gcPrioritise = 1;
1076                 dev->hasPendingPrioritisedGCs = 1;
1077                 bi->chunkErrorStrikes++;
1078
1079                 if (bi->chunkErrorStrikes > 3) {
1080                         bi->needsRetiring = 1; /* Too many stikes, so retire this */
1081                         T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Block struck out" TENDSTR)));
1082
1083                 }
1084         }
1085 }
1086
1087 static void yaffs_HandleWriteChunkError(yaffs_Device *dev, int chunkInNAND,
1088                 int erasedOk)
1089 {
1090         int blockInNAND = chunkInNAND / dev->nChunksPerBlock;
1091         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockInNAND);
1092
1093         yaffs_HandleChunkError(dev, bi);
1094
1095         if (erasedOk) {
1096                 /* Was an actual write failure, so mark the block for retirement  */
1097                 bi->needsRetiring = 1;
1098                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1099                   (TSTR("**>> Block %d needs retiring" TENDSTR), blockInNAND));
1100         }
1101
1102         /* Delete the chunk */
1103         yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
1104 }
1105
1106
1107 /*---------------- Name handling functions ------------*/
1108
1109 static __u16 yaffs_CalcNameSum(const YCHAR *name)
1110 {
1111         __u16 sum = 0;
1112         __u16 i = 1;
1113
1114         const YUCHAR *bname = (const YUCHAR *) name;
1115         if (bname) {
1116                 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH/2))) {
1117
1118 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1119                         sum += yaffs_toupper(*bname) * i;
1120 #else
1121                         sum += (*bname) * i;
1122 #endif
1123                         i++;
1124                         bname++;
1125                 }
1126         }
1127         return sum;
1128 }
1129
1130 static void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name)
1131 {
1132 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
1133         memset(obj->shortName, 0, sizeof(YCHAR) * (YAFFS_SHORT_NAME_LENGTH+1));
1134         if (name && yaffs_strlen(name) <= YAFFS_SHORT_NAME_LENGTH)
1135                 yaffs_strcpy(obj->shortName, name);
1136         else
1137                 obj->shortName[0] = _Y('\0');
1138 #endif
1139         obj->sum = yaffs_CalcNameSum(name);
1140 }
1141
1142 /*-------------------- TNODES -------------------
1143
1144  * List of spare tnodes
1145  * The list is hooked together using the first pointer
1146  * in the tnode.
1147  */
1148
1149 /* yaffs_CreateTnodes creates a bunch more tnodes and
1150  * adds them to the tnode free list.
1151  * Don't use this function directly
1152  */
1153
1154 static int yaffs_CreateTnodes(yaffs_Device *dev, int nTnodes)
1155 {
1156         int i;
1157         int tnodeSize;
1158         yaffs_Tnode *newTnodes;
1159         __u8 *mem;
1160         yaffs_Tnode *curr;
1161         yaffs_Tnode *next;
1162         yaffs_TnodeList *tnl;
1163
1164         if (nTnodes < 1)
1165                 return YAFFS_OK;
1166
1167         /* Calculate the tnode size in bytes for variable width tnode support.
1168          * Must be a multiple of 32-bits  */
1169         tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
1170
1171         if (tnodeSize < sizeof(yaffs_Tnode))
1172                 tnodeSize = sizeof(yaffs_Tnode);
1173
1174         /* make these things */
1175
1176         newTnodes = YMALLOC(nTnodes * tnodeSize);
1177         mem = (__u8 *)newTnodes;
1178
1179         if (!newTnodes) {
1180                 T(YAFFS_TRACE_ERROR,
1181                         (TSTR("yaffs: Could not allocate Tnodes" TENDSTR)));
1182                 return YAFFS_FAIL;
1183         }
1184
1185         /* Hook them into the free list */
1186 #if 0
1187         for (i = 0; i < nTnodes - 1; i++) {
1188                 newTnodes[i].internal[0] = &newTnodes[i + 1];
1189 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1190                 newTnodes[i].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1191 #endif
1192         }
1193
1194         newTnodes[nTnodes - 1].internal[0] = dev->freeTnodes;
1195 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1196         newTnodes[nTnodes - 1].internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1197 #endif
1198         dev->freeTnodes = newTnodes;
1199 #else
1200         /* New hookup for wide tnodes */
1201         for (i = 0; i < nTnodes - 1; i++) {
1202                 curr = (yaffs_Tnode *) &mem[i * tnodeSize];
1203                 next = (yaffs_Tnode *) &mem[(i+1) * tnodeSize];
1204                 curr->internal[0] = next;
1205         }
1206
1207         curr = (yaffs_Tnode *) &mem[(nTnodes - 1) * tnodeSize];
1208         curr->internal[0] = dev->freeTnodes;
1209         dev->freeTnodes = (yaffs_Tnode *)mem;
1210
1211 #endif
1212
1213
1214         dev->nFreeTnodes += nTnodes;
1215         dev->nTnodesCreated += nTnodes;
1216
1217         /* Now add this bunch of tnodes to a list for freeing up.
1218          * NB If we can't add this to the management list it isn't fatal
1219          * but it just means we can't free this bunch of tnodes later.
1220          */
1221
1222         tnl = YMALLOC(sizeof(yaffs_TnodeList));
1223         if (!tnl) {
1224                 T(YAFFS_TRACE_ERROR,
1225                   (TSTR
1226                    ("yaffs: Could not add tnodes to management list" TENDSTR)));
1227                    return YAFFS_FAIL;
1228         } else {
1229                 tnl->tnodes = newTnodes;
1230                 tnl->next = dev->allocatedTnodeList;
1231                 dev->allocatedTnodeList = tnl;
1232         }
1233
1234         T(YAFFS_TRACE_ALLOCATE, (TSTR("yaffs: Tnodes added" TENDSTR)));
1235
1236         return YAFFS_OK;
1237 }
1238
1239 /* GetTnode gets us a clean tnode. Tries to make allocate more if we run out */
1240
1241 static yaffs_Tnode *yaffs_GetTnodeRaw(yaffs_Device *dev)
1242 {
1243         yaffs_Tnode *tn = NULL;
1244
1245         /* If there are none left make more */
1246         if (!dev->freeTnodes)
1247                 yaffs_CreateTnodes(dev, YAFFS_ALLOCATION_NTNODES);
1248
1249         if (dev->freeTnodes) {
1250                 tn = dev->freeTnodes;
1251 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1252                 if (tn->internal[YAFFS_NTNODES_INTERNAL] != (void *)1) {
1253                         /* Hoosterman, this thing looks like it isn't in the list */
1254                         T(YAFFS_TRACE_ALWAYS,
1255                           (TSTR("yaffs: Tnode list bug 1" TENDSTR)));
1256                 }
1257 #endif
1258                 dev->freeTnodes = dev->freeTnodes->internal[0];
1259                 dev->nFreeTnodes--;
1260         }
1261
1262         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1263
1264         return tn;
1265 }
1266
1267 static yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev)
1268 {
1269         yaffs_Tnode *tn = yaffs_GetTnodeRaw(dev);
1270         int tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
1271
1272         if (tnodeSize < sizeof(yaffs_Tnode))
1273                 tnodeSize = sizeof(yaffs_Tnode);
1274
1275         if (tn)
1276                 memset(tn, 0, tnodeSize);
1277
1278         return tn;
1279 }
1280
1281 /* FreeTnode frees up a tnode and puts it back on the free list */
1282 static void yaffs_FreeTnode(yaffs_Device *dev, yaffs_Tnode *tn)
1283 {
1284         if (tn) {
1285 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
1286                 if (tn->internal[YAFFS_NTNODES_INTERNAL] != 0) {
1287                         /* Hoosterman, this thing looks like it is already in the list */
1288                         T(YAFFS_TRACE_ALWAYS,
1289                           (TSTR("yaffs: Tnode list bug 2" TENDSTR)));
1290                 }
1291                 tn->internal[YAFFS_NTNODES_INTERNAL] = (void *)1;
1292 #endif
1293                 tn->internal[0] = dev->freeTnodes;
1294                 dev->freeTnodes = tn;
1295                 dev->nFreeTnodes++;
1296         }
1297         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1298 }
1299
1300 static void yaffs_DeinitialiseTnodes(yaffs_Device *dev)
1301 {
1302         /* Free the list of allocated tnodes */
1303         yaffs_TnodeList *tmp;
1304
1305         while (dev->allocatedTnodeList) {
1306                 tmp = dev->allocatedTnodeList->next;
1307
1308                 YFREE(dev->allocatedTnodeList->tnodes);
1309                 YFREE(dev->allocatedTnodeList);
1310                 dev->allocatedTnodeList = tmp;
1311
1312         }
1313
1314         dev->freeTnodes = NULL;
1315         dev->nFreeTnodes = 0;
1316 }
1317
1318 static void yaffs_InitialiseTnodes(yaffs_Device *dev)
1319 {
1320         dev->allocatedTnodeList = NULL;
1321         dev->freeTnodes = NULL;
1322         dev->nFreeTnodes = 0;
1323         dev->nTnodesCreated = 0;
1324 }
1325
1326
1327 void yaffs_PutLevel0Tnode(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos,
1328                 unsigned val)
1329 {
1330         __u32 *map = (__u32 *)tn;
1331         __u32 bitInMap;
1332         __u32 bitInWord;
1333         __u32 wordInMap;
1334         __u32 mask;
1335
1336         pos &= YAFFS_TNODES_LEVEL0_MASK;
1337         val >>= dev->chunkGroupBits;
1338
1339         bitInMap = pos * dev->tnodeWidth;
1340         wordInMap = bitInMap / 32;
1341         bitInWord = bitInMap & (32 - 1);
1342
1343         mask = dev->tnodeMask << bitInWord;
1344
1345         map[wordInMap] &= ~mask;
1346         map[wordInMap] |= (mask & (val << bitInWord));
1347
1348         if (dev->tnodeWidth > (32 - bitInWord)) {
1349                 bitInWord = (32 - bitInWord);
1350                 wordInMap++;;
1351                 mask = dev->tnodeMask >> (/*dev->tnodeWidth -*/ bitInWord);
1352                 map[wordInMap] &= ~mask;
1353                 map[wordInMap] |= (mask & (val >> bitInWord));
1354         }
1355 }
1356
1357 static __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn,
1358                 unsigned pos)
1359 {
1360         __u32 *map = (__u32 *)tn;
1361         __u32 bitInMap;
1362         __u32 bitInWord;
1363         __u32 wordInMap;
1364         __u32 val;
1365
1366         pos &= YAFFS_TNODES_LEVEL0_MASK;
1367
1368         bitInMap = pos * dev->tnodeWidth;
1369         wordInMap = bitInMap / 32;
1370         bitInWord = bitInMap & (32 - 1);
1371
1372         val = map[wordInMap] >> bitInWord;
1373
1374         if      (dev->tnodeWidth > (32 - bitInWord)) {
1375                 bitInWord = (32 - bitInWord);
1376                 wordInMap++;;
1377                 val |= (map[wordInMap] << bitInWord);
1378         }
1379
1380         val &= dev->tnodeMask;
1381         val <<= dev->chunkGroupBits;
1382
1383         return val;
1384 }
1385
1386 /* ------------------- End of individual tnode manipulation -----------------*/
1387
1388 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
1389  * The look up tree is represented by the top tnode and the number of topLevel
1390  * in the tree. 0 means only the level 0 tnode is in the tree.
1391  */
1392
1393 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
1394 static yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
1395                                         yaffs_FileStructure *fStruct,
1396                                         __u32 chunkId)
1397 {
1398         yaffs_Tnode *tn = fStruct->top;
1399         __u32 i;
1400         int requiredTallness;
1401         int level = fStruct->topLevel;
1402
1403         /* Check sane level and chunk Id */
1404         if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
1405                 return NULL;
1406
1407         if (chunkId > YAFFS_MAX_CHUNK_ID)
1408                 return NULL;
1409
1410         /* First check we're tall enough (ie enough topLevel) */
1411
1412         i = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1413         requiredTallness = 0;
1414         while (i) {
1415                 i >>= YAFFS_TNODES_INTERNAL_BITS;
1416                 requiredTallness++;
1417         }
1418
1419         if (requiredTallness > fStruct->topLevel)
1420                 return NULL; /* Not tall enough, so we can't find it */
1421
1422         /* Traverse down to level 0 */
1423         while (level > 0 && tn) {
1424                 tn = tn->internal[(chunkId >>
1425                         (YAFFS_TNODES_LEVEL0_BITS +
1426                                 (level - 1) *
1427                                 YAFFS_TNODES_INTERNAL_BITS)) &
1428                         YAFFS_TNODES_INTERNAL_MASK];
1429                 level--;
1430         }
1431
1432         return tn;
1433 }
1434
1435 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
1436  * This happens in two steps:
1437  *  1. If the tree isn't tall enough, then make it taller.
1438  *  2. Scan down the tree towards the level 0 tnode adding tnodes if required.
1439  *
1440  * Used when modifying the tree.
1441  *
1442  *  If the tn argument is NULL, then a fresh tnode will be added otherwise the specified tn will
1443  *  be plugged into the ttree.
1444  */
1445
1446 static yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev,
1447                                         yaffs_FileStructure *fStruct,
1448                                         __u32 chunkId,
1449                                         yaffs_Tnode *passedTn)
1450 {
1451         int requiredTallness;
1452         int i;
1453         int l;
1454         yaffs_Tnode *tn;
1455
1456         __u32 x;
1457
1458
1459         /* Check sane level and page Id */
1460         if (fStruct->topLevel < 0 || fStruct->topLevel > YAFFS_TNODES_MAX_LEVEL)
1461                 return NULL;
1462
1463         if (chunkId > YAFFS_MAX_CHUNK_ID)
1464                 return NULL;
1465
1466         /* First check we're tall enough (ie enough topLevel) */
1467
1468         x = chunkId >> YAFFS_TNODES_LEVEL0_BITS;
1469         requiredTallness = 0;
1470         while (x) {
1471                 x >>= YAFFS_TNODES_INTERNAL_BITS;
1472                 requiredTallness++;
1473         }
1474
1475
1476         if (requiredTallness > fStruct->topLevel) {
1477                 /* Not tall enough, gotta make the tree taller */
1478                 for (i = fStruct->topLevel; i < requiredTallness; i++) {
1479
1480                         tn = yaffs_GetTnode(dev);
1481
1482                         if (tn) {
1483                                 tn->internal[0] = fStruct->top;
1484                                 fStruct->top = tn;
1485                         } else {
1486                                 T(YAFFS_TRACE_ERROR,
1487                                   (TSTR("yaffs: no more tnodes" TENDSTR)));
1488                         }
1489                 }
1490
1491                 fStruct->topLevel = requiredTallness;
1492         }
1493
1494         /* Traverse down to level 0, adding anything we need */
1495
1496         l = fStruct->topLevel;
1497         tn = fStruct->top;
1498
1499         if (l > 0) {
1500                 while (l > 0 && tn) {
1501                         x = (chunkId >>
1502                              (YAFFS_TNODES_LEVEL0_BITS +
1503                               (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
1504                             YAFFS_TNODES_INTERNAL_MASK;
1505
1506
1507                         if ((l > 1) && !tn->internal[x]) {
1508                                 /* Add missing non-level-zero tnode */
1509                                 tn->internal[x] = yaffs_GetTnode(dev);
1510
1511                         } else if (l == 1) {
1512                                 /* Looking from level 1 at level 0 */
1513                                 if (passedTn) {
1514                                         /* If we already have one, then release it.*/
1515                                         if (tn->internal[x])
1516                                                 yaffs_FreeTnode(dev, tn->internal[x]);
1517                                         tn->internal[x] = passedTn;
1518
1519                                 } else if (!tn->internal[x]) {
1520                                         /* Don't have one, none passed in */
1521                                         tn->internal[x] = yaffs_GetTnode(dev);
1522                                 }
1523                         }
1524
1525                         tn = tn->internal[x];
1526                         l--;
1527                 }
1528         } else {
1529                 /* top is level 0 */
1530                 if (passedTn) {
1531                         memcpy(tn, passedTn, (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8);
1532                         yaffs_FreeTnode(dev, passedTn);
1533                 }
1534         }
1535
1536         return tn;
1537 }
1538
1539 static int yaffs_FindChunkInGroup(yaffs_Device *dev, int theChunk,
1540                                 yaffs_ExtendedTags *tags, int objectId,
1541                                 int chunkInInode)
1542 {
1543         int j;
1544
1545         for (j = 0; theChunk && j < dev->chunkGroupSize; j++) {
1546                 if (yaffs_CheckChunkBit(dev, theChunk / dev->nChunksPerBlock,
1547                                 theChunk % dev->nChunksPerBlock)) {
1548                         yaffs_ReadChunkWithTagsFromNAND(dev, theChunk, NULL,
1549                                                         tags);
1550                         if (yaffs_TagsMatch(tags, objectId, chunkInInode)) {
1551                                 /* found it; */
1552                                 return theChunk;
1553                         }
1554                 }
1555                 theChunk++;
1556         }
1557         return -1;
1558 }
1559
1560
1561 /* DeleteWorker scans backwards through the tnode tree and deletes all the
1562  * chunks and tnodes in the file
1563  * Returns 1 if the tree was deleted.
1564  * Returns 0 if it stopped early due to hitting the limit and the delete is incomplete.
1565  */
1566
1567 static int yaffs_DeleteWorker(yaffs_Object *in, yaffs_Tnode *tn, __u32 level,
1568                               int chunkOffset, int *limit)
1569 {
1570         int i;
1571         int chunkInInode;
1572         int theChunk;
1573         yaffs_ExtendedTags tags;
1574         int foundChunk;
1575         yaffs_Device *dev = in->myDev;
1576
1577         int allDone = 1;
1578
1579         if (tn) {
1580                 if (level > 0) {
1581                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1582                              i--) {
1583                                 if (tn->internal[i]) {
1584                                         if (limit && (*limit) < 0) {
1585                                                 allDone = 0;
1586                                         } else {
1587                                                 allDone =
1588                                                         yaffs_DeleteWorker(in,
1589                                                                 tn->
1590                                                                 internal
1591                                                                 [i],
1592                                                                 level -
1593                                                                 1,
1594                                                                 (chunkOffset
1595                                                                         <<
1596                                                                         YAFFS_TNODES_INTERNAL_BITS)
1597                                                                 + i,
1598                                                                 limit);
1599                                         }
1600                                         if (allDone) {
1601                                                 yaffs_FreeTnode(dev,
1602                                                                 tn->
1603                                                                 internal[i]);
1604                                                 tn->internal[i] = NULL;
1605                                         }
1606                                 }
1607                         }
1608                         return (allDone) ? 1 : 0;
1609                 } else if (level == 0) {
1610                         int hitLimit = 0;
1611
1612                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0 && !hitLimit;
1613                                         i--) {
1614                                 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1615                                 if (theChunk) {
1616
1617                                         chunkInInode = (chunkOffset <<
1618                                                 YAFFS_TNODES_LEVEL0_BITS) + i;
1619
1620                                         foundChunk =
1621                                                 yaffs_FindChunkInGroup(dev,
1622                                                                 theChunk,
1623                                                                 &tags,
1624                                                                 in->objectId,
1625                                                                 chunkInInode);
1626
1627                                         if (foundChunk > 0) {
1628                                                 yaffs_DeleteChunk(dev,
1629                                                                   foundChunk, 1,
1630                                                                   __LINE__);
1631                                                 in->nDataChunks--;
1632                                                 if (limit) {
1633                                                         *limit = *limit - 1;
1634                                                         if (*limit <= 0)
1635                                                                 hitLimit = 1;
1636                                                 }
1637
1638                                         }
1639
1640                                         yaffs_PutLevel0Tnode(dev, tn, i, 0);
1641                                 }
1642
1643                         }
1644                         return (i < 0) ? 1 : 0;
1645
1646                 }
1647
1648         }
1649
1650         return 1;
1651
1652 }
1653
1654 static void yaffs_SoftDeleteChunk(yaffs_Device *dev, int chunk)
1655 {
1656         yaffs_BlockInfo *theBlock;
1657
1658         T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
1659
1660         theBlock = yaffs_GetBlockInfo(dev, chunk / dev->nChunksPerBlock);
1661         if (theBlock) {
1662                 theBlock->softDeletions++;
1663                 dev->nFreeChunks++;
1664         }
1665 }
1666
1667 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
1668  * All soft deleting does is increment the block's softdelete count and pulls the chunk out
1669  * of the tnode.
1670  * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
1671  */
1672
1673 static int yaffs_SoftDeleteWorker(yaffs_Object *in, yaffs_Tnode *tn,
1674                                   __u32 level, int chunkOffset)
1675 {
1676         int i;
1677         int theChunk;
1678         int allDone = 1;
1679         yaffs_Device *dev = in->myDev;
1680
1681         if (tn) {
1682                 if (level > 0) {
1683
1684                         for (i = YAFFS_NTNODES_INTERNAL - 1; allDone && i >= 0;
1685                              i--) {
1686                                 if (tn->internal[i]) {
1687                                         allDone =
1688                                             yaffs_SoftDeleteWorker(in,
1689                                                                    tn->
1690                                                                    internal[i],
1691                                                                    level - 1,
1692                                                                    (chunkOffset
1693                                                                     <<
1694                                                                     YAFFS_TNODES_INTERNAL_BITS)
1695                                                                    + i);
1696                                         if (allDone) {
1697                                                 yaffs_FreeTnode(dev,
1698                                                                 tn->
1699                                                                 internal[i]);
1700                                                 tn->internal[i] = NULL;
1701                                         } else {
1702                                                 /* Hoosterman... how could this happen? */
1703                                         }
1704                                 }
1705                         }
1706                         return (allDone) ? 1 : 0;
1707                 } else if (level == 0) {
1708
1709                         for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1710                                 theChunk = yaffs_GetChunkGroupBase(dev, tn, i);
1711                                 if (theChunk) {
1712                                         /* Note this does not find the real chunk, only the chunk group.
1713                                          * We make an assumption that a chunk group is not larger than
1714                                          * a block.
1715                                          */
1716                                         yaffs_SoftDeleteChunk(dev, theChunk);
1717                                         yaffs_PutLevel0Tnode(dev, tn, i, 0);
1718                                 }
1719
1720                         }
1721                         return 1;
1722
1723                 }
1724
1725         }
1726
1727         return 1;
1728
1729 }
1730
1731 static void yaffs_SoftDeleteFile(yaffs_Object *obj)
1732 {
1733         if (obj->deleted &&
1734             obj->variantType == YAFFS_OBJECT_TYPE_FILE && !obj->softDeleted) {
1735                 if (obj->nDataChunks <= 0) {
1736                         /* Empty file with no duplicate object headers, just delete it immediately */
1737                         yaffs_FreeTnode(obj->myDev,
1738                                         obj->variant.fileVariant.top);
1739                         obj->variant.fileVariant.top = NULL;
1740                         T(YAFFS_TRACE_TRACING,
1741                           (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1742                            obj->objectId));
1743                         yaffs_DoGenericObjectDeletion(obj);
1744                 } else {
1745                         yaffs_SoftDeleteWorker(obj,
1746                                                obj->variant.fileVariant.top,
1747                                                obj->variant.fileVariant.
1748                                                topLevel, 0);
1749                         obj->softDeleted = 1;
1750                 }
1751         }
1752 }
1753
1754 /* Pruning removes any part of the file structure tree that is beyond the
1755  * bounds of the file (ie that does not point to chunks).
1756  *
1757  * A file should only get pruned when its size is reduced.
1758  *
1759  * Before pruning, the chunks must be pulled from the tree and the
1760  * level 0 tnode entries must be zeroed out.
1761  * Could also use this for file deletion, but that's probably better handled
1762  * by a special case.
1763  */
1764
1765 static yaffs_Tnode *yaffs_PruneWorker(yaffs_Device *dev, yaffs_Tnode *tn,
1766                                 __u32 level, int del0)
1767 {
1768         int i;
1769         int hasData;
1770
1771         if (tn) {
1772                 hasData = 0;
1773
1774                 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1775                         if (tn->internal[i] && level > 0) {
1776                                 tn->internal[i] =
1777                                     yaffs_PruneWorker(dev, tn->internal[i],
1778                                                       level - 1,
1779                                                       (i == 0) ? del0 : 1);
1780                         }
1781
1782                         if (tn->internal[i])
1783                                 hasData++;
1784                 }
1785
1786                 if (hasData == 0 && del0) {
1787                         /* Free and return NULL */
1788
1789                         yaffs_FreeTnode(dev, tn);
1790                         tn = NULL;
1791                 }
1792
1793         }
1794
1795         return tn;
1796
1797 }
1798
1799 static int yaffs_PruneFileStructure(yaffs_Device *dev,
1800                                 yaffs_FileStructure *fStruct)
1801 {
1802         int i;
1803         int hasData;
1804         int done = 0;
1805         yaffs_Tnode *tn;
1806
1807         if (fStruct->topLevel > 0) {
1808                 fStruct->top =
1809                     yaffs_PruneWorker(dev, fStruct->top, fStruct->topLevel, 0);
1810
1811                 /* Now we have a tree with all the non-zero branches NULL but the height
1812                  * is the same as it was.
1813                  * Let's see if we can trim internal tnodes to shorten the tree.
1814                  * We can do this if only the 0th element in the tnode is in use
1815                  * (ie all the non-zero are NULL)
1816                  */
1817
1818                 while (fStruct->topLevel && !done) {
1819                         tn = fStruct->top;
1820
1821                         hasData = 0;
1822                         for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1823                                 if (tn->internal[i])
1824                                         hasData++;
1825                         }
1826
1827                         if (!hasData) {
1828                                 fStruct->top = tn->internal[0];
1829                                 fStruct->topLevel--;
1830                                 yaffs_FreeTnode(dev, tn);
1831                         } else {
1832                                 done = 1;
1833                         }
1834                 }
1835         }
1836
1837         return YAFFS_OK;
1838 }
1839
1840 /*-------------------- End of File Structure functions.-------------------*/
1841
1842 /* yaffs_CreateFreeObjects creates a bunch more objects and
1843  * adds them to the object free list.
1844  */
1845 static int yaffs_CreateFreeObjects(yaffs_Device *dev, int nObjects)
1846 {
1847         int i;
1848         yaffs_Object *newObjects;
1849         yaffs_ObjectList *list;
1850
1851         if (nObjects < 1)
1852                 return YAFFS_OK;
1853
1854         /* make these things */
1855         newObjects = YMALLOC(nObjects * sizeof(yaffs_Object));
1856         list = YMALLOC(sizeof(yaffs_ObjectList));
1857
1858         if (!newObjects || !list) {
1859                 if (newObjects)
1860                         YFREE(newObjects);
1861                 if (list)
1862                         YFREE(list);
1863                 T(YAFFS_TRACE_ALLOCATE,
1864                   (TSTR("yaffs: Could not allocate more objects" TENDSTR)));
1865                 return YAFFS_FAIL;
1866         }
1867
1868         /* Hook them into the free list */
1869         for (i = 0; i < nObjects - 1; i++) {
1870                 newObjects[i].siblings.next =
1871                                 (struct ylist_head *)(&newObjects[i + 1]);
1872         }
1873
1874         newObjects[nObjects - 1].siblings.next = (void *)dev->freeObjects;
1875         dev->freeObjects = newObjects;
1876         dev->nFreeObjects += nObjects;
1877         dev->nObjectsCreated += nObjects;
1878
1879         /* Now add this bunch of Objects to a list for freeing up. */
1880
1881         list->objects = newObjects;
1882         list->next = dev->allocatedObjectList;
1883         dev->allocatedObjectList = list;
1884
1885         return YAFFS_OK;
1886 }
1887
1888
1889 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
1890 static yaffs_Object *yaffs_AllocateEmptyObject(yaffs_Device *dev)
1891 {
1892         yaffs_Object *tn = NULL;
1893
1894 #ifdef VALGRIND_TEST
1895         tn = YMALLOC(sizeof(yaffs_Object));
1896 #else
1897         /* If there are none left make more */
1898         if (!dev->freeObjects)
1899                 yaffs_CreateFreeObjects(dev, YAFFS_ALLOCATION_NOBJECTS);
1900
1901         if (dev->freeObjects) {
1902                 tn = dev->freeObjects;
1903                 dev->freeObjects =
1904                         (yaffs_Object *) (dev->freeObjects->siblings.next);
1905                 dev->nFreeObjects--;
1906         }
1907 #endif
1908         if (tn) {
1909                 /* Now sweeten it up... */
1910
1911                 memset(tn, 0, sizeof(yaffs_Object));
1912                 tn->beingCreated = 1;
1913
1914                 tn->myDev = dev;
1915                 tn->hdrChunk = 0;
1916                 tn->variantType = YAFFS_OBJECT_TYPE_UNKNOWN;
1917                 YINIT_LIST_HEAD(&(tn->hardLinks));
1918                 YINIT_LIST_HEAD(&(tn->hashLink));
1919                 YINIT_LIST_HEAD(&tn->siblings);
1920
1921
1922                 /* Now make the directory sane */
1923                 if (dev->rootDir) {
1924                         tn->parent = dev->rootDir;
1925                         ylist_add(&(tn->siblings), &dev->rootDir->variant.directoryVariant.children);
1926                 }
1927
1928                 /* Add it to the lost and found directory.
1929                  * NB Can't put root or lostNFound in lostNFound so
1930                  * check if lostNFound exists first
1931                  */
1932                 if (dev->lostNFoundDir)
1933                         yaffs_AddObjectToDirectory(dev->lostNFoundDir, tn);
1934
1935                 tn->beingCreated = 0;
1936         }
1937
1938         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
1939
1940         return tn;
1941 }
1942
1943 static yaffs_Object *yaffs_CreateFakeDirectory(yaffs_Device *dev, int number,
1944                                                __u32 mode)
1945 {
1946
1947         yaffs_Object *obj =
1948             yaffs_CreateNewObject(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1949         if (obj) {
1950                 obj->fake = 1;          /* it is fake so it might have no NAND presence... */
1951                 obj->renameAllowed = 0; /* ... and we're not allowed to rename it... */
1952                 obj->unlinkAllowed = 0; /* ... or unlink it */
1953                 obj->deleted = 0;
1954                 obj->unlinked = 0;
1955                 obj->yst_mode = mode;
1956                 obj->myDev = dev;
1957                 obj->hdrChunk = 0;      /* Not a valid chunk. */
1958         }
1959
1960         return obj;
1961
1962 }
1963
1964 static void yaffs_UnhashObject(yaffs_Object *tn)
1965 {
1966         int bucket;
1967         yaffs_Device *dev = tn->myDev;
1968
1969         /* If it is still linked into the bucket list, free from the list */
1970         if (!ylist_empty(&tn->hashLink)) {
1971                 ylist_del_init(&tn->hashLink);
1972                 bucket = yaffs_HashFunction(tn->objectId);
1973                 dev->objectBucket[bucket].count--;
1974         }
1975 }
1976
1977 /*  FreeObject frees up a Object and puts it back on the free list */
1978 static void yaffs_FreeObject(yaffs_Object *tn)
1979 {
1980         yaffs_Device *dev = tn->myDev;
1981
1982 #ifdef __KERNEL__
1983         T(YAFFS_TRACE_OS, (TSTR("FreeObject %p inode %p"TENDSTR), tn, tn->myInode));
1984 #endif
1985
1986         if (tn->parent)
1987                 YBUG();
1988         if (!ylist_empty(&tn->siblings))
1989                 YBUG();
1990
1991
1992 #ifdef __KERNEL__
1993         if (tn->myInode) {
1994                 /* We're still hooked up to a cached inode.
1995                  * Don't delete now, but mark for later deletion
1996                  */
1997                 tn->deferedFree = 1;
1998                 return;
1999         }
2000 #endif
2001
2002         yaffs_UnhashObject(tn);
2003
2004 #ifdef VALGRIND_TEST
2005         YFREE(tn);
2006 #else
2007         /* Link into the free list. */
2008         tn->siblings.next = (struct ylist_head *)(dev->freeObjects);
2009         dev->freeObjects = tn;
2010         dev->nFreeObjects++;
2011 #endif
2012         dev->nCheckpointBlocksRequired = 0; /* force recalculation*/
2013 }
2014
2015 #ifdef __KERNEL__
2016
2017 void yaffs_HandleDeferedFree(yaffs_Object *obj)
2018 {
2019         if (obj->deferedFree)
2020                 yaffs_FreeObject(obj);
2021 }
2022
2023 #endif
2024
2025 static void yaffs_DeinitialiseObjects(yaffs_Device *dev)
2026 {
2027         /* Free the list of allocated Objects */
2028
2029         yaffs_ObjectList *tmp;
2030
2031         while (dev->allocatedObjectList) {
2032                 tmp = dev->allocatedObjectList->next;
2033                 YFREE(dev->allocatedObjectList->objects);
2034                 YFREE(dev->allocatedObjectList);
2035
2036                 dev->allocatedObjectList = tmp;
2037         }
2038
2039         dev->freeObjects = NULL;
2040         dev->nFreeObjects = 0;
2041 }
2042
2043 static void yaffs_InitialiseObjects(yaffs_Device *dev)
2044 {
2045         int i;
2046
2047         dev->allocatedObjectList = NULL;
2048         dev->freeObjects = NULL;
2049         dev->nFreeObjects = 0;
2050
2051         for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2052                 YINIT_LIST_HEAD(&dev->objectBucket[i].list);
2053                 dev->objectBucket[i].count = 0;
2054         }
2055 }
2056
2057 static int yaffs_FindNiceObjectBucket(yaffs_Device *dev)
2058 {
2059         static int x;
2060         int i;
2061         int l = 999;
2062         int lowest = 999999;
2063
2064         /* First let's see if we can find one that's empty. */
2065
2066         for (i = 0; i < 10 && lowest > 0; i++) {
2067                 x++;
2068                 x %= YAFFS_NOBJECT_BUCKETS;
2069                 if (dev->objectBucket[x].count < lowest) {
2070                         lowest = dev->objectBucket[x].count;
2071                         l = x;
2072                 }
2073
2074         }
2075
2076         /* If we didn't find an empty list, then try
2077          * looking a bit further for a short one
2078          */
2079
2080         for (i = 0; i < 10 && lowest > 3; i++) {
2081                 x++;
2082                 x %= YAFFS_NOBJECT_BUCKETS;
2083                 if (dev->objectBucket[x].count < lowest) {
2084                         lowest = dev->objectBucket[x].count;
2085                         l = x;
2086                 }
2087
2088         }
2089
2090         return l;
2091 }
2092
2093 static int yaffs_CreateNewObjectNumber(yaffs_Device *dev)
2094 {
2095         int bucket = yaffs_FindNiceObjectBucket(dev);
2096
2097         /* Now find an object value that has not already been taken
2098          * by scanning the list.
2099          */
2100
2101         int found = 0;
2102         struct ylist_head *i;
2103
2104         __u32 n = (__u32) bucket;
2105
2106         /* yaffs_CheckObjectHashSanity();  */
2107
2108         while (!found) {
2109                 found = 1;
2110                 n += YAFFS_NOBJECT_BUCKETS;
2111                 if (1 || dev->objectBucket[bucket].count > 0) {
2112                         ylist_for_each(i, &dev->objectBucket[bucket].list) {
2113                                 /* If there is already one in the list */
2114                                 if (i && ylist_entry(i, yaffs_Object,
2115                                                 hashLink)->objectId == n) {
2116                                         found = 0;
2117                                 }
2118                         }
2119                 }
2120         }
2121
2122         return n;
2123 }
2124
2125 static void yaffs_HashObject(yaffs_Object *in)
2126 {
2127         int bucket = yaffs_HashFunction(in->objectId);
2128         yaffs_Device *dev = in->myDev;
2129
2130         ylist_add(&in->hashLink, &dev->objectBucket[bucket].list);
2131         dev->objectBucket[bucket].count++;
2132 }
2133
2134 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number)
2135 {
2136         int bucket = yaffs_HashFunction(number);
2137         struct ylist_head *i;
2138         yaffs_Object *in;
2139
2140         ylist_for_each(i, &dev->objectBucket[bucket].list) {
2141                 /* Look if it is in the list */
2142                 if (i) {
2143                         in = ylist_entry(i, yaffs_Object, hashLink);
2144                         if (in->objectId == number) {
2145 #ifdef __KERNEL__
2146                                 /* Don't tell the VFS about this one if it is defered free */
2147                                 if (in->deferedFree)
2148                                         return NULL;
2149 #endif
2150
2151                                 return in;
2152                         }
2153                 }
2154         }
2155
2156         return NULL;
2157 }
2158
2159 yaffs_Object *yaffs_CreateNewObject(yaffs_Device *dev, int number,
2160                                     yaffs_ObjectType type)
2161 {
2162         yaffs_Object *theObject;
2163         yaffs_Tnode *tn = NULL;
2164
2165         if (number < 0)
2166                 number = yaffs_CreateNewObjectNumber(dev);
2167
2168         theObject = yaffs_AllocateEmptyObject(dev);
2169         if (!theObject)
2170                 return NULL;
2171
2172         if (type == YAFFS_OBJECT_TYPE_FILE) {
2173                 tn = yaffs_GetTnode(dev);
2174                 if (!tn) {
2175                         yaffs_FreeObject(theObject);
2176                         return NULL;
2177                 }
2178         }
2179
2180         if (theObject) {
2181                 theObject->fake = 0;
2182                 theObject->renameAllowed = 1;
2183                 theObject->unlinkAllowed = 1;
2184                 theObject->objectId = number;
2185                 yaffs_HashObject(theObject);
2186                 theObject->variantType = type;
2187 #ifdef CONFIG_YAFFS_WINCE
2188                 yfsd_WinFileTimeNow(theObject->win_atime);
2189                 theObject->win_ctime[0] = theObject->win_mtime[0] =
2190                     theObject->win_atime[0];
2191                 theObject->win_ctime[1] = theObject->win_mtime[1] =
2192                     theObject->win_atime[1];
2193
2194 #else
2195
2196                 theObject->yst_atime = theObject->yst_mtime =
2197                     theObject->yst_ctime = Y_CURRENT_TIME;
2198 #endif
2199                 switch (type) {
2200                 case YAFFS_OBJECT_TYPE_FILE:
2201                         theObject->variant.fileVariant.fileSize = 0;
2202                         theObject->variant.fileVariant.scannedFileSize = 0;
2203                         theObject->variant.fileVariant.shrinkSize = 0xFFFFFFFF; /* max __u32 */
2204                         theObject->variant.fileVariant.topLevel = 0;
2205                         theObject->variant.fileVariant.top = tn;
2206                         break;
2207                 case YAFFS_OBJECT_TYPE_DIRECTORY:
2208                         YINIT_LIST_HEAD(&theObject->variant.directoryVariant.
2209                                         children);
2210                         break;
2211                 case YAFFS_OBJECT_TYPE_SYMLINK:
2212                 case YAFFS_OBJECT_TYPE_HARDLINK:
2213                 case YAFFS_OBJECT_TYPE_SPECIAL:
2214                         /* No action required */
2215                         break;
2216                 case YAFFS_OBJECT_TYPE_UNKNOWN:
2217                         /* todo this should not happen */
2218                         break;
2219                 }
2220         }
2221
2222         return theObject;
2223 }
2224
2225 static yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev,
2226                                                       int number,
2227                                                       yaffs_ObjectType type)
2228 {
2229         yaffs_Object *theObject = NULL;
2230
2231         if (number > 0)
2232                 theObject = yaffs_FindObjectByNumber(dev, number);
2233
2234         if (!theObject)
2235                 theObject = yaffs_CreateNewObject(dev, number, type);
2236
2237         return theObject;
2238
2239 }
2240
2241
2242 static YCHAR *yaffs_CloneString(const YCHAR *str)
2243 {
2244         YCHAR *newStr = NULL;
2245
2246         if (str && *str) {
2247                 newStr = YMALLOC((yaffs_strlen(str) + 1) * sizeof(YCHAR));
2248                 if (newStr)
2249                         yaffs_strcpy(newStr, str);
2250         }
2251
2252         return newStr;
2253
2254 }
2255
2256 /*
2257  * Mknod (create) a new object.
2258  * equivalentObject only has meaning for a hard link;
2259  * aliasString only has meaning for a sumlink.
2260  * rdev only has meaning for devices (a subset of special objects)
2261  */
2262
2263 static yaffs_Object *yaffs_MknodObject(yaffs_ObjectType type,
2264                                        yaffs_Object *parent,
2265                                        const YCHAR *name,
2266                                        __u32 mode,
2267                                        __u32 uid,
2268                                        __u32 gid,
2269                                        yaffs_Object *equivalentObject,
2270                                        const YCHAR *aliasString, __u32 rdev)
2271 {
2272         yaffs_Object *in;
2273         YCHAR *str = NULL;
2274
2275         yaffs_Device *dev = parent->myDev;
2276
2277         /* Check if the entry exists. If it does then fail the call since we don't want a dup.*/
2278         if (yaffs_FindObjectByName(parent, name))
2279                 return NULL;
2280
2281         in = yaffs_CreateNewObject(dev, -1, type);
2282
2283         if (!in)
2284                 return YAFFS_FAIL;
2285
2286         if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2287                 str = yaffs_CloneString(aliasString);
2288                 if (!str) {
2289                         yaffs_FreeObject(in);
2290                         return NULL;
2291                 }
2292         }
2293
2294
2295
2296         if (in) {
2297                 in->hdrChunk = 0;
2298                 in->valid = 1;
2299                 in->variantType = type;
2300
2301                 in->yst_mode = mode;
2302
2303 #ifdef CONFIG_YAFFS_WINCE
2304                 yfsd_WinFileTimeNow(in->win_atime);
2305                 in->win_ctime[0] = in->win_mtime[0] = in->win_atime[0];
2306                 in->win_ctime[1] = in->win_mtime[1] = in->win_atime[1];
2307
2308 #else
2309                 in->yst_atime = in->yst_mtime = in->yst_ctime = Y_CURRENT_TIME;
2310
2311                 in->yst_rdev = rdev;
2312                 in->yst_uid = uid;
2313                 in->yst_gid = gid;
2314 #endif
2315                 in->nDataChunks = 0;
2316
2317                 yaffs_SetObjectName(in, name);
2318                 in->dirty = 1;
2319
2320                 yaffs_AddObjectToDirectory(parent, in);
2321
2322                 in->myDev = parent->myDev;
2323
2324                 switch (type) {
2325                 case YAFFS_OBJECT_TYPE_SYMLINK:
2326                         in->variant.symLinkVariant.alias = str;
2327                         break;
2328                 case YAFFS_OBJECT_TYPE_HARDLINK:
2329                         in->variant.hardLinkVariant.equivalentObject =
2330                                 equivalentObject;
2331                         in->variant.hardLinkVariant.equivalentObjectId =
2332                                 equivalentObject->objectId;
2333                         ylist_add(&in->hardLinks, &equivalentObject->hardLinks);
2334                         break;
2335                 case YAFFS_OBJECT_TYPE_FILE:
2336                 case YAFFS_OBJECT_TYPE_DIRECTORY:
2337                 case YAFFS_OBJECT_TYPE_SPECIAL:
2338                 case YAFFS_OBJECT_TYPE_UNKNOWN:
2339                         /* do nothing */
2340                         break;
2341                 }
2342
2343                 if (yaffs_UpdateObjectHeader(in, name, 0, 0, 0) < 0) {
2344                         /* Could not create the object header, fail the creation */
2345                         yaffs_DeleteObject(in);
2346                         in = NULL;
2347                 }
2348
2349                 yaffs_UpdateParent(parent);
2350         }
2351
2352         return in;
2353 }
2354
2355 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
2356                         __u32 mode, __u32 uid, __u32 gid)
2357 {
2358         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2359                                 uid, gid, NULL, NULL, 0);
2360 }
2361
2362 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
2363                                 __u32 mode, __u32 uid, __u32 gid)
2364 {
2365         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2366                                  mode, uid, gid, NULL, NULL, 0);
2367 }
2368
2369 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
2370                                 __u32 mode, __u32 uid, __u32 gid, __u32 rdev)
2371 {
2372         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2373                                  uid, gid, NULL, NULL, rdev);
2374 }
2375
2376 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
2377                                 __u32 mode, __u32 uid, __u32 gid,
2378                                 const YCHAR *alias)
2379 {
2380         return yaffs_MknodObject(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2381                                 uid, gid, NULL, alias, 0);
2382 }
2383
2384 /* yaffs_Link returns the object id of the equivalent object.*/
2385 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
2386                         yaffs_Object *equivalentObject)
2387 {
2388         /* Get the real object in case we were fed a hard link as an equivalent object */
2389         equivalentObject = yaffs_GetEquivalentObject(equivalentObject);
2390
2391         if (yaffs_MknodObject
2392             (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
2393              equivalentObject, NULL, 0)) {
2394                 return equivalentObject;
2395         } else {
2396                 return NULL;
2397         }
2398
2399 }
2400
2401 static int yaffs_ChangeObjectName(yaffs_Object *obj, yaffs_Object *newDir,
2402                                 const YCHAR *newName, int force, int shadows)
2403 {
2404         int unlinkOp;
2405         int deleteOp;
2406
2407         yaffs_Object *existingTarget;
2408
2409         if (newDir == NULL)
2410                 newDir = obj->parent;   /* use the old directory */
2411
2412         if (newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
2413                 T(YAFFS_TRACE_ALWAYS,
2414                   (TSTR
2415                    ("tragedy: yaffs_ChangeObjectName: newDir is not a directory"
2416                     TENDSTR)));
2417                 YBUG();
2418         }
2419
2420         /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
2421         if (obj->myDev->isYaffs2)
2422                 unlinkOp = (newDir == obj->myDev->unlinkedDir);
2423         else
2424                 unlinkOp = (newDir == obj->myDev->unlinkedDir
2425                             && obj->variantType == YAFFS_OBJECT_TYPE_FILE);
2426
2427         deleteOp = (newDir == obj->myDev->deletedDir);
2428
2429         existingTarget = yaffs_FindObjectByName(newDir, newName);
2430
2431         /* If the object is a file going into the unlinked directory,
2432          *   then it is OK to just stuff it in since duplicate names are allowed.
2433          *   else only proceed if the new name does not exist and if we're putting
2434          *   it into a directory.
2435          */
2436         if ((unlinkOp ||
2437              deleteOp ||
2438              force ||
2439              (shadows > 0) ||
2440              !existingTarget) &&
2441             newDir->variantType == YAFFS_OBJECT_TYPE_DIRECTORY) {
2442                 yaffs_SetObjectName(obj, newName);
2443                 obj->dirty = 1;
2444
2445                 yaffs_AddObjectToDirectory(newDir, obj);
2446
2447                 if (unlinkOp)
2448                         obj->unlinked = 1;
2449
2450                 /* If it is a deletion then we mark it as a shrink for gc purposes. */
2451                 if (yaffs_UpdateObjectHeader(obj, newName, 0, deleteOp, shadows) >= 0)
2452                         return YAFFS_OK;
2453         }
2454
2455         return YAFFS_FAIL;
2456 }
2457
2458 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
2459                 yaffs_Object *newDir, const YCHAR *newName)
2460 {
2461         yaffs_Object *obj = NULL;
2462         yaffs_Object *existingTarget = NULL;
2463         int force = 0;
2464
2465
2466         if (!oldDir || oldDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2467                 YBUG();
2468         if (!newDir || newDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY)
2469                 YBUG();
2470
2471 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
2472         /* Special case for case insemsitive systems (eg. WinCE).
2473          * While look-up is case insensitive, the name isn't.
2474          * Therefore we might want to change x.txt to X.txt
2475         */
2476         if (oldDir == newDir && yaffs_strcmp(oldName, newName) == 0)
2477                 force = 1;
2478 #endif
2479
2480         else if (yaffs_strlen(newName) > YAFFS_MAX_NAME_LENGTH)
2481                 /* ENAMETOOLONG */
2482                 return YAFFS_FAIL;
2483
2484         obj = yaffs_FindObjectByName(oldDir, oldName);
2485
2486         if (obj && obj->renameAllowed) {
2487
2488                 /* Now do the handling for an existing target, if there is one */
2489
2490                 existingTarget = yaffs_FindObjectByName(newDir, newName);
2491                 if (existingTarget &&
2492                         existingTarget->variantType == YAFFS_OBJECT_TYPE_DIRECTORY &&
2493                         !ylist_empty(&existingTarget->variant.directoryVariant.children)) {
2494                         /* There is a target that is a non-empty directory, so we fail */
2495                         return YAFFS_FAIL;      /* EEXIST or ENOTEMPTY */
2496                 } else if (existingTarget && existingTarget != obj) {
2497                         /* Nuke the target first, using shadowing,
2498                          * but only if it isn't the same object
2499                          */
2500                         yaffs_ChangeObjectName(obj, newDir, newName, force,
2501                                                 existingTarget->objectId);
2502                         yaffs_UnlinkObject(existingTarget);
2503                 }
2504                 yaffs_UpdateParent(oldDir);
2505                 if(newDir != oldDir)
2506                         yaffs_UpdateParent(newDir);
2507
2508                 return yaffs_ChangeObjectName(obj, newDir, newName, 1, 0);
2509         }
2510         return YAFFS_FAIL;
2511 }
2512
2513 /*------------------------- Block Management and Page Allocation ----------------*/
2514
2515 static int yaffs_InitialiseBlocks(yaffs_Device *dev)
2516 {
2517         int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
2518
2519         dev->blockInfo = NULL;
2520         dev->chunkBits = NULL;
2521
2522         dev->allocationBlock = -1;      /* force it to get a new one */
2523
2524         /* If the first allocation strategy fails, thry the alternate one */
2525         dev->blockInfo = YMALLOC(nBlocks * sizeof(yaffs_BlockInfo));
2526         if (!dev->blockInfo) {
2527                 dev->blockInfo = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockInfo));
2528                 dev->blockInfoAlt = 1;
2529         } else
2530                 dev->blockInfoAlt = 0;
2531
2532         if (dev->blockInfo) {
2533                 /* Set up dynamic blockinfo stuff. */
2534                 dev->chunkBitmapStride = (dev->nChunksPerBlock + 7) / 8; /* round up bytes */
2535                 dev->chunkBits = YMALLOC(dev->chunkBitmapStride * nBlocks);
2536                 if (!dev->chunkBits) {
2537                         dev->chunkBits = YMALLOC_ALT(dev->chunkBitmapStride * nBlocks);
2538                         dev->chunkBitsAlt = 1;
2539                 } else
2540                         dev->chunkBitsAlt = 0;
2541         }
2542
2543         if (dev->blockInfo && dev->chunkBits) {
2544                 memset(dev->blockInfo, 0, nBlocks * sizeof(yaffs_BlockInfo));
2545                 memset(dev->chunkBits, 0, dev->chunkBitmapStride * nBlocks);
2546                 return YAFFS_OK;
2547         }
2548
2549         return YAFFS_FAIL;
2550 }
2551
2552 static void yaffs_DeinitialiseBlocks(yaffs_Device *dev)
2553 {
2554         if (dev->blockInfoAlt && dev->blockInfo)
2555                 YFREE_ALT(dev->blockInfo);
2556         else if (dev->blockInfo)
2557                 YFREE(dev->blockInfo);
2558
2559         dev->blockInfoAlt = 0;
2560
2561         dev->blockInfo = NULL;
2562
2563         if (dev->chunkBitsAlt && dev->chunkBits)
2564                 YFREE_ALT(dev->chunkBits);
2565         else if (dev->chunkBits)
2566                 YFREE(dev->chunkBits);
2567         dev->chunkBitsAlt = 0;
2568         dev->chunkBits = NULL;
2569 }
2570
2571 static int yaffs_BlockNotDisqualifiedFromGC(yaffs_Device *dev,
2572                                         yaffs_BlockInfo *bi)
2573 {
2574         int i;
2575         __u32 seq;
2576         yaffs_BlockInfo *b;
2577
2578         if (!dev->isYaffs2)
2579                 return 1;       /* disqualification only applies to yaffs2. */
2580
2581         if (!bi->hasShrinkHeader)
2582                 return 1;       /* can gc */
2583
2584         /* Find the oldest dirty sequence number if we don't know it and save it
2585          * so we don't have to keep recomputing it.
2586          */
2587         if (!dev->oldestDirtySequence) {
2588                 seq = dev->sequenceNumber;
2589
2590                 for (i = dev->internalStartBlock; i <= dev->internalEndBlock;
2591                                 i++) {
2592                         b = yaffs_GetBlockInfo(dev, i);
2593                         if (b->blockState == YAFFS_BLOCK_STATE_FULL &&
2594                             (b->pagesInUse - b->softDeletions) <
2595                             dev->nChunksPerBlock && b->sequenceNumber < seq) {
2596                                 seq = b->sequenceNumber;
2597                         }
2598                 }
2599                 dev->oldestDirtySequence = seq;
2600         }
2601
2602         /* Can't do gc of this block if there are any blocks older than this one that have
2603          * discarded pages.
2604          */
2605         return (bi->sequenceNumber <= dev->oldestDirtySequence);
2606 }
2607
2608 /* FindDiretiestBlock is used to select the dirtiest block (or close enough)
2609  * for garbage collection.
2610  */
2611
2612 static int yaffs_FindBlockForGarbageCollection(yaffs_Device *dev,
2613                                         int aggressive)
2614 {
2615         int b = dev->currentDirtyChecker;
2616
2617         int i;
2618         int iterations;
2619         int dirtiest = -1;
2620         int pagesInUse = 0;
2621         int prioritised = 0;
2622         yaffs_BlockInfo *bi;
2623         int pendingPrioritisedExist = 0;
2624
2625         /* First let's see if we need to grab a prioritised block */
2626         if (dev->hasPendingPrioritisedGCs) {
2627                 for (i = dev->internalStartBlock; i < dev->internalEndBlock && !prioritised; i++) {
2628
2629                         bi = yaffs_GetBlockInfo(dev, i);
2630                         /* yaffs_VerifyBlock(dev,bi,i); */
2631
2632                         if (bi->gcPrioritise) {
2633                                 pendingPrioritisedExist = 1;
2634                                 if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2635                                    yaffs_BlockNotDisqualifiedFromGC(dev, bi)) {
2636                                         pagesInUse = (bi->pagesInUse - bi->softDeletions);
2637                                         dirtiest = i;
2638                                         prioritised = 1;
2639                                         aggressive = 1; /* Fool the non-aggressive skip logiv below */
2640                                 }
2641                         }
2642                 }
2643
2644                 if (!pendingPrioritisedExist) /* None found, so we can clear this */
2645                         dev->hasPendingPrioritisedGCs = 0;
2646         }
2647
2648         /* If we're doing aggressive GC then we are happy to take a less-dirty block, and
2649          * search harder.
2650          * else (we're doing a leasurely gc), then we only bother to do this if the
2651          * block has only a few pages in use.
2652          */
2653
2654         dev->nonAggressiveSkip--;
2655
2656         if (!aggressive && (dev->nonAggressiveSkip > 0))
2657                 return -1;
2658
2659         if (!prioritised)
2660                 pagesInUse =
2661                         (aggressive) ? dev->nChunksPerBlock : YAFFS_PASSIVE_GC_CHUNKS + 1;
2662
2663         if (aggressive)
2664                 iterations =
2665                     dev->internalEndBlock - dev->internalStartBlock + 1;
2666         else {
2667                 iterations =
2668                     dev->internalEndBlock - dev->internalStartBlock + 1;
2669                 iterations = iterations / 16;
2670                 if (iterations > 200)
2671                         iterations = 200;
2672         }
2673
2674         for (i = 0; i <= iterations && pagesInUse > 0 && !prioritised; i++) {
2675                 b++;
2676                 if (b < dev->internalStartBlock || b > dev->internalEndBlock)
2677                         b = dev->internalStartBlock;
2678
2679                 if (b < dev->internalStartBlock || b > dev->internalEndBlock) {
2680                         T(YAFFS_TRACE_ERROR,
2681                           (TSTR("**>> Block %d is not valid" TENDSTR), b));
2682                         YBUG();
2683                 }
2684
2685                 bi = yaffs_GetBlockInfo(dev, b);
2686
2687                 if (bi->blockState == YAFFS_BLOCK_STATE_FULL &&
2688                         (bi->pagesInUse - bi->softDeletions) < pagesInUse &&
2689                                 yaffs_BlockNotDisqualifiedFromGC(dev, bi)) {
2690                         dirtiest = b;
2691                         pagesInUse = (bi->pagesInUse - bi->softDeletions);
2692                 }
2693         }
2694
2695         dev->currentDirtyChecker = b;
2696
2697         if (dirtiest > 0) {
2698                 T(YAFFS_TRACE_GC,
2699                   (TSTR("GC Selected block %d with %d free, prioritised:%d" TENDSTR), dirtiest,
2700                    dev->nChunksPerBlock - pagesInUse, prioritised));
2701         }
2702
2703         dev->oldestDirtySequence = 0;
2704
2705         if (dirtiest > 0)
2706                 dev->nonAggressiveSkip = 4;
2707
2708         return dirtiest;
2709 }
2710
2711 static void yaffs_BlockBecameDirty(yaffs_Device *dev, int blockNo)
2712 {
2713         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, blockNo);
2714
2715         int erasedOk = 0;
2716
2717         /* If the block is still healthy erase it and mark as clean.
2718          * If the block has had a data failure, then retire it.
2719          */
2720
2721         T(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2722                 (TSTR("yaffs_BlockBecameDirty block %d state %d %s"TENDSTR),
2723                 blockNo, bi->blockState, (bi->needsRetiring) ? "needs retiring" : ""));
2724
2725         bi->blockState = YAFFS_BLOCK_STATE_DIRTY;
2726
2727         if (!bi->needsRetiring) {
2728                 yaffs_InvalidateCheckpoint(dev);
2729                 erasedOk = yaffs_EraseBlockInNAND(dev, blockNo);
2730                 if (!erasedOk) {
2731                         dev->nErasureFailures++;
2732                         T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2733                           (TSTR("**>> Erasure failed %d" TENDSTR), blockNo));
2734                 }
2735         }
2736
2737         if (erasedOk &&
2738             ((yaffs_traceMask & YAFFS_TRACE_ERASE) || !yaffs_SkipVerification(dev))) {
2739                 int i;
2740                 for (i = 0; i < dev->nChunksPerBlock; i++) {
2741                         if (!yaffs_CheckChunkErased
2742                             (dev, blockNo * dev->nChunksPerBlock + i)) {
2743                                 T(YAFFS_TRACE_ERROR,
2744                                   (TSTR
2745                                    (">>Block %d erasure supposedly OK, but chunk %d not erased"
2746                                     TENDSTR), blockNo, i));
2747                         }
2748                 }
2749         }
2750
2751         if (erasedOk) {
2752                 /* Clean it up... */
2753                 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
2754                 dev->nErasedBlocks++;
2755                 bi->pagesInUse = 0;
2756                 bi->softDeletions = 0;
2757                 bi->hasShrinkHeader = 0;
2758                 bi->skipErasedCheck = 1;  /* This is clean, so no need to check */
2759                 bi->gcPrioritise = 0;
2760                 yaffs_ClearChunkBits(dev, blockNo);
2761
2762                 T(YAFFS_TRACE_ERASE,
2763                   (TSTR("Erased block %d" TENDSTR), blockNo));
2764         } else {
2765                 dev->nFreeChunks -= dev->nChunksPerBlock;       /* We lost a block of free space */
2766
2767                 yaffs_RetireBlock(dev, blockNo);
2768                 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2769                   (TSTR("**>> Block %d retired" TENDSTR), blockNo));
2770         }
2771 }
2772
2773 static int yaffs_FindBlockForAllocation(yaffs_Device *dev)
2774 {
2775         int i;
2776
2777         yaffs_BlockInfo *bi;
2778
2779         if (dev->nErasedBlocks < 1) {
2780                 /* Hoosterman we've got a problem.
2781                  * Can't get space to gc
2782                  */
2783                 T(YAFFS_TRACE_ERROR,
2784                   (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
2785
2786                 return -1;
2787         }
2788
2789         /* Find an empty block. */
2790
2791         for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
2792                 dev->allocationBlockFinder++;
2793                 if (dev->allocationBlockFinder < dev->internalStartBlock
2794                     || dev->allocationBlockFinder > dev->internalEndBlock) {
2795                         dev->allocationBlockFinder = dev->internalStartBlock;
2796                 }
2797
2798                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlockFinder);
2799
2800                 if (bi->blockState == YAFFS_BLOCK_STATE_EMPTY) {
2801                         bi->blockState = YAFFS_BLOCK_STATE_ALLOCATING;
2802                         dev->sequenceNumber++;
2803                         bi->sequenceNumber = dev->sequenceNumber;
2804                         dev->nErasedBlocks--;
2805                         T(YAFFS_TRACE_ALLOCATE,
2806                           (TSTR("Allocated block %d, seq  %d, %d left" TENDSTR),
2807                            dev->allocationBlockFinder, dev->sequenceNumber,
2808                            dev->nErasedBlocks));
2809                         return dev->allocationBlockFinder;
2810                 }
2811         }
2812
2813         T(YAFFS_TRACE_ALWAYS,
2814           (TSTR
2815            ("yaffs tragedy: no more erased blocks, but there should have been %d"
2816             TENDSTR), dev->nErasedBlocks));
2817
2818         return -1;
2819 }
2820
2821
2822
2823 static int yaffs_CalcCheckpointBlocksRequired(yaffs_Device *dev)
2824 {
2825         if (!dev->nCheckpointBlocksRequired &&
2826            dev->isYaffs2) {
2827                 /* Not a valid value so recalculate */
2828                 int nBytes = 0;
2829                 int nBlocks;
2830                 int devBlocks = (dev->endBlock - dev->startBlock + 1);
2831                 int tnodeSize;
2832
2833                 tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
2834
2835                 if (tnodeSize < sizeof(yaffs_Tnode))
2836                         tnodeSize = sizeof(yaffs_Tnode);
2837
2838                 nBytes += sizeof(yaffs_CheckpointValidity);
2839                 nBytes += sizeof(yaffs_CheckpointDevice);
2840                 nBytes += devBlocks * sizeof(yaffs_BlockInfo);
2841                 nBytes += devBlocks * dev->chunkBitmapStride;
2842                 nBytes += (sizeof(yaffs_CheckpointObject) + sizeof(__u32)) * (dev->nObjectsCreated - dev->nFreeObjects);
2843                 nBytes += (tnodeSize + sizeof(__u32)) * (dev->nTnodesCreated - dev->nFreeTnodes);
2844                 nBytes += sizeof(yaffs_CheckpointValidity);
2845                 nBytes += sizeof(__u32); /* checksum*/
2846
2847                 /* Round up and add 2 blocks to allow for some bad blocks, so add 3 */
2848
2849                 nBlocks = (nBytes/(dev->nDataBytesPerChunk * dev->nChunksPerBlock)) + 3;
2850
2851                 dev->nCheckpointBlocksRequired = nBlocks;
2852         }
2853
2854         return dev->nCheckpointBlocksRequired;
2855 }
2856
2857 /*
2858  * Check if there's space to allocate...
2859  * Thinks.... do we need top make this ths same as yaffs_GetFreeChunks()?
2860  */
2861 static int yaffs_CheckSpaceForAllocation(yaffs_Device *dev)
2862 {
2863         int reservedChunks;
2864         int reservedBlocks = dev->nReservedBlocks;
2865         int checkpointBlocks;
2866
2867         if (dev->isYaffs2) {
2868                 checkpointBlocks =  yaffs_CalcCheckpointBlocksRequired(dev) -
2869                                     dev->blocksInCheckpoint;
2870                 if (checkpointBlocks < 0)
2871                         checkpointBlocks = 0;
2872         } else {
2873                 checkpointBlocks = 0;
2874         }
2875
2876         reservedChunks = ((reservedBlocks + checkpointBlocks) * dev->nChunksPerBlock);
2877
2878         return (dev->nFreeChunks > reservedChunks);
2879 }
2880
2881 static int yaffs_AllocateChunk(yaffs_Device *dev, int useReserve,
2882                 yaffs_BlockInfo **blockUsedPtr)
2883 {
2884         int retVal;
2885         yaffs_BlockInfo *bi;
2886
2887         if (dev->allocationBlock < 0) {
2888                 /* Get next block to allocate off */
2889                 dev->allocationBlock = yaffs_FindBlockForAllocation(dev);
2890                 dev->allocationPage = 0;
2891         }
2892
2893         if (!useReserve && !yaffs_CheckSpaceForAllocation(dev)) {
2894                 /* Not enough space to allocate unless we're allowed to use the reserve. */
2895                 return -1;
2896         }
2897
2898         if (dev->nErasedBlocks < dev->nReservedBlocks
2899                         && dev->allocationPage == 0) {
2900                 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
2901         }
2902
2903         /* Next page please.... */
2904         if (dev->allocationBlock >= 0) {
2905                 bi = yaffs_GetBlockInfo(dev, dev->allocationBlock);
2906
2907                 retVal = (dev->allocationBlock * dev->nChunksPerBlock) +
2908                         dev->allocationPage;
2909                 bi->pagesInUse++;
2910                 yaffs_SetChunkBit(dev, dev->allocationBlock,
2911                                 dev->allocationPage);
2912
2913                 dev->allocationPage++;
2914
2915                 dev->nFreeChunks--;
2916
2917                 /* If the block is full set the state to full */
2918                 if (dev->allocationPage >= dev->nChunksPerBlock) {
2919                         bi->blockState = YAFFS_BLOCK_STATE_FULL;
2920                         dev->allocationBlock = -1;
2921                 }
2922
2923                 if (blockUsedPtr)
2924                         *blockUsedPtr = bi;
2925
2926                 return retVal;
2927         }
2928
2929         T(YAFFS_TRACE_ERROR,
2930                         (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
2931
2932         return -1;
2933 }
2934
2935 static int yaffs_GetErasedChunks(yaffs_Device *dev)
2936 {
2937         int n;
2938
2939         n = dev->nErasedBlocks * dev->nChunksPerBlock;
2940
2941         if (dev->allocationBlock > 0)
2942                 n += (dev->nChunksPerBlock - dev->allocationPage);
2943
2944         return n;
2945
2946 }
2947
2948 static int yaffs_GarbageCollectBlock(yaffs_Device *dev, int block,
2949                 int wholeBlock)
2950 {
2951         int oldChunk;
2952         int newChunk;
2953         int markNAND;
2954         int retVal = YAFFS_OK;
2955         int cleanups = 0;
2956         int i;
2957         int isCheckpointBlock;
2958         int matchingChunk;
2959         int maxCopies;
2960
2961         int chunksBefore = yaffs_GetErasedChunks(dev);
2962         int chunksAfter;
2963
2964         yaffs_ExtendedTags tags;
2965
2966         yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, block);
2967
2968         yaffs_Object *object;
2969
2970         isCheckpointBlock = (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT);
2971
2972         bi->blockState = YAFFS_BLOCK_STATE_COLLECTING;
2973
2974         T(YAFFS_TRACE_TRACING,
2975                         (TSTR("Collecting block %d, in use %d, shrink %d, wholeBlock %d" TENDSTR),
2976                          block,
2977                          bi->pagesInUse,
2978                          bi->hasShrinkHeader,
2979                          wholeBlock));
2980
2981         /*yaffs_VerifyFreeChunks(dev); */
2982
2983         bi->hasShrinkHeader = 0;        /* clear the flag so that the block can erase */
2984
2985         /* Take off the number of soft deleted entries because
2986          * they're going to get really deleted during GC.
2987          */
2988         if(dev->gcChunk == 0) /* first time through for this block */
2989                 dev->nFreeChunks -= bi->softDeletions;
2990
2991         dev->isDoingGC = 1;
2992
2993         if (isCheckpointBlock ||
2994                         !yaffs_StillSomeChunkBits(dev, block)) {
2995                 T(YAFFS_TRACE_TRACING,
2996                                 (TSTR
2997                                  ("Collecting block %d that has no chunks in use" TENDSTR),
2998                                  block));
2999                 yaffs_BlockBecameDirty(dev, block);
3000         } else {
3001
3002                 __u8 *buffer = yaffs_GetTempBuffer(dev, __LINE__);
3003
3004                 yaffs_VerifyBlock(dev, bi, block);
3005
3006                 maxCopies = (wholeBlock) ? dev->nChunksPerBlock : 10;
3007                 oldChunk = block * dev->nChunksPerBlock + dev->gcChunk;
3008
3009                 for (/* init already done */;
3010                      retVal == YAFFS_OK &&
3011                      dev->gcChunk < dev->nChunksPerBlock &&
3012                      (bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) &&
3013                      maxCopies > 0;
3014                      dev->gcChunk++, oldChunk++) {
3015                         if (yaffs_CheckChunkBit(dev, block, dev->gcChunk)) {
3016
3017                                 /* This page is in use and might need to be copied off */
3018
3019                                 maxCopies--;
3020
3021                                 markNAND = 1;
3022
3023                                 yaffs_InitialiseTags(&tags);
3024
3025                                 yaffs_ReadChunkWithTagsFromNAND(dev, oldChunk,
3026                                                                 buffer, &tags);
3027
3028                                 object =
3029                                     yaffs_FindObjectByNumber(dev,
3030                                                              tags.objectId);
3031
3032                                 T(YAFFS_TRACE_GC_DETAIL,
3033                                   (TSTR
3034                                    ("Collecting chunk in block %d, %d %d %d " TENDSTR),
3035                                    dev->gcChunk, tags.objectId, tags.chunkId,
3036                                    tags.byteCount));
3037
3038                                 if (object && !yaffs_SkipVerification(dev)) {
3039                                         if (tags.chunkId == 0)
3040                                                 matchingChunk = object->hdrChunk;
3041                                         else if (object->softDeleted)
3042                                                 matchingChunk = oldChunk; /* Defeat the test */
3043                                         else
3044                                                 matchingChunk = yaffs_FindChunkInFile(object, tags.chunkId, NULL);
3045
3046                                         if (oldChunk != matchingChunk)
3047                                                 T(YAFFS_TRACE_ERROR,
3048                                                   (TSTR("gc: page in gc mismatch: %d %d %d %d"TENDSTR),
3049                                                   oldChunk, matchingChunk, tags.objectId, tags.chunkId));
3050
3051                                 }
3052
3053                                 if (!object) {
3054                                         T(YAFFS_TRACE_ERROR,
3055                                           (TSTR
3056                                            ("page %d in gc has no object: %d %d %d "
3057                                             TENDSTR), oldChunk,
3058                                             tags.objectId, tags.chunkId, tags.byteCount));
3059                                 }
3060
3061                                 if (object &&
3062                                     object->deleted &&
3063                                     object->softDeleted &&
3064                                     tags.chunkId != 0) {
3065                                         /* Data chunk in a soft deleted file, throw it away
3066                                          * It's a soft deleted data chunk,
3067                                          * No need to copy this, just forget about it and
3068                                          * fix up the object.
3069                                          */
3070
3071                                         object->nDataChunks--;
3072
3073                                         if (object->nDataChunks <= 0) {
3074                                                 /* remeber to clean up the object */
3075                                                 dev->gcCleanupList[cleanups] =
3076                                                     tags.objectId;
3077                                                 cleanups++;
3078                                         }
3079                                         markNAND = 0;
3080                                 } else if (0) {
3081                                         /* Todo object && object->deleted && object->nDataChunks == 0 */
3082                                         /* Deleted object header with no data chunks.
3083                                          * Can be discarded and the file deleted.
3084                                          */
3085                                         object->hdrChunk = 0;
3086                                         yaffs_FreeTnode(object->myDev,
3087                                                         object->variant.
3088                                                         fileVariant.top);
3089                                         object->variant.fileVariant.top = NULL;
3090                                         yaffs_DoGenericObjectDeletion(object);
3091
3092                                 } else if (object) {
3093                                         /* It's either a data chunk in a live file or
3094                                          * an ObjectHeader, so we're interested in it.
3095                                          * NB Need to keep the ObjectHeaders of deleted files
3096                                          * until the whole file has been deleted off
3097                                          */
3098                                         tags.serialNumber++;
3099
3100                                         dev->nGCCopies++;
3101
3102                                         if (tags.chunkId == 0) {
3103                                                 /* It is an object Id,
3104                                                  * We need to nuke the shrinkheader flags first
3105                                                  * We no longer want the shrinkHeader flag since its work is done
3106                                                  * and if it is left in place it will mess up scanning.
3107                                                  */
3108
3109                                                 yaffs_ObjectHeader *oh;
3110                                                 oh = (yaffs_ObjectHeader *)buffer;
3111                                                 oh->isShrink = 0;
3112                                                 tags.extraIsShrinkHeader = 0;
3113
3114                                                 yaffs_VerifyObjectHeader(object, oh, &tags, 1);
3115                                         }
3116
3117                                         newChunk =
3118                                             yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &tags, 1);
3119
3120                                         if (newChunk < 0) {
3121                                                 retVal = YAFFS_FAIL;
3122                                         } else {
3123
3124                                                 /* Ok, now fix up the Tnodes etc. */
3125
3126                                                 if (tags.chunkId == 0) {
3127                                                         /* It's a header */
3128                                                         object->hdrChunk =  newChunk;
3129                                                         object->serial =   tags.serialNumber;
3130                                                 } else {
3131                                                         /* It's a data chunk */
3132                                                         yaffs_PutChunkIntoFile
3133                                                             (object,
3134                                                              tags.chunkId,
3135                                                              newChunk, 0);
3136                                                 }
3137                                         }
3138                                 }
3139
3140                                 if (retVal == YAFFS_OK)
3141                                         yaffs_DeleteChunk(dev, oldChunk, markNAND, __LINE__);
3142
3143                         }
3144                 }
3145
3146                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3147
3148
3149                 /* Do any required cleanups */
3150                 for (i = 0; i < cleanups; i++) {
3151                         /* Time to delete the file too */
3152                         object =
3153                             yaffs_FindObjectByNumber(dev,
3154                                                      dev->gcCleanupList[i]);
3155                         if (object) {
3156                                 yaffs_FreeTnode(dev,
3157                                                 object->variant.fileVariant.
3158                                                 top);
3159                                 object->variant.fileVariant.top = NULL;
3160                                 T(YAFFS_TRACE_GC,
3161                                   (TSTR
3162                                    ("yaffs: About to finally delete object %d"
3163                                     TENDSTR), object->objectId));
3164                                 yaffs_DoGenericObjectDeletion(object);
3165                                 object->myDev->nDeletedFiles--;
3166                         }
3167
3168                 }
3169
3170         }
3171
3172         yaffs_VerifyCollectedBlock(dev, bi, block);
3173
3174         chunksAfter = yaffs_GetErasedChunks(dev);
3175         if (chunksBefore >= chunksAfter) {
3176                 T(YAFFS_TRACE_GC,
3177                   (TSTR
3178                    ("gc did not increase free chunks before %d after %d"
3179                     TENDSTR), chunksBefore, chunksAfter));
3180         }
3181
3182         /* If the gc completed then clear the current gcBlock so that we find another. */
3183         if (bi->blockState != YAFFS_BLOCK_STATE_COLLECTING) {
3184                 dev->gcBlock = -1;
3185                 dev->gcChunk = 0;
3186         }
3187
3188         dev->isDoingGC = 0;
3189
3190         return retVal;
3191 }
3192
3193 /* New garbage collector
3194  * If we're very low on erased blocks then we do aggressive garbage collection
3195  * otherwise we do "leasurely" garbage collection.
3196  * Aggressive gc looks further (whole array) and will accept less dirty blocks.
3197  * Passive gc only inspects smaller areas and will only accept more dirty blocks.
3198  *
3199  * The idea is to help clear out space in a more spread-out manner.
3200  * Dunno if it really does anything useful.
3201  */
3202 static int yaffs_CheckGarbageCollection(yaffs_Device *dev)
3203 {
3204         int block;
3205         int aggressive;
3206         int gcOk = YAFFS_OK;
3207         int maxTries = 0;
3208
3209         int checkpointBlockAdjust;
3210
3211         if (dev->isDoingGC) {
3212                 /* Bail out so we don't get recursive gc */
3213                 return YAFFS_OK;
3214         }
3215
3216         /* This loop should pass the first time.
3217          * We'll only see looping here if the erase of the collected block fails.
3218          */
3219
3220         do {
3221                 maxTries++;
3222
3223                 checkpointBlockAdjust = yaffs_CalcCheckpointBlocksRequired(dev) - dev->blocksInCheckpoint;
3224                 if (checkpointBlockAdjust < 0)
3225                         checkpointBlockAdjust = 0;
3226
3227                 if (dev->nErasedBlocks < (dev->nReservedBlocks + checkpointBlockAdjust + 2)) {
3228                         /* We need a block soon...*/
3229                         aggressive = 1;
3230                 } else {
3231                         /* We're in no hurry */
3232                         aggressive = 0;
3233                 }
3234
3235                 if (dev->gcBlock <= 0) {
3236                         dev->gcBlock = yaffs_FindBlockForGarbageCollection(dev, aggressive);
3237                         dev->gcChunk = 0;
3238                 }
3239
3240                 block = dev->gcBlock;
3241
3242                 if (block > 0) {
3243                         dev->garbageCollections++;
3244                         if (!aggressive)
3245                                 dev->passiveGarbageCollections++;
3246
3247                         T(YAFFS_TRACE_GC,
3248                           (TSTR
3249                            ("yaffs: GC erasedBlocks %d aggressive %d" TENDSTR),
3250                            dev->nErasedBlocks, aggressive));
3251
3252                         gcOk = yaffs_GarbageCollectBlock(dev, block, aggressive);
3253                 }
3254
3255                 if (dev->nErasedBlocks < (dev->nReservedBlocks) && block > 0) {
3256                         T(YAFFS_TRACE_GC,
3257                           (TSTR
3258                            ("yaffs: GC !!!no reclaim!!! erasedBlocks %d after try %d block %d"
3259                             TENDSTR), dev->nErasedBlocks, maxTries, block));
3260                 }
3261         } while ((dev->nErasedBlocks < dev->nReservedBlocks) &&
3262                  (block > 0) &&
3263                  (maxTries < 2));
3264
3265         return aggressive ? gcOk : YAFFS_OK;
3266 }
3267
3268 /*-------------------------  TAGS --------------------------------*/
3269
3270 static int yaffs_TagsMatch(const yaffs_ExtendedTags *tags, int objectId,
3271                            int chunkInObject)
3272 {
3273         return (tags->chunkId == chunkInObject &&
3274                 tags->objectId == objectId && !tags->chunkDeleted) ? 1 : 0;
3275
3276 }
3277
3278
3279 /*-------------------- Data file manipulation -----------------*/
3280
3281 static int yaffs_FindChunkInFile(yaffs_Object *in, int chunkInInode,
3282                                  yaffs_ExtendedTags *tags)
3283 {
3284         /*Get the Tnode, then get the level 0 offset chunk offset */
3285         yaffs_Tnode *tn;
3286         int theChunk = -1;
3287         yaffs_ExtendedTags localTags;
3288         int retVal = -1;
3289
3290         yaffs_Device *dev = in->myDev;
3291
3292         if (!tags) {
3293                 /* Passed a NULL, so use our own tags space */
3294                 tags = &localTags;
3295         }
3296
3297         tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
3298
3299         if (tn) {
3300                 theChunk = yaffs_GetChunkGroupBase(dev, tn, chunkInInode);
3301
3302                 retVal =
3303                     yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
3304                                            chunkInInode);
3305         }
3306         return retVal;
3307 }
3308
3309 static int yaffs_FindAndDeleteChunkInFile(yaffs_Object *in, int chunkInInode,
3310                                           yaffs_ExtendedTags *tags)
3311 {
3312         /* Get the Tnode, then get the level 0 offset chunk offset */
3313         yaffs_Tnode *tn;
3314         int theChunk = -1;
3315         yaffs_ExtendedTags localTags;
3316
3317         yaffs_Device *dev = in->myDev;
3318         int retVal = -1;
3319
3320         if (!tags) {
3321                 /* Passed a NULL, so use our own tags space */
3322                 tags = &localTags;
3323         }
3324
3325         tn = yaffs_FindLevel0Tnode(dev, &in->variant.fileVariant, chunkInInode);
3326
3327         if (tn) {
3328
3329                 theChunk = yaffs_GetChunkGroupBase(dev, tn, chunkInInode);
3330
3331                 retVal =
3332                     yaffs_FindChunkInGroup(dev, theChunk, tags, in->objectId,
3333                                            chunkInInode);
3334
3335                 /* Delete the entry in the filestructure (if found) */
3336                 if (retVal != -1)
3337                         yaffs_PutLevel0Tnode(dev, tn, chunkInInode, 0);
3338         }
3339
3340         return retVal;
3341 }
3342
3343 #ifdef YAFFS_PARANOID
3344
3345 static int yaffs_CheckFileSanity(yaffs_Object *in)
3346 {
3347         int chunk;
3348         int nChunks;
3349         int fSize;
3350         int failed = 0;
3351         int objId;
3352         yaffs_Tnode *tn;
3353         yaffs_Tags localTags;
3354         yaffs_Tags *tags = &localTags;
3355         int theChunk;
3356         int chunkDeleted;
3357
3358         if (in->variantType != YAFFS_OBJECT_TYPE_FILE)
3359                 return YAFFS_FAIL;
3360
3361         objId = in->objectId;
3362         fSize = in->variant.fileVariant.fileSize;
3363         nChunks =
3364             (fSize + in->myDev->nDataBytesPerChunk - 1) / in->myDev->nDataBytesPerChunk;
3365
3366         for (chunk = 1; chunk <= nChunks; chunk++) {
3367                 tn = yaffs_FindLevel0Tnode(in->myDev, &in->variant.fileVariant,
3368                                            chunk);
3369
3370                 if (tn) {
3371
3372                         theChunk = yaffs_GetChunkGroupBase(dev, tn, chunk);
3373
3374                         if (yaffs_CheckChunkBits
3375                             (dev, theChunk / dev->nChunksPerBlock,
3376                              theChunk % dev->nChunksPerBlock)) {
3377
3378                                 yaffs_ReadChunkTagsFromNAND(in->myDev, theChunk,
3379                                                             tags,
3380                                                             &chunkDeleted);
3381                                 if (yaffs_TagsMatch
3382                                     (tags, in->objectId, chunk, chunkDeleted)) {
3383                                         /* found it; */
3384
3385                                 }
3386                         } else {
3387
3388                                 failed = 1;
3389                         }
3390
3391                 } else {
3392                         /* T(("No level 0 found for %d\n", chunk)); */
3393                 }
3394         }
3395
3396         return failed ? YAFFS_FAIL : YAFFS_OK;
3397 }
3398
3399 #endif
3400
3401 static int yaffs_PutChunkIntoFile(yaffs_Object *in, int chunkInInode,
3402                                   int chunkInNAND, int inScan)
3403 {
3404         /* NB inScan is zero unless scanning.
3405          * For forward scanning, inScan is > 0;
3406          * for backward scanning inScan is < 0
3407          */
3408
3409         yaffs_Tnode *tn;
3410         yaffs_Device *dev = in->myDev;
3411         int existingChunk;
3412         yaffs_ExtendedTags existingTags;
3413         yaffs_ExtendedTags newTags;
3414         unsigned existingSerial, newSerial;
3415
3416         if (in->variantType != YAFFS_OBJECT_TYPE_FILE) {
3417                 /* Just ignore an attempt at putting a chunk into a non-file during scanning
3418                  * If it is not during Scanning then something went wrong!
3419                  */
3420                 if (!inScan) {
3421                         T(YAFFS_TRACE_ERROR,
3422                           (TSTR
3423                            ("yaffs tragedy:attempt to put data chunk into a non-file"
3424                             TENDSTR)));
3425                         YBUG();
3426                 }
3427
3428                 yaffs_DeleteChunk(dev, chunkInNAND, 1, __LINE__);
3429                 return YAFFS_OK;
3430         }
3431
3432         tn = yaffs_AddOrFindLevel0Tnode(dev,
3433                                         &in->variant.fileVariant,
3434                                         chunkInInode,
3435                                         NULL);
3436         if (!tn)
3437                 return YAFFS_FAIL;
3438
3439         existingChunk = yaffs_GetChunkGroupBase(dev, tn, chunkInInode);
3440
3441         if (inScan != 0) {
3442                 /* If we're scanning then we need to test for duplicates
3443                  * NB This does not need to be efficient since it should only ever
3444                  * happen when the power fails during a write, then only one
3445                  * chunk should ever be affected.
3446                  *
3447                  * Correction for YAFFS2: This could happen quite a lot and we need to think about efficiency! TODO
3448                  * Update: For backward scanning we don't need to re-read tags so this is quite cheap.
3449                  */
3450
3451                 if (existingChunk > 0) {
3452                         /* NB Right now existing chunk will not be real chunkId if the device >= 32MB
3453                          *    thus we have to do a FindChunkInFile to get the real chunk id.
3454                          *
3455                          * We have a duplicate now we need to decide which one to use:
3456                          *
3457                          * Backwards scanning YAFFS2: The old one is what we use, dump the new one.
3458                          * Forward scanning YAFFS2: The new one is what we use, dump the old one.
3459                          * YAFFS1: Get both sets of tags and compare serial numbers.
3460                          */
3461
3462                         if (inScan > 0) {
3463                                 /* Only do this for forward scanning */
3464                                 yaffs_ReadChunkWithTagsFromNAND(dev,
3465                                                                 chunkInNAND,
3466                                                                 NULL, &newTags);
3467
3468                                 /* Do a proper find */
3469                                 existingChunk =
3470                                     yaffs_FindChunkInFile(in, chunkInInode,
3471                                                           &existingTags);
3472                         }
3473
3474                         if (existingChunk <= 0) {
3475                                 /*Hoosterman - how did this happen? */
3476
3477                                 T(YAFFS_TRACE_ERROR,
3478                                   (TSTR
3479                                    ("yaffs tragedy: existing chunk < 0 in scan"
3480                                     TENDSTR)));
3481
3482                         }
3483
3484                         /* NB The deleted flags should be false, otherwise the chunks will
3485                          * not be loaded during a scan
3486                          */
3487
3488                         if (inScan > 0) {
3489                                 newSerial = newTags.serialNumber;
3490                                 existingSerial = existingTags.serialNumber;
3491                         }
3492
3493                         if ((inScan > 0) &&
3494                             (in->myDev->isYaffs2 ||
3495                              existingChunk <= 0 ||
3496                              ((existingSerial + 1) & 3) == newSerial)) {
3497                                 /* Forward scanning.
3498                                  * Use new
3499                                  * Delete the old one and drop through to update the tnode
3500                                  */
3501                                 yaffs_DeleteChunk(dev, existingChunk, 1,
3502                                                   __LINE__);
3503                         } else {
3504                                 /* Backward scanning or we want to use the existing one
3505                                  * Use existing.
3506                                  * Delete the new one and return early so that the tnode isn't changed
3507                                  */
3508                                 yaffs_DeleteChunk(dev, chunkInNAND, 1,
3509                                                   __LINE__);
3510                                 return YAFFS_OK;
3511                         }
3512                 }
3513
3514         }
3515
3516         if (existingChunk == 0)
3517                 in->nDataChunks++;
3518
3519         yaffs_PutLevel0Tnode(dev, tn, chunkInInode, chunkInNAND);
3520
3521         return YAFFS_OK;
3522 }
3523
3524 static int yaffs_ReadChunkDataFromObject(yaffs_Object *in, int chunkInInode,
3525                                         __u8 *buffer)
3526 {
3527         int chunkInNAND = yaffs_FindChunkInFile(in, chunkInInode, NULL);
3528
3529         if (chunkInNAND >= 0)
3530                 return yaffs_ReadChunkWithTagsFromNAND(in->myDev, chunkInNAND,
3531                                                 buffer, NULL);
3532         else {
3533                 T(YAFFS_TRACE_NANDACCESS,
3534                   (TSTR("Chunk %d not found zero instead" TENDSTR),
3535                    chunkInNAND));
3536                 /* get sane (zero) data if you read a hole */
3537                 memset(buffer, 0, in->myDev->nDataBytesPerChunk);
3538                 return 0;
3539         }
3540
3541 }
3542
3543 void yaffs_DeleteChunk(yaffs_Device *dev, int chunkId, int markNAND, int lyn)
3544 {
3545         int block;
3546         int page;
3547         yaffs_ExtendedTags tags;
3548         yaffs_BlockInfo *bi;
3549
3550         if (chunkId <= 0)
3551                 return;
3552
3553         dev->nDeletions++;
3554         block = chunkId / dev->nChunksPerBlock;
3555         page = chunkId % dev->nChunksPerBlock;
3556
3557
3558         if (!yaffs_CheckChunkBit(dev, block, page))
3559                 T(YAFFS_TRACE_VERIFY,
3560                         (TSTR("Deleting invalid chunk %d"TENDSTR),
3561                          chunkId));
3562
3563         bi = yaffs_GetBlockInfo(dev, block);
3564
3565         T(YAFFS_TRACE_DELETION,
3566           (TSTR("line %d delete of chunk %d" TENDSTR), lyn, chunkId));
3567
3568         if (markNAND &&
3569             bi->blockState != YAFFS_BLOCK_STATE_COLLECTING && !dev->isYaffs2) {
3570
3571                 yaffs_InitialiseTags(&tags);
3572
3573                 tags.chunkDeleted = 1;
3574
3575                 yaffs_WriteChunkWithTagsToNAND(dev, chunkId, NULL, &tags);
3576                 yaffs_HandleUpdateChunk(dev, chunkId, &tags);
3577         } else {
3578                 dev->nUnmarkedDeletions++;
3579         }
3580
3581         /* Pull out of the management area.
3582          * If the whole block became dirty, this will kick off an erasure.
3583          */
3584         if (bi->blockState == YAFFS_BLOCK_STATE_ALLOCATING ||
3585             bi->blockState == YAFFS_BLOCK_STATE_FULL ||
3586             bi->blockState == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
3587             bi->blockState == YAFFS_BLOCK_STATE_COLLECTING) {
3588                 dev->nFreeChunks++;
3589
3590                 yaffs_ClearChunkBit(dev, block, page);
3591
3592                 bi->pagesInUse--;
3593
3594                 if (bi->pagesInUse == 0 &&
3595                     !bi->hasShrinkHeader &&
3596                     bi->blockState != YAFFS_BLOCK_STATE_ALLOCATING &&
3597                     bi->blockState != YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
3598                         yaffs_BlockBecameDirty(dev, block);
3599                 }
3600
3601         }
3602
3603 }
3604
3605 static int yaffs_WriteChunkDataToObject(yaffs_Object *in, int chunkInInode,
3606                                         const __u8 *buffer, int nBytes,
3607                                         int useReserve)
3608 {
3609         /* Find old chunk Need to do this to get serial number
3610          * Write new one and patch into tree.
3611          * Invalidate old tags.
3612          */
3613
3614         int prevChunkId;
3615         yaffs_ExtendedTags prevTags;
3616
3617         int newChunkId;
3618         yaffs_ExtendedTags newTags;
3619
3620         yaffs_Device *dev = in->myDev;
3621
3622         yaffs_CheckGarbageCollection(dev);
3623
3624         /* Get the previous chunk at this location in the file if it exists */
3625         prevChunkId = yaffs_FindChunkInFile(in, chunkInInode, &prevTags);
3626
3627         /* Set up new tags */
3628         yaffs_InitialiseTags(&newTags);
3629
3630         newTags.chunkId = chunkInInode;
3631         newTags.objectId = in->objectId;
3632         newTags.serialNumber =
3633             (prevChunkId > 0) ? prevTags.serialNumber + 1 : 1;
3634         newTags.byteCount = nBytes;
3635
3636         if (nBytes < 1 || nBytes > dev->totalBytesPerChunk) {
3637                 T(YAFFS_TRACE_ERROR,
3638                 (TSTR("Writing %d bytes to chunk!!!!!!!!!" TENDSTR), nBytes));
3639                 YBUG();
3640         }
3641
3642         newChunkId =
3643             yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &newTags,
3644                                               useReserve);
3645
3646         if (newChunkId >= 0) {
3647                 yaffs_PutChunkIntoFile(in, chunkInInode, newChunkId, 0);
3648
3649                 if (prevChunkId > 0)
3650                         yaffs_DeleteChunk(dev, prevChunkId, 1, __LINE__);
3651
3652                 yaffs_CheckFileSanity(in);
3653         }
3654         return newChunkId;
3655
3656 }
3657
3658 /* UpdateObjectHeader updates the header on NAND for an object.
3659  * If name is not NULL, then that new name is used.
3660  */
3661 int yaffs_UpdateObjectHeader(yaffs_Object *in, const YCHAR *name, int force,
3662                              int isShrink, int shadows)
3663 {
3664
3665         yaffs_BlockInfo *bi;
3666
3667         yaffs_Device *dev = in->myDev;
3668
3669         int prevChunkId;
3670         int retVal = 0;
3671         int result = 0;
3672
3673         int newChunkId;
3674         yaffs_ExtendedTags newTags;
3675         yaffs_ExtendedTags oldTags;
3676
3677         __u8 *buffer = NULL;
3678         YCHAR oldName[YAFFS_MAX_NAME_LENGTH + 1];
3679
3680         yaffs_ObjectHeader *oh = NULL;
3681
3682         yaffs_strcpy(oldName, _Y("silly old name"));
3683
3684
3685         if (!in->fake ||
3686                 in == dev->rootDir || /* The rootDir should also be saved */
3687                 force) {
3688
3689                 yaffs_CheckGarbageCollection(dev);
3690                 yaffs_CheckObjectDetailsLoaded(in);
3691
3692                 buffer = yaffs_GetTempBuffer(in->myDev, __LINE__);
3693                 oh = (yaffs_ObjectHeader *) buffer;
3694
3695                 prevChunkId = in->hdrChunk;
3696
3697                 if (prevChunkId > 0) {
3698                         result = yaffs_ReadChunkWithTagsFromNAND(dev, prevChunkId,
3699                                                         buffer, &oldTags);
3700
3701                         yaffs_VerifyObjectHeader(in, oh, &oldTags, 0);
3702
3703                         memcpy(oldName, oh->name, sizeof(oh->name));
3704                 }
3705
3706                 memset(buffer, 0xFF, dev->nDataBytesPerChunk);
3707
3708                 oh->type = in->variantType;
3709                 oh->yst_mode = in->yst_mode;
3710                 oh->shadowsObject = oh->inbandShadowsObject = shadows;
3711
3712 #ifdef CONFIG_YAFFS_WINCE
3713                 oh->win_atime[0] = in->win_atime[0];
3714                 oh->win_ctime[0] = in->win_ctime[0];
3715                 oh->win_mtime[0] = in->win_mtime[0];
3716                 oh->win_atime[1] = in->win_atime[1];
3717                 oh->win_ctime[1] = in->win_ctime[1];
3718                 oh->win_mtime[1] = in->win_mtime[1];
3719 #else
3720                 oh->yst_uid = in->yst_uid;
3721                 oh->yst_gid = in->yst_gid;
3722                 oh->yst_atime = in->yst_atime;
3723                 oh->yst_mtime = in->yst_mtime;
3724                 oh->yst_ctime = in->yst_ctime;
3725                 oh->yst_rdev = in->yst_rdev;
3726 #endif
3727                 if (in->parent)
3728                         oh->parentObjectId = in->parent->objectId;
3729                 else
3730                         oh->parentObjectId = 0;
3731
3732                 if (name && *name) {
3733                         memset(oh->name, 0, sizeof(oh->name));
3734                         yaffs_strncpy(oh->name, name, YAFFS_MAX_NAME_LENGTH);
3735                 } else if (prevChunkId > 0)
3736                         memcpy(oh->name, oldName, sizeof(oh->name));
3737                 else
3738                         memset(oh->name, 0, sizeof(oh->name));
3739
3740                 oh->isShrink = isShrink;
3741
3742                 switch (in->variantType) {
3743                 case YAFFS_OBJECT_TYPE_UNKNOWN:
3744                         /* Should not happen */
3745                         break;
3746                 case YAFFS_OBJECT_TYPE_FILE:
3747                         oh->fileSize =
3748                             (oh->parentObjectId == YAFFS_OBJECTID_DELETED
3749                              || oh->parentObjectId ==
3750                              YAFFS_OBJECTID_UNLINKED) ? 0 : in->variant.
3751                             fileVariant.fileSize;
3752                         break;
3753                 case YAFFS_OBJECT_TYPE_HARDLINK:
3754                         oh->equivalentObjectId =
3755                             in->variant.hardLinkVariant.equivalentObjectId;
3756                         break;
3757                 case YAFFS_OBJECT_TYPE_SPECIAL:
3758                         /* Do nothing */
3759                         break;
3760                 case YAFFS_OBJECT_TYPE_DIRECTORY:
3761                         /* Do nothing */
3762                         break;
3763                 case YAFFS_OBJECT_TYPE_SYMLINK:
3764                         yaffs_strncpy(oh->alias,
3765                                       in->variant.symLinkVariant.alias,
3766                                       YAFFS_MAX_ALIAS_LENGTH);
3767                         oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3768                         break;
3769                 }
3770
3771                 /* Tags */
3772                 yaffs_InitialiseTags(&newTags);
3773                 in->serial++;
3774                 newTags.chunkId = 0;
3775                 newTags.objectId = in->objectId;
3776                 newTags.serialNumber = in->serial;
3777
3778                 /* Add extra info for file header */
3779
3780                 newTags.extraHeaderInfoAvailable = 1;
3781                 newTags.extraParentObjectId = oh->parentObjectId;
3782                 newTags.extraFileLength = oh->fileSize;
3783                 newTags.extraIsShrinkHeader = oh->isShrink;
3784                 newTags.extraEquivalentObjectId = oh->equivalentObjectId;
3785                 newTags.extraShadows = (oh->shadowsObject > 0) ? 1 : 0;
3786                 newTags.extraObjectType = in->variantType;
3787
3788                 yaffs_VerifyObjectHeader(in, oh, &newTags, 1);
3789
3790                 /* Create new chunk in NAND */
3791                 newChunkId =
3792                     yaffs_WriteNewChunkWithTagsToNAND(dev, buffer, &newTags,
3793                                                       (prevChunkId > 0) ? 1 : 0);
3794
3795                 if (newChunkId >= 0) {
3796
3797                         in->hdrChunk = newChunkId;
3798
3799                         if (prevChunkId > 0) {
3800                                 yaffs_DeleteChunk(dev, prevChunkId, 1,
3801                                                   __LINE__);
3802                         }
3803
3804                         if (!yaffs_ObjectHasCachedWriteData(in))
3805                                 in->dirty = 0;
3806
3807                         /* If this was a shrink, then mark the block that the chunk lives on */
3808                         if (isShrink) {
3809                                 bi = yaffs_GetBlockInfo(in->myDev,
3810                                         newChunkId / in->myDev->nChunksPerBlock);
3811                                 bi->hasShrinkHeader = 1;
3812                         }
3813
3814                 }
3815
3816                 retVal = newChunkId;
3817
3818         }
3819
3820         if (buffer)
3821                 yaffs_ReleaseTempBuffer(dev, buffer, __LINE__);
3822
3823         return retVal;
3824 }
3825
3826 /*------------------------ Short Operations Cache ----------------------------------------
3827  *   In many situations where there is no high level buffering (eg WinCE) a lot of
3828  *   reads might be short sequential reads, and a lot of writes may be short
3829  *   sequential writes. eg. scanning/writing a jpeg file.
3830  *   In these cases, a short read/write cache can provide a huge perfomance benefit
3831  *   with dumb-as-a-rock code.
3832  *   In Linux, the page cache provides read buffering aand the short op cache provides write
3833  *   buffering.
3834  *
3835  *   There are a limited number (~10) of cache chunks per device so that we don't
3836  *   need a very intelligent search.
3837  */
3838
3839 static int yaffs_ObjectHasCachedWriteData(yaffs_Object *obj)
3840 {
3841         yaffs_Device *dev = obj->myDev;
3842         int i;
3843         yaffs_ChunkCache *cache;
3844         int nCaches = obj->myDev->nShortOpCaches;
3845
3846         for (i = 0; i < nCaches; i++) {
3847                 cache = &dev->srCache[i];
3848                 if (cache->object == obj &&
3849                     cache->dirty)
3850                         return 1;
3851         }
3852
3853         return 0;
3854 }
3855
3856
3857 static void yaffs_FlushFilesChunkCache(yaffs_Object *obj)
3858 {
3859         yaffs_Device *dev = obj->myDev;
3860         int lowest = -99;       /* Stop compiler whining. */
3861         int i;
3862         yaffs_ChunkCache *cache;
3863         int chunkWritten = 0;
3864         int nCaches = obj->myDev->nShortOpCaches;
3865
3866         if (nCaches > 0) {
3867                 do {
3868                         cache = NULL;
3869
3870                         /* Find the dirty cache for this object with the lowest chunk id. */
3871                         for (i = 0; i < nCaches; i++) {
3872                                 if (dev->srCache[i].object == obj &&
3873                                     dev->srCache[i].dirty) {
3874                                         if (!cache
3875                                             || dev->srCache[i].chunkId <
3876                                             lowest) {
3877                                                 cache = &dev->srCache[i];
3878                                                 lowest = cache->chunkId;
3879                                         }
3880                                 }
3881                         }
3882
3883                         if (cache && !cache->locked) {
3884                                 /* Write it out and free it up */
3885
3886                                 chunkWritten =
3887                                     yaffs_WriteChunkDataToObject(cache->object,
3888                                                                  cache->chunkId,
3889                                                                  cache->data,
3890                                                                  cache->nBytes,
3891                                                                  1);
3892                                 cache->dirty = 0;
3893                                 cache->object = NULL;
3894                         }
3895
3896                 } while (cache && chunkWritten > 0);
3897
3898                 if (cache) {
3899                         /* Hoosterman, disk full while writing cache out. */
3900                         T(YAFFS_TRACE_ERROR,
3901                           (TSTR("yaffs tragedy: no space during cache write" TENDSTR)));
3902
3903                 }
3904         }
3905
3906 }
3907
3908 /*yaffs_FlushEntireDeviceCache(dev)
3909  *
3910  *
3911  */
3912
3913 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev)
3914 {
3915         yaffs_Object *obj;
3916         int nCaches = dev->nShortOpCaches;
3917         int i;
3918
3919         /* Find a dirty object in the cache and flush it...
3920          * until there are no further dirty objects.
3921          */
3922         do {
3923                 obj = NULL;
3924                 for (i = 0; i < nCaches && !obj; i++) {
3925                         if (dev->srCache[i].object &&
3926                             dev->srCache[i].dirty)
3927                                 obj = dev->srCache[i].object;
3928
3929                 }
3930                 if (obj)
3931                         yaffs_FlushFilesChunkCache(obj);
3932
3933         } while (obj);
3934
3935 }
3936
3937
3938 /* Grab us a cache chunk for use.
3939  * First look for an empty one.
3940  * Then look for the least recently used non-dirty one.
3941  * Then look for the least recently used dirty one...., flush and look again.
3942  */
3943 static yaffs_ChunkCache *yaffs_GrabChunkCacheWorker(yaffs_Device *dev)
3944 {
3945         int i;
3946
3947         if (dev->nShortOpCaches > 0) {
3948                 for (i = 0; i < dev->nShortOpCaches; i++) {
3949                         if (!dev->srCache[i].object)
3950                                 return &dev->srCache[i];
3951                 }
3952         }
3953
3954         return NULL;
3955 }
3956
3957 static yaffs_ChunkCache *yaffs_GrabChunkCache(yaffs_Device *dev)
3958 {
3959         yaffs_ChunkCache *cache;
3960         yaffs_Object *theObj;
3961         int usage;
3962         int i;
3963         int pushout;
3964
3965         if (dev->nShortOpCaches > 0) {
3966                 /* Try find a non-dirty one... */
3967
3968                 cache = yaffs_GrabChunkCacheWorker(dev);
3969
3970                 if (!cache) {
3971                         /* They were all dirty, find the last recently used object and flush
3972                          * its cache, then  find again.
3973                          * NB what's here is not very accurate, we actually flush the object
3974                          * the last recently used page.
3975                          */
3976
3977                         /* With locking we can't assume we can use entry zero */
3978
3979                         theObj = NULL;
3980                         usage = -1;
3981                         cache = NULL;
3982                         pushout = -1;
3983
3984                         for (i = 0; i < dev->nShortOpCaches; i++) {
3985                                 if (dev->srCache[i].object &&
3986                                     !dev->srCache[i].locked &&
3987                                     (dev->srCache[i].lastUse < usage || !cache)) {
3988                                         usage = dev->srCache[i].lastUse;
3989                                         theObj = dev->srCache[i].object;
3990                                         cache = &dev->srCache[i];
3991                                         pushout = i;
3992                                 }
3993                         }
3994
3995                         if (!cache || cache->dirty) {
3996                                 /* Flush and try again */
3997                                 yaffs_FlushFilesChunkCache(theObj);
3998                                 cache = yaffs_GrabChunkCacheWorker(dev);
3999                         }
4000
4001                 }
4002                 return cache;
4003         } else
4004                 return NULL;
4005
4006 }
4007
4008 /* Find a cached chunk */
4009 static yaffs_ChunkCache *yaffs_FindChunkCache(const yaffs_Object *obj,
4010                                               int chunkId)
4011 {
4012         yaffs_Device *dev = obj->myDev;
4013         int i;
4014         if (dev->nShortOpCaches > 0) {
4015                 for (i = 0; i < dev->nShortOpCaches; i++) {
4016                         if (dev->srCache[i].object == obj &&
4017                             dev->srCache[i].chunkId == chunkId) {
4018                                 dev->cacheHits++;
4019
4020                                 return &dev->srCache[i];
4021                         }
4022                 }
4023         }
4024         return NULL;
4025 }
4026
4027 /* Mark the chunk for the least recently used algorithym */
4028 static void yaffs_UseChunkCache(yaffs_Device *dev, yaffs_ChunkCache *cache,
4029                                 int isAWrite)
4030 {
4031
4032         if (dev->nShortOpCaches > 0) {
4033                 if (dev->srLastUse < 0 || dev->srLastUse > 100000000) {
4034                         /* Reset the cache usages */
4035                         int i;
4036                         for (i = 1; i < dev->nShortOpCaches; i++)
4037                                 dev->srCache[i].lastUse = 0;
4038
4039                         dev->srLastUse = 0;
4040                 }
4041
4042                 dev->srLastUse++;
4043
4044                 cache->lastUse = dev->srLastUse;
4045
4046                 if (isAWrite)
4047                         cache->dirty = 1;
4048         }
4049 }
4050
4051 /* Invalidate a single cache page.
4052  * Do this when a whole page gets written,
4053  * ie the short cache for this page is no longer valid.
4054  */
4055 static void yaffs_InvalidateChunkCache(yaffs_Object *object, int chunkId)
4056 {
4057         if (object->myDev->nShortOpCaches > 0) {
4058                 yaffs_ChunkCache *cache = yaffs_FindChunkCache(object, chunkId);
4059
4060                 if (cache)
4061                         cache->object = NULL;
4062         }
4063 }
4064
4065 /* Invalidate all the cache pages associated with this object
4066  * Do this whenever ther file is deleted or resized.
4067  */
4068 static void yaffs_InvalidateWholeChunkCache(yaffs_Object *in)
4069 {
4070         int i;
4071         yaffs_Device *dev = in->myDev;
4072
4073         if (dev->nShortOpCaches > 0) {
4074                 /* Invalidate it. */
4075                 for (i = 0; i < dev->nShortOpCaches; i++) {
4076                         if (dev->srCache[i].object == in)
4077                                 dev->srCache[i].object = NULL;
4078                 }
4079         }
4080 }
4081
4082 /*--------------------- Checkpointing --------------------*/
4083
4084
4085 static int yaffs_WriteCheckpointValidityMarker(yaffs_Device *dev, int head)
4086 {
4087         yaffs_CheckpointValidity cp;
4088
4089         memset(&cp, 0, sizeof(cp));
4090
4091         cp.structType = sizeof(cp);
4092         cp.magic = YAFFS_MAGIC;
4093         cp.version = YAFFS_CHECKPOINT_VERSION;
4094         cp.head = (head) ? 1 : 0;
4095
4096         return (yaffs_CheckpointWrite(dev, &cp, sizeof(cp)) == sizeof(cp)) ?
4097                 1 : 0;
4098 }
4099
4100 static int yaffs_ReadCheckpointValidityMarker(yaffs_Device *dev, int head)
4101 {
4102         yaffs_CheckpointValidity cp;
4103         int ok;
4104
4105         ok = (yaffs_CheckpointRead(dev, &cp, sizeof(cp)) == sizeof(cp));
4106
4107         if (ok)
4108                 ok = (cp.structType == sizeof(cp)) &&
4109                      (cp.magic == YAFFS_MAGIC) &&
4110                      (cp.version == YAFFS_CHECKPOINT_VERSION) &&
4111                      (cp.head == ((head) ? 1 : 0));
4112         return ok ? 1 : 0;
4113 }
4114
4115 static void yaffs_DeviceToCheckpointDevice(yaffs_CheckpointDevice *cp,
4116                                            yaffs_Device *dev)
4117 {
4118         cp->nErasedBlocks = dev->nErasedBlocks;
4119         cp->allocationBlock = dev->allocationBlock;
4120         cp->allocationPage = dev->allocationPage;
4121         cp->nFreeChunks = dev->nFreeChunks;
4122
4123         cp->nDeletedFiles = dev->nDeletedFiles;
4124         cp->nUnlinkedFiles = dev->nUnlinkedFiles;
4125         cp->nBackgroundDeletions = dev->nBackgroundDeletions;
4126         cp->sequenceNumber = dev->sequenceNumber;
4127         cp->oldestDirtySequence = dev->oldestDirtySequence;
4128
4129 }
4130
4131 static void yaffs_CheckpointDeviceToDevice(yaffs_Device *dev,
4132                                            yaffs_CheckpointDevice *cp)
4133 {
4134         dev->nErasedBlocks = cp->nErasedBlocks;
4135         dev->allocationBlock = cp->allocationBlock;
4136         dev->allocationPage = cp->allocationPage;
4137         dev->nFreeChunks = cp->nFreeChunks;
4138
4139         dev->nDeletedFiles = cp->nDeletedFiles;
4140         dev->nUnlinkedFiles = cp->nUnlinkedFiles;
4141         dev->nBackgroundDeletions = cp->nBackgroundDeletions;
4142         dev->sequenceNumber = cp->sequenceNumber;
4143         dev->oldestDirtySequence = cp->oldestDirtySequence;
4144 }
4145
4146
4147 static int yaffs_WriteCheckpointDevice(yaffs_Device *dev)
4148 {
4149         yaffs_CheckpointDevice cp;
4150         __u32 nBytes;
4151         __u32 nBlocks = (dev->internalEndBlock - dev->internalStartBlock + 1);
4152
4153         int ok;
4154
4155         /* Write device runtime values*/
4156         yaffs_DeviceToCheckpointDevice(&cp, dev);
4157         cp.structType = sizeof(cp);
4158
4159         ok = (yaffs_CheckpointWrite(dev, &cp, sizeof(cp)) == sizeof(cp));
4160
4161         /* Write block info */
4162         if (ok) {
4163                 nBytes = nBlocks * sizeof(yaffs_BlockInfo);
4164                 ok = (yaffs_CheckpointWrite(dev, dev->blockInfo, nBytes) == nBytes);
4165         }
4166
4167         /* Write chunk bits */
4168         if (ok) {
4169                 nBytes = nBlocks * dev->chunkBitmapStride;
4170                 ok = (yaffs_CheckpointWrite(dev, dev->chunkBits, nBytes) == nBytes);
4171         }
4172         return   ok ? 1 : 0;
4173
4174 }
4175
4176 static int yaffs_ReadCheckpointDevice(yaffs_Device *dev)
4177 {
4178         yaffs_CheckpointDevice cp;
4179         __u32 nBytes;
4180         __u32 nBlocks = (dev->internalEndBlock - dev->internalStartBlock + 1);
4181
4182         int ok;
4183
4184         ok = (yaffs_CheckpointRead(dev, &cp, sizeof(cp)) == sizeof(cp));
4185         if (!ok)
4186                 return 0;
4187
4188         if (cp.structType != sizeof(cp))
4189                 return 0;
4190
4191
4192         yaffs_CheckpointDeviceToDevice(dev, &cp);
4193
4194         nBytes = nBlocks * sizeof(yaffs_BlockInfo);
4195
4196         ok = (yaffs_CheckpointRead(dev, dev->blockInfo, nBytes) == nBytes);
4197
4198         if (!ok)
4199                 return 0;
4200         nBytes = nBlocks * dev->chunkBitmapStride;
4201
4202         ok = (yaffs_CheckpointRead(dev, dev->chunkBits, nBytes) == nBytes);
4203
4204         return ok ? 1 : 0;
4205 }
4206
4207 static void yaffs_ObjectToCheckpointObject(yaffs_CheckpointObject *cp,
4208                                            yaffs_Object *obj)
4209 {
4210
4211         cp->objectId = obj->objectId;
4212         cp->parentId = (obj->parent) ? obj->parent->objectId : 0;
4213         cp->hdrChunk = obj->hdrChunk;
4214         cp->variantType = obj->variantType;
4215         cp->deleted = obj->deleted;
4216         cp->softDeleted = obj->softDeleted;
4217         cp->unlinked = obj->unlinked;
4218         cp->fake = obj->fake;
4219         cp->renameAllowed = obj->renameAllowed;
4220         cp->unlinkAllowed = obj->unlinkAllowed;
4221         cp->serial = obj->serial;
4222         cp->nDataChunks = obj->nDataChunks;
4223
4224         if (obj->variantType == YAFFS_OBJECT_TYPE_FILE)
4225                 cp->fileSizeOrEquivalentObjectId = obj->variant.fileVariant.fileSize;
4226         else if (obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK)
4227                 cp->fileSizeOrEquivalentObjectId = obj->variant.hardLinkVariant.equivalentObjectId;
4228 }
4229
4230 static int yaffs_CheckpointObjectToObject(yaffs_Object *obj, yaffs_CheckpointObject *cp)
4231 {
4232
4233         yaffs_Object *parent;
4234
4235         if (obj->variantType != cp->variantType) {
4236                 T(YAFFS_TRACE_ERROR, (TSTR("Checkpoint read object %d type %d "
4237                         TCONT("chunk %d does not match existing object type %d")
4238                         TENDSTR), cp->objectId, cp->variantType, cp->hdrChunk,
4239                         obj->variantType));
4240                 return 0;
4241         }
4242
4243         obj->objectId = cp->objectId;
4244
4245         if (cp->parentId)
4246                 parent = yaffs_FindOrCreateObjectByNumber(
4247                                         obj->myDev,
4248                                         cp->parentId,
4249                                         YAFFS_OBJECT_TYPE_DIRECTORY);
4250         else
4251                 parent = NULL;
4252
4253         if (parent) {
4254                 if (parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
4255                         T(YAFFS_TRACE_ALWAYS, (TSTR("Checkpoint read object %d parent %d type %d"
4256                                 TCONT(" chunk %d Parent type, %d, not directory")
4257                                 TENDSTR),
4258                                 cp->objectId, cp->parentId, cp->variantType,
4259                                 cp->hdrChunk, parent->variantType));
4260                         return 0;
4261                 }
4262                 yaffs_AddObjectToDirectory(parent, obj);
4263         }
4264
4265         obj->hdrChunk = cp->hdrChunk;
4266         obj->variantType = cp->variantType;
4267         obj->deleted = cp->deleted;
4268         obj->softDeleted = cp->softDeleted;
4269         obj->unlinked = cp->unlinked;
4270         obj->fake = cp->fake;
4271         obj->renameAllowed = cp->renameAllowed;
4272         obj->unlinkAllowed = cp->unlinkAllowed;
4273         obj->serial = cp->serial;
4274         obj->nDataChunks = cp->nDataChunks;
4275
4276         if (obj->variantType == YAFFS_OBJECT_TYPE_FILE)
4277                 obj->variant.fileVariant.fileSize = cp->fileSizeOrEquivalentObjectId;
4278         else if (obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK)
4279                 obj->variant.hardLinkVariant.equivalentObjectId = cp->fileSizeOrEquivalentObjectId;
4280
4281         if (obj->hdrChunk > 0)
4282                 obj->lazyLoaded = 1;
4283         return 1;
4284 }
4285
4286
4287
4288 static int yaffs_CheckpointTnodeWorker(yaffs_Object *in, yaffs_Tnode *tn,
4289                                         __u32 level, int chunkOffset)
4290 {
4291         int i;
4292         yaffs_Device *dev = in->myDev;
4293         int ok = 1;
4294         int tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
4295
4296         if (tnodeSize < sizeof(yaffs_Tnode))
4297                 tnodeSize = sizeof(yaffs_Tnode);
4298
4299
4300         if (tn) {
4301                 if (level > 0) {
4302
4303                         for (i = 0; i < YAFFS_NTNODES_INTERNAL && ok; i++) {
4304                                 if (tn->internal[i]) {
4305                                         ok = yaffs_CheckpointTnodeWorker(in,
4306                                                         tn->internal[i],
4307                                                         level - 1,
4308                                                         (chunkOffset<<YAFFS_TNODES_INTERNAL_BITS) + i);
4309                                 }
4310                         }
4311                 } else if (level == 0) {
4312                         __u32 baseOffset = chunkOffset <<  YAFFS_TNODES_LEVEL0_BITS;
4313                         ok = (yaffs_CheckpointWrite(dev, &baseOffset, sizeof(baseOffset)) == sizeof(baseOffset));
4314                         if (ok)
4315                                 ok = (yaffs_CheckpointWrite(dev, tn, tnodeSize) == tnodeSize);
4316                 }
4317         }
4318
4319         return ok;
4320
4321 }
4322
4323 static int yaffs_WriteCheckpointTnodes(yaffs_Object *obj)
4324 {
4325         __u32 endMarker = ~0;
4326         int ok = 1;
4327
4328         if (obj->variantType == YAFFS_OBJECT_TYPE_FILE) {
4329                 ok = yaffs_CheckpointTnodeWorker(obj,
4330                                             obj->variant.fileVariant.top,
4331                                             obj->variant.fileVariant.topLevel,
4332                                             0);
4333                 if (ok)
4334                         ok = (yaffs_CheckpointWrite(obj->myDev, &endMarker, sizeof(endMarker)) ==
4335                                 sizeof(endMarker));
4336         }
4337
4338         return ok ? 1 : 0;
4339 }
4340
4341 static int yaffs_ReadCheckpointTnodes(yaffs_Object *obj)
4342 {
4343         __u32 baseChunk;
4344         int ok = 1;
4345         yaffs_Device *dev = obj->myDev;
4346         yaffs_FileStructure *fileStructPtr = &obj->variant.fileVariant;
4347         yaffs_Tnode *tn;
4348         int nread = 0;
4349         int tnodeSize = (dev->tnodeWidth * YAFFS_NTNODES_LEVEL0)/8;
4350
4351         if (tnodeSize < sizeof(yaffs_Tnode))
4352                 tnodeSize = sizeof(yaffs_Tnode);
4353
4354         ok = (yaffs_CheckpointRead(dev, &baseChunk, sizeof(baseChunk)) == sizeof(baseChunk));
4355
4356         while (ok && (~baseChunk)) {
4357                 nread++;
4358                 /* Read level 0 tnode */
4359
4360
4361                 tn = yaffs_GetTnodeRaw(dev);
4362                 if (tn)
4363                         ok = (yaffs_CheckpointRead(dev, tn, tnodeSize) == tnodeSize);
4364                 else
4365                         ok = 0;
4366
4367                 if (tn && ok)
4368                         ok = yaffs_AddOrFindLevel0Tnode(dev,
4369                                                         fileStructPtr,
4370                                                         baseChunk,
4371                                                         tn) ? 1 : 0;
4372
4373                 if (ok)
4374                         ok = (yaffs_CheckpointRead(dev, &baseChunk, sizeof(baseChunk)) == sizeof(baseChunk));
4375
4376         }
4377
4378         T(YAFFS_TRACE_CHECKPOINT, (
4379                 TSTR("Checkpoint read tnodes %d records, last %d. ok %d" TENDSTR),
4380                 nread, baseChunk, ok));
4381
4382         return ok ? 1 : 0;
4383 }
4384
4385
4386 static int yaffs_WriteCheckpointObjects(yaffs_Device *dev)
4387 {
4388         yaffs_Object *obj;
4389         yaffs_CheckpointObject cp;
4390         int i;
4391         int ok = 1;
4392         struct ylist_head *lh;
4393
4394
4395         /* Iterate through the objects in each hash entry,
4396          * dumping them to the checkpointing stream.
4397          */
4398
4399         for (i = 0; ok &&  i <  YAFFS_NOBJECT_BUCKETS; i++) {
4400                 ylist_for_each(lh, &dev->objectBucket[i].list) {
4401                         if (lh) {
4402                                 obj = ylist_entry(lh, yaffs_Object, hashLink);
4403                                 if (!obj->deferedFree) {
4404                                         yaffs_ObjectToCheckpointObject(&cp, obj);
4405                                         cp.structType = sizeof(cp);
4406
4407                                         T(YAFFS_TRACE_CHECKPOINT, (
4408                                                 TSTR("Checkpoint write object %d parent %d type %d chunk %d obj addr %x" TENDSTR),
4409                                                 cp.objectId, cp.parentId, cp.variantType, cp.hdrChunk, (unsigned) obj));
4410
4411                                         ok = (yaffs_CheckpointWrite(dev, &cp, sizeof(cp)) == sizeof(cp));
4412
4413                                         if (ok && obj->variantType == YAFFS_OBJECT_TYPE_FILE)
4414                                                 ok = yaffs_WriteCheckpointTnodes(obj);
4415                                 }
4416                         }
4417                 }
4418         }
4419
4420         /* Dump end of list */
4421         memset(&cp, 0xFF, sizeof(yaffs_CheckpointObject));
4422         cp.structType = sizeof(cp);
4423
4424         if (ok)
4425                 ok = (yaffs_CheckpointWrite(dev, &cp, sizeof(cp)) == sizeof(cp));
4426
4427         return ok ? 1 : 0;
4428 }
4429
4430 static int yaffs_ReadCheckpointObjects(yaffs_Device *dev)
4431 {
4432         yaffs_Object *obj;
4433         yaffs_CheckpointObject cp;
4434         int ok = 1;
4435         int done = 0;
4436         yaffs_Object *hardList = NULL;
4437
4438         while (ok && !done) {
4439                 ok = (yaffs_CheckpointRead(dev, &cp, sizeof(cp)) == sizeof(cp));
4440                 if (cp.structType != sizeof(cp)) {
4441                         T(YAFFS_TRACE_CHECKPOINT, (TSTR("struct size %d instead of %d ok %d"TENDSTR),
4442                                 cp.structType, sizeof(cp), ok));
4443                         ok = 0;
4444                 }
4445
4446                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("Checkpoint read object %d parent %d type %d chunk %d " TENDSTR),
4447                         cp.objectId, cp.parentId, cp.variantType, cp.hdrChunk));
4448
4449                 if (ok && cp.objectId == ~0)
4450                         done = 1;
4451                 else if (ok) {
4452                         obj = yaffs_FindOrCreateObjectByNumber(dev, cp.objectId, cp.variantType);
4453                         if (obj) {
4454                                 ok = yaffs_CheckpointObjectToObject(obj, &cp);
4455                                 if (!ok)
4456                                         break;
4457                                 if (obj->variantType == YAFFS_OBJECT_TYPE_FILE) {
4458                                         ok = yaffs_ReadCheckpointTnodes(obj);
4459                                 } else if (obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK) {
4460                                         obj->hardLinks.next =
4461                                                 (struct ylist_head *) hardList;
4462                                         hardList = obj;
4463                                 }
4464                         } else
4465                                 ok = 0;
4466                 }
4467         }
4468
4469         if (ok)
4470                 yaffs_HardlinkFixup(dev, hardList);
4471
4472         return ok ? 1 : 0;
4473 }
4474
4475 static int yaffs_WriteCheckpointSum(yaffs_Device *dev)
4476 {
4477         __u32 checkpointSum;
4478         int ok;
4479
4480         yaffs_GetCheckpointSum(dev, &checkpointSum);
4481
4482         ok = (yaffs_CheckpointWrite(dev, &checkpointSum, sizeof(checkpointSum)) == sizeof(checkpointSum));
4483
4484         if (!ok)
4485                 return 0;
4486
4487         return 1;
4488 }
4489
4490 static int yaffs_ReadCheckpointSum(yaffs_Device *dev)
4491 {
4492         __u32 checkpointSum0;
4493         __u32 checkpointSum1;
4494         int ok;
4495
4496         yaffs_GetCheckpointSum(dev, &checkpointSum0);
4497
4498         ok = (yaffs_CheckpointRead(dev, &checkpointSum1, sizeof(checkpointSum1)) == sizeof(checkpointSum1));
4499
4500         if (!ok)
4501                 return 0;
4502
4503         if (checkpointSum0 != checkpointSum1)
4504                 return 0;
4505
4506         return 1;
4507 }
4508
4509
4510 static int yaffs_WriteCheckpointData(yaffs_Device *dev)
4511 {
4512         int ok = 1;
4513
4514         if (dev->skipCheckpointWrite || !dev->isYaffs2) {
4515                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("skipping checkpoint write" TENDSTR)));
4516                 ok = 0;
4517         }
4518
4519         if (ok)
4520                 ok = yaffs_CheckpointOpen(dev, 1);
4521
4522         if (ok) {
4523                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("write checkpoint validity" TENDSTR)));
4524                 ok = yaffs_WriteCheckpointValidityMarker(dev, 1);
4525         }
4526         if (ok) {
4527                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("write checkpoint device" TENDSTR)));
4528                 ok = yaffs_WriteCheckpointDevice(dev);
4529         }
4530         if (ok) {
4531                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("write checkpoint objects" TENDSTR)));
4532                 ok = yaffs_WriteCheckpointObjects(dev);
4533         }
4534         if (ok) {
4535                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("write checkpoint validity" TENDSTR)));
4536                 ok = yaffs_WriteCheckpointValidityMarker(dev, 0);
4537         }
4538
4539         if (ok)
4540                 ok = yaffs_WriteCheckpointSum(dev);
4541
4542         if (!yaffs_CheckpointClose(dev))
4543                 ok = 0;
4544
4545         if (ok)
4546                 dev->isCheckpointed = 1;
4547         else
4548                 dev->isCheckpointed = 0;
4549
4550         return dev->isCheckpointed;
4551 }
4552
4553 static int yaffs_ReadCheckpointData(yaffs_Device *dev)
4554 {
4555         int ok = 1;
4556
4557         if (dev->skipCheckpointRead || !dev->isYaffs2) {
4558                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("skipping checkpoint read" TENDSTR)));
4559                 ok = 0;
4560         }
4561
4562         if (ok)
4563                 ok = yaffs_CheckpointOpen(dev, 0); /* open for read */
4564
4565         if (ok) {
4566                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("read checkpoint validity" TENDSTR)));
4567                 ok = yaffs_ReadCheckpointValidityMarker(dev, 1);
4568         }
4569         if (ok) {
4570                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("read checkpoint device" TENDSTR)));
4571                 ok = yaffs_ReadCheckpointDevice(dev);
4572         }
4573         if (ok) {
4574                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("read checkpoint objects" TENDSTR)));
4575                 ok = yaffs_ReadCheckpointObjects(dev);
4576         }
4577         if (ok) {
4578                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("read checkpoint validity" TENDSTR)));
4579                 ok = yaffs_ReadCheckpointValidityMarker(dev, 0);
4580         }
4581
4582         if (ok) {
4583                 ok = yaffs_ReadCheckpointSum(dev);
4584                 T(YAFFS_TRACE_CHECKPOINT, (TSTR("read checkpoint checksum %d" TENDSTR), ok));
4585         }
4586
4587         if (!yaffs_CheckpointClose(dev))
4588                 ok = 0;
4589
4590         if (ok)
4591                 dev->isCheckpointed = 1;
4592         else
4593                 dev->isCheckpointed = 0;
4594
4595         return ok ? 1 : 0;
4596
4597 }
4598
4599 static void yaffs_InvalidateCheckpoint(yaffs_Device *dev)
4600 {
4601         if (dev->isCheckpointed ||
4602                         dev->blocksInCheckpoint > 0) {
4603                 dev->isCheckpointed = 0;
4604                 yaffs_CheckpointInvalidateStream(dev);
4605                 if (dev->superBlock && dev->markSuperBlockDirty)
4606                         dev->markSuperBlockDirty(dev->superBlock);
4607         }
4608 }
4609
4610
4611 int yaffs_CheckpointSave(yaffs_Device *dev)
4612 {
4613
4614         T(YAFFS_TRACE_CHECKPOINT, (TSTR("save entry: isCheckpointed %d"TENDSTR), dev->isCheckpointed));
4615
4616         yaffs_VerifyObjects(dev);
4617         yaffs_VerifyBlocks(dev);
4618         yaffs_VerifyFreeChunks(dev);
4619
4620         if (!dev->isCheckpointed) {
4621                 yaffs_InvalidateCheckpoint(dev);
4622                 yaffs_WriteCheckpointData(dev);
4623         }
4624
4625         T(YAFFS_TRACE_ALWAYS, (TSTR("save exit: isCheckpointed %d"TENDSTR), dev->isCheckpointed));
4626
4627         return dev->isCheckpointed;
4628 }
4629
4630 int yaffs_CheckpointRestore(yaffs_Device *dev)
4631 {
4632         int retval;
4633         T(YAFFS_TRACE_CHECKPOINT, (TSTR("restore entry: isCheckpointed %d"TENDSTR), dev->isCheckpointed));
4634
4635         retval = yaffs_ReadCheckpointData(dev);
4636
4637         if (dev->isCheckpointed) {
4638                 yaffs_VerifyObjects(dev);
4639                 yaffs_VerifyBlocks(dev);
4640                 yaffs_VerifyFreeChunks(dev);
4641         }
4642
4643         T(YAFFS_TRACE_CHECKPOINT, (TSTR("restore exit: isCheckpointed %d"TENDSTR), dev->isCheckpointed));
4644
4645         return retval;
4646 }
4647
4648 /*--------------------- File read/write ------------------------
4649  * Read and write have very similar structures.
4650  * In general the read/write has three parts to it
4651  * An incomplete chunk to start with (if the read/write is not chunk-aligned)
4652  * Some complete chunks
4653  * An incomplete chunk to end off with
4654  *
4655  * Curve-balls: the first chunk might also be the last chunk.
4656  */
4657
4658 int yaffs_ReadDataFromFile(yaffs_Object *in, __u8 *buffer, loff_t offset,
4659                         int nBytes)
4660 {
4661
4662         int chunk;
4663         __u32 start;
4664         int nToCopy;
4665         int n = nBytes;
4666         int nDone = 0;
4667         yaffs_ChunkCache *cache;
4668
4669         yaffs_Device *dev;
4670
4671         dev = in->myDev;
4672
4673         while (n > 0) {
4674                 /* chunk = offset / dev->nDataBytesPerChunk + 1; */
4675                 /* start = offset % dev->nDataBytesPerChunk; */
4676                 yaffs_AddrToChunk(dev, offset, &chunk, &start);
4677                 chunk++;
4678
4679                 /* OK now check for the curveball where the start and end are in
4680                  * the same chunk.
4681                  */
4682                 if ((start + n) < dev->nDataBytesPerChunk)
4683                         nToCopy = n;
4684                 else
4685                         nToCopy = dev->nDataBytesPerChunk - start;
4686
4687                 cache = yaffs_FindChunkCache(in, chunk);
4688
4689                 /* If the chunk is already in the cache or it is less than a whole chunk
4690                  * or we're using inband tags then use the cache (if there is caching)
4691                  * else bypass the cache.
4692                  */
4693                 if (cache || nToCopy != dev->nDataBytesPerChunk || dev->inbandTags) {
4694                         if (dev->nShortOpCaches > 0) {
4695
4696                                 /* If we can't find the data in the cache, then load it up. */
4697
4698                                 if (!cache) {
4699                                         cache = yaffs_GrabChunkCache(in->myDev);
4700                                         cache->object = in;
4701                                         cache->chunkId = chunk;
4702                                         cache->dirty = 0;
4703                                         cache->locked = 0;
4704                                         yaffs_ReadChunkDataFromObject(in, chunk,
4705                                                                       cache->
4706                                                                       data);
4707                                         cache->nBytes = 0;
4708                                 }
4709
4710                                 yaffs_UseChunkCache(dev, cache, 0);
4711
4712                                 cache->locked = 1;
4713
4714
4715                                 memcpy(buffer, &cache->data[start], nToCopy);
4716
4717                                 cache->locked = 0;
4718                         } else {
4719                                 /* Read into the local buffer then copy..*/
4720
4721                                 __u8 *localBuffer =
4722                                     yaffs_GetTempBuffer(dev, __LINE__);
4723                                 yaffs_ReadChunkDataFromObject(in, chunk,
4724                                                               localBuffer);
4725
4726                                 memcpy(buffer, &localBuffer[start], nToCopy);
4727
4728
4729                                 yaffs_ReleaseTempBuffer(dev, localBuffer,
4730                                                         __LINE__);
4731                         }
4732
4733                 } else {
4734
4735                         /* A full chunk. Read directly into the supplied buffer. */
4736                         yaffs_ReadChunkDataFromObject(in, chunk, buffer);
4737
4738                 }
4739
4740                 n -= nToCopy;
4741                 offset += nToCopy;
4742                 buffer += nToCopy;
4743                 nDone += nToCopy;
4744
4745         }
4746
4747         return nDone;
4748 }
4749
4750 int yaffs_WriteDataToFile(yaffs_Object *in, const __u8 *buffer, loff_t offset,
4751                         int nBytes, int writeThrough)
4752 {
4753
4754         int chunk;
4755         __u32 start;
4756         int nToCopy;
4757         int n = nBytes;
4758         int nDone = 0;
4759         int nToWriteBack;
4760         int startOfWrite = offset;
4761         int chunkWritten = 0;
4762         __u32 nBytesRead;
4763         __u32 chunkStart;
4764
4765         yaffs_Device *dev;
4766
4767         dev = in->myDev;
4768
4769         while (n > 0 && chunkWritten >= 0) {
4770                 /* chunk = offset / dev->nDataBytesPerChunk + 1; */
4771                 /* start = offset % dev->nDataBytesPerChunk; */
4772                 yaffs_AddrToChunk(dev, offset, &chunk, &start);
4773
4774                 if (chunk * dev->nDataBytesPerChunk + start != offset ||
4775                                 start >= dev->nDataBytesPerChunk) {
4776                         T(YAFFS_TRACE_ERROR, (
4777                            TSTR("AddrToChunk of offset %d gives chunk %d start %d"
4778                            TENDSTR),
4779                            (int)offset, chunk, start));
4780                 }
4781                 chunk++;
4782
4783                 /* OK now check for the curveball where the start and end are in
4784                  * the same chunk.
4785                  */
4786
4787                 if ((start + n) < dev->nDataBytesPerChunk) {
4788                         nToCopy = n;
4789
4790                         /* Now folks, to calculate how many bytes to write back....
4791                          * If we're overwriting and not writing to then end of file then
4792                          * we need to write back as much as was there before.
4793                          */
4794
4795                         chunkStart = ((chunk - 1) * dev->nDataBytesPerChunk);
4796
4797                         if (chunkStart > in->variant.fileVariant.fileSize)
4798                                 nBytesRead = 0; /* Past end of file */
4799                         else
4800                                 nBytesRead = in->variant.fileVariant.fileSize - chunkStart;
4801
4802                         if (nBytesRead > dev->nDataBytesPerChunk)
4803                                 nBytesRead = dev->nDataBytesPerChunk;
4804
4805                         nToWriteBack =
4806                             (nBytesRead >
4807                              (start + n)) ? nBytesRead : (start + n);
4808
4809                         if (nToWriteBack < 0 || nToWriteBack > dev->nDataBytesPerChunk)
4810                                 YBUG();
4811
4812                 } else {
4813                         nToCopy = dev->nDataBytesPerChunk - start;
4814                         nToWriteBack = dev->nDataBytesPerChunk;
4815                 }
4816
4817                 if (nToCopy != dev->nDataBytesPerChunk || dev->inbandTags) {
4818                         /* An incomplete start or end chunk (or maybe both start and end chunk),
4819                          * or we're using inband tags, so we want to use the cache buffers.
4820                          */
4821                         if (dev->nShortOpCaches > 0) {
4822                                 yaffs_ChunkCache *cache;
4823                                 /* If we can't find the data in the cache, then load the cache */
4824                                 cache = yaffs_FindChunkCache(in, chunk);
4825
4826                                 if (!cache
4827                                     && yaffs_CheckSpaceForAllocation(in->
4828                                                                      myDev)) {
4829                                         cache = yaffs_GrabChunkCache(in->myDev);
4830                                         cache->object = in;
4831                                         cache->chunkId = chunk;
4832                                         cache->dirty = 0;
4833                                         cache->locked = 0;
4834                                         yaffs_ReadChunkDataFromObject(in, chunk,
4835                                                                       cache->
4836                                                                       data);
4837                                 } else if (cache &&
4838                                         !cache->dirty &&
4839                                         !yaffs_CheckSpaceForAllocation(in->myDev)) {
4840                                         /* Drop the cache if it was a read cache item and
4841                                          * no space check has been made for it.
4842                                          */
4843                                          cache = NULL;
4844                                 }
4845
4846                                 if (cache) {
4847                                         yaffs_UseChunkCache(dev, cache, 1);
4848                                         cache->locked = 1;
4849
4850
4851                                         memcpy(&cache->data[start], buffer,
4852                                                nToCopy);
4853
4854
4855                                         cache->locked = 0;
4856                                         cache->nBytes = nToWriteBack;
4857
4858                                         if (writeThrough) {
4859                                                 chunkWritten =
4860                                                     yaffs_WriteChunkDataToObject
4861                                                     (cache->object,
4862                                                      cache->chunkId,
4863                                                      cache->data, cache->nBytes,
4864                                                      1);
4865                                                 cache->dirty = 0;
4866                                         }
4867
4868                                 } else {
4869                                         chunkWritten = -1;      /* fail the write */
4870                                 }
4871                         } else {
4872                                 /* An incomplete start or end chunk (or maybe both start and end chunk)
4873                                  * Read into the local buffer then copy, then copy over and write back.
4874                                  */
4875
4876                                 __u8 *localBuffer =
4877                                     yaffs_GetTempBuffer(dev, __LINE__);
4878
4879                                 yaffs_ReadChunkDataFromObject(in, chunk,
4880                                                               localBuffer);
4881
4882
4883
4884                                 memcpy(&localBuffer[start], buffer, nToCopy);
4885
4886                                 chunkWritten =
4887                                     yaffs_WriteChunkDataToObject(in, chunk,
4888                                                                  localBuffer,
4889                                                                  nToWriteBack,
4890                                                                  0);
4891
4892                                 yaffs_ReleaseTempBuffer(dev, localBuffer,
4893                                                         __LINE__);
4894
4895                         }
4896
4897                 } else {
4898                         /* A full chunk. Write directly from the supplied buffer. */
4899
4900
4901
4902                         chunkWritten =
4903                             yaffs_WriteChunkDataToObject(in, chunk, buffer,
4904                                                          dev->nDataBytesPerChunk,
4905                                                          0);
4906
4907                         /* Since we've overwritten the cached data, we better invalidate it. */
4908                         yaffs_InvalidateChunkCache(in, chunk);
4909                 }
4910
4911                 if (chunkWritten >= 0) {
4912                         n -= nToCopy;
4913                         offset += nToCopy;
4914                         buffer += nToCopy;
4915                         nDone += nToCopy;
4916                 }
4917
4918         }
4919
4920         /* Update file object */
4921
4922         if ((startOfWrite + nDone) > in->variant.fileVariant.fileSize)
4923                 in->variant.fileVariant.fileSize = (startOfWrite + nDone);
4924
4925         in->dirty = 1;
4926
4927         return nDone;
4928 }
4929
4930
4931 /* ---------------------- File resizing stuff ------------------ */
4932
4933 static void yaffs_PruneResizedChunks(yaffs_Object *in, int newSize)
4934 {
4935
4936         yaffs_Device *dev = in->myDev;
4937         int oldFileSize = in->variant.fileVariant.fileSize;
4938
4939         int lastDel = 1 + (oldFileSize - 1) / dev->nDataBytesPerChunk;
4940
4941         int startDel = 1 + (newSize + dev->nDataBytesPerChunk - 1) /
4942             dev->nDataBytesPerChunk;
4943         int i;
4944         int chunkId;
4945
4946         /* Delete backwards so that we don't end up with holes if
4947          * power is lost part-way through the operation.
4948          */
4949         for (i = lastDel; i >= startDel; i--) {
4950                 /* NB this could be optimised somewhat,
4951                  * eg. could retrieve the tags and write them without
4952                  * using yaffs_DeleteChunk
4953                  */
4954
4955                 chunkId = yaffs_FindAndDeleteChunkInFile(in, i, NULL);
4956                 if (chunkId > 0) {
4957                         if (chunkId <
4958                             (dev->internalStartBlock * dev->nChunksPerBlock)
4959                             || chunkId >=
4960                             ((dev->internalEndBlock +
4961                               1) * dev->nChunksPerBlock)) {
4962                                 T(YAFFS_TRACE_ALWAYS,
4963                                   (TSTR("Found daft chunkId %d for %d" TENDSTR),
4964                                    chunkId, i));
4965                         } else {
4966                                 in->nDataChunks--;
4967                                 yaffs_DeleteChunk(dev, chunkId, 1, __LINE__);
4968                         }
4969                 }
4970         }
4971
4972 }
4973
4974 int yaffs_ResizeFile(yaffs_Object *in, loff_t newSize)
4975 {
4976
4977         int oldFileSize = in->variant.fileVariant.fileSize;
4978         __u32 newSizeOfPartialChunk;
4979         int newFullChunks;
4980
4981         yaffs_Device *dev = in->myDev;
4982
4983         yaffs_AddrToChunk(dev, newSize, &newFullChunks, &newSizeOfPartialChunk);
4984
4985         yaffs_FlushFilesChunkCache(in);
4986         yaffs_InvalidateWholeChunkCache(in);
4987
4988         yaffs_CheckGarbageCollection(dev);
4989
4990         if (in->variantType != YAFFS_OBJECT_TYPE_FILE)
4991                 return YAFFS_FAIL;
4992
4993         if (newSize == oldFileSize)
4994                 return YAFFS_OK;
4995
4996         if (newSize < oldFileSize) {
4997
4998                 yaffs_PruneResizedChunks(in, newSize);
4999
5000                 if (newSizeOfPartialChunk != 0) {
5001                         int lastChunk = 1 + newFullChunks;
5002
5003                         __u8 *localBuffer = yaffs_GetTempBuffer(dev, __LINE__);
5004
5005                         /* Got to read and rewrite the last chunk with its new size and zero pad */
5006                         yaffs_ReadChunkDataFromObject(in, lastChunk,
5007                                                       localBuffer);
5008
5009                         memset(localBuffer + newSizeOfPartialChunk, 0,
5010                                dev->nDataBytesPerChunk - newSizeOfPartialChunk);
5011
5012                         yaffs_WriteChunkDataToObject(in, lastChunk, localBuffer,
5013                                                      newSizeOfPartialChunk, 1);
5014
5015                         yaffs_ReleaseTempBuffer(dev, localBuffer, __LINE__);
5016                 }
5017
5018                 in->variant.fileVariant.fileSize = newSize;
5019
5020                 yaffs_PruneFileStructure(dev, &in->variant.fileVariant);
5021         } else {
5022                 /* newsSize > oldFileSize */
5023                 in->variant.fileVariant.fileSize = newSize;
5024         }
5025
5026
5027         /* Write a new object header.
5028          * show we've shrunk the file, if need be
5029          * Do this only if the file is not in the deleted directories.
5030          */
5031         if (in->parent &&
5032             in->parent->objectId != YAFFS_OBJECTID_UNLINKED &&
5033             in->parent->objectId != YAFFS_OBJECTID_DELETED)
5034                 yaffs_UpdateObjectHeader(in, NULL, 0,
5035                                          (newSize < oldFileSize) ? 1 : 0, 0);
5036
5037         return YAFFS_OK;
5038 }
5039
5040 loff_t yaffs_GetFileSize(yaffs_Object *obj)
5041 {
5042         obj = yaffs_GetEquivalentObject(obj);
5043
5044         switch (obj->variantType) {
5045         case YAFFS_OBJECT_TYPE_FILE:
5046                 return obj->variant.fileVariant.fileSize;
5047         case YAFFS_OBJECT_TYPE_SYMLINK:
5048                 return yaffs_strlen(obj->variant.symLinkVariant.alias);
5049         default:
5050                 return 0;
5051         }
5052 }
5053
5054
5055
5056 int yaffs_FlushFile(yaffs_Object *in, int updateTime)
5057 {
5058         int retVal;
5059         if (in->dirty) {
5060                 yaffs_FlushFilesChunkCache(in);
5061                 if (updateTime) {
5062 #ifdef CONFIG_YAFFS_WINCE
5063                         yfsd_WinFileTimeNow(in->win_mtime);
5064 #else
5065
5066                         in->yst_mtime = Y_CURRENT_TIME;
5067
5068 #endif
5069                 }
5070
5071                 retVal = (yaffs_UpdateObjectHeader(in, NULL, 0, 0, 0) >=
5072                         0) ? YAFFS_OK : YAFFS_FAIL;
5073         } else {
5074                 retVal = YAFFS_OK;
5075         }
5076
5077         return retVal;
5078
5079 }
5080
5081 static int yaffs_DoGenericObjectDeletion(yaffs_Object *in)
5082 {
5083
5084         /* First off, invalidate the file's data in the cache, without flushing. */
5085         yaffs_InvalidateWholeChunkCache(in);
5086
5087         if (in->myDev->isYaffs2 && (in->parent != in->myDev->deletedDir)) {
5088                 /* Move to the unlinked directory so we have a record that it was deleted. */
5089                 yaffs_ChangeObjectName(in, in->myDev->deletedDir, _Y("deleted"), 0, 0);
5090
5091         }
5092
5093         yaffs_RemoveObjectFromDirectory(in);
5094         yaffs_DeleteChunk(in->myDev, in->hdrChunk, 1, __LINE__);
5095         in->hdrChunk = 0;
5096
5097         yaffs_FreeObject(in);
5098         return YAFFS_OK;
5099
5100 }
5101
5102 /* yaffs_DeleteFile deletes the whole file data
5103  * and the inode associated with the file.
5104  * It does not delete the links associated with the file.
5105  */
5106 static int yaffs_UnlinkFileIfNeeded(yaffs_Object *in)
5107 {
5108
5109         int retVal;
5110         int immediateDeletion = 0;
5111
5112 #ifdef __KERNEL__
5113         if (!in->myInode)
5114                 immediateDeletion = 1;
5115 #else
5116         if (in->inUse <= 0)
5117                 immediateDeletion = 1;
5118 #endif
5119
5120         if (immediateDeletion) {
5121                 retVal =
5122                     yaffs_ChangeObjectName(in, in->myDev->deletedDir,
5123                                            _Y("deleted"), 0, 0);
5124                 T(YAFFS_TRACE_TRACING,
5125                   (TSTR("yaffs: immediate deletion of file %d" TENDSTR),
5126                    in->objectId));
5127                 in->deleted = 1;
5128                 in->myDev->nDeletedFiles++;
5129                 if (1 || in->myDev->isYaffs2)
5130                         yaffs_ResizeFile(in, 0);
5131                 yaffs_SoftDeleteFile(in);
5132         } else {
5133                 retVal =
5134                     yaffs_ChangeObjectName(in, in->myDev->unlinkedDir,
5135                                            _Y("unlinked"), 0, 0);
5136         }
5137
5138
5139         return retVal;
5140 }
5141
5142 int yaffs_DeleteFile(yaffs_Object *in)
5143 {
5144         int retVal = YAFFS_OK;
5145         int deleted = in->deleted;
5146
5147         yaffs_ResizeFile(in, 0);
5148
5149         if (in->nDataChunks > 0) {
5150                 /* Use soft deletion if there is data in the file.
5151                  * That won't be the case if it has been resized to zero.
5152                  */
5153                 if (!in->unlinked)
5154                         retVal = yaffs_UnlinkFileIfNeeded(in);
5155
5156                 if (retVal == YAFFS_OK && in->unlinked && !in->deleted) {
5157                         in->deleted = 1;
5158                         deleted = 1;
5159                         in->myDev->nDeletedFiles++;
5160                         yaffs_SoftDeleteFile(in);
5161                 }
5162                 return deleted ? YAFFS_OK : YAFFS_FAIL;
5163         } else {
5164                 /* The file has no data chunks so we toss it immediately */
5165                 yaffs_FreeTnode(in->myDev, in->variant.fileVariant.top);
5166                 in->variant.fileVariant.top = NULL;
5167                 yaffs_DoGenericObjectDeletion(in);
5168
5169                 return YAFFS_OK;
5170         }
5171 }
5172
5173 static int yaffs_DeleteDirectory(yaffs_Object *in)
5174 {
5175         /* First check that the directory is empty. */
5176         if (ylist_empty(&in->variant.directoryVariant.children))
5177                 return yaffs_DoGenericObjectDeletion(in);
5178
5179         return YAFFS_FAIL;
5180
5181 }
5182
5183 static int yaffs_DeleteSymLink(yaffs_Object *in)
5184 {
5185         YFREE(in->variant.symLinkVariant.alias);
5186
5187         return yaffs_DoGenericObjectDeletion(in);
5188 }
5189
5190 static int yaffs_DeleteHardLink(yaffs_Object *in)
5191 {
5192         /* remove this hardlink from the list assocaited with the equivalent
5193          * object
5194          */
5195         ylist_del_init(&in->hardLinks);
5196         return yaffs_DoGenericObjectDeletion(in);
5197 }
5198
5199 int yaffs_DeleteObject(yaffs_Object *obj)
5200 {
5201 int retVal = -1;
5202         switch (obj->variantType) {
5203         case YAFFS_OBJECT_TYPE_FILE:
5204                 retVal = yaffs_DeleteFile(obj);
5205                 break;
5206         case YAFFS_OBJECT_TYPE_DIRECTORY:
5207                 return yaffs_DeleteDirectory(obj);
5208                 break;
5209         case YAFFS_OBJECT_TYPE_SYMLINK:
5210                 retVal = yaffs_DeleteSymLink(obj);
5211                 break;
5212         case YAFFS_OBJECT_TYPE_HARDLINK:
5213                 retVal = yaffs_DeleteHardLink(obj);
5214                 break;
5215         case YAFFS_OBJECT_TYPE_SPECIAL:
5216                 retVal = yaffs_DoGenericObjectDeletion(obj);
5217                 break;
5218         case YAFFS_OBJECT_TYPE_UNKNOWN:
5219                 retVal = 0;
5220                 break;          /* should not happen. */
5221         }
5222
5223         return retVal;
5224 }
5225
5226 static int yaffs_UnlinkWorker(yaffs_Object *obj)
5227 {
5228
5229         int immediateDeletion = 0;
5230
5231 #ifdef __KERNEL__
5232         if (!obj->myInode)
5233                 immediateDeletion = 1;
5234 #else
5235         if (obj->inUse <= 0)
5236                 immediateDeletion = 1;
5237 #endif
5238
5239         if(obj)
5240                 yaffs_UpdateParent(obj->parent);
5241
5242         if (obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK) {
5243                 return yaffs_DeleteHardLink(obj);
5244         } else if (!ylist_empty(&obj->hardLinks)) {
5245                 /* Curve ball: We're unlinking an object that has a hardlink.
5246                  *
5247                  * This problem arises because we are not strictly following
5248                  * The Linux link/inode model.
5249                  *
5250                  * We can't really delete the object.
5251                  * Instead, we do the following:
5252                  * - Select a hardlink.
5253                  * - Unhook it from the hard links
5254                  * - Unhook it from its parent directory (so that the rename can work)
5255                  * - Rename the object to the hardlink's name.
5256                  * - Delete the hardlink
5257                  */
5258
5259                 yaffs_Object *hl;
5260                 int retVal;
5261                 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
5262
5263                 hl = ylist_entry(obj->hardLinks.next, yaffs_Object, hardLinks);
5264
5265                 ylist_del_init(&hl->hardLinks);
5266                 ylist_del_init(&hl->siblings);
5267
5268                 yaffs_GetObjectName(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
5269
5270                 retVal = yaffs_ChangeObjectName(obj, hl->parent, name, 0, 0);
5271
5272                 if (retVal == YAFFS_OK)
5273                         retVal = yaffs_DoGenericObjectDeletion(hl);
5274
5275                 return retVal;
5276
5277         } else if (immediateDeletion) {
5278                 switch (obj->variantType) {
5279                 case YAFFS_OBJECT_TYPE_FILE:
5280                         return yaffs_DeleteFile(obj);
5281                         break;
5282                 case YAFFS_OBJECT_TYPE_DIRECTORY:
5283                         return yaffs_DeleteDirectory(obj);
5284                         break;
5285                 case YAFFS_OBJECT_TYPE_SYMLINK:
5286                         return yaffs_DeleteSymLink(obj);
5287                         break;
5288                 case YAFFS_OBJECT_TYPE_SPECIAL:
5289                         return yaffs_DoGenericObjectDeletion(obj);
5290                         break;
5291                 case YAFFS_OBJECT_TYPE_HARDLINK:
5292                 case YAFFS_OBJECT_TYPE_UNKNOWN:
5293                 default:
5294                         return YAFFS_FAIL;
5295                 }
5296         } else
5297                 return yaffs_ChangeObjectName(obj, obj->myDev->unlinkedDir,
5298                                            _Y("unlinked"), 0, 0);
5299 }
5300
5301
5302 static int yaffs_UnlinkObject(yaffs_Object *obj)
5303 {
5304
5305         if (obj && obj->unlinkAllowed)
5306                 return yaffs_UnlinkWorker(obj);
5307
5308         return YAFFS_FAIL;
5309
5310 }
5311 int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name)
5312 {
5313         yaffs_Object *obj;
5314
5315         obj = yaffs_FindObjectByName(dir, name);
5316         return yaffs_UnlinkObject(obj);
5317 }
5318
5319 /*----------------------- Initialisation Scanning ---------------------- */
5320
5321 static void yaffs_HandleShadowedObject(yaffs_Device *dev, int objId,
5322                                 int backwardScanning)
5323 {
5324         yaffs_Object *obj;
5325
5326         if (!backwardScanning) {
5327                 /* Handle YAFFS1 forward scanning case
5328                  * For YAFFS1 we always do the deletion
5329                  */
5330
5331         } else {
5332                 /* Handle YAFFS2 case (backward scanning)
5333                  * If the shadowed object exists then ignore.
5334                  */
5335                 if (yaffs_FindObjectByNumber(dev, objId))
5336                         return;
5337         }
5338
5339         /* Let's create it (if it does not exist) assuming it is a file so that it can do shrinking etc.
5340          * We put it in unlinked dir to be cleaned up after the scanning
5341          */
5342         obj =
5343             yaffs_FindOrCreateObjectByNumber(dev, objId,
5344                                              YAFFS_OBJECT_TYPE_FILE);
5345         if (!obj)
5346                 return;
5347         yaffs_AddObjectToDirectory(dev->unlinkedDir, obj);
5348         obj->variant.fileVariant.shrinkSize = 0;
5349         obj->valid = 1;         /* So that we don't read any other info for this file */
5350
5351 }
5352
5353 typedef struct {
5354         int seq;
5355         int block;
5356 } yaffs_BlockIndex;
5357
5358
5359 static void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList)
5360 {
5361         yaffs_Object *hl;
5362         yaffs_Object *in;
5363
5364         while (hardList) {
5365                 hl = hardList;
5366                 hardList = (yaffs_Object *) (hardList->hardLinks.next);
5367
5368                 in = yaffs_FindObjectByNumber(dev,
5369                                               hl->variant.hardLinkVariant.
5370                                               equivalentObjectId);
5371
5372                 if (in) {
5373                         /* Add the hardlink pointers */
5374                         hl->variant.hardLinkVariant.equivalentObject = in;
5375                         ylist_add(&hl->hardLinks, &in->hardLinks);
5376                 } else {
5377                         /* Todo Need to report/handle this better.
5378                          * Got a problem... hardlink to a non-existant object
5379                          */
5380                         hl->variant.hardLinkVariant.equivalentObject = NULL;
5381                         YINIT_LIST_HEAD(&hl->hardLinks);
5382
5383                 }
5384         }
5385 }
5386
5387
5388
5389
5390
5391 static int ybicmp(const void *a, const void *b)
5392 {
5393         register int aseq = ((yaffs_BlockIndex *)a)->seq;
5394         register int bseq = ((yaffs_BlockIndex *)b)->seq;
5395         register int ablock = ((yaffs_BlockIndex *)a)->block;
5396         register int bblock = ((yaffs_BlockIndex *)b)->block;
5397         if (aseq == bseq)
5398                 return ablock - bblock;
5399         else
5400                 return aseq - bseq;
5401 }
5402
5403
5404 struct yaffs_ShadowFixerStruct {
5405         int objectId;
5406         int shadowedId;
5407         struct yaffs_ShadowFixerStruct *next;
5408 };
5409
5410
5411 static void yaffs_StripDeletedObjects(yaffs_Device *dev)
5412 {
5413         /*
5414         *  Sort out state of unlinked and deleted objects after scanning.
5415         */
5416         struct ylist_head *i;
5417         struct ylist_head *n;
5418         yaffs_Object *l;
5419
5420         /* Soft delete all the unlinked files */
5421         ylist_for_each_safe(i, n,
5422                 &dev->unlinkedDir->variant.directoryVariant.children) {
5423                 if (i) {
5424                         l = ylist_entry(i, yaffs_Object, siblings);
5425                         yaffs_DeleteObject(l);
5426                 }
5427         }
5428
5429         ylist_for_each_safe(i, n,
5430                 &dev->deletedDir->variant.directoryVariant.children) {
5431                 if (i) {
5432                         l = ylist_entry(i, yaffs_Object, siblings);
5433                         yaffs_DeleteObject(l);
5434                 }
5435         }
5436
5437 }
5438
5439 static int yaffs_Scan(yaffs_Device *dev)
5440 {
5441         yaffs_ExtendedTags tags;
5442         int blk;
5443         int blockIterator;
5444         int startIterator;
5445         int endIterator;
5446         int result;
5447
5448         int chunk;
5449         int c;
5450         int deleted;
5451         yaffs_BlockState state;
5452         yaffs_Object *hardList = NULL;
5453         yaffs_BlockInfo *bi;
5454         __u32 sequenceNumber;
5455         yaffs_ObjectHeader *oh;
5456         yaffs_Object *in;
5457         yaffs_Object *parent;
5458
5459         int alloc_failed = 0;
5460
5461         struct yaffs_ShadowFixerStruct *shadowFixerList = NULL;
5462
5463
5464         __u8 *chunkData;
5465
5466
5467
5468         T(YAFFS_TRACE_SCAN,
5469           (TSTR("yaffs_Scan starts  intstartblk %d intendblk %d..." TENDSTR),
5470            dev->internalStartBlock, dev->internalEndBlock));
5471
5472         chunkData = yaffs_GetTempBuffer(dev, __LINE__);
5473
5474         dev->sequenceNumber = YAFFS_LOWEST_SEQUENCE_NUMBER;
5475
5476         /* Scan all the blocks to determine their state */
5477         for (blk = dev->internalStartBlock; blk <= dev->internalEndBlock; blk++) {
5478                 bi = yaffs_GetBlockInfo(dev, blk);
5479                 yaffs_ClearChunkBits(dev, blk);
5480                 bi->pagesInUse = 0;
5481                 bi->softDeletions = 0;
5482
5483                 yaffs_QueryInitialBlockState(dev, blk, &state, &sequenceNumber);
5484
5485                 bi->blockState = state;
5486                 bi->sequenceNumber = sequenceNumber;
5487
5488                 if (bi->sequenceNumber == YAFFS_SEQUENCE_BAD_BLOCK)
5489                         bi->blockState = state = YAFFS_BLOCK_STATE_DEAD;
5490
5491                 T(YAFFS_TRACE_SCAN_DEBUG,
5492                   (TSTR("Block scanning block %d state %d seq %d" TENDSTR), blk,
5493                    state, sequenceNumber));
5494
5495                 if (state == YAFFS_BLOCK_STATE_DEAD) {
5496                         T(YAFFS_TRACE_BAD_BLOCKS,
5497                           (TSTR("block %d is bad" TENDSTR), blk));
5498                 } else if (state == YAFFS_BLOCK_STATE_EMPTY) {
5499                         T(YAFFS_TRACE_SCAN_DEBUG,
5500                           (TSTR("Block empty " TENDSTR)));
5501                         dev->nErasedBlocks++;
5502                         dev->nFreeChunks += dev->nChunksPerBlock;
5503                 }
5504         }
5505
5506         startIterator = dev->internalStartBlock;
5507         endIterator = dev->internalEndBlock;
5508
5509         /* For each block.... */
5510         for (blockIterator = startIterator; !alloc_failed && blockIterator <= endIterator;
5511              blockIterator++) {
5512
5513                 YYIELD();
5514
5515                 YYIELD();
5516
5517                 blk = blockIterator;
5518
5519                 bi = yaffs_GetBlockInfo(dev, blk);
5520                 state = bi->blockState;
5521
5522                 deleted = 0;
5523
5524                 /* For each chunk in each block that needs scanning....*/
5525                 for (c = 0; !alloc_failed && c < dev->nChunksPerBlock &&
5526                      state == YAFFS_BLOCK_STATE_NEEDS_SCANNING; c++) {
5527                         /* Read the tags and decide what to do */
5528                         chunk = blk * dev->nChunksPerBlock + c;
5529
5530                         result = yaffs_ReadChunkWithTagsFromNAND(dev, chunk, NULL,
5531                                                         &tags);
5532
5533                         /* Let's have a good look at this chunk... */
5534
5535                         if (tags.eccResult == YAFFS_ECC_RESULT_UNFIXED || tags.chunkDeleted) {
5536                                 /* YAFFS1 only...
5537                                  * A deleted chunk
5538                                  */
5539                                 deleted++;
5540                                 dev->nFreeChunks++;
5541                                 /*T((" %d %d deleted\n",blk,c)); */
5542                         } else if (!tags.chunkUsed) {
5543                                 /* An unassigned chunk in the block
5544                                  * This means that either the block is empty or
5545                                  * this is the one being allocated from
5546                                  */
5547
5548                                 if (c == 0) {
5549                                         /* We're looking at the first chunk in the block so the block is unused */
5550                                         state = YAFFS_BLOCK_STATE_EMPTY;
5551                                         dev->nErasedBlocks++;
5552                                 } else {
5553                                         /* this is the block being allocated from */
5554                                         T(YAFFS_TRACE_SCAN,
5555                                           (TSTR
5556                                            (" Allocating from %d %d" TENDSTR),
5557                                            blk, c));
5558                                         state = YAFFS_BLOCK_STATE_ALLOCATING;
5559                                         dev->allocationBlock = blk;
5560                                         dev->allocationPage = c;
5561                                         dev->allocationBlockFinder = blk;
5562                                         /* Set it to here to encourage the allocator to go forth from here. */
5563
5564                                 }
5565
5566                                 dev->nFreeChunks += (dev->nChunksPerBlock - c);
5567                         } else if (tags.chunkId > 0) {
5568                                 /* chunkId > 0 so it is a data chunk... */
5569                                 unsigned int endpos;
5570
5571                                 yaffs_SetChunkBit(dev, blk, c);
5572                                 bi->pagesInUse++;
5573
5574                                 in = yaffs_FindOrCreateObjectByNumber(dev,
5575                                                                       tags.
5576                                                                       objectId,
5577                                                                       YAFFS_OBJECT_TYPE_FILE);
5578                                 /* PutChunkIntoFile checks for a clash (two data chunks with
5579                                  * the same chunkId).
5580                                  */
5581
5582                                 if (!in)
5583                                         alloc_failed = 1;
5584
5585                                 if (in) {
5586                                         if (!yaffs_PutChunkIntoFile(in, tags.chunkId, chunk, 1))
5587                                                 alloc_failed = 1;
5588                                 }
5589
5590                                 endpos =
5591                                     (tags.chunkId - 1) * dev->nDataBytesPerChunk +
5592                                     tags.byteCount;
5593                                 if (in &&
5594                                     in->variantType == YAFFS_OBJECT_TYPE_FILE
5595                                     && in->variant.fileVariant.scannedFileSize <
5596                                     endpos) {
5597                                         in->variant.fileVariant.
5598                                             scannedFileSize = endpos;
5599                                         if (!dev->useHeaderFileSize) {
5600                                                 in->variant.fileVariant.
5601                                                     fileSize =
5602                                                     in->variant.fileVariant.
5603                                                     scannedFileSize;
5604                                         }
5605
5606                                 }
5607                                 /* T((" %d %d data %d %d\n",blk,c,tags.objectId,tags.chunkId));   */
5608                         } else {
5609                                 /* chunkId == 0, so it is an ObjectHeader.
5610                                  * Thus, we read in the object header and make the object
5611                                  */
5612                                 yaffs_SetChunkBit(dev, blk, c);
5613                                 bi->pagesInUse++;
5614
5615                                 result = yaffs_ReadChunkWithTagsFromNAND(dev, chunk,
5616                                                                 chunkData,
5617                                                                 NULL);
5618
5619                                 oh = (yaffs_ObjectHeader *) chunkData;
5620
5621                                 in = yaffs_FindObjectByNumber(dev,
5622                                                               tags.objectId);
5623                                 if (in && in->variantType != oh->type) {
5624                                         /* This should not happen, but somehow
5625                                          * Wev'e ended up with an objectId that has been reused but not yet
5626                                          * deleted, and worse still it has changed type. Delete the old object.
5627                                          */
5628
5629                                         yaffs_DeleteObject(in);
5630
5631                                         in = 0;
5632                                 }
5633
5634                                 in = yaffs_FindOrCreateObjectByNumber(dev,
5635                                                                       tags.
5636                                                                       objectId,
5637                                                                       oh->type);
5638
5639                                 if (!in)
5640                                         alloc_failed = 1;
5641
5642                                 if (in && oh->shadowsObject > 0) {
5643
5644                                         struct yaffs_ShadowFixerStruct *fixer;
5645                                         fixer = YMALLOC(sizeof(struct yaffs_ShadowFixerStruct));
5646                                         if (fixer) {
5647                                                 fixer->next = shadowFixerList;
5648                                                 shadowFixerList = fixer;
5649                                                 fixer->objectId = tags.objectId;
5650                                                 fixer->shadowedId = oh->shadowsObject;
5651                                         }
5652
5653                                 }
5654
5655                                 if (in && in->valid) {
5656                                         /* We have already filled this one. We have a duplicate and need to resolve it. */
5657
5658                                         unsigned existingSerial = in->serial;
5659                                         unsigned newSerial = tags.serialNumber;
5660
5661                                         if (((existingSerial + 1) & 3) == newSerial) {
5662                                                 /* Use new one - destroy the exisiting one */
5663                                                 yaffs_DeleteChunk(dev,
5664                                                                   in->hdrChunk,
5665                                                                   1, __LINE__);
5666                                                 in->valid = 0;
5667                                         } else {
5668                                                 /* Use existing - destroy this one. */
5669                                                 yaffs_DeleteChunk(dev, chunk, 1,
5670                                                                   __LINE__);
5671                                         }
5672                                 }
5673
5674                                 if (in && !in->valid &&
5675                                     (tags.objectId == YAFFS_OBJECTID_ROOT ||
5676                                      tags.objectId == YAFFS_OBJECTID_LOSTNFOUND)) {
5677                                         /* We only load some info, don't fiddle with directory structure */
5678                                         in->valid = 1;
5679                                         in->variantType = oh->type;
5680
5681                                         in->yst_mode = oh->yst_mode;
5682 #ifdef CONFIG_YAFFS_WINCE
5683                                         in->win_atime[0] = oh->win_atime[0];
5684                                         in->win_ctime[0] = oh->win_ctime[0];
5685                                         in->win_mtime[0] = oh->win_mtime[0];
5686                                         in->win_atime[1] = oh->win_atime[1];
5687                                         in->win_ctime[1] = oh->win_ctime[1];
5688                                         in->win_mtime[1] = oh->win_mtime[1];
5689 #else
5690                                         in->yst_uid = oh->yst_uid;
5691                                         in->yst_gid = oh->yst_gid;
5692                                         in->yst_atime = oh->yst_atime;
5693                                         in->yst_mtime = oh->yst_mtime;
5694                                         in->yst_ctime = oh->yst_ctime;
5695                                         in->yst_rdev = oh->yst_rdev;
5696 #endif
5697                                         in->hdrChunk = chunk;
5698                                         in->serial = tags.serialNumber;
5699
5700                                 } else if (in && !in->valid) {
5701                                         /* we need to load this info */
5702
5703                                         in->valid = 1;
5704                                         in->variantType = oh->type;
5705
5706                                         in->yst_mode = oh->yst_mode;
5707 #ifdef CONFIG_YAFFS_WINCE
5708                                         in->win_atime[0] = oh->win_atime[0];
5709                                         in->win_ctime[0] = oh->win_ctime[0];
5710                                         in->win_mtime[0] = oh->win_mtime[0];
5711                                         in->win_atime[1] = oh->win_atime[1];
5712                                         in->win_ctime[1] = oh->win_ctime[1];
5713                                         in->win_mtime[1] = oh->win_mtime[1];
5714 #else
5715                                         in->yst_uid = oh->yst_uid;
5716                                         in->yst_gid = oh->yst_gid;
5717                                         in->yst_atime = oh->yst_atime;
5718                                         in->yst_mtime = oh->yst_mtime;
5719                                         in->yst_ctime = oh->yst_ctime;
5720                                         in->yst_rdev = oh->yst_rdev;
5721 #endif
5722                                         in->hdrChunk = chunk;
5723                                         in->serial = tags.serialNumber;
5724
5725                                         yaffs_SetObjectName(in, oh->name);
5726                                         in->dirty = 0;
5727
5728                                         /* directory stuff...
5729                                          * hook up to parent
5730                                          */
5731
5732                                         parent =
5733                                             yaffs_FindOrCreateObjectByNumber
5734                                             (dev, oh->parentObjectId,
5735                                              YAFFS_OBJECT_TYPE_DIRECTORY);
5736                                         if (!parent)
5737                                                 alloc_failed = 1;
5738                                         if (parent && parent->variantType ==
5739                                             YAFFS_OBJECT_TYPE_UNKNOWN) {
5740                                                 /* Set up as a directory */
5741                                                 parent->variantType =
5742                                                         YAFFS_OBJECT_TYPE_DIRECTORY;
5743                                                 YINIT_LIST_HEAD(&parent->variant.
5744                                                                 directoryVariant.
5745                                                                 children);
5746                                         } else if (!parent || parent->variantType !=
5747                                                    YAFFS_OBJECT_TYPE_DIRECTORY) {
5748                                                 /* Hoosterman, another problem....
5749                                                  * We're trying to use a non-directory as a directory
5750                                                  */
5751
5752                                                 T(YAFFS_TRACE_ERROR,
5753                                                   (TSTR
5754                                                    ("yaffs tragedy: attempting to use non-directory as a directory in scan. Put in lost+found."
5755                                                     TENDSTR)));
5756                                                 parent = dev->lostNFoundDir;
5757                                         }
5758
5759                                         yaffs_AddObjectToDirectory(parent, in);
5760
5761                                         if (0 && (parent == dev->deletedDir ||
5762                                                   parent == dev->unlinkedDir)) {
5763                                                 in->deleted = 1;        /* If it is unlinked at start up then it wants deleting */
5764                                                 dev->nDeletedFiles++;
5765                                         }
5766                                         /* Note re hardlinks.
5767                                          * Since we might scan a hardlink before its equivalent object is scanned
5768                                          * we put them all in a list.
5769                                          * After scanning is complete, we should have all the objects, so we run through this
5770                                          * list and fix up all the chains.
5771                                          */
5772
5773                                         switch (in->variantType) {
5774                                         case YAFFS_OBJECT_TYPE_UNKNOWN:
5775                                                 /* Todo got a problem */
5776                                                 break;
5777                                         case YAFFS_OBJECT_TYPE_FILE:
5778                                                 if (dev->useHeaderFileSize)
5779
5780                                                         in->variant.fileVariant.
5781                                                             fileSize =
5782                                                             oh->fileSize;
5783
5784                                                 break;
5785                                         case YAFFS_OBJECT_TYPE_HARDLINK:
5786                                                 in->variant.hardLinkVariant.
5787                                                         equivalentObjectId =
5788                                                         oh->equivalentObjectId;
5789                                                 in->hardLinks.next =
5790                                                         (struct ylist_head *)
5791                                                         hardList;
5792                                                 hardList = in;
5793                                                 break;
5794                                         case YAFFS_OBJECT_TYPE_DIRECTORY:
5795                                                 /* Do nothing */
5796                                                 break;
5797                                         case YAFFS_OBJECT_TYPE_SPECIAL:
5798                                                 /* Do nothing */
5799                                                 break;
5800                                         case YAFFS_OBJECT_TYPE_SYMLINK:
5801                                                 in->variant.symLinkVariant.alias =
5802                                                     yaffs_CloneString(oh->alias);
5803                                                 if (!in->variant.symLinkVariant.alias)
5804                                                         alloc_failed = 1;
5805                                                 break;
5806                                         }
5807
5808 /*
5809                                         if (parent == dev->deletedDir) {
5810                                                 yaffs_DestroyObject(in);
5811                                                 bi->hasShrinkHeader = 1;
5812                                         }
5813 */
5814                                 }
5815                         }
5816                 }
5817
5818                 if (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
5819                         /* If we got this far while scanning, then the block is fully allocated.*/
5820                         state = YAFFS_BLOCK_STATE_FULL;
5821                 }
5822
5823                 bi->blockState = state;
5824
5825                 /* Now let's see if it was dirty */
5826                 if (bi->pagesInUse == 0 &&
5827                     !bi->hasShrinkHeader &&
5828                     bi->blockState == YAFFS_BLOCK_STATE_FULL) {
5829                         yaffs_BlockBecameDirty(dev, blk);
5830                 }
5831
5832         }
5833
5834
5835         /* Ok, we've done all the scanning.
5836          * Fix up the hard link chains.
5837          * We should now have scanned all the objects, now it's time to add these
5838          * hardlinks.
5839          */
5840
5841         yaffs_HardlinkFixup(dev, hardList);
5842
5843         /* Fix up any shadowed objects */
5844         {
5845                 struct yaffs_ShadowFixerStruct *fixer;
5846                 yaffs_Object *obj;
5847
5848                 while (shadowFixerList) {
5849                         fixer = shadowFixerList;
5850                         shadowFixerList = fixer->next;
5851                         /* Complete the rename transaction by deleting the shadowed object
5852                          * then setting the object header to unshadowed.
5853                          */
5854                         obj = yaffs_FindObjectByNumber(dev, fixer->shadowedId);
5855                         if (obj)
5856                                 yaffs_DeleteObject(obj);
5857
5858                         obj = yaffs_FindObjectByNumber(dev, fixer->objectId);
5859
5860                         if (obj)
5861                                 yaffs_UpdateObjectHeader(obj, NULL, 1, 0, 0);
5862
5863                         YFREE(fixer);
5864                 }
5865         }
5866
5867         yaffs_ReleaseTempBuffer(dev, chunkData, __LINE__);
5868
5869         if (alloc_failed)
5870                 return YAFFS_FAIL;
5871
5872         T(YAFFS_TRACE_SCAN, (TSTR("yaffs_Scan ends" TENDSTR)));
5873
5874
5875         return YAFFS_OK;
5876 }
5877
5878 static void yaffs_CheckObjectDetailsLoaded(yaffs_Object *in)
5879 {
5880         __u8 *chunkData;
5881         yaffs_ObjectHeader *oh;
5882         yaffs_Device *dev;
5883         yaffs_ExtendedTags tags;
5884         int result;
5885         int alloc_failed = 0;
5886
5887         if (!in)
5888                 return;
5889
5890         dev = in->myDev;
5891
5892 #if 0
5893         T(YAFFS_TRACE_SCAN, (TSTR("details for object %d %s loaded" TENDSTR),
5894                 in->objectId,
5895                 in->lazyLoaded ? "not yet" : "already"));
5896 #endif
5897
5898         if (in->lazyLoaded && in->hdrChunk > 0) {
5899                 in->lazyLoaded = 0;
5900                 chunkData = yaffs_GetTempBuffer(dev, __LINE__);
5901
5902                 result = yaffs_ReadChunkWithTagsFromNAND(dev, in->hdrChunk, chunkData, &tags);
5903                 oh = (yaffs_ObjectHeader *) chunkData;
5904
5905                 in->yst_mode = oh->yst_mode;
5906 #ifdef CONFIG_YAFFS_WINCE
5907                 in->win_atime[0] = oh->win_atime[0];
5908                 in->win_ctime[0] = oh->win_ctime[0];
5909                 in->win_mtime[0] = oh->win_mtime[0];
5910                 in->win_atime[1] = oh->win_atime[1];
5911                 in->win_ctime[1] = oh->win_ctime[1];
5912                 in->win_mtime[1] = oh->win_mtime[1];
5913 #else
5914                 in->yst_uid = oh->yst_uid;
5915                 in->yst_gid = oh->yst_gid;
5916                 in->yst_atime = oh->yst_atime;
5917                 in->yst_mtime = oh->yst_mtime;
5918                 in->yst_ctime = oh->yst_ctime;
5919                 in->yst_rdev = oh->yst_rdev;
5920
5921 #endif
5922                 yaffs_SetObjectName(in, oh->name);
5923
5924                 if (in->variantType == YAFFS_OBJECT_TYPE_SYMLINK) {
5925                         in->variant.symLinkVariant.alias =
5926                                                     yaffs_CloneString(oh->alias);
5927                         if (!in->variant.symLinkVariant.alias)
5928                                 alloc_failed = 1; /* Not returned to caller */
5929                 }
5930
5931                 yaffs_ReleaseTempBuffer(dev, chunkData, __LINE__);
5932         }
5933 }
5934
5935 static int yaffs_ScanBackwards(yaffs_Device *dev)
5936 {
5937         yaffs_ExtendedTags tags;
5938         int blk;
5939         int blockIterator;
5940         int startIterator;
5941         int endIterator;
5942         int nBlocksToScan = 0;
5943
5944         int chunk;
5945         int result;
5946         int c;
5947         int deleted;
5948         yaffs_BlockState state;
5949         yaffs_Object *hardList = NULL;
5950         yaffs_BlockInfo *bi;
5951         __u32 sequenceNumber;
5952         yaffs_ObjectHeader *oh;
5953         yaffs_Object *in;
5954         yaffs_Object *parent;
5955         int nBlocks = dev->internalEndBlock - dev->internalStartBlock + 1;
5956         int itsUnlinked;
5957         __u8 *chunkData;
5958
5959         int fileSize;
5960         int isShrink;
5961         int foundChunksInBlock;
5962         int equivalentObjectId;
5963         int alloc_failed = 0;
5964
5965
5966         yaffs_BlockIndex *blockIndex = NULL;
5967         int altBlockIndex = 0;
5968
5969         if (!dev->isYaffs2) {
5970                 T(YAFFS_TRACE_SCAN,
5971                   (TSTR("yaffs_ScanBackwards is only for YAFFS2!" TENDSTR)));
5972                 return YAFFS_FAIL;
5973         }
5974
5975         T(YAFFS_TRACE_SCAN,
5976           (TSTR
5977            ("yaffs_ScanBackwards starts  intstartblk %d intendblk %d..."
5978             TENDSTR), dev->internalStartBlock, dev->internalEndBlock));
5979
5980
5981         dev->sequenceNumber = YAFFS_LOWEST_SEQUENCE_NUMBER;
5982
5983         blockIndex = YMALLOC(nBlocks * sizeof(yaffs_BlockIndex));
5984
5985         if (!blockIndex) {
5986                 blockIndex = YMALLOC_ALT(nBlocks * sizeof(yaffs_BlockIndex));
5987                 altBlockIndex = 1;
5988         }
5989
5990         if (!blockIndex) {
5991                 T(YAFFS_TRACE_SCAN,
5992                   (TSTR("yaffs_Scan() could not allocate block index!" TENDSTR)));
5993                 return YAFFS_FAIL;
5994         }
5995
5996         dev->blocksInCheckpoint = 0;
5997
5998         chunkData = yaffs_GetTempBuffer(dev, __LINE__);
5999
6000         /* Scan all the blocks to determine their state */
6001         for (blk = dev->internalStartBlock; blk <= dev->internalEndBlock; blk++) {
6002                 bi = yaffs_GetBlockInfo(dev, blk);
6003                 yaffs_ClearChunkBits(dev, blk);
6004                 bi->pagesInUse = 0;
6005                 bi->softDeletions = 0;
6006
6007                 yaffs_QueryInitialBlockState(dev, blk, &state, &sequenceNumber);
6008
6009                 bi->blockState = state;
6010                 bi->sequenceNumber = sequenceNumber;
6011
6012                 if (bi->sequenceNumber == YAFFS_SEQUENCE_CHECKPOINT_DATA)
6013                         bi->blockState = state = YAFFS_BLOCK_STATE_CHECKPOINT;
6014                 if (bi->sequenceNumber == YAFFS_SEQUENCE_BAD_BLOCK)
6015                         bi->blockState = state = YAFFS_BLOCK_STATE_DEAD;
6016
6017                 T(YAFFS_TRACE_SCAN_DEBUG,
6018                   (TSTR("Block scanning block %d state %d seq %d" TENDSTR), blk,
6019                    state, sequenceNumber));
6020
6021
6022                 if (state == YAFFS_BLOCK_STATE_CHECKPOINT) {
6023                         dev->blocksInCheckpoint++;
6024
6025                 } else if (state == YAFFS_BLOCK_STATE_DEAD) {
6026                         T(YAFFS_TRACE_BAD_BLOCKS,
6027                           (TSTR("block %d is bad" TENDSTR), blk));
6028                 } else if (state == YAFFS_BLOCK_STATE_EMPTY) {
6029                         T(YAFFS_TRACE_SCAN_DEBUG,
6030                           (TSTR("Block empty " TENDSTR)));
6031                         dev->nErasedBlocks++;
6032                         dev->nFreeChunks += dev->nChunksPerBlock;
6033                 } else if (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
6034
6035                         /* Determine the highest sequence number */
6036                         if (sequenceNumber >= YAFFS_LOWEST_SEQUENCE_NUMBER &&
6037                             sequenceNumber < YAFFS_HIGHEST_SEQUENCE_NUMBER) {
6038
6039                                 blockIndex[nBlocksToScan].seq = sequenceNumber;
6040                                 blockIndex[nBlocksToScan].block = blk;
6041
6042                                 nBlocksToScan++;
6043
6044                                 if (sequenceNumber >= dev->sequenceNumber)
6045                                         dev->sequenceNumber = sequenceNumber;
6046                         } else {
6047                                 /* TODO: Nasty sequence number! */
6048                                 T(YAFFS_TRACE_SCAN,
6049                                   (TSTR
6050                                    ("Block scanning block %d has bad sequence number %d"
6051                                     TENDSTR), blk, sequenceNumber));
6052
6053                         }
6054                 }
6055         }
6056
6057         T(YAFFS_TRACE_SCAN,
6058         (TSTR("%d blocks to be sorted..." TENDSTR), nBlocksToScan));
6059
6060
6061
6062         YYIELD();
6063
6064         /* Sort the blocks */
6065 #ifndef CONFIG_YAFFS_USE_OWN_SORT
6066         {
6067                 /* Use qsort now. */
6068                 yaffs_qsort(blockIndex, nBlocksToScan, sizeof(yaffs_BlockIndex), ybicmp);
6069         }
6070 #else
6071         {
6072                 /* Dungy old bubble sort... */
6073
6074                 yaffs_BlockIndex temp;
6075                 int i;
6076                 int j;
6077
6078                 for (i = 0; i < nBlocksToScan; i++)
6079                         for (j = i + 1; j < nBlocksToScan; j++)
6080                                 if (blockIndex[i].seq > blockIndex[j].seq) {
6081                                         temp = blockIndex[j];
6082                                         blockIndex[j] = blockIndex[i];
6083                                         blockIndex[i] = temp;
6084                                 }
6085         }
6086 #endif
6087
6088         YYIELD();
6089
6090         T(YAFFS_TRACE_SCAN, (TSTR("...done" TENDSTR)));
6091
6092         /* Now scan the blocks looking at the data. */
6093         startIterator = 0;
6094         endIterator = nBlocksToScan - 1;
6095         T(YAFFS_TRACE_SCAN_DEBUG,
6096           (TSTR("%d blocks to be scanned" TENDSTR), nBlocksToScan));
6097
6098         /* For each block.... backwards */
6099         for (blockIterator = endIterator; !alloc_failed && blockIterator >= startIterator;
6100                         blockIterator--) {
6101                 /* Cooperative multitasking! This loop can run for so
6102                    long that watchdog timers expire. */
6103                 YYIELD();
6104
6105                 /* get the block to scan in the correct order */
6106                 blk = blockIndex[blockIterator].block;
6107
6108                 bi = yaffs_GetBlockInfo(dev, blk);
6109
6110
6111                 state = bi->blockState;
6112
6113                 deleted = 0;
6114
6115                 /* For each chunk in each block that needs scanning.... */
6116                 foundChunksInBlock = 0;
6117                 for (c = dev->nChunksPerBlock - 1;
6118                      !alloc_failed && c >= 0 &&
6119                      (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
6120                       state == YAFFS_BLOCK_STATE_ALLOCATING); c--) {
6121                         /* Scan backwards...
6122                          * Read the tags and decide what to do
6123                          */
6124
6125                         chunk = blk * dev->nChunksPerBlock + c;
6126
6127                         result = yaffs_ReadChunkWithTagsFromNAND(dev, chunk, NULL,
6128                                                         &tags);
6129
6130                         /* Let's have a good look at this chunk... */
6131
6132                         if (!tags.chunkUsed) {
6133                                 /* An unassigned chunk in the block.
6134                                  * If there are used chunks after this one, then
6135                                  * it is a chunk that was skipped due to failing the erased
6136                                  * check. Just skip it so that it can be deleted.
6137                                  * But, more typically, We get here when this is an unallocated
6138                                  * chunk and his means that either the block is empty or
6139                                  * this is the one being allocated from
6140                                  */
6141
6142                                 if (foundChunksInBlock) {
6143                                         /* This is a chunk that was skipped due to failing the erased check */
6144                                 } else if (c == 0) {
6145                                         /* We're looking at the first chunk in the block so the block is unused */
6146                                         state = YAFFS_BLOCK_STATE_EMPTY;
6147                                         dev->nErasedBlocks++;
6148                                 } else {
6149                                         if (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
6150                                             state == YAFFS_BLOCK_STATE_ALLOCATING) {
6151                                                 if (dev->sequenceNumber == bi->sequenceNumber) {
6152                                                         /* this is the block being allocated from */
6153
6154                                                         T(YAFFS_TRACE_SCAN,
6155                                                           (TSTR
6156                                                            (" Allocating from %d %d"
6157                                                             TENDSTR), blk, c));
6158
6159                                                         state = YAFFS_BLOCK_STATE_ALLOCATING;
6160                                                         dev->allocationBlock = blk;
6161                                                         dev->allocationPage = c;
6162                                                         dev->allocationBlockFinder = blk;
6163                                                 } else {
6164                                                         /* This is a partially written block that is not
6165                                                          * the current allocation block. This block must have
6166                                                          * had a write failure, so set up for retirement.
6167                                                          */
6168
6169                                                          /* bi->needsRetiring = 1; ??? TODO */
6170                                                          bi->gcPrioritise = 1;
6171
6172                                                          T(YAFFS_TRACE_ALWAYS,
6173                                                          (TSTR("Partially written block %d detected" TENDSTR),
6174                                                          blk));
6175                                                 }
6176                                         }
6177                                 }
6178
6179                                 dev->nFreeChunks++;
6180
6181                         } else if (tags.eccResult == YAFFS_ECC_RESULT_UNFIXED) {
6182                                 T(YAFFS_TRACE_SCAN,
6183                                   (TSTR(" Unfixed ECC in chunk(%d:%d), chunk ignored"TENDSTR),
6184                                   blk, c));
6185
6186                                   dev->nFreeChunks++;
6187
6188                         } else if (tags.chunkId > 0) {
6189                                 /* chunkId > 0 so it is a data chunk... */
6190                                 unsigned int endpos;
6191                                 __u32 chunkBase =
6192                                     (tags.chunkId - 1) * dev->nDataBytesPerChunk;
6193
6194                                 foundChunksInBlock = 1;
6195
6196
6197                                 yaffs_SetChunkBit(dev, blk, c);
6198                                 bi->pagesInUse++;
6199
6200                                 in = yaffs_FindOrCreateObjectByNumber(dev,
6201                                                                       tags.
6202                                                                       objectId,
6203                                                                       YAFFS_OBJECT_TYPE_FILE);
6204                                 if (!in) {
6205                                         /* Out of memory */
6206                                         alloc_failed = 1;
6207                                 }
6208
6209                                 if (in &&
6210                                     in->variantType == YAFFS_OBJECT_TYPE_FILE
6211                                     && chunkBase <
6212                                     in->variant.fileVariant.shrinkSize) {
6213                                         /* This has not been invalidated by a resize */
6214                                         if (!yaffs_PutChunkIntoFile(in, tags.chunkId,
6215                                                                chunk, -1)) {
6216                                                 alloc_failed = 1;
6217                                         }
6218
6219                                         /* File size is calculated by looking at the data chunks if we have not
6220                                          * seen an object header yet. Stop this practice once we find an object header.
6221                                          */
6222                                         endpos =
6223                                             (tags.chunkId -
6224                                              1) * dev->nDataBytesPerChunk +
6225                                             tags.byteCount;
6226
6227                                         if (!in->valid &&       /* have not got an object header yet */
6228                                             in->variant.fileVariant.
6229                                             scannedFileSize < endpos) {
6230                                                 in->variant.fileVariant.
6231                                                     scannedFileSize = endpos;
6232                                                 in->variant.fileVariant.
6233                                                     fileSize =
6234                                                     in->variant.fileVariant.
6235                                                     scannedFileSize;
6236                                         }
6237
6238                                 } else if (in) {
6239                                         /* This chunk has been invalidated by a resize, so delete */
6240                                         yaffs_DeleteChunk(dev, chunk, 1, __LINE__);
6241
6242                                 }
6243                         } else {
6244                                 /* chunkId == 0, so it is an ObjectHeader.
6245                                  * Thus, we read in the object header and make the object
6246                                  */
6247                                 foundChunksInBlock = 1;
6248
6249                                 yaffs_SetChunkBit(dev, blk, c);
6250                                 bi->pagesInUse++;
6251
6252                                 oh = NULL;
6253                                 in = NULL;
6254
6255                                 if (tags.extraHeaderInfoAvailable) {
6256                                         in = yaffs_FindOrCreateObjectByNumber
6257                                             (dev, tags.objectId,
6258                                              tags.extraObjectType);
6259                                         if (!in)
6260                                                 alloc_failed = 1;
6261                                 }
6262
6263                                 if (!in ||
6264 #ifdef CONFIG_YAFFS_DISABLE_LAZY_LOAD
6265                                     !in->valid ||
6266 #endif
6267                                     tags.extraShadows ||
6268                                     (!in->valid &&
6269                                     (tags.objectId == YAFFS_OBJECTID_ROOT ||
6270                                      tags.objectId == YAFFS_OBJECTID_LOSTNFOUND))) {
6271
6272                                         /* If we don't have  valid info then we need to read the chunk
6273                                          * TODO In future we can probably defer reading the chunk and
6274                                          * living with invalid data until needed.
6275                                          */
6276
6277                                         result = yaffs_ReadChunkWithTagsFromNAND(dev,
6278                                                                         chunk,
6279                                                                         chunkData,
6280                                                                         NULL);
6281
6282                                         oh = (yaffs_ObjectHeader *) chunkData;
6283
6284                                         if (dev->inbandTags) {
6285                                                 /* Fix up the header if they got corrupted by inband tags */
6286                                                 oh->shadowsObject = oh->inbandShadowsObject;
6287                                                 oh->isShrink = oh->inbandIsShrink;
6288                                         }
6289
6290                                         if (!in) {
6291                                                 in = yaffs_FindOrCreateObjectByNumber(dev, tags.objectId, oh->type);
6292                                                 if (!in)
6293                                                         alloc_failed = 1;
6294                                         }
6295
6296                                 }
6297
6298                                 if (!in) {
6299                                         /* TODO Hoosterman we have a problem! */
6300                                         T(YAFFS_TRACE_ERROR,
6301                                           (TSTR
6302                                            ("yaffs tragedy: Could not make object for object  %d at chunk %d during scan"
6303                                             TENDSTR), tags.objectId, chunk));
6304                                         continue;
6305                                 }
6306
6307                                 if (in->valid) {
6308                                         /* We have already filled this one.
6309                                          * We have a duplicate that will be discarded, but
6310                                          * we first have to suck out resize info if it is a file.
6311                                          */
6312
6313                                         if ((in->variantType == YAFFS_OBJECT_TYPE_FILE) &&
6314                                              ((oh &&
6315                                                oh->type == YAFFS_OBJECT_TYPE_FILE) ||
6316                                               (tags.extraHeaderInfoAvailable  &&
6317                                                tags.extraObjectType == YAFFS_OBJECT_TYPE_FILE))) {
6318                                                 __u32 thisSize =
6319                                                     (oh) ? oh->fileSize : tags.
6320                                                     extraFileLength;
6321                                                 __u32 parentObjectId =
6322                                                     (oh) ? oh->
6323                                                     parentObjectId : tags.
6324                                                     extraParentObjectId;
6325
6326
6327                                                 isShrink =
6328                                                     (oh) ? oh->isShrink : tags.
6329                                                     extraIsShrinkHeader;
6330
6331                                                 /* If it is deleted (unlinked at start also means deleted)
6332                                                  * we treat the file size as being zeroed at this point.
6333                                                  */
6334                                                 if (parentObjectId ==
6335                                                     YAFFS_OBJECTID_DELETED
6336                                                     || parentObjectId ==
6337                                                     YAFFS_OBJECTID_UNLINKED) {
6338                                                         thisSize = 0;
6339                                                         isShrink = 1;
6340                                                 }
6341
6342                                                 if (isShrink &&
6343                                                     in->variant.fileVariant.
6344                                                     shrinkSize > thisSize) {
6345                                                         in->variant.fileVariant.
6346                                                             shrinkSize =
6347                                                             thisSize;
6348                                                 }
6349
6350                                                 if (isShrink)
6351                                                         bi->hasShrinkHeader = 1;
6352
6353                                         }
6354                                         /* Use existing - destroy this one. */
6355                                         yaffs_DeleteChunk(dev, chunk, 1, __LINE__);
6356
6357                                 }
6358
6359                                 if (!in->valid && in->variantType !=
6360                                     (oh ? oh->type : tags.extraObjectType))
6361                                         T(YAFFS_TRACE_ERROR, (
6362                                                 TSTR("yaffs tragedy: Bad object type, "
6363                                             TCONT("%d != %d, for object %d at chunk ")
6364                                             TCONT("%d during scan")
6365                                                 TENDSTR), oh ?
6366                                             oh->type : tags.extraObjectType,
6367                                             in->variantType, tags.objectId,
6368                                             chunk));
6369
6370                                 if (!in->valid &&
6371                                     (tags.objectId == YAFFS_OBJECTID_ROOT ||
6372                                      tags.objectId ==
6373                                      YAFFS_OBJECTID_LOSTNFOUND)) {
6374                                         /* We only load some info, don't fiddle with directory structure */
6375                                         in->valid = 1;
6376
6377                                         if (oh) {
6378                                                 in->variantType = oh->type;
6379
6380                                                 in->yst_mode = oh->yst_mode;
6381 #ifdef CONFIG_YAFFS_WINCE
6382                                                 in->win_atime[0] = oh->win_atime[0];
6383                                                 in->win_ctime[0] = oh->win_ctime[0];
6384                                                 in->win_mtime[0] = oh->win_mtime[0];
6385                                                 in->win_atime[1] = oh->win_atime[1];
6386                                                 in->win_ctime[1] = oh->win_ctime[1];
6387                                                 in->win_mtime[1] = oh->win_mtime[1];
6388 #else
6389                                                 in->yst_uid = oh->yst_uid;
6390                                                 in->yst_gid = oh->yst_gid;
6391                                                 in->yst_atime = oh->yst_atime;
6392                                                 in->yst_mtime = oh->yst_mtime;
6393                                                 in->yst_ctime = oh->yst_ctime;
6394                                                 in->yst_rdev = oh->yst_rdev;
6395
6396 #endif
6397                                         } else {
6398                                                 in->variantType = tags.extraObjectType;
6399                                                 in->lazyLoaded = 1;
6400                                         }
6401
6402                                         in->hdrChunk = chunk;
6403
6404                                 } else if (!in->valid) {
6405                                         /* we need to load this info */
6406
6407                                         in->valid = 1;
6408                                         in->hdrChunk = chunk;
6409
6410                                         if (oh) {
6411                                                 in->variantType = oh->type;
6412
6413                                                 in->yst_mode = oh->yst_mode;
6414 #ifdef CONFIG_YAFFS_WINCE
6415                                                 in->win_atime[0] = oh->win_atime[0];
6416                                                 in->win_ctime[0] = oh->win_ctime[0];
6417                                                 in->win_mtime[0] = oh->win_mtime[0];
6418                                                 in->win_atime[1] = oh->win_atime[1];
6419                                                 in->win_ctime[1] = oh->win_ctime[1];
6420                                                 in->win_mtime[1] = oh->win_mtime[1];
6421 #else
6422                                                 in->yst_uid = oh->yst_uid;
6423                                                 in->yst_gid = oh->yst_gid;
6424                                                 in->yst_atime = oh->yst_atime;
6425                                                 in->yst_mtime = oh->yst_mtime;
6426                                                 in->yst_ctime = oh->yst_ctime;
6427                                                 in->yst_rdev = oh->yst_rdev;
6428 #endif
6429
6430                                                 if (oh->shadowsObject > 0)
6431                                                         yaffs_HandleShadowedObject(dev,
6432                                                                            oh->
6433                                                                            shadowsObject,
6434                                                                            1);
6435
6436
6437                                                 yaffs_SetObjectName(in, oh->name);
6438                                                 parent =
6439                                                     yaffs_FindOrCreateObjectByNumber
6440                                                         (dev, oh->parentObjectId,
6441                                                          YAFFS_OBJECT_TYPE_DIRECTORY);
6442
6443                                                  fileSize = oh->fileSize;
6444                                                  isShrink = oh->isShrink;
6445                                                  equivalentObjectId = oh->equivalentObjectId;
6446
6447                                         } else {
6448                                                 in->variantType = tags.extraObjectType;
6449                                                 parent =
6450                                                     yaffs_FindOrCreateObjectByNumber
6451                                                         (dev, tags.extraParentObjectId,
6452                                                          YAFFS_OBJECT_TYPE_DIRECTORY);
6453                                                  fileSize = tags.extraFileLength;
6454                                                  isShrink = tags.extraIsShrinkHeader;
6455                                                  equivalentObjectId = tags.extraEquivalentObjectId;
6456                                                 in->lazyLoaded = 1;
6457
6458                                         }
6459                                         in->dirty = 0;
6460
6461                                         if (!parent)
6462                                                 alloc_failed = 1;
6463
6464                                         /* directory stuff...
6465                                          * hook up to parent
6466                                          */
6467
6468                                         if (parent && parent->variantType ==
6469                                             YAFFS_OBJECT_TYPE_UNKNOWN) {
6470                                                 /* Set up as a directory */
6471                                                 parent->variantType =
6472                                                         YAFFS_OBJECT_TYPE_DIRECTORY;
6473                                                 YINIT_LIST_HEAD(&parent->variant.
6474                                                         directoryVariant.
6475                                                         children);
6476                                         } else if (!parent || parent->variantType !=
6477                                                    YAFFS_OBJECT_TYPE_DIRECTORY) {
6478                                                 /* Hoosterman, another problem....
6479                                                  * We're trying to use a non-directory as a directory
6480                                                  */
6481
6482                                                 T(YAFFS_TRACE_ERROR,
6483                                                   (TSTR
6484                                                    ("yaffs tragedy: attempting to use non-directory as a directory in scan. Put in lost+found."
6485                                                     TENDSTR)));
6486                                                 parent = dev->lostNFoundDir;
6487                                         }
6488
6489                                         yaffs_AddObjectToDirectory(parent, in);
6490
6491                                         itsUnlinked = (parent == dev->deletedDir) ||
6492                                                       (parent == dev->unlinkedDir);
6493
6494                                         if (isShrink) {
6495                                                 /* Mark the block as having a shrinkHeader */
6496                                                 bi->hasShrinkHeader = 1;
6497                                         }
6498
6499                                         /* Note re hardlinks.
6500                                          * Since we might scan a hardlink before its equivalent object is scanned
6501                                          * we put them all in a list.
6502                                          * After scanning is complete, we should have all the objects, so we run
6503                                          * through this list and fix up all the chains.
6504                                          */
6505
6506                                         switch (in->variantType) {
6507                                         case YAFFS_OBJECT_TYPE_UNKNOWN:
6508                                                 /* Todo got a problem */
6509                                                 break;
6510                                         case YAFFS_OBJECT_TYPE_FILE:
6511
6512                                                 if (in->variant.fileVariant.
6513                                                     scannedFileSize < fileSize) {
6514                                                         /* This covers the case where the file size is greater
6515                                                          * than where the data is
6516                                                          * This will happen if the file is resized to be larger
6517                                                          * than its current data extents.
6518                                                          */
6519                                                         in->variant.fileVariant.fileSize = fileSize;
6520                                                         in->variant.fileVariant.scannedFileSize =
6521                                                             in->variant.fileVariant.fileSize;
6522                                                 }
6523
6524                                                 if (isShrink &&
6525                                                     in->variant.fileVariant.shrinkSize > fileSize) {
6526                                                         in->variant.fileVariant.shrinkSize = fileSize;
6527                                                 }
6528
6529                                                 break;
6530                                         case YAFFS_OBJECT_TYPE_HARDLINK:
6531                                                 if (!itsUnlinked) {
6532                                                         in->variant.hardLinkVariant.equivalentObjectId =
6533                                                                 equivalentObjectId;
6534                                                         in->hardLinks.next =
6535                                                                 (struct ylist_head *) hardList;
6536                                                         hardList = in;
6537                                                 }
6538                                                 break;
6539                                         case YAFFS_OBJECT_TYPE_DIRECTORY:
6540                                                 /* Do nothing */
6541                                                 break;
6542                                         case YAFFS_OBJECT_TYPE_SPECIAL:
6543                                                 /* Do nothing */
6544                                                 break;
6545                                         case YAFFS_OBJECT_TYPE_SYMLINK:
6546                                                 if (oh) {
6547                                                         in->variant.symLinkVariant.alias =
6548                                                                 yaffs_CloneString(oh->alias);
6549                                                         if (!in->variant.symLinkVariant.alias)
6550                                                                 alloc_failed = 1;
6551                                                 }
6552                                                 break;
6553                                         }
6554
6555                                 }
6556
6557                         }
6558
6559                 } /* End of scanning for each chunk */
6560
6561                 if (state == YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
6562                         /* If we got this far while scanning, then the block is fully allocated. */
6563                         state = YAFFS_BLOCK_STATE_FULL;
6564                 }
6565
6566                 bi->blockState = state;
6567
6568                 /* Now let's see if it was dirty */
6569                 if (bi->pagesInUse == 0 &&
6570                     !bi->hasShrinkHeader &&
6571                     bi->blockState == YAFFS_BLOCK_STATE_FULL) {
6572                         yaffs_BlockBecameDirty(dev, blk);
6573                 }
6574
6575         }
6576
6577         if (altBlockIndex)
6578                 YFREE_ALT(blockIndex);
6579         else
6580                 YFREE(blockIndex);
6581
6582         /* Ok, we've done all the scanning.
6583          * Fix up the hard link chains.
6584          * We should now have scanned all the objects, now it's time to add these
6585          * hardlinks.
6586          */
6587         yaffs_HardlinkFixup(dev, hardList);
6588
6589
6590         yaffs_ReleaseTempBuffer(dev, chunkData, __LINE__);
6591
6592         if (alloc_failed)
6593                 return YAFFS_FAIL;
6594
6595         T(YAFFS_TRACE_SCAN, (TSTR("yaffs_ScanBackwards ends" TENDSTR)));
6596
6597         return YAFFS_OK;
6598 }
6599
6600 /*------------------------------  Directory Functions ----------------------------- */
6601
6602 static void yaffs_VerifyObjectInDirectory(yaffs_Object *obj)
6603 {
6604         struct ylist_head *lh;
6605         yaffs_Object *listObj;
6606
6607         int count = 0;
6608
6609         if (!obj) {
6610                 T(YAFFS_TRACE_ALWAYS, (TSTR("No object to verify" TENDSTR)));
6611                 YBUG();
6612                 return;
6613         }
6614
6615         if (yaffs_SkipVerification(obj->myDev))
6616                 return;
6617
6618         if (!obj->parent) {
6619                 T(YAFFS_TRACE_ALWAYS, (TSTR("Object does not have parent" TENDSTR)));
6620                 YBUG();
6621                 return;
6622         }
6623
6624         if (obj->parent->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
6625                 T(YAFFS_TRACE_ALWAYS, (TSTR("Parent is not directory" TENDSTR)));
6626                 YBUG();
6627         }
6628
6629         /* Iterate through the objects in each hash entry */
6630
6631         ylist_for_each(lh, &obj->parent->variant.directoryVariant.children) {
6632                 if (lh) {
6633                         listObj = ylist_entry(lh, yaffs_Object, siblings);
6634                         yaffs_VerifyObject(listObj);
6635                         if (obj == listObj)
6636                                 count++;
6637                 }
6638          }
6639
6640         if (count != 1) {
6641                 T(YAFFS_TRACE_ALWAYS, (TSTR("Object in directory %d times" TENDSTR), count));
6642                 YBUG();
6643         }
6644 }
6645
6646 static void yaffs_VerifyDirectory(yaffs_Object *directory)
6647 {
6648         struct ylist_head *lh;
6649         yaffs_Object *listObj;
6650
6651         if (!directory) {
6652                 YBUG();
6653                 return;
6654         }
6655
6656         if (yaffs_SkipFullVerification(directory->myDev))
6657                 return;
6658
6659         if (directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
6660                 T(YAFFS_TRACE_ALWAYS, (TSTR("Directory has wrong type: %d" TENDSTR), directory->variantType));
6661                 YBUG();
6662         }
6663
6664         /* Iterate through the objects in each hash entry */
6665
6666         ylist_for_each(lh, &directory->variant.directoryVariant.children) {
6667                 if (lh) {
6668                         listObj = ylist_entry(lh, yaffs_Object, siblings);
6669                         if (listObj->parent != directory) {
6670                                 T(YAFFS_TRACE_ALWAYS, (TSTR("Object in directory list has wrong parent %p" TENDSTR), listObj->parent));
6671                                 YBUG();
6672                         }
6673                         yaffs_VerifyObjectInDirectory(listObj);
6674                 }
6675         }
6676 }
6677
6678 /*
6679  *yaffs_UpdateParent() handles fixing a directories mtime and ctime when a new
6680  * link (ie. name) is created or deleted in the directory.
6681  *
6682  * ie.
6683  *   create dir/a : update dir's mtime/ctime
6684  *   rm dir/a:   update dir's mtime/ctime
6685  *   modify dir/a: don't update dir's mtimme/ctime
6686  */
6687  
6688 static void yaffs_UpdateParent(yaffs_Object *obj)
6689 {
6690         if(!obj)
6691                 return;
6692
6693         obj->dirty = 1;
6694         obj->yst_mtime = obj->yst_ctime = Y_CURRENT_TIME;
6695
6696         yaffs_UpdateObjectHeader(obj,NULL,0,0,0);
6697 }
6698
6699 static void yaffs_RemoveObjectFromDirectory(yaffs_Object *obj)
6700 {
6701         yaffs_Device *dev = obj->myDev;
6702         yaffs_Object *parent;
6703
6704         yaffs_VerifyObjectInDirectory(obj);
6705         parent = obj->parent;
6706
6707         yaffs_VerifyDirectory(parent);
6708
6709         if (dev && dev->removeObjectCallback)
6710                 dev->removeObjectCallback(obj);
6711
6712
6713         ylist_del_init(&obj->siblings);
6714         obj->parent = NULL;
6715         
6716         yaffs_VerifyDirectory(parent);
6717 }
6718
6719 static void yaffs_AddObjectToDirectory(yaffs_Object *directory,
6720                                         yaffs_Object *obj)
6721 {
6722         if (!directory) {
6723                 T(YAFFS_TRACE_ALWAYS,
6724                   (TSTR
6725                    ("tragedy: Trying to add an object to a null pointer directory"
6726                     TENDSTR)));
6727                 YBUG();
6728                 return;
6729         }
6730         if (directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
6731                 T(YAFFS_TRACE_ALWAYS,
6732                   (TSTR
6733                    ("tragedy: Trying to add an object to a non-directory"
6734                     TENDSTR)));
6735                 YBUG();
6736         }
6737
6738         if (obj->siblings.prev == NULL) {
6739                 /* Not initialised */
6740                 YBUG();
6741         }
6742
6743
6744         yaffs_VerifyDirectory(directory);
6745
6746         yaffs_RemoveObjectFromDirectory(obj);
6747
6748
6749         /* Now add it */
6750         ylist_add(&obj->siblings, &directory->variant.directoryVariant.children);
6751         obj->parent = directory;
6752
6753         if (directory == obj->myDev->unlinkedDir
6754                         || directory == obj->myDev->deletedDir) {
6755                 obj->unlinked = 1;
6756                 obj->myDev->nUnlinkedFiles++;
6757                 obj->renameAllowed = 0;
6758         }
6759
6760         yaffs_VerifyDirectory(directory);
6761         yaffs_VerifyObjectInDirectory(obj);
6762 }
6763
6764 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *directory,
6765                                      const YCHAR *name)
6766 {
6767         int sum;
6768
6769         struct ylist_head *i;
6770         YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
6771
6772         yaffs_Object *l;
6773
6774         if (!name)
6775                 return NULL;
6776
6777         if (!directory) {
6778                 T(YAFFS_TRACE_ALWAYS,
6779                   (TSTR
6780                    ("tragedy: yaffs_FindObjectByName: null pointer directory"
6781                     TENDSTR)));
6782                 YBUG();
6783                 return NULL;
6784         }
6785         if (directory->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
6786                 T(YAFFS_TRACE_ALWAYS,
6787                   (TSTR
6788                    ("tragedy: yaffs_FindObjectByName: non-directory" TENDSTR)));
6789                 YBUG();
6790         }
6791
6792         sum = yaffs_CalcNameSum(name);
6793
6794         ylist_for_each(i, &directory->variant.directoryVariant.children) {
6795                 if (i) {
6796                         l = ylist_entry(i, yaffs_Object, siblings);
6797
6798                         if (l->parent != directory)
6799                                 YBUG();
6800
6801                         yaffs_CheckObjectDetailsLoaded(l);
6802
6803                         /* Special case for lost-n-found */
6804                         if (l->objectId == YAFFS_OBJECTID_LOSTNFOUND) {
6805                                 if (yaffs_strcmp(name, YAFFS_LOSTNFOUND_NAME) == 0)
6806                                         return l;
6807                         } else if (yaffs_SumCompare(l->sum, sum) || l->hdrChunk <= 0) {
6808                                 /* LostnFound chunk called Objxxx
6809                                  * Do a real check
6810                                  */
6811                                 yaffs_GetObjectName(l, buffer,
6812                                                     YAFFS_MAX_NAME_LENGTH);
6813                                 if (yaffs_strncmp(name, buffer, YAFFS_MAX_NAME_LENGTH) == 0)
6814                                         return l;
6815                         }
6816                 }
6817         }
6818
6819         return NULL;
6820 }
6821
6822
6823 #if 0
6824 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,
6825                                         int (*fn) (yaffs_Object *))
6826 {
6827         struct ylist_head *i;
6828         yaffs_Object *l;
6829
6830         if (!theDir) {
6831                 T(YAFFS_TRACE_ALWAYS,
6832                   (TSTR
6833                    ("tragedy: yaffs_FindObjectByName: null pointer directory"
6834                     TENDSTR)));
6835                 YBUG();
6836                 return YAFFS_FAIL;
6837         }
6838         if (theDir->variantType != YAFFS_OBJECT_TYPE_DIRECTORY) {
6839                 T(YAFFS_TRACE_ALWAYS,
6840                   (TSTR
6841                    ("tragedy: yaffs_FindObjectByName: non-directory" TENDSTR)));
6842                 YBUG();
6843                 return YAFFS_FAIL;
6844         }
6845
6846         ylist_for_each(i, &theDir->variant.directoryVariant.children) {
6847                 if (i) {
6848                         l = ylist_entry(i, yaffs_Object, siblings);
6849                         if (l && !fn(l))
6850                                 return YAFFS_FAIL;
6851                 }
6852         }
6853
6854         return YAFFS_OK;
6855
6856 }
6857 #endif
6858
6859 /* GetEquivalentObject dereferences any hard links to get to the
6860  * actual object.
6861  */
6862
6863 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj)
6864 {
6865         if (obj && obj->variantType == YAFFS_OBJECT_TYPE_HARDLINK) {
6866                 /* We want the object id of the equivalent object, not this one */
6867                 obj = obj->variant.hardLinkVariant.equivalentObject;
6868                 yaffs_CheckObjectDetailsLoaded(obj);
6869         }
6870         return obj;
6871 }
6872
6873 int yaffs_GetObjectName(yaffs_Object *obj, YCHAR *name, int buffSize)
6874 {
6875         memset(name, 0, buffSize * sizeof(YCHAR));
6876
6877         yaffs_CheckObjectDetailsLoaded(obj);
6878
6879         if (obj->objectId == YAFFS_OBJECTID_LOSTNFOUND) {
6880                 yaffs_strncpy(name, YAFFS_LOSTNFOUND_NAME, buffSize - 1);
6881         } else if (obj->hdrChunk <= 0) {
6882                 YCHAR locName[20];
6883                 YCHAR numString[20];
6884                 YCHAR *x = &numString[19];
6885                 unsigned v = obj->objectId;
6886                 numString[19] = 0;
6887                 while (v > 0) {
6888                         x--;
6889                         *x = '0' + (v % 10);
6890                         v /= 10;
6891                 }
6892                 /* make up a name */
6893                 yaffs_strcpy(locName, YAFFS_LOSTNFOUND_PREFIX);
6894                 yaffs_strcat(locName, x);
6895                 yaffs_strncpy(name, locName, buffSize - 1);
6896
6897         }
6898 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
6899         else if (obj->shortName[0])
6900                 yaffs_strcpy(name, obj->shortName);
6901 #endif
6902         else {
6903                 int result;
6904                 __u8 *buffer = yaffs_GetTempBuffer(obj->myDev, __LINE__);
6905
6906                 yaffs_ObjectHeader *oh = (yaffs_ObjectHeader *) buffer;
6907
6908                 memset(buffer, 0, obj->myDev->nDataBytesPerChunk);
6909
6910                 if (obj->hdrChunk > 0) {
6911                         result = yaffs_ReadChunkWithTagsFromNAND(obj->myDev,
6912                                                         obj->hdrChunk, buffer,
6913                                                         NULL);
6914                 }
6915                 yaffs_strncpy(name, oh->name, buffSize - 1);
6916
6917                 yaffs_ReleaseTempBuffer(obj->myDev, buffer, __LINE__);
6918         }
6919
6920         return yaffs_strlen(name);
6921 }
6922
6923 int yaffs_GetObjectFileLength(yaffs_Object *obj)
6924 {
6925         /* Dereference any hard linking */
6926         obj = yaffs_GetEquivalentObject(obj);
6927
6928         if (obj->variantType == YAFFS_OBJECT_TYPE_FILE)
6929                 return obj->variant.fileVariant.fileSize;
6930         if (obj->variantType == YAFFS_OBJECT_TYPE_SYMLINK)
6931                 return yaffs_strlen(obj->variant.symLinkVariant.alias);
6932         else {
6933                 /* Only a directory should drop through to here */
6934                 return obj->myDev->nDataBytesPerChunk;
6935         }
6936 }
6937
6938 int yaffs_GetObjectLinkCount(yaffs_Object *obj)
6939 {
6940         int count = 0;
6941         struct ylist_head *i;
6942
6943         if (!obj->unlinked)
6944                 count++;                /* the object itself */
6945
6946         ylist_for_each(i, &obj->hardLinks)
6947                 count++;                /* add the hard links; */
6948
6949         return count;
6950 }
6951
6952 int yaffs_GetObjectInode(yaffs_Object *obj)
6953 {
6954         obj = yaffs_GetEquivalentObject(obj);
6955
6956         return obj->objectId;
6957 }
6958
6959 unsigned yaffs_GetObjectType(yaffs_Object *obj)
6960 {
6961         obj = yaffs_GetEquivalentObject(obj);
6962
6963         switch (obj->variantType) {
6964         case YAFFS_OBJECT_TYPE_FILE:
6965                 return DT_REG;
6966                 break;
6967         case YAFFS_OBJECT_TYPE_DIRECTORY:
6968                 return DT_DIR;
6969                 break;
6970         case YAFFS_OBJECT_TYPE_SYMLINK:
6971                 return DT_LNK;
6972                 break;
6973         case YAFFS_OBJECT_TYPE_HARDLINK:
6974                 return DT_REG;
6975                 break;
6976         case YAFFS_OBJECT_TYPE_SPECIAL:
6977                 if (S_ISFIFO(obj->yst_mode))
6978                         return DT_FIFO;
6979                 if (S_ISCHR(obj->yst_mode))
6980                         return DT_CHR;
6981                 if (S_ISBLK(obj->yst_mode))
6982                         return DT_BLK;
6983                 if (S_ISSOCK(obj->yst_mode))
6984                         return DT_SOCK;
6985         default:
6986                 return DT_REG;
6987                 break;
6988         }
6989 }
6990
6991 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj)
6992 {
6993         obj = yaffs_GetEquivalentObject(obj);
6994         if (obj->variantType == YAFFS_OBJECT_TYPE_SYMLINK)
6995                 return yaffs_CloneString(obj->variant.symLinkVariant.alias);
6996         else
6997                 return yaffs_CloneString(_Y(""));
6998 }
6999
7000 #ifndef CONFIG_YAFFS_WINCE
7001
7002 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr)
7003 {
7004         unsigned int valid = attr->ia_valid;
7005
7006         if (valid & ATTR_MODE)
7007                 obj->yst_mode = attr->ia_mode;
7008         if (valid & ATTR_UID)
7009                 obj->yst_uid = attr->ia_uid;
7010         if (valid & ATTR_GID)
7011                 obj->yst_gid = attr->ia_gid;
7012
7013         if (valid & ATTR_ATIME)
7014                 obj->yst_atime = Y_TIME_CONVERT(attr->ia_atime);
7015         if (valid & ATTR_CTIME)
7016                 obj->yst_ctime = Y_TIME_CONVERT(attr->ia_ctime);
7017         if (valid & ATTR_MTIME)
7018                 obj->yst_mtime = Y_TIME_CONVERT(attr->ia_mtime);
7019
7020         if (valid & ATTR_SIZE)
7021                 yaffs_ResizeFile(obj, attr->ia_size);
7022
7023         yaffs_UpdateObjectHeader(obj, NULL, 1, 0, 0);
7024
7025         return YAFFS_OK;
7026
7027 }
7028 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr)
7029 {
7030         unsigned int valid = 0;
7031
7032         attr->ia_mode = obj->yst_mode;
7033         valid |= ATTR_MODE;
7034         attr->ia_uid = obj->yst_uid;
7035         valid |= ATTR_UID;
7036         attr->ia_gid = obj->yst_gid;
7037         valid |= ATTR_GID;
7038
7039         Y_TIME_CONVERT(attr->ia_atime) = obj->yst_atime;
7040         valid |= ATTR_ATIME;
7041         Y_TIME_CONVERT(attr->ia_ctime) = obj->yst_ctime;
7042         valid |= ATTR_CTIME;
7043         Y_TIME_CONVERT(attr->ia_mtime) = obj->yst_mtime;
7044         valid |= ATTR_MTIME;
7045
7046         attr->ia_size = yaffs_GetFileSize(obj);
7047         valid |= ATTR_SIZE;
7048
7049         attr->ia_valid = valid;
7050
7051         return YAFFS_OK;
7052 }
7053
7054 #endif
7055
7056 #if 0
7057 int yaffs_DumpObject(yaffs_Object *obj)
7058 {
7059         YCHAR name[257];
7060
7061         yaffs_GetObjectName(obj, name, 256);
7062
7063         T(YAFFS_TRACE_ALWAYS,
7064           (TSTR
7065            ("Object %d, inode %d \"%s\"\n dirty %d valid %d serial %d sum %d"
7066             " chunk %d type %d size %d\n"
7067             TENDSTR), obj->objectId, yaffs_GetObjectInode(obj), name,
7068            obj->dirty, obj->valid, obj->serial, obj->sum, obj->hdrChunk,
7069            yaffs_GetObjectType(obj), yaffs_GetObjectFileLength(obj)));
7070
7071         return YAFFS_OK;
7072 }
7073 #endif
7074
7075 /*---------------------------- Initialisation code -------------------------------------- */
7076
7077 static int yaffs_CheckDevFunctions(const yaffs_Device *dev)
7078 {
7079
7080         /* Common functions, gotta have */
7081         if (!dev->eraseBlockInNAND || !dev->initialiseNAND)
7082                 return 0;
7083
7084 #ifdef CONFIG_YAFFS_YAFFS2
7085
7086         /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
7087         if (dev->writeChunkWithTagsToNAND &&
7088             dev->readChunkWithTagsFromNAND &&
7089             !dev->writeChunkToNAND &&
7090             !dev->readChunkFromNAND &&
7091             dev->markNANDBlockBad && dev->queryNANDBlock)
7092                 return 1;
7093 #endif
7094
7095         /* Can use the "spare" style interface for yaffs1 */
7096         if (!dev->isYaffs2 &&
7097             !dev->writeChunkWithTagsToNAND &&
7098             !dev->readChunkWithTagsFromNAND &&
7099             dev->writeChunkToNAND &&
7100             dev->readChunkFromNAND &&
7101             !dev->markNANDBlockBad && !dev->queryNANDBlock)
7102                 return 1;
7103
7104         return 0;               /* bad */
7105 }
7106
7107
7108 static int yaffs_CreateInitialDirectories(yaffs_Device *dev)
7109 {
7110         /* Initialise the unlinked, deleted, root and lost and found directories */
7111
7112         dev->lostNFoundDir = dev->rootDir =  NULL;
7113         dev->unlinkedDir = dev->deletedDir = NULL;
7114
7115         dev->unlinkedDir =
7116             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
7117
7118         dev->deletedDir =
7119             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
7120
7121         dev->rootDir =
7122             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_ROOT,
7123                                       YAFFS_ROOT_MODE | S_IFDIR);
7124         dev->lostNFoundDir =
7125             yaffs_CreateFakeDirectory(dev, YAFFS_OBJECTID_LOSTNFOUND,
7126                                       YAFFS_LOSTNFOUND_MODE | S_IFDIR);
7127
7128         if (dev->lostNFoundDir && dev->rootDir && dev->unlinkedDir && dev->deletedDir) {
7129                 yaffs_AddObjectToDirectory(dev->rootDir, dev->lostNFoundDir);
7130                 return YAFFS_OK;
7131         }
7132
7133         return YAFFS_FAIL;
7134 }
7135
7136 int yaffs_GutsInitialise(yaffs_Device *dev)
7137 {
7138         int init_failed = 0;
7139         unsigned x;
7140         int bits;
7141
7142         T(YAFFS_TRACE_TRACING, (TSTR("yaffs: yaffs_GutsInitialise()" TENDSTR)));
7143
7144         /* Check stuff that must be set */
7145
7146         if (!dev) {
7147                 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Need a device" TENDSTR)));
7148                 return YAFFS_FAIL;
7149         }
7150
7151         dev->internalStartBlock = dev->startBlock;
7152         dev->internalEndBlock = dev->endBlock;
7153         dev->blockOffset = 0;
7154         dev->chunkOffset = 0;
7155         dev->nFreeChunks = 0;
7156
7157         dev->gcBlock = -1;
7158
7159         if (dev->startBlock == 0) {
7160                 dev->internalStartBlock = dev->startBlock + 1;
7161                 dev->internalEndBlock = dev->endBlock + 1;
7162                 dev->blockOffset = 1;
7163                 dev->chunkOffset = dev->nChunksPerBlock;
7164         }
7165
7166         /* Check geometry parameters. */
7167
7168         if ((!dev->inbandTags && dev->isYaffs2 && dev->totalBytesPerChunk < 1024) ||
7169             (!dev->isYaffs2 && dev->totalBytesPerChunk < 512) ||
7170             (dev->inbandTags && !dev->isYaffs2) ||
7171              dev->nChunksPerBlock < 2 ||
7172              dev->nReservedBlocks < 2 ||
7173              dev->internalStartBlock <= 0 ||
7174              dev->internalEndBlock <= 0 ||
7175              dev->internalEndBlock <= (dev->internalStartBlock + dev->nReservedBlocks + 2)) {   /* otherwise it is too small */
7176                 T(YAFFS_TRACE_ALWAYS,
7177                   (TSTR
7178                    ("yaffs: NAND geometry problems: chunk size %d, type is yaffs%s, inbandTags %d "
7179                     TENDSTR), dev->totalBytesPerChunk, dev->isYaffs2 ? "2" : "", dev->inbandTags));
7180                 return YAFFS_FAIL;
7181         }
7182
7183         if (yaffs_InitialiseNAND(dev) != YAFFS_OK) {
7184                 T(YAFFS_TRACE_ALWAYS,
7185                   (TSTR("yaffs: InitialiseNAND failed" TENDSTR)));
7186                 return YAFFS_FAIL;
7187         }
7188
7189         /* Sort out space for inband tags, if required */
7190         if (dev->inbandTags)
7191                 dev->nDataBytesPerChunk = dev->totalBytesPerChunk - sizeof(yaffs_PackedTags2TagsPart);
7192         else
7193                 dev->nDataBytesPerChunk = dev->totalBytesPerChunk;
7194
7195         /* Got the right mix of functions? */
7196         if (!yaffs_CheckDevFunctions(dev)) {
7197                 /* Function missing */
7198                 T(YAFFS_TRACE_ALWAYS,
7199                   (TSTR
7200                    ("yaffs: device function(s) missing or wrong\n" TENDSTR)));
7201
7202                 return YAFFS_FAIL;
7203         }
7204
7205         /* This is really a compilation check. */
7206         if (!yaffs_CheckStructures()) {
7207                 T(YAFFS_TRACE_ALWAYS,
7208                   (TSTR("yaffs_CheckStructures failed\n" TENDSTR)));
7209                 return YAFFS_FAIL;
7210         }
7211
7212         if (dev->isMounted) {
7213                 T(YAFFS_TRACE_ALWAYS,
7214                   (TSTR("yaffs: device already mounted\n" TENDSTR)));
7215                 return YAFFS_FAIL;
7216         }
7217
7218         /* Finished with most checks. One or two more checks happen later on too. */
7219
7220         dev->isMounted = 1;
7221
7222         /* OK now calculate a few things for the device */
7223
7224         /*
7225          *  Calculate all the chunk size manipulation numbers:
7226          */
7227         x = dev->nDataBytesPerChunk;
7228         /* We always use dev->chunkShift and dev->chunkDiv */
7229         dev->chunkShift = Shifts(x);
7230         x >>= dev->chunkShift;
7231         dev->chunkDiv = x;
7232         /* We only use chunk mask if chunkDiv is 1 */
7233         dev->chunkMask = (1<<dev->chunkShift) - 1;
7234
7235         /*
7236          * Calculate chunkGroupBits.
7237          * We need to find the next power of 2 > than internalEndBlock
7238          */
7239
7240         x = dev->nChunksPerBlock * (dev->internalEndBlock + 1);
7241
7242         bits = ShiftsGE(x);
7243
7244         /* Set up tnode width if wide tnodes are enabled. */
7245         if (!dev->wideTnodesDisabled) {
7246                 /* bits must be even so that we end up with 32-bit words */
7247                 if (bits & 1)
7248                         bits++;
7249                 if (bits < 16)
7250                         dev->tnodeWidth = 16;
7251                 else
7252                         dev->tnodeWidth = bits;
7253         } else
7254                 dev->tnodeWidth = 16;
7255
7256         dev->tnodeMask = (1<<dev->tnodeWidth)-1;
7257
7258         /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
7259          * so if the bitwidth of the
7260          * chunk range we're using is greater than 16 we need
7261          * to figure out chunk shift and chunkGroupSize
7262          */
7263
7264         if (bits <= dev->tnodeWidth)
7265                 dev->chunkGroupBits = 0;
7266         else
7267                 dev->chunkGroupBits = bits - dev->tnodeWidth;
7268
7269
7270         dev->chunkGroupSize = 1 << dev->chunkGroupBits;
7271
7272         if (dev->nChunksPerBlock < dev->chunkGroupSize) {
7273                 /* We have a problem because the soft delete won't work if
7274                  * the chunk group size > chunks per block.
7275                  * This can be remedied by using larger "virtual blocks".
7276                  */
7277                 T(YAFFS_TRACE_ALWAYS,
7278                   (TSTR("yaffs: chunk group too large\n" TENDSTR)));
7279
7280                 return YAFFS_FAIL;
7281         }
7282
7283         /* OK, we've finished verifying the device, lets continue with initialisation */
7284
7285         /* More device initialisation */
7286         dev->garbageCollections = 0;
7287         dev->passiveGarbageCollections = 0;
7288         dev->currentDirtyChecker = 0;
7289         dev->bufferedBlock = -1;
7290         dev->doingBufferedBlockRewrite = 0;
7291         dev->nDeletedFiles = 0;
7292         dev->nBackgroundDeletions = 0;
7293         dev->nUnlinkedFiles = 0;
7294         dev->eccFixed = 0;
7295         dev->eccUnfixed = 0;
7296         dev->tagsEccFixed = 0;
7297         dev->tagsEccUnfixed = 0;
7298         dev->nErasureFailures = 0;
7299         dev->nErasedBlocks = 0;
7300         dev->isDoingGC = 0;
7301         dev->hasPendingPrioritisedGCs = 1; /* Assume the worst for now, will get fixed on first GC */
7302
7303         /* Initialise temporary buffers and caches. */
7304         if (!yaffs_InitialiseTempBuffers(dev))
7305                 init_failed = 1;
7306
7307         dev->srCache = NULL;
7308         dev->gcCleanupList = NULL;
7309
7310
7311         if (!init_failed &&
7312             dev->nShortOpCaches > 0) {
7313                 int i;
7314                 void *buf;
7315                 int srCacheBytes = dev->nShortOpCaches * sizeof(yaffs_ChunkCache);
7316
7317                 if (dev->nShortOpCaches > YAFFS_MAX_SHORT_OP_CACHES)
7318                         dev->nShortOpCaches = YAFFS_MAX_SHORT_OP_CACHES;
7319
7320                 dev->srCache =  YMALLOC(srCacheBytes);
7321
7322                 buf = (__u8 *) dev->srCache;
7323
7324                 if (dev->srCache)
7325                         memset(dev->srCache, 0, srCacheBytes);
7326
7327                 for (i = 0; i < dev->nShortOpCaches && buf; i++) {
7328                         dev->srCache[i].object = NULL;
7329                         dev->srCache[i].lastUse = 0;
7330                         dev->srCache[i].dirty = 0;
7331                         dev->srCache[i].data = buf = YMALLOC_DMA(dev->totalBytesPerChunk);
7332                 }
7333                 if (!buf)
7334                         init_failed = 1;
7335
7336                 dev->srLastUse = 0;
7337         }
7338
7339         dev->cacheHits = 0;
7340
7341         if (!init_failed) {
7342                 dev->gcCleanupList = YMALLOC(dev->nChunksPerBlock * sizeof(__u32));
7343                 if (!dev->gcCleanupList)
7344                         init_failed = 1;
7345         }
7346
7347         if (dev->isYaffs2)
7348                 dev->useHeaderFileSize = 1;
7349
7350         if (!init_failed && !yaffs_InitialiseBlocks(dev))
7351                 init_failed = 1;
7352
7353         yaffs_InitialiseTnodes(dev);
7354         yaffs_InitialiseObjects(dev);
7355
7356         if (!init_failed && !yaffs_CreateInitialDirectories(dev))
7357                 init_failed = 1;
7358
7359
7360         if (!init_failed) {
7361                 /* Now scan the flash. */
7362                 if (dev->isYaffs2) {
7363                         if (yaffs_CheckpointRestore(dev)) {
7364                                 yaffs_CheckObjectDetailsLoaded(dev->rootDir);
7365                                 T(YAFFS_TRACE_ALWAYS,
7366                                   (TSTR("yaffs: restored from checkpoint" TENDSTR)));
7367                         } else {
7368
7369                                 /* Clean up the mess caused by an aborted checkpoint load
7370                                  * and scan backwards.
7371                                  */
7372                                 yaffs_DeinitialiseBlocks(dev);
7373                                 yaffs_DeinitialiseTnodes(dev);
7374                                 yaffs_DeinitialiseObjects(dev);
7375
7376
7377                                 dev->nErasedBlocks = 0;
7378                                 dev->nFreeChunks = 0;
7379                                 dev->allocationBlock = -1;
7380                                 dev->allocationPage = -1;
7381                                 dev->nDeletedFiles = 0;
7382                                 dev->nUnlinkedFiles = 0;
7383                                 dev->nBackgroundDeletions = 0;
7384                                 dev->oldestDirtySequence = 0;
7385
7386                                 if (!init_failed && !yaffs_InitialiseBlocks(dev))
7387                                         init_failed = 1;
7388
7389                                 yaffs_InitialiseTnodes(dev);
7390                                 yaffs_InitialiseObjects(dev);
7391
7392                                 if (!init_failed && !yaffs_CreateInitialDirectories(dev))
7393                                         init_failed = 1;
7394
7395                                 if (!init_failed && !yaffs_ScanBackwards(dev))
7396                                         init_failed = 1;
7397                         }
7398                 } else if (!yaffs_Scan(dev))
7399                                 init_failed = 1;
7400
7401                 yaffs_StripDeletedObjects(dev);
7402         }
7403
7404         if (init_failed) {
7405                 /* Clean up the mess */
7406                 T(YAFFS_TRACE_TRACING,
7407                   (TSTR("yaffs: yaffs_GutsInitialise() aborted.\n" TENDSTR)));
7408
7409                 yaffs_Deinitialise(dev);
7410                 return YAFFS_FAIL;
7411         }
7412
7413         /* Zero out stats */
7414         dev->nPageReads = 0;
7415         dev->nPageWrites = 0;
7416         dev->nBlockErasures = 0;
7417         dev->nGCCopies = 0;
7418         dev->nRetriedWrites = 0;
7419
7420         dev->nRetiredBlocks = 0;
7421
7422         yaffs_VerifyFreeChunks(dev);
7423         yaffs_VerifyBlocks(dev);
7424
7425
7426         T(YAFFS_TRACE_TRACING,
7427           (TSTR("yaffs: yaffs_GutsInitialise() done.\n" TENDSTR)));
7428         return YAFFS_OK;
7429
7430 }
7431
7432 void yaffs_Deinitialise(yaffs_Device *dev)
7433 {
7434         if (dev->isMounted) {
7435                 int i;
7436
7437                 yaffs_DeinitialiseBlocks(dev);
7438                 yaffs_DeinitialiseTnodes(dev);
7439                 yaffs_DeinitialiseObjects(dev);
7440                 if (dev->nShortOpCaches > 0 &&
7441                     dev->srCache) {
7442
7443                         for (i = 0; i < dev->nShortOpCaches; i++) {
7444                                 if (dev->srCache[i].data)
7445                                         YFREE(dev->srCache[i].data);
7446                                 dev->srCache[i].data = NULL;
7447                         }
7448
7449                         YFREE(dev->srCache);
7450                         dev->srCache = NULL;
7451                 }
7452
7453                 YFREE(dev->gcCleanupList);
7454
7455                 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
7456                         YFREE(dev->tempBuffer[i].buffer);
7457
7458                 dev->isMounted = 0;
7459
7460                 if (dev->deinitialiseNAND)
7461                         dev->deinitialiseNAND(dev);
7462         }
7463 }
7464
7465 static int yaffs_CountFreeChunks(yaffs_Device *dev)
7466 {
7467         int nFree;
7468         int b;
7469
7470         yaffs_BlockInfo *blk;
7471
7472         for (nFree = 0, b = dev->internalStartBlock; b <= dev->internalEndBlock;
7473                         b++) {
7474                 blk = yaffs_GetBlockInfo(dev, b);
7475
7476                 switch (blk->blockState) {
7477                 case YAFFS_BLOCK_STATE_EMPTY:
7478                 case YAFFS_BLOCK_STATE_ALLOCATING:
7479                 case YAFFS_BLOCK_STATE_COLLECTING:
7480                 case YAFFS_BLOCK_STATE_FULL:
7481                         nFree +=
7482                             (dev->nChunksPerBlock - blk->pagesInUse +
7483                              blk->softDeletions);
7484                         break;
7485                 default:
7486                         break;
7487                 }
7488         }
7489
7490         return nFree;
7491 }
7492
7493 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev)
7494 {
7495         /* This is what we report to the outside world */
7496
7497         int nFree;
7498         int nDirtyCacheChunks;
7499         int blocksForCheckpoint;
7500         int i;
7501
7502 #if 1
7503         nFree = dev->nFreeChunks;
7504 #else
7505         nFree = yaffs_CountFreeChunks(dev);
7506 #endif
7507
7508         nFree += dev->nDeletedFiles;
7509
7510         /* Now count the number of dirty chunks in the cache and subtract those */
7511
7512         for (nDirtyCacheChunks = 0, i = 0; i < dev->nShortOpCaches; i++) {
7513                 if (dev->srCache[i].dirty)
7514                         nDirtyCacheChunks++;
7515         }
7516
7517         nFree -= nDirtyCacheChunks;
7518
7519         nFree -= ((dev->nReservedBlocks + 1) * dev->nChunksPerBlock);
7520
7521         /* Now we figure out how much to reserve for the checkpoint and report that... */
7522         blocksForCheckpoint = yaffs_CalcCheckpointBlocksRequired(dev) - dev->blocksInCheckpoint;
7523         if (blocksForCheckpoint < 0)
7524                 blocksForCheckpoint = 0;
7525
7526         nFree -= (blocksForCheckpoint * dev->nChunksPerBlock);
7527
7528         if (nFree < 0)
7529                 nFree = 0;
7530
7531         return nFree;
7532
7533 }
7534
7535 static int yaffs_freeVerificationFailures;
7536
7537 static void yaffs_VerifyFreeChunks(yaffs_Device *dev)
7538 {
7539         int counted;
7540         int difference;
7541
7542         if (yaffs_SkipVerification(dev))
7543                 return;
7544
7545         counted = yaffs_CountFreeChunks(dev);
7546
7547         difference = dev->nFreeChunks - counted;
7548
7549         if (difference) {
7550                 T(YAFFS_TRACE_ALWAYS,
7551                   (TSTR("Freechunks verification failure %d %d %d" TENDSTR),
7552                    dev->nFreeChunks, counted, difference));
7553                 yaffs_freeVerificationFailures++;
7554         }
7555 }
7556
7557 /*---------------------------------------- YAFFS test code ----------------------*/
7558
7559 #define yaffs_CheckStruct(structure, syze, name) \
7560         do { \
7561                 if (sizeof(structure) != syze) { \
7562                         T(YAFFS_TRACE_ALWAYS, (TSTR("%s should be %d but is %d\n" TENDSTR),\
7563                                 name, syze, sizeof(structure))); \
7564                         return YAFFS_FAIL; \
7565                 } \
7566         } while (0)
7567
7568 static int yaffs_CheckStructures(void)
7569 {
7570 /*      yaffs_CheckStruct(yaffs_Tags,8,"yaffs_Tags"); */
7571 /*      yaffs_CheckStruct(yaffs_TagsUnion,8,"yaffs_TagsUnion"); */
7572 /*      yaffs_CheckStruct(yaffs_Spare,16,"yaffs_Spare"); */
7573 #ifndef CONFIG_YAFFS_TNODE_LIST_DEBUG
7574         yaffs_CheckStruct(yaffs_Tnode, 2 * YAFFS_NTNODES_LEVEL0, "yaffs_Tnode");
7575 #endif
7576 #ifndef CONFIG_YAFFS_WINCE
7577         yaffs_CheckStruct(yaffs_ObjectHeader, 512, "yaffs_ObjectHeader");
7578 #endif
7579         return YAFFS_OK;
7580 }