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
 365 /*------------------------  Object -----------------------------*/
 366 /* An object can be one of:
 367  * - a directory (no data, has children links
 368  * - a regular file (data.... not prunes :->).
 369  * - a symlink [symbolic link] (the alias).
 370  * - a hard link
 371  */
 372
 373 typedef struct {
 374         __u32 fileSize;
 375         __u32 scannedFileSize;
 376         __u32 shrinkSize;
 377         int topLevel;
 378         yaffs_Tnode *top;
 379 } yaffs_FileStructure;
 380
 381 typedef struct {
 382         struct ylist_head children;     /* list of child links */
 383         struct ylist_head dirty;        /* Entry for list of dirty directories */
 384 } yaffs_DirectoryStructure;
 385
 386 typedef struct {
 387         YCHAR *alias;
 388 } yaffs_SymLinkStructure;
 389
 390 typedef struct {
 391         struct yaffs_ObjectStruct *equivalentObject;
 392         __u32 equivalentObjectId;
 393 } yaffs_HardLinkStructure;
 394
 395 typedef union {
 396         yaffs_FileStructure fileVariant;
 397         yaffs_DirectoryStructure directoryVariant;
 398         yaffs_SymLinkStructure symLinkVariant;
 399         yaffs_HardLinkStructure hardLinkVariant;
 400 } yaffs_ObjectVariant;
 401
 402
 403
 404 struct yaffs_ObjectStruct {
 405         __u8 deleted:1;         /* This should only apply to unlinked files. */
 406         __u8 softDeleted:1;     /* it has also been soft deleted */
 407         __u8 unlinked:1;        /* An unlinked file. The file should be in the unlinked directory.*/
 408         __u8 fake:1;            /* A fake object has no presence on NAND. */
 409         __u8 renameAllowed:1;   /* Some objects are not allowed to be renamed. */
 410         __u8 unlinkAllowed:1;
 411         __u8 dirty:1;           /* the object needs to be written to flash */
 412         __u8 valid:1;           /* When the file system is being loaded up, this
 413                                  * object might be created before the data
 414                                  * is available (ie. file data records appear before the header).
 415                                  */
 416         __u8 lazyLoaded:1;      /* This object has been lazy loaded and is missing some detail */
 417
 418         __u8 deferedFree:1;     /* For Linux kernel. Object is removed from NAND, but is
 419                                  * still in the inode cache. Free of object is defered.
 420                                  * until the inode is released.
 421                                  */
 422         __u8 beingCreated:1;    /* This object is still being created so skip some checks. */
 423         __u8 isShadowed:1;      /* This object is shadowed on the way to being renamed. */
 424
 425         __u8 serial;            /* serial number of chunk in NAND. Cached here */
 426         __u16 sum;              /* sum of the name to speed searching */
 427
 428         struct yaffs_DeviceStruct *myDev;       /* The device I'm on */
 429
 430         struct ylist_head hashLink;     /* list of objects in this hash bucket */
 431
 432         struct ylist_head hardLinks;    /* all the equivalent hard linked objects */
 433
 434         /* directory structure stuff */
 435         /* also used for linking up the free list */
 436         struct yaffs_ObjectStruct *parent;
 437         struct ylist_head siblings;
 438
 439         /* Where's my object header in NAND? */
 440         int hdrChunk;
 441
 442         int nDataChunks;        /* Number of data chunks attached to the file. */
 443
 444         __u32 objectId;         /* the object id value */
 445
 446         __u32 yst_mode;
 447
 448 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
 449         YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
 450 #endif
 451
 452 #ifdef CONFIG_YAFFS_WINCE
 453         __u32 win_ctime[2];
 454         __u32 win_mtime[2];
 455         __u32 win_atime[2];
 456 #else
 457         __u32 yst_uid;
 458         __u32 yst_gid;
 459         __u32 yst_atime;
 460         __u32 yst_mtime;
 461         __u32 yst_ctime;
 462 #endif
 463
 464         __u32 yst_rdev;
 465
 466         void *myInode;
 467
 468         yaffs_ObjectType variantType;
 469
 470         yaffs_ObjectVariant variant;
 471
 472 };
 473
 474 typedef struct yaffs_ObjectStruct yaffs_Object;
 475
 476 typedef struct {
 477         struct ylist_head list;
 478         int count;
 479 } yaffs_ObjectBucket;
 480
 481
 482 /* yaffs_CheckpointObject holds the definition of an object as dumped
 483  * by checkpointing.
 484  */
 485
 486 typedef struct {
 487         int structType;
 488         __u32 objectId;
 489         __u32 parentId;
 490         int hdrChunk;
 491         yaffs_ObjectType variantType:3;
 492         __u8 deleted:1;
 493         __u8 softDeleted:1;
 494         __u8 unlinked:1;
 495         __u8 fake:1;
 496         __u8 renameAllowed:1;
 497         __u8 unlinkAllowed:1;
 498         __u8 serial;
 499
 500         int nDataChunks;
 501         __u32 fileSizeOrEquivalentObjectId;
 502 } yaffs_CheckpointObject;
 503
 504 /*--------------------- Temporary buffers ----------------
 505  *
 506  * These are chunk-sized working buffers. Each device has a few
 507  */
 508
 509 typedef struct {
 510         __u8 *buffer;
 511         int line;       /* track from whence this buffer was allocated */
 512         int maxLine;
 513 } yaffs_TempBuffer;
 514
 515 /*----------------- Device ---------------------------------*/
 516
 517
 518 struct yaffs_DeviceParamStruct {
 519         const char *name;
 520
 521         /*
 522          * Entry parameters set up way early. Yaffs sets up the rest.
 523          * The structure should be zeroed out before use so that unused
 524          * and defualt values are zero.
 525          */
 526
 527         int inbandTags;          /* Use unband tags */
 528         __u32 totalBytesPerChunk; /* Should be >= 512, does not need to be a power of 2 */
 529         int nChunksPerBlock;    /* does not need to be a power of 2 */
 530         int spareBytesPerChunk; /* spare area size */
 531         int startBlock;         /* Start block we're allowed to use */
 532         int endBlock;           /* End block we're allowed to use */
 533         int nReservedBlocks;    /* We want this tuneable so that we can reduce */
 534                                 /* reserved blocks on NOR and RAM. */
 535
 536
 537         int nShortOpCaches;     /* If <= 0, then short op caching is disabled, else
 538                                  * the number of short op caches (don't use too many).
 539                                  * 10 to 20 is a good bet.
 540                                  */
 541         int useNANDECC;         /* Flag to decide whether or not to use NANDECC on data (yaffs1) */
 542         int noTagsECC;          /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */
 543
 544         int isYaffs2;           /* Use yaffs2 mode on this device */
 545
 546         int emptyLostAndFound;  /* Auto-empty lost+found directory on mount */
 547
 548         int refreshPeriod;      /* How often we should check to do a block refresh */
 549
 550         /* Checkpoint control. Can be set before or after initialisation */
 551         __u8 skipCheckpointRead;
 552         __u8 skipCheckpointWrite;
 553
 554         int enableXattr;        /* Enable xattribs */
 555
 556         /* NAND access functions (Must be set before calling YAFFS)*/
 557
 558         int (*writeChunkToNAND) (struct yaffs_DeviceStruct *dev,
 559                                         int chunkInNAND, const __u8 *data,
 560                                         const yaffs_Spare *spare);
 561         int (*readChunkFromNAND) (struct yaffs_DeviceStruct *dev,
 562                                         int chunkInNAND, __u8 *data,
 563                                         yaffs_Spare *spare);
 564         int (*eraseBlockInNAND) (struct yaffs_DeviceStruct *dev,
 565                                         int blockInNAND);
 566         int (*initialiseNAND) (struct yaffs_DeviceStruct *dev);
 567         int (*deinitialiseNAND) (struct yaffs_DeviceStruct *dev);
 568
 569 #ifdef CONFIG_YAFFS_YAFFS2
 570         int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct *dev,
 571                                          int chunkInNAND, const __u8 *data,
 572                                          const yaffs_ExtendedTags *tags);
 573         int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct *dev,
 574                                           int chunkInNAND, __u8 *data,
 575                                           yaffs_ExtendedTags *tags);
 576         int (*markNANDBlockBad) (struct yaffs_DeviceStruct *dev, int blockNo);
 577         int (*queryNANDBlock) (struct yaffs_DeviceStruct *dev, int blockNo,
 578                                yaffs_BlockState *state, __u32 *sequenceNumber);
 579 #endif
 580
 581         /* The removeObjectCallback function must be supplied by OS flavours that
 582          * need it.
 583          * yaffs direct uses it to implement the faster readdir.
 584          * Linux uses it to protect the directory during unlocking.
 585          */
 586         void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj);
 587
 588         /* Callback to mark the superblock dirty */
 589         void (*markSuperBlockDirty)(struct yaffs_DeviceStruct *dev);
 590
 591         /*  Callback to control garbage collection. */
 592         unsigned (*gcControl)(struct yaffs_DeviceStruct *dev);
 593
 594         /* Debug control flags. Don't use unless you know what you're doing */
 595         int useHeaderFileSize;  /* Flag to determine if we should use file sizes from the header */
 596         int disableLazyLoad;    /* Disable lazy loading on this device */
 597         int wideTnodesDisabled; /* Set to disable wide tnodes */
 598         int disableSoftDelete;  /* yaffs 1 only: Set to disable the use of softdeletion. */
 599
 600         int deferDirectoryUpdate; /* Set to defer directory updates */
 601
 602 };
 603
 604 typedef struct yaffs_DeviceParamStruct yaffs_DeviceParam;
 605
 606 struct yaffs_DeviceStruct {
 607         struct yaffs_DeviceParamStruct param;
 608
 609         /* Context storage. Holds extra OS specific data for this device */
 610
 611         void *context;
 612
 613         /* Runtime parameters. Set up by YAFFS. */
 614         int nDataBytesPerChunk;
 615
 616         /* Non-wide tnode stuff */
 617         __u16 chunkGroupBits;   /* Number of bits that need to be resolved if
 618                                  * the tnodes are not wide enough.
 619                                  */
 620         __u16 chunkGroupSize;   /* == 2^^chunkGroupBits */
 621
 622         /* Stuff to support wide tnodes */
 623         __u32 tnodeWidth;
 624         __u32 tnodeMask;
 625         __u32 tnodeSize;
 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
 633
 634         int isMounted;
 635         int readOnly;
 636         int isCheckpointed;
 637
 638
 639         /* Stuff to support block offsetting to support start block zero */
 640         int internalStartBlock;
 641         int internalEndBlock;
 642         int blockOffset;
 643         int chunkOffset;
 644
 645
 646         /* Runtime checkpointing stuff */
 647         int checkpointPageSequence;   /* running sequence number of checkpoint pages */
 648         int checkpointByteCount;
 649         int checkpointByteOffset;
 650         __u8 *checkpointBuffer;
 651         int checkpointOpenForWrite;
 652         int blocksInCheckpoint;
 653         int checkpointCurrentChunk;
 654         int checkpointCurrentBlock;
 655         int checkpointNextBlock;
 656         int *checkpointBlockList;
 657         int checkpointMaxBlocks;
 658         __u32 checkpointSum;
 659         __u32 checkpointXor;
 660
 661         int nCheckpointBlocksRequired; /* Number of blocks needed to store current checkpoint set */
 662
 663         /* Block Info */
 664         yaffs_BlockInfo *blockInfo;
 665         __u8 *chunkBits;        /* bitmap of chunks in use */
 666         unsigned blockInfoAlt:1;        /* was allocated using alternative strategy */
 667         unsigned chunkBitsAlt:1;        /* was allocated using alternative strategy */
 668         int chunkBitmapStride;  /* Number of bytes of chunkBits per block.
 669                                  * Must be consistent with nChunksPerBlock.
 670                                  */
 671
 672         int nErasedBlocks;
 673         int allocationBlock;    /* Current block being allocated off */
 674         __u32 allocationPage;
 675         int allocationBlockFinder;      /* Used to search for next allocation block */
 676
 677         /* Object and Tnode memory management */
 678         void *allocator;
 679         int nObjects;
 680         int nTnodes;
 681
 682         int nHardLinks;
 683
 684         yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
 685         __u32 bucketFinder;
 686
 687         int nFreeChunks;
 688
 689         /* Garbage collection control */
 690         __u32 *gcCleanupList;   /* objects to delete at the end of a GC. */
 691
 692         unsigned hasPendingPrioritisedGCs; /* We think this device might have pending prioritised gcs */
 693         unsigned gcDisable;
 694         unsigned gcBlockFinder;
 695         unsigned gcDirtiest;
 696         unsigned gcPagesInUse;
 697         unsigned gcNotDone;
 698         unsigned gcBlock;
 699         unsigned gcChunk;
 700         unsigned gcSkip;
 701
 702         /* Special directories */
 703         yaffs_Object *rootDir;
 704         yaffs_Object *lostNFoundDir;
 705
 706         /* Buffer areas for storing data to recover from write failures TODO
 707          *      __u8            bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
 708          *      yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
 709          */
 710
 711         int bufferedBlock;      /* Which block is buffered here? */
 712         int doingBufferedBlockRewrite;
 713
 714         yaffs_ChunkCache *srCache;
 715         int srLastUse;
 716
 717         /* Stuff for background deletion and unlinked files.*/
 718         yaffs_Object *unlinkedDir;      /* Directory where unlinked and deleted files live. */
 719         yaffs_Object *deletedDir;       /* Directory where deleted objects are sent to disappear. */
 720         yaffs_Object *unlinkedDeletion; /* Current file being background deleted.*/
 721         int nDeletedFiles;              /* Count of files awaiting deletion;*/
 722         int nUnlinkedFiles;             /* Count of unlinked files. */
 723         int nBackgroundDeletions;       /* Count of background deletions. */
 724
 725         /* Temporary buffer management */
 726         yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
 727         int maxTemp;
 728         int tempInUse;
 729         int unmanagedTempAllocations;
 730         int unmanagedTempDeallocations;
 731
 732         /* yaffs2 runtime stuff */
 733         unsigned sequenceNumber;        /* Sequence number of currently allocating block */
 734         unsigned oldestDirtySequence;
 735         unsigned oldestDirtyBlock;
 736
 737         /* Block refreshing */
 738         int refreshSkip;        /* A skip down counter. Refresh happens when this gets to zero. */
 739
 740         /* Dirty directory handling */
 741         struct ylist_head dirtyDirectories; /* List of dirty directories */
 742
 743
 744         /* Statistcs */
 745         __u32 nPageWrites;
 746         __u32 nPageReads;
 747         __u32 nBlockErasures;
 748         __u32 nErasureFailures;
 749         __u32 nGCCopies;
 750         __u32 allGCs;
 751         __u32 passiveGCs;
 752         __u32 oldestDirtyGCs;
 753         __u32 backgroundGCs;
 754         __u32 nRetriedWrites;
 755         __u32 nRetiredBlocks;
 756         __u32 eccFixed;
 757         __u32 eccUnfixed;
 758         __u32 tagsEccFixed;
 759         __u32 tagsEccUnfixed;
 760         __u32 nDeletions;
 761         __u32 nUnmarkedDeletions;
 762         __u32 refreshCount;
 763         __u32 cacheHits;
 764
 765 };
 766
 767 typedef struct yaffs_DeviceStruct yaffs_Device;
 768
 769 /* The static layout of block usage etc is stored in the super block header */
 770 typedef struct {
 771         int StructType;
 772         int version;
 773         int checkpointStartBlock;
 774         int checkpointEndBlock;
 775         int startBlock;
 776         int endBlock;
 777         int rfu[100];
 778 } yaffs_SuperBlockHeader;
 779
 780 /* The CheckpointDevice structure holds the device information that changes at runtime and
 781  * must be preserved over unmount/mount cycles.
 782  */
 783 typedef struct {
 784         int structType;
 785         int nErasedBlocks;
 786         int allocationBlock;    /* Current block being allocated off */
 787         __u32 allocationPage;
 788         int nFreeChunks;
 789
 790         int nDeletedFiles;              /* Count of files awaiting deletion;*/
 791         int nUnlinkedFiles;             /* Count of unlinked files. */
 792         int nBackgroundDeletions;       /* Count of background deletions. */
 793
 794         /* yaffs2 runtime stuff */
 795         unsigned sequenceNumber;        /* Sequence number of currently allocating block */
 796
 797 } yaffs_CheckpointDevice;
 798
 799
 800 typedef struct {
 801         int structType;
 802         __u32 magic;
 803         __u32 version;
 804         __u32 head;
 805 } yaffs_CheckpointValidity;
 806
 807
 808 /*----------------------- YAFFS Functions -----------------------*/
 809
 810 int yaffs_GutsInitialise(yaffs_Device *dev);
 811 void yaffs_Deinitialise(yaffs_Device *dev);
 812
 813 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
 814
 815 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
 816                        yaffs_Object *newDir, const YCHAR *newName);
 817
 818 int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name);
 819 int yaffs_DeleteObject(yaffs_Object *obj);
 820
 821 int yaffs_GetObjectName(yaffs_Object *obj, YCHAR *name, int buffSize);
 822 int yaffs_GetObjectFileLength(yaffs_Object *obj);
 823 int yaffs_GetObjectInode(yaffs_Object *obj);
 824 unsigned yaffs_GetObjectType(yaffs_Object *obj);
 825 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
 826
 827 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
 828 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
 829
 830 /* File operations */
 831 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, loff_t offset,
 832                                 int nBytes);
 833 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, loff_t offset,
 834                                 int nBytes, int writeThrough);
 835 int yaffs_ResizeFile(yaffs_Object *obj, loff_t newSize);
 836
 837 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
 838                                 __u32 mode, __u32 uid, __u32 gid);
 839
 840 int yaffs_FlushFile(yaffs_Object *obj, int updateTime, int dataSync);
 841
 842 /* Flushing and checkpointing */
 843 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev);
 844
 845 int yaffs_CheckpointSave(yaffs_Device *dev);
 846 int yaffs_CheckpointRestore(yaffs_Device *dev);
 847
 848 /* Directory operations */
 849 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
 850                                 __u32 mode, __u32 uid, __u32 gid);
 851 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir, const YCHAR *name);
 852 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,
 853                                    int (*fn) (yaffs_Object *));
 854
 855 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number);
 856
 857 /* Link operations */
 858 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
 859                          yaffs_Object *equivalentObject);
 860
 861 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
 862
 863 /* Symlink operations */
 864 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
 865                                  __u32 mode, __u32 uid, __u32 gid,
 866                                  const YCHAR *alias);
 867 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj);
 868
 869 /* Special inodes (fifos, sockets and devices) */
 870 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
 871                                  __u32 mode, __u32 uid, __u32 gid, __u32 rdev);
 872
 873
 874 int yaffs_SetXAttribute(yaffs_Object *obj, const char *name, const void * value, int size, int flags);
 875 int yaffs_GetXAttribute(yaffs_Object *obj, const char *name, void *value, int size);
 876 int yaffs_ListXAttributes(yaffs_Object *obj, char *buffer, int size);
 877 int yaffs_RemoveXAttribute(yaffs_Object *obj, const char *name);
 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 void yaffs_HandleDeferedFree(yaffs_Object *obj);
 889
 890 void yaffs_UpdateDirtyDirectories(yaffs_Device *dev);
 891
 892 int yaffs_BackgroundGarbageCollect(yaffs_Device *dev, unsigned urgency);
 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
 909 #endif