yaffs_guts.h

   1 /*
   2  * YAFFS: Yet another FFS. A NAND-flash specific file system.
   3  * yaffs_guts.h: Configuration etc for yaffs_guts
   4  *
   5  * Copyright (C) 2002 Aleph One Ltd.
   6  *   for Toby Churchill Ltd and Brightstar Engineering
   7  *
   8  * Created by Charles Manning <charles@aleph1.co.uk>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU Lesser General Public License version 2.1 as
  12  * published by the Free Software Foundation.
  13  *
  14  *
  15  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
  16  *
  17  * $Id: yaffs_guts.h,v 1.23 2006-09-21 08:13:59 charles Exp $
  18  */
  19
  20 #ifndef __YAFFS_GUTS_H__
  21 #define __YAFFS_GUTS_H__
  22
  23 #include "devextras.h"
  24 #include "yportenv.h"
  25
  26 #define YAFFS_OK        1
  27 #define YAFFS_FAIL  0
  28
  29 /* Give us a  Y=0x59,
  30  * Give us an A=0x41,
  31  * Give us an FF=0xFF
  32  * Give us an S=0x53
  33  * And what have we got...
  34  */
  35 #define YAFFS_MAGIC                     0x5941FF53
  36
  37 #define YAFFS_NTNODES_LEVEL0            16
  38 #define YAFFS_TNODES_LEVEL0_BITS        4
  39 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  40
  41 #define YAFFS_NTNODES_INTERNAL          (YAFFS_NTNODES_LEVEL0 / 2)
  42 #define YAFFS_TNODES_INTERNAL_BITS      (YAFFS_TNODES_LEVEL0_BITS - 1)
  43 #define YAFFS_TNODES_INTERNAL_MASK      0x7
  44 #define YAFFS_TNODES_MAX_LEVEL          6
  45
  46 #ifndef CONFIG_YAFFS_NO_YAFFS1
  47 #define YAFFS_BYTES_PER_SPARE           16
  48 #define YAFFS_BYTES_PER_CHUNK           512
  49 #define YAFFS_CHUNK_SIZE_SHIFT          9
  50 #define YAFFS_CHUNKS_PER_BLOCK          32
  51 #define YAFFS_BYTES_PER_BLOCK           (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
  52 #endif
  53
  54 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE     1024
  55 #define YAFFS_MIN_YAFFS2_SPARE_SIZE     32
  56
  57 #define YAFFS_MAX_CHUNK_ID              0x000FFFFF
  58
  59 #define YAFFS_UNUSED_OBJECT_ID          0x0003FFFF
  60
  61 #define YAFFS_ALLOCATION_NOBJECTS       100
  62 #define YAFFS_ALLOCATION_NTNODES        100
  63 #define YAFFS_ALLOCATION_NLINKS         100
  64
  65 #define YAFFS_NOBJECT_BUCKETS           256
  66
  67
  68 #define YAFFS_OBJECT_SPACE              0x40000
  69
  70 #define YAFFS_NCHECKPOINT_OBJECTS       5000
  71
  72 #ifdef CONFIG_YAFFS_UNICODE
  73 #define YAFFS_MAX_NAME_LENGTH           127
  74 #define YAFFS_MAX_ALIAS_LENGTH          79
  75 #else
  76 #define YAFFS_MAX_NAME_LENGTH           255
  77 #define YAFFS_MAX_ALIAS_LENGTH          159
  78 #endif
  79
  80 #define YAFFS_SHORT_NAME_LENGTH         15
  81
  82 /* Some special object ids for pseudo objects */
  83 #define YAFFS_OBJECTID_ROOT             1
  84 #define YAFFS_OBJECTID_LOSTNFOUND       2
  85 #define YAFFS_OBJECTID_UNLINKED         3
  86 #define YAFFS_OBJECTID_DELETED          4
  87
  88 /* Sseudo object ids for checkpointing */
  89 #define YAFFS_OBJECTID_SB_HEADER        0x10
  90 #define YAFFS_OBJECTID_CHECKPOINT_DATA  0x20
  91 #define YAFFS_SEQUENCE_CHECKPOINT_DATA  0x21
  92
  93 /* */
  94
  95 #define YAFFS_MAX_SHORT_OP_CACHES       20
  96
  97 #define YAFFS_N_TEMP_BUFFERS            4
  98
  99 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
 100  * The range is limited slightly to help distinguish bad numbers from good.
 101  * This also allows us to perhaps in the future use special numbers for
 102  * special purposes.
 103  * EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years,
 104  * and is a larger number than the lifetime of a 2GB device.
 105  */
 106 #define YAFFS_LOWEST_SEQUENCE_NUMBER    0x00001000
 107 #define YAFFS_HIGHEST_SEQUENCE_NUMBER   0xEFFFFF00
 108
 109 /* ChunkCache is used for short read/write operations.*/
 110 typedef struct {
 111         struct yaffs_ObjectStruct *object;
 112         int chunkId;
 113         int lastUse;
 114         int dirty;
 115         int nBytes;             /* Only valid if the cache is dirty */
 116         int locked;             /* Can't push out or flush while locked. */
 117 #ifdef CONFIG_YAFFS_YAFFS2
 118         __u8 *data;
 119 #else
 120         __u8 data[YAFFS_BYTES_PER_CHUNK];
 121 #endif
 122 } yaffs_ChunkCache;
 123
 124
 125
 126 /* Tags structures in RAM
 127  * NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
 128  * the structure size will get blown out.
 129  */
 130
 131 #ifndef CONFIG_YAFFS_NO_YAFFS1
 132 typedef struct {
 133         unsigned chunkId:20;
 134         unsigned serialNumber:2;
 135         unsigned byteCount:10;
 136         unsigned objectId:18;
 137         unsigned ecc:12;
 138         unsigned unusedStuff:2;
 139
 140 } yaffs_Tags;
 141
 142 typedef union {
 143         yaffs_Tags asTags;
 144         __u8 asBytes[8];
 145 } yaffs_TagsUnion;
 146
 147 #endif
 148
 149 /* Stuff used for extended tags in YAFFS2 */
 150
 151 typedef enum {
 152         YAFFS_ECC_RESULT_UNKNOWN,
 153         YAFFS_ECC_RESULT_NO_ERROR,
 154         YAFFS_ECC_RESULT_FIXED,
 155         YAFFS_ECC_RESULT_UNFIXED
 156 } yaffs_ECCResult;
 157
 158 typedef enum {
 159         YAFFS_OBJECT_TYPE_UNKNOWN,
 160         YAFFS_OBJECT_TYPE_FILE,
 161         YAFFS_OBJECT_TYPE_SYMLINK,
 162         YAFFS_OBJECT_TYPE_DIRECTORY,
 163         YAFFS_OBJECT_TYPE_HARDLINK,
 164         YAFFS_OBJECT_TYPE_SPECIAL
 165 } yaffs_ObjectType;
 166
 167 typedef struct {
 168
 169         unsigned validMarker0;
 170         unsigned chunkUsed;     /*  Status of the chunk: used or unused */
 171         unsigned objectId;      /* If 0 then this is not part of an object (unused) */
 172         unsigned chunkId;       /* If 0 then this is a header, else a data chunk */
 173         unsigned byteCount;     /* Only valid for data chunks */
 174
 175         /* The following stuff only has meaning when we read */
 176         yaffs_ECCResult eccResult;
 177         unsigned blockBad;
 178
 179         /* YAFFS 1 stuff */
 180         unsigned chunkDeleted;  /* The chunk is marked deleted */
 181         unsigned serialNumber;  /* Yaffs1 2-bit serial number */
 182
 183         /* YAFFS2 stuff */
 184         unsigned sequenceNumber;        /* The sequence number of this block */
 185
 186         /* Extra info if this is an object header (YAFFS2 only) */
 187
 188         unsigned extraHeaderInfoAvailable;      /* There is extra info available if this is not zero */
 189         unsigned extraParentObjectId;   /* The parent object */
 190         unsigned extraIsShrinkHeader;   /* Is it a shrink header? */
 191         unsigned extraShadows;          /* Does this shadow another object? */
 192
 193         yaffs_ObjectType extraObjectType;       /* What object type? */
 194
 195         unsigned extraFileLength;               /* Length if it is a file */
 196         unsigned extraEquivalentObjectId;       /* Equivalent object Id if it is a hard link */
 197
 198         unsigned validMarker1;
 199
 200 } yaffs_ExtendedTags;
 201
 202 /* Spare structure for YAFFS1 */
 203 typedef struct {
 204         __u8 tagByte0;
 205         __u8 tagByte1;
 206         __u8 tagByte2;
 207         __u8 tagByte3;
 208         __u8 pageStatus;        /* set to 0 to delete the chunk */
 209         __u8 blockStatus;
 210         __u8 tagByte4;
 211         __u8 tagByte5;
 212         __u8 ecc1[3];
 213         __u8 tagByte6;
 214         __u8 tagByte7;
 215         __u8 ecc2[3];
 216 } yaffs_Spare;
 217
 218 /*Special structure for passing through to mtd */
 219 struct yaffs_NANDSpare {
 220         yaffs_Spare spare;
 221         int eccres1;
 222         int eccres2;
 223 };
 224
 225 /* Block data in RAM */
 226
 227 typedef enum {
 228         YAFFS_BLOCK_STATE_UNKNOWN = 0,
 229
 230         YAFFS_BLOCK_STATE_SCANNING,
 231         YAFFS_BLOCK_STATE_NEEDS_SCANNING,
 232         /* The block might have something on it (ie it is allocating or full, perhaps empty)
 233          * but it needs to be scanned to determine its true state.
 234          * This state is only valid during yaffs_Scan.
 235          * NB We tolerate empty because the pre-scanner might be incapable of deciding
 236          * However, if this state is returned on a YAFFS2 device, then we expect a sequence number
 237          */
 238
 239         YAFFS_BLOCK_STATE_EMPTY,
 240         /* This block is empty */
 241
 242         YAFFS_BLOCK_STATE_ALLOCATING,
 243         /* This block is partially allocated.
 244          * At least one page holds valid data.
 245          * This is the one currently being used for page
 246          * allocation. Should never be more than one of these
 247          */
 248
 249         YAFFS_BLOCK_STATE_FULL,
 250         /* All the pages in this block have been allocated.
 251          */
 252
 253         YAFFS_BLOCK_STATE_DIRTY,
 254         /* All pages have been allocated and deleted.
 255          * Erase me, reuse me.
 256          */
 257
 258         YAFFS_BLOCK_STATE_CHECKPOINT,
 259         /* This block is assigned to holding checkpoint data.
 260          */
 261
 262         YAFFS_BLOCK_STATE_COLLECTING,
 263         /* This block is being garbage collected */
 264
 265         YAFFS_BLOCK_STATE_DEAD
 266         /* This block has failed and is not in use */
 267 } yaffs_BlockState;
 268
 269 typedef struct {
 270
 271         int softDeletions:12;   /* number of soft deleted pages */
 272         int pagesInUse:12;      /* number of pages in use */
 273         yaffs_BlockState blockState:4;  /* One of the above block states */
 274         __u32 needsRetiring:1;  /* Data has failed on this block, need to get valid data off */
 275                                 /* and retire the block. */
 276         __u32 skipErasedCheck: 1; /* If this is set we can skip the erased check on this block */
 277         __u32 gcPrioritise: 1;  /* An ECC check or bank check has failed on this block.
 278                                    It should be prioritised for GC */
 279
 280 #ifdef CONFIG_YAFFS_YAFFS2
 281         __u32 hasShrinkHeader:1; /* This block has at least one shrink object header */
 282         __u32 sequenceNumber;    /* block sequence number for yaffs2 */
 283 #endif
 284
 285 } yaffs_BlockInfo;
 286
 287 /* -------------------------- Object structure -------------------------------*/
 288 /* This is the object structure as stored on NAND */
 289
 290 typedef struct {
 291         yaffs_ObjectType type;
 292
 293         /* Apply to everything  */
 294         int parentObjectId;
 295         __u16 sum__NoLongerUsed;        /* checksum of name. No longer used */
 296         YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
 297
 298         /* Thes following apply to directories, files, symlinks - not hard links */
 299         __u32 yst_mode;         /* protection */
 300
 301 #ifdef CONFIG_YAFFS_WINCE
 302         __u32 notForWinCE[5];
 303 #else
 304         __u32 yst_uid;
 305         __u32 yst_gid;
 306         __u32 yst_atime;
 307         __u32 yst_mtime;
 308         __u32 yst_ctime;
 309 #endif
 310
 311         /* File size  applies to files only */
 312         int fileSize;
 313
 314         /* Equivalent object id applies to hard links only. */
 315         int equivalentObjectId;
 316
 317         /* Alias is for symlinks only. */
 318         YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 319
 320         __u32 yst_rdev;         /* device stuff for block and char devices (major/min) */
 321
 322 #ifdef CONFIG_YAFFS_WINCE
 323         __u32 win_ctime[2];
 324         __u32 win_atime[2];
 325         __u32 win_mtime[2];
 326         __u32 roomToGrow[4];
 327 #else
 328         __u32 roomToGrow[10];
 329 #endif
 330
 331         int shadowsObject;      /* This object header shadows the specified object if > 0 */
 332
 333         /* isShrink applies to object headers written when we shrink the file (ie resize) */
 334         __u32 isShrink;
 335
 336 } yaffs_ObjectHeader;
 337
 338 /*--------------------------- Tnode -------------------------- */
 339
 340 union yaffs_Tnode_union {
 341 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
 342         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL + 1];
 343 #else
 344         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
 345 #endif
 346 /*      __u16 level0[YAFFS_NTNODES_LEVEL0]; */
 347
 348 };
 349
 350 typedef union yaffs_Tnode_union yaffs_Tnode;
 351
 352 struct yaffs_TnodeList_struct {
 353         struct yaffs_TnodeList_struct *next;
 354         yaffs_Tnode *tnodes;
 355 };
 356
 357 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
 358
 359 /*------------------------  Object -----------------------------*/
 360 /* An object can be one of:
 361  * - a directory (no data, has children links
 362  * - a regular file (data.... not prunes :->).
 363  * - a symlink [symbolic link] (the alias).
 364  * - a hard link
 365  */
 366
 367 typedef struct {
 368         __u32 fileSize;
 369         __u32 scannedFileSize;
 370         __u32 shrinkSize;
 371         int topLevel;
 372         yaffs_Tnode *top;
 373 } yaffs_FileStructure;
 374
 375 typedef struct {
 376         struct list_head children;      /* list of child links */
 377 } yaffs_DirectoryStructure;
 378
 379 typedef struct {
 380         YCHAR *alias;
 381 } yaffs_SymLinkStructure;
 382
 383 typedef struct {
 384         struct yaffs_ObjectStruct *equivalentObject;
 385         __u32 equivalentObjectId;
 386 } yaffs_HardLinkStructure;
 387
 388 typedef union {
 389         yaffs_FileStructure fileVariant;
 390         yaffs_DirectoryStructure directoryVariant;
 391         yaffs_SymLinkStructure symLinkVariant;
 392         yaffs_HardLinkStructure hardLinkVariant;
 393 } yaffs_ObjectVariant;
 394
 395 struct yaffs_ObjectStruct {
 396         __u8 deleted:1;         /* This should only apply to unlinked files. */
 397         __u8 softDeleted:1;     /* it has also been soft deleted */
 398         __u8 unlinked:1;        /* An unlinked file. The file should be in the unlinked directory.*/
 399         __u8 fake:1;            /* A fake object has no presence on NAND. */
 400         __u8 renameAllowed:1;   /* Some objects are not allowed to be renamed. */
 401         __u8 unlinkAllowed:1;
 402         __u8 dirty:1;           /* the object needs to be written to flash */
 403         __u8 valid:1;           /* When the file system is being loaded up, this
 404                                  * object might be created before the data
 405                                  * is available (ie. file data records appear before the header).
 406                                  */
 407         __u8 lazyLoaded:1;      /* This object has been lazy loaded and is missing some detail */
 408
 409         __u8 deferedFree:1;     /* For Linux kernel. Object is removed from NAND, but is
 410                                  * still in the inode cache. Free of object is defered.
 411                                  * until the inode is released.
 412                                  */
 413
 414         __u8 serial;            /* serial number of chunk in NAND. Cached here */
 415         __u16 sum;              /* sum of the name to speed searching */
 416
 417         struct yaffs_DeviceStruct *myDev;       /* The device I'm on */
 418
 419         struct list_head hashLink;      /* list of objects in this hash bucket */
 420
 421         struct list_head hardLinks;     /* all the equivalent hard linked objects */
 422
 423         /* directory structure stuff */
 424         /* also used for linking up the free list */
 425         struct yaffs_ObjectStruct *parent;
 426         struct list_head siblings;
 427
 428         /* Where's my object header in NAND? */
 429         int chunkId;
 430
 431         int nDataChunks;        /* Number of data chunks attached to the file. */
 432
 433         __u32 objectId;         /* the object id value */
 434
 435         __u32 yst_mode;
 436
 437 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
 438         YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
 439 #endif
 440
 441 #ifndef __KERNEL__
 442         __u32 inUse;
 443 #endif
 444
 445 #ifdef CONFIG_YAFFS_WINCE
 446         __u32 win_ctime[2];
 447         __u32 win_mtime[2];
 448         __u32 win_atime[2];
 449 #else
 450         __u32 yst_uid;
 451         __u32 yst_gid;
 452         __u32 yst_atime;
 453         __u32 yst_mtime;
 454         __u32 yst_ctime;
 455 #endif
 456
 457         __u32 yst_rdev;
 458
 459 #ifdef __KERNEL__
 460         struct inode *myInode;
 461
 462 #endif
 463
 464         yaffs_ObjectType variantType;
 465
 466         yaffs_ObjectVariant variant;
 467
 468 };
 469
 470 typedef struct yaffs_ObjectStruct yaffs_Object;
 471
 472 struct yaffs_ObjectList_struct {
 473         yaffs_Object *objects;
 474         struct yaffs_ObjectList_struct *next;
 475 };
 476
 477 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
 478
 479 typedef struct {
 480         struct list_head list;
 481         int count;
 482 } yaffs_ObjectBucket;
 483
 484
 485 /* yaffs_CheckpointObject holds the definition of an object as dumped
 486  * by checkpointing.
 487  */
 488
 489 typedef struct {
 490         int structType;
 491         __u32 objectId;
 492         __u32 parentId;
 493         int chunkId;
 494
 495         yaffs_ObjectType variantType:3;
 496         __u8 deleted:1;
 497         __u8 softDeleted:1;
 498         __u8 unlinked:1;
 499         __u8 fake:1;
 500         __u8 renameAllowed:1;
 501         __u8 unlinkAllowed:1;
 502         __u8 serial;
 503
 504         int nDataChunks;
 505         __u32 fileSizeOrEquivalentObjectId;
 506
 507 }yaffs_CheckpointObject;
 508
 509 /*--------------------- Temporary buffers ----------------
 510  *
 511  * These are chunk-sized working buffers. Each device has a few
 512  */
 513
 514 typedef struct {
 515         __u8 *buffer;
 516         int line;       /* track from whence this buffer was allocated */
 517         int maxLine;
 518 } yaffs_TempBuffer;
 519
 520 /*----------------- Device ---------------------------------*/
 521
 522 struct yaffs_DeviceStruct {
 523         struct list_head devList;
 524         const char *name;
 525
 526         /* Entry parameters set up way early. Yaffs sets up the rest.*/
 527         int nBytesPerChunk;     /* Should be a power of 2 >= 512 */
 528         int nChunksPerBlock;    /* does not need to be a power of 2 */
 529         int nBytesPerSpare;     /* spare area size */
 530         int startBlock;         /* Start block we're allowed to use */
 531         int endBlock;           /* End block we're allowed to use */
 532         int nReservedBlocks;    /* We want this tuneable so that we can reduce */
 533                                 /* reserved blocks on NOR and RAM. */
 534
 535         /* Stuff used by the partitioned checkpointing mechanism */
 536         int checkpointStartBlock;
 537         int checkpointEndBlock;
 538
 539         /* Stuff used by the shared space checkpointing mechanism */
 540         /* If this value is zero, then this mechanism is disabled */
 541
 542         int nCheckpointReservedBlocks; /* Blocks to reserve for checkpoint data */
 543
 544
 545
 546
 547         int nShortOpCaches;     /* If <= 0, then short op caching is disabled, else
 548                                  * the number of short op caches (don't use too many)
 549                                  */
 550
 551         int useHeaderFileSize;  /* Flag to determine if we should use file sizes from the header */
 552
 553         int useNANDECC;         /* Flag to decide whether or not to use NANDECC */
 554
 555         void *genericDevice;    /* Pointer to device context
 556                                  * On an mtd this holds the mtd pointer.
 557                                  */
 558         void *superBlock;
 559
 560         /* NAND access functions (Must be set before calling YAFFS)*/
 561
 562         int (*writeChunkToNAND) (struct yaffs_DeviceStruct * dev,
 563                                  int chunkInNAND, const __u8 * data,
 564                                  const yaffs_Spare * spare);
 565         int (*readChunkFromNAND) (struct yaffs_DeviceStruct * dev,
 566                                   int chunkInNAND, __u8 * data,
 567                                   yaffs_Spare * spare);
 568         int (*eraseBlockInNAND) (struct yaffs_DeviceStruct * dev,
 569                                  int blockInNAND);
 570         int (*initialiseNAND) (struct yaffs_DeviceStruct * dev);
 571
 572 #ifdef CONFIG_YAFFS_YAFFS2
 573         int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct * dev,
 574                                          int chunkInNAND, const __u8 * data,
 575                                          const yaffs_ExtendedTags * tags);
 576         int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct * dev,
 577                                           int chunkInNAND, __u8 * data,
 578                                           yaffs_ExtendedTags * tags);
 579         int (*markNANDBlockBad) (struct yaffs_DeviceStruct * dev, int blockNo);
 580         int (*queryNANDBlock) (struct yaffs_DeviceStruct * dev, int blockNo,
 581                                yaffs_BlockState * state, int *sequenceNumber);
 582 #endif
 583
 584         int isYaffs2;
 585
 586         /* The removeObjectCallback function must be supplied by OS flavours that
 587          * need it. The Linux kernel does not use this, but yaffs direct does use
 588          * it to implement the faster readdir
 589          */
 590         void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj);
 591
 592         /* Callback to mark the superblock dirsty */
 593         void (*markSuperBlockDirty)(void * superblock);
 594
 595         int wideTnodesDisabled; /* Set to disable wide tnodes */
 596
 597
 598         /* End of stuff that must be set before initialisation. */
 599
 600         /* Runtime parameters. Set up by YAFFS. */
 601
 602         __u16 chunkGroupBits;   /* 0 for devices <= 32MB. else log2(nchunks) - 16 */
 603         __u16 chunkGroupSize;   /* == 2^^chunkGroupBits */
 604
 605         /* Stuff to support wide tnodes */
 606         __u32 tnodeWidth;
 607         __u32 tnodeMask;
 608
 609
 610 #ifdef __KERNEL__
 611
 612         struct semaphore sem;   /* Semaphore for waiting on erasure.*/
 613         struct semaphore grossLock;     /* Gross locking semaphore */
 614         __u8 *spareBuffer;      /* For mtdif2 use. Don't know the size of the buffer
 615                                  * at compile time so we have to allocate it.
 616                                  */
 617         void (*putSuperFunc) (struct super_block * sb);
 618 #endif
 619
 620         int isMounted;
 621
 622         int isCheckpointed;
 623
 624         /* Stuff to support block offsetting to support start block zero */
 625         int internalStartBlock;
 626         int internalEndBlock;
 627         int blockOffset;
 628         int chunkOffset;
 629
 630
 631         /* Runtime checkpointing stuff */
 632         int checkpointPageSequence;   /* running sequence number of checkpoint pages */
 633         int checkpointByteCount;
 634         int checkpointByteOffset;
 635         __u8 *checkpointBuffer;
 636         int checkpointOpenForWrite;
 637         int blocksInCheckpoint;
 638         int checkpointCurrentChunk;
 639         int checkpointCurrentBlock;
 640         int checkpointNextBlock;
 641         int *checkpointBlockList;
 642         int checkpointMaxBlocks;
 643
 644         /* Block Info */
 645         yaffs_BlockInfo *blockInfo;
 646         __u8 *chunkBits;        /* bitmap of chunks in use */
 647         unsigned blockInfoAlt:1;        /* was allocated using alternative strategy */
 648         unsigned chunkBitsAlt:1;        /* was allocated using alternative strategy */
 649         int chunkBitmapStride;  /* Number of bytes of chunkBits per block.
 650                                  * Must be consistent with nChunksPerBlock.
 651                                  */
 652
 653         int nErasedBlocks;
 654         int allocationBlock;    /* Current block being allocated off */
 655         __u32 allocationPage;
 656         int allocationBlockFinder;      /* Used to search for next allocation block */
 657
 658         /* Runtime state */
 659         int nTnodesCreated;
 660         yaffs_Tnode *freeTnodes;
 661         int nFreeTnodes;
 662         yaffs_TnodeList *allocatedTnodeList;
 663
 664         int isDoingGC;
 665
 666         int nObjectsCreated;
 667         yaffs_Object *freeObjects;
 668         int nFreeObjects;
 669
 670         yaffs_ObjectList *allocatedObjectList;
 671
 672         yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
 673
 674         int nFreeChunks;
 675
 676         int currentDirtyChecker;        /* Used to find current dirtiest block */
 677
 678         __u32 *gcCleanupList;   /* objects to delete at the end of a GC. */
 679
 680         /* Statistcs */
 681         int nPageWrites;
 682         int nPageReads;
 683         int nBlockErasures;
 684         int nErasureFailures;
 685         int nGCCopies;
 686         int garbageCollections;
 687         int passiveGarbageCollections;
 688         int nRetriedWrites;
 689         int nRetiredBlocks;
 690         int eccFixed;
 691         int eccUnfixed;
 692         int tagsEccFixed;
 693         int tagsEccUnfixed;
 694         int nDeletions;
 695         int nUnmarkedDeletions;
 696
 697         /* Special directories */
 698         yaffs_Object *rootDir;
 699         yaffs_Object *lostNFoundDir;
 700
 701         /* Buffer areas for storing data to recover from write failures TODO
 702          *      __u8            bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
 703          *      yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
 704          */
 705
 706         int bufferedBlock;      /* Which block is buffered here? */
 707         int doingBufferedBlockRewrite;
 708
 709         yaffs_ChunkCache *srCache;
 710         int srLastUse;
 711
 712         int cacheHits;
 713
 714         /* Stuff for background deletion and unlinked files.*/
 715         yaffs_Object *unlinkedDir;      /* Directory where unlinked and deleted files live. */
 716         yaffs_Object *deletedDir;       /* Directory where deleted objects are sent to disappear. */
 717         yaffs_Object *unlinkedDeletion; /* Current file being background deleted.*/
 718         int nDeletedFiles;              /* Count of files awaiting deletion;*/
 719         int nUnlinkedFiles;             /* Count of unlinked files. */
 720         int nBackgroundDeletions;       /* Count of background deletions. */
 721
 722
 723         yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
 724         int maxTemp;
 725         int unmanagedTempAllocations;
 726         int unmanagedTempDeallocations;
 727
 728         /* yaffs2 runtime stuff */
 729         unsigned sequenceNumber;        /* Sequence number of currently allocating block */
 730         unsigned oldestDirtySequence;
 731
 732 };
 733
 734 typedef struct yaffs_DeviceStruct yaffs_Device;
 735
 736 /* The static layout of bllock usage etc is stored in the super block header */
 737 typedef struct {
 738         int StructType;
 739         int version;
 740         int checkpointStartBlock;
 741         int checkpointEndBlock;
 742         int startBlock;
 743         int endBlock;
 744         int rfu[100];
 745 } yaffs_SuperBlockHeader;
 746
 747 /* The CheckpointDevice structure holds the device information that changes at runtime and
 748  * must be preserved over unmount/mount cycles.
 749  */
 750 typedef struct {
 751         int structType;
 752         int nErasedBlocks;
 753         int allocationBlock;    /* Current block being allocated off */
 754         __u32 allocationPage;
 755         int nFreeChunks;
 756
 757         int nDeletedFiles;              /* Count of files awaiting deletion;*/
 758         int nUnlinkedFiles;             /* Count of unlinked files. */
 759         int nBackgroundDeletions;       /* Count of background deletions. */
 760
 761         /* yaffs2 runtime stuff */
 762         unsigned sequenceNumber;        /* Sequence number of currently allocating block */
 763         unsigned oldestDirtySequence;
 764
 765 } yaffs_CheckpointDevice;
 766
 767
 768 typedef struct {
 769     int structType;
 770     __u32 magic;
 771     __u32 version;
 772     __u32 head;
 773 } yaffs_CheckpointValidity;
 774
 775 /* Function to manipulate block info */
 776 static Y_INLINE yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device * dev, int blk)
 777 {
 778         if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
 779                 T(YAFFS_TRACE_ERROR,
 780                   (TSTR
 781                    ("**>> yaffs: getBlockInfo block %d is not valid" TENDSTR),
 782                    blk));
 783                 YBUG();
 784         }
 785         return &dev->blockInfo[blk - dev->internalStartBlock];
 786 }
 787
 788 /*----------------------- YAFFS Functions -----------------------*/
 789
 790 int yaffs_GutsInitialise(yaffs_Device * dev);
 791 void yaffs_Deinitialise(yaffs_Device * dev);
 792
 793 int yaffs_GetNumberOfFreeChunks(yaffs_Device * dev);
 794
 795 int yaffs_RenameObject(yaffs_Object * oldDir, const YCHAR * oldName,
 796                        yaffs_Object * newDir, const YCHAR * newName);
 797
 798 int yaffs_Unlink(yaffs_Object * dir, const YCHAR * name);
 799 int yaffs_DeleteFile(yaffs_Object * obj);
 800
 801 int yaffs_GetObjectName(yaffs_Object * obj, YCHAR * name, int buffSize);
 802 int yaffs_GetObjectFileLength(yaffs_Object * obj);
 803 int yaffs_GetObjectInode(yaffs_Object * obj);
 804 unsigned yaffs_GetObjectType(yaffs_Object * obj);
 805 int yaffs_GetObjectLinkCount(yaffs_Object * obj);
 806
 807 int yaffs_SetAttributes(yaffs_Object * obj, struct iattr *attr);
 808 int yaffs_GetAttributes(yaffs_Object * obj, struct iattr *attr);
 809
 810 /* File operations */
 811 int yaffs_ReadDataFromFile(yaffs_Object * obj, __u8 * buffer, __u32 offset,
 812                            int nBytes);
 813 int yaffs_WriteDataToFile(yaffs_Object * obj, const __u8 * buffer, __u32 offset,
 814                           int nBytes, int writeThrough);
 815 int yaffs_ResizeFile(yaffs_Object * obj, int newSize);
 816
 817 yaffs_Object *yaffs_MknodFile(yaffs_Object * parent, const YCHAR * name,
 818                               __u32 mode, __u32 uid, __u32 gid);
 819 int yaffs_FlushFile(yaffs_Object * obj, int updateTime);
 820
 821 /* Flushing and checkpointing */
 822 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev);
 823
 824 int yaffs_CheckpointSave(yaffs_Device *dev);
 825 int yaffs_CheckpointRestore(yaffs_Device *dev);
 826
 827 /* Directory operations */
 828 yaffs_Object *yaffs_MknodDirectory(yaffs_Object * parent, const YCHAR * name,
 829                                    __u32 mode, __u32 uid, __u32 gid);
 830 yaffs_Object *yaffs_FindObjectByName(yaffs_Object * theDir, const YCHAR * name);
 831 int yaffs_ApplyToDirectoryChildren(yaffs_Object * theDir,
 832                                    int (*fn) (yaffs_Object *));
 833
 834 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device * dev, __u32 number);
 835
 836 /* Link operations */
 837 yaffs_Object *yaffs_Link(yaffs_Object * parent, const YCHAR * name,
 838                          yaffs_Object * equivalentObject);
 839
 840 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object * obj);
 841
 842 /* Symlink operations */
 843 yaffs_Object *yaffs_MknodSymLink(yaffs_Object * parent, const YCHAR * name,
 844                                  __u32 mode, __u32 uid, __u32 gid,
 845                                  const YCHAR * alias);
 846 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object * obj);
 847
 848 /* Special inodes (fifos, sockets and devices) */
 849 yaffs_Object *yaffs_MknodSpecial(yaffs_Object * parent, const YCHAR * name,
 850                                  __u32 mode, __u32 uid, __u32 gid, __u32 rdev);
 851
 852 /* Special directories */
 853 yaffs_Object *yaffs_Root(yaffs_Device * dev);
 854 yaffs_Object *yaffs_LostNFound(yaffs_Device * dev);
 855
 856 #ifdef CONFIG_YAFFS_WINCE
 857 /* CONFIG_YAFFS_WINCE special stuff */
 858 void yfsd_WinFileTimeNow(__u32 target[2]);
 859 #endif
 860
 861 #ifdef __KERNEL__
 862
 863 void yaffs_HandleDeferedFree(yaffs_Object * obj);
 864 #endif
 865
 866 /* Debug dump  */
 867 int yaffs_DumpObject(yaffs_Object * obj);
 868
 869 void yaffs_GutsTest(yaffs_Device * dev);
 870
 871 /* A few useful functions */
 872 void yaffs_InitialiseTags(yaffs_ExtendedTags * tags);
 873 void yaffs_DeleteChunk(yaffs_Device * dev, int chunkId, int markNAND, int lyn);
 874 int yaffs_CheckFF(__u8 * buffer, int nBytes);
 875
 876 #endif