yaffs_guts.h

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