yaffs_guts.h

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