X-Git-Url: http://www.aleph1.co.uk/gitweb/?p=yaffs2.git;a=blobdiff_plain;f=yaffs_guts.h;h=643e5750954784e1cfb2cdd2a5ac6f4268eb4c76;hp=e4680e819e4610e54a8759855d8600b9cae14450;hb=e81a96058aa89f6812e3c5224e26b4b44da3c143;hpb=46eb953ecab322d3385ccf84c75d969de8542317 diff --git a/yaffs_guts.h b/yaffs_guts.h index e4680e8..643e575 100644 --- a/yaffs_guts.h +++ b/yaffs_guts.h @@ -1,7 +1,7 @@ /* * YAFFS: Yet another Flash File System . A NAND-flash specific file system. * - * Copyright (C) 2002-2010 Aleph One Ltd. + * Copyright (C) 2002-2011 Aleph One Ltd. * for Toby Churchill Ltd and Brightstar Engineering * * Created by Charles Manning @@ -23,12 +23,24 @@ /* 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 +/* + * 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 arounf 51Gbytees with 2k chunks. + */ #define YAFFS_NTNODES_LEVEL0 16 #define YAFFS_TNODES_LEVEL0_BITS 4 #define YAFFS_TNODES_LEVEL0_MASK 0xf @@ -36,20 +48,25 @@ #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_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 @@ -60,7 +77,9 @@ #define YAFFS_OBJECT_SPACE 0x40000 #define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE - 1) -#define YAFFS_CHECKPOINT_VERSION 4 +/* Binary data version stamps */ +#define YAFFS_SUMMARY_VERSION 1 +#define YAFFS_CHECKPOINT_VERSION 7 #ifdef CONFIG_YAFFS_UNICODE #define YAFFS_MAX_NAME_LENGTH 127 @@ -78,10 +97,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 @@ -101,10 +122,10 @@ * 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,12 +138,11 @@ struct yaffs_cache { u8 *data; }; -/* Tags structures in RAM +/* 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; @@ -137,7 +157,6 @@ union yaffs_tags_union { u8 as_bytes[8]; }; -#endif /* Stuff used for extended tags in YAFFS2 */ @@ -160,8 +179,6 @@ 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 this is not used */ unsigned chunk_id; /* If 0 this is a header, else a data chunk */ @@ -187,11 +204,8 @@ struct yaffs_ext_tags { enum yaffs_obj_type extra_obj_type; /* What object type? */ - unsigned extra_length; /* Length if it is a file */ + loff_t extra_file_size; /* Length if it is a file */ unsigned extra_equiv_id; /* Equivalent object for a hard link */ - - unsigned validity1; - }; /* Spare structure for YAFFS1 */ @@ -225,7 +239,7 @@ enum yaffs_block_state { YAFFS_BLOCK_STATE_SCANNING, /* Being scanned */ - YAFFS_BLOCK_STATE_NEEDS_SCANNING, + 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. @@ -285,11 +299,10 @@ struct yaffs_block_info { 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 */ -#ifdef CONFIG_YAFFS_YAFFS2 u32 has_shrink_hdr:1; /* This block has at least one shrink header */ u32 seq_number; /* block sequence number for yaffs2 */ -#endif }; @@ -314,7 +327,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; @@ -331,7 +344,8 @@ struct yaffs_obj_hdr { u32 inband_shadowed_obj_id; u32 inband_is_shrink; - u32 reserved[2]; + u32 file_size_high; + u32 reserved[1]; int shadows_obj; /* This object header shadows the specified object if > 0 */ @@ -355,9 +369,9 @@ struct yaffs_tnode { */ struct yaffs_file_var { - u32 file_size; - u32 scanned_size; - u32 shrink_size; + loff_t file_size; + loff_t scanned_size; + loff_t shrink_size; int top_level; struct yaffs_tnode *top; }; @@ -438,9 +452,7 @@ struct yaffs_obj { u32 yst_mode; -#ifndef CONFIG_YAFFS_NO_SHORT_NAMES YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1]; -#endif #ifdef CONFIG_YAFFS_WINCE u32 win_ctime[2]; @@ -487,18 +499,17 @@ struct yaffs_checkpt_obj { u8 unlink_allowed:1; u8 serial; int n_data_chunks; - u32 size_or_equiv_obj; + loff_t 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 ---------------------------------*/ @@ -509,7 +520,7 @@ 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 */ @@ -525,8 +536,13 @@ struct yaffs_param { int n_caches; /* If <= 0, then short op caching is disabled, * else the number of short op caches. */ + 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) */ @@ -542,30 +558,43 @@ 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 + /* Tags marshalling functions. + * If these are not set then defaults will be assigned. + */ 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 (*mark_bad_fn) (struct yaffs_dev *dev, int block_no); + + /* NAND driver access functions All required except + * the deinitialise function which is optional. + */ + + 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); + + + int max_objects; /* + * Set to limit the number of objects created. + * 0 = no limit. + */ /* The remove_obj_fn function must be supplied by OS flavours that * need it. @@ -594,6 +623,9 @@ struct yaffs_param { int auto_unicode; #endif int always_check_erased; /* Force chunk erased check always on */ + + int disable_summary; + }; struct yaffs_dev { @@ -693,6 +725,7 @@ 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; @@ -735,10 +768,15 @@ struct yaffs_dev { /* 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_markings; u32 n_erase_failures; u32 n_gc_copies; u32 all_gcs; @@ -746,7 +784,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; @@ -756,6 +794,8 @@ struct yaffs_dev { u32 n_unmarked_deletions; u32 refresh_count; u32 cache_hits; + u32 tags_used; + u32 summary_used; }; @@ -816,7 +856,7 @@ int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name); int yaffs_del_obj(struct yaffs_obj *obj); 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); @@ -893,8 +933,8 @@ 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, @@ -906,7 +946,7 @@ 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); +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 force, int is_shrink, int shadows, @@ -935,4 +975,16 @@ 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); + +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 aand out of + * object headers. + */ +void yaffs_oh_size_load(struct yaffs_obj_hdr *oh, loff_t fsize); +loff_t yaffs_oh_to_size(struct yaffs_obj_hdr *oh); +loff_t yaffs_max_file_size(struct yaffs_dev *dev); + + #endif