yaffs_guts.h

   1 /*
   2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2011 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
  21 #define YAFFS_OK        1
  22 #define YAFFS_FAIL  0
  23
  24 /* Give us a  Y=0x59,
  25  * Give us an A=0x41,
  26  * Give us an FF=0xFF
  27  * Give us an S=0x53
  28  * And what have we got...
  29  */
  30 #define YAFFS_MAGIC                     0x5941FF53
  31
  32 #define YAFFS_NTNODES_LEVEL0            16
  33 #define YAFFS_TNODES_LEVEL0_BITS        4
  34 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  35
  36 #define YAFFS_NTNODES_INTERNAL          (YAFFS_NTNODES_LEVEL0 / 2)
  37 #define YAFFS_TNODES_INTERNAL_BITS      (YAFFS_TNODES_LEVEL0_BITS - 1)
  38 #define YAFFS_TNODES_INTERNAL_MASK      0x7
  39 #define YAFFS_TNODES_MAX_LEVEL          6
  40
  41 #ifndef CONFIG_YAFFS_NO_YAFFS1
  42 #define YAFFS_BYTES_PER_SPARE           16
  43 #define YAFFS_BYTES_PER_CHUNK           512
  44 #define YAFFS_CHUNK_SIZE_SHIFT          9
  45 #define YAFFS_CHUNKS_PER_BLOCK          32
  46 #define YAFFS_BYTES_PER_BLOCK   (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
  47 #endif
  48
  49 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE     1024
  50 #define YAFFS_MIN_YAFFS2_SPARE_SIZE     32
  51
  52 #define YAFFS_MAX_CHUNK_ID              0x000FFFFF
  53
  54 #define YAFFS_ALLOCATION_NOBJECTS       100
  55 #define YAFFS_ALLOCATION_NTNODES        100
  56 #define YAFFS_ALLOCATION_NLINKS         100
  57
  58 #define YAFFS_NOBJECT_BUCKETS           256
  59
  60 #define YAFFS_OBJECT_SPACE              0x40000
  61 #define YAFFS_MAX_OBJECT_ID             (YAFFS_OBJECT_SPACE - 1)
  62
  63 #define YAFFS_CHECKPOINT_VERSION        4
  64
  65 #ifdef CONFIG_YAFFS_UNICODE
  66 #define YAFFS_MAX_NAME_LENGTH           127
  67 #define YAFFS_MAX_ALIAS_LENGTH          79
  68 #else
  69 #define YAFFS_MAX_NAME_LENGTH           255
  70 #define YAFFS_MAX_ALIAS_LENGTH          159
  71 #endif
  72
  73 #define YAFFS_SHORT_NAME_LENGTH         15
  74
  75 /* Some special object ids for pseudo objects */
  76 #define YAFFS_OBJECTID_ROOT             1
  77 #define YAFFS_OBJECTID_LOSTNFOUND       2
  78 #define YAFFS_OBJECTID_UNLINKED         3
  79 #define YAFFS_OBJECTID_DELETED          4
  80
  81 /* Pseudo object ids for checkpointing */
  82 #define YAFFS_OBJECTID_SB_HEADER        0x10
  83 #define YAFFS_OBJECTID_CHECKPOINT_DATA  0x20
  84 #define YAFFS_SEQUENCE_CHECKPOINT_DATA  0x21
  85
  86 #define YAFFS_MAX_SHORT_OP_CACHES       20
  87
  88 #define YAFFS_N_TEMP_BUFFERS            6
  89
  90 /* We limit the number attempts at sucessfully saving a chunk of data.
  91  * Small-page devices have 32 pages per block; large-page devices have 64.
  92  * Default to something in the order of 5 to 10 blocks worth of chunks.
  93  */
  94 #define YAFFS_WR_ATTEMPTS               (5*64)
  95
  96 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
  97  * The range is limited slightly to help distinguish bad numbers from good.
  98  * This also allows us to perhaps in the future use special numbers for
  99  * special purposes.
 100  * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
 101  * and is a larger number than the lifetime of a 2GB device.
 102  */
 103 #define YAFFS_LOWEST_SEQUENCE_NUMBER    0x00001000
 104 #define YAFFS_HIGHEST_SEQUENCE_NUMBER   0xEFFFFF00
 105
 106 /* Special sequence number for bad block that failed to be marked bad */
 107 #define YAFFS_SEQUENCE_BAD_BLOCK        0xFFFF0000
 108
 109 /* ChunkCache is used for short read/write operations.*/
 110 struct yaffs_cache {
 111         struct yaffs_obj *object;
 112         int chunk_id;
 113         int last_use;
 114         int dirty;
 115         int n_bytes;            /* Only valid if the cache is dirty */
 116         int locked;             /* Can't push out or flush while locked. */
 117         u8 *data;
 118 };
 119
 120 /* Tags structures in RAM
 121  * NB This uses bitfield. Bitfields should not straddle a u32 boundary
 122  * otherwise the structure size will get blown out.
 123  */
 124
 125 #ifndef CONFIG_YAFFS_NO_YAFFS1
 126 struct yaffs_tags {
 127         unsigned chunk_id:20;
 128         unsigned serial_number:2;
 129         unsigned n_bytes_lsb:10;
 130         unsigned obj_id:18;
 131         unsigned ecc:12;
 132         unsigned n_bytes_msb:2;
 133 };
 134
 135 union yaffs_tags_union {
 136         struct yaffs_tags as_tags;
 137         u8 as_bytes[8];
 138 };
 139
 140 #endif
 141
 142 /* Stuff used for extended tags in YAFFS2 */
 143
 144 enum yaffs_ecc_result {
 145         YAFFS_ECC_RESULT_UNKNOWN,
 146         YAFFS_ECC_RESULT_NO_ERROR,
 147         YAFFS_ECC_RESULT_FIXED,
 148         YAFFS_ECC_RESULT_UNFIXED
 149 };
 150
 151 enum yaffs_obj_type {
 152         YAFFS_OBJECT_TYPE_UNKNOWN,
 153         YAFFS_OBJECT_TYPE_FILE,
 154         YAFFS_OBJECT_TYPE_SYMLINK,
 155         YAFFS_OBJECT_TYPE_DIRECTORY,
 156         YAFFS_OBJECT_TYPE_HARDLINK,
 157         YAFFS_OBJECT_TYPE_SPECIAL
 158 };
 159
 160 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
 161
 162 struct yaffs_ext_tags {
 163
 164         unsigned validity0;
 165         unsigned chunk_used;    /*  Status of the chunk: used or unused */
 166         unsigned obj_id;        /* If 0 this is not used */
 167         unsigned chunk_id;      /* If 0 this is a header, else a data chunk */
 168         unsigned n_bytes;       /* Only valid for data chunks */
 169
 170         /* The following stuff only has meaning when we read */
 171         enum yaffs_ecc_result ecc_result;
 172         unsigned block_bad;
 173
 174         /* YAFFS 1 stuff */
 175         unsigned is_deleted;    /* The chunk is marked deleted */
 176         unsigned serial_number; /* Yaffs1 2-bit serial number */
 177
 178         /* YAFFS2 stuff */
 179         unsigned seq_number;    /* The sequence number of this block */
 180
 181         /* Extra info if this is an object header (YAFFS2 only) */
 182
 183         unsigned extra_available;       /* Extra info available if not zero */
 184         unsigned extra_parent_id;       /* The parent object */
 185         unsigned extra_is_shrink;       /* Is it a shrink header? */
 186         unsigned extra_shadows; /* Does this shadow another object? */
 187
 188         enum yaffs_obj_type extra_obj_type;     /* What object type? */
 189
 190         unsigned extra_length;  /* Length if it is a file */
 191         unsigned extra_equiv_id;        /* Equivalent object for a hard link */
 192
 193         unsigned validity1;
 194
 195 };
 196
 197 /* Spare structure for YAFFS1 */
 198 struct yaffs_spare {
 199         u8 tb0;
 200         u8 tb1;
 201         u8 tb2;
 202         u8 tb3;
 203         u8 page_status;         /* set to 0 to delete the chunk */
 204         u8 block_status;
 205         u8 tb4;
 206         u8 tb5;
 207         u8 ecc1[3];
 208         u8 tb6;
 209         u8 tb7;
 210         u8 ecc2[3];
 211 };
 212
 213 /*Special structure for passing through to mtd */
 214 struct yaffs_nand_spare {
 215         struct yaffs_spare spare;
 216         int eccres1;
 217         int eccres2;
 218 };
 219
 220 /* Block data in RAM */
 221
 222 enum yaffs_block_state {
 223         YAFFS_BLOCK_STATE_UNKNOWN = 0,
 224
 225         YAFFS_BLOCK_STATE_SCANNING,
 226         /* Being scanned */
 227
 228         YAFFS_BLOCK_STATE_NEEDS_SCAN,
 229         /* The block might have something on it (ie it is allocating or full,
 230          * perhaps empty) but it needs to be scanned to determine its true
 231          * state.
 232          * This state is only valid during scanning.
 233          * NB We tolerate empty because the pre-scanner might be incapable of
 234          * deciding
 235          * However, if this state is returned on a YAFFS2 device,
 236          * then we expect a sequence number
 237          */
 238
 239         YAFFS_BLOCK_STATE_EMPTY,
 240         /* This block is empty */
 241
 242         YAFFS_BLOCK_STATE_ALLOCATING,
 243         /* This block is partially allocated.
 244          * At least one page holds valid data.
 245          * This is the one currently being used for page
 246          * allocation. Should never be more than one of these.
 247          * If a block is only partially allocated at mount it is treated as
 248          * full.
 249          */
 250
 251         YAFFS_BLOCK_STATE_FULL,
 252         /* All the pages in this block have been allocated.
 253          * If a block was only partially allocated when mounted we treat
 254          * it as fully allocated.
 255          */
 256
 257         YAFFS_BLOCK_STATE_DIRTY,
 258         /* The block was full and now all chunks have been deleted.
 259          * Erase me, reuse me.
 260          */
 261
 262         YAFFS_BLOCK_STATE_CHECKPOINT,
 263         /* This block is assigned to holding checkpoint data. */
 264
 265         YAFFS_BLOCK_STATE_COLLECTING,
 266         /* This block is being garbage collected */
 267
 268         YAFFS_BLOCK_STATE_DEAD
 269             /* This block has failed and is not in use */
 270 };
 271
 272 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
 273
 274 struct yaffs_block_info {
 275
 276         int soft_del_pages:10;  /* number of soft deleted pages */
 277         int pages_in_use:10;    /* number of pages in use */
 278         unsigned block_state:4; /* One of the above block states. */
 279                                 /* NB use unsigned because enum is sometimes
 280                                  * an int */
 281         u32 needs_retiring:1;   /* Data has failed on this block, */
 282                                 /*need to get valid data off and retire*/
 283         u32 skip_erased_check:1;/* Skip the erased check on this block */
 284         u32 gc_prioritise:1;    /* An ECC check or blank check has failed.
 285                                    Block should be prioritised for GC */
 286         u32 chunk_error_strikes:3;      /* How many times we've had ecc etc
 287                                 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 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 all object types except for hard links */
 308         u32 yst_mode;           /* protection */
 309
 310         u32 yst_uid;
 311         u32 yst_gid;
 312         u32 yst_atime;
 313         u32 yst_mtime;
 314         u32 yst_ctime;
 315
 316         /* File size  applies to files only */
 317         int file_size;
 318
 319         /* Equivalent object id applies to hard links only. */
 320         int equiv_id;
 321
 322         /* Alias is for symlinks only. */
 323         YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 324
 325         u32 yst_rdev;   /* stuff for block and char devices (major/min) */
 326
 327         u32 win_ctime[2];
 328         u32 win_atime[2];
 329         u32 win_mtime[2];
 330
 331         u32 inband_shadowed_obj_id;
 332         u32 inband_is_shrink;
 333
 334         u32 reserved[2];
 335         int shadows_obj;        /* This object header shadows the
 336                                 specified object if > 0 */
 337
 338         /* is_shrink applies to object headers written when wemake a hole. */
 339         u32 is_shrink;
 340
 341 };
 342
 343 /*--------------------------- Tnode -------------------------- */
 344
 345 struct yaffs_tnode {
 346         struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
 347 };
 348
 349 /*------------------------  Object -----------------------------*/
 350 /* An object can be one of:
 351  * - a directory (no data, has children links
 352  * - a regular file (data.... not prunes :->).
 353  * - a symlink [symbolic link] (the alias).
 354  * - a hard link
 355  */
 356
 357 struct yaffs_file_var {
 358         u32 file_size;
 359         u32 scanned_size;
 360         u32 shrink_size;
 361         int top_level;
 362         struct yaffs_tnode *top;
 363 };
 364
 365 struct yaffs_dir_var {
 366         struct list_head children;      /* list of child links */
 367         struct list_head dirty; /* Entry for list of dirty directories */
 368 };
 369
 370 struct yaffs_symlink_var {
 371         YCHAR *alias;
 372 };
 373
 374 struct yaffs_hardlink_var {
 375         struct yaffs_obj *equiv_obj;
 376         u32 equiv_id;
 377 };
 378
 379 union yaffs_obj_var {
 380         struct yaffs_file_var file_variant;
 381         struct yaffs_dir_var dir_variant;
 382         struct yaffs_symlink_var symlink_variant;
 383         struct yaffs_hardlink_var hardlink_variant;
 384 };
 385
 386 struct yaffs_obj {
 387         u8 deleted:1;           /* This should only apply to unlinked files. */
 388         u8 soft_del:1;          /* it has also been soft deleted */
 389         u8 unlinked:1;          /* An unlinked file.*/
 390         u8 fake:1;              /* A fake object has no presence on NAND. */
 391         u8 rename_allowed:1;    /* Some objects cannot be renamed. */
 392         u8 unlink_allowed:1;
 393         u8 dirty:1;             /* the object needs to be written to flash */
 394         u8 valid:1;             /* When the file system is being loaded up, this
 395                                  * object might be created before the data
 396                                  * is available
 397                                  * ie. file data chunks encountered before
 398                                 * the header.
 399                                  */
 400         u8 lazy_loaded:1;       /* This object has been lazy loaded and
 401                                  * is missing some detail */
 402
 403         u8 defered_free:1;      /* Object is removed from NAND, but is
 404                                  * still in the inode cache.
 405                                  * Free of object is defered.
 406                                  * until the inode is released.
 407                                  */
 408         u8 being_created:1;     /* This object is still being created
 409                                  * so skip some verification checks. */
 410         u8 is_shadowed:1;       /* This object is shadowed on the way
 411                                  * to being renamed. */
 412
 413         u8 xattr_known:1;       /* We know if this has object has xattribs
 414                                  * or not. */
 415         u8 has_xattr:1;         /* This object has xattribs.
 416                                  * Only valid if xattr_known. */
 417
 418         u8 serial;              /* serial number of chunk in NAND.*/
 419         u16 sum;                /* sum of the name to speed searching */
 420
 421         struct yaffs_dev *my_dev;       /* The device I'm on */
 422
 423         struct list_head hash_link;     /* list of objects in hash bucket */
 424
 425         struct list_head hard_links;    /* hard linked object chain*/
 426
 427         /* directory structure stuff */
 428         /* also used for linking up the free list */
 429         struct yaffs_obj *parent;
 430         struct list_head siblings;
 431
 432         /* Where's my object header in NAND? */
 433         int hdr_chunk;
 434
 435         int n_data_chunks;      /* Number of data chunks for this file. */
 436
 437         u32 obj_id;             /* the object id value */
 438
 439         u32 yst_mode;
 440
 441 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
 442         YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
 443 #endif
 444
 445 #ifdef CONFIG_YAFFS_WINCE
 446         u32 win_ctime[2];
 447         u32 win_mtime[2];
 448         u32 win_atime[2];
 449 #else
 450         u32 yst_uid;
 451         u32 yst_gid;
 452         u32 yst_atime;
 453         u32 yst_mtime;
 454         u32 yst_ctime;
 455 #endif
 456
 457         u32 yst_rdev;
 458
 459         void *my_inode;
 460
 461         enum yaffs_obj_type variant_type;
 462
 463         union yaffs_obj_var variant;
 464
 465 };
 466
 467 struct yaffs_obj_bucket {
 468         struct list_head list;
 469         int count;
 470 };
 471
 472 /* yaffs_checkpt_obj holds the definition of an object as dumped
 473  * by checkpointing.
 474  */
 475
 476 struct yaffs_checkpt_obj {
 477         int struct_type;
 478         u32 obj_id;
 479         u32 parent_id;
 480         int hdr_chunk;
 481         enum yaffs_obj_type variant_type:3;
 482         u8 deleted:1;
 483         u8 soft_del:1;
 484         u8 unlinked:1;
 485         u8 fake:1;
 486         u8 rename_allowed:1;
 487         u8 unlink_allowed:1;
 488         u8 serial;
 489         int n_data_chunks;
 490         u32 size_or_equiv_obj;
 491 };
 492
 493 /*--------------------- Temporary buffers ----------------
 494  *
 495  * These are chunk-sized working buffers. Each device has a few
 496  */
 497
 498 struct yaffs_buffer {
 499         u8 *buffer;
 500         int line;       /* track from whence this buffer was allocated */
 501         int max_line;
 502 };
 503
 504 /*----------------- Device ---------------------------------*/
 505
 506 struct yaffs_param {
 507         const YCHAR *name;
 508
 509         /*
 510          * Entry parameters set up way early. Yaffs sets up the rest.
 511          * The structure should be zeroed out before use so that unused
 512          * and defualt values are zero.
 513          */
 514
 515         int inband_tags;        /* Use unband tags */
 516         u32 total_bytes_per_chunk;      /* Should be >= 512, does not need to
 517                                          be a power of 2 */
 518         int chunks_per_block;   /* does not need to be a power of 2 */
 519         int spare_bytes_per_chunk;      /* spare area size */
 520         int start_block;        /* Start block we're allowed to use */
 521         int end_block;          /* End block we're allowed to use */
 522         int n_reserved_blocks;  /* Tuneable so that we can reduce
 523                                  * reserved blocks on NOR and RAM. */
 524
 525         int n_caches;           /* If <= 0, then short op caching is disabled,
 526                                  * else the number of short op caches.
 527                                  */
 528         int use_nand_ecc;       /* Flag to decide whether or not to use
 529                                  * NAND driver ECC on data (yaffs1) */
 530         int no_tags_ecc;        /* Flag to decide whether or not to do ECC
 531                                  * on packed tags (yaffs2) */
 532
 533         int is_yaffs2;          /* Use yaffs2 mode on this device */
 534
 535         int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
 536
 537         int refresh_period;     /* How often to check for a block refresh */
 538
 539         /* Checkpoint control. Can be set before or after initialisation */
 540         u8 skip_checkpt_rd;
 541         u8 skip_checkpt_wr;
 542
 543         int enable_xattr;       /* Enable xattribs */
 544
 545         /* NAND access functions (Must be set before calling YAFFS) */
 546
 547         int (*write_chunk_fn) (struct yaffs_dev *dev,
 548                                int nand_chunk, const u8 *data,
 549                                const struct yaffs_spare *spare);
 550         int (*read_chunk_fn) (struct yaffs_dev *dev,
 551                               int nand_chunk, u8 *data,
 552                               struct yaffs_spare *spare);
 553         int (*erase_fn) (struct yaffs_dev *dev, int flash_block);
 554         int (*initialise_flash_fn) (struct yaffs_dev *dev);
 555         int (*deinitialise_flash_fn) (struct yaffs_dev *dev);
 556
 557 #ifdef CONFIG_YAFFS_YAFFS2
 558         int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
 559                                     int nand_chunk, const u8 *data,
 560                                     const struct yaffs_ext_tags *tags);
 561         int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
 562                                    int nand_chunk, u8 *data,
 563                                    struct yaffs_ext_tags *tags);
 564         int (*bad_block_fn) (struct yaffs_dev *dev, int block_no);
 565         int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
 566                                enum yaffs_block_state *state,
 567                                u32 *seq_number);
 568 #endif
 569
 570         /* The remove_obj_fn function must be supplied by OS flavours that
 571          * need it.
 572          * yaffs direct uses it to implement the faster readdir.
 573          * Linux uses it to protect the directory during unlocking.
 574          */
 575         void (*remove_obj_fn) (struct yaffs_obj *obj);
 576
 577         /* Callback to mark the superblock dirty */
 578         void (*sb_dirty_fn) (struct yaffs_dev *dev);
 579
 580         /*  Callback to control garbage collection. */
 581         unsigned (*gc_control) (struct yaffs_dev *dev);
 582
 583         /* Debug control flags. Don't use unless you know what you're doing */
 584         int use_header_file_size;       /* Flag to determine if we should use
 585                                          * file sizes from the header */
 586         int disable_lazy_load;  /* Disable lazy loading on this device */
 587         int wide_tnodes_disabled;       /* Set to disable wide tnodes */
 588         int disable_soft_del;   /* yaffs 1 only: Set to disable the use of
 589                                  * softdeletion. */
 590
 591         int defered_dir_update; /* Set to defer directory updates */
 592
 593 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 594         int auto_unicode;
 595 #endif
 596         int always_check_erased;        /* Force chunk erased check always on */
 597 };
 598
 599 struct yaffs_dev {
 600         struct yaffs_param param;
 601
 602         /* Context storage. Holds extra OS specific data for this device */
 603
 604         void *os_context;
 605         void *driver_context;
 606
 607         struct list_head dev_list;
 608
 609         /* Runtime parameters. Set up by YAFFS. */
 610         int data_bytes_per_chunk;
 611
 612         /* Non-wide tnode stuff */
 613         u16 chunk_grp_bits;     /* Number of bits that need to be resolved if
 614                                  * the tnodes are not wide enough.
 615                                  */
 616         u16 chunk_grp_size;     /* == 2^^chunk_grp_bits */
 617
 618         /* Stuff to support wide tnodes */
 619         u32 tnode_width;
 620         u32 tnode_mask;
 621         u32 tnode_size;
 622
 623         /* Stuff for figuring out file offset to chunk conversions */
 624         u32 chunk_shift;        /* Shift value */
 625         u32 chunk_div;          /* Divisor after shifting: 1 for 2^n sizes */
 626         u32 chunk_mask;         /* Mask to use for power-of-2 case */
 627
 628         int is_mounted;
 629         int read_only;
 630         int is_checkpointed;
 631
 632         /* Stuff to support block offsetting to support start block zero */
 633         int internal_start_block;
 634         int internal_end_block;
 635         int block_offset;
 636         int chunk_offset;
 637
 638         /* Runtime checkpointing stuff */
 639         int checkpt_page_seq;   /* running sequence number of checkpt pages */
 640         int checkpt_byte_count;
 641         int checkpt_byte_offs;
 642         u8 *checkpt_buffer;
 643         int checkpt_open_write;
 644         int blocks_in_checkpt;
 645         int checkpt_cur_chunk;
 646         int checkpt_cur_block;
 647         int checkpt_next_block;
 648         int *checkpt_block_list;
 649         int checkpt_max_blocks;
 650         u32 checkpt_sum;
 651         u32 checkpt_xor;
 652
 653         int checkpoint_blocks_required; /* Number of blocks needed to store
 654                                          * current checkpoint set */
 655
 656         /* Block Info */
 657         struct yaffs_block_info *block_info;
 658         u8 *chunk_bits;         /* bitmap of chunks in use */
 659         unsigned block_info_alt:1;      /* allocated using alternative alloc */
 660         unsigned chunk_bits_alt:1;      /* allocated using alternative alloc */
 661         int chunk_bit_stride;   /* Number of bytes of chunk_bits per block.
 662                                  * Must be consistent with chunks_per_block.
 663                                  */
 664
 665         int n_erased_blocks;
 666         int alloc_block;        /* Current block being allocated off */
 667         u32 alloc_page;
 668         int alloc_block_finder; /* Used to search for next allocation block */
 669
 670         /* Object and Tnode memory management */
 671         void *allocator;
 672         int n_obj;
 673         int n_tnodes;
 674
 675         int n_hardlinks;
 676
 677         struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
 678         u32 bucket_finder;
 679
 680         int n_free_chunks;
 681
 682         /* Garbage collection control */
 683         u32 *gc_cleanup_list;   /* objects to delete at the end of a GC. */
 684         u32 n_clean_ups;
 685
 686         unsigned has_pending_prioritised_gc;    /* We think this device might
 687                                                 have pending prioritised gcs */
 688         unsigned gc_disable;
 689         unsigned gc_block_finder;
 690         unsigned gc_dirtiest;
 691         unsigned gc_pages_in_use;
 692         unsigned gc_not_done;
 693         unsigned gc_block;
 694         unsigned gc_chunk;
 695         unsigned gc_skip;
 696
 697         /* Special directories */
 698         struct yaffs_obj *root_dir;
 699         struct yaffs_obj *lost_n_found;
 700
 701         int buffered_block;     /* Which block is buffered here? */
 702         int doing_buffered_block_rewrite;
 703
 704         struct yaffs_cache *cache;
 705         int cache_last_use;
 706
 707         /* Stuff for background deletion and unlinked files. */
 708         struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
 709                                          files live. */
 710         struct yaffs_obj *del_dir;      /* Directory where deleted objects are
 711                                         sent to disappear. */
 712         struct yaffs_obj *unlinked_deletion;    /* Current file being
 713                                                         background deleted. */
 714         int n_deleted_files;    /* Count of files awaiting deletion; */
 715         int n_unlinked_files;   /* Count of unlinked files. */
 716         int n_bg_deletions;     /* Count of background deletions. */
 717
 718         /* Temporary buffer management */
 719         struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
 720         int max_temp;
 721         int temp_in_use;
 722         int unmanaged_buffer_allocs;
 723         int unmanaged_buffer_deallocs;
 724
 725         /* yaffs2 runtime stuff */
 726         unsigned seq_number;    /* Sequence number of currently
 727                                         allocating block */
 728         unsigned oldest_dirty_seq;
 729         unsigned oldest_dirty_block;
 730
 731         /* Block refreshing */
 732         int refresh_skip;       /* A skip down counter.
 733                                  * Refresh happens when this gets to zero. */
 734
 735         /* Dirty directory handling */
 736         struct list_head dirty_dirs;    /* List of dirty directories */
 737
 738         /* Statistcs */
 739         u32 n_page_writes;
 740         u32 n_page_reads;
 741         u32 n_erasures;
 742         u32 n_erase_failures;
 743         u32 n_gc_copies;
 744         u32 all_gcs;
 745         u32 passive_gc_count;
 746         u32 oldest_dirty_gc_count;
 747         u32 n_gc_blocks;
 748         u32 bg_gcs;
 749         u32 n_retired_writes;
 750         u32 n_retired_blocks;
 751         u32 n_ecc_fixed;
 752         u32 n_ecc_unfixed;
 753         u32 n_tags_ecc_fixed;
 754         u32 n_tags_ecc_unfixed;
 755         u32 n_deletions;
 756         u32 n_unmarked_deletions;
 757         u32 refresh_count;
 758         u32 cache_hits;
 759
 760 };
 761
 762 /* The CheckpointDevice structure holds the device information that changes
 763  *at runtime and must be preserved over unmount/mount cycles.
 764  */
 765 struct yaffs_checkpt_dev {
 766         int struct_type;
 767         int n_erased_blocks;
 768         int alloc_block;        /* Current block being allocated off */
 769         u32 alloc_page;
 770         int n_free_chunks;
 771
 772         int n_deleted_files;    /* Count of files awaiting deletion; */
 773         int n_unlinked_files;   /* Count of unlinked files. */
 774         int n_bg_deletions;     /* Count of background deletions. */
 775
 776         /* yaffs2 runtime stuff */
 777         unsigned seq_number;    /* Sequence number of currently
 778                                  * allocating block */
 779
 780 };
 781
 782 struct yaffs_checkpt_validity {
 783         int struct_type;
 784         u32 magic;
 785         u32 version;
 786         u32 head;
 787 };
 788
 789 struct yaffs_shadow_fixer {
 790         int obj_id;
 791         int shadowed_id;
 792         struct yaffs_shadow_fixer *next;
 793 };
 794
 795 /* Structure for doing xattr modifications */
 796 struct yaffs_xattr_mod {
 797         int set;                /* If 0 then this is a deletion */
 798         const YCHAR *name;
 799         const void *data;
 800         int size;
 801         int flags;
 802         int result;
 803 };
 804
 805 /*----------------------- YAFFS Functions -----------------------*/
 806
 807 int yaffs_guts_initialise(struct yaffs_dev *dev);
 808 void yaffs_deinitialise(struct yaffs_dev *dev);
 809
 810 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
 811
 812 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
 813                      struct yaffs_obj *new_dir, const YCHAR * new_name);
 814
 815 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
 816 int yaffs_del_obj(struct yaffs_obj *obj);
 817
 818 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
 819 int yaffs_get_obj_length(struct yaffs_obj *obj);
 820 int yaffs_get_obj_inode(struct yaffs_obj *obj);
 821 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
 822 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
 823
 824 /* File operations */
 825 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
 826                   int n_bytes);
 827 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
 828                   int n_bytes, int write_trhrough);
 829 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
 830
 831 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
 832                                     const YCHAR *name, u32 mode, u32 uid,
 833                                     u32 gid);
 834
 835 int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync);
 836
 837 /* Flushing and checkpointing */
 838 void yaffs_flush_whole_cache(struct yaffs_dev *dev);
 839
 840 int yaffs_checkpoint_save(struct yaffs_dev *dev);
 841 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
 842
 843 /* Directory operations */
 844 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
 845                                    u32 mode, u32 uid, u32 gid);
 846 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
 847                                      const YCHAR *name);
 848 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
 849
 850 /* Link operations */
 851 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
 852                                  struct yaffs_obj *equiv_obj);
 853
 854 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
 855
 856 /* Symlink operations */
 857 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
 858                                        const YCHAR *name, u32 mode, u32 uid,
 859                                        u32 gid, const YCHAR *alias);
 860 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
 861
 862 /* Special inodes (fifos, sockets and devices) */
 863 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
 864                                        const YCHAR *name, u32 mode, u32 uid,
 865                                        u32 gid, u32 rdev);
 866
 867 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
 868                       const void *value, int size, int flags);
 869 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
 870                       int size);
 871 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
 872 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
 873
 874 /* Special directories */
 875 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
 876 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
 877
 878 void yaffs_handle_defered_free(struct yaffs_obj *obj);
 879
 880 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
 881
 882 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
 883
 884 /* Debug dump  */
 885 int yaffs_dump_obj(struct yaffs_obj *obj);
 886
 887 void yaffs_guts_test(struct yaffs_dev *dev);
 888
 889 /* A few useful functions to be used within the core files*/
 890 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
 891                      int lyn);
 892 int yaffs_check_ff(u8 *buffer, int n_bytes);
 893 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
 894                               struct yaffs_block_info *bi);
 895
 896 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev, int line_no);
 897 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer, int line_no);
 898
 899 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
 900                                                  int number,
 901                                                  enum yaffs_obj_type type);
 902 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
 903                             int nand_chunk, int in_scan);
 904 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
 905 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
 906                                 const struct yaffs_obj_hdr *oh);
 907 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
 908 YCHAR *yaffs_clone_str(const YCHAR *str);
 909 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
 910 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
 911 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
 912                     int force, int is_shrink, int shadows,
 913                     struct yaffs_xattr_mod *xop);
 914 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
 915                                int backward_scanning);
 916 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
 917 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
 918 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
 919                                            struct yaffs_file_var *file_struct,
 920                                            u32 chunk_id,
 921                                            struct yaffs_tnode *passed_tn);
 922
 923 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
 924                      int n_bytes, int write_trhrough);
 925 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
 926 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
 927
 928 int yaffs_count_free_chunks(struct yaffs_dev *dev);
 929
 930 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
 931                                        struct yaffs_file_var *file_struct,
 932                                        u32 chunk_id);
 933
 934 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
 935                          unsigned pos);
 936
 937 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
 938 #endif