X-Git-Url: http://www.aleph1.co.uk/gitweb/?p=yaffs2.git;a=blobdiff_plain;f=yaffs_guts.h;h=5ebc3787b4d46f905f028816ac4ed9f2a308edea;hp=60770ca7e10040e0f7da693ad833726586454433;hb=3439fa4e60dd9799766b2c101f799ed9e565b632;hpb=3ecea787c3d99a5e13bf3b826dd3ad772fbad810 diff --git a/yaffs_guts.h b/yaffs_guts.h index 60770ca..5ebc378 100644 --- a/yaffs_guts.h +++ b/yaffs_guts.h @@ -1,8 +1,7 @@ /* * YAFFS: Yet another Flash File System . A NAND-flash specific file system. * - * Copyright (C) 2002-2010 Aleph One Ltd. - * for Toby Churchill Ltd and Brightstar Engineering + * Copyright (C) 2002-2018 Aleph One Ltd. * * Created by Charles Manning * @@ -23,33 +22,50 @@ /* Give us a Y=0x59, * Give us an A=0x41, - * Give us an FF=0xFF + * Give us an FF=0xff * Give us an S=0x53 * And what have we got... */ -#define YAFFS_MAGIC 0x5941FF53 +#define YAFFS_MAGIC 0x5941ff53 -#define YAFFS_NTNODES_LEVEL0 16 +/* + * Tnodes form a tree with the tnodes in "levels" + * Levels greater than 0 hold 8 slots which point to other tnodes. + * Those at level 0 hold 16 slots which point to chunks in NAND. + * + * A maximum level of 8 thust supports files of size up to: + * + * 2^(3*MAX_LEVEL+4) + * + * Thus a max level of 8 supports files with up to 2^^28 chunks which gives + * a maximum file size of around 512Gbytees with 2k chunks. + */ +#define YAFFS_NTNODES_LEVEL0 16 #define YAFFS_TNODES_LEVEL0_BITS 4 #define YAFFS_TNODES_LEVEL0_MASK 0xf -#define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2) -#define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1) +#define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2) +#define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1) #define YAFFS_TNODES_INTERNAL_MASK 0x7 -#define YAFFS_TNODES_MAX_LEVEL 6 +#define YAFFS_TNODES_MAX_LEVEL 8 +#define YAFFS_TNODES_MAX_BITS (YAFFS_TNODES_LEVEL0_BITS + \ + YAFFS_TNODES_INTERNAL_BITS * \ + YAFFS_TNODES_MAX_LEVEL) +#define YAFFS_MAX_CHUNK_ID ((1 << YAFFS_TNODES_MAX_BITS) - 1) + +#define YAFFS_MAX_FILE_SIZE_32 0x7fffffff -#ifndef CONFIG_YAFFS_NO_YAFFS1 +/* Constants for YAFFS1 mode */ #define YAFFS_BYTES_PER_SPARE 16 #define YAFFS_BYTES_PER_CHUNK 512 #define YAFFS_CHUNK_SIZE_SHIFT 9 #define YAFFS_CHUNKS_PER_BLOCK 32 -#define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK) -#endif +#define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK) -#define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024 +#define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32 -#define YAFFS_MAX_CHUNK_ID 0x000FFFFF + #define YAFFS_ALLOCATION_NOBJECTS 100 #define YAFFS_ALLOCATION_NTNODES 100 @@ -58,9 +74,10 @@ #define YAFFS_NOBJECT_BUCKETS 256 #define YAFFS_OBJECT_SPACE 0x40000 -#define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE -1) +#define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE - 1) -#define YAFFS_CHECKPOINT_VERSION 4 +/* Binary data version stamps */ +#define YAFFS_SUMMARY_VERSION 1 #ifdef CONFIG_YAFFS_UNICODE #define YAFFS_MAX_NAME_LENGTH 127 @@ -78,10 +95,12 @@ #define YAFFS_OBJECTID_UNLINKED 3 #define YAFFS_OBJECTID_DELETED 4 +/* Fake object Id for summary data */ +#define YAFFS_OBJECTID_SUMMARY 0x10 + /* Pseudo object ids for checkpointing */ -#define YAFFS_OBJECTID_SB_HEADER 0x10 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20 -#define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21 +#define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21 #define YAFFS_MAX_SHORT_OP_CACHES 20 @@ -97,14 +116,14 @@ * The range is limited slightly to help distinguish bad numbers from good. * This also allows us to perhaps in the future use special numbers for * special purposes. - * EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years, + * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years, * and is a larger number than the lifetime of a 2GB device. */ #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000 -#define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xEFFFFF00 +#define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xefffff00 /* Special sequence number for bad block that failed to be marked bad */ -#define YAFFS_SEQUENCE_BAD_BLOCK 0xFFFF0000 +#define YAFFS_SEQUENCE_BAD_BLOCK 0xffff0000 /* ChunkCache is used for short read/write operations.*/ struct yaffs_cache { @@ -117,27 +136,26 @@ struct yaffs_cache { u8 *data; }; -/* Tags structures in RAM - * NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise - * the structure size will get blown out. +/* yaffs1 tags structures in RAM + * NB This uses bitfield. Bitfields should not straddle a u32 boundary + * otherwise the structure size will get blown out. */ -#ifndef CONFIG_YAFFS_NO_YAFFS1 struct yaffs_tags { - unsigned chunk_id:20; - unsigned serial_number:2; - unsigned n_bytes_lsb:10; - unsigned obj_id:18; - unsigned ecc:12; - unsigned n_bytes_msb:2; + u32 chunk_id:20; + u32 serial_number:2; + u32 n_bytes_lsb:10; + u32 obj_id:18; + u32 ecc:12; + u32 n_bytes_msb:2; }; union yaffs_tags_union { struct yaffs_tags as_tags; - u8 as_bytes[8]; + u8 as_bytes[8]; + u32 as_u32[2]; }; -#endif /* Stuff used for extended tags in YAFFS2 */ @@ -148,6 +166,12 @@ enum yaffs_ecc_result { YAFFS_ECC_RESULT_UNFIXED }; +/* + * Object type enum: + * When this is stored in flash we store it as a u32 instead + * to prevent any alignment change issues as compiler variants change. + */ + enum yaffs_obj_type { YAFFS_OBJECT_TYPE_UNKNOWN, YAFFS_OBJECT_TYPE_FILE, @@ -160,11 +184,9 @@ enum yaffs_obj_type { #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL struct yaffs_ext_tags { - - unsigned validity0; unsigned chunk_used; /* Status of the chunk: used or unused */ - unsigned obj_id; /* If 0 then this is not part of an object (unused) */ - unsigned chunk_id; /* If 0 then this is a header, else a data chunk */ + unsigned obj_id; /* If 0 this is not used */ + unsigned chunk_id; /* If 0 this is a header, else a data chunk */ unsigned n_bytes; /* Only valid for data chunks */ /* The following stuff only has meaning when we read */ @@ -180,18 +202,15 @@ struct yaffs_ext_tags { /* Extra info if this is an object header (YAFFS2 only) */ - unsigned extra_available; /* There is extra info available if this is not zero */ + unsigned extra_available; /* Extra info available if not zero */ unsigned extra_parent_id; /* The parent object */ unsigned extra_is_shrink; /* Is it a shrink header? */ unsigned extra_shadows; /* Does this shadow another object? */ enum yaffs_obj_type extra_obj_type; /* What object type? */ - unsigned extra_length; /* Length if it is a file */ - unsigned extra_equiv_id; /* Equivalent object Id if it is a hard link */ - - unsigned validity1; - + loff_t extra_file_size; /* Length if it is a file */ + unsigned extra_equiv_id; /* Equivalent object for a hard link */ }; /* Spare structure for YAFFS1 */ @@ -225,12 +244,15 @@ enum yaffs_block_state { YAFFS_BLOCK_STATE_SCANNING, /* Being scanned */ - YAFFS_BLOCK_STATE_NEEDS_SCANNING, - /* The block might have something on it (ie it is allocating or full, perhaps empty) - * but it needs to be scanned to determine its true state. + YAFFS_BLOCK_STATE_NEEDS_SCAN, + /* The block might have something on it (ie it is allocating or full, + * perhaps empty) but it needs to be scanned to determine its true + * state. * This state is only valid during scanning. - * NB We tolerate empty because the pre-scanner might be incapable of deciding - * However, if this state is returned on a YAFFS2 device, then we expect a sequence number + * NB We tolerate empty because the pre-scanner might be incapable of + * deciding + * However, if this state is returned on a YAFFS2 device, + * then we expect a sequence number */ YAFFS_BLOCK_STATE_EMPTY, @@ -241,7 +263,8 @@ enum yaffs_block_state { * At least one page holds valid data. * This is the one currently being used for page * allocation. Should never be more than one of these. - * If a block is only partially allocated at mount it is treated as full. + * If a block is only partially allocated at mount it is treated as + * full. */ YAFFS_BLOCK_STATE_FULL, @@ -269,35 +292,42 @@ enum yaffs_block_state { struct yaffs_block_info { - int soft_del_pages:10; /* number of soft deleted pages */ - int pages_in_use:10; /* number of pages in use */ - unsigned block_state:4; /* One of the above block states. NB use unsigned because enum is sometimes an int */ - u32 needs_retiring:1; /* Data has failed on this block, need to get valid data off */ - /* and retire the block. */ - u32 skip_erased_check:1; /* If this is set we can skip the erased check on this block */ - u32 gc_prioritise:1; /* An ECC check or blank check has failed on this block. - It should be prioritised for GC */ - u32 chunk_error_strikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */ - -#ifdef CONFIG_YAFFS_YAFFS2 - u32 has_shrink_hdr:1; /* This block has at least one shrink object header */ + s32 soft_del_pages:10; /* number of soft deleted pages */ + s32 pages_in_use:10; /* number of pages in use */ + u32 block_state:4; /* One of the above block states. */ + /* NB use unsigned because enum is sometimes + * an int */ + u32 needs_retiring:1; /* Data has failed on this block, */ + /*need to get valid data off and retire*/ + u32 skip_erased_check:1;/* Skip the erased check on this block */ + u32 gc_prioritise:1; /* An ECC check or blank check has failed. + Block should be prioritised for GC */ + u32 chunk_error_strikes:3; /* How many times we've had ecc etc + failures on this block and tried to reuse it */ + u32 has_summary:1; /* The block has a summary */ + + u32 has_shrink_hdr:1; /* This block has at least one shrink header */ u32 seq_number; /* block sequence number for yaffs2 */ -#endif }; +union yaffs_block_info_union { + struct yaffs_block_info bi; + u32 as_u32[2]; +}; + /* -------------------------- Object structure -------------------------------*/ /* This is the object structure as stored on NAND */ struct yaffs_obj_hdr { - enum yaffs_obj_type type; + u32 type; /* enum yaffs_obj_type */ /* Apply to everything */ - int parent_obj_id; + u32 parent_obj_id; u16 sum_no_longer_used; /* checksum of name. No longer used */ YCHAR name[YAFFS_MAX_NAME_LENGTH + 1]; - /* The following apply to directories, files, symlinks - not hard links */ + /* The following apply to all object types except for hard links */ u32 yst_mode; /* protection */ u32 yst_uid; @@ -307,7 +337,7 @@ struct yaffs_obj_hdr { u32 yst_ctime; /* File size applies to files only */ - int file_size; + u32 file_size_low; /* Equivalent object id applies to hard links only. */ int equiv_id; @@ -315,7 +345,7 @@ struct yaffs_obj_hdr { /* Alias is for symlinks only. */ YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1]; - u32 yst_rdev; /* device stuff for block and char devices (major/min) */ + u32 yst_rdev; /* stuff for block and char devices (major/min) */ u32 win_ctime[2]; u32 win_atime[2]; @@ -324,10 +354,12 @@ struct yaffs_obj_hdr { u32 inband_shadowed_obj_id; u32 inband_is_shrink; - u32 reserved[2]; - int shadows_obj; /* This object header shadows the specified object if > 0 */ + u32 file_size_high; + u32 reserved[1]; + int shadows_obj; /* This object header shadows the + specified object if > 0 */ - /* is_shrink applies to object headers written when we shrink the file (ie resize) */ + /* is_shrink applies to object headers written when wemake a hole. */ u32 is_shrink; }; @@ -346,10 +378,20 @@ struct yaffs_tnode { * - a hard link */ +/* The file variant has three file sizes: + * - file_size : size of file as written into Yaffs - including data in cache. + * - stored_size - size of file as stored on media. + * - shrink_size - size of file that has been shrunk back to. + * + * The stored_size and file_size might be different because the data written + * into the cache will increase the file_size but the stored_size will only + * change when the data is actually stored. + * + */ struct yaffs_file_var { - u32 file_size; - u32 scanned_size; - u32 shrink_size; + loff_t file_size; + loff_t stored_size; + loff_t shrink_size; int top_level; struct yaffs_tnode *top; }; @@ -378,35 +420,43 @@ union yaffs_obj_var { struct yaffs_obj { u8 deleted:1; /* This should only apply to unlinked files. */ u8 soft_del:1; /* it has also been soft deleted */ - u8 unlinked:1; /* An unlinked file. The file should be in the unlinked directory. */ + u8 unlinked:1; /* An unlinked file.*/ u8 fake:1; /* A fake object has no presence on NAND. */ - u8 rename_allowed:1; /* Some objects are not allowed to be renamed. */ + u8 rename_allowed:1; /* Some objects cannot be renamed. */ u8 unlink_allowed:1; u8 dirty:1; /* the object needs to be written to flash */ u8 valid:1; /* When the file system is being loaded up, this * object might be created before the data - * is available (ie. file data records appear before the header). + * is available + * ie. file data chunks encountered before + * the header. */ - u8 lazy_loaded:1; /* This object has been lazy loaded and is missing some detail */ + u8 lazy_loaded:1; /* This object has been lazy loaded and + * is missing some detail */ - u8 defered_free:1; /* For Linux kernel. Object is removed from NAND, but is - * still in the inode cache. Free of object is defered. + u8 defered_free:1; /* Object is removed from NAND, but is + * still in the inode cache. + * Free of object is defered. * until the inode is released. */ - u8 being_created:1; /* This object is still being created so skip some checks. */ - u8 is_shadowed:1; /* This object is shadowed on the way to being renamed. */ + u8 being_created:1; /* This object is still being created + * so skip some verification checks. */ + u8 is_shadowed:1; /* This object is shadowed on the way + * to being renamed. */ - u8 xattr_known:1; /* We know if this has object has xattribs or not. */ - u8 has_xattr:1; /* This object has xattribs. Valid if xattr_known. */ + u8 xattr_known:1; /* We know if this has object has xattribs + * or not. */ + u8 has_xattr:1; /* This object has xattribs. + * Only valid if xattr_known. */ - u8 serial; /* serial number of chunk in NAND. Cached here */ + u8 serial; /* serial number of chunk in NAND.*/ u16 sum; /* sum of the name to speed searching */ struct yaffs_dev *my_dev; /* The device I'm on */ - struct list_head hash_link; /* list of objects in this hash bucket */ + struct list_head hash_link; /* list of objects in hash bucket */ - struct list_head hard_links; /* all the equivalent hard linked objects */ + struct list_head hard_links; /* hard linked object chain*/ /* directory structure stuff */ /* also used for linking up the free list */ @@ -416,15 +466,13 @@ struct yaffs_obj { /* Where's my object header in NAND? */ int hdr_chunk; - int n_data_chunks; /* Number of data chunks attached to the file. */ + int n_data_chunks; /* Number of data chunks for this file. */ u32 obj_id; /* the object id value */ u32 yst_mode; -#ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1]; -#endif #ifdef CONFIG_YAFFS_WINCE u32 win_ctime[2]; @@ -442,7 +490,7 @@ struct yaffs_obj { void *my_inode; - enum yaffs_obj_type variant_type; + u32 variant_type; /* enum yaffs_object_type */ union yaffs_obj_var variant; @@ -453,36 +501,15 @@ struct yaffs_obj_bucket { int count; }; -/* yaffs_checkpt_obj holds the definition of an object as dumped - * by checkpointing. - */ - -struct yaffs_checkpt_obj { - int struct_type; - u32 obj_id; - u32 parent_id; - int hdr_chunk; - enum yaffs_obj_type variant_type:3; - u8 deleted:1; - u8 soft_del:1; - u8 unlinked:1; - u8 fake:1; - u8 rename_allowed:1; - u8 unlink_allowed:1; - u8 serial; - int n_data_chunks; - u32 size_or_equiv_obj; -}; /*--------------------- Temporary buffers ---------------- * - * These are chunk-sized working buffers. Each device has a few + * These are chunk-sized working buffers. Each device has a few. */ struct yaffs_buffer { u8 *buffer; - int line; /* track from whence this buffer was allocated */ - int max_line; + int in_use; }; /*----------------- Device ---------------------------------*/ @@ -493,30 +520,37 @@ struct yaffs_param { /* * Entry parameters set up way early. Yaffs sets up the rest. * The structure should be zeroed out before use so that unused - * and defualt values are zero. + * and default values are zero. */ int inband_tags; /* Use unband tags */ - u32 total_bytes_per_chunk; /* Should be >= 512, does not need to be a power of 2 */ - int chunks_per_block; /* does not need to be a power of 2 */ - int spare_bytes_per_chunk; /* spare area size */ - int start_block; /* Start block we're allowed to use */ - int end_block; /* End block we're allowed to use */ - int n_reserved_blocks; /* We want this tuneable so that we can reduce */ - /* reserved blocks on NOR and RAM. */ - - int n_caches; /* If <= 0, then short op caching is disabled, else - * the number of short op caches (don't use too many). - * 10 to 20 is a good bet. + u32 total_bytes_per_chunk; /* Should be >= 512, does not need to + be a power of 2 */ + u32 chunks_per_block; /* does not need to be a power of 2 */ + u32 spare_bytes_per_chunk; /* spare area size */ + u32 start_block; /* Start block we're allowed to use */ + u32 end_block; /* End block we're allowed to use */ + u32 n_reserved_blocks; /* Tuneable so that we can reduce + * reserved blocks on NOR and RAM. */ + + u32 n_caches; /* If == 0, then short op caching is disabled, + * else the number of short op caches. */ - int use_nand_ecc; /* Flag to decide whether or not to use NANDECC on data (yaffs1) */ - int no_tags_ecc; /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */ + int cache_bypass_aligned; /* If non-zero then bypass the cache for + * aligned writes. + */ + + int use_nand_ecc; /* Flag to decide whether or not to use + * NAND driver ECC on data (yaffs1) */ + int tags_9bytes; /* Use 9 byte tags */ + int no_tags_ecc; /* Flag to decide whether or not to do ECC + * on packed tags (yaffs2) */ int is_yaffs2; /* Use yaffs2 mode on this device */ int empty_lost_n_found; /* Auto-empty lost+found directory on mount */ - int refresh_period; /* How often we should check to do a block refresh */ + int refresh_period; /* How often to check for a block refresh */ /* Checkpoint control. Can be set before or after initialisation */ u8 skip_checkpt_rd; @@ -524,49 +558,35 @@ struct yaffs_param { int enable_xattr; /* Enable xattribs */ - /* NAND access functions (Must be set before calling YAFFS) */ - - int (*write_chunk_fn) (struct yaffs_dev * dev, - int nand_chunk, const u8 * data, - const struct yaffs_spare * spare); - int (*read_chunk_fn) (struct yaffs_dev * dev, - int nand_chunk, u8 * data, - struct yaffs_spare * spare); - int (*erase_fn) (struct yaffs_dev * dev, int flash_block); - int (*initialise_flash_fn) (struct yaffs_dev * dev); - int (*deinitialise_flash_fn) (struct yaffs_dev * dev); - -#ifdef CONFIG_YAFFS_YAFFS2 - int (*write_chunk_tags_fn) (struct yaffs_dev * dev, - int nand_chunk, const u8 * data, - const struct yaffs_ext_tags * tags); - int (*read_chunk_tags_fn) (struct yaffs_dev * dev, - int nand_chunk, u8 * data, - struct yaffs_ext_tags * tags); - int (*bad_block_fn) (struct yaffs_dev * dev, int block_no); - int (*query_block_fn) (struct yaffs_dev * dev, int block_no, - enum yaffs_block_state * state, - u32 * seq_number); -#endif + int max_objects; /* + * Set to limit the number of objects created. + * 0 = no limit. + */ + + int hide_lost_n_found; /* Set non-zero to hide the lost-n-found dir. */ + + int stored_endian; /* 0=cpu endian, 1=little endian, 2=big endian */ /* The remove_obj_fn function must be supplied by OS flavours that * need it. * yaffs direct uses it to implement the faster readdir. * Linux uses it to protect the directory during unlocking. */ - void (*remove_obj_fn) (struct yaffs_obj * obj); + void (*remove_obj_fn) (struct yaffs_obj *obj); /* Callback to mark the superblock dirty */ - void (*sb_dirty_fn) (struct yaffs_dev * dev); + void (*sb_dirty_fn) (struct yaffs_dev *dev); /* Callback to control garbage collection. */ - unsigned (*gc_control) (struct yaffs_dev * dev); + unsigned (*gc_control_fn) (struct yaffs_dev *dev); /* Debug control flags. Don't use unless you know what you're doing */ - int use_header_file_size; /* Flag to determine if we should use file sizes from the header */ + int use_header_file_size; /* Flag to determine if we should use + * file sizes from the header */ int disable_lazy_load; /* Disable lazy loading on this device */ int wide_tnodes_disabled; /* Set to disable wide tnodes */ - int disable_soft_del; /* yaffs 1 only: Set to disable the use of softdeletion. */ + int disable_soft_del; /* yaffs 1 only: Set to disable the use of + * softdeletion. */ int defered_dir_update; /* Set to defer directory updates */ @@ -574,10 +594,45 @@ struct yaffs_param { int auto_unicode; #endif int always_check_erased; /* Force chunk erased check always on */ + + int disable_summary; + int disable_bad_block_marking; + +}; + +struct yaffs_driver { + int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk, + const u8 *data, int data_len, + const u8 *oob, int oob_len); + int (*drv_read_chunk_fn) (struct yaffs_dev *dev, int nand_chunk, + u8 *data, int data_len, + u8 *oob, int oob_len, + enum yaffs_ecc_result *ecc_result); + int (*drv_erase_fn) (struct yaffs_dev *dev, int block_no); + int (*drv_mark_bad_fn) (struct yaffs_dev *dev, int block_no); + int (*drv_check_bad_fn) (struct yaffs_dev *dev, int block_no); + int (*drv_initialise_fn) (struct yaffs_dev *dev); + int (*drv_deinitialise_fn) (struct yaffs_dev *dev); +}; + +struct yaffs_tags_handler { + int (*write_chunk_tags_fn) (struct yaffs_dev *dev, + int nand_chunk, const u8 *data, + const struct yaffs_ext_tags *tags); + int (*read_chunk_tags_fn) (struct yaffs_dev *dev, + int nand_chunk, u8 *data, + struct yaffs_ext_tags *tags); + + int (*query_block_fn) (struct yaffs_dev *dev, int block_no, + enum yaffs_block_state *state, + u32 *seq_number); + int (*mark_bad_fn) (struct yaffs_dev *dev, int block_no); }; struct yaffs_dev { struct yaffs_param param; + struct yaffs_driver drv; + struct yaffs_tags_handler tagger; /* Context storage. Holds extra OS specific data for this device */ @@ -586,8 +641,9 @@ struct yaffs_dev { struct list_head dev_list; + int ll_init; /* Runtime parameters. Set up by YAFFS. */ - int data_bytes_per_chunk; + u32 data_bytes_per_chunk; /* Non-wide tnode stuff */ u16 chunk_grp_bits; /* Number of bits that need to be resolved if @@ -595,6 +651,8 @@ struct yaffs_dev { */ u16 chunk_grp_size; /* == 2^^chunk_grp_bits */ + struct yaffs_tnode *tn_swap_buffer; + /* Stuff to support wide tnodes */ u32 tnode_width; u32 tnode_mask; @@ -602,41 +660,43 @@ struct yaffs_dev { /* Stuff for figuring out file offset to chunk conversions */ u32 chunk_shift; /* Shift value */ - u32 chunk_div; /* Divisor after shifting: 1 for power-of-2 sizes */ + u32 chunk_div; /* Divisor after shifting: 1 for 2^n sizes */ u32 chunk_mask; /* Mask to use for power-of-2 case */ int is_mounted; int read_only; int is_checkpointed; + int swap_endian; /* Stored endian needs endian swap. */ /* Stuff to support block offsetting to support start block zero */ - int internal_start_block; - int internal_end_block; + u32 internal_start_block; + u32 internal_end_block; int block_offset; int chunk_offset; /* Runtime checkpointing stuff */ - int checkpt_page_seq; /* running sequence number of checkpoint pages */ + int checkpt_page_seq; /* running sequence number of checkpt pages */ int checkpt_byte_count; int checkpt_byte_offs; u8 *checkpt_buffer; int checkpt_open_write; - int blocks_in_checkpt; + u32 blocks_in_checkpt; int checkpt_cur_chunk; int checkpt_cur_block; int checkpt_next_block; int *checkpt_block_list; - int checkpt_max_blocks; + u32 checkpt_max_blocks; u32 checkpt_sum; u32 checkpt_xor; - int checkpoint_blocks_required; /* Number of blocks needed to store current checkpoint set */ + int checkpoint_blocks_required; /* Number of blocks needed to store + * current checkpoint set */ /* Block Info */ struct yaffs_block_info *block_info; u8 *chunk_bits; /* bitmap of chunks in use */ - unsigned block_info_alt:1; /* was allocated using alternative strategy */ - unsigned chunk_bits_alt:1; /* was allocated using alternative strategy */ + u8 block_info_alt:1; /* allocated using alternative alloc */ + u8 chunk_bits_alt:1; /* allocated using alternative alloc */ int chunk_bit_stride; /* Number of bytes of chunk_bits per block. * Must be consistent with chunks_per_block. */ @@ -662,7 +722,8 @@ struct yaffs_dev { u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */ u32 n_clean_ups; - unsigned has_pending_prioritised_gc; /* We think this device might have pending prioritised gcs */ + unsigned has_pending_prioritised_gc; /* We think this device might + have pending prioritised gcs */ unsigned gc_disable; unsigned gc_block_finder; unsigned gc_dirtiest; @@ -671,16 +732,12 @@ struct yaffs_dev { unsigned gc_block; unsigned gc_chunk; unsigned gc_skip; + struct yaffs_summary_tags *gc_sum_tags; /* Special directories */ struct yaffs_obj *root_dir; struct yaffs_obj *lost_n_found; - /* Buffer areas for storing data to recover from write failures TODO - * u8 buffered_data[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK]; - * struct yaffs_spare buffered_spare[YAFFS_CHUNKS_PER_BLOCK]; - */ - int buffered_block; /* Which block is buffered here? */ int doing_buffered_block_rewrite; @@ -688,9 +745,12 @@ struct yaffs_dev { int cache_last_use; /* Stuff for background deletion and unlinked files. */ - struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted files live. */ - struct yaffs_obj *del_dir; /* Directory where deleted objects are sent to disappear. */ - struct yaffs_obj *unlinked_deletion; /* Current file being background deleted. */ + struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted + files live. */ + struct yaffs_obj *del_dir; /* Directory where deleted objects are + sent to disappear. */ + struct yaffs_obj *unlinked_deletion; /* Current file being + background deleted. */ int n_deleted_files; /* Count of files awaiting deletion; */ int n_unlinked_files; /* Count of unlinked files. */ int n_bg_deletions; /* Count of background deletions. */ @@ -703,20 +763,28 @@ struct yaffs_dev { int unmanaged_buffer_deallocs; /* yaffs2 runtime stuff */ - unsigned seq_number; /* Sequence number of currently allocating block */ + unsigned seq_number; /* Sequence number of currently + allocating block */ unsigned oldest_dirty_seq; unsigned oldest_dirty_block; /* Block refreshing */ - int refresh_skip; /* A skip down counter. Refresh happens when this gets to zero. */ + int refresh_skip; /* A skip down counter. + * Refresh happens when this gets to zero. */ /* Dirty directory handling */ struct list_head dirty_dirs; /* List of dirty directories */ - /* Statistcs */ + /* Summary */ + int chunks_per_summary; + struct yaffs_summary_tags *sum_tags; + + /* Statistics */ u32 n_page_writes; u32 n_page_reads; u32 n_erasures; + u32 n_bad_queries; + u32 n_bad_markings; u32 n_erase_failures; u32 n_gc_copies; u32 all_gcs; @@ -724,7 +792,7 @@ struct yaffs_dev { u32 oldest_dirty_gc_count; u32 n_gc_blocks; u32 bg_gcs; - u32 n_retired_writes; + u32 n_retried_writes; u32 n_retired_blocks; u32 n_ecc_fixed; u32 n_ecc_unfixed; @@ -734,11 +802,44 @@ struct yaffs_dev { u32 n_unmarked_deletions; u32 refresh_count; u32 cache_hits; + u32 tags_used; + u32 summary_used; + +}; + +/* + * Checkpointing definitions. + */ +#define YAFFS_CHECKPOINT_VERSION 8 + +/* yaffs_checkpt_obj holds the definition of an object as dumped + * by checkpointing. + */ + + +/* Checkpint object bits in bitfield: offset, length */ +#define CHECKPOINT_VARIANT_BITS 0, 3 +#define CHECKPOINT_DELETED_BITS 3, 1 +#define CHECKPOINT_SOFT_DEL_BITS 4, 1 +#define CHECKPOINT_UNLINKED_BITS 5, 1 +#define CHECKPOINT_FAKE_BITS 6, 1 +#define CHECKPOINT_RENAME_ALLOWED_BITS 7, 1 +#define CHECKPOINT_UNLINK_ALLOWED_BITS 8, 1 +#define CHECKPOINT_SERIAL_BITS 9, 8 + +struct yaffs_checkpt_obj { + int struct_type; + u32 obj_id; + u32 parent_id; + int hdr_chunk; + u32 bit_field; + int n_data_chunks; + loff_t size_or_equiv_obj; }; -/* The CheckpointDevice structure holds the device information that changes at runtime and - * must be preserved over unmount/mount cycles. +/* The CheckpointDevice structure holds the device information that changes + *at runtime and must be preserved over unmount/mount cycles. */ struct yaffs_checkpt_dev { int struct_type; @@ -752,7 +853,8 @@ struct yaffs_checkpt_dev { int n_bg_deletions; /* Count of background deletions. */ /* yaffs2 runtime stuff */ - unsigned seq_number; /* Sequence number of currently allocating block */ + unsigned seq_number; /* Sequence number of currently + * allocating block */ }; @@ -789,11 +891,16 @@ int yaffs_get_n_free_chunks(struct yaffs_dev *dev); int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name, struct yaffs_obj *new_dir, const YCHAR * new_name); +int yaffs_unlink_obj(struct yaffs_obj *obj); + int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name); int yaffs_del_obj(struct yaffs_obj *obj); +struct yaffs_obj *yaffs_retype_obj(struct yaffs_obj *obj, + enum yaffs_obj_type type); + int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size); -int yaffs_get_obj_length(struct yaffs_obj *obj); +loff_t yaffs_get_obj_length(struct yaffs_obj *obj); int yaffs_get_obj_inode(struct yaffs_obj *obj); unsigned yaffs_get_obj_type(struct yaffs_obj *obj); int yaffs_get_obj_link_count(struct yaffs_obj *obj); @@ -806,47 +913,50 @@ int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset, int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size); struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent, - const YCHAR * name, u32 mode, u32 uid, + const YCHAR *name, u32 mode, u32 uid, u32 gid); -int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync); +int yaffs_flush_file(struct yaffs_obj *in, + int update_time, + int data_sync, + int discard_cache); /* Flushing and checkpointing */ -void yaffs_flush_whole_cache(struct yaffs_dev *dev); +void yaffs_flush_whole_cache(struct yaffs_dev *dev, int discard); int yaffs_checkpoint_save(struct yaffs_dev *dev); int yaffs_checkpoint_restore(struct yaffs_dev *dev); /* Directory operations */ -struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR * name, +struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name, u32 mode, u32 uid, u32 gid); struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir, - const YCHAR * name); + const YCHAR *name); struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number); /* Link operations */ -struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR * name, +struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name, struct yaffs_obj *equiv_obj); struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj); /* Symlink operations */ struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent, - const YCHAR * name, u32 mode, u32 uid, - u32 gid, const YCHAR * alias); + const YCHAR *name, u32 mode, u32 uid, + u32 gid, const YCHAR *alias); YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj); /* Special inodes (fifos, sockets and devices) */ struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent, - const YCHAR * name, u32 mode, u32 uid, + const YCHAR *name, u32 mode, u32 uid, u32 gid, u32 rdev); -int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR * name, +int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name, const void *value, int size, int flags); -int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR * name, void *value, +int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value, int size); int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size); -int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR * name); +int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name); /* Special directories */ struct yaffs_obj *yaffs_root(struct yaffs_dev *dev); @@ -862,30 +972,32 @@ int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency); int yaffs_dump_obj(struct yaffs_obj *obj); void yaffs_guts_test(struct yaffs_dev *dev); +int yaffs_guts_ll_init(struct yaffs_dev *dev); + /* A few useful functions to be used within the core files*/ void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash, int lyn); -int yaffs_check_ff(u8 * buffer, int n_bytes); +int yaffs_check_ff(u8 *buffer, int n_bytes); void yaffs_handle_chunk_error(struct yaffs_dev *dev, struct yaffs_block_info *bi); -u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev, int line_no); -void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 * buffer, int line_no); +u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev); +void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer); struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev, int number, enum yaffs_obj_type type); int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk, int nand_chunk, int in_scan); -void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR * name); +void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name); void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj, const struct yaffs_obj_hdr *oh); void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj); -YCHAR *yaffs_clone_str(const YCHAR * str); -void yaffs_link_fixup(struct yaffs_dev *dev, struct yaffs_obj *hard_list); +YCHAR *yaffs_clone_str(const YCHAR *str); +void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list); void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no); -int yaffs_update_oh(struct yaffs_obj *in, const YCHAR * name, +int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name, int force, int is_shrink, int shadows, struct yaffs_xattr_mod *xop); void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id, @@ -897,7 +1009,7 @@ struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev, u32 chunk_id, struct yaffs_tnode *passed_tn); -int yaffs_do_file_wr(struct yaffs_obj *in, const u8 * buffer, loff_t offset, +int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset, int n_bytes, int write_trhrough); void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size); void yaffs_skip_rest_of_block(struct yaffs_dev *dev); @@ -911,4 +1023,47 @@ struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev, u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn, unsigned pos); +int yaffs_is_non_empty_dir(struct yaffs_obj *obj); + +int yaffs_guts_format_dev(struct yaffs_dev *dev); + +void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr, + int *chunk_out, u32 *offset_out); +/* + * Marshalling functions to get loff_t file sizes into and out of + * object headers. + */ +void yaffs_oh_size_load(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh, + loff_t fsize, int do_endian); +loff_t yaffs_oh_to_size(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh, + int do_endian); +loff_t yaffs_max_file_size(struct yaffs_dev *dev); + +/* + * Debug function to count number of blocks in each state + * NB Needs to be called with correct number of integers + */ + +void yaffs_count_blocks_by_state(struct yaffs_dev *dev, int bs[10]); + +int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk, + struct yaffs_ext_tags *tags); + +/* + * Define LOFF_T_32_BIT if a 32-bit LOFF_T is being used. + * Not serious if you get this wrong - you might just get some warnings. +*/ + +#ifdef LOFF_T_32_BIT +#define FSIZE_LOW(fsize) (fsize) +#define FSIZE_HIGH(fsize) 0 +#define FSIZE_COMBINE(high, low) (low) +#else +#define FSIZE_LOW(fsize) ((fsize) & 0xffffffff) +#define FSIZE_HIGH(fsize)(((fsize) >> 32) & 0xffffffff) +#define FSIZE_COMBINE(high, low) ((((loff_t) (high)) << 32) | \ + (((loff_t) (low)) & 0xFFFFFFFF)) +#endif + + #endif