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
  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
  56 #define YAFFS_ALLOCATION_NOBJECTS       100
  57 #define YAFFS_ALLOCATION_NTNODES        100
  58 #define YAFFS_ALLOCATION_NLINKS         100
  59
  60 #define YAFFS_NOBJECT_BUCKETS           256
  61
  62
  63 #define YAFFS_OBJECT_SPACE              0x40000
  64 #define YAFFS_MAX_OBJECT_ID             (YAFFS_OBJECT_SPACE -1)
  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 struct yaffs_cache {
 115         struct yaffs_obj *object;
 116         int chunk_id;
 117         int last_use;
 118         int dirty;
 119         int n_bytes;            /* Only valid if the cache is dirty */
 120         int locked;             /* Can't push out or flush while locked. */
 121         u8 *data;
 122 } ;
 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 struct yaffs_tags {
 133         unsigned chunk_id:20;
 134         unsigned serial_number:2;
 135         unsigned n_bytes_lsb:10;
 136         unsigned obj_id:18;
 137         unsigned ecc:12;
 138         unsigned n_bytes_msb:2;
 139 };
 140
 141 union yaffs_tags_union{
 142         struct yaffs_tags as_tags;
 143         u8 as_bytes[8];
 144 } ;
 145
 146 #endif
 147
 148 /* Stuff used for extended tags in YAFFS2 */
 149
 150 enum yaffs_ecc_result {
 151         YAFFS_ECC_RESULT_UNKNOWN,
 152         YAFFS_ECC_RESULT_NO_ERROR,
 153         YAFFS_ECC_RESULT_FIXED,
 154         YAFFS_ECC_RESULT_UNFIXED
 155 } ;
 156
 157 enum yaffs_obj_type {
 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 } ;
 165
 166 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
 167
 168 struct yaffs_ext_tags{
 169
 170         unsigned validity0;
 171         unsigned chunk_used;    /*  Status of the chunk: used or unused */
 172         unsigned obj_id;        /* If 0 then this is not part of an object (unused) */
 173         unsigned chunk_id;      /* If 0 then this is a header, else a data chunk */
 174         unsigned n_bytes;       /* Only valid for data chunks */
 175
 176         /* The following stuff only has meaning when we read */
 177         enum yaffs_ecc_result ecc_result;
 178         unsigned block_bad;
 179
 180         /* YAFFS 1 stuff */
 181         unsigned is_deleted;    /* The chunk is marked deleted */
 182         unsigned serial_number; /* Yaffs1 2-bit serial number */
 183
 184         /* YAFFS2 stuff */
 185         unsigned seq_number;    /* The sequence number of this block */
 186
 187         /* Extra info if this is an object header (YAFFS2 only) */
 188
 189         unsigned extra_available;       /* There is extra info available if this is not zero */
 190         unsigned extra_parent_id;       /* The parent object */
 191         unsigned extra_is_shrink;       /* Is it a shrink header? */
 192         unsigned extra_shadows;         /* Does this shadow another object? */
 193
 194         enum yaffs_obj_type extra_obj_type;     /* What object type? */
 195
 196         unsigned extra_length;          /* Length if it is a file */
 197         unsigned extra_equiv_id;        /* Equivalent object Id if it is a hard link */
 198
 199         unsigned validity1;
 200
 201 };
 202
 203 /* Spare structure for YAFFS1 */
 204 struct yaffs_spare{
 205         u8 tb0;
 206         u8 tb1;
 207         u8 tb2;
 208         u8 tb3;
 209         u8 page_status; /* set to 0 to delete the chunk */
 210         u8 block_status;
 211         u8 tb4;
 212         u8 tb5;
 213         u8 ecc1[3];
 214         u8 tb6;
 215         u8 tb7;
 216         u8 ecc2[3];
 217 } ;
 218
 219 /*Special structure for passing through to mtd */
 220 struct yaffs_nand_spare {
 221         struct yaffs_spare spare;
 222         int eccres1;
 223         int eccres2;
 224 };
 225
 226 /* Block data in RAM */
 227
 228 enum yaffs_block_state{
 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 scanning.
 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 };
 273
 274 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
 275
 276
 277 struct yaffs_block_info{
 278
 279         int soft_del_pages:10;  /* number of soft deleted pages */
 280         int pages_in_use:10;    /* number of pages in use */
 281         unsigned block_state:4; /* One of the above block states. NB use unsigned because enum is sometimes an int */
 282         u32 needs_retiring:1;   /* Data has failed on this block, need to get valid data off */
 283                                 /* and retire the block. */
 284         u32 skip_erased_check:1; /* If this is set we can skip the erased check on this block */
 285         u32 gc_prioritise:1;    /* An ECC check or blank check has failed on this block.
 286                                    It should be prioritised for GC */
 287         u32 chunk_error_strikes: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 has_shrink_hdr:1; /* This block has at least one shrink object header */
 291         u32 seq_number;  /* block sequence number for yaffs2 */
 292 #endif
 293
 294 } ;
 295
 296 /* -------------------------- Object structure -------------------------------*/
 297 /* This is the object structure as stored on NAND */
 298
 299 struct yaffs_obj_hdr {
 300         enum yaffs_obj_type type;
 301
 302         /* Apply to everything  */
 303         int parent_obj_id;
 304         u16 sum_no_longer_used;        /* 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 not_for_wince[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 file_size;
 322
 323         /* Equivalent object id applies to hard links only. */
 324         int equiv_id;
 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 room_to_grow[6];
 337
 338 #endif
 339         u32 inband_shadowed_obj_id;
 340         u32 inband_is_shrink;
 341
 342         u32 reserved[2];
 343         int shadows_obj;        /* This object header shadows the specified object if > 0 */
 344
 345         /* is_shrink applies to object headers written when we shrink the file (ie resize) */
 346         u32 is_shrink;
 347
 348 };
 349
 350 /*--------------------------- Tnode -------------------------- */
 351
 352 struct yaffs_tnode {
 353         struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
 354 };
 355
 356
 357
 358 /*------------------------  Object -----------------------------*/
 359 /* An object can be one of:
 360  * - a directory (no data, has children links
 361  * - a regular file (data.... not prunes :->).
 362  * - a symlink [symbolic link] (the alias).
 363  * - a hard link
 364  */
 365
 366 struct yaffs_file_var {
 367         u32 file_size;
 368         u32 scanned_size;
 369         u32 shrink_size;
 370         int top_level;
 371         struct yaffs_tnode *top;
 372 } ;
 373
 374 struct yaffs_dir_var{
 375         struct list_head children;     /* list of child links */
 376         struct list_head dirty; /* Entry for list of dirty directories */
 377 };
 378
 379 struct yaffs_symlink_var{
 380         YCHAR *alias;
 381 };
 382
 383 struct yaffs_hardlink_var{
 384         struct yaffs_obj *equiv_obj;
 385         u32 equiv_id;
 386 };
 387
 388 union yaffs_obj_var{
 389         struct yaffs_file_var file_variant;
 390         struct yaffs_dir_var dir_variant;
 391         struct yaffs_symlink_var symlink_variant;
 392         struct yaffs_hardlink_var hardlink_variant;
 393 };
 394
 395
 396
 397 struct yaffs_obj {
 398         u8 deleted:1;           /* This should only apply to unlinked files. */
 399         u8 soft_del:1;  /* it has also been soft deleted */
 400         u8 unlinked:1;  /* An unlinked file. The file should be in the unlinked directory.*/
 401         u8 fake:1;              /* A fake object has no presence on NAND. */
 402         u8 rename_allowed:1;    /* Some objects are not allowed to be renamed. */
 403         u8 unlink_allowed:1;
 404         u8 dirty:1;             /* the object needs to be written to flash */
 405         u8 valid:1;             /* When the file system is being loaded up, this
 406                                  * object might be created before the data
 407                                  * is available (ie. file data records appear before the header).
 408                                  */
 409         u8 lazy_loaded:1;       /* This object has been lazy loaded and is missing some detail */
 410
 411         u8 defered_free:1;      /* For Linux kernel. Object is removed from NAND, but is
 412                                  * still in the inode cache. Free of object is defered.
 413                                  * until the inode is released.
 414                                  */
 415         u8 being_created:1;     /* This object is still being created so skip some checks. */
 416         u8 is_shadowed:1;       /* This object is shadowed on the way to being renamed. */
 417
 418         u8 xattr_known:1;       /* We know if this has object has xattribs or not. */
 419         u8 has_xattr:1; /* This object has xattribs. Valid if xattr_known. */
 420
 421         u8 serial;              /* serial number of chunk in NAND. Cached here */
 422         u16 sum;                /* sum of the name to speed searching */
 423
 424         struct yaffs_dev *my_dev;       /* The device I'm on */
 425
 426         struct list_head hash_link;     /* list of objects in this hash bucket */
 427
 428         struct list_head hard_links;    /* all the equivalent hard linked objects */
 429
 430         /* directory structure stuff */
 431         /* also used for linking up the free list */
 432         struct yaffs_obj *parent;
 433         struct list_head siblings;
 434
 435         /* Where's my object header in NAND? */
 436         int hdr_chunk;
 437
 438         int n_data_chunks;      /* Number of data chunks attached to the file. */
 439
 440         u32 obj_id;             /* the object id value */
 441
 442         u32 yst_mode;
 443
 444 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
 445         YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
 446 #endif
 447
 448 #ifdef CONFIG_YAFFS_WINCE
 449         u32 win_ctime[2];
 450         u32 win_mtime[2];
 451         u32 win_atime[2];
 452 #else
 453         u32 yst_uid;
 454         u32 yst_gid;
 455         u32 yst_atime;
 456         u32 yst_mtime;
 457         u32 yst_ctime;
 458 #endif
 459
 460         u32 yst_rdev;
 461
 462         void *my_inode;
 463
 464         enum yaffs_obj_type variant_type;
 465
 466         union yaffs_obj_var variant;
 467
 468 };
 469
 470 struct yaffs_obj_bucket {
 471         struct list_head list;
 472         int count;
 473 } ;
 474
 475
 476 /* yaffs_checkpt_obj holds the definition of an object as dumped
 477  * by checkpointing.
 478  */
 479
 480 struct yaffs_checkpt_obj{
 481         int struct_type;
 482         u32 obj_id;
 483         u32 parent_id;
 484         int hdr_chunk;
 485         enum yaffs_obj_type variant_type:3;
 486         u8 deleted:1;
 487         u8 soft_del:1;
 488         u8 unlinked:1;
 489         u8 fake:1;
 490         u8 rename_allowed:1;
 491         u8 unlink_allowed:1;
 492         u8 serial;
 493         int n_data_chunks;
 494         u32 size_or_equiv_obj;
 495 };
 496
 497 /*--------------------- Temporary buffers ----------------
 498  *
 499  * These are chunk-sized working buffers. Each device has a few
 500  */
 501
 502 struct yaffs_buffer {
 503         u8 *buffer;
 504         int line;       /* track from whence this buffer was allocated */
 505         int max_line;
 506 } ;
 507
 508 /*----------------- Device ---------------------------------*/
 509
 510
 511 struct yaffs_param {
 512         const YCHAR *name;
 513
 514         /*
 515          * Entry parameters set up way early. Yaffs sets up the rest.
 516          * The structure should be zeroed out before use so that unused
 517          * and defualt values are zero.
 518          */
 519
 520         int inband_tags;          /* Use unband tags */
 521         u32 total_bytes_per_chunk; /* Should be >= 512, does not need to be a power of 2 */
 522         int chunks_per_block;   /* does not need to be a power of 2 */
 523         int spare_bytes_per_chunk;      /* spare area size */
 524         int start_block;                /* Start block we're allowed to use */
 525         int end_block;          /* End block we're allowed to use */
 526         int n_reserved_blocks;  /* We want this tuneable so that we can reduce */
 527                                 /* reserved blocks on NOR and RAM. */
 528
 529
 530         int n_caches;   /* If <= 0, then short op caching is disabled, else
 531                                  * the number of short op caches (don't use too many).
 532                                  * 10 to 20 is a good bet.
 533                                  */
 534         int use_nand_ecc;               /* Flag to decide whether or not to use NANDECC on data (yaffs1) */
 535         int no_tags_ecc;                /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */
 536
 537         int is_yaffs2;           /* Use yaffs2 mode on this device */
 538
 539         int empty_lost_n_found;  /* Auto-empty lost+found directory on mount */
 540
 541         int refresh_period;     /* How often we should check to do a block refresh */
 542
 543         /* Checkpoint control. Can be set before or after initialisation */
 544         u8 skip_checkpt_rd;
 545         u8 skip_checkpt_wr;
 546
 547         int enable_xattr;       /* Enable xattribs */
 548
 549         /* NAND access functions (Must be set before calling YAFFS)*/
 550
 551         int (*write_chunk_fn) (struct yaffs_dev *dev,
 552                                         int nand_chunk, const u8 *data,
 553                                         const struct yaffs_spare *spare);
 554         int (*read_chunk_fn) (struct yaffs_dev *dev,
 555                                         int nand_chunk, u8 *data,
 556                                         struct yaffs_spare *spare);
 557         int (*erase_fn) (struct yaffs_dev *dev,
 558                                         int flash_block);
 559         int (*initialise_flash_fn) (struct yaffs_dev *dev);
 560         int (*deinitialise_flash_fn) (struct yaffs_dev *dev);
 561
 562 #ifdef CONFIG_YAFFS_YAFFS2
 563         int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
 564                                          int nand_chunk, const u8 *data,
 565                                          const struct yaffs_ext_tags *tags);
 566         int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
 567                                           int nand_chunk, u8 *data,
 568                                           struct yaffs_ext_tags *tags);
 569         int (*bad_block_fn) (struct yaffs_dev *dev, int block_no);
 570         int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
 571                                enum yaffs_block_state *state, u32 *seq_number);
 572 #endif
 573
 574         /* The remove_obj_fn function must be supplied by OS flavours that
 575          * need it.
 576          * yaffs direct uses it to implement the faster readdir.
 577          * Linux uses it to protect the directory during unlocking.
 578          */
 579         void (*remove_obj_fn)(struct yaffs_obj *obj);
 580
 581         /* Callback to mark the superblock dirty */
 582         void (*sb_dirty_fn)(struct yaffs_dev *dev);
 583
 584         /*  Callback to control garbage collection. */
 585         unsigned (*gc_control)(struct yaffs_dev *dev);
 586
 587         /* Debug control flags. Don't use unless you know what you're doing */
 588         int use_header_file_size;       /* Flag to determine if we should use file sizes from the header */
 589         int disable_lazy_load;  /* Disable lazy loading on this device */
 590         int wide_tnodes_disabled; /* Set to disable wide tnodes */
 591         int disable_soft_del;  /* yaffs 1 only: Set to disable the use of softdeletion. */
 592
 593         int defered_dir_update; /* Set to defer directory updates */
 594
 595 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 596         int auto_unicode;
 597 #endif
 598         int always_check_erased; /* Force chunk erased check always on */
 599 };
 600
 601
 602 struct yaffs_dev {
 603         struct yaffs_param param;
 604
 605         /* Context storage. Holds extra OS specific data for this device */
 606
 607         void *os_context;
 608         void *driver_context;
 609
 610         struct list_head dev_list;
 611
 612         /* Runtime parameters. Set up by YAFFS. */
 613         int data_bytes_per_chunk;
 614
 615         /* Non-wide tnode stuff */
 616         u16 chunk_grp_bits;     /* Number of bits that need to be resolved if
 617                                  * the tnodes are not wide enough.
 618                                  */
 619         u16 chunk_grp_size;     /* == 2^^chunk_grp_bits */
 620
 621         /* Stuff to support wide tnodes */
 622         u32 tnode_width;
 623         u32 tnode_mask;
 624         u32 tnode_size;
 625
 626         /* Stuff for figuring out file offset to chunk conversions */
 627         u32 chunk_shift; /* Shift value */
 628         u32 chunk_div;   /* Divisor after shifting: 1 for power-of-2 sizes */
 629         u32 chunk_mask;  /* Mask to use for power-of-2 case */
 630
 631
 632
 633         int is_mounted;
 634         int read_only;
 635         int is_checkpointed;
 636
 637
 638         /* Stuff to support block offsetting to support start block zero */
 639         int internal_start_block;
 640         int internal_end_block;
 641         int block_offset;
 642         int chunk_offset;
 643
 644
 645         /* Runtime checkpointing stuff */
 646         int checkpt_page_seq;   /* running sequence number of checkpoint pages */
 647         int checkpt_byte_count;
 648         int checkpt_byte_offs;
 649         u8 *checkpt_buffer;
 650         int checkpt_open_write;
 651         int blocks_in_checkpt;
 652         int checkpt_cur_chunk;
 653         int checkpt_cur_block;
 654         int checkpt_next_block;
 655         int *checkpt_block_list;
 656         int checkpt_max_blocks;
 657         u32 checkpt_sum;
 658         u32 checkpt_xor;
 659
 660         int checkpoint_blocks_required; /* Number of blocks needed to store current checkpoint set */
 661
 662         /* Block Info */
 663         struct yaffs_block_info *block_info;
 664         u8 *chunk_bits; /* bitmap of chunks in use */
 665         unsigned block_info_alt:1;      /* was allocated using alternative strategy */
 666         unsigned chunk_bits_alt:1;      /* was allocated using alternative strategy */
 667         int chunk_bit_stride;   /* Number of bytes of chunk_bits per block.
 668                                  * Must be consistent with chunks_per_block.
 669                                  */
 670
 671         int n_erased_blocks;
 672         int alloc_block;        /* Current block being allocated off */
 673         u32 alloc_page;
 674         int alloc_block_finder; /* Used to search for next allocation block */
 675
 676         /* Object and Tnode memory management */
 677         void *allocator;
 678         int n_obj;
 679         int n_tnodes;
 680
 681         int n_hardlinks;
 682
 683         struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
 684         u32 bucket_finder;
 685
 686         int n_free_chunks;
 687
 688         /* Garbage collection control */
 689         u32 *gc_cleanup_list;   /* objects to delete at the end of a GC. */
 690         u32 n_clean_ups;
 691
 692         unsigned has_pending_prioritised_gc; /* We think this device might have pending prioritised gcs */
 693         unsigned gc_disable;
 694         unsigned gc_block_finder;
 695         unsigned gc_dirtiest;
 696         unsigned gc_pages_in_use;
 697         unsigned gc_not_done;
 698         unsigned gc_block;
 699         unsigned gc_chunk;
 700         unsigned gc_skip;
 701
 702         /* Special directories */
 703         struct yaffs_obj *root_dir;
 704         struct yaffs_obj *lost_n_found;
 705
 706         /* Buffer areas for storing data to recover from write failures TODO
 707          *      u8            buffered_data[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
 708          *      struct yaffs_spare buffered_spare[YAFFS_CHUNKS_PER_BLOCK];
 709          */
 710
 711         int buffered_block;     /* Which block is buffered here? */
 712         int doing_buffered_block_rewrite;
 713
 714         struct yaffs_cache *cache;
 715         int cache_last_use;
 716
 717         /* Stuff for background deletion and unlinked files.*/
 718         struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted files live. */
 719         struct yaffs_obj *del_dir;      /* Directory where deleted objects are sent to disappear. */
 720         struct yaffs_obj *unlinked_deletion;    /* Current file being background deleted.*/
 721         int n_deleted_files;            /* Count of files awaiting deletion;*/
 722         int n_unlinked_files;           /* Count of unlinked files. */
 723         int n_bg_deletions;     /* Count of background deletions. */
 724
 725         /* Temporary buffer management */
 726         struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
 727         int max_temp;
 728         int temp_in_use;
 729         int unmanaged_buffer_allocs;
 730         int unmanaged_buffer_deallocs;
 731
 732         /* yaffs2 runtime stuff */
 733         unsigned seq_number;    /* Sequence number of currently allocating block */
 734         unsigned oldest_dirty_seq;
 735         unsigned oldest_dirty_block;
 736
 737         /* Block refreshing */
 738         int refresh_skip;       /* A skip down counter. Refresh happens when this gets to zero. */
 739
 740         /* Dirty directory handling */
 741         struct list_head dirty_dirs; /* List of dirty directories */
 742
 743
 744         /* Statistcs */
 745         u32 n_page_writes;
 746         u32 n_page_reads;
 747         u32 n_erasures;
 748         u32 n_erase_failures;
 749         u32 n_gc_copies;
 750         u32 all_gcs;
 751         u32 passive_gc_count;
 752         u32 oldest_dirty_gc_count;
 753         u32 n_gc_blocks;
 754         u32 bg_gcs;
 755         u32 n_retired_writes;
 756         u32 n_retired_blocks;
 757         u32 n_ecc_fixed;
 758         u32 n_ecc_unfixed;
 759         u32 n_tags_ecc_fixed;
 760         u32 n_tags_ecc_unfixed;
 761         u32 n_deletions;
 762         u32 n_unmarked_deletions;
 763         u32 refresh_count;
 764         u32 cache_hits;
 765
 766 };
 767
 768
 769 /* The CheckpointDevice structure holds the device information that changes at runtime and
 770  * must be preserved over unmount/mount cycles.
 771  */
 772 struct yaffs_checkpt_dev{
 773         int struct_type;
 774         int n_erased_blocks;
 775         int alloc_block;        /* Current block being allocated off */
 776         u32 alloc_page;
 777         int n_free_chunks;
 778
 779         int n_deleted_files;            /* Count of files awaiting deletion;*/
 780         int n_unlinked_files;           /* Count of unlinked files. */
 781         int n_bg_deletions;     /* Count of background deletions. */
 782
 783         /* yaffs2 runtime stuff */
 784         unsigned seq_number;    /* Sequence number of currently allocating block */
 785
 786 };
 787
 788
 789 struct yaffs_checkpt_validity{
 790         int struct_type;
 791         u32 magic;
 792         u32 version;
 793         u32 head;
 794 };
 795
 796
 797 struct yaffs_shadow_fixer {
 798         int obj_id;
 799         int shadowed_id;
 800         struct yaffs_shadow_fixer *next;
 801 };
 802
 803 /* Structure for doing xattr modifications */
 804 struct yaffs_xattr_mod{
 805         int set; /* If 0 then this is a deletion */
 806         const YCHAR *name;
 807         const void *data;
 808         int size;
 809         int flags;
 810         int result;
 811 };
 812
 813
 814 /*----------------------- YAFFS Functions -----------------------*/
 815
 816 int yaffs_guts_initialise(struct yaffs_dev *dev);
 817 void yaffs_deinitialise(struct yaffs_dev *dev);
 818
 819 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
 820
 821 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR *old_name,
 822                        struct yaffs_obj *new_dir, const YCHAR *new_name);
 823
 824 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR *name);
 825 int yaffs_del_obj(struct yaffs_obj *obj);
 826
 827 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR *name, int buffer_size);
 828 int yaffs_get_obj_length(struct yaffs_obj *obj);
 829 int yaffs_get_obj_inode(struct yaffs_obj *obj);
 830 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
 831 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
 832
 833 int yaffs_set_attribs(struct yaffs_obj *obj, struct iattr *attr);
 834 int yaffs_get_attribs(struct yaffs_obj *obj, struct iattr *attr);
 835
 836 /* File operations */
 837 int yaffs_file_rd(struct yaffs_obj *obj, u8 *buffer, loff_t offset,
 838                                 int n_bytes);
 839 int yaffs_wr_file(struct yaffs_obj *obj, const u8 *buffer, loff_t offset,
 840                                 int n_bytes, int write_trhrough);
 841 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
 842
 843 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent, const YCHAR *name,
 844                                 u32 mode, u32 uid, u32 gid);
 845
 846 int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync);
 847
 848 /* Flushing and checkpointing */
 849 void yaffs_flush_whole_cache(struct yaffs_dev *dev);
 850
 851 int yaffs_checkpoint_save(struct yaffs_dev *dev);
 852 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
 853
 854 /* Directory operations */
 855 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
 856                                 u32 mode, u32 uid, u32 gid);
 857 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir, const YCHAR *name);
 858 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
 859
 860 /* Link operations */
 861 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
 862                          struct yaffs_obj *equiv_obj);
 863
 864 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
 865
 866 /* Symlink operations */
 867 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent, const YCHAR *name,
 868                                  u32 mode, u32 uid, u32 gid,
 869                                  const YCHAR *alias);
 870 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
 871
 872 /* Special inodes (fifos, sockets and devices) */
 873 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent, const YCHAR *name,
 874                                  u32 mode, u32 uid, u32 gid, u32 rdev);
 875
 876
 877 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name, const void * value, int size, int flags);
 878 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value, int size);
 879 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
 880 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
 881
 882 /* Special directories */
 883 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
 884 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
 885
 886 #ifdef CONFIG_YAFFS_WINCE
 887 /* CONFIG_YAFFS_WINCE special stuff */
 888 void yfsd_win_file_time_now(u32 target[2]);
 889 #endif
 890
 891 void yaffs_handle_defered_free(struct yaffs_obj *obj);
 892
 893 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
 894
 895 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
 896
 897 /* Debug dump  */
 898 int yaffs_dump_obj(struct yaffs_obj *obj);
 899
 900 void yaffs_guts_test(struct yaffs_dev *dev);
 901
 902 /* A few useful functions to be used within the core files*/
 903 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash, int lyn);
 904 int yaffs_check_ff(u8 *buffer, int n_bytes);
 905 void yaffs_handle_chunk_error(struct yaffs_dev *dev, struct yaffs_block_info *bi);
 906
 907 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev, int line_no);
 908 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer, int line_no);
 909
 910 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
 911                                                 int number,
 912                                                 enum yaffs_obj_type type);
 913 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
 914                                 int nand_chunk, int in_scan);
 915 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
 916 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
 917                                 const struct yaffs_obj_hdr *oh);
 918 void yaffs_add_obj_to_dir(struct yaffs_obj *directory,
 919                                         struct yaffs_obj *obj);
 920 YCHAR *yaffs_clone_str(const YCHAR *str);
 921 void yaffs_link_fixup(struct yaffs_dev *dev, struct yaffs_obj *hard_list);
 922 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
 923 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
 924                                 int force, int is_shrink, int shadows,
 925                                 struct yaffs_xattr_mod *xop);
 926 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
 927                                 int backward_scanning);
 928 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
 929 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
 930 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
 931                                         struct yaffs_file_var *file_struct,
 932                                         u32 chunk_id,
 933                                         struct yaffs_tnode *passed_tn);
 934
 935 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
 936                         int n_bytes, int write_trhrough);
 937 void yaffs_resize_file_down( struct yaffs_obj *obj, loff_t new_size);
 938 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
 939
 940 int yaffs_count_free_chunks(struct yaffs_dev *dev);
 941
 942 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
 943                                 struct yaffs_file_var *file_struct,
 944                                 u32 chunk_id);
 945
 946 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn, unsigned pos);
 947
 948 #endif