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 "yportenv.h"
  20 #include "devextras.h"
  21 #include "yaffs_list.h"
  22
  23 #define YAFFS_OK        1
  24 #define YAFFS_FAIL  0
  25
  26 /* Give us a  Y=0x59,
  27  * Give us an A=0x41,
  28  * Give us an FF=0xFF
  29  * Give us an S=0x53
  30  * And what have we got...
  31  */
  32 #define YAFFS_MAGIC                     0x5941FF53
  33
  34 #define YAFFS_NTNODES_LEVEL0            16
  35 #define YAFFS_TNODES_LEVEL0_BITS        4
  36 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  37
  38 #define YAFFS_NTNODES_INTERNAL          (YAFFS_NTNODES_LEVEL0 / 2)
  39 #define YAFFS_TNODES_INTERNAL_BITS      (YAFFS_TNODES_LEVEL0_BITS - 1)
  40 #define YAFFS_TNODES_INTERNAL_MASK      0x7
  41 #define YAFFS_TNODES_MAX_LEVEL          6
  42
  43 #ifndef CONFIG_YAFFS_NO_YAFFS1
  44 #define YAFFS_BYTES_PER_SPARE           16
  45 #define YAFFS_BYTES_PER_CHUNK           512
  46 #define YAFFS_CHUNK_SIZE_SHIFT          9
  47 #define YAFFS_CHUNKS_PER_BLOCK          32
  48 #define YAFFS_BYTES_PER_BLOCK           (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
  49 #endif
  50
  51 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE     1024
  52 #define YAFFS_MIN_YAFFS2_SPARE_SIZE     32
  53
  54 #define YAFFS_MAX_CHUNK_ID              0x000FFFFF
  55
  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 #define YAFFS_MAX_OBJECT_ID             (YAFFS_OBJECT_SPACE -1)
  66
  67 #define YAFFS_CHECKPOINT_VERSION        4
  68
  69 #ifdef CONFIG_YAFFS_UNICODE
  70 #define YAFFS_MAX_NAME_LENGTH           127
  71 #define YAFFS_MAX_ALIAS_LENGTH          79
  72 #else
  73 #define YAFFS_MAX_NAME_LENGTH           255
  74 #define YAFFS_MAX_ALIAS_LENGTH          159
  75 #endif
  76
  77 #define YAFFS_SHORT_NAME_LENGTH         15
  78
  79 /* Some special object ids for pseudo objects */
  80 #define YAFFS_OBJECTID_ROOT             1
  81 #define YAFFS_OBJECTID_LOSTNFOUND       2
  82 #define YAFFS_OBJECTID_UNLINKED         3
  83 #define YAFFS_OBJECTID_DELETED          4
  84
  85 /* Pseudo object ids for checkpointing */
  86 #define YAFFS_OBJECTID_SB_HEADER        0x10
  87 #define YAFFS_OBJECTID_CHECKPOINT_DATA  0x20
  88 #define YAFFS_SEQUENCE_CHECKPOINT_DATA  0x21
  89
  90
  91 #define YAFFS_MAX_SHORT_OP_CACHES       20
  92
  93 #define YAFFS_N_TEMP_BUFFERS            6
  94
  95 /* We limit the number attempts at sucessfully saving a chunk of data.
  96  * Small-page devices have 32 pages per block; large-page devices have 64.
  97  * Default to something in the order of 5 to 10 blocks worth of chunks.
  98  */
  99 #define YAFFS_WR_ATTEMPTS               (5*64)
 100
 101 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
 102  * The range is limited slightly to help distinguish bad numbers from good.
 103  * This also allows us to perhaps in the future use special numbers for
 104  * special purposes.
 105  * EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years,
 106  * and is a larger number than the lifetime of a 2GB device.
 107  */
 108 #define YAFFS_LOWEST_SEQUENCE_NUMBER    0x00001000
 109 #define YAFFS_HIGHEST_SEQUENCE_NUMBER   0xEFFFFF00
 110
 111 /* Special sequence number for bad block that failed to be marked bad */
 112 #define YAFFS_SEQUENCE_BAD_BLOCK        0xFFFF0000
 113
 114 /* ChunkCache is used for short read/write operations.*/
 115 typedef struct {
 116         struct yaffs_ObjectStruct *object;
 117         int chunkId;
 118         int lastUse;
 119         int dirty;
 120         int nBytes;             /* Only valid if the cache is dirty */
 121         int locked;             /* Can't push out or flush while locked. */
 122         __u8 *data;
 123 } yaffs_ChunkCache;
 124
 125
 126
 127 /* Tags structures in RAM
 128  * NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
 129  * the structure size will get blown out.
 130  */
 131
 132 #ifndef CONFIG_YAFFS_NO_YAFFS1
 133 typedef struct {
 134         unsigned chunkId:20;
 135         unsigned serialNumber:2;
 136         unsigned byteCountLSB:10;
 137         unsigned objectId:18;
 138         unsigned ecc:12;
 139         unsigned byteCountMSB:2;
 140 } yaffs_Tags;
 141
 142 typedef union {
 143         yaffs_Tags asTags;
 144         __u8 asBytes[8];
 145 } yaffs_TagsUnion;
 146
 147 #endif
 148
 149 /* Stuff used for extended tags in YAFFS2 */
 150
 151 typedef enum {
 152         YAFFS_ECC_RESULT_UNKNOWN,
 153         YAFFS_ECC_RESULT_NO_ERROR,
 154         YAFFS_ECC_RESULT_FIXED,
 155         YAFFS_ECC_RESULT_UNFIXED
 156 } yaffs_ECCResult;
 157
 158 typedef enum {
 159         YAFFS_OBJECT_TYPE_UNKNOWN,
 160         YAFFS_OBJECT_TYPE_FILE,
 161         YAFFS_OBJECT_TYPE_SYMLINK,
 162         YAFFS_OBJECT_TYPE_DIRECTORY,
 163         YAFFS_OBJECT_TYPE_HARDLINK,
 164         YAFFS_OBJECT_TYPE_SPECIAL
 165 } yaffs_ObjectType;
 166
 167 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
 168
 169 typedef struct {
 170
 171         unsigned validMarker0;
 172         unsigned chunkUsed;     /*  Status of the chunk: used or unused */
 173         unsigned objectId;      /* If 0 then this is not part of an object (unused) */
 174         unsigned chunkId;       /* If 0 then this is a header, else a data chunk */
 175         unsigned byteCount;     /* Only valid for data chunks */
 176
 177         /* The following stuff only has meaning when we read */
 178         yaffs_ECCResult eccResult;
 179         unsigned blockBad;
 180
 181         /* YAFFS 1 stuff */
 182         unsigned chunkDeleted;  /* The chunk is marked deleted */
 183         unsigned serialNumber;  /* Yaffs1 2-bit serial number */
 184
 185         /* YAFFS2 stuff */
 186         unsigned sequenceNumber;        /* The sequence number of this block */
 187
 188         /* Extra info if this is an object header (YAFFS2 only) */
 189
 190         unsigned extraHeaderInfoAvailable;      /* There is extra info available if this is not zero */
 191         unsigned extraParentObjectId;   /* The parent object */
 192         unsigned extraIsShrinkHeader;   /* Is it a shrink header? */
 193         unsigned extraShadows;          /* Does this shadow another object? */
 194
 195         yaffs_ObjectType extraObjectType;       /* What object type? */
 196
 197         unsigned extraFileLength;               /* Length if it is a file */
 198         unsigned extraEquivalentObjectId;       /* Equivalent object Id if it is a hard link */
 199
 200         unsigned validMarker1;
 201
 202 } yaffs_ExtendedTags;
 203
 204 /* Spare structure for YAFFS1 */
 205 typedef struct {
 206         __u8 tagByte0;
 207         __u8 tagByte1;
 208         __u8 tagByte2;
 209         __u8 tagByte3;
 210         __u8 pageStatus;        /* set to 0 to delete the chunk */
 211         __u8 blockStatus;
 212         __u8 tagByte4;
 213         __u8 tagByte5;
 214         __u8 ecc1[3];
 215         __u8 tagByte6;
 216         __u8 tagByte7;
 217         __u8 ecc2[3];
 218 } yaffs_Spare;
 219
 220 /*Special structure for passing through to mtd */
 221 struct yaffs_NANDSpare {
 222         yaffs_Spare spare;
 223         int eccres1;
 224         int eccres2;
 225 };
 226
 227 /* Block data in RAM */
 228
 229 typedef enum {
 230         YAFFS_BLOCK_STATE_UNKNOWN = 0,
 231
 232         YAFFS_BLOCK_STATE_SCANNING,
 233         /* Being scanned */
 234
 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          * If a block is only partially allocated at mount it is treated as full.
 252          */
 253
 254         YAFFS_BLOCK_STATE_FULL,
 255         /* All the pages in this block have been allocated.
 256          * If a block was only partially allocated when mounted we treat
 257          * it as fully allocated.
 258          */
 259
 260         YAFFS_BLOCK_STATE_DIRTY,
 261         /* The block was full and now all chunks have been deleted.
 262          * Erase me, reuse me.
 263          */
 264
 265         YAFFS_BLOCK_STATE_CHECKPOINT,
 266         /* This block is assigned to holding checkpoint data. */
 267
 268         YAFFS_BLOCK_STATE_COLLECTING,
 269         /* This block is being garbage collected */
 270
 271         YAFFS_BLOCK_STATE_DEAD
 272         /* This block has failed and is not in use */
 273 } yaffs_BlockState;
 274
 275 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
 276
 277
 278 typedef struct {
 279
 280         int softDeletions:10;   /* number of soft deleted pages */
 281         int pagesInUse:10;      /* number of pages in use */
 282         unsigned blockState:4;  /* One of the above block states. NB use unsigned because enum is sometimes an int */
 283         __u32 needsRetiring:1;  /* Data has failed on this block, need to get valid data off */
 284                                 /* and retire the block. */
 285         __u32 skipErasedCheck:1; /* If this is set we can skip the erased check on this block */
 286         __u32 gcPrioritise:1;   /* An ECC check or blank check has failed on this block.
 287                                    It should be prioritised for GC */
 288         __u32 chunkErrorStrikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */
 289
 290 #ifdef CONFIG_YAFFS_YAFFS2
 291         __u32 hasShrinkHeader:1; /* This block has at least one shrink object header */
 292         __u32 sequenceNumber;    /* block sequence number for yaffs2 */
 293 #endif
 294
 295 } yaffs_BlockInfo;
 296
 297 /* -------------------------- Object structure -------------------------------*/
 298 /* This is the object structure as stored on NAND */
 299
 300 typedef struct {
 301         yaffs_ObjectType type;
 302
 303         /* Apply to everything  */
 304         int parentObjectId;
 305         __u16 sum__NoLongerUsed;        /* checksum of name. No longer used */
 306         YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
 307
 308         /* The following apply to directories, files, symlinks - not hard links */
 309         __u32 yst_mode;         /* protection */
 310
 311 #ifdef CONFIG_YAFFS_WINCE
 312         __u32 notForWinCE[5];
 313 #else
 314         __u32 yst_uid;
 315         __u32 yst_gid;
 316         __u32 yst_atime;
 317         __u32 yst_mtime;
 318         __u32 yst_ctime;
 319 #endif
 320
 321         /* File size  applies to files only */
 322         int fileSize;
 323
 324         /* Equivalent object id applies to hard links only. */
 325         int equivalentObjectId;
 326
 327         /* Alias is for symlinks only. */
 328         YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 329
 330         __u32 yst_rdev;         /* device stuff for block and char devices (major/min) */
 331
 332 #ifdef CONFIG_YAFFS_WINCE
 333         __u32 win_ctime[2];
 334         __u32 win_atime[2];
 335         __u32 win_mtime[2];
 336 #else
 337         __u32 roomToGrow[6];
 338
 339 #endif
 340         __u32 inbandShadowsObject;
 341         __u32 inbandIsShrink;
 342
 343         __u32 reservedSpace[2];
 344         int shadowsObject;      /* This object header shadows the specified object if > 0 */
 345
 346         /* isShrink applies to object headers written when we shrink the file (ie resize) */
 347         __u32 isShrink;
 348
 349 } yaffs_ObjectHeader;
 350
 351 /*--------------------------- Tnode -------------------------- */
 352
 353 union yaffs_Tnode_union {
 354 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
 355         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL + 1];
 356 #else
 357         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
 358 #endif
 359 /*      __u16 level0[YAFFS_NTNODES_LEVEL0]; */
 360
 361 };
 362
 363 typedef union yaffs_Tnode_union yaffs_Tnode;
 364
 365
 366 /*------------------------  Object -----------------------------*/
 367 /* An object can be one of:
 368  * - a directory (no data, has children links
 369  * - a regular file (data.... not prunes :->).
 370  * - a symlink [symbolic link] (the alias).
 371  * - a hard link
 372  */
 373
 374 typedef struct {
 375         __u32 fileSize;
 376         __u32 scannedFileSize;
 377         __u32 shrinkSize;
 378         int topLevel;
 379         yaffs_Tnode *top;
 380 } yaffs_FileStructure;
 381
 382 typedef struct {
 383         struct ylist_head children;     /* list of child links */
 384         struct ylist_head dirty;        /* Entry for list of dirty directories */
 385 } yaffs_DirectoryStructure;
 386
 387 typedef struct {
 388         YCHAR *alias;
 389 } yaffs_SymLinkStructure;
 390
 391 typedef struct {
 392         struct yaffs_ObjectStruct *equivalentObject;
 393         __u32 equivalentObjectId;
 394 } yaffs_HardLinkStructure;
 395
 396 typedef union {
 397         yaffs_FileStructure fileVariant;
 398         yaffs_DirectoryStructure directoryVariant;
 399         yaffs_SymLinkStructure symLinkVariant;
 400         yaffs_HardLinkStructure hardLinkVariant;
 401 } yaffs_ObjectVariant;
 402
 403
 404
 405 struct yaffs_ObjectStruct {
 406         __u8 deleted:1;         /* This should only apply to unlinked files. */
 407         __u8 softDeleted:1;     /* it has also been soft deleted */
 408         __u8 unlinked:1;        /* An unlinked file. The file should be in the unlinked directory.*/
 409         __u8 fake:1;            /* A fake object has no presence on NAND. */
 410         __u8 renameAllowed:1;   /* Some objects are not allowed to be renamed. */
 411         __u8 unlinkAllowed:1;
 412         __u8 dirty:1;           /* the object needs to be written to flash */
 413         __u8 valid:1;           /* When the file system is being loaded up, this
 414                                  * object might be created before the data
 415                                  * is available (ie. file data records appear before the header).
 416                                  */
 417         __u8 lazyLoaded:1;      /* This object has been lazy loaded and is missing some detail */
 418
 419         __u8 deferedFree:1;     /* For Linux kernel. Object is removed from NAND, but is
 420                                  * still in the inode cache. Free of object is defered.
 421                                  * until the inode is released.
 422                                  */
 423         __u8 beingCreated:1;    /* This object is still being created so skip some checks. */
 424         __u8 isShadowed:1;      /* This object is shadowed on the way to being renamed. */
 425
 426         __u8 xattrKnown:1;      /* We know if this has object has xattribs or not. */
 427         __u8 hasXattr:1;        /* This object has xattribs. Valid if xattrKnown. */
 428
 429         __u8 serial;            /* serial number of chunk in NAND. Cached here */
 430         __u16 sum;              /* sum of the name to speed searching */
 431
 432         struct yaffs_DeviceStruct *myDev;       /* The device I'm on */
 433
 434         struct ylist_head hashLink;     /* list of objects in this hash bucket */
 435
 436         struct ylist_head hardLinks;    /* all the equivalent hard linked objects */
 437
 438         /* directory structure stuff */
 439         /* also used for linking up the free list */
 440         struct yaffs_ObjectStruct *parent;
 441         struct ylist_head siblings;
 442
 443         /* Where's my object header in NAND? */
 444         int hdrChunk;
 445
 446         int nDataChunks;        /* Number of data chunks attached to the file. */
 447
 448         __u32 objectId;         /* the object id value */
 449
 450         __u32 yst_mode;
 451
 452 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
 453         YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
 454 #endif
 455
 456 #ifdef CONFIG_YAFFS_WINCE
 457         __u32 win_ctime[2];
 458         __u32 win_mtime[2];
 459         __u32 win_atime[2];
 460 #else
 461         __u32 yst_uid;
 462         __u32 yst_gid;
 463         __u32 yst_atime;
 464         __u32 yst_mtime;
 465         __u32 yst_ctime;
 466 #endif
 467
 468         __u32 yst_rdev;
 469
 470         void *myInode;
 471
 472         yaffs_ObjectType variantType;
 473
 474         yaffs_ObjectVariant variant;
 475
 476 };
 477
 478 typedef struct yaffs_ObjectStruct yaffs_Object;
 479
 480 typedef struct {
 481         struct ylist_head list;
 482         int count;
 483 } yaffs_ObjectBucket;
 484
 485
 486 /* yaffs_CheckpointObject holds the definition of an object as dumped
 487  * by checkpointing.
 488  */
 489
 490 typedef struct {
 491         int structType;
 492         __u32 objectId;
 493         __u32 parentId;
 494         int hdrChunk;
 495         yaffs_ObjectType variantType:3;
 496         __u8 deleted:1;
 497         __u8 softDeleted:1;
 498         __u8 unlinked:1;
 499         __u8 fake:1;
 500         __u8 renameAllowed:1;
 501         __u8 unlinkAllowed:1;
 502         __u8 serial;
 503
 504         int nDataChunks;
 505         __u32 fileSizeOrEquivalentObjectId;
 506 } yaffs_CheckpointObject;
 507
 508 /*--------------------- Temporary buffers ----------------
 509  *
 510  * These are chunk-sized working buffers. Each device has a few
 511  */
 512
 513 typedef struct {
 514         __u8 *buffer;
 515         int line;       /* track from whence this buffer was allocated */
 516         int maxLine;
 517 } yaffs_TempBuffer;
 518
 519 /*----------------- Device ---------------------------------*/
 520
 521
 522 struct yaffs_DeviceParamStruct {
 523         const YCHAR *name;
 524
 525         /*
 526          * Entry parameters set up way early. Yaffs sets up the rest.
 527          * The structure should be zeroed out before use so that unused
 528          * and defualt values are zero.
 529          */
 530
 531         int inbandTags;          /* Use unband tags */
 532         __u32 totalBytesPerChunk; /* Should be >= 512, does not need to be a power of 2 */
 533         int nChunksPerBlock;    /* does not need to be a power of 2 */
 534         int spareBytesPerChunk; /* spare area size */
 535         int startBlock;         /* Start block we're allowed to use */
 536         int endBlock;           /* End block we're allowed to use */
 537         int nReservedBlocks;    /* We want this tuneable so that we can reduce */
 538                                 /* reserved blocks on NOR and RAM. */
 539
 540
 541         int nShortOpCaches;     /* If <= 0, then short op caching is disabled, else
 542                                  * the number of short op caches (don't use too many).
 543                                  * 10 to 20 is a good bet.
 544                                  */
 545         int useNANDECC;         /* Flag to decide whether or not to use NANDECC on data (yaffs1) */
 546         int noTagsECC;          /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */
 547
 548         int isYaffs2;           /* Use yaffs2 mode on this device */
 549
 550         int emptyLostAndFound;  /* Auto-empty lost+found directory on mount */
 551
 552         int refreshPeriod;      /* How often we should check to do a block refresh */
 553
 554         /* Checkpoint control. Can be set before or after initialisation */
 555         __u8 skipCheckpointRead;
 556         __u8 skipCheckpointWrite;
 557
 558         int enableXattr;        /* Enable xattribs */
 559
 560         /* NAND access functions (Must be set before calling YAFFS)*/
 561
 562         int (*writeChunkToNAND) (struct yaffs_DeviceStruct *dev,
 563                                         int chunkInNAND, const __u8 *data,
 564                                         const yaffs_Spare *spare);
 565         int (*readChunkFromNAND) (struct yaffs_DeviceStruct *dev,
 566                                         int chunkInNAND, __u8 *data,
 567                                         yaffs_Spare *spare);
 568         int (*eraseBlockInNAND) (struct yaffs_DeviceStruct *dev,
 569                                         int blockInNAND);
 570         int (*initialiseNAND) (struct yaffs_DeviceStruct *dev);
 571         int (*deinitialiseNAND) (struct yaffs_DeviceStruct *dev);
 572
 573 #ifdef CONFIG_YAFFS_YAFFS2
 574         int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct *dev,
 575                                          int chunkInNAND, const __u8 *data,
 576                                          const yaffs_ExtendedTags *tags);
 577         int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct *dev,
 578                                           int chunkInNAND, __u8 *data,
 579                                           yaffs_ExtendedTags *tags);
 580         int (*markNANDBlockBad) (struct yaffs_DeviceStruct *dev, int blockNo);
 581         int (*queryNANDBlock) (struct yaffs_DeviceStruct *dev, int blockNo,
 582                                yaffs_BlockState *state, __u32 *sequenceNumber);
 583 #endif
 584
 585         /* The removeObjectCallback function must be supplied by OS flavours that
 586          * need it.
 587          * yaffs direct uses it to implement the faster readdir.
 588          * Linux uses it to protect the directory during unlocking.
 589          */
 590         void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj);
 591
 592         /* Callback to mark the superblock dirty */
 593         void (*markSuperBlockDirty)(struct yaffs_DeviceStruct *dev);
 594
 595         /*  Callback to control garbage collection. */
 596         unsigned (*gcControl)(struct yaffs_DeviceStruct *dev);
 597
 598         /* Debug control flags. Don't use unless you know what you're doing */
 599         int useHeaderFileSize;  /* Flag to determine if we should use file sizes from the header */
 600         int disableLazyLoad;    /* Disable lazy loading on this device */
 601         int wideTnodesDisabled; /* Set to disable wide tnodes */
 602         int disableSoftDelete;  /* yaffs 1 only: Set to disable the use of softdeletion. */
 603
 604         int deferDirectoryUpdate; /* Set to defer directory updates */
 605
 606 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 607         int autoUnicode;
 608 #endif
 609
 610 };
 611
 612 typedef struct yaffs_DeviceParamStruct yaffs_DeviceParam;
 613
 614 struct yaffs_DeviceStruct {
 615         struct yaffs_DeviceParamStruct param;
 616
 617         /* Context storage. Holds extra OS specific data for this device */
 618
 619         void *osContext;
 620         void *driverContext;
 621
 622         struct ylist_head devList;
 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         __u32 tnodeSize;
 637
 638         /* Stuff for figuring out file offset to chunk conversions */
 639         __u32 chunkShift; /* Shift value */
 640         __u32 chunkDiv;   /* Divisor after shifting: 1 for power-of-2 sizes */
 641         __u32 chunkMask;  /* Mask to use for power-of-2 case */
 642
 643
 644
 645         int isMounted;
 646         int readOnly;
 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         /* Object and Tnode memory management */
 689         void *allocator;
 690         int nObjects;
 691         int nTnodes;
 692
 693         int nHardLinks;
 694
 695         yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
 696         __u32 bucketFinder;
 697
 698         int nFreeChunks;
 699
 700         /* Garbage collection control */
 701         __u32 *gcCleanupList;   /* objects to delete at the end of a GC. */
 702         __u32 nCleanups;
 703
 704         unsigned hasPendingPrioritisedGCs; /* We think this device might have pending prioritised gcs */
 705         unsigned gcDisable;
 706         unsigned gcBlockFinder;
 707         unsigned gcDirtiest;
 708         unsigned gcPagesInUse;
 709         unsigned gcNotDone;
 710         unsigned gcBlock;
 711         unsigned gcChunk;
 712         unsigned gcSkip;
 713
 714         /* Special directories */
 715         yaffs_Object *rootDir;
 716         yaffs_Object *lostNFoundDir;
 717
 718         /* Buffer areas for storing data to recover from write failures TODO
 719          *      __u8            bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
 720          *      yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
 721          */
 722
 723         int bufferedBlock;      /* Which block is buffered here? */
 724         int doingBufferedBlockRewrite;
 725
 726         yaffs_ChunkCache *srCache;
 727         int srLastUse;
 728
 729         /* Stuff for background deletion and unlinked files.*/
 730         yaffs_Object *unlinkedDir;      /* Directory where unlinked and deleted files live. */
 731         yaffs_Object *deletedDir;       /* Directory where deleted objects are sent to disappear. */
 732         yaffs_Object *unlinkedDeletion; /* Current file being background deleted.*/
 733         int nDeletedFiles;              /* Count of files awaiting deletion;*/
 734         int nUnlinkedFiles;             /* Count of unlinked files. */
 735         int nBackgroundDeletions;       /* Count of background deletions. */
 736
 737         /* Temporary buffer management */
 738         yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
 739         int maxTemp;
 740         int tempInUse;
 741         int unmanagedTempAllocations;
 742         int unmanagedTempDeallocations;
 743
 744         /* yaffs2 runtime stuff */
 745         unsigned sequenceNumber;        /* Sequence number of currently allocating block */
 746         unsigned oldestDirtySequence;
 747         unsigned oldestDirtyBlock;
 748
 749         /* Block refreshing */
 750         int refreshSkip;        /* A skip down counter. Refresh happens when this gets to zero. */
 751
 752         /* Dirty directory handling */
 753         struct ylist_head dirtyDirectories; /* List of dirty directories */
 754
 755
 756         /* Statistcs */
 757         __u32 nPageWrites;
 758         __u32 nPageReads;
 759         __u32 nBlockErasures;
 760         __u32 nErasureFailures;
 761         __u32 nGCCopies;
 762         __u32 allGCs;
 763         __u32 passiveGCs;
 764         __u32 oldestDirtyGCs;
 765         __u32 nGCBlocks;
 766         __u32 backgroundGCs;
 767         __u32 nRetriedWrites;
 768         __u32 nRetiredBlocks;
 769         __u32 eccFixed;
 770         __u32 eccUnfixed;
 771         __u32 tagsEccFixed;
 772         __u32 tagsEccUnfixed;
 773         __u32 nDeletions;
 774         __u32 nUnmarkedDeletions;
 775         __u32 refreshCount;
 776         __u32 cacheHits;
 777
 778 };
 779
 780 typedef struct yaffs_DeviceStruct yaffs_Device;
 781
 782 /* The static layout of block usage etc is stored in the super block header */
 783 typedef struct {
 784         int StructType;
 785         int version;
 786         int checkpointStartBlock;
 787         int checkpointEndBlock;
 788         int startBlock;
 789         int endBlock;
 790         int rfu[100];
 791 } yaffs_SuperBlockHeader;
 792
 793 /* The CheckpointDevice structure holds the device information that changes at runtime and
 794  * must be preserved over unmount/mount cycles.
 795  */
 796 typedef struct {
 797         int structType;
 798         int nErasedBlocks;
 799         int allocationBlock;    /* Current block being allocated off */
 800         __u32 allocationPage;
 801         int nFreeChunks;
 802
 803         int nDeletedFiles;              /* Count of files awaiting deletion;*/
 804         int nUnlinkedFiles;             /* Count of unlinked files. */
 805         int nBackgroundDeletions;       /* Count of background deletions. */
 806
 807         /* yaffs2 runtime stuff */
 808         unsigned sequenceNumber;        /* Sequence number of currently allocating block */
 809
 810 } yaffs_CheckpointDevice;
 811
 812
 813 typedef struct {
 814         int structType;
 815         __u32 magic;
 816         __u32 version;
 817         __u32 head;
 818 } yaffs_CheckpointValidity;
 819
 820
 821 struct yaffs_ShadowFixerStruct {
 822         int objectId;
 823         int shadowedId;
 824         struct yaffs_ShadowFixerStruct *next;
 825 };
 826
 827 /* Structure for doing xattr modifications */
 828 typedef struct {
 829         int set; /* If 0 then this is a deletion */
 830         const YCHAR *name;
 831         const void *data;
 832         int size;
 833         int flags;
 834         int result;
 835 }yaffs_XAttrMod;
 836
 837
 838 /*----------------------- YAFFS Functions -----------------------*/
 839
 840 int yaffs_GutsInitialise(yaffs_Device *dev);
 841 void yaffs_Deinitialise(yaffs_Device *dev);
 842
 843 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
 844
 845 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
 846                        yaffs_Object *newDir, const YCHAR *newName);
 847
 848 int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name);
 849 int yaffs_DeleteObject(yaffs_Object *obj);
 850
 851 int yaffs_GetObjectName(yaffs_Object *obj, YCHAR *name, int buffSize);
 852 int yaffs_GetObjectFileLength(yaffs_Object *obj);
 853 int yaffs_GetObjectInode(yaffs_Object *obj);
 854 unsigned yaffs_GetObjectType(yaffs_Object *obj);
 855 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
 856
 857 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
 858 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
 859
 860 /* File operations */
 861 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, loff_t offset,
 862                                 int nBytes);
 863 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, loff_t offset,
 864                                 int nBytes, int writeThrough);
 865 int yaffs_ResizeFile(yaffs_Object *obj, loff_t newSize);
 866
 867 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
 868                                 __u32 mode, __u32 uid, __u32 gid);
 869
 870 int yaffs_FlushFile(yaffs_Object *obj, int updateTime, int dataSync);
 871
 872 /* Flushing and checkpointing */
 873 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev);
 874
 875 int yaffs_CheckpointSave(yaffs_Device *dev);
 876 int yaffs_CheckpointRestore(yaffs_Device *dev);
 877
 878 /* Directory operations */
 879 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
 880                                 __u32 mode, __u32 uid, __u32 gid);
 881 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir, const YCHAR *name);
 882 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,
 883                                    int (*fn) (yaffs_Object *));
 884
 885 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number);
 886
 887 /* Link operations */
 888 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
 889                          yaffs_Object *equivalentObject);
 890
 891 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
 892
 893 /* Symlink operations */
 894 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
 895                                  __u32 mode, __u32 uid, __u32 gid,
 896                                  const YCHAR *alias);
 897 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj);
 898
 899 /* Special inodes (fifos, sockets and devices) */
 900 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
 901                                  __u32 mode, __u32 uid, __u32 gid, __u32 rdev);
 902
 903
 904 int yaffs_SetXAttribute(yaffs_Object *obj, const YCHAR *name, const void * value, int size, int flags);
 905 int yaffs_GetXAttribute(yaffs_Object *obj, const YCHAR *name, void *value, int size);
 906 int yaffs_ListXAttributes(yaffs_Object *obj, char *buffer, int size);
 907 int yaffs_RemoveXAttribute(yaffs_Object *obj, const YCHAR *name);
 908
 909 /* Special directories */
 910 yaffs_Object *yaffs_Root(yaffs_Device *dev);
 911 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
 912
 913 #ifdef CONFIG_YAFFS_WINCE
 914 /* CONFIG_YAFFS_WINCE special stuff */
 915 void yfsd_WinFileTimeNow(__u32 target[2]);
 916 #endif
 917
 918 void yaffs_HandleDeferedFree(yaffs_Object *obj);
 919
 920 void yaffs_UpdateDirtyDirectories(yaffs_Device *dev);
 921
 922 int yaffs_BackgroundGarbageCollect(yaffs_Device *dev, unsigned urgency);
 923
 924 /* Debug dump  */
 925 int yaffs_DumpObject(yaffs_Object *obj);
 926
 927 void yaffs_GutsTest(yaffs_Device *dev);
 928
 929 /* A few useful functions to be used within the core files*/
 930 void yaffs_InitialiseTags(yaffs_ExtendedTags *tags);
 931 void yaffs_DeleteChunk(yaffs_Device *dev, int chunkId, int markNAND, int lyn);
 932 int yaffs_CheckFF(__u8 *buffer, int nBytes);
 933 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi);
 934
 935 __u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo);
 936 void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo);
 937
 938 yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev,
 939                                                 int number,
 940                                                 yaffs_ObjectType type);
 941 int yaffs_PutChunkIntoFile(yaffs_Object *in, int chunkInInode,
 942                                 int chunkInNAND, int inScan);
 943 void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name);
 944 void yaffs_SetObjectNameFromOH(yaffs_Object *obj, const yaffs_ObjectHeader *oh);
 945 void yaffs_AddObjectToDirectory(yaffs_Object *directory,
 946                                         yaffs_Object *obj);
 947 YCHAR *yaffs_CloneString(const YCHAR *str);
 948 void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList);
 949 void yaffs_BlockBecameDirty(yaffs_Device *dev, int blockNo);
 950 int yaffs_UpdateObjectHeader(yaffs_Object *in, const YCHAR *name,
 951                                 int force, int isShrink, int shadows,
 952                                 yaffs_XAttrMod *xop);
 953 void yaffs_HandleShadowedObject(yaffs_Device *dev, int objId,
 954                                 int backwardScanning);
 955 int yaffs_CheckSpaceForAllocation(yaffs_Device *dev, int nChunks);
 956 yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev);
 957 yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev,
 958                                         yaffs_FileStructure *fStruct,
 959                                         __u32 chunkId,
 960                                         yaffs_Tnode *passedTn);
 961 void yaffs_VerifyObjects(yaffs_Device *dev);
 962 void yaffs_VerifyBlocks(yaffs_Device *dev);
 963 void yaffs_VerifyFreeChunks(yaffs_Device *dev);
 964 int yaffs_DoWriteDataToFile(yaffs_Object *in, const __u8 *buffer, loff_t offset,
 965                         int nBytes, int writeThrough);
 966 void yaffs_ResizeDown( yaffs_Object *obj, loff_t newSize);
 967 void yaffs_SkipRestOfBlock(yaffs_Device *dev);
 968
 969 int yaffs_CountFreeChunks(yaffs_Device *dev);
 970
 971 yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
 972                                 yaffs_FileStructure *fStruct,
 973                                 __u32 chunkId);
 974
 975 __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos);
 976
 977 #endif