yaffs_guts.h

   1 /*
   2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2018 Aleph One Ltd.
   5  *
   6  * Created by Charles Manning <charles@aleph1.co.uk>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU Lesser General Public License version 2.1 as
  10  * published by the Free Software Foundation.
  11  *
  12  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
  13  */
  14
  15 #ifndef __YAFFS_GUTS_H__
  16 #define __YAFFS_GUTS_H__
  17
  18 #include "yportenv.h"
  19
  20 #define YAFFS_OK        1
  21 #define YAFFS_FAIL  0
  22
  23 /* Give us a  Y=0x59,
  24  * Give us an A=0x41,
  25  * Give us an FF=0xff
  26  * Give us an S=0x53
  27  * And what have we got...
  28  */
  29 #define YAFFS_MAGIC                     0x5941ff53
  30
  31 /*
  32  * Tnodes form a tree with the tnodes in "levels"
  33  * Levels greater than 0 hold 8 slots which point to other tnodes.
  34  * Those at level 0 hold 16 slots which point to chunks in NAND.
  35  *
  36  * A maximum level of 8 thust supports files of size up to:
  37  *
  38  * 2^(3*MAX_LEVEL+4)
  39  *
  40  * Thus a max level of 8 supports files with up to 2^^28 chunks which gives
  41  * a maximum file size of around 512Gbytees with 2k chunks.
  42  */
  43 #define YAFFS_NTNODES_LEVEL0            16
  44 #define YAFFS_TNODES_LEVEL0_BITS        4
  45 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  46
  47 #define YAFFS_NTNODES_INTERNAL          (YAFFS_NTNODES_LEVEL0 / 2)
  48 #define YAFFS_TNODES_INTERNAL_BITS      (YAFFS_TNODES_LEVEL0_BITS - 1)
  49 #define YAFFS_TNODES_INTERNAL_MASK      0x7
  50 #define YAFFS_TNODES_MAX_LEVEL          8
  51 #define YAFFS_TNODES_MAX_BITS           (YAFFS_TNODES_LEVEL0_BITS + \
  52                                         YAFFS_TNODES_INTERNAL_BITS * \
  53                                         YAFFS_TNODES_MAX_LEVEL)
  54 #define YAFFS_MAX_CHUNK_ID              ((1 << YAFFS_TNODES_MAX_BITS) - 1)
  55
  56 #define YAFFS_MAX_FILE_SIZE_32          0x7fffffff
  57
  58 /* Constants for YAFFS1 mode */
  59 #define YAFFS_BYTES_PER_SPARE           16
  60 #define YAFFS_BYTES_PER_CHUNK           512
  61 #define YAFFS_CHUNK_SIZE_SHIFT          9
  62 #define YAFFS_CHUNKS_PER_BLOCK          32
  63 #define YAFFS_BYTES_PER_BLOCK   (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
  64
  65 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE     1024
  66 #define YAFFS_MIN_YAFFS2_SPARE_SIZE     32
  67
  68
  69
  70 #define YAFFS_ALLOCATION_NOBJECTS       100
  71 #define YAFFS_ALLOCATION_NTNODES        100
  72 #define YAFFS_ALLOCATION_NLINKS         100
  73
  74 #define YAFFS_NOBJECT_BUCKETS           256
  75
  76 #define YAFFS_OBJECT_SPACE              0x40000
  77 #define YAFFS_MAX_OBJECT_ID             (YAFFS_OBJECT_SPACE - 1)
  78
  79 /* Binary data version stamps */
  80 #define YAFFS_SUMMARY_VERSION           1
  81
  82 #ifdef CONFIG_YAFFS_UNICODE
  83 #define YAFFS_MAX_NAME_LENGTH           127
  84 #define YAFFS_MAX_ALIAS_LENGTH          79
  85 #else
  86 #define YAFFS_MAX_NAME_LENGTH           255
  87 #define YAFFS_MAX_ALIAS_LENGTH          159
  88 #endif
  89
  90 #define YAFFS_SHORT_NAME_LENGTH         15
  91
  92 /* Some special object ids for pseudo objects */
  93 #define YAFFS_OBJECTID_ROOT             1
  94 #define YAFFS_OBJECTID_LOSTNFOUND       2
  95 #define YAFFS_OBJECTID_UNLINKED         3
  96 #define YAFFS_OBJECTID_DELETED          4
  97
  98 /* Fake object Id for summary data */
  99 #define YAFFS_OBJECTID_SUMMARY          0x10
 100
 101 /* Pseudo object ids for checkpointing */
 102 #define YAFFS_OBJECTID_CHECKPOINT_DATA  0x20
 103 #define YAFFS_SEQUENCE_CHECKPOINT_DATA  0x21
 104
 105 #define YAFFS_MAX_SHORT_OP_CACHES       20
 106
 107 #define YAFFS_N_TEMP_BUFFERS            6
 108
 109 /* We limit the number attempts at sucessfully saving a chunk of data.
 110  * Small-page devices have 32 pages per block; large-page devices have 64.
 111  * Default to something in the order of 5 to 10 blocks worth of chunks.
 112  */
 113 #define YAFFS_WR_ATTEMPTS               (5*64)
 114
 115 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
 116  * The range is limited slightly to help distinguish bad numbers from good.
 117  * This also allows us to perhaps in the future use special numbers for
 118  * special purposes.
 119  * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
 120  * and is a larger number than the lifetime of a 2GB device.
 121  */
 122 #define YAFFS_LOWEST_SEQUENCE_NUMBER    0x00001000
 123 #define YAFFS_HIGHEST_SEQUENCE_NUMBER   0xefffff00
 124
 125 /* Special sequence number for bad block that failed to be marked bad */
 126 #define YAFFS_SEQUENCE_BAD_BLOCK        0xffff0000
 127
 128 /* ChunkCache is used for short read/write operations.*/
 129 struct yaffs_cache {
 130         struct yaffs_obj *object;
 131         int chunk_id;
 132         int last_use;
 133         int dirty;
 134         int n_bytes;            /* Only valid if the cache is dirty */
 135         int locked;             /* Can't push out or flush while locked. */
 136         u8 *data;
 137 };
 138
 139 /* yaffs1 tags structures in RAM
 140  * NB This uses bitfield. Bitfields should not straddle a u32 boundary
 141  * otherwise the structure size will get blown out.
 142  */
 143
 144 struct yaffs_tags {
 145         u32 chunk_id:20;
 146         u32 serial_number:2;
 147         u32 n_bytes_lsb:10;
 148         u32 obj_id:18;
 149         u32 ecc:12;
 150         u32 n_bytes_msb:2;
 151 };
 152
 153 union yaffs_tags_union {
 154         struct yaffs_tags as_tags;
 155         u8  as_bytes[8];
 156         u32 as_u32[2];
 157 };
 158
 159
 160 /* Stuff used for extended tags in YAFFS2 */
 161
 162 enum yaffs_ecc_result {
 163         YAFFS_ECC_RESULT_UNKNOWN,
 164         YAFFS_ECC_RESULT_NO_ERROR,
 165         YAFFS_ECC_RESULT_FIXED,
 166         YAFFS_ECC_RESULT_UNFIXED
 167 };
 168
 169 /*
 170  * Object type enum:
 171  * When this is stored in flash we store it as a u32 instead
 172  * to prevent any alignment change issues as compiler variants change.
 173  */
 174
 175 enum yaffs_obj_type {
 176         YAFFS_OBJECT_TYPE_UNKNOWN,
 177         YAFFS_OBJECT_TYPE_FILE,
 178         YAFFS_OBJECT_TYPE_SYMLINK,
 179         YAFFS_OBJECT_TYPE_DIRECTORY,
 180         YAFFS_OBJECT_TYPE_HARDLINK,
 181         YAFFS_OBJECT_TYPE_SPECIAL
 182 };
 183
 184 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
 185
 186 struct yaffs_ext_tags {
 187         unsigned chunk_used;    /*  Status of the chunk: used or unused */
 188         unsigned obj_id;        /* If 0 this is not used */
 189         unsigned chunk_id;      /* If 0 this is a header, else a data chunk */
 190         unsigned n_bytes;       /* Only valid for data chunks */
 191
 192         /* The following stuff only has meaning when we read */
 193         enum yaffs_ecc_result ecc_result;
 194         unsigned block_bad;
 195
 196         /* YAFFS 1 stuff */
 197         unsigned is_deleted;    /* The chunk is marked deleted */
 198         unsigned serial_number; /* Yaffs1 2-bit serial number */
 199
 200         /* YAFFS2 stuff */
 201         unsigned seq_number;    /* The sequence number of this block */
 202
 203         /* Extra info if this is an object header (YAFFS2 only) */
 204
 205         unsigned extra_available;       /* Extra info available if not zero */
 206         unsigned extra_parent_id;       /* The parent object */
 207         unsigned extra_is_shrink;       /* Is it a shrink header? */
 208         unsigned extra_shadows; /* Does this shadow another object? */
 209
 210         enum yaffs_obj_type extra_obj_type;     /* What object type? */
 211
 212         loff_t extra_file_size;         /* Length if it is a file */
 213         unsigned extra_equiv_id;        /* Equivalent object for a hard link */
 214 };
 215
 216 /* Spare structure for YAFFS1 */
 217 struct yaffs_spare {
 218         u8 tb0;
 219         u8 tb1;
 220         u8 tb2;
 221         u8 tb3;
 222         u8 page_status;         /* set to 0 to delete the chunk */
 223         u8 block_status;
 224         u8 tb4;
 225         u8 tb5;
 226         u8 ecc1[3];
 227         u8 tb6;
 228         u8 tb7;
 229         u8 ecc2[3];
 230 };
 231
 232 /*Special structure for passing through to mtd */
 233 struct yaffs_nand_spare {
 234         struct yaffs_spare spare;
 235         int eccres1;
 236         int eccres2;
 237 };
 238
 239 /* Block data in RAM */
 240
 241 enum yaffs_block_state {
 242         YAFFS_BLOCK_STATE_UNKNOWN = 0,
 243
 244         YAFFS_BLOCK_STATE_SCANNING,
 245         /* Being scanned */
 246
 247         YAFFS_BLOCK_STATE_NEEDS_SCAN,
 248         /* The block might have something on it (ie it is allocating or full,
 249          * perhaps empty) but it needs to be scanned to determine its true
 250          * state.
 251          * This state is only valid during scanning.
 252          * NB We tolerate empty because the pre-scanner might be incapable of
 253          * deciding
 254          * However, if this state is returned on a YAFFS2 device,
 255          * then we expect a sequence number
 256          */
 257
 258         YAFFS_BLOCK_STATE_EMPTY,
 259         /* This block is empty */
 260
 261         YAFFS_BLOCK_STATE_ALLOCATING,
 262         /* This block is partially allocated.
 263          * At least one page holds valid data.
 264          * This is the one currently being used for page
 265          * allocation. Should never be more than one of these.
 266          * If a block is only partially allocated at mount it is treated as
 267          * full.
 268          */
 269
 270         YAFFS_BLOCK_STATE_FULL,
 271         /* All the pages in this block have been allocated.
 272          * If a block was only partially allocated when mounted we treat
 273          * it as fully allocated.
 274          */
 275
 276         YAFFS_BLOCK_STATE_DIRTY,
 277         /* The block was full and now all chunks have been deleted.
 278          * Erase me, reuse me.
 279          */
 280
 281         YAFFS_BLOCK_STATE_CHECKPOINT,
 282         /* This block is assigned to holding checkpoint data. */
 283
 284         YAFFS_BLOCK_STATE_COLLECTING,
 285         /* This block is being garbage collected */
 286
 287         YAFFS_BLOCK_STATE_DEAD
 288             /* This block has failed and is not in use */
 289 };
 290
 291 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
 292
 293 struct yaffs_block_info {
 294
 295         s32 soft_del_pages:10;  /* number of soft deleted pages */
 296         s32 pages_in_use:10;    /* number of pages in use */
 297         u32 block_state:4;      /* One of the above block states. */
 298                                 /* NB use unsigned because enum is sometimes
 299                                  * an int */
 300         u32 needs_retiring:1;   /* Data has failed on this block, */
 301                                 /*need to get valid data off and retire*/
 302         u32 skip_erased_check:1;/* Skip the erased check on this block */
 303         u32 gc_prioritise:1;    /* An ECC check or blank check has failed.
 304                                    Block should be prioritised for GC */
 305         u32 chunk_error_strikes:3;      /* How many times we've had ecc etc
 306                                 failures on this block and tried to reuse it */
 307         u32 has_summary:1;      /* The block has a summary */
 308
 309         u32 has_shrink_hdr:1;   /* This block has at least one shrink header */
 310         u32 seq_number;         /* block sequence number for yaffs2 */
 311
 312 };
 313
 314 union yaffs_block_info_union {
 315         struct yaffs_block_info bi;
 316         u32     as_u32[2];
 317 };
 318
 319 /* -------------------------- Object structure -------------------------------*/
 320 /* This is the object structure as stored on NAND */
 321
 322 struct yaffs_obj_hdr {
 323         u32 type;  /* enum yaffs_obj_type  */
 324
 325         /* Apply to everything  */
 326         u32 parent_obj_id;
 327         u16 sum_no_longer_used; /* checksum of name. No longer used */
 328         YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
 329
 330         /* The following apply to all object types except for hard links */
 331         u32 yst_mode;           /* protection */
 332
 333         u32 yst_uid;
 334         u32 yst_gid;
 335         u32 yst_atime;
 336         u32 yst_mtime;
 337         u32 yst_ctime;
 338
 339         /* File size  applies to files only */
 340         u32 file_size_low;
 341
 342         /* Equivalent object id applies to hard links only. */
 343         int equiv_id;
 344
 345         /* Alias is for symlinks only. */
 346         YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 347
 348         u32 yst_rdev;   /* stuff for block and char devices (major/min) */
 349
 350         u32 win_ctime[2];
 351         u32 win_atime[2];
 352         u32 win_mtime[2];
 353
 354         u32 inband_shadowed_obj_id;
 355         u32 inband_is_shrink;
 356
 357         u32 file_size_high;
 358         u32 reserved[1];
 359         int shadows_obj;        /* This object header shadows the
 360                                 specified object if > 0 */
 361
 362         /* is_shrink applies to object headers written when wemake a hole. */
 363         u32 is_shrink;
 364
 365 };
 366
 367 /*--------------------------- Tnode -------------------------- */
 368
 369 struct yaffs_tnode {
 370         struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
 371 };
 372
 373 /*------------------------  Object -----------------------------*/
 374 /* An object can be one of:
 375  * - a directory (no data, has children links
 376  * - a regular file (data.... not prunes :->).
 377  * - a symlink [symbolic link] (the alias).
 378  * - a hard link
 379  */
 380
 381 /* The file variant has three file sizes:
 382  *  - file_size : size of file as written into Yaffs - including data in cache.
 383  *  - stored_size - size of file as stored on media.
 384  *  - shrink_size - size of file that has been shrunk back to.
 385  *
 386  * The stored_size and file_size might be different because the data written
 387  * into the cache will increase the file_size but the stored_size will only
 388  * change when the data is actually stored.
 389  *
 390  */
 391 struct yaffs_file_var {
 392         loff_t file_size;
 393         loff_t stored_size;
 394         loff_t shrink_size;
 395         int top_level;
 396         struct yaffs_tnode *top;
 397 };
 398
 399 struct yaffs_dir_var {
 400         struct list_head children;      /* list of child links */
 401         struct list_head dirty; /* Entry for list of dirty directories */
 402 };
 403
 404 struct yaffs_symlink_var {
 405         YCHAR *alias;
 406 };
 407
 408 struct yaffs_hardlink_var {
 409         struct yaffs_obj *equiv_obj;
 410         u32 equiv_id;
 411 };
 412
 413 union yaffs_obj_var {
 414         struct yaffs_file_var file_variant;
 415         struct yaffs_dir_var dir_variant;
 416         struct yaffs_symlink_var symlink_variant;
 417         struct yaffs_hardlink_var hardlink_variant;
 418 };
 419
 420 struct yaffs_obj {
 421         u8 deleted:1;           /* This should only apply to unlinked files. */
 422         u8 soft_del:1;          /* it has also been soft deleted */
 423         u8 unlinked:1;          /* An unlinked file.*/
 424         u8 fake:1;              /* A fake object has no presence on NAND. */
 425         u8 rename_allowed:1;    /* Some objects cannot be renamed. */
 426         u8 unlink_allowed:1;
 427         u8 dirty:1;             /* the object needs to be written to flash */
 428         u8 valid:1;             /* When the file system is being loaded up, this
 429                                  * object might be created before the data
 430                                  * is available
 431                                  * ie. file data chunks encountered before
 432                                 * the header.
 433                                  */
 434         u8 lazy_loaded:1;       /* This object has been lazy loaded and
 435                                  * is missing some detail */
 436
 437         u8 defered_free:1;      /* Object is removed from NAND, but is
 438                                  * still in the inode cache.
 439                                  * Free of object is defered.
 440                                  * until the inode is released.
 441                                  */
 442         u8 being_created:1;     /* This object is still being created
 443                                  * so skip some verification checks. */
 444         u8 is_shadowed:1;       /* This object is shadowed on the way
 445                                  * to being renamed. */
 446
 447         u8 xattr_known:1;       /* We know if this has object has xattribs
 448                                  * or not. */
 449         u8 has_xattr:1;         /* This object has xattribs.
 450                                  * Only valid if xattr_known. */
 451
 452         u8 serial;              /* serial number of chunk in NAND.*/
 453         u16 sum;                /* sum of the name to speed searching */
 454
 455         struct yaffs_dev *my_dev;       /* The device I'm on */
 456
 457         struct list_head hash_link;     /* list of objects in hash bucket */
 458
 459         struct list_head hard_links;    /* hard linked object chain*/
 460
 461         /* directory structure stuff */
 462         /* also used for linking up the free list */
 463         struct yaffs_obj *parent;
 464         struct list_head siblings;
 465
 466         /* Where's my object header in NAND? */
 467         int hdr_chunk;
 468
 469         int n_data_chunks;      /* Number of data chunks for this file. */
 470
 471         u32 obj_id;             /* the object id value */
 472
 473         u32 yst_mode;
 474
 475         YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
 476
 477 #ifdef CONFIG_YAFFS_WINCE
 478         u32 win_ctime[2];
 479         u32 win_mtime[2];
 480         u32 win_atime[2];
 481 #else
 482         u32 yst_uid;
 483         u32 yst_gid;
 484         u32 yst_atime;
 485         u32 yst_mtime;
 486         u32 yst_ctime;
 487 #endif
 488
 489         u32 yst_rdev;
 490
 491         void *my_inode;
 492
 493         u32 variant_type; /* enum yaffs_object_type */
 494
 495         union yaffs_obj_var variant;
 496
 497 };
 498
 499 struct yaffs_obj_bucket {
 500         struct list_head list;
 501         int count;
 502 };
 503
 504
 505 /*--------------------- Temporary buffers ----------------
 506  *
 507  * These are chunk-sized working buffers. Each device has a few.
 508  */
 509
 510 struct yaffs_buffer {
 511         u8 *buffer;
 512         int in_use;
 513 };
 514
 515 /*----------------- Device ---------------------------------*/
 516
 517 struct yaffs_param {
 518         const YCHAR *name;
 519
 520         /*
 521          * Entry parameters set up way early. Yaffs sets up the rest.
 522          * The structure should be zeroed out before use so that unused
 523          * and default values are zero.
 524          */
 525
 526         int inband_tags;        /* Use unband tags */
 527         u32 total_bytes_per_chunk;      /* Should be >= 512, does not need to
 528                                          be a power of 2 */
 529         u32 chunks_per_block;   /* does not need to be a power of 2 */
 530         u32 spare_bytes_per_chunk;      /* spare area size */
 531         u32 start_block;        /* Start block we're allowed to use */
 532         u32 end_block;          /* End block we're allowed to use */
 533         u32 n_reserved_blocks;  /* Tuneable so that we can reduce
 534                                  * reserved blocks on NOR and RAM. */
 535
 536         u32 n_caches;           /* If == 0, then short op caching is disabled,
 537                                  * else the number of short op caches.
 538                                  */
 539         int cache_bypass_aligned; /* If non-zero then bypass the cache for
 540                                    * aligned writes.
 541                                    */
 542
 543         int use_nand_ecc;       /* Flag to decide whether or not to use
 544                                  * NAND driver ECC on data (yaffs1) */
 545         int tags_9bytes;        /* Use 9 byte tags */
 546         int no_tags_ecc;        /* Flag to decide whether or not to do ECC
 547                                  * on packed tags (yaffs2) */
 548
 549         int is_yaffs2;          /* Use yaffs2 mode on this device */
 550
 551         int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
 552
 553         int refresh_period;     /* How often to check for a block refresh */
 554
 555         /* Checkpoint control. Can be set before or after initialisation */
 556         u8 skip_checkpt_rd;
 557         u8 skip_checkpt_wr;
 558
 559         int enable_xattr;       /* Enable xattribs */
 560
 561         int max_objects;        /*
 562                                  * Set to limit the number of objects created.
 563                                  * 0 = no limit.
 564                                 */
 565
 566         int hide_lost_n_found;  /* Set non-zero to hide the lost-n-found dir. */
 567
 568         int stored_endian; /* 0=cpu endian, 1=little endian, 2=big endian */
 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_fn) (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         int disable_summary;
 599         int disable_bad_block_marking;
 600
 601 };
 602
 603 struct yaffs_driver {
 604         int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
 605                                    const u8 *data, int data_len,
 606                                    const u8 *oob, int oob_len);
 607         int (*drv_read_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
 608                                    u8 *data, int data_len,
 609                                    u8 *oob, int oob_len,
 610                                    enum yaffs_ecc_result *ecc_result);
 611         int (*drv_erase_fn) (struct yaffs_dev *dev, int block_no);
 612         int (*drv_mark_bad_fn) (struct yaffs_dev *dev, int block_no);
 613         int (*drv_check_bad_fn) (struct yaffs_dev *dev, int block_no);
 614         int (*drv_initialise_fn) (struct yaffs_dev *dev);
 615         int (*drv_deinitialise_fn) (struct yaffs_dev *dev);
 616 };
 617
 618 struct yaffs_tags_handler {
 619         int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
 620                                     int nand_chunk, const u8 *data,
 621                                     const struct yaffs_ext_tags *tags);
 622         int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
 623                                    int nand_chunk, u8 *data,
 624                                    struct yaffs_ext_tags *tags);
 625
 626         int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
 627                                enum yaffs_block_state *state,
 628                                u32 *seq_number);
 629         int (*mark_bad_fn) (struct yaffs_dev *dev, int block_no);
 630 };
 631
 632 struct yaffs_dev {
 633         struct yaffs_param param;
 634         struct yaffs_driver drv;
 635         struct yaffs_tags_handler tagger;
 636
 637         /* Context storage. Holds extra OS specific data for this device */
 638
 639         void *os_context;
 640         void *driver_context;
 641
 642         struct list_head dev_list;
 643
 644         int ll_init;
 645         /* Runtime parameters. Set up by YAFFS. */
 646         u32 data_bytes_per_chunk;
 647
 648         /* Non-wide tnode stuff */
 649         u16 chunk_grp_bits;     /* Number of bits that need to be resolved if
 650                                  * the tnodes are not wide enough.
 651                                  */
 652         u16 chunk_grp_size;     /* == 2^^chunk_grp_bits */
 653
 654         struct yaffs_tnode *tn_swap_buffer;
 655
 656         /* Stuff to support wide tnodes */
 657         u32 tnode_width;
 658         u32 tnode_mask;
 659         u32 tnode_size;
 660
 661         /* Stuff for figuring out file offset to chunk conversions */
 662         u32 chunk_shift;        /* Shift value */
 663         u32 chunk_div;          /* Divisor after shifting: 1 for 2^n sizes */
 664         u32 chunk_mask;         /* Mask to use for power-of-2 case */
 665
 666         int is_mounted;
 667         int read_only;
 668         int is_checkpointed;
 669         int swap_endian;        /* Stored endian needs endian swap. */
 670
 671         /* Stuff to support block offsetting to support start block zero */
 672         u32 internal_start_block;
 673         u32 internal_end_block;
 674         int block_offset;
 675         int chunk_offset;
 676
 677         /* Runtime checkpointing stuff */
 678         int checkpt_page_seq;   /* running sequence number of checkpt pages */
 679         int checkpt_byte_count;
 680         int checkpt_byte_offs;
 681         u8 *checkpt_buffer;
 682         int checkpt_open_write;
 683         u32 blocks_in_checkpt;
 684         int checkpt_cur_chunk;
 685         int checkpt_cur_block;
 686         int checkpt_next_block;
 687         int *checkpt_block_list;
 688         u32 checkpt_max_blocks;
 689         u32 checkpt_sum;
 690         u32 checkpt_xor;
 691
 692         int checkpoint_blocks_required; /* Number of blocks needed to store
 693                                          * current checkpoint set */
 694
 695         /* Block Info */
 696         struct yaffs_block_info *block_info;
 697         u8 *chunk_bits;         /* bitmap of chunks in use */
 698         u8 block_info_alt:1;    /* allocated using alternative alloc */
 699         u8 chunk_bits_alt:1;    /* allocated using alternative alloc */
 700         int chunk_bit_stride;   /* Number of bytes of chunk_bits per block.
 701                                  * Must be consistent with chunks_per_block.
 702                                  */
 703
 704         int n_erased_blocks;
 705         int alloc_block;        /* Current block being allocated off */
 706         u32 alloc_page;
 707         int alloc_block_finder; /* Used to search for next allocation block */
 708
 709         /* Object and Tnode memory management */
 710         void *allocator;
 711         int n_obj;
 712         int n_tnodes;
 713
 714         int n_hardlinks;
 715
 716         struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
 717         u32 bucket_finder;
 718
 719         int n_free_chunks;
 720
 721         /* Garbage collection control */
 722         u32 *gc_cleanup_list;   /* objects to delete at the end of a GC. */
 723         u32 n_clean_ups;
 724
 725         unsigned has_pending_prioritised_gc;    /* We think this device might
 726                                                 have pending prioritised gcs */
 727         unsigned gc_disable;
 728         unsigned gc_block_finder;
 729         unsigned gc_dirtiest;
 730         unsigned gc_pages_in_use;
 731         unsigned gc_not_done;
 732         unsigned gc_block;
 733         unsigned gc_chunk;
 734         unsigned gc_skip;
 735         struct yaffs_summary_tags *gc_sum_tags;
 736
 737         /* Special directories */
 738         struct yaffs_obj *root_dir;
 739         struct yaffs_obj *lost_n_found;
 740
 741         int buffered_block;     /* Which block is buffered here? */
 742         int doing_buffered_block_rewrite;
 743
 744         struct yaffs_cache *cache;
 745         int cache_last_use;
 746
 747         /* Stuff for background deletion and unlinked files. */
 748         struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
 749                                          files live. */
 750         struct yaffs_obj *del_dir;      /* Directory where deleted objects are
 751                                         sent to disappear. */
 752         struct yaffs_obj *unlinked_deletion;    /* Current file being
 753                                                         background deleted. */
 754         int n_deleted_files;    /* Count of files awaiting deletion; */
 755         int n_unlinked_files;   /* Count of unlinked files. */
 756         int n_bg_deletions;     /* Count of background deletions. */
 757
 758         /* Temporary buffer management */
 759         struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
 760         int max_temp;
 761         int temp_in_use;
 762         int unmanaged_buffer_allocs;
 763         int unmanaged_buffer_deallocs;
 764
 765         /* yaffs2 runtime stuff */
 766         unsigned seq_number;    /* Sequence number of currently
 767                                         allocating block */
 768         unsigned oldest_dirty_seq;
 769         unsigned oldest_dirty_block;
 770
 771         /* Block refreshing */
 772         int refresh_skip;       /* A skip down counter.
 773                                  * Refresh happens when this gets to zero. */
 774
 775         /* Dirty directory handling */
 776         struct list_head dirty_dirs;    /* List of dirty directories */
 777
 778         /* Summary */
 779         int chunks_per_summary;
 780         struct yaffs_summary_tags *sum_tags;
 781
 782         /* Statistics */
 783         u32 n_page_writes;
 784         u32 n_page_reads;
 785         u32 n_erasures;
 786         u32 n_bad_queries;
 787         u32 n_bad_markings;
 788         u32 n_erase_failures;
 789         u32 n_gc_copies;
 790         u32 all_gcs;
 791         u32 passive_gc_count;
 792         u32 oldest_dirty_gc_count;
 793         u32 n_gc_blocks;
 794         u32 bg_gcs;
 795         u32 n_retried_writes;
 796         u32 n_retired_blocks;
 797         u32 n_ecc_fixed;
 798         u32 n_ecc_unfixed;
 799         u32 n_tags_ecc_fixed;
 800         u32 n_tags_ecc_unfixed;
 801         u32 n_deletions;
 802         u32 n_unmarked_deletions;
 803         u32 refresh_count;
 804         u32 cache_hits;
 805         u32 tags_used;
 806         u32 summary_used;
 807
 808 };
 809
 810 /*
 811  * Checkpointing definitions.
 812  */
 813
 814 #define YAFFS_CHECKPOINT_VERSION        8
 815
 816 /* yaffs_checkpt_obj holds the definition of an object as dumped
 817  * by checkpointing.
 818  */
 819
 820
 821 /*  Checkpint object bits in bitfield: offset, length */
 822 #define CHECKPOINT_VARIANT_BITS         0, 3
 823 #define CHECKPOINT_DELETED_BITS         3, 1
 824 #define CHECKPOINT_SOFT_DEL_BITS        4, 1
 825 #define CHECKPOINT_UNLINKED_BITS        5, 1
 826 #define CHECKPOINT_FAKE_BITS            6, 1
 827 #define CHECKPOINT_RENAME_ALLOWED_BITS  7, 1
 828 #define CHECKPOINT_UNLINK_ALLOWED_BITS  8, 1
 829 #define CHECKPOINT_SERIAL_BITS          9, 8
 830
 831 struct yaffs_checkpt_obj {
 832         int struct_type;
 833         u32 obj_id;
 834         u32 parent_id;
 835         int hdr_chunk;
 836         u32 bit_field;
 837         int n_data_chunks;
 838         loff_t size_or_equiv_obj;
 839 };
 840
 841 /* The CheckpointDevice structure holds the device information that changes
 842  *at runtime and must be preserved over unmount/mount cycles.
 843  */
 844 struct yaffs_checkpt_dev {
 845         int struct_type;
 846         int n_erased_blocks;
 847         int alloc_block;        /* Current block being allocated off */
 848         u32 alloc_page;
 849         int n_free_chunks;
 850
 851         int n_deleted_files;    /* Count of files awaiting deletion; */
 852         int n_unlinked_files;   /* Count of unlinked files. */
 853         int n_bg_deletions;     /* Count of background deletions. */
 854
 855         /* yaffs2 runtime stuff */
 856         unsigned seq_number;    /* Sequence number of currently
 857                                  * allocating block */
 858
 859 };
 860
 861 struct yaffs_checkpt_validity {
 862         int struct_type;
 863         u32 magic;
 864         u32 version;
 865         u32 head;
 866 };
 867
 868 struct yaffs_shadow_fixer {
 869         int obj_id;
 870         int shadowed_id;
 871         struct yaffs_shadow_fixer *next;
 872 };
 873
 874 /* Structure for doing xattr modifications */
 875 struct yaffs_xattr_mod {
 876         int set;                /* If 0 then this is a deletion */
 877         const YCHAR *name;
 878         const void *data;
 879         int size;
 880         int flags;
 881         int result;
 882 };
 883
 884 /*----------------------- YAFFS Functions -----------------------*/
 885
 886 int yaffs_guts_initialise(struct yaffs_dev *dev);
 887 void yaffs_deinitialise(struct yaffs_dev *dev);
 888 void yaffs_guts_cleanup(struct yaffs_dev *dev);
 889
 890 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
 891
 892 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
 893                      struct yaffs_obj *new_dir, const YCHAR * new_name);
 894
 895 int yaffs_unlink_obj(struct yaffs_obj *obj);
 896
 897 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
 898 int yaffs_del_obj(struct yaffs_obj *obj);
 899 struct yaffs_obj *yaffs_retype_obj(struct yaffs_obj *obj,
 900                                    enum yaffs_obj_type type);
 901
 902
 903 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
 904 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
 905 int yaffs_get_obj_inode(struct yaffs_obj *obj);
 906 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
 907 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
 908
 909 /* File operations */
 910 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
 911                   int n_bytes);
 912 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
 913                   int n_bytes, int write_trhrough);
 914 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
 915
 916 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
 917                                     const YCHAR *name, u32 mode, u32 uid,
 918                                     u32 gid);
 919
 920 int yaffs_flush_file(struct yaffs_obj *in,
 921                      int update_time,
 922                      int data_sync,
 923                      int discard_cache);
 924
 925 /* Flushing and checkpointing */
 926 void yaffs_flush_whole_cache(struct yaffs_dev *dev, int discard);
 927
 928 int yaffs_checkpoint_save(struct yaffs_dev *dev);
 929 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
 930
 931 /* Directory operations */
 932 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
 933                                    u32 mode, u32 uid, u32 gid);
 934 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
 935                                      const YCHAR *name);
 936 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
 937
 938 /* Link operations */
 939 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
 940                                  struct yaffs_obj *equiv_obj);
 941
 942 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
 943
 944 /* Symlink operations */
 945 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
 946                                        const YCHAR *name, u32 mode, u32 uid,
 947                                        u32 gid, const YCHAR *alias);
 948 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
 949
 950 /* Special inodes (fifos, sockets and devices) */
 951 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
 952                                        const YCHAR *name, u32 mode, u32 uid,
 953                                        u32 gid, u32 rdev);
 954
 955 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
 956                       const void *value, int size, int flags);
 957 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
 958                       int size);
 959 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
 960 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
 961
 962 /* Special directories */
 963 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
 964 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
 965
 966 void yaffs_handle_defered_free(struct yaffs_obj *obj);
 967
 968 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
 969
 970 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
 971
 972 /* Debug dump  */
 973 int yaffs_dump_obj(struct yaffs_obj *obj);
 974
 975 void yaffs_guts_test(struct yaffs_dev *dev);
 976 int yaffs_guts_ll_init(struct yaffs_dev *dev);
 977
 978
 979 /* A few useful functions to be used within the core files*/
 980 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
 981                      int lyn);
 982 int yaffs_check_ff(u8 *buffer, int n_bytes);
 983 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
 984                               struct yaffs_block_info *bi);
 985
 986 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
 987 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
 988
 989 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
 990                                                  int number,
 991                                                  enum yaffs_obj_type type);
 992 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
 993                             int nand_chunk, int in_scan);
 994 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
 995 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
 996                                 const struct yaffs_obj_hdr *oh);
 997 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
 998 YCHAR *yaffs_clone_str(const YCHAR *str);
 999 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
1000 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
1001 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
1002                     int force, int is_shrink, int shadows,
1003                     struct yaffs_xattr_mod *xop);
1004 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
1005                                int backward_scanning);
1006 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
1007 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
1008 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
1009                                            struct yaffs_file_var *file_struct,
1010                                            u32 chunk_id,
1011                                            struct yaffs_tnode *passed_tn);
1012
1013 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
1014                      int n_bytes, int write_trhrough);
1015 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
1016 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
1017
1018 int yaffs_count_free_chunks(struct yaffs_dev *dev);
1019
1020 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
1021                                        struct yaffs_file_var *file_struct,
1022                                        u32 chunk_id);
1023
1024 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
1025                          unsigned pos);
1026
1027 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
1028
1029 int yaffs_guts_format_dev(struct yaffs_dev *dev);
1030
1031 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
1032                                 int *chunk_out, u32 *offset_out);
1033 /*
1034  * Marshalling functions to get loff_t file sizes into and out of
1035  * object headers.
1036  */
1037 void yaffs_oh_size_load(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh,
1038                         loff_t fsize, int do_endian);
1039 loff_t yaffs_oh_to_size(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh,
1040                         int do_endian);
1041 loff_t yaffs_max_file_size(struct yaffs_dev *dev);
1042
1043 /*
1044  * Debug function to count number of blocks in each state
1045  * NB Needs to be called with correct number of integers
1046  */
1047
1048 void yaffs_count_blocks_by_state(struct yaffs_dev *dev, int bs[10]);
1049
1050 int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1051                                     struct yaffs_ext_tags *tags);
1052
1053 /*
1054  * Define LOFF_T_32_BIT if a 32-bit LOFF_T is being used.
1055  * Not serious if you get this wrong - you might just get some warnings.
1056 */
1057
1058 #ifdef  LOFF_T_32_BIT
1059 #define FSIZE_LOW(fsize) (fsize)
1060 #define FSIZE_HIGH(fsize) 0
1061 #define FSIZE_COMBINE(high, low) (low)
1062 #else
1063 #define FSIZE_LOW(fsize) ((fsize) & 0xffffffff)
1064 #define FSIZE_HIGH(fsize)(((fsize) >> 32) & 0xffffffff)
1065 #define FSIZE_COMBINE(high, low) ((((loff_t) (high)) << 32) | \
1066                                         (((loff_t) (low)) & 0xFFFFFFFF))
1067 #endif
1068
1069
1070 #endif