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