2 * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
4 * Copyright (C) 2002-2011 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
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.
13 * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
16 #ifndef __YAFFS_GUTS_H__
17 #define __YAFFS_GUTS_H__
28 * And what have we got...
30 #define YAFFS_MAGIC 0x5941ff53
32 #define YAFFS_NTNODES_LEVEL0 16
33 #define YAFFS_TNODES_LEVEL0_BITS 4
34 #define YAFFS_TNODES_LEVEL0_MASK 0xf
36 #define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2)
37 #define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1)
38 #define YAFFS_TNODES_INTERNAL_MASK 0x7
39 #define YAFFS_TNODES_MAX_LEVEL 6
41 #ifndef CONFIG_YAFFS_NO_YAFFS1
42 #define YAFFS_BYTES_PER_SPARE 16
43 #define YAFFS_BYTES_PER_CHUNK 512
44 #define YAFFS_CHUNK_SIZE_SHIFT 9
45 #define YAFFS_CHUNKS_PER_BLOCK 32
46 #define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
49 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024
50 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32
52 #define YAFFS_MAX_CHUNK_ID 0x000fffff
54 #define YAFFS_ALLOCATION_NOBJECTS 100
55 #define YAFFS_ALLOCATION_NTNODES 100
56 #define YAFFS_ALLOCATION_NLINKS 100
58 #define YAFFS_NOBJECT_BUCKETS 256
60 #define YAFFS_OBJECT_SPACE 0x40000
61 #define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE - 1)
63 #define YAFFS_CHECKPOINT_VERSION 4
65 #ifdef CONFIG_YAFFS_UNICODE
66 #define YAFFS_MAX_NAME_LENGTH 127
67 #define YAFFS_MAX_ALIAS_LENGTH 79
69 #define YAFFS_MAX_NAME_LENGTH 255
70 #define YAFFS_MAX_ALIAS_LENGTH 159
73 #define YAFFS_SHORT_NAME_LENGTH 15
75 /* Some special object ids for pseudo objects */
76 #define YAFFS_OBJECTID_ROOT 1
77 #define YAFFS_OBJECTID_LOSTNFOUND 2
78 #define YAFFS_OBJECTID_UNLINKED 3
79 #define YAFFS_OBJECTID_DELETED 4
81 /* Pseudo object ids for checkpointing */
82 #define YAFFS_OBJECTID_SB_HEADER 0x10
83 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
84 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
86 #define YAFFS_MAX_SHORT_OP_CACHES 20
88 #define YAFFS_N_TEMP_BUFFERS 6
90 /* We limit the number attempts at sucessfully saving a chunk of data.
91 * Small-page devices have 32 pages per block; large-page devices have 64.
92 * Default to something in the order of 5 to 10 blocks worth of chunks.
94 #define YAFFS_WR_ATTEMPTS (5*64)
96 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
97 * The range is limited slightly to help distinguish bad numbers from good.
98 * This also allows us to perhaps in the future use special numbers for
100 * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
101 * and is a larger number than the lifetime of a 2GB device.
103 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
104 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xefffff00
106 /* Special sequence number for bad block that failed to be marked bad */
107 #define YAFFS_SEQUENCE_BAD_BLOCK 0xffff0000
109 /* ChunkCache is used for short read/write operations.*/
111 struct yaffs_obj *object;
115 int n_bytes; /* Only valid if the cache is dirty */
116 int locked; /* Can't push out or flush while locked. */
120 /* Tags structures in RAM
121 * NB This uses bitfield. Bitfields should not straddle a u32 boundary
122 * otherwise the structure size will get blown out.
125 #ifndef CONFIG_YAFFS_NO_YAFFS1
127 unsigned chunk_id:20;
128 unsigned serial_number:2;
129 unsigned n_bytes_lsb:10;
132 unsigned n_bytes_msb:2;
135 union yaffs_tags_union {
136 struct yaffs_tags as_tags;
142 /* Stuff used for extended tags in YAFFS2 */
144 enum yaffs_ecc_result {
145 YAFFS_ECC_RESULT_UNKNOWN,
146 YAFFS_ECC_RESULT_NO_ERROR,
147 YAFFS_ECC_RESULT_FIXED,
148 YAFFS_ECC_RESULT_UNFIXED
151 enum yaffs_obj_type {
152 YAFFS_OBJECT_TYPE_UNKNOWN,
153 YAFFS_OBJECT_TYPE_FILE,
154 YAFFS_OBJECT_TYPE_SYMLINK,
155 YAFFS_OBJECT_TYPE_DIRECTORY,
156 YAFFS_OBJECT_TYPE_HARDLINK,
157 YAFFS_OBJECT_TYPE_SPECIAL
160 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
162 struct yaffs_ext_tags {
163 unsigned chunk_used; /* Status of the chunk: used or unused */
164 unsigned obj_id; /* If 0 this is not used */
165 unsigned chunk_id; /* If 0 this is a header, else a data chunk */
166 unsigned n_bytes; /* Only valid for data chunks */
168 /* The following stuff only has meaning when we read */
169 enum yaffs_ecc_result ecc_result;
173 unsigned is_deleted; /* The chunk is marked deleted */
174 unsigned serial_number; /* Yaffs1 2-bit serial number */
177 unsigned seq_number; /* The sequence number of this block */
179 /* Extra info if this is an object header (YAFFS2 only) */
181 unsigned extra_available; /* Extra info available if not zero */
182 unsigned extra_parent_id; /* The parent object */
183 unsigned extra_is_shrink; /* Is it a shrink header? */
184 unsigned extra_shadows; /* Does this shadow another object? */
186 enum yaffs_obj_type extra_obj_type; /* What object type? */
188 unsigned extra_length; /* Length if it is a file */
189 unsigned extra_equiv_id; /* Equivalent object for a hard link */
192 /* Spare structure for YAFFS1 */
198 u8 page_status; /* set to 0 to delete the chunk */
208 /*Special structure for passing through to mtd */
209 struct yaffs_nand_spare {
210 struct yaffs_spare spare;
215 /* Block data in RAM */
217 enum yaffs_block_state {
218 YAFFS_BLOCK_STATE_UNKNOWN = 0,
220 YAFFS_BLOCK_STATE_SCANNING,
223 YAFFS_BLOCK_STATE_NEEDS_SCAN,
224 /* The block might have something on it (ie it is allocating or full,
225 * perhaps empty) but it needs to be scanned to determine its true
227 * This state is only valid during scanning.
228 * NB We tolerate empty because the pre-scanner might be incapable of
230 * However, if this state is returned on a YAFFS2 device,
231 * then we expect a sequence number
234 YAFFS_BLOCK_STATE_EMPTY,
235 /* This block is empty */
237 YAFFS_BLOCK_STATE_ALLOCATING,
238 /* This block is partially allocated.
239 * At least one page holds valid data.
240 * This is the one currently being used for page
241 * allocation. Should never be more than one of these.
242 * If a block is only partially allocated at mount it is treated as
246 YAFFS_BLOCK_STATE_FULL,
247 /* All the pages in this block have been allocated.
248 * If a block was only partially allocated when mounted we treat
249 * it as fully allocated.
252 YAFFS_BLOCK_STATE_DIRTY,
253 /* The block was full and now all chunks have been deleted.
254 * Erase me, reuse me.
257 YAFFS_BLOCK_STATE_CHECKPOINT,
258 /* This block is assigned to holding checkpoint data. */
260 YAFFS_BLOCK_STATE_COLLECTING,
261 /* This block is being garbage collected */
263 YAFFS_BLOCK_STATE_DEAD
264 /* This block has failed and is not in use */
267 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
269 struct yaffs_block_info {
271 int soft_del_pages:10; /* number of soft deleted pages */
272 int pages_in_use:10; /* number of pages in use */
273 unsigned block_state:4; /* One of the above block states. */
274 /* NB use unsigned because enum is sometimes
276 u32 needs_retiring:1; /* Data has failed on this block, */
277 /*need to get valid data off and retire*/
278 u32 skip_erased_check:1;/* Skip the erased check on this block */
279 u32 gc_prioritise:1; /* An ECC check or blank check has failed.
280 Block should be prioritised for GC */
281 u32 chunk_error_strikes:3; /* How many times we've had ecc etc
282 failures on this block and tried to reuse it */
284 #ifdef CONFIG_YAFFS_YAFFS2
285 u32 has_shrink_hdr:1; /* This block has at least one shrink header */
286 u32 seq_number; /* block sequence number for yaffs2 */
291 /* -------------------------- Object structure -------------------------------*/
292 /* This is the object structure as stored on NAND */
294 struct yaffs_obj_hdr {
295 enum yaffs_obj_type type;
297 /* Apply to everything */
299 u16 sum_no_longer_used; /* checksum of name. No longer used */
300 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
302 /* The following apply to all object types except for hard links */
303 u32 yst_mode; /* protection */
311 /* File size applies to files only */
314 /* Equivalent object id applies to hard links only. */
317 /* Alias is for symlinks only. */
318 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
320 u32 yst_rdev; /* stuff for block and char devices (major/min) */
326 u32 inband_shadowed_obj_id;
327 u32 inband_is_shrink;
330 int shadows_obj; /* This object header shadows the
331 specified object if > 0 */
333 /* is_shrink applies to object headers written when wemake a hole. */
338 /*--------------------------- Tnode -------------------------- */
341 struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
344 /*------------------------ Object -----------------------------*/
345 /* An object can be one of:
346 * - a directory (no data, has children links
347 * - a regular file (data.... not prunes :->).
348 * - a symlink [symbolic link] (the alias).
352 struct yaffs_file_var {
357 struct yaffs_tnode *top;
360 struct yaffs_dir_var {
361 struct list_head children; /* list of child links */
362 struct list_head dirty; /* Entry for list of dirty directories */
365 struct yaffs_symlink_var {
369 struct yaffs_hardlink_var {
370 struct yaffs_obj *equiv_obj;
374 union yaffs_obj_var {
375 struct yaffs_file_var file_variant;
376 struct yaffs_dir_var dir_variant;
377 struct yaffs_symlink_var symlink_variant;
378 struct yaffs_hardlink_var hardlink_variant;
382 u8 deleted:1; /* This should only apply to unlinked files. */
383 u8 soft_del:1; /* it has also been soft deleted */
384 u8 unlinked:1; /* An unlinked file.*/
385 u8 fake:1; /* A fake object has no presence on NAND. */
386 u8 rename_allowed:1; /* Some objects cannot be renamed. */
388 u8 dirty:1; /* the object needs to be written to flash */
389 u8 valid:1; /* When the file system is being loaded up, this
390 * object might be created before the data
392 * ie. file data chunks encountered before
395 u8 lazy_loaded:1; /* This object has been lazy loaded and
396 * is missing some detail */
398 u8 defered_free:1; /* Object is removed from NAND, but is
399 * still in the inode cache.
400 * Free of object is defered.
401 * until the inode is released.
403 u8 being_created:1; /* This object is still being created
404 * so skip some verification checks. */
405 u8 is_shadowed:1; /* This object is shadowed on the way
406 * to being renamed. */
408 u8 xattr_known:1; /* We know if this has object has xattribs
410 u8 has_xattr:1; /* This object has xattribs.
411 * Only valid if xattr_known. */
413 u8 serial; /* serial number of chunk in NAND.*/
414 u16 sum; /* sum of the name to speed searching */
416 struct yaffs_dev *my_dev; /* The device I'm on */
418 struct list_head hash_link; /* list of objects in hash bucket */
420 struct list_head hard_links; /* hard linked object chain*/
422 /* directory structure stuff */
423 /* also used for linking up the free list */
424 struct yaffs_obj *parent;
425 struct list_head siblings;
427 /* Where's my object header in NAND? */
430 int n_data_chunks; /* Number of data chunks for this file. */
432 u32 obj_id; /* the object id value */
436 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
437 YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
440 #ifdef CONFIG_YAFFS_WINCE
456 enum yaffs_obj_type variant_type;
458 union yaffs_obj_var variant;
462 struct yaffs_obj_bucket {
463 struct list_head list;
467 /* yaffs_checkpt_obj holds the definition of an object as dumped
471 struct yaffs_checkpt_obj {
476 enum yaffs_obj_type variant_type:3;
485 u32 size_or_equiv_obj;
488 /*--------------------- Temporary buffers ----------------
490 * These are chunk-sized working buffers. Each device has a few
493 struct yaffs_buffer {
495 int line; /* track from whence this buffer was allocated */
499 /*----------------- Device ---------------------------------*/
505 * Entry parameters set up way early. Yaffs sets up the rest.
506 * The structure should be zeroed out before use so that unused
507 * and defualt values are zero.
510 int inband_tags; /* Use unband tags */
511 u32 total_bytes_per_chunk; /* Should be >= 512, does not need to
513 int chunks_per_block; /* does not need to be a power of 2 */
514 int spare_bytes_per_chunk; /* spare area size */
515 int start_block; /* Start block we're allowed to use */
516 int end_block; /* End block we're allowed to use */
517 int n_reserved_blocks; /* Tuneable so that we can reduce
518 * reserved blocks on NOR and RAM. */
520 int n_caches; /* If <= 0, then short op caching is disabled,
521 * else the number of short op caches.
523 int use_nand_ecc; /* Flag to decide whether or not to use
524 * NAND driver ECC on data (yaffs1) */
525 int no_tags_ecc; /* Flag to decide whether or not to do ECC
526 * on packed tags (yaffs2) */
528 int is_yaffs2; /* Use yaffs2 mode on this device */
530 int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
532 int refresh_period; /* How often to check for a block refresh */
534 /* Checkpoint control. Can be set before or after initialisation */
538 int enable_xattr; /* Enable xattribs */
540 /* NAND access functions (Must be set before calling YAFFS) */
542 int (*write_chunk_fn) (struct yaffs_dev *dev,
543 int nand_chunk, const u8 *data,
544 const struct yaffs_spare *spare);
545 int (*read_chunk_fn) (struct yaffs_dev *dev,
546 int nand_chunk, u8 *data,
547 struct yaffs_spare *spare);
548 int (*erase_fn) (struct yaffs_dev *dev, int flash_block);
549 int (*initialise_flash_fn) (struct yaffs_dev *dev);
550 int (*deinitialise_flash_fn) (struct yaffs_dev *dev);
552 #ifdef CONFIG_YAFFS_YAFFS2
553 int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
554 int nand_chunk, const u8 *data,
555 const struct yaffs_ext_tags *tags);
556 int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
557 int nand_chunk, u8 *data,
558 struct yaffs_ext_tags *tags);
559 int (*bad_block_fn) (struct yaffs_dev *dev, int block_no);
560 int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
561 enum yaffs_block_state *state,
565 /* The remove_obj_fn function must be supplied by OS flavours that
567 * yaffs direct uses it to implement the faster readdir.
568 * Linux uses it to protect the directory during unlocking.
570 void (*remove_obj_fn) (struct yaffs_obj *obj);
572 /* Callback to mark the superblock dirty */
573 void (*sb_dirty_fn) (struct yaffs_dev *dev);
575 /* Callback to control garbage collection. */
576 unsigned (*gc_control) (struct yaffs_dev *dev);
578 /* Debug control flags. Don't use unless you know what you're doing */
579 int use_header_file_size; /* Flag to determine if we should use
580 * file sizes from the header */
581 int disable_lazy_load; /* Disable lazy loading on this device */
582 int wide_tnodes_disabled; /* Set to disable wide tnodes */
583 int disable_soft_del; /* yaffs 1 only: Set to disable the use of
586 int defered_dir_update; /* Set to defer directory updates */
588 #ifdef CONFIG_YAFFS_AUTO_UNICODE
591 int always_check_erased; /* Force chunk erased check always on */
595 struct yaffs_param param;
597 /* Context storage. Holds extra OS specific data for this device */
600 void *driver_context;
602 struct list_head dev_list;
604 /* Runtime parameters. Set up by YAFFS. */
605 int data_bytes_per_chunk;
607 /* Non-wide tnode stuff */
608 u16 chunk_grp_bits; /* Number of bits that need to be resolved if
609 * the tnodes are not wide enough.
611 u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
613 /* Stuff to support wide tnodes */
618 /* Stuff for figuring out file offset to chunk conversions */
619 u32 chunk_shift; /* Shift value */
620 u32 chunk_div; /* Divisor after shifting: 1 for 2^n sizes */
621 u32 chunk_mask; /* Mask to use for power-of-2 case */
627 /* Stuff to support block offsetting to support start block zero */
628 int internal_start_block;
629 int internal_end_block;
633 /* Runtime checkpointing stuff */
634 int checkpt_page_seq; /* running sequence number of checkpt pages */
635 int checkpt_byte_count;
636 int checkpt_byte_offs;
638 int checkpt_open_write;
639 int blocks_in_checkpt;
640 int checkpt_cur_chunk;
641 int checkpt_cur_block;
642 int checkpt_next_block;
643 int *checkpt_block_list;
644 int checkpt_max_blocks;
648 int checkpoint_blocks_required; /* Number of blocks needed to store
649 * current checkpoint set */
652 struct yaffs_block_info *block_info;
653 u8 *chunk_bits; /* bitmap of chunks in use */
654 unsigned block_info_alt:1; /* allocated using alternative alloc */
655 unsigned chunk_bits_alt:1; /* allocated using alternative alloc */
656 int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
657 * Must be consistent with chunks_per_block.
661 int alloc_block; /* Current block being allocated off */
663 int alloc_block_finder; /* Used to search for next allocation block */
665 /* Object and Tnode memory management */
672 struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
677 /* Garbage collection control */
678 u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
681 unsigned has_pending_prioritised_gc; /* We think this device might
682 have pending prioritised gcs */
684 unsigned gc_block_finder;
685 unsigned gc_dirtiest;
686 unsigned gc_pages_in_use;
687 unsigned gc_not_done;
692 /* Special directories */
693 struct yaffs_obj *root_dir;
694 struct yaffs_obj *lost_n_found;
696 int buffered_block; /* Which block is buffered here? */
697 int doing_buffered_block_rewrite;
699 struct yaffs_cache *cache;
702 /* Stuff for background deletion and unlinked files. */
703 struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
705 struct yaffs_obj *del_dir; /* Directory where deleted objects are
706 sent to disappear. */
707 struct yaffs_obj *unlinked_deletion; /* Current file being
708 background deleted. */
709 int n_deleted_files; /* Count of files awaiting deletion; */
710 int n_unlinked_files; /* Count of unlinked files. */
711 int n_bg_deletions; /* Count of background deletions. */
713 /* Temporary buffer management */
714 struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
717 int unmanaged_buffer_allocs;
718 int unmanaged_buffer_deallocs;
720 /* yaffs2 runtime stuff */
721 unsigned seq_number; /* Sequence number of currently
723 unsigned oldest_dirty_seq;
724 unsigned oldest_dirty_block;
726 /* Block refreshing */
727 int refresh_skip; /* A skip down counter.
728 * Refresh happens when this gets to zero. */
730 /* Dirty directory handling */
731 struct list_head dirty_dirs; /* List of dirty directories */
737 u32 n_erase_failures;
740 u32 passive_gc_count;
741 u32 oldest_dirty_gc_count;
744 u32 n_retired_writes;
745 u32 n_retired_blocks;
748 u32 n_tags_ecc_fixed;
749 u32 n_tags_ecc_unfixed;
751 u32 n_unmarked_deletions;
757 /* The CheckpointDevice structure holds the device information that changes
758 *at runtime and must be preserved over unmount/mount cycles.
760 struct yaffs_checkpt_dev {
763 int alloc_block; /* Current block being allocated off */
767 int n_deleted_files; /* Count of files awaiting deletion; */
768 int n_unlinked_files; /* Count of unlinked files. */
769 int n_bg_deletions; /* Count of background deletions. */
771 /* yaffs2 runtime stuff */
772 unsigned seq_number; /* Sequence number of currently
773 * allocating block */
777 struct yaffs_checkpt_validity {
784 struct yaffs_shadow_fixer {
787 struct yaffs_shadow_fixer *next;
790 /* Structure for doing xattr modifications */
791 struct yaffs_xattr_mod {
792 int set; /* If 0 then this is a deletion */
800 /*----------------------- YAFFS Functions -----------------------*/
802 int yaffs_guts_initialise(struct yaffs_dev *dev);
803 void yaffs_deinitialise(struct yaffs_dev *dev);
805 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
807 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
808 struct yaffs_obj *new_dir, const YCHAR * new_name);
810 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
811 int yaffs_del_obj(struct yaffs_obj *obj);
813 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
814 int yaffs_get_obj_length(struct yaffs_obj *obj);
815 int yaffs_get_obj_inode(struct yaffs_obj *obj);
816 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
817 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
819 /* File operations */
820 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
822 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
823 int n_bytes, int write_trhrough);
824 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
826 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
827 const YCHAR *name, u32 mode, u32 uid,
830 int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync);
832 /* Flushing and checkpointing */
833 void yaffs_flush_whole_cache(struct yaffs_dev *dev);
835 int yaffs_checkpoint_save(struct yaffs_dev *dev);
836 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
838 /* Directory operations */
839 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
840 u32 mode, u32 uid, u32 gid);
841 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
843 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
845 /* Link operations */
846 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
847 struct yaffs_obj *equiv_obj);
849 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
851 /* Symlink operations */
852 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
853 const YCHAR *name, u32 mode, u32 uid,
854 u32 gid, const YCHAR *alias);
855 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
857 /* Special inodes (fifos, sockets and devices) */
858 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
859 const YCHAR *name, u32 mode, u32 uid,
862 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
863 const void *value, int size, int flags);
864 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
866 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
867 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
869 /* Special directories */
870 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
871 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
873 void yaffs_handle_defered_free(struct yaffs_obj *obj);
875 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
877 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
880 int yaffs_dump_obj(struct yaffs_obj *obj);
882 void yaffs_guts_test(struct yaffs_dev *dev);
884 /* A few useful functions to be used within the core files*/
885 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
887 int yaffs_check_ff(u8 *buffer, int n_bytes);
888 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
889 struct yaffs_block_info *bi);
891 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev, int line_no);
892 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer, int line_no);
894 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
896 enum yaffs_obj_type type);
897 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
898 int nand_chunk, int in_scan);
899 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
900 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
901 const struct yaffs_obj_hdr *oh);
902 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
903 YCHAR *yaffs_clone_str(const YCHAR *str);
904 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
905 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
906 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
907 int force, int is_shrink, int shadows,
908 struct yaffs_xattr_mod *xop);
909 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
910 int backward_scanning);
911 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
912 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
913 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
914 struct yaffs_file_var *file_struct,
916 struct yaffs_tnode *passed_tn);
918 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
919 int n_bytes, int write_trhrough);
920 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
921 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
923 int yaffs_count_free_chunks(struct yaffs_dev *dev);
925 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
926 struct yaffs_file_var *file_struct,
929 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
932 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);