2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2010 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 General Public License version 2 as
11 * published by the Free Software Foundation.
15 #include "yaffs_trace.h"
17 #include "yaffs_guts.h"
18 #include "yaffs_tagsvalidity.h"
19 #include "yaffs_getblockinfo.h"
21 #include "yaffs_tagscompat.h"
23 #include "yaffs_nand.h"
25 #include "yaffs_yaffs1.h"
26 #include "yaffs_yaffs2.h"
27 #include "yaffs_bitmap.h"
28 #include "yaffs_verify.h"
30 #include "yaffs_nand.h"
31 #include "yaffs_packedtags2.h"
33 #include "yaffs_nameval.h"
34 #include "yaffs_allocator.h"
36 #include "yaffs_attribs.h"
38 /* Note YAFFS_GC_GOOD_ENOUGH must be <= YAFFS_GC_PASSIVE_THRESHOLD */
39 #define YAFFS_GC_GOOD_ENOUGH 2
40 #define YAFFS_GC_PASSIVE_THRESHOLD 4
42 #include "yaffs_ecc.h"
44 /* Robustification (if it ever comes about...) */
45 static void yaffs_retire_block(struct yaffs_dev *dev, int flash_block);
46 static void yaffs_handle_chunk_wr_error(struct yaffs_dev *dev, int nand_chunk,
48 static void yaffs_handle_chunk_wr_ok(struct yaffs_dev *dev, int nand_chunk,
50 const struct yaffs_ext_tags *tags);
51 static void yaffs_handle_chunk_update(struct yaffs_dev *dev, int nand_chunk,
52 const struct yaffs_ext_tags *tags);
54 /* Other local prototypes */
55 static void yaffs_update_parent(struct yaffs_obj *obj);
56 static int yaffs_unlink_obj(struct yaffs_obj *obj);
57 static int yaffs_obj_cache_dirty(struct yaffs_obj *obj);
59 static int yaffs_write_new_chunk(struct yaffs_dev *dev,
61 struct yaffs_ext_tags *tags, int use_reserver);
63 static struct yaffs_obj *yaffs_new_obj(struct yaffs_dev *dev, int number,
64 enum yaffs_obj_type type);
66 static int yaffs_apply_xattrib_mod(struct yaffs_obj *obj, char *buffer,
67 struct yaffs_xattr_mod *xmod);
69 static void yaffs_remove_obj_from_dir(struct yaffs_obj *obj);
70 static int yaffs_generic_obj_del(struct yaffs_obj *in);
72 static int yaffs_check_chunk_erased(struct yaffs_dev *dev, int nand_chunk);
74 static int yaffs_unlink_worker(struct yaffs_obj *obj);
76 static int yaffs_tags_match(const struct yaffs_ext_tags *tags, int obj_id,
79 static int yaffs_alloc_chunk(struct yaffs_dev *dev, int use_reserver,
80 struct yaffs_block_info **block_ptr);
82 static void yaffs_check_obj_details_loaded(struct yaffs_obj *in);
84 static void yaffs_invalidate_whole_cache(struct yaffs_obj *in);
85 static void yaffs_invalidate_chunk_cache(struct yaffs_obj *object,
88 static int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
89 struct yaffs_ext_tags *tags);
91 static int yaffs_verify_chunk_written(struct yaffs_dev *dev,
94 struct yaffs_ext_tags *tags);
96 static void yaffs_load_name_from_oh(struct yaffs_dev *dev, YCHAR * name,
97 const YCHAR * oh_name, int buff_size);
98 static void yaffs_load_oh_from_name(struct yaffs_dev *dev, YCHAR * oh_name,
101 /* Function to calculate chunk and offset */
103 static void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
104 int *chunk_out, u32 * offset_out)
109 chunk = (u32) (addr >> dev->chunk_shift);
111 if (dev->chunk_div == 1) {
112 /* easy power of 2 case */
113 offset = (u32) (addr & dev->chunk_mask);
115 /* Non power-of-2 case */
119 chunk /= dev->chunk_div;
121 chunk_base = ((loff_t) chunk) * dev->data_bytes_per_chunk;
122 offset = (u32) (addr - chunk_base);
126 *offset_out = offset;
129 /* Function to return the number of shifts for a power of 2 greater than or
130 * equal to the given number
131 * Note we don't try to cater for all possible numbers and this does not have to
132 * be hellishly efficient.
135 static u32 calc_shifts_ceiling(u32 x)
140 shifts = extra_bits = 0;
155 /* Function to return the number of shifts to get a 1 in bit 0
158 static u32 calc_shifts(u32 x)
176 * Temporary buffer manipulations.
179 static int yaffs_init_tmp_buffers(struct yaffs_dev *dev)
184 memset(dev->temp_buffer, 0, sizeof(dev->temp_buffer));
186 for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
187 dev->temp_buffer[i].line = 0; /* not in use */
188 dev->temp_buffer[i].buffer = buf =
189 YMALLOC_DMA(dev->param.total_bytes_per_chunk);
192 return buf ? YAFFS_OK : YAFFS_FAIL;
195 u8 *yaffs_get_temp_buffer(struct yaffs_dev * dev, int line_no)
200 if (dev->temp_in_use > dev->max_temp)
201 dev->max_temp = dev->temp_in_use;
203 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
204 if (dev->temp_buffer[i].line == 0) {
205 dev->temp_buffer[i].line = line_no;
206 if ((i + 1) > dev->max_temp) {
207 dev->max_temp = i + 1;
208 for (j = 0; j <= i; j++)
209 dev->temp_buffer[j].max_line =
210 dev->temp_buffer[j].line;
213 return dev->temp_buffer[i].buffer;
217 T(YAFFS_TRACE_BUFFERS,
218 (TSTR("Out of temp buffers at line %d, other held by lines:"),
220 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
221 T(YAFFS_TRACE_BUFFERS,
222 (TSTR(" %d "), dev->temp_buffer[i].line));
224 T(YAFFS_TRACE_BUFFERS, (TSTR(" " TENDSTR)));
227 * If we got here then we have to allocate an unmanaged one
231 dev->unmanaged_buffer_allocs++;
232 return YMALLOC(dev->data_bytes_per_chunk);
236 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 * buffer, int line_no)
242 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
243 if (dev->temp_buffer[i].buffer == buffer) {
244 dev->temp_buffer[i].line = 0;
250 /* assume it is an unmanaged one. */
251 T(YAFFS_TRACE_BUFFERS,
252 (TSTR("Releasing unmanaged temp buffer in line %d" TENDSTR),
255 dev->unmanaged_buffer_deallocs++;
261 * Determine if we have a managed buffer.
263 int yaffs_is_managed_tmp_buffer(struct yaffs_dev *dev, const u8 * buffer)
267 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
268 if (dev->temp_buffer[i].buffer == buffer)
272 for (i = 0; i < dev->param.n_caches; i++) {
273 if (dev->cache[i].data == buffer)
277 if (buffer == dev->checkpt_buffer)
280 T(YAFFS_TRACE_ALWAYS,
281 (TSTR("yaffs: unmaged buffer detected.\n" TENDSTR)));
290 * Simple hash function. Needs to have a reasonable spread
293 static Y_INLINE int yaffs_hash_fn(int n)
296 return n % YAFFS_NOBJECT_BUCKETS;
300 * Access functions to useful fake objects.
301 * Note that root might have a presence in NAND if permissions are set.
304 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev)
306 return dev->root_dir;
309 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev)
311 return dev->lost_n_found;
315 * Erased NAND checking functions
318 int yaffs_check_ff(u8 * buffer, int n_bytes)
320 /* Horrible, slow implementation */
329 static int yaffs_check_chunk_erased(struct yaffs_dev *dev, int nand_chunk)
331 int retval = YAFFS_OK;
332 u8 *data = yaffs_get_temp_buffer(dev, __LINE__);
333 struct yaffs_ext_tags tags;
336 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, data, &tags);
338 if (tags.ecc_result > YAFFS_ECC_RESULT_NO_ERROR)
341 if (!yaffs_check_ff(data, dev->data_bytes_per_chunk) || tags.chunk_used) {
342 T(YAFFS_TRACE_NANDACCESS,
343 (TSTR("Chunk %d not erased" TENDSTR), nand_chunk));
347 yaffs_release_temp_buffer(dev, data, __LINE__);
353 static int yaffs_verify_chunk_written(struct yaffs_dev *dev,
356 struct yaffs_ext_tags *tags)
358 int retval = YAFFS_OK;
359 struct yaffs_ext_tags temp_tags;
360 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
363 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, buffer, &temp_tags);
364 if (memcmp(buffer, data, dev->data_bytes_per_chunk) ||
365 temp_tags.obj_id != tags->obj_id ||
366 temp_tags.chunk_id != tags->chunk_id ||
367 temp_tags.n_bytes != tags->n_bytes)
370 yaffs_release_temp_buffer(dev, buffer, __LINE__);
375 static int yaffs_write_new_chunk(struct yaffs_dev *dev,
377 struct yaffs_ext_tags *tags, int use_reserver)
383 yaffs2_checkpt_invalidate(dev);
386 struct yaffs_block_info *bi = 0;
389 chunk = yaffs_alloc_chunk(dev, use_reserver, &bi);
395 /* First check this chunk is erased, if it needs
396 * checking. The checking policy (unless forced
397 * always on) is as follows:
399 * Check the first page we try to write in a block.
400 * If the check passes then we don't need to check any
401 * more. If the check fails, we check again...
402 * If the block has been erased, we don't need to check.
404 * However, if the block has been prioritised for gc,
405 * then we think there might be something odd about
406 * this block and stop using it.
408 * Rationale: We should only ever see chunks that have
409 * not been erased if there was a partially written
410 * chunk due to power loss. This checking policy should
411 * catch that case with very few checks and thus save a
412 * lot of checks that are most likely not needed.
415 * If an erase check fails or the write fails we skip the
419 /* let's give it a try */
422 if (dev->param.always_check_erased)
423 bi->skip_erased_check = 0;
425 if (!bi->skip_erased_check) {
426 erased_ok = yaffs_check_chunk_erased(dev, chunk);
427 if (erased_ok != YAFFS_OK) {
429 (TSTR("**>> yaffs chunk %d was not erased"
432 /* If not erased, delete this one,
433 * skip rest of block and
434 * try another chunk */
435 yaffs_chunk_del(dev, chunk, 1, __LINE__);
436 yaffs_skip_rest_of_block(dev);
441 write_ok = yaffs_wr_chunk_tags_nand(dev, chunk, data, tags);
443 if (!bi->skip_erased_check)
445 yaffs_verify_chunk_written(dev, chunk, data, tags);
447 if (write_ok != YAFFS_OK) {
448 /* Clean up aborted write, skip to next block and
449 * try another chunk */
450 yaffs_handle_chunk_wr_error(dev, chunk, erased_ok);
454 bi->skip_erased_check = 1;
456 /* Copy the data into the robustification buffer */
457 yaffs_handle_chunk_wr_ok(dev, chunk, data, tags);
459 } while (write_ok != YAFFS_OK &&
460 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
467 (TSTR("**>> yaffs write required %d attempts" TENDSTR),
470 dev->n_retired_writes += (attempts - 1);
477 * Block retiring for handling a broken block.
480 static void yaffs_retire_block(struct yaffs_dev *dev, int flash_block)
482 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
484 yaffs2_checkpt_invalidate(dev);
486 yaffs2_clear_oldest_dirty_seq(dev, bi);
488 if (yaffs_mark_bad(dev, flash_block) != YAFFS_OK) {
489 if (yaffs_erase_block(dev, flash_block) != YAFFS_OK) {
490 T(YAFFS_TRACE_ALWAYS,
492 ("yaffs: Failed to mark bad and erase block %d"
493 TENDSTR), flash_block));
495 struct yaffs_ext_tags tags;
497 flash_block * dev->param.chunks_per_block;
499 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
501 memset(buffer, 0xff, dev->data_bytes_per_chunk);
502 yaffs_init_tags(&tags);
503 tags.seq_number = YAFFS_SEQUENCE_BAD_BLOCK;
504 if (dev->param.write_chunk_tags_fn(dev, chunk_id -
508 T(YAFFS_TRACE_ALWAYS,
511 TCONT("write bad block marker to block %d")
512 TENDSTR), flash_block));
514 yaffs_release_temp_buffer(dev, buffer, __LINE__);
518 bi->block_state = YAFFS_BLOCK_STATE_DEAD;
519 bi->gc_prioritise = 0;
520 bi->needs_retiring = 0;
522 dev->n_retired_blocks++;
526 * Functions for robustisizing TODO
530 static void yaffs_handle_chunk_wr_ok(struct yaffs_dev *dev, int nand_chunk,
532 const struct yaffs_ext_tags *tags)
535 nand_chunk = nand_chunk;
540 static void yaffs_handle_chunk_update(struct yaffs_dev *dev, int nand_chunk,
541 const struct yaffs_ext_tags *tags)
544 nand_chunk = nand_chunk;
548 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
549 struct yaffs_block_info *bi)
551 if (!bi->gc_prioritise) {
552 bi->gc_prioritise = 1;
553 dev->has_pending_prioritised_gc = 1;
554 bi->chunk_error_strikes++;
556 if (bi->chunk_error_strikes > 3) {
557 bi->needs_retiring = 1; /* Too many stikes, so retire this */
558 T(YAFFS_TRACE_ALWAYS,
559 (TSTR("yaffs: Block struck out" TENDSTR)));
565 static void yaffs_handle_chunk_wr_error(struct yaffs_dev *dev, int nand_chunk,
568 int flash_block = nand_chunk / dev->param.chunks_per_block;
569 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
571 yaffs_handle_chunk_error(dev, bi);
574 /* Was an actual write failure, so mark the block for retirement */
575 bi->needs_retiring = 1;
576 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
577 (TSTR("**>> Block %d needs retiring" TENDSTR), flash_block));
580 /* Delete the chunk */
581 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
582 yaffs_skip_rest_of_block(dev);
585 /*---------------- Name handling functions ------------*/
587 static u16 yaffs_calc_name_sum(const YCHAR * name)
592 const YUCHAR *bname = (const YUCHAR *)name;
594 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH / 2))) {
596 /* 0x1f mask is case insensitive */
597 sum += ((*bname) & 0x1f) * i;
605 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR * name)
607 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
608 memset(obj->short_name, 0,
609 sizeof(YCHAR) * (YAFFS_SHORT_NAME_LENGTH + 1));
611 && yaffs_strnlen(name,
612 YAFFS_SHORT_NAME_LENGTH + 1) <=
613 YAFFS_SHORT_NAME_LENGTH)
614 yaffs_strcpy(obj->short_name, name);
616 obj->short_name[0] = _Y('\0');
618 obj->sum = yaffs_calc_name_sum(name);
621 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
622 const struct yaffs_obj_hdr *oh)
624 #ifdef CONFIG_YAFFS_AUTO_UNICODE
625 YCHAR tmp_name[YAFFS_MAX_NAME_LENGTH + 1];
626 memset(tmp_name, 0, sizeof(tmp_name));
627 yaffs_load_name_from_oh(obj->my_dev, tmp_name, oh->name,
628 YAFFS_MAX_NAME_LENGTH + 1);
629 yaffs_set_obj_name(obj, tmp_name);
631 yaffs_set_obj_name(obj, oh->name);
635 /*-------------------- TNODES -------------------
637 * List of spare tnodes
638 * The list is hooked together using the first pointer
642 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev)
644 struct yaffs_tnode *tn = yaffs_alloc_raw_tnode(dev);
646 memset(tn, 0, dev->tnode_size);
650 dev->checkpoint_blocks_required = 0; /* force recalculation */
655 /* FreeTnode frees up a tnode and puts it back on the free list */
656 static void yaffs_free_tnode(struct yaffs_dev *dev, struct yaffs_tnode *tn)
658 yaffs_free_raw_tnode(dev, tn);
660 dev->checkpoint_blocks_required = 0; /* force recalculation */
663 static void yaffs_deinit_tnodes_and_objs(struct yaffs_dev *dev)
665 yaffs_deinit_raw_tnodes_and_objs(dev);
670 void yaffs_load_tnode_0(struct yaffs_dev *dev, struct yaffs_tnode *tn,
671 unsigned pos, unsigned val)
673 u32 *map = (u32 *) tn;
679 pos &= YAFFS_TNODES_LEVEL0_MASK;
680 val >>= dev->chunk_grp_bits;
682 bit_in_map = pos * dev->tnode_width;
683 word_in_map = bit_in_map / 32;
684 bit_in_word = bit_in_map & (32 - 1);
686 mask = dev->tnode_mask << bit_in_word;
688 map[word_in_map] &= ~mask;
689 map[word_in_map] |= (mask & (val << bit_in_word));
691 if (dev->tnode_width > (32 - bit_in_word)) {
692 bit_in_word = (32 - bit_in_word);
695 dev->tnode_mask >> ( /*dev->tnode_width - */ bit_in_word);
696 map[word_in_map] &= ~mask;
697 map[word_in_map] |= (mask & (val >> bit_in_word));
701 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
704 u32 *map = (u32 *) tn;
710 pos &= YAFFS_TNODES_LEVEL0_MASK;
712 bit_in_map = pos * dev->tnode_width;
713 word_in_map = bit_in_map / 32;
714 bit_in_word = bit_in_map & (32 - 1);
716 val = map[word_in_map] >> bit_in_word;
718 if (dev->tnode_width > (32 - bit_in_word)) {
719 bit_in_word = (32 - bit_in_word);
721 val |= (map[word_in_map] << bit_in_word);
724 val &= dev->tnode_mask;
725 val <<= dev->chunk_grp_bits;
730 /* ------------------- End of individual tnode manipulation -----------------*/
732 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
733 * The look up tree is represented by the top tnode and the number of top_level
734 * in the tree. 0 means only the level 0 tnode is in the tree.
737 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
738 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
739 struct yaffs_file_var *file_struct,
742 struct yaffs_tnode *tn = file_struct->top;
745 int level = file_struct->top_level;
749 /* Check sane level and chunk Id */
750 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
753 if (chunk_id > YAFFS_MAX_CHUNK_ID)
756 /* First check we're tall enough (ie enough top_level) */
758 i = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
761 i >>= YAFFS_TNODES_INTERNAL_BITS;
765 if (required_depth > file_struct->top_level)
766 return NULL; /* Not tall enough, so we can't find it */
768 /* Traverse down to level 0 */
769 while (level > 0 && tn) {
770 tn = tn->internal[(chunk_id >>
771 (YAFFS_TNODES_LEVEL0_BITS +
773 YAFFS_TNODES_INTERNAL_BITS)) &
774 YAFFS_TNODES_INTERNAL_MASK];
781 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
782 * This happens in two steps:
783 * 1. If the tree isn't tall enough, then make it taller.
784 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
786 * Used when modifying the tree.
788 * If the tn argument is NULL, then a fresh tnode will be added otherwise the specified tn will
789 * be plugged into the ttree.
792 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
793 struct yaffs_file_var *file_struct,
795 struct yaffs_tnode *passed_tn)
800 struct yaffs_tnode *tn;
804 /* Check sane level and page Id */
805 if (file_struct->top_level < 0
806 || file_struct->top_level > YAFFS_TNODES_MAX_LEVEL)
809 if (chunk_id > YAFFS_MAX_CHUNK_ID)
812 /* First check we're tall enough (ie enough top_level) */
814 x = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
817 x >>= YAFFS_TNODES_INTERNAL_BITS;
821 if (required_depth > file_struct->top_level) {
822 /* Not tall enough, gotta make the tree taller */
823 for (i = file_struct->top_level; i < required_depth; i++) {
825 tn = yaffs_get_tnode(dev);
828 tn->internal[0] = file_struct->top;
829 file_struct->top = tn;
830 file_struct->top_level++;
833 (TSTR("yaffs: no more tnodes" TENDSTR)));
839 /* Traverse down to level 0, adding anything we need */
841 l = file_struct->top_level;
842 tn = file_struct->top;
845 while (l > 0 && tn) {
847 (YAFFS_TNODES_LEVEL0_BITS +
848 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
849 YAFFS_TNODES_INTERNAL_MASK;
851 if ((l > 1) && !tn->internal[x]) {
852 /* Add missing non-level-zero tnode */
853 tn->internal[x] = yaffs_get_tnode(dev);
854 if (!tn->internal[x])
857 /* Looking from level 1 at level 0 */
859 /* If we already have one, then release it. */
861 yaffs_free_tnode(dev,
864 tn->internal[x] = passed_tn;
866 } else if (!tn->internal[x]) {
867 /* Don't have one, none passed in */
868 tn->internal[x] = yaffs_get_tnode(dev);
869 if (!tn->internal[x])
874 tn = tn->internal[x];
880 memcpy(tn, passed_tn,
881 (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8);
882 yaffs_free_tnode(dev, passed_tn);
889 static int yaffs_find_chunk_in_group(struct yaffs_dev *dev, int the_chunk,
890 struct yaffs_ext_tags *tags, int obj_id,
895 for (j = 0; the_chunk && j < dev->chunk_grp_size; j++) {
896 if (yaffs_check_chunk_bit
897 (dev, the_chunk / dev->param.chunks_per_block,
898 the_chunk % dev->param.chunks_per_block)) {
900 if (dev->chunk_grp_size == 1)
903 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
905 if (yaffs_tags_match(tags, obj_id, inode_chunk)) {
916 static void yaffs_soft_del_chunk(struct yaffs_dev *dev, int chunk)
918 struct yaffs_block_info *the_block;
921 T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
923 block_no = chunk / dev->param.chunks_per_block;
924 the_block = yaffs_get_block_info(dev, block_no);
926 the_block->soft_del_pages++;
927 dev->n_free_chunks++;
928 yaffs2_update_oldest_dirty_seq(dev, block_no, the_block);
932 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
933 * All soft deleting does is increment the block's softdelete count and pulls the chunk out
935 * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
938 static int yaffs_soft_del_worker(struct yaffs_obj *in, struct yaffs_tnode *tn,
939 u32 level, int chunk_offset)
944 struct yaffs_dev *dev = in->my_dev;
949 for (i = YAFFS_NTNODES_INTERNAL - 1; all_done && i >= 0;
951 if (tn->internal[i]) {
953 yaffs_soft_del_worker(in,
959 YAFFS_TNODES_INTERNAL_BITS)
962 yaffs_free_tnode(dev,
965 tn->internal[i] = NULL;
967 /* Hoosterman... how could this happen? */
971 return (all_done) ? 1 : 0;
972 } else if (level == 0) {
974 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
975 the_chunk = yaffs_get_group_base(dev, tn, i);
977 /* Note this does not find the real chunk, only the chunk group.
978 * We make an assumption that a chunk group is not larger than
981 yaffs_soft_del_chunk(dev, the_chunk);
982 yaffs_load_tnode_0(dev, tn, i, 0);
996 static void yaffs_soft_del_file(struct yaffs_obj *obj)
999 obj->variant_type == YAFFS_OBJECT_TYPE_FILE && !obj->soft_del) {
1000 if (obj->n_data_chunks <= 0) {
1001 /* Empty file with no duplicate object headers, just delete it immediately */
1002 yaffs_free_tnode(obj->my_dev,
1003 obj->variant.file_variant.top);
1004 obj->variant.file_variant.top = NULL;
1005 T(YAFFS_TRACE_TRACING,
1006 (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1008 yaffs_generic_obj_del(obj);
1010 yaffs_soft_del_worker(obj,
1011 obj->variant.file_variant.top,
1013 file_variant.top_level, 0);
1019 /* Pruning removes any part of the file structure tree that is beyond the
1020 * bounds of the file (ie that does not point to chunks).
1022 * A file should only get pruned when its size is reduced.
1024 * Before pruning, the chunks must be pulled from the tree and the
1025 * level 0 tnode entries must be zeroed out.
1026 * Could also use this for file deletion, but that's probably better handled
1027 * by a special case.
1029 * This function is recursive. For levels > 0 the function is called again on
1030 * any sub-tree. For level == 0 we just check if the sub-tree has data.
1031 * If there is no data in a subtree then it is pruned.
1034 static struct yaffs_tnode *yaffs_prune_worker(struct yaffs_dev *dev,
1035 struct yaffs_tnode *tn, u32 level,
1045 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1046 if (tn->internal[i]) {
1048 yaffs_prune_worker(dev,
1055 if (tn->internal[i])
1059 int tnode_size_u32 = dev->tnode_size / sizeof(u32);
1060 u32 *map = (u32 *) tn;
1062 for (i = 0; !has_data && i < tnode_size_u32; i++) {
1068 if (has_data == 0 && del0) {
1069 /* Free and return NULL */
1071 yaffs_free_tnode(dev, tn);
1081 static int yaffs_prune_tree(struct yaffs_dev *dev,
1082 struct yaffs_file_var *file_struct)
1087 struct yaffs_tnode *tn;
1089 if (file_struct->top_level > 0) {
1091 yaffs_prune_worker(dev, file_struct->top,
1092 file_struct->top_level, 0);
1094 /* Now we have a tree with all the non-zero branches NULL but the height
1095 * is the same as it was.
1096 * Let's see if we can trim internal tnodes to shorten the tree.
1097 * We can do this if only the 0th element in the tnode is in use
1098 * (ie all the non-zero are NULL)
1101 while (file_struct->top_level && !done) {
1102 tn = file_struct->top;
1105 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1106 if (tn->internal[i])
1111 file_struct->top = tn->internal[0];
1112 file_struct->top_level--;
1113 yaffs_free_tnode(dev, tn);
1123 /*-------------------- End of File Structure functions.-------------------*/
1125 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
1126 static struct yaffs_obj *yaffs_alloc_empty_obj(struct yaffs_dev *dev)
1128 struct yaffs_obj *obj = yaffs_alloc_raw_obj(dev);
1133 /* Now sweeten it up... */
1135 memset(obj, 0, sizeof(struct yaffs_obj));
1136 obj->being_created = 1;
1140 obj->variant_type = YAFFS_OBJECT_TYPE_UNKNOWN;
1141 INIT_LIST_HEAD(&(obj->hard_links));
1142 INIT_LIST_HEAD(&(obj->hash_link));
1143 INIT_LIST_HEAD(&obj->siblings);
1145 /* Now make the directory sane */
1146 if (dev->root_dir) {
1147 obj->parent = dev->root_dir;
1148 list_add(&(obj->siblings),
1149 &dev->root_dir->variant.dir_variant.children);
1152 /* Add it to the lost and found directory.
1153 * NB Can't put root or lost-n-found in lost-n-found so
1154 * check if lost-n-found exists first
1156 if (dev->lost_n_found)
1157 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
1159 obj->being_created = 0;
1162 dev->checkpoint_blocks_required = 0; /* force recalculation */
1167 static struct yaffs_obj *yaffs_create_fake_dir(struct yaffs_dev *dev,
1168 int number, u32 mode)
1171 struct yaffs_obj *obj =
1172 yaffs_new_obj(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1174 obj->fake = 1; /* it is fake so it might have no NAND presence... */
1175 obj->rename_allowed = 0; /* ... and we're not allowed to rename it... */
1176 obj->unlink_allowed = 0; /* ... or unlink it */
1179 obj->yst_mode = mode;
1181 obj->hdr_chunk = 0; /* Not a valid chunk. */
1188 static void yaffs_unhash_obj(struct yaffs_obj *obj)
1191 struct yaffs_dev *dev = obj->my_dev;
1193 /* If it is still linked into the bucket list, free from the list */
1194 if (!list_empty(&obj->hash_link)) {
1195 list_del_init(&obj->hash_link);
1196 bucket = yaffs_hash_fn(obj->obj_id);
1197 dev->obj_bucket[bucket].count--;
1201 /* FreeObject frees up a Object and puts it back on the free list */
1202 static void yaffs_free_obj(struct yaffs_obj *obj)
1204 struct yaffs_dev *dev = obj->my_dev;
1207 (TSTR("FreeObject %p inode %p" TENDSTR), obj, obj->my_inode));
1213 if (!list_empty(&obj->siblings))
1216 if (obj->my_inode) {
1217 /* We're still hooked up to a cached inode.
1218 * Don't delete now, but mark for later deletion
1220 obj->defered_free = 1;
1224 yaffs_unhash_obj(obj);
1226 yaffs_free_raw_obj(dev, obj);
1228 dev->checkpoint_blocks_required = 0; /* force recalculation */
1231 void yaffs_handle_defered_free(struct yaffs_obj *obj)
1233 if (obj->defered_free)
1234 yaffs_free_obj(obj);
1237 static void yaffs_init_tnodes_and_objs(struct yaffs_dev *dev)
1244 yaffs_init_raw_tnodes_and_objs(dev);
1246 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
1247 INIT_LIST_HEAD(&dev->obj_bucket[i].list);
1248 dev->obj_bucket[i].count = 0;
1252 static int yaffs_find_nice_bucket(struct yaffs_dev *dev)
1256 int lowest = 999999;
1258 /* Search for the shortest list or one that
1262 for (i = 0; i < 10 && lowest > 4; i++) {
1263 dev->bucket_finder++;
1264 dev->bucket_finder %= YAFFS_NOBJECT_BUCKETS;
1265 if (dev->obj_bucket[dev->bucket_finder].count < lowest) {
1266 lowest = dev->obj_bucket[dev->bucket_finder].count;
1267 l = dev->bucket_finder;
1275 static int yaffs_new_obj_id(struct yaffs_dev *dev)
1277 int bucket = yaffs_find_nice_bucket(dev);
1279 /* Now find an object value that has not already been taken
1280 * by scanning the list.
1284 struct list_head *i;
1286 u32 n = (u32) bucket;
1288 /* yaffs_check_obj_hash_sane(); */
1292 n += YAFFS_NOBJECT_BUCKETS;
1293 if (1 || dev->obj_bucket[bucket].count > 0) {
1294 list_for_each(i, &dev->obj_bucket[bucket].list) {
1295 /* If there is already one in the list */
1296 if (i && list_entry(i, struct yaffs_obj,
1297 hash_link)->obj_id == n) {
1307 static void yaffs_hash_obj(struct yaffs_obj *in)
1309 int bucket = yaffs_hash_fn(in->obj_id);
1310 struct yaffs_dev *dev = in->my_dev;
1312 list_add(&in->hash_link, &dev->obj_bucket[bucket].list);
1313 dev->obj_bucket[bucket].count++;
1316 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number)
1318 int bucket = yaffs_hash_fn(number);
1319 struct list_head *i;
1320 struct yaffs_obj *in;
1322 list_for_each(i, &dev->obj_bucket[bucket].list) {
1323 /* Look if it is in the list */
1325 in = list_entry(i, struct yaffs_obj, hash_link);
1326 if (in->obj_id == number) {
1328 /* Don't tell the VFS about this one if it is defered free */
1329 if (in->defered_free)
1340 struct yaffs_obj *yaffs_new_obj(struct yaffs_dev *dev, int number,
1341 enum yaffs_obj_type type)
1343 struct yaffs_obj *the_obj = NULL;
1344 struct yaffs_tnode *tn = NULL;
1347 number = yaffs_new_obj_id(dev);
1349 if (type == YAFFS_OBJECT_TYPE_FILE) {
1350 tn = yaffs_get_tnode(dev);
1355 the_obj = yaffs_alloc_empty_obj(dev);
1358 yaffs_free_tnode(dev, tn);
1364 the_obj->rename_allowed = 1;
1365 the_obj->unlink_allowed = 1;
1366 the_obj->obj_id = number;
1367 yaffs_hash_obj(the_obj);
1368 the_obj->variant_type = type;
1369 yaffs_load_current_time(the_obj, 1, 1);
1372 case YAFFS_OBJECT_TYPE_FILE:
1373 the_obj->variant.file_variant.file_size = 0;
1374 the_obj->variant.file_variant.scanned_size = 0;
1375 the_obj->variant.file_variant.shrink_size = ~0; /* max */
1376 the_obj->variant.file_variant.top_level = 0;
1377 the_obj->variant.file_variant.top = tn;
1379 case YAFFS_OBJECT_TYPE_DIRECTORY:
1380 INIT_LIST_HEAD(&the_obj->variant.dir_variant.children);
1381 INIT_LIST_HEAD(&the_obj->variant.dir_variant.dirty);
1383 case YAFFS_OBJECT_TYPE_SYMLINK:
1384 case YAFFS_OBJECT_TYPE_HARDLINK:
1385 case YAFFS_OBJECT_TYPE_SPECIAL:
1386 /* No action required */
1388 case YAFFS_OBJECT_TYPE_UNKNOWN:
1389 /* todo this should not happen */
1397 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
1399 enum yaffs_obj_type type)
1401 struct yaffs_obj *the_obj = NULL;
1404 the_obj = yaffs_find_by_number(dev, number);
1407 the_obj = yaffs_new_obj(dev, number, type);
1413 YCHAR *yaffs_clone_str(const YCHAR * str)
1415 YCHAR *new_str = NULL;
1421 len = yaffs_strnlen(str, YAFFS_MAX_ALIAS_LENGTH);
1422 new_str = YMALLOC((len + 1) * sizeof(YCHAR));
1424 yaffs_strncpy(new_str, str, len);
1432 * Mknod (create) a new object.
1433 * equiv_obj only has meaning for a hard link;
1434 * alias_str only has meaning for a symlink.
1435 * rdev only has meaning for devices (a subset of special objects)
1438 static struct yaffs_obj *yaffs_create_obj(enum yaffs_obj_type type,
1439 struct yaffs_obj *parent,
1444 struct yaffs_obj *equiv_obj,
1445 const YCHAR * alias_str, u32 rdev)
1447 struct yaffs_obj *in;
1450 struct yaffs_dev *dev = parent->my_dev;
1452 /* Check if the entry exists. If it does then fail the call since we don't want a dup. */
1453 if (yaffs_find_by_name(parent, name))
1456 if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
1457 str = yaffs_clone_str(alias_str);
1462 in = yaffs_new_obj(dev, -1, type);
1473 in->variant_type = type;
1475 in->yst_mode = mode;
1477 yaffs_attribs_init(in, gid, uid, rdev);
1479 in->n_data_chunks = 0;
1481 yaffs_set_obj_name(in, name);
1484 yaffs_add_obj_to_dir(parent, in);
1486 in->my_dev = parent->my_dev;
1489 case YAFFS_OBJECT_TYPE_SYMLINK:
1490 in->variant.symlink_variant.alias = str;
1492 case YAFFS_OBJECT_TYPE_HARDLINK:
1493 in->variant.hardlink_variant.equiv_obj = equiv_obj;
1494 in->variant.hardlink_variant.equiv_id =
1496 list_add(&in->hard_links, &equiv_obj->hard_links);
1498 case YAFFS_OBJECT_TYPE_FILE:
1499 case YAFFS_OBJECT_TYPE_DIRECTORY:
1500 case YAFFS_OBJECT_TYPE_SPECIAL:
1501 case YAFFS_OBJECT_TYPE_UNKNOWN:
1506 if (yaffs_update_oh(in, name, 0, 0, 0, NULL) < 0) {
1507 /* Could not create the object header, fail the creation */
1512 yaffs_update_parent(parent);
1518 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
1519 const YCHAR * name, u32 mode, u32 uid,
1522 return yaffs_create_obj(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
1523 uid, gid, NULL, NULL, 0);
1526 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR * name,
1527 u32 mode, u32 uid, u32 gid)
1529 return yaffs_create_obj(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
1530 mode, uid, gid, NULL, NULL, 0);
1533 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
1534 const YCHAR * name, u32 mode, u32 uid,
1537 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
1538 uid, gid, NULL, NULL, rdev);
1541 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
1542 const YCHAR * name, u32 mode, u32 uid,
1543 u32 gid, const YCHAR * alias)
1545 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
1546 uid, gid, NULL, alias, 0);
1549 /* yaffs_link_obj returns the object id of the equivalent object.*/
1550 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR * name,
1551 struct yaffs_obj *equiv_obj)
1553 /* Get the real object in case we were fed a hard link as an equivalent object */
1554 equiv_obj = yaffs_get_equivalent_obj(equiv_obj);
1556 if (yaffs_create_obj
1557 (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
1558 equiv_obj, NULL, 0)) {
1566 static int yaffs_change_obj_name(struct yaffs_obj *obj,
1567 struct yaffs_obj *new_dir,
1568 const YCHAR * new_name, int force, int shadows)
1573 struct yaffs_obj *existing_target;
1575 if (new_dir == NULL)
1576 new_dir = obj->parent; /* use the old directory */
1578 if (new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1579 T(YAFFS_TRACE_ALWAYS,
1581 ("tragedy: yaffs_change_obj_name: new_dir is not a directory"
1586 /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
1587 if (obj->my_dev->param.is_yaffs2)
1588 unlink_op = (new_dir == obj->my_dev->unlinked_dir);
1590 unlink_op = (new_dir == obj->my_dev->unlinked_dir
1591 && obj->variant_type == YAFFS_OBJECT_TYPE_FILE);
1593 del_op = (new_dir == obj->my_dev->del_dir);
1595 existing_target = yaffs_find_by_name(new_dir, new_name);
1597 /* If the object is a file going into the unlinked directory,
1598 * then it is OK to just stuff it in since duplicate names are allowed.
1599 * else only proceed if the new name does not exist and if we're putting
1600 * it into a directory.
1606 !existing_target) &&
1607 new_dir->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) {
1608 yaffs_set_obj_name(obj, new_name);
1611 yaffs_add_obj_to_dir(new_dir, obj);
1616 /* If it is a deletion then we mark it as a shrink for gc purposes. */
1617 if (yaffs_update_oh(obj, new_name, 0, del_op, shadows, NULL) >=
1625 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
1626 struct yaffs_obj *new_dir, const YCHAR * new_name)
1628 struct yaffs_obj *obj = NULL;
1629 struct yaffs_obj *existing_target = NULL;
1632 struct yaffs_dev *dev;
1634 if (!old_dir || old_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
1636 if (!new_dir || new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
1639 dev = old_dir->my_dev;
1641 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1642 /* Special case for case insemsitive systems.
1643 * While look-up is case insensitive, the name isn't.
1644 * Therefore we might want to change x.txt to X.txt
1646 if (old_dir == new_dir && yaffs_strcmp(old_name, new_name) == 0)
1650 if (yaffs_strnlen(new_name, YAFFS_MAX_NAME_LENGTH + 1) >
1651 YAFFS_MAX_NAME_LENGTH)
1655 obj = yaffs_find_by_name(old_dir, old_name);
1657 if (obj && obj->rename_allowed) {
1659 /* Now do the handling for an existing target, if there is one */
1661 existing_target = yaffs_find_by_name(new_dir, new_name);
1662 if (existing_target &&
1663 existing_target->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY
1664 && !list_empty(&existing_target->variant.dir_variant.
1666 /* There is a target that is a non-empty directory, so we fail */
1667 return YAFFS_FAIL; /* EEXIST or ENOTEMPTY */
1668 } else if (existing_target && existing_target != obj) {
1669 /* Nuke the target first, using shadowing,
1670 * but only if it isn't the same object.
1672 * Note we must disable gc otherwise it can mess up the shadowing.
1675 dev->gc_disable = 1;
1676 yaffs_change_obj_name(obj, new_dir, new_name, force,
1677 existing_target->obj_id);
1678 existing_target->is_shadowed = 1;
1679 yaffs_unlink_obj(existing_target);
1680 dev->gc_disable = 0;
1683 result = yaffs_change_obj_name(obj, new_dir, new_name, 1, 0);
1685 yaffs_update_parent(old_dir);
1686 if (new_dir != old_dir)
1687 yaffs_update_parent(new_dir);
1694 /*------------------------- Block Management and Page Allocation ----------------*/
1696 static int yaffs_init_blocks(struct yaffs_dev *dev)
1698 int n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
1700 dev->block_info = NULL;
1701 dev->chunk_bits = NULL;
1703 dev->alloc_block = -1; /* force it to get a new one */
1705 /* If the first allocation strategy fails, thry the alternate one */
1706 dev->block_info = YMALLOC(n_blocks * sizeof(struct yaffs_block_info));
1707 if (!dev->block_info) {
1709 YMALLOC_ALT(n_blocks * sizeof(struct yaffs_block_info));
1710 dev->block_info_alt = 1;
1712 dev->block_info_alt = 0;
1715 if (dev->block_info) {
1716 /* Set up dynamic blockinfo stuff. */
1717 dev->chunk_bit_stride = (dev->param.chunks_per_block + 7) / 8; /* round up bytes */
1718 dev->chunk_bits = YMALLOC(dev->chunk_bit_stride * n_blocks);
1719 if (!dev->chunk_bits) {
1721 YMALLOC_ALT(dev->chunk_bit_stride * n_blocks);
1722 dev->chunk_bits_alt = 1;
1724 dev->chunk_bits_alt = 0;
1728 if (dev->block_info && dev->chunk_bits) {
1729 memset(dev->block_info, 0,
1730 n_blocks * sizeof(struct yaffs_block_info));
1731 memset(dev->chunk_bits, 0, dev->chunk_bit_stride * n_blocks);
1738 static void yaffs_deinit_blocks(struct yaffs_dev *dev)
1740 if (dev->block_info_alt && dev->block_info)
1741 YFREE_ALT(dev->block_info);
1742 else if (dev->block_info)
1743 YFREE(dev->block_info);
1745 dev->block_info_alt = 0;
1747 dev->block_info = NULL;
1749 if (dev->chunk_bits_alt && dev->chunk_bits)
1750 YFREE_ALT(dev->chunk_bits);
1751 else if (dev->chunk_bits)
1752 YFREE(dev->chunk_bits);
1753 dev->chunk_bits_alt = 0;
1754 dev->chunk_bits = NULL;
1757 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no)
1759 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block_no);
1763 /* If the block is still healthy erase it and mark as clean.
1764 * If the block has had a data failure, then retire it.
1767 T(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
1768 (TSTR("yaffs_block_became_dirty block %d state %d %s" TENDSTR),
1769 block_no, bi->block_state,
1770 (bi->needs_retiring) ? "needs retiring" : ""));
1772 yaffs2_clear_oldest_dirty_seq(dev, bi);
1774 bi->block_state = YAFFS_BLOCK_STATE_DIRTY;
1776 /* If this is the block being garbage collected then stop gc'ing this block */
1777 if (block_no == dev->gc_block)
1780 /* If this block is currently the best candidate for gc then drop as a candidate */
1781 if (block_no == dev->gc_dirtiest) {
1782 dev->gc_dirtiest = 0;
1783 dev->gc_pages_in_use = 0;
1786 if (!bi->needs_retiring) {
1787 yaffs2_checkpt_invalidate(dev);
1788 erased_ok = yaffs_erase_block(dev, block_no);
1790 dev->n_erase_failures++;
1791 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1792 (TSTR("**>> Erasure failed %d" TENDSTR), block_no));
1797 ((yaffs_trace_mask & YAFFS_TRACE_ERASE)
1798 || !yaffs_skip_verification(dev))) {
1800 for (i = 0; i < dev->param.chunks_per_block; i++) {
1801 if (!yaffs_check_chunk_erased
1802 (dev, block_no * dev->param.chunks_per_block + i)) {
1803 T(YAFFS_TRACE_ERROR,
1805 (">>Block %d erasure supposedly OK, but chunk %d not erased"
1806 TENDSTR), block_no, i));
1812 /* Clean it up... */
1813 bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
1815 dev->n_erased_blocks++;
1816 bi->pages_in_use = 0;
1817 bi->soft_del_pages = 0;
1818 bi->has_shrink_hdr = 0;
1819 bi->skip_erased_check = 1; /* This is clean, so no need to check */
1820 bi->gc_prioritise = 0;
1821 yaffs_clear_chunk_bits(dev, block_no);
1823 T(YAFFS_TRACE_ERASE,
1824 (TSTR("Erased block %d" TENDSTR), block_no));
1826 dev->n_free_chunks -= dev->param.chunks_per_block; /* We lost a block of free space */
1828 yaffs_retire_block(dev, block_no);
1829 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1830 (TSTR("**>> Block %d retired" TENDSTR), block_no));
1834 static int yaffs_find_alloc_block(struct yaffs_dev *dev)
1838 struct yaffs_block_info *bi;
1840 if (dev->n_erased_blocks < 1) {
1841 /* Hoosterman we've got a problem.
1842 * Can't get space to gc
1844 T(YAFFS_TRACE_ERROR,
1845 (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
1850 /* Find an empty block. */
1852 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
1853 dev->alloc_block_finder++;
1854 if (dev->alloc_block_finder < dev->internal_start_block
1855 || dev->alloc_block_finder > dev->internal_end_block) {
1856 dev->alloc_block_finder = dev->internal_start_block;
1859 bi = yaffs_get_block_info(dev, dev->alloc_block_finder);
1861 if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
1862 bi->block_state = YAFFS_BLOCK_STATE_ALLOCATING;
1864 bi->seq_number = dev->seq_number;
1865 dev->n_erased_blocks--;
1866 T(YAFFS_TRACE_ALLOCATE,
1867 (TSTR("Allocated block %d, seq %d, %d left" TENDSTR),
1868 dev->alloc_block_finder, dev->seq_number,
1869 dev->n_erased_blocks));
1870 return dev->alloc_block_finder;
1874 T(YAFFS_TRACE_ALWAYS,
1876 ("yaffs tragedy: no more erased blocks, but there should have been %d"
1877 TENDSTR), dev->n_erased_blocks));
1883 * Check if there's space to allocate...
1884 * Thinks.... do we need top make this ths same as yaffs_get_free_chunks()?
1886 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks)
1888 int reserved_chunks;
1889 int reserved_blocks = dev->param.n_reserved_blocks;
1892 checkpt_blocks = yaffs_calc_checkpt_blocks_required(dev);
1895 ((reserved_blocks + checkpt_blocks) * dev->param.chunks_per_block);
1897 return (dev->n_free_chunks > (reserved_chunks + n_chunks));
1900 static int yaffs_alloc_chunk(struct yaffs_dev *dev, int use_reserver,
1901 struct yaffs_block_info **block_ptr)
1904 struct yaffs_block_info *bi;
1906 if (dev->alloc_block < 0) {
1907 /* Get next block to allocate off */
1908 dev->alloc_block = yaffs_find_alloc_block(dev);
1909 dev->alloc_page = 0;
1912 if (!use_reserver && !yaffs_check_alloc_available(dev, 1)) {
1913 /* Not enough space to allocate unless we're allowed to use the reserve. */
1917 if (dev->n_erased_blocks < dev->param.n_reserved_blocks
1918 && dev->alloc_page == 0) {
1919 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
1922 /* Next page please.... */
1923 if (dev->alloc_block >= 0) {
1924 bi = yaffs_get_block_info(dev, dev->alloc_block);
1926 ret_val = (dev->alloc_block * dev->param.chunks_per_block) +
1929 yaffs_set_chunk_bit(dev, dev->alloc_block, dev->alloc_page);
1933 dev->n_free_chunks--;
1935 /* If the block is full set the state to full */
1936 if (dev->alloc_page >= dev->param.chunks_per_block) {
1937 bi->block_state = YAFFS_BLOCK_STATE_FULL;
1938 dev->alloc_block = -1;
1947 T(YAFFS_TRACE_ERROR,
1948 (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
1953 static int yaffs_get_erased_chunks(struct yaffs_dev *dev)
1957 n = dev->n_erased_blocks * dev->param.chunks_per_block;
1959 if (dev->alloc_block > 0)
1960 n += (dev->param.chunks_per_block - dev->alloc_page);
1967 * yaffs_skip_rest_of_block() skips over the rest of the allocation block
1968 * if we don't want to write to it.
1970 void yaffs_skip_rest_of_block(struct yaffs_dev *dev)
1972 if (dev->alloc_block > 0) {
1973 struct yaffs_block_info *bi =
1974 yaffs_get_block_info(dev, dev->alloc_block);
1975 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING) {
1976 bi->block_state = YAFFS_BLOCK_STATE_FULL;
1977 dev->alloc_block = -1;
1982 static int yaffs_gc_block(struct yaffs_dev *dev, int block, int whole_block)
1987 int ret_val = YAFFS_OK;
1989 int is_checkpt_block;
1993 int chunks_before = yaffs_get_erased_chunks(dev);
1996 struct yaffs_ext_tags tags;
1998 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block);
2000 struct yaffs_obj *object;
2002 is_checkpt_block = (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT);
2004 T(YAFFS_TRACE_TRACING,
2006 ("Collecting block %d, in use %d, shrink %d, whole_block %d"
2007 TENDSTR), block, bi->pages_in_use, bi->has_shrink_hdr,
2010 /*yaffs_verify_free_chunks(dev); */
2012 if (bi->block_state == YAFFS_BLOCK_STATE_FULL)
2013 bi->block_state = YAFFS_BLOCK_STATE_COLLECTING;
2015 bi->has_shrink_hdr = 0; /* clear the flag so that the block can erase */
2017 dev->gc_disable = 1;
2019 if (is_checkpt_block || !yaffs_still_some_chunks(dev, block)) {
2020 T(YAFFS_TRACE_TRACING,
2022 ("Collecting block %d that has no chunks in use" TENDSTR),
2024 yaffs_block_became_dirty(dev, block);
2027 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
2029 yaffs_verify_blk(dev, bi, block);
2031 max_copies = (whole_block) ? dev->param.chunks_per_block : 5;
2032 old_chunk = block * dev->param.chunks_per_block + dev->gc_chunk;
2034 for ( /* init already done */ ;
2035 ret_val == YAFFS_OK &&
2036 dev->gc_chunk < dev->param.chunks_per_block &&
2037 (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) &&
2038 max_copies > 0; dev->gc_chunk++, old_chunk++) {
2039 if (yaffs_check_chunk_bit(dev, block, dev->gc_chunk)) {
2041 /* This page is in use and might need to be copied off */
2047 yaffs_init_tags(&tags);
2049 yaffs_rd_chunk_tags_nand(dev, old_chunk,
2052 object = yaffs_find_by_number(dev, tags.obj_id);
2054 T(YAFFS_TRACE_GC_DETAIL,
2056 ("Collecting chunk in block %d, %d %d %d "
2057 TENDSTR), dev->gc_chunk, tags.obj_id,
2058 tags.chunk_id, tags.n_bytes));
2060 if (object && !yaffs_skip_verification(dev)) {
2061 if (tags.chunk_id == 0)
2064 else if (object->soft_del)
2065 matching_chunk = old_chunk; /* Defeat the test */
2068 yaffs_find_chunk_in_file
2069 (object, tags.chunk_id,
2072 if (old_chunk != matching_chunk)
2073 T(YAFFS_TRACE_ERROR,
2075 ("gc: page in gc mismatch: %d %d %d %d"
2076 TENDSTR), old_chunk,
2077 matching_chunk, tags.obj_id,
2083 T(YAFFS_TRACE_ERROR,
2085 ("page %d in gc has no object: %d %d %d "
2086 TENDSTR), old_chunk,
2087 tags.obj_id, tags.chunk_id,
2093 object->soft_del && tags.chunk_id != 0) {
2094 /* Data chunk in a soft deleted file, throw it away
2095 * It's a soft deleted data chunk,
2096 * No need to copy this, just forget about it and
2097 * fix up the object.
2100 /* Free chunks already includes softdeleted chunks.
2101 * How ever this chunk is going to soon be really deleted
2102 * which will increment free chunks.
2103 * We have to decrement free chunks so this works out properly.
2105 dev->n_free_chunks--;
2106 bi->soft_del_pages--;
2108 object->n_data_chunks--;
2110 if (object->n_data_chunks <= 0) {
2111 /* remeber to clean up the object */
2112 dev->gc_cleanup_list[dev->
2119 /* Todo object && object->deleted && object->n_data_chunks == 0 */
2120 /* Deleted object header with no data chunks.
2121 * Can be discarded and the file deleted.
2123 object->hdr_chunk = 0;
2124 yaffs_free_tnode(object->my_dev,
2126 variant.file_variant.
2128 object->variant.file_variant.top = NULL;
2129 yaffs_generic_obj_del(object);
2131 } else if (object) {
2132 /* It's either a data chunk in a live file or
2133 * an ObjectHeader, so we're interested in it.
2134 * NB Need to keep the ObjectHeaders of deleted files
2135 * until the whole file has been deleted off
2137 tags.serial_number++;
2141 if (tags.chunk_id == 0) {
2142 /* It is an object Id,
2143 * We need to nuke the shrinkheader flags first
2144 * Also need to clean up shadowing.
2145 * We no longer want the shrink_header flag since its work is done
2146 * and if it is left in place it will mess up scanning.
2149 struct yaffs_obj_hdr *oh;
2150 oh = (struct yaffs_obj_hdr *)
2154 tags.extra_is_shrink = 0;
2156 oh->shadows_obj = 0;
2157 oh->inband_shadowed_obj_id = 0;
2158 tags.extra_shadows = 0;
2160 /* Update file size */
2161 if (object->variant_type ==
2162 YAFFS_OBJECT_TYPE_FILE) {
2171 yaffs_verify_oh(object, oh,
2174 yaffs_write_new_chunk(dev,
2181 yaffs_write_new_chunk(dev,
2187 if (new_chunk < 0) {
2188 ret_val = YAFFS_FAIL;
2191 /* Ok, now fix up the Tnodes etc. */
2193 if (tags.chunk_id == 0) {
2200 /* It's a data chunk */
2202 ok = yaffs_put_chunk_in_file(object, tags.chunk_id, new_chunk, 0);
2207 if (ret_val == YAFFS_OK)
2208 yaffs_chunk_del(dev, old_chunk,
2209 mark_flash, __LINE__);
2214 yaffs_release_temp_buffer(dev, buffer, __LINE__);
2218 yaffs_verify_collected_blk(dev, bi, block);
2220 if (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2222 * The gc did not complete. Set block state back to FULL
2223 * because checkpointing does not restore gc.
2225 bi->block_state = YAFFS_BLOCK_STATE_FULL;
2227 /* The gc completed. */
2228 /* Do any required cleanups */
2229 for (i = 0; i < dev->n_clean_ups; i++) {
2230 /* Time to delete the file too */
2232 yaffs_find_by_number(dev, dev->gc_cleanup_list[i]);
2234 yaffs_free_tnode(dev,
2237 object->variant.file_variant.top = NULL;
2240 ("yaffs: About to finally delete object %d"
2241 TENDSTR), object->obj_id));
2242 yaffs_generic_obj_del(object);
2243 object->my_dev->n_deleted_files--;
2248 chunks_after = yaffs_get_erased_chunks(dev);
2249 if (chunks_before >= chunks_after) {
2252 ("gc did not increase free chunks before %d after %d"
2253 TENDSTR), chunks_before, chunks_after));
2257 dev->n_clean_ups = 0;
2260 dev->gc_disable = 0;
2266 * FindBlockForgarbageCollection is used to select the dirtiest block (or close enough)
2267 * for garbage collection.
2270 static unsigned yaffs_find_gc_block(struct yaffs_dev *dev,
2271 int aggressive, int background)
2275 unsigned selected = 0;
2276 int prioritised = 0;
2277 int prioritised_exist = 0;
2278 struct yaffs_block_info *bi;
2281 /* First let's see if we need to grab a prioritised block */
2282 if (dev->has_pending_prioritised_gc && !aggressive) {
2283 dev->gc_dirtiest = 0;
2284 bi = dev->block_info;
2285 for (i = dev->internal_start_block;
2286 i <= dev->internal_end_block && !selected; i++) {
2288 if (bi->gc_prioritise) {
2289 prioritised_exist = 1;
2290 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2291 yaffs_block_ok_for_gc(dev, bi)) {
2300 * If there is a prioritised block and none was selected then
2301 * this happened because there is at least one old dirty block gumming
2302 * up the works. Let's gc the oldest dirty block.
2305 if (prioritised_exist &&
2306 !selected && dev->oldest_dirty_block > 0)
2307 selected = dev->oldest_dirty_block;
2309 if (!prioritised_exist) /* None found, so we can clear this */
2310 dev->has_pending_prioritised_gc = 0;
2313 /* If we're doing aggressive GC then we are happy to take a less-dirty block, and
2315 * else (we're doing a leasurely gc), then we only bother to do this if the
2316 * block has only a few pages in use.
2322 dev->internal_end_block - dev->internal_start_block + 1;
2324 threshold = dev->param.chunks_per_block;
2325 iterations = n_blocks;
2330 max_threshold = dev->param.chunks_per_block / 2;
2332 max_threshold = dev->param.chunks_per_block / 8;
2334 if (max_threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2335 max_threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2337 threshold = background ? (dev->gc_not_done + 2) * 2 : 0;
2338 if (threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2339 threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2340 if (threshold > max_threshold)
2341 threshold = max_threshold;
2343 iterations = n_blocks / 16 + 1;
2344 if (iterations > 100)
2350 (dev->gc_dirtiest < 1 ||
2351 dev->gc_pages_in_use > YAFFS_GC_GOOD_ENOUGH); i++) {
2352 dev->gc_block_finder++;
2353 if (dev->gc_block_finder < dev->internal_start_block ||
2354 dev->gc_block_finder > dev->internal_end_block)
2355 dev->gc_block_finder =
2356 dev->internal_start_block;
2358 bi = yaffs_get_block_info(dev, dev->gc_block_finder);
2360 pages_used = bi->pages_in_use - bi->soft_del_pages;
2362 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2363 pages_used < dev->param.chunks_per_block &&
2364 (dev->gc_dirtiest < 1
2365 || pages_used < dev->gc_pages_in_use)
2366 && yaffs_block_ok_for_gc(dev, bi)) {
2367 dev->gc_dirtiest = dev->gc_block_finder;
2368 dev->gc_pages_in_use = pages_used;
2372 if (dev->gc_dirtiest > 0 && dev->gc_pages_in_use <= threshold)
2373 selected = dev->gc_dirtiest;
2377 * If nothing has been selected for a while, try selecting the oldest dirty
2378 * because that's gumming up the works.
2381 if (!selected && dev->param.is_yaffs2 &&
2382 dev->gc_not_done >= (background ? 10 : 20)) {
2383 yaffs2_find_oldest_dirty_seq(dev);
2384 if (dev->oldest_dirty_block > 0) {
2385 selected = dev->oldest_dirty_block;
2386 dev->gc_dirtiest = selected;
2387 dev->oldest_dirty_gc_count++;
2388 bi = yaffs_get_block_info(dev, selected);
2389 dev->gc_pages_in_use =
2390 bi->pages_in_use - bi->soft_del_pages;
2392 dev->gc_not_done = 0;
2399 ("GC Selected block %d with %d free, prioritised:%d"
2401 dev->param.chunks_per_block - dev->gc_pages_in_use,
2408 dev->gc_dirtiest = 0;
2409 dev->gc_pages_in_use = 0;
2410 dev->gc_not_done = 0;
2411 if (dev->refresh_skip > 0)
2412 dev->refresh_skip--;
2417 ("GC none: finder %d skip %d threshold %d dirtiest %d using %d oldest %d%s"
2418 TENDSTR), dev->gc_block_finder, dev->gc_not_done, threshold,
2419 dev->gc_dirtiest, dev->gc_pages_in_use,
2420 dev->oldest_dirty_block, background ? " bg" : ""));
2426 /* New garbage collector
2427 * If we're very low on erased blocks then we do aggressive garbage collection
2428 * otherwise we do "leasurely" garbage collection.
2429 * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2430 * Passive gc only inspects smaller areas and will only accept more dirty blocks.
2432 * The idea is to help clear out space in a more spread-out manner.
2433 * Dunno if it really does anything useful.
2435 static int yaffs_check_gc(struct yaffs_dev *dev, int background)
2438 int gc_ok = YAFFS_OK;
2442 int checkpt_block_adjust;
2444 if (dev->param.gc_control && (dev->param.gc_control(dev) & 1) == 0)
2447 if (dev->gc_disable) {
2448 /* Bail out so we don't get recursive gc */
2452 /* This loop should pass the first time.
2453 * We'll only see looping here if the collection does not increase space.
2459 checkpt_block_adjust = yaffs_calc_checkpt_blocks_required(dev);
2462 dev->param.n_reserved_blocks + checkpt_block_adjust + 1;
2464 dev->n_erased_blocks * dev->param.chunks_per_block;
2466 /* If we need a block soon then do aggressive gc. */
2467 if (dev->n_erased_blocks < min_erased)
2471 && erased_chunks > (dev->n_free_chunks / 4))
2474 if (dev->gc_skip > 20)
2476 if (erased_chunks < dev->n_free_chunks / 2 ||
2477 dev->gc_skip < 1 || background)
2487 /* If we don't already have a block being gc'd then see if we should start another */
2489 if (dev->gc_block < 1 && !aggressive) {
2490 dev->gc_block = yaffs2_find_refresh_block(dev);
2492 dev->n_clean_ups = 0;
2494 if (dev->gc_block < 1) {
2496 yaffs_find_gc_block(dev, aggressive, background);
2498 dev->n_clean_ups = 0;
2501 if (dev->gc_block > 0) {
2504 dev->passive_gc_count++;
2508 ("yaffs: GC n_erased_blocks %d aggressive %d"
2509 TENDSTR), dev->n_erased_blocks, aggressive));
2511 gc_ok = yaffs_gc_block(dev, dev->gc_block, aggressive);
2514 if (dev->n_erased_blocks < (dev->param.n_reserved_blocks)
2515 && dev->gc_block > 0) {
2518 ("yaffs: GC !!!no reclaim!!! n_erased_blocks %d after try %d block %d"
2519 TENDSTR), dev->n_erased_blocks, max_tries,
2522 } while ((dev->n_erased_blocks < dev->param.n_reserved_blocks) &&
2523 (dev->gc_block > 0) && (max_tries < 2));
2525 return aggressive ? gc_ok : YAFFS_OK;
2530 * Garbage collects. Intended to be called from a background thread.
2531 * Returns non-zero if at least half the free chunks are erased.
2533 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency)
2535 int erased_chunks = dev->n_erased_blocks * dev->param.chunks_per_block;
2537 T(YAFFS_TRACE_BACKGROUND, (TSTR("Background gc %u" TENDSTR), urgency));
2539 yaffs_check_gc(dev, 1);
2540 return erased_chunks > dev->n_free_chunks / 2;
2543 /*------------------------- TAGS --------------------------------*/
2545 static int yaffs_tags_match(const struct yaffs_ext_tags *tags, int obj_id,
2548 return (tags->chunk_id == chunk_obj &&
2549 tags->obj_id == obj_id && !tags->is_deleted) ? 1 : 0;
2553 /*-------------------- Data file manipulation -----------------*/
2555 static int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
2556 struct yaffs_ext_tags *tags)
2558 /*Get the Tnode, then get the level 0 offset chunk offset */
2559 struct yaffs_tnode *tn;
2561 struct yaffs_ext_tags local_tags;
2564 struct yaffs_dev *dev = in->my_dev;
2567 /* Passed a NULL, so use our own tags space */
2571 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
2574 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
2577 yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
2583 static int yaffs_find_del_file_chunk(struct yaffs_obj *in, int inode_chunk,
2584 struct yaffs_ext_tags *tags)
2586 /* Get the Tnode, then get the level 0 offset chunk offset */
2587 struct yaffs_tnode *tn;
2589 struct yaffs_ext_tags local_tags;
2591 struct yaffs_dev *dev = in->my_dev;
2595 /* Passed a NULL, so use our own tags space */
2599 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
2603 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
2606 yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
2609 /* Delete the entry in the filestructure (if found) */
2611 yaffs_load_tnode_0(dev, tn, inode_chunk, 0);
2617 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
2618 int nand_chunk, int in_scan)
2620 /* NB in_scan is zero unless scanning.
2621 * For forward scanning, in_scan is > 0;
2622 * for backward scanning in_scan is < 0
2624 * nand_chunk = 0 is a dummy insert to make sure the tnodes are there.
2627 struct yaffs_tnode *tn;
2628 struct yaffs_dev *dev = in->my_dev;
2630 struct yaffs_ext_tags existing_tags;
2631 struct yaffs_ext_tags new_tags;
2632 unsigned existing_serial, new_serial;
2634 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE) {
2635 /* Just ignore an attempt at putting a chunk into a non-file during scanning
2636 * If it is not during Scanning then something went wrong!
2639 T(YAFFS_TRACE_ERROR,
2641 ("yaffs tragedy:attempt to put data chunk into a non-file"
2646 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
2650 tn = yaffs_add_find_tnode_0(dev,
2651 &in->variant.file_variant,
2657 /* Dummy insert, bail now */
2660 existing_cunk = yaffs_get_group_base(dev, tn, inode_chunk);
2663 /* If we're scanning then we need to test for duplicates
2664 * NB This does not need to be efficient since it should only ever
2665 * happen when the power fails during a write, then only one
2666 * chunk should ever be affected.
2668 * Correction for YAFFS2: This could happen quite a lot and we need to think about efficiency! TODO
2669 * Update: For backward scanning we don't need to re-read tags so this is quite cheap.
2672 if (existing_cunk > 0) {
2673 /* NB Right now existing chunk will not be real chunk_id if the chunk group size > 1
2674 * thus we have to do a FindChunkInFile to get the real chunk id.
2676 * We have a duplicate now we need to decide which one to use:
2678 * Backwards scanning YAFFS2: The old one is what we use, dump the new one.
2679 * Forward scanning YAFFS2: The new one is what we use, dump the old one.
2680 * YAFFS1: Get both sets of tags and compare serial numbers.
2684 /* Only do this for forward scanning */
2685 yaffs_rd_chunk_tags_nand(dev,
2689 /* Do a proper find */
2691 yaffs_find_chunk_in_file(in, inode_chunk,
2695 if (existing_cunk <= 0) {
2696 /*Hoosterman - how did this happen? */
2698 T(YAFFS_TRACE_ERROR,
2700 ("yaffs tragedy: existing chunk < 0 in scan"
2705 /* NB The deleted flags should be false, otherwise the chunks will
2706 * not be loaded during a scan
2710 new_serial = new_tags.serial_number;
2711 existing_serial = existing_tags.serial_number;
2714 if ((in_scan > 0) &&
2715 (existing_cunk <= 0 ||
2716 ((existing_serial + 1) & 3) == new_serial)) {
2717 /* Forward scanning.
2719 * Delete the old one and drop through to update the tnode
2721 yaffs_chunk_del(dev, existing_cunk, 1,
2724 /* Backward scanning or we want to use the existing one
2726 * Delete the new one and return early so that the tnode isn't changed
2728 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
2735 if (existing_cunk == 0)
2736 in->n_data_chunks++;
2738 yaffs_load_tnode_0(dev, tn, inode_chunk, nand_chunk);
2743 static int yaffs_rd_data_obj(struct yaffs_obj *in, int inode_chunk, u8 * buffer)
2745 int nand_chunk = yaffs_find_chunk_in_file(in, inode_chunk, NULL);
2747 if (nand_chunk >= 0)
2748 return yaffs_rd_chunk_tags_nand(in->my_dev, nand_chunk,
2751 T(YAFFS_TRACE_NANDACCESS,
2752 (TSTR("Chunk %d not found zero instead" TENDSTR),
2754 /* get sane (zero) data if you read a hole */
2755 memset(buffer, 0, in->my_dev->data_bytes_per_chunk);
2761 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
2766 struct yaffs_ext_tags tags;
2767 struct yaffs_block_info *bi;
2773 block = chunk_id / dev->param.chunks_per_block;
2774 page = chunk_id % dev->param.chunks_per_block;
2776 if (!yaffs_check_chunk_bit(dev, block, page))
2777 T(YAFFS_TRACE_VERIFY,
2778 (TSTR("Deleting invalid chunk %d" TENDSTR), chunk_id));
2780 bi = yaffs_get_block_info(dev, block);
2782 yaffs2_update_oldest_dirty_seq(dev, block, bi);
2784 T(YAFFS_TRACE_DELETION,
2785 (TSTR("line %d delete of chunk %d" TENDSTR), lyn, chunk_id));
2787 if (!dev->param.is_yaffs2 && mark_flash &&
2788 bi->block_state != YAFFS_BLOCK_STATE_COLLECTING) {
2790 yaffs_init_tags(&tags);
2792 tags.is_deleted = 1;
2794 yaffs_wr_chunk_tags_nand(dev, chunk_id, NULL, &tags);
2795 yaffs_handle_chunk_update(dev, chunk_id, &tags);
2797 dev->n_unmarked_deletions++;
2800 /* Pull out of the management area.
2801 * If the whole block became dirty, this will kick off an erasure.
2803 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING ||
2804 bi->block_state == YAFFS_BLOCK_STATE_FULL ||
2805 bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
2806 bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2807 dev->n_free_chunks++;
2809 yaffs_clear_chunk_bit(dev, block, page);
2813 if (bi->pages_in_use == 0 &&
2814 !bi->has_shrink_hdr &&
2815 bi->block_state != YAFFS_BLOCK_STATE_ALLOCATING &&
2816 bi->block_state != YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
2817 yaffs_block_became_dirty(dev, block);
2824 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
2825 const u8 * buffer, int n_bytes, int use_reserve)
2827 /* Find old chunk Need to do this to get serial number
2828 * Write new one and patch into tree.
2829 * Invalidate old tags.
2833 struct yaffs_ext_tags prev_tags;
2836 struct yaffs_ext_tags new_tags;
2838 struct yaffs_dev *dev = in->my_dev;
2840 yaffs_check_gc(dev, 0);
2842 /* Get the previous chunk at this location in the file if it exists.
2843 * If it does not exist then put a zero into the tree. This creates
2844 * the tnode now, rather than later when it is harder to clean up.
2846 prev_chunk_id = yaffs_find_chunk_in_file(in, inode_chunk, &prev_tags);
2847 if (prev_chunk_id < 1 &&
2848 !yaffs_put_chunk_in_file(in, inode_chunk, 0, 0))
2851 /* Set up new tags */
2852 yaffs_init_tags(&new_tags);
2854 new_tags.chunk_id = inode_chunk;
2855 new_tags.obj_id = in->obj_id;
2856 new_tags.serial_number =
2857 (prev_chunk_id > 0) ? prev_tags.serial_number + 1 : 1;
2858 new_tags.n_bytes = n_bytes;
2860 if (n_bytes < 1 || n_bytes > dev->param.total_bytes_per_chunk) {
2861 T(YAFFS_TRACE_ERROR,
2862 (TSTR("Writing %d bytes to chunk!!!!!!!!!" TENDSTR),
2868 yaffs_write_new_chunk(dev, buffer, &new_tags, use_reserve);
2870 if (new_chunk_id > 0) {
2871 yaffs_put_chunk_in_file(in, inode_chunk, new_chunk_id, 0);
2873 if (prev_chunk_id > 0)
2874 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
2876 yaffs_verify_file_sane(in);
2878 return new_chunk_id;
2882 /* UpdateObjectHeader updates the header on NAND for an object.
2883 * If name is not NULL, then that new name is used.
2885 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR * name, int force,
2886 int is_shrink, int shadows, struct yaffs_xattr_mod *xmod)
2889 struct yaffs_block_info *bi;
2891 struct yaffs_dev *dev = in->my_dev;
2898 struct yaffs_ext_tags new_tags;
2899 struct yaffs_ext_tags old_tags;
2900 const YCHAR *alias = NULL;
2903 YCHAR old_name[YAFFS_MAX_NAME_LENGTH + 1];
2905 struct yaffs_obj_hdr *oh = NULL;
2907 yaffs_strcpy(old_name, _Y("silly old name"));
2909 if (!in->fake || in == dev->root_dir || /* The root_dir should also be saved */
2912 yaffs_check_gc(dev, 0);
2913 yaffs_check_obj_details_loaded(in);
2915 buffer = yaffs_get_temp_buffer(in->my_dev, __LINE__);
2916 oh = (struct yaffs_obj_hdr *)buffer;
2918 prev_chunk_id = in->hdr_chunk;
2920 if (prev_chunk_id > 0) {
2921 result = yaffs_rd_chunk_tags_nand(dev, prev_chunk_id,
2924 yaffs_verify_oh(in, oh, &old_tags, 0);
2926 memcpy(old_name, oh->name, sizeof(oh->name));
2927 memset(buffer, 0xFF, sizeof(struct yaffs_obj_hdr));
2929 memset(buffer, 0xFF, dev->data_bytes_per_chunk);
2932 oh->type = in->variant_type;
2933 oh->yst_mode = in->yst_mode;
2934 oh->shadows_obj = oh->inband_shadowed_obj_id = shadows;
2936 yaffs_load_attribs_oh(oh, in);
2939 oh->parent_obj_id = in->parent->obj_id;
2941 oh->parent_obj_id = 0;
2943 if (name && *name) {
2944 memset(oh->name, 0, sizeof(oh->name));
2945 yaffs_load_oh_from_name(dev, oh->name, name);
2946 } else if (prev_chunk_id > 0) {
2947 memcpy(oh->name, old_name, sizeof(oh->name));
2949 memset(oh->name, 0, sizeof(oh->name));
2952 oh->is_shrink = is_shrink;
2954 switch (in->variant_type) {
2955 case YAFFS_OBJECT_TYPE_UNKNOWN:
2956 /* Should not happen */
2958 case YAFFS_OBJECT_TYPE_FILE:
2960 (oh->parent_obj_id == YAFFS_OBJECTID_DELETED
2961 || oh->parent_obj_id ==
2962 YAFFS_OBJECTID_UNLINKED) ? 0 : in->
2963 variant.file_variant.file_size;
2965 case YAFFS_OBJECT_TYPE_HARDLINK:
2966 oh->equiv_id = in->variant.hardlink_variant.equiv_id;
2968 case YAFFS_OBJECT_TYPE_SPECIAL:
2971 case YAFFS_OBJECT_TYPE_DIRECTORY:
2974 case YAFFS_OBJECT_TYPE_SYMLINK:
2975 alias = in->variant.symlink_variant.alias;
2977 alias = _Y("no alias");
2978 yaffs_strncpy(oh->alias, alias, YAFFS_MAX_ALIAS_LENGTH);
2979 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
2983 /* process any xattrib modifications */
2985 yaffs_apply_xattrib_mod(in, (char *)buffer, xmod);
2988 yaffs_init_tags(&new_tags);
2990 new_tags.chunk_id = 0;
2991 new_tags.obj_id = in->obj_id;
2992 new_tags.serial_number = in->serial;
2994 /* Add extra info for file header */
2996 new_tags.extra_available = 1;
2997 new_tags.extra_parent_id = oh->parent_obj_id;
2998 new_tags.extra_length = oh->file_size;
2999 new_tags.extra_is_shrink = oh->is_shrink;
3000 new_tags.extra_equiv_id = oh->equiv_id;
3001 new_tags.extra_shadows = (oh->shadows_obj > 0) ? 1 : 0;
3002 new_tags.extra_obj_type = in->variant_type;
3004 yaffs_verify_oh(in, oh, &new_tags, 1);
3006 /* Create new chunk in NAND */
3008 yaffs_write_new_chunk(dev, buffer, &new_tags,
3009 (prev_chunk_id > 0) ? 1 : 0);
3011 if (new_chunk_id >= 0) {
3013 in->hdr_chunk = new_chunk_id;
3015 if (prev_chunk_id > 0) {
3016 yaffs_chunk_del(dev, prev_chunk_id, 1,
3020 if (!yaffs_obj_cache_dirty(in))
3023 /* If this was a shrink, then mark the block that the chunk lives on */
3025 bi = yaffs_get_block_info(in->my_dev,
3029 bi->has_shrink_hdr = 1;
3034 ret_val = new_chunk_id;
3039 yaffs_release_temp_buffer(dev, buffer, __LINE__);
3044 /*------------------------ Short Operations Cache ----------------------------------------
3045 * In many situations where there is no high level buffering a lot of
3046 * reads might be short sequential reads, and a lot of writes may be short
3047 * sequential writes. eg. scanning/writing a jpeg file.
3048 * In these cases, a short read/write cache can provide a huge perfomance
3049 * benefit with dumb-as-a-rock code.
3050 * In Linux, the page cache provides read buffering and the short op cache
3051 * provides write buffering.
3053 * There are a limited number (~10) of cache chunks per device so that we don't
3054 * need a very intelligent search.
3057 static int yaffs_obj_cache_dirty(struct yaffs_obj *obj)
3059 struct yaffs_dev *dev = obj->my_dev;
3061 struct yaffs_cache *cache;
3062 int n_caches = obj->my_dev->param.n_caches;
3064 for (i = 0; i < n_caches; i++) {
3065 cache = &dev->cache[i];
3066 if (cache->object == obj && cache->dirty)
3073 static void yaffs_flush_file_cache(struct yaffs_obj *obj)
3075 struct yaffs_dev *dev = obj->my_dev;
3076 int lowest = -99; /* Stop compiler whining. */
3078 struct yaffs_cache *cache;
3079 int chunk_written = 0;
3080 int n_caches = obj->my_dev->param.n_caches;
3086 /* Find the dirty cache for this object with the lowest chunk id. */
3087 for (i = 0; i < n_caches; i++) {
3088 if (dev->cache[i].object == obj &&
3089 dev->cache[i].dirty) {
3091 || dev->cache[i].chunk_id <
3093 cache = &dev->cache[i];
3094 lowest = cache->chunk_id;
3099 if (cache && !cache->locked) {
3100 /* Write it out and free it up */
3103 yaffs_wr_data_obj(cache->object,
3108 cache->object = NULL;
3111 } while (cache && chunk_written > 0);
3114 /* Hoosterman, disk full while writing cache out. */
3115 T(YAFFS_TRACE_ERROR,
3117 ("yaffs tragedy: no space during cache write"
3125 /*yaffs_flush_whole_cache(dev)
3130 void yaffs_flush_whole_cache(struct yaffs_dev *dev)
3132 struct yaffs_obj *obj;
3133 int n_caches = dev->param.n_caches;
3136 /* Find a dirty object in the cache and flush it...
3137 * until there are no further dirty objects.
3141 for (i = 0; i < n_caches && !obj; i++) {
3142 if (dev->cache[i].object && dev->cache[i].dirty)
3143 obj = dev->cache[i].object;
3147 yaffs_flush_file_cache(obj);
3153 /* Grab us a cache chunk for use.
3154 * First look for an empty one.
3155 * Then look for the least recently used non-dirty one.
3156 * Then look for the least recently used dirty one...., flush and look again.
3158 static struct yaffs_cache *yaffs_grab_chunk_worker(struct yaffs_dev *dev)
3162 if (dev->param.n_caches > 0) {
3163 for (i = 0; i < dev->param.n_caches; i++) {
3164 if (!dev->cache[i].object)
3165 return &dev->cache[i];
3172 static struct yaffs_cache *yaffs_grab_chunk_cache(struct yaffs_dev *dev)
3174 struct yaffs_cache *cache;
3175 struct yaffs_obj *the_obj;
3180 if (dev->param.n_caches > 0) {
3181 /* Try find a non-dirty one... */
3183 cache = yaffs_grab_chunk_worker(dev);
3186 /* They were all dirty, find the last recently used object and flush
3187 * its cache, then find again.
3188 * NB what's here is not very accurate, we actually flush the object
3189 * the last recently used page.
3192 /* With locking we can't assume we can use entry zero */
3199 for (i = 0; i < dev->param.n_caches; i++) {
3200 if (dev->cache[i].object &&
3201 !dev->cache[i].locked &&
3202 (dev->cache[i].last_use < usage
3204 usage = dev->cache[i].last_use;
3205 the_obj = dev->cache[i].object;
3206 cache = &dev->cache[i];
3211 if (!cache || cache->dirty) {
3212 /* Flush and try again */
3213 yaffs_flush_file_cache(the_obj);
3214 cache = yaffs_grab_chunk_worker(dev);
3224 /* Find a cached chunk */
3225 static struct yaffs_cache *yaffs_find_chunk_cache(const struct yaffs_obj *obj,
3228 struct yaffs_dev *dev = obj->my_dev;
3230 if (dev->param.n_caches > 0) {
3231 for (i = 0; i < dev->param.n_caches; i++) {
3232 if (dev->cache[i].object == obj &&
3233 dev->cache[i].chunk_id == chunk_id) {
3236 return &dev->cache[i];
3243 /* Mark the chunk for the least recently used algorithym */
3244 static void yaffs_use_cache(struct yaffs_dev *dev, struct yaffs_cache *cache,
3248 if (dev->param.n_caches > 0) {
3249 if (dev->cache_last_use < 0 || dev->cache_last_use > 100000000) {
3250 /* Reset the cache usages */
3252 for (i = 1; i < dev->param.n_caches; i++)
3253 dev->cache[i].last_use = 0;
3255 dev->cache_last_use = 0;
3258 dev->cache_last_use++;
3260 cache->last_use = dev->cache_last_use;
3267 /* Invalidate a single cache page.
3268 * Do this when a whole page gets written,
3269 * ie the short cache for this page is no longer valid.
3271 static void yaffs_invalidate_chunk_cache(struct yaffs_obj *object, int chunk_id)
3273 if (object->my_dev->param.n_caches > 0) {
3274 struct yaffs_cache *cache =
3275 yaffs_find_chunk_cache(object, chunk_id);
3278 cache->object = NULL;
3282 /* Invalidate all the cache pages associated with this object
3283 * Do this whenever ther file is deleted or resized.
3285 static void yaffs_invalidate_whole_cache(struct yaffs_obj *in)
3288 struct yaffs_dev *dev = in->my_dev;
3290 if (dev->param.n_caches > 0) {
3291 /* Invalidate it. */
3292 for (i = 0; i < dev->param.n_caches; i++) {
3293 if (dev->cache[i].object == in)
3294 dev->cache[i].object = NULL;
3299 /*--------------------- File read/write ------------------------
3300 * Read and write have very similar structures.
3301 * In general the read/write has three parts to it
3302 * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3303 * Some complete chunks
3304 * An incomplete chunk to end off with
3306 * Curve-balls: the first chunk might also be the last chunk.
3309 int yaffs_file_rd(struct yaffs_obj *in, u8 * buffer, loff_t offset, int n_bytes)
3317 struct yaffs_cache *cache;
3319 struct yaffs_dev *dev;
3324 /* chunk = offset / dev->data_bytes_per_chunk + 1; */
3325 /* start = offset % dev->data_bytes_per_chunk; */
3326 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3329 /* OK now check for the curveball where the start and end are in
3332 if ((start + n) < dev->data_bytes_per_chunk)
3335 n_copy = dev->data_bytes_per_chunk - start;
3337 cache = yaffs_find_chunk_cache(in, chunk);
3339 /* If the chunk is already in the cache or it is less than a whole chunk
3340 * or we're using inband tags then use the cache (if there is caching)
3341 * else bypass the cache.
3343 if (cache || n_copy != dev->data_bytes_per_chunk
3344 || dev->param.inband_tags) {
3345 if (dev->param.n_caches > 0) {
3347 /* If we can't find the data in the cache, then load it up. */
3351 yaffs_grab_chunk_cache(in->my_dev);
3353 cache->chunk_id = chunk;
3356 yaffs_rd_data_obj(in, chunk,
3361 yaffs_use_cache(dev, cache, 0);
3365 memcpy(buffer, &cache->data[start], n_copy);
3369 /* Read into the local buffer then copy.. */
3372 yaffs_get_temp_buffer(dev, __LINE__);
3373 yaffs_rd_data_obj(in, chunk, local_buffer);
3375 memcpy(buffer, &local_buffer[start], n_copy);
3377 yaffs_release_temp_buffer(dev, local_buffer,
3383 /* A full chunk. Read directly into the supplied buffer. */
3384 yaffs_rd_data_obj(in, chunk, buffer);
3398 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 * buffer, loff_t offset,
3399 int n_bytes, int write_trhrough)
3408 int start_write = offset;
3409 int chunk_written = 0;
3413 struct yaffs_dev *dev;
3417 while (n > 0 && chunk_written >= 0) {
3418 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3420 if (chunk * dev->data_bytes_per_chunk + start != offset ||
3421 start >= dev->data_bytes_per_chunk) {
3422 T(YAFFS_TRACE_ERROR,
3424 ("AddrToChunk of offset %d gives chunk %d start %d"
3425 TENDSTR), (int)offset, chunk, start));
3427 chunk++; /* File pos to chunk in file offset */
3429 /* OK now check for the curveball where the start and end are in
3433 if ((start + n) < dev->data_bytes_per_chunk) {
3436 /* Now folks, to calculate how many bytes to write back....
3437 * If we're overwriting and not writing to then end of file then
3438 * we need to write back as much as was there before.
3441 chunk_start = ((chunk - 1) * dev->data_bytes_per_chunk);
3443 if (chunk_start > in->variant.file_variant.file_size)
3444 n_bytes_read = 0; /* Past end of file */
3447 in->variant.file_variant.file_size -
3450 if (n_bytes_read > dev->data_bytes_per_chunk)
3451 n_bytes_read = dev->data_bytes_per_chunk;
3455 (start + n)) ? n_bytes_read : (start + n);
3458 || n_writeback > dev->data_bytes_per_chunk)
3462 n_copy = dev->data_bytes_per_chunk - start;
3463 n_writeback = dev->data_bytes_per_chunk;
3466 if (n_copy != dev->data_bytes_per_chunk
3467 || dev->param.inband_tags) {
3468 /* An incomplete start or end chunk (or maybe both start and end chunk),
3469 * or we're using inband tags, so we want to use the cache buffers.
3471 if (dev->param.n_caches > 0) {
3472 struct yaffs_cache *cache;
3473 /* If we can't find the data in the cache, then load the cache */
3474 cache = yaffs_find_chunk_cache(in, chunk);
3477 && yaffs_check_alloc_available(dev, 1)) {
3478 cache = yaffs_grab_chunk_cache(dev);
3480 cache->chunk_id = chunk;
3483 yaffs_rd_data_obj(in, chunk,
3487 !yaffs_check_alloc_available(dev,
3489 /* Drop the cache if it was a read cache item and
3490 * no space check has been made for it.
3496 yaffs_use_cache(dev, cache, 1);
3499 memcpy(&cache->data[start], buffer,
3503 cache->n_bytes = n_writeback;
3505 if (write_trhrough) {
3516 chunk_written = -1; /* fail the write */
3519 /* An incomplete start or end chunk (or maybe both start and end chunk)
3520 * Read into the local buffer then copy, then copy over and write back.
3524 yaffs_get_temp_buffer(dev, __LINE__);
3526 yaffs_rd_data_obj(in, chunk, local_buffer);
3528 memcpy(&local_buffer[start], buffer, n_copy);
3531 yaffs_wr_data_obj(in, chunk,
3535 yaffs_release_temp_buffer(dev, local_buffer,
3541 /* A full chunk. Write directly from the supplied buffer. */
3544 yaffs_wr_data_obj(in, chunk, buffer,
3545 dev->data_bytes_per_chunk, 0);
3547 /* Since we've overwritten the cached data, we better invalidate it. */
3548 yaffs_invalidate_chunk_cache(in, chunk);
3551 if (chunk_written >= 0) {
3560 /* Update file object */
3562 if ((start_write + n_done) > in->variant.file_variant.file_size)
3563 in->variant.file_variant.file_size = (start_write + n_done);
3570 int yaffs_wr_file(struct yaffs_obj *in, const u8 * buffer, loff_t offset,
3571 int n_bytes, int write_trhrough)
3573 yaffs2_handle_hole(in, offset);
3574 return yaffs_do_file_wr(in, buffer, offset, n_bytes, write_trhrough);
3577 /* ---------------------- File resizing stuff ------------------ */
3579 static void yaffs_prune_chunks(struct yaffs_obj *in, int new_size)
3582 struct yaffs_dev *dev = in->my_dev;
3583 int old_size = in->variant.file_variant.file_size;
3585 int last_del = 1 + (old_size - 1) / dev->data_bytes_per_chunk;
3587 int start_del = 1 + (new_size + dev->data_bytes_per_chunk - 1) /
3588 dev->data_bytes_per_chunk;
3592 /* Delete backwards so that we don't end up with holes if
3593 * power is lost part-way through the operation.
3595 for (i = last_del; i >= start_del; i--) {
3596 /* NB this could be optimised somewhat,
3597 * eg. could retrieve the tags and write them without
3598 * using yaffs_chunk_del
3601 chunk_id = yaffs_find_del_file_chunk(in, i, NULL);
3604 (dev->internal_start_block *
3605 dev->param.chunks_per_block)
3607 ((dev->internal_end_block +
3608 1) * dev->param.chunks_per_block)) {
3609 T(YAFFS_TRACE_ALWAYS,
3611 ("Found daft chunk_id %d for %d" TENDSTR),
3614 in->n_data_chunks--;
3615 yaffs_chunk_del(dev, chunk_id, 1, __LINE__);
3622 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size)
3626 struct yaffs_dev *dev = obj->my_dev;
3628 yaffs_addr_to_chunk(dev, new_size, &new_full, &new_partial);
3630 yaffs_prune_chunks(obj, new_size);
3632 if (new_partial != 0) {
3633 int last_chunk = 1 + new_full;
3634 u8 *local_buffer = yaffs_get_temp_buffer(dev, __LINE__);
3636 /* Got to read and rewrite the last chunk with its new size and zero pad */
3637 yaffs_rd_data_obj(obj, last_chunk, local_buffer);
3638 memset(local_buffer + new_partial, 0,
3639 dev->data_bytes_per_chunk - new_partial);
3641 yaffs_wr_data_obj(obj, last_chunk, local_buffer,
3644 yaffs_release_temp_buffer(dev, local_buffer, __LINE__);
3647 obj->variant.file_variant.file_size = new_size;
3649 yaffs_prune_tree(dev, &obj->variant.file_variant);
3652 int yaffs_resize_file(struct yaffs_obj *in, loff_t new_size)
3654 struct yaffs_dev *dev = in->my_dev;
3655 int old_size = in->variant.file_variant.file_size;
3657 yaffs_flush_file_cache(in);
3658 yaffs_invalidate_whole_cache(in);
3660 yaffs_check_gc(dev, 0);
3662 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE)
3665 if (new_size == old_size)
3668 if (new_size > old_size) {
3669 yaffs2_handle_hole(in, new_size);
3670 in->variant.file_variant.file_size = new_size;
3672 /* new_size < old_size */
3673 yaffs_resize_file_down(in, new_size);
3676 /* Write a new object header to reflect the resize.
3677 * show we've shrunk the file, if need be
3678 * Do this only if the file is not in the deleted directories
3679 * and is not shadowed.
3683 in->parent->obj_id != YAFFS_OBJECTID_UNLINKED &&
3684 in->parent->obj_id != YAFFS_OBJECTID_DELETED)
3685 yaffs_update_oh(in, NULL, 0, 0, 0, NULL);
3690 int yaffs_flush_file(struct yaffs_obj *in, int update_time, int data_sync)
3694 yaffs_flush_file_cache(in);
3695 if (data_sync) /* Only sync data */
3699 yaffs_load_current_time(in, 0, 0);
3701 ret_val = (yaffs_update_oh(in, NULL, 0, 0, 0, NULL) >=
3702 0) ? YAFFS_OK : YAFFS_FAIL;
3712 static int yaffs_generic_obj_del(struct yaffs_obj *in)
3715 /* First off, invalidate the file's data in the cache, without flushing. */
3716 yaffs_invalidate_whole_cache(in);
3718 if (in->my_dev->param.is_yaffs2 && (in->parent != in->my_dev->del_dir)) {
3719 /* Move to the unlinked directory so we have a record that it was deleted. */
3720 yaffs_change_obj_name(in, in->my_dev->del_dir, _Y("deleted"), 0,
3725 yaffs_remove_obj_from_dir(in);
3726 yaffs_chunk_del(in->my_dev, in->hdr_chunk, 1, __LINE__);
3734 /* yaffs_del_file deletes the whole file data
3735 * and the inode associated with the file.
3736 * It does not delete the links associated with the file.
3738 static int yaffs_unlink_file_if_needed(struct yaffs_obj *in)
3743 struct yaffs_dev *dev = in->my_dev;
3750 yaffs_change_obj_name(in, in->my_dev->del_dir,
3751 _Y("deleted"), 0, 0);
3752 T(YAFFS_TRACE_TRACING,
3753 (TSTR("yaffs: immediate deletion of file %d" TENDSTR),
3756 in->my_dev->n_deleted_files++;
3757 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3758 yaffs_resize_file(in, 0);
3759 yaffs_soft_del_file(in);
3762 yaffs_change_obj_name(in, in->my_dev->unlinked_dir,
3763 _Y("unlinked"), 0, 0);
3769 int yaffs_del_file(struct yaffs_obj *in)
3771 int ret_val = YAFFS_OK;
3772 int deleted; /* Need to cache value on stack if in is freed */
3773 struct yaffs_dev *dev = in->my_dev;
3775 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3776 yaffs_resize_file(in, 0);
3778 if (in->n_data_chunks > 0) {
3779 /* Use soft deletion if there is data in the file.
3780 * That won't be the case if it has been resized to zero.
3783 ret_val = yaffs_unlink_file_if_needed(in);
3785 deleted = in->deleted;
3787 if (ret_val == YAFFS_OK && in->unlinked && !in->deleted) {
3790 in->my_dev->n_deleted_files++;
3791 yaffs_soft_del_file(in);
3793 return deleted ? YAFFS_OK : YAFFS_FAIL;
3795 /* The file has no data chunks so we toss it immediately */
3796 yaffs_free_tnode(in->my_dev, in->variant.file_variant.top);
3797 in->variant.file_variant.top = NULL;
3798 yaffs_generic_obj_del(in);
3804 static int yaffs_is_non_empty_dir(struct yaffs_obj *obj)
3806 return (obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) &&
3807 !(list_empty(&obj->variant.dir_variant.children));
3810 static int yaffs_del_dir(struct yaffs_obj *obj)
3812 /* First check that the directory is empty. */
3813 if (yaffs_is_non_empty_dir(obj))
3816 return yaffs_generic_obj_del(obj);
3819 static int yaffs_del_symlink(struct yaffs_obj *in)
3821 if (in->variant.symlink_variant.alias)
3822 YFREE(in->variant.symlink_variant.alias);
3823 in->variant.symlink_variant.alias = NULL;
3825 return yaffs_generic_obj_del(in);
3828 static int yaffs_del_link(struct yaffs_obj *in)
3830 /* remove this hardlink from the list assocaited with the equivalent
3833 list_del_init(&in->hard_links);
3834 return yaffs_generic_obj_del(in);
3837 int yaffs_del_obj(struct yaffs_obj *obj)
3840 switch (obj->variant_type) {
3841 case YAFFS_OBJECT_TYPE_FILE:
3842 ret_val = yaffs_del_file(obj);
3844 case YAFFS_OBJECT_TYPE_DIRECTORY:
3845 if (!list_empty(&obj->variant.dir_variant.dirty)) {
3846 T(YAFFS_TRACE_BACKGROUND,
3848 ("Remove object %d from dirty directories" TENDSTR),
3850 list_del_init(&obj->variant.dir_variant.dirty);
3852 return yaffs_del_dir(obj);
3854 case YAFFS_OBJECT_TYPE_SYMLINK:
3855 ret_val = yaffs_del_symlink(obj);
3857 case YAFFS_OBJECT_TYPE_HARDLINK:
3858 ret_val = yaffs_del_link(obj);
3860 case YAFFS_OBJECT_TYPE_SPECIAL:
3861 ret_val = yaffs_generic_obj_del(obj);
3863 case YAFFS_OBJECT_TYPE_UNKNOWN:
3865 break; /* should not happen. */
3871 static int yaffs_unlink_worker(struct yaffs_obj *obj)
3880 yaffs_update_parent(obj->parent);
3882 if (obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
3883 return yaffs_del_link(obj);
3884 } else if (!list_empty(&obj->hard_links)) {
3885 /* Curve ball: We're unlinking an object that has a hardlink.
3887 * This problem arises because we are not strictly following
3888 * The Linux link/inode model.
3890 * We can't really delete the object.
3891 * Instead, we do the following:
3892 * - Select a hardlink.
3893 * - Unhook it from the hard links
3894 * - Move it from its parent directory (so that the rename can work)
3895 * - Rename the object to the hardlink's name.
3896 * - Delete the hardlink
3899 struct yaffs_obj *hl;
3900 struct yaffs_obj *parent;
3902 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
3904 hl = list_entry(obj->hard_links.next, struct yaffs_obj,
3907 yaffs_get_obj_name(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
3908 parent = hl->parent;
3910 list_del_init(&hl->hard_links);
3912 yaffs_add_obj_to_dir(obj->my_dev->unlinked_dir, hl);
3914 ret_val = yaffs_change_obj_name(obj, parent, name, 0, 0);
3916 if (ret_val == YAFFS_OK)
3917 ret_val = yaffs_generic_obj_del(hl);
3921 } else if (del_now) {
3922 switch (obj->variant_type) {
3923 case YAFFS_OBJECT_TYPE_FILE:
3924 return yaffs_del_file(obj);
3926 case YAFFS_OBJECT_TYPE_DIRECTORY:
3927 list_del_init(&obj->variant.dir_variant.dirty);
3928 return yaffs_del_dir(obj);
3930 case YAFFS_OBJECT_TYPE_SYMLINK:
3931 return yaffs_del_symlink(obj);
3933 case YAFFS_OBJECT_TYPE_SPECIAL:
3934 return yaffs_generic_obj_del(obj);
3936 case YAFFS_OBJECT_TYPE_HARDLINK:
3937 case YAFFS_OBJECT_TYPE_UNKNOWN:
3941 } else if (yaffs_is_non_empty_dir(obj)) {
3944 return yaffs_change_obj_name(obj, obj->my_dev->unlinked_dir,
3945 _Y("unlinked"), 0, 0);
3949 static int yaffs_unlink_obj(struct yaffs_obj *obj)
3952 if (obj && obj->unlink_allowed)
3953 return yaffs_unlink_worker(obj);
3959 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name)
3961 struct yaffs_obj *obj;
3963 obj = yaffs_find_by_name(dir, name);
3964 return yaffs_unlink_obj(obj);
3967 /*----------------------- Initialisation Scanning ---------------------- */
3969 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
3970 int backward_scanning)
3972 struct yaffs_obj *obj;
3974 if (!backward_scanning) {
3975 /* Handle YAFFS1 forward scanning case
3976 * For YAFFS1 we always do the deletion
3980 /* Handle YAFFS2 case (backward scanning)
3981 * If the shadowed object exists then ignore.
3983 obj = yaffs_find_by_number(dev, obj_id);
3988 /* Let's create it (if it does not exist) assuming it is a file so that it can do shrinking etc.
3989 * We put it in unlinked dir to be cleaned up after the scanning
3992 yaffs_find_or_create_by_number(dev, obj_id, YAFFS_OBJECT_TYPE_FILE);
3995 obj->is_shadowed = 1;
3996 yaffs_add_obj_to_dir(dev->unlinked_dir, obj);
3997 obj->variant.file_variant.shrink_size = 0;
3998 obj->valid = 1; /* So that we don't read any other info for this file */
4002 void yaffs_link_fixup(struct yaffs_dev *dev, struct yaffs_obj *hard_list)
4004 struct yaffs_obj *hl;
4005 struct yaffs_obj *in;
4009 hard_list = (struct yaffs_obj *)(hard_list->hard_links.next);
4011 in = yaffs_find_by_number(dev,
4013 hardlink_variant.equiv_id);
4016 /* Add the hardlink pointers */
4017 hl->variant.hardlink_variant.equiv_obj = in;
4018 list_add(&hl->hard_links, &in->hard_links);
4020 /* Todo Need to report/handle this better.
4021 * Got a problem... hardlink to a non-existant object
4023 hl->variant.hardlink_variant.equiv_obj = NULL;
4024 INIT_LIST_HEAD(&hl->hard_links);
4030 static void yaffs_strip_deleted_objs(struct yaffs_dev *dev)
4033 * Sort out state of unlinked and deleted objects after scanning.
4035 struct list_head *i;
4036 struct list_head *n;
4037 struct yaffs_obj *l;
4042 /* Soft delete all the unlinked files */
4043 list_for_each_safe(i, n,
4044 &dev->unlinked_dir->variant.dir_variant.children) {
4046 l = list_entry(i, struct yaffs_obj, siblings);
4051 list_for_each_safe(i, n, &dev->del_dir->variant.dir_variant.children) {
4053 l = list_entry(i, struct yaffs_obj, siblings);
4061 * This code iterates through all the objects making sure that they are rooted.
4062 * Any unrooted objects are re-rooted in lost+found.
4063 * An object needs to be in one of:
4064 * - Directly under deleted, unlinked
4065 * - Directly or indirectly under root.
4068 * This code assumes that we don't ever change the current relationships between
4070 * root_dir->parent == unlinked_dir->parent == del_dir->parent == NULL
4071 * lost-n-found->parent == root_dir
4073 * This fixes the problem where directories might have inadvertently been deleted
4074 * leaving the object "hanging" without being rooted in the directory tree.
4077 static int yaffs_has_null_parent(struct yaffs_dev *dev, struct yaffs_obj *obj)
4079 return (obj == dev->del_dir ||
4080 obj == dev->unlinked_dir || obj == dev->root_dir);
4083 static void yaffs_fix_hanging_objs(struct yaffs_dev *dev)
4085 struct yaffs_obj *obj;
4086 struct yaffs_obj *parent;
4088 struct list_head *lh;
4089 struct list_head *n;
4096 /* Iterate through the objects in each hash entry,
4097 * looking at each object.
4098 * Make sure it is rooted.
4101 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
4102 list_for_each_safe(lh, n, &dev->obj_bucket[i].list) {
4105 list_entry(lh, struct yaffs_obj, hash_link);
4106 parent = obj->parent;
4108 if (yaffs_has_null_parent(dev, obj)) {
4109 /* These directories are not hanging */
4112 || parent->variant_type !=
4113 YAFFS_OBJECT_TYPE_DIRECTORY) {
4115 } else if (yaffs_has_null_parent(dev, parent)) {
4119 * Need to follow the parent chain to see if it is hanging.
4124 while (parent != dev->root_dir &&
4126 parent->parent->variant_type ==
4127 YAFFS_OBJECT_TYPE_DIRECTORY
4128 && depth_limit > 0) {
4129 parent = parent->parent;
4132 if (parent != dev->root_dir)
4138 ("Hanging object %d moved to lost and found"
4139 TENDSTR), obj->obj_id));
4140 yaffs_add_obj_to_dir(dev->lost_n_found,
4149 * Delete directory contents for cleaning up lost and found.
4151 static void yaffs_del_dir_contents(struct yaffs_obj *dir)
4153 struct yaffs_obj *obj;
4154 struct list_head *lh;
4155 struct list_head *n;
4157 if (dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
4160 list_for_each_safe(lh, n, &dir->variant.dir_variant.children) {
4162 obj = list_entry(lh, struct yaffs_obj, siblings);
4163 if (obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY)
4164 yaffs_del_dir_contents(obj);
4167 (TSTR("Deleting lost_found object %d" TENDSTR),
4170 /* Need to use UnlinkObject since Delete would not handle
4171 * hardlinked objects correctly.
4173 yaffs_unlink_obj(obj);
4179 static void yaffs_empty_l_n_f(struct yaffs_dev *dev)
4181 yaffs_del_dir_contents(dev->lost_n_found);
4184 static void yaffs_check_obj_details_loaded(struct yaffs_obj *in)
4187 struct yaffs_obj_hdr *oh;
4188 struct yaffs_dev *dev;
4189 struct yaffs_ext_tags tags;
4191 int alloc_failed = 0;
4198 if (in->lazy_loaded && in->hdr_chunk > 0) {
4199 in->lazy_loaded = 0;
4200 chunk_data = yaffs_get_temp_buffer(dev, __LINE__);
4203 yaffs_rd_chunk_tags_nand(dev, in->hdr_chunk, chunk_data,
4205 oh = (struct yaffs_obj_hdr *)chunk_data;
4207 in->yst_mode = oh->yst_mode;
4208 yaffs_load_attribs(in, oh);
4209 yaffs_set_obj_name_from_oh(in, oh);
4211 if (in->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
4212 in->variant.symlink_variant.alias =
4213 yaffs_clone_str(oh->alias);
4214 if (!in->variant.symlink_variant.alias)
4215 alloc_failed = 1; /* Not returned to caller */
4218 yaffs_release_temp_buffer(dev, chunk_data, __LINE__);
4222 /*------------------------------ Directory Functions ----------------------------- */
4225 *yaffs_update_parent() handles fixing a directories mtime and ctime when a new
4226 * link (ie. name) is created or deleted in the directory.
4229 * create dir/a : update dir's mtime/ctime
4230 * rm dir/a: update dir's mtime/ctime
4231 * modify dir/a: don't update dir's mtimme/ctime
4233 * This can be handled immediately or defered. Defering helps reduce the number
4234 * of updates when many files in a directory are changed within a brief period.
4236 * If the directory updating is defered then yaffs_update_dirty_dirs must be
4237 * called periodically.
4240 static void yaffs_update_parent(struct yaffs_obj *obj)
4242 struct yaffs_dev *dev;
4247 yaffs_load_current_time(obj, 0, 1);
4248 if (dev->param.defered_dir_update) {
4249 struct list_head *link = &obj->variant.dir_variant.dirty;
4251 if (list_empty(link)) {
4252 list_add(link, &dev->dirty_dirs);
4253 T(YAFFS_TRACE_BACKGROUND,
4254 (TSTR("Added object %d to dirty directories" TENDSTR),
4259 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
4263 void yaffs_update_dirty_dirs(struct yaffs_dev *dev)
4265 struct list_head *link;
4266 struct yaffs_obj *obj;
4267 struct yaffs_dir_var *d_s;
4268 union yaffs_obj_var *o_v;
4270 T(YAFFS_TRACE_BACKGROUND, (TSTR("Update dirty directories" TENDSTR)));
4272 while (!list_empty(&dev->dirty_dirs)) {
4273 link = dev->dirty_dirs.next;
4274 list_del_init(link);
4276 d_s = list_entry(link, struct yaffs_dir_var, dirty);
4277 o_v = list_entry(d_s, union yaffs_obj_var, dir_variant);
4278 obj = list_entry(o_v, struct yaffs_obj, variant);
4280 T(YAFFS_TRACE_BACKGROUND,
4281 (TSTR("Update directory %d" TENDSTR), obj->obj_id));
4284 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
4288 static void yaffs_remove_obj_from_dir(struct yaffs_obj *obj)
4290 struct yaffs_dev *dev = obj->my_dev;
4291 struct yaffs_obj *parent;
4293 yaffs_verify_obj_in_dir(obj);
4294 parent = obj->parent;
4296 yaffs_verify_dir(parent);
4298 if (dev && dev->param.remove_obj_fn)
4299 dev->param.remove_obj_fn(obj);
4301 list_del_init(&obj->siblings);
4304 yaffs_verify_dir(parent);
4307 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj)
4310 T(YAFFS_TRACE_ALWAYS,
4312 ("tragedy: Trying to add an object to a null pointer directory"
4317 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4318 T(YAFFS_TRACE_ALWAYS,
4320 ("tragedy: Trying to add an object to a non-directory"
4325 if (obj->siblings.prev == NULL) {
4326 /* Not initialised */
4330 yaffs_verify_dir(directory);
4332 yaffs_remove_obj_from_dir(obj);
4335 list_add(&obj->siblings, &directory->variant.dir_variant.children);
4336 obj->parent = directory;
4338 if (directory == obj->my_dev->unlinked_dir
4339 || directory == obj->my_dev->del_dir) {
4341 obj->my_dev->n_unlinked_files++;
4342 obj->rename_allowed = 0;
4345 yaffs_verify_dir(directory);
4346 yaffs_verify_obj_in_dir(obj);
4349 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *directory,
4354 struct list_head *i;
4355 YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
4357 struct yaffs_obj *l;
4363 T(YAFFS_TRACE_ALWAYS,
4365 ("tragedy: yaffs_find_by_name: null pointer directory"
4370 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4371 T(YAFFS_TRACE_ALWAYS,
4372 (TSTR("tragedy: yaffs_find_by_name: non-directory" TENDSTR)));
4376 sum = yaffs_calc_name_sum(name);
4378 list_for_each(i, &directory->variant.dir_variant.children) {
4380 l = list_entry(i, struct yaffs_obj, siblings);
4382 if (l->parent != directory)
4385 yaffs_check_obj_details_loaded(l);
4387 /* Special case for lost-n-found */
4388 if (l->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4389 if (!yaffs_strcmp(name, YAFFS_LOSTNFOUND_NAME))
4391 } else if (yaffs_sum_cmp(l->sum, sum)
4392 || l->hdr_chunk <= 0) {
4393 /* LostnFound chunk called Objxxx
4396 yaffs_get_obj_name(l, buffer,
4397 YAFFS_MAX_NAME_LENGTH + 1);
4399 (name, buffer, YAFFS_MAX_NAME_LENGTH) == 0)
4408 /* GetEquivalentObject dereferences any hard links to get to the
4412 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj)
4414 if (obj && obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
4415 /* We want the object id of the equivalent object, not this one */
4416 obj = obj->variant.hardlink_variant.equiv_obj;
4417 yaffs_check_obj_details_loaded(obj);
4423 * A note or two on object names.
4424 * * If the object name is missing, we then make one up in the form objnnn
4426 * * ASCII names are stored in the object header's name field from byte zero
4427 * * Unicode names are historically stored starting from byte zero.
4429 * Then there are automatic Unicode names...
4430 * The purpose of these is to save names in a way that can be read as
4431 * ASCII or Unicode names as appropriate, thus allowing a Unicode and ASCII
4432 * system to share files.
4434 * These automatic unicode are stored slightly differently...
4435 * - If the name can fit in the ASCII character space then they are saved as
4436 * ascii names as per above.
4437 * - If the name needs Unicode then the name is saved in Unicode
4438 * starting at oh->name[1].
4441 static void yaffs_fix_null_name(struct yaffs_obj *obj, YCHAR * name,
4444 /* Create an object name if we could not find one. */
4445 if (yaffs_strnlen(name, YAFFS_MAX_NAME_LENGTH) == 0) {
4446 YCHAR local_name[20];
4447 YCHAR num_string[20];
4448 YCHAR *x = &num_string[19];
4449 unsigned v = obj->obj_id;
4453 *x = '0' + (v % 10);
4456 /* make up a name */
4457 yaffs_strcpy(local_name, YAFFS_LOSTNFOUND_PREFIX);
4458 yaffs_strcat(local_name, x);
4459 yaffs_strncpy(name, local_name, buffer_size - 1);
4463 static void yaffs_load_name_from_oh(struct yaffs_dev *dev, YCHAR * name,
4464 const YCHAR * oh_name, int buff_size)
4466 #ifdef CONFIG_YAFFS_AUTO_UNICODE
4467 if (dev->param.auto_unicode) {
4469 /* It is an ASCII name, so do an ASCII to unicode conversion */
4470 const char *ascii_oh_name = (const char *)oh_name;
4471 int n = buff_size - 1;
4472 while (n > 0 && *ascii_oh_name) {
4473 *name = *ascii_oh_name;
4479 yaffs_strncpy(name, oh_name + 1, buff_size - 1);
4485 yaffs_strncpy(name, oh_name, buff_size - 1);
4489 static void yaffs_load_oh_from_name(struct yaffs_dev *dev, YCHAR * oh_name,
4492 #ifdef CONFIG_YAFFS_AUTO_UNICODE
4497 if (dev->param.auto_unicode) {
4502 /* Figure out if the name will fit in ascii character set */
4503 while (is_ascii && *w) {
4510 /* It is an ASCII name, so do a unicode to ascii conversion */
4511 char *ascii_oh_name = (char *)oh_name;
4512 int n = YAFFS_MAX_NAME_LENGTH - 1;
4513 while (n > 0 && *name) {
4514 *ascii_oh_name = *name;
4520 /* It is a unicode name, so save starting at the second YCHAR */
4522 yaffs_strncpy(oh_name + 1, name,
4523 YAFFS_MAX_NAME_LENGTH - 2);
4529 yaffs_strncpy(oh_name, name, YAFFS_MAX_NAME_LENGTH - 1);
4534 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size)
4536 memset(name, 0, buffer_size * sizeof(YCHAR));
4538 yaffs_check_obj_details_loaded(obj);
4540 if (obj->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4541 yaffs_strncpy(name, YAFFS_LOSTNFOUND_NAME, buffer_size - 1);
4543 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
4544 else if (obj->short_name[0]) {
4545 yaffs_strcpy(name, obj->short_name);
4548 else if (obj->hdr_chunk > 0) {
4550 u8 *buffer = yaffs_get_temp_buffer(obj->my_dev, __LINE__);
4552 struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)buffer;
4554 memset(buffer, 0, obj->my_dev->data_bytes_per_chunk);
4556 if (obj->hdr_chunk > 0) {
4557 result = yaffs_rd_chunk_tags_nand(obj->my_dev,
4561 yaffs_load_name_from_oh(obj->my_dev, name, oh->name,
4564 yaffs_release_temp_buffer(obj->my_dev, buffer, __LINE__);
4567 yaffs_fix_null_name(obj, name, buffer_size);
4569 return yaffs_strnlen(name, YAFFS_MAX_NAME_LENGTH);
4572 int yaffs_get_obj_length(struct yaffs_obj *obj)
4574 /* Dereference any hard linking */
4575 obj = yaffs_get_equivalent_obj(obj);
4577 if (obj->variant_type == YAFFS_OBJECT_TYPE_FILE)
4578 return obj->variant.file_variant.file_size;
4579 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
4580 if (!obj->variant.symlink_variant.alias)
4582 return yaffs_strnlen(obj->variant.symlink_variant.alias,
4583 YAFFS_MAX_ALIAS_LENGTH);
4585 /* Only a directory should drop through to here */
4586 return obj->my_dev->data_bytes_per_chunk;
4590 int yaffs_get_obj_link_count(struct yaffs_obj *obj)
4593 struct list_head *i;
4596 count++; /* the object itself */
4598 list_for_each(i, &obj->hard_links)
4599 count++; /* add the hard links; */
4604 int yaffs_get_obj_inode(struct yaffs_obj *obj)
4606 obj = yaffs_get_equivalent_obj(obj);
4611 unsigned yaffs_get_obj_type(struct yaffs_obj *obj)
4613 obj = yaffs_get_equivalent_obj(obj);
4615 switch (obj->variant_type) {
4616 case YAFFS_OBJECT_TYPE_FILE:
4619 case YAFFS_OBJECT_TYPE_DIRECTORY:
4622 case YAFFS_OBJECT_TYPE_SYMLINK:
4625 case YAFFS_OBJECT_TYPE_HARDLINK:
4628 case YAFFS_OBJECT_TYPE_SPECIAL:
4629 if (S_ISFIFO(obj->yst_mode))
4631 if (S_ISCHR(obj->yst_mode))
4633 if (S_ISBLK(obj->yst_mode))
4635 if (S_ISSOCK(obj->yst_mode))
4643 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj)
4645 obj = yaffs_get_equivalent_obj(obj);
4646 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK)
4647 return yaffs_clone_str(obj->variant.symlink_variant.alias);
4649 return yaffs_clone_str(_Y(""));
4652 static int yaffs_do_xattrib_mod(struct yaffs_obj *obj, int set,
4653 const YCHAR * name, const void *value, int size,
4656 struct yaffs_xattr_mod xmod;
4665 xmod.result = -ENOSPC;
4667 result = yaffs_update_oh(obj, NULL, 0, 0, 0, &xmod);
4675 static int yaffs_apply_xattrib_mod(struct yaffs_obj *obj, char *buffer,
4676 struct yaffs_xattr_mod *xmod)
4679 int x_offs = sizeof(struct yaffs_obj_hdr);
4680 struct yaffs_dev *dev = obj->my_dev;
4681 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
4683 char *x_buffer = buffer + x_offs;
4687 nval_set(x_buffer, x_size, xmod->name, xmod->data,
4688 xmod->size, xmod->flags);
4690 retval = nval_del(x_buffer, x_size, xmod->name);
4692 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
4693 obj->xattr_known = 1;
4695 xmod->result = retval;
4700 static int yaffs_do_xattrib_fetch(struct yaffs_obj *obj, const YCHAR * name,
4701 void *value, int size)
4703 char *buffer = NULL;
4705 struct yaffs_ext_tags tags;
4706 struct yaffs_dev *dev = obj->my_dev;
4707 int x_offs = sizeof(struct yaffs_obj_hdr);
4708 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
4714 if (obj->hdr_chunk < 1)
4717 /* If we know that the object has no xattribs then don't do all the
4718 * reading and parsing.
4720 if (obj->xattr_known && !obj->has_xattr) {
4727 buffer = (char *)yaffs_get_temp_buffer(dev, __LINE__);
4732 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, (u8 *) buffer, &tags);
4734 if (result != YAFFS_OK)
4737 x_buffer = buffer + x_offs;
4739 if (!obj->xattr_known) {
4740 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
4741 obj->xattr_known = 1;
4745 retval = nval_get(x_buffer, x_size, name, value, size);
4747 retval = nval_list(x_buffer, x_size, value, size);
4749 yaffs_release_temp_buffer(dev, (u8 *) buffer, __LINE__);
4753 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR * name,
4754 const void *value, int size, int flags)
4756 return yaffs_do_xattrib_mod(obj, 1, name, value, size, flags);
4759 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR * name)
4761 return yaffs_do_xattrib_mod(obj, 0, name, NULL, 0, 0);
4764 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR * name, void *value,
4767 return yaffs_do_xattrib_fetch(obj, name, value, size);
4770 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size)
4772 return yaffs_do_xattrib_fetch(obj, NULL, buffer, size);
4775 /*---------------------------- Initialisation code -------------------------------------- */
4777 static int yaffs_check_dev_fns(const struct yaffs_dev *dev)
4780 /* Common functions, gotta have */
4781 if (!dev->param.erase_fn || !dev->param.initialise_flash_fn)
4784 #ifdef CONFIG_YAFFS_YAFFS2
4786 /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
4787 if (dev->param.write_chunk_tags_fn &&
4788 dev->param.read_chunk_tags_fn &&
4789 !dev->param.write_chunk_fn &&
4790 !dev->param.read_chunk_fn &&
4791 dev->param.bad_block_fn && dev->param.query_block_fn)
4795 /* Can use the "spare" style interface for yaffs1 */
4796 if (!dev->param.is_yaffs2 &&
4797 !dev->param.write_chunk_tags_fn &&
4798 !dev->param.read_chunk_tags_fn &&
4799 dev->param.write_chunk_fn &&
4800 dev->param.read_chunk_fn &&
4801 !dev->param.bad_block_fn && !dev->param.query_block_fn)
4807 static int yaffs_create_initial_dir(struct yaffs_dev *dev)
4809 /* Initialise the unlinked, deleted, root and lost and found directories */
4811 dev->lost_n_found = dev->root_dir = NULL;
4812 dev->unlinked_dir = dev->del_dir = NULL;
4815 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
4818 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
4821 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_ROOT,
4822 YAFFS_ROOT_MODE | S_IFDIR);
4824 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_LOSTNFOUND,
4825 YAFFS_LOSTNFOUND_MODE | S_IFDIR);
4827 if (dev->lost_n_found && dev->root_dir && dev->unlinked_dir
4829 yaffs_add_obj_to_dir(dev->root_dir, dev->lost_n_found);
4836 int yaffs_guts_initialise(struct yaffs_dev *dev)
4838 int init_failed = 0;
4842 T(YAFFS_TRACE_TRACING,
4843 (TSTR("yaffs: yaffs_guts_initialise()" TENDSTR)));
4845 /* Check stuff that must be set */
4848 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Need a device" TENDSTR)));
4852 dev->internal_start_block = dev->param.start_block;
4853 dev->internal_end_block = dev->param.end_block;
4854 dev->block_offset = 0;
4855 dev->chunk_offset = 0;
4856 dev->n_free_chunks = 0;
4860 if (dev->param.start_block == 0) {
4861 dev->internal_start_block = dev->param.start_block + 1;
4862 dev->internal_end_block = dev->param.end_block + 1;
4863 dev->block_offset = 1;
4864 dev->chunk_offset = dev->param.chunks_per_block;
4867 /* Check geometry parameters. */
4869 if ((!dev->param.inband_tags && dev->param.is_yaffs2 && dev->param.total_bytes_per_chunk < 1024) || (!dev->param.is_yaffs2 && dev->param.total_bytes_per_chunk < 512) || (dev->param.inband_tags && !dev->param.is_yaffs2) || dev->param.chunks_per_block < 2 || dev->param.n_reserved_blocks < 2 || dev->internal_start_block <= 0 || dev->internal_end_block <= 0 || dev->internal_end_block <= (dev->internal_start_block + dev->param.n_reserved_blocks + 2)) { /* otherwise it is too small */
4870 T(YAFFS_TRACE_ALWAYS,
4872 ("yaffs: NAND geometry problems: chunk size %d, type is yaffs%s, inband_tags %d "
4873 TENDSTR), dev->param.total_bytes_per_chunk,
4874 dev->param.is_yaffs2 ? "2" : "", dev->param.inband_tags));
4878 if (yaffs_init_nand(dev) != YAFFS_OK) {
4879 T(YAFFS_TRACE_ALWAYS,
4880 (TSTR("yaffs: InitialiseNAND failed" TENDSTR)));
4884 /* Sort out space for inband tags, if required */
4885 if (dev->param.inband_tags)
4886 dev->data_bytes_per_chunk =
4887 dev->param.total_bytes_per_chunk -
4888 sizeof(struct yaffs_packed_tags2_tags_only);
4890 dev->data_bytes_per_chunk = dev->param.total_bytes_per_chunk;
4892 /* Got the right mix of functions? */
4893 if (!yaffs_check_dev_fns(dev)) {
4894 /* Function missing */
4895 T(YAFFS_TRACE_ALWAYS,
4897 ("yaffs: device function(s) missing or wrong\n" TENDSTR)));
4902 if (dev->is_mounted) {
4903 T(YAFFS_TRACE_ALWAYS,
4904 (TSTR("yaffs: device already mounted\n" TENDSTR)));
4908 /* Finished with most checks. One or two more checks happen later on too. */
4910 dev->is_mounted = 1;
4912 /* OK now calculate a few things for the device */
4915 * Calculate all the chunk size manipulation numbers:
4917 x = dev->data_bytes_per_chunk;
4918 /* We always use dev->chunk_shift and dev->chunk_div */
4919 dev->chunk_shift = calc_shifts(x);
4920 x >>= dev->chunk_shift;
4922 /* We only use chunk mask if chunk_div is 1 */
4923 dev->chunk_mask = (1 << dev->chunk_shift) - 1;
4926 * Calculate chunk_grp_bits.
4927 * We need to find the next power of 2 > than internal_end_block
4930 x = dev->param.chunks_per_block * (dev->internal_end_block + 1);
4932 bits = calc_shifts_ceiling(x);
4934 /* Set up tnode width if wide tnodes are enabled. */
4935 if (!dev->param.wide_tnodes_disabled) {
4936 /* bits must be even so that we end up with 32-bit words */
4940 dev->tnode_width = 16;
4942 dev->tnode_width = bits;
4944 dev->tnode_width = 16;
4947 dev->tnode_mask = (1 << dev->tnode_width) - 1;
4949 /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
4950 * so if the bitwidth of the
4951 * chunk range we're using is greater than 16 we need
4952 * to figure out chunk shift and chunk_grp_size
4955 if (bits <= dev->tnode_width)
4956 dev->chunk_grp_bits = 0;
4958 dev->chunk_grp_bits = bits - dev->tnode_width;
4960 dev->tnode_size = (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8;
4961 if (dev->tnode_size < sizeof(struct yaffs_tnode))
4962 dev->tnode_size = sizeof(struct yaffs_tnode);
4964 dev->chunk_grp_size = 1 << dev->chunk_grp_bits;
4966 if (dev->param.chunks_per_block < dev->chunk_grp_size) {
4967 /* We have a problem because the soft delete won't work if
4968 * the chunk group size > chunks per block.
4969 * This can be remedied by using larger "virtual blocks".
4971 T(YAFFS_TRACE_ALWAYS,
4972 (TSTR("yaffs: chunk group too large\n" TENDSTR)));
4977 /* OK, we've finished verifying the device, lets continue with initialisation */
4979 /* More device initialisation */
4981 dev->passive_gc_count = 0;
4982 dev->oldest_dirty_gc_count = 0;
4984 dev->gc_block_finder = 0;
4985 dev->buffered_block = -1;
4986 dev->doing_buffered_block_rewrite = 0;
4987 dev->n_deleted_files = 0;
4988 dev->n_bg_deletions = 0;
4989 dev->n_unlinked_files = 0;
4990 dev->n_ecc_fixed = 0;
4991 dev->n_ecc_unfixed = 0;
4992 dev->n_tags_ecc_fixed = 0;
4993 dev->n_tags_ecc_unfixed = 0;
4994 dev->n_erase_failures = 0;
4995 dev->n_erased_blocks = 0;
4996 dev->gc_disable = 0;
4997 dev->has_pending_prioritised_gc = 1; /* Assume the worst for now, will get fixed on first GC */
4998 INIT_LIST_HEAD(&dev->dirty_dirs);
4999 dev->oldest_dirty_seq = 0;
5000 dev->oldest_dirty_block = 0;
5002 /* Initialise temporary buffers and caches. */
5003 if (!yaffs_init_tmp_buffers(dev))
5007 dev->gc_cleanup_list = NULL;
5009 if (!init_failed && dev->param.n_caches > 0) {
5013 dev->param.n_caches * sizeof(struct yaffs_cache);
5015 if (dev->param.n_caches > YAFFS_MAX_SHORT_OP_CACHES)
5016 dev->param.n_caches = YAFFS_MAX_SHORT_OP_CACHES;
5018 dev->cache = YMALLOC(cache_bytes);
5020 buf = (u8 *) dev->cache;
5023 memset(dev->cache, 0, cache_bytes);
5025 for (i = 0; i < dev->param.n_caches && buf; i++) {
5026 dev->cache[i].object = NULL;
5027 dev->cache[i].last_use = 0;
5028 dev->cache[i].dirty = 0;
5029 dev->cache[i].data = buf =
5030 YMALLOC_DMA(dev->param.total_bytes_per_chunk);
5035 dev->cache_last_use = 0;
5038 dev->cache_hits = 0;
5041 dev->gc_cleanup_list =
5042 YMALLOC(dev->param.chunks_per_block * sizeof(u32));
5043 if (!dev->gc_cleanup_list)
5047 if (dev->param.is_yaffs2)
5048 dev->param.use_header_file_size = 1;
5050 if (!init_failed && !yaffs_init_blocks(dev))
5053 yaffs_init_tnodes_and_objs(dev);
5055 if (!init_failed && !yaffs_create_initial_dir(dev))
5059 /* Now scan the flash. */
5060 if (dev->param.is_yaffs2) {
5061 if (yaffs2_checkpt_restore(dev)) {
5062 yaffs_check_obj_details_loaded(dev->root_dir);
5063 T(YAFFS_TRACE_ALWAYS,
5065 ("yaffs: restored from checkpoint"
5069 /* Clean up the mess caused by an aborted checkpoint load
5070 * and scan backwards.
5072 yaffs_deinit_blocks(dev);
5074 yaffs_deinit_tnodes_and_objs(dev);
5076 dev->n_erased_blocks = 0;
5077 dev->n_free_chunks = 0;
5078 dev->alloc_block = -1;
5079 dev->alloc_page = -1;
5080 dev->n_deleted_files = 0;
5081 dev->n_unlinked_files = 0;
5082 dev->n_bg_deletions = 0;
5084 if (!init_failed && !yaffs_init_blocks(dev))
5087 yaffs_init_tnodes_and_objs(dev);
5090 && !yaffs_create_initial_dir(dev))
5093 if (!init_failed && !yaffs2_scan_backwards(dev))
5096 } else if (!yaffs1_scan(dev)) {
5100 yaffs_strip_deleted_objs(dev);
5101 yaffs_fix_hanging_objs(dev);
5102 if (dev->param.empty_lost_n_found)
5103 yaffs_empty_l_n_f(dev);
5107 /* Clean up the mess */
5108 T(YAFFS_TRACE_TRACING,
5109 (TSTR("yaffs: yaffs_guts_initialise() aborted.\n" TENDSTR)));
5111 yaffs_deinitialise(dev);
5115 /* Zero out stats */
5116 dev->n_page_reads = 0;
5117 dev->n_page_writes = 0;
5118 dev->n_erasures = 0;
5119 dev->n_gc_copies = 0;
5120 dev->n_retired_writes = 0;
5122 dev->n_retired_blocks = 0;
5124 yaffs_verify_free_chunks(dev);
5125 yaffs_verify_blocks(dev);
5127 /* Clean up any aborted checkpoint data */
5128 if (!dev->is_checkpointed && dev->blocks_in_checkpt > 0)
5129 yaffs2_checkpt_invalidate(dev);
5131 T(YAFFS_TRACE_TRACING,
5132 (TSTR("yaffs: yaffs_guts_initialise() done.\n" TENDSTR)));
5137 void yaffs_deinitialise(struct yaffs_dev *dev)
5139 if (dev->is_mounted) {
5142 yaffs_deinit_blocks(dev);
5143 yaffs_deinit_tnodes_and_objs(dev);
5144 if (dev->param.n_caches > 0 && dev->cache) {
5146 for (i = 0; i < dev->param.n_caches; i++) {
5147 if (dev->cache[i].data)
5148 YFREE(dev->cache[i].data);
5149 dev->cache[i].data = NULL;
5156 YFREE(dev->gc_cleanup_list);
5158 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
5159 YFREE(dev->temp_buffer[i].buffer);
5161 dev->is_mounted = 0;
5163 if (dev->param.deinitialise_flash_fn)
5164 dev->param.deinitialise_flash_fn(dev);
5168 int yaffs_count_free_chunks(struct yaffs_dev *dev)
5173 struct yaffs_block_info *blk;
5175 blk = dev->block_info;
5176 for (b = dev->internal_start_block; b <= dev->internal_end_block; b++) {
5177 switch (blk->block_state) {
5178 case YAFFS_BLOCK_STATE_EMPTY:
5179 case YAFFS_BLOCK_STATE_ALLOCATING:
5180 case YAFFS_BLOCK_STATE_COLLECTING:
5181 case YAFFS_BLOCK_STATE_FULL:
5183 (dev->param.chunks_per_block - blk->pages_in_use +
5184 blk->soft_del_pages);
5195 int yaffs_get_n_free_chunks(struct yaffs_dev *dev)
5197 /* This is what we report to the outside world */
5201 int blocks_for_checkpt;
5204 n_free = dev->n_free_chunks;
5205 n_free += dev->n_deleted_files;
5207 /* Now count the number of dirty chunks in the cache and subtract those */
5209 for (n_dirty_caches = 0, i = 0; i < dev->param.n_caches; i++) {
5210 if (dev->cache[i].dirty)
5214 n_free -= n_dirty_caches;
5217 ((dev->param.n_reserved_blocks + 1) * dev->param.chunks_per_block);
5219 /* Now we figure out how much to reserve for the checkpoint and report that... */
5220 blocks_for_checkpt = yaffs_calc_checkpt_blocks_required(dev);
5222 n_free -= (blocks_for_checkpt * dev->param.chunks_per_block);