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