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 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
608 memset(obj->short_name, 0, sizeof(obj->short_name));
610 yaffs_strnlen(name, YAFFS_SHORT_NAME_LENGTH + 1) <=
611 YAFFS_SHORT_NAME_LENGTH)
612 yaffs_strcpy(obj->short_name, name);
614 obj->short_name[0] = _Y('\0');
616 obj->sum = yaffs_calc_name_sum(name);
619 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
620 const struct yaffs_obj_hdr *oh)
622 #ifdef CONFIG_YAFFS_AUTO_UNICODE
623 YCHAR tmp_name[YAFFS_MAX_NAME_LENGTH + 1];
624 memset(tmp_name, 0, sizeof(tmp_name));
625 yaffs_load_name_from_oh(obj->my_dev, tmp_name, oh->name,
626 YAFFS_MAX_NAME_LENGTH + 1);
627 yaffs_set_obj_name(obj, tmp_name);
629 yaffs_set_obj_name(obj, oh->name);
633 /*-------------------- TNODES -------------------
635 * List of spare tnodes
636 * The list is hooked together using the first pointer
640 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev)
642 struct yaffs_tnode *tn = yaffs_alloc_raw_tnode(dev);
644 memset(tn, 0, dev->tnode_size);
648 dev->checkpoint_blocks_required = 0; /* force recalculation */
653 /* FreeTnode frees up a tnode and puts it back on the free list */
654 static void yaffs_free_tnode(struct yaffs_dev *dev, struct yaffs_tnode *tn)
656 yaffs_free_raw_tnode(dev, tn);
658 dev->checkpoint_blocks_required = 0; /* force recalculation */
661 static void yaffs_deinit_tnodes_and_objs(struct yaffs_dev *dev)
663 yaffs_deinit_raw_tnodes_and_objs(dev);
668 void yaffs_load_tnode_0(struct yaffs_dev *dev, struct yaffs_tnode *tn,
669 unsigned pos, unsigned val)
671 u32 *map = (u32 *) tn;
677 pos &= YAFFS_TNODES_LEVEL0_MASK;
678 val >>= dev->chunk_grp_bits;
680 bit_in_map = pos * dev->tnode_width;
681 word_in_map = bit_in_map / 32;
682 bit_in_word = bit_in_map & (32 - 1);
684 mask = dev->tnode_mask << bit_in_word;
686 map[word_in_map] &= ~mask;
687 map[word_in_map] |= (mask & (val << bit_in_word));
689 if (dev->tnode_width > (32 - bit_in_word)) {
690 bit_in_word = (32 - bit_in_word);
693 dev->tnode_mask >> ( /*dev->tnode_width - */ bit_in_word);
694 map[word_in_map] &= ~mask;
695 map[word_in_map] |= (mask & (val >> bit_in_word));
699 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
702 u32 *map = (u32 *) tn;
708 pos &= YAFFS_TNODES_LEVEL0_MASK;
710 bit_in_map = pos * dev->tnode_width;
711 word_in_map = bit_in_map / 32;
712 bit_in_word = bit_in_map & (32 - 1);
714 val = map[word_in_map] >> bit_in_word;
716 if (dev->tnode_width > (32 - bit_in_word)) {
717 bit_in_word = (32 - bit_in_word);
719 val |= (map[word_in_map] << bit_in_word);
722 val &= dev->tnode_mask;
723 val <<= dev->chunk_grp_bits;
728 /* ------------------- End of individual tnode manipulation -----------------*/
730 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
731 * The look up tree is represented by the top tnode and the number of top_level
732 * in the tree. 0 means only the level 0 tnode is in the tree.
735 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
736 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
737 struct yaffs_file_var *file_struct,
740 struct yaffs_tnode *tn = file_struct->top;
743 int level = file_struct->top_level;
747 /* Check sane level and chunk Id */
748 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
751 if (chunk_id > YAFFS_MAX_CHUNK_ID)
754 /* First check we're tall enough (ie enough top_level) */
756 i = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
759 i >>= YAFFS_TNODES_INTERNAL_BITS;
763 if (required_depth > file_struct->top_level)
764 return NULL; /* Not tall enough, so we can't find it */
766 /* Traverse down to level 0 */
767 while (level > 0 && tn) {
768 tn = tn->internal[(chunk_id >>
769 (YAFFS_TNODES_LEVEL0_BITS +
771 YAFFS_TNODES_INTERNAL_BITS)) &
772 YAFFS_TNODES_INTERNAL_MASK];
779 /* AddOrFindLevel0Tnode finds the level 0 tnode if it exists, otherwise first expands the tree.
780 * This happens in two steps:
781 * 1. If the tree isn't tall enough, then make it taller.
782 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
784 * Used when modifying the tree.
786 * If the tn argument is NULL, then a fresh tnode will be added otherwise the specified tn will
787 * be plugged into the ttree.
790 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
791 struct yaffs_file_var *file_struct,
793 struct yaffs_tnode *passed_tn)
798 struct yaffs_tnode *tn;
802 /* Check sane level and page Id */
803 if (file_struct->top_level < 0
804 || file_struct->top_level > YAFFS_TNODES_MAX_LEVEL)
807 if (chunk_id > YAFFS_MAX_CHUNK_ID)
810 /* First check we're tall enough (ie enough top_level) */
812 x = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
815 x >>= YAFFS_TNODES_INTERNAL_BITS;
819 if (required_depth > file_struct->top_level) {
820 /* Not tall enough, gotta make the tree taller */
821 for (i = file_struct->top_level; i < required_depth; i++) {
823 tn = yaffs_get_tnode(dev);
826 tn->internal[0] = file_struct->top;
827 file_struct->top = tn;
828 file_struct->top_level++;
831 (TSTR("yaffs: no more tnodes" TENDSTR)));
837 /* Traverse down to level 0, adding anything we need */
839 l = file_struct->top_level;
840 tn = file_struct->top;
843 while (l > 0 && tn) {
845 (YAFFS_TNODES_LEVEL0_BITS +
846 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
847 YAFFS_TNODES_INTERNAL_MASK;
849 if ((l > 1) && !tn->internal[x]) {
850 /* Add missing non-level-zero tnode */
851 tn->internal[x] = yaffs_get_tnode(dev);
852 if (!tn->internal[x])
855 /* Looking from level 1 at level 0 */
857 /* If we already have one, then release it. */
859 yaffs_free_tnode(dev,
862 tn->internal[x] = passed_tn;
864 } else if (!tn->internal[x]) {
865 /* Don't have one, none passed in */
866 tn->internal[x] = yaffs_get_tnode(dev);
867 if (!tn->internal[x])
872 tn = tn->internal[x];
878 memcpy(tn, passed_tn,
879 (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8);
880 yaffs_free_tnode(dev, passed_tn);
887 static int yaffs_find_chunk_in_group(struct yaffs_dev *dev, int the_chunk,
888 struct yaffs_ext_tags *tags, int obj_id,
893 for (j = 0; the_chunk && j < dev->chunk_grp_size; j++) {
894 if (yaffs_check_chunk_bit
895 (dev, the_chunk / dev->param.chunks_per_block,
896 the_chunk % dev->param.chunks_per_block)) {
898 if (dev->chunk_grp_size == 1)
901 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
903 if (yaffs_tags_match(tags, obj_id, inode_chunk)) {
914 static void yaffs_soft_del_chunk(struct yaffs_dev *dev, int chunk)
916 struct yaffs_block_info *the_block;
919 T(YAFFS_TRACE_DELETION, (TSTR("soft delete chunk %d" TENDSTR), chunk));
921 block_no = chunk / dev->param.chunks_per_block;
922 the_block = yaffs_get_block_info(dev, block_no);
924 the_block->soft_del_pages++;
925 dev->n_free_chunks++;
926 yaffs2_update_oldest_dirty_seq(dev, block_no, the_block);
930 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all the chunks in the file.
931 * All soft deleting does is increment the block's softdelete count and pulls the chunk out
933 * Thus, essentially this is the same as DeleteWorker except that the chunks are soft deleted.
936 static int yaffs_soft_del_worker(struct yaffs_obj *in, struct yaffs_tnode *tn,
937 u32 level, int chunk_offset)
942 struct yaffs_dev *dev = in->my_dev;
947 for (i = YAFFS_NTNODES_INTERNAL - 1; all_done && i >= 0;
949 if (tn->internal[i]) {
951 yaffs_soft_del_worker(in,
957 YAFFS_TNODES_INTERNAL_BITS)
960 yaffs_free_tnode(dev,
963 tn->internal[i] = NULL;
965 /* Hoosterman... how could this happen? */
969 return (all_done) ? 1 : 0;
970 } else if (level == 0) {
972 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
973 the_chunk = yaffs_get_group_base(dev, tn, i);
975 /* Note this does not find the real chunk, only the chunk group.
976 * We make an assumption that a chunk group is not larger than
979 yaffs_soft_del_chunk(dev, the_chunk);
980 yaffs_load_tnode_0(dev, tn, i, 0);
994 static void yaffs_soft_del_file(struct yaffs_obj *obj)
997 obj->variant_type == YAFFS_OBJECT_TYPE_FILE && !obj->soft_del) {
998 if (obj->n_data_chunks <= 0) {
999 /* Empty file with no duplicate object headers, just delete it immediately */
1000 yaffs_free_tnode(obj->my_dev,
1001 obj->variant.file_variant.top);
1002 obj->variant.file_variant.top = NULL;
1003 T(YAFFS_TRACE_TRACING,
1004 (TSTR("yaffs: Deleting empty file %d" TENDSTR),
1006 yaffs_generic_obj_del(obj);
1008 yaffs_soft_del_worker(obj,
1009 obj->variant.file_variant.top,
1011 file_variant.top_level, 0);
1017 /* Pruning removes any part of the file structure tree that is beyond the
1018 * bounds of the file (ie that does not point to chunks).
1020 * A file should only get pruned when its size is reduced.
1022 * Before pruning, the chunks must be pulled from the tree and the
1023 * level 0 tnode entries must be zeroed out.
1024 * Could also use this for file deletion, but that's probably better handled
1025 * by a special case.
1027 * This function is recursive. For levels > 0 the function is called again on
1028 * any sub-tree. For level == 0 we just check if the sub-tree has data.
1029 * If there is no data in a subtree then it is pruned.
1032 static struct yaffs_tnode *yaffs_prune_worker(struct yaffs_dev *dev,
1033 struct yaffs_tnode *tn, u32 level,
1043 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1044 if (tn->internal[i]) {
1046 yaffs_prune_worker(dev,
1053 if (tn->internal[i])
1057 int tnode_size_u32 = dev->tnode_size / sizeof(u32);
1058 u32 *map = (u32 *) tn;
1060 for (i = 0; !has_data && i < tnode_size_u32; i++) {
1066 if (has_data == 0 && del0) {
1067 /* Free and return NULL */
1069 yaffs_free_tnode(dev, tn);
1079 static int yaffs_prune_tree(struct yaffs_dev *dev,
1080 struct yaffs_file_var *file_struct)
1085 struct yaffs_tnode *tn;
1087 if (file_struct->top_level > 0) {
1089 yaffs_prune_worker(dev, file_struct->top,
1090 file_struct->top_level, 0);
1092 /* Now we have a tree with all the non-zero branches NULL but the height
1093 * is the same as it was.
1094 * Let's see if we can trim internal tnodes to shorten the tree.
1095 * We can do this if only the 0th element in the tnode is in use
1096 * (ie all the non-zero are NULL)
1099 while (file_struct->top_level && !done) {
1100 tn = file_struct->top;
1103 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1104 if (tn->internal[i])
1109 file_struct->top = tn->internal[0];
1110 file_struct->top_level--;
1111 yaffs_free_tnode(dev, tn);
1121 /*-------------------- End of File Structure functions.-------------------*/
1123 /* AllocateEmptyObject gets us a clean Object. Tries to make allocate more if we run out */
1124 static struct yaffs_obj *yaffs_alloc_empty_obj(struct yaffs_dev *dev)
1126 struct yaffs_obj *obj = yaffs_alloc_raw_obj(dev);
1131 /* Now sweeten it up... */
1133 memset(obj, 0, sizeof(struct yaffs_obj));
1134 obj->being_created = 1;
1138 obj->variant_type = YAFFS_OBJECT_TYPE_UNKNOWN;
1139 INIT_LIST_HEAD(&(obj->hard_links));
1140 INIT_LIST_HEAD(&(obj->hash_link));
1141 INIT_LIST_HEAD(&obj->siblings);
1143 /* Now make the directory sane */
1144 if (dev->root_dir) {
1145 obj->parent = dev->root_dir;
1146 list_add(&(obj->siblings),
1147 &dev->root_dir->variant.dir_variant.children);
1150 /* Add it to the lost and found directory.
1151 * NB Can't put root or lost-n-found in lost-n-found so
1152 * check if lost-n-found exists first
1154 if (dev->lost_n_found)
1155 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
1157 obj->being_created = 0;
1160 dev->checkpoint_blocks_required = 0; /* force recalculation */
1165 static struct yaffs_obj *yaffs_create_fake_dir(struct yaffs_dev *dev,
1166 int number, u32 mode)
1169 struct yaffs_obj *obj =
1170 yaffs_new_obj(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1172 obj->fake = 1; /* it is fake so it might have no NAND presence... */
1173 obj->rename_allowed = 0; /* ... and we're not allowed to rename it... */
1174 obj->unlink_allowed = 0; /* ... or unlink it */
1177 obj->yst_mode = mode;
1179 obj->hdr_chunk = 0; /* Not a valid chunk. */
1186 static void yaffs_unhash_obj(struct yaffs_obj *obj)
1189 struct yaffs_dev *dev = obj->my_dev;
1191 /* If it is still linked into the bucket list, free from the list */
1192 if (!list_empty(&obj->hash_link)) {
1193 list_del_init(&obj->hash_link);
1194 bucket = yaffs_hash_fn(obj->obj_id);
1195 dev->obj_bucket[bucket].count--;
1199 /* FreeObject frees up a Object and puts it back on the free list */
1200 static void yaffs_free_obj(struct yaffs_obj *obj)
1202 struct yaffs_dev *dev = obj->my_dev;
1205 (TSTR("FreeObject %p inode %p" TENDSTR), obj, obj->my_inode));
1211 if (!list_empty(&obj->siblings))
1214 if (obj->my_inode) {
1215 /* We're still hooked up to a cached inode.
1216 * Don't delete now, but mark for later deletion
1218 obj->defered_free = 1;
1222 yaffs_unhash_obj(obj);
1224 yaffs_free_raw_obj(dev, obj);
1226 dev->checkpoint_blocks_required = 0; /* force recalculation */
1229 void yaffs_handle_defered_free(struct yaffs_obj *obj)
1231 if (obj->defered_free)
1232 yaffs_free_obj(obj);
1235 static void yaffs_init_tnodes_and_objs(struct yaffs_dev *dev)
1242 yaffs_init_raw_tnodes_and_objs(dev);
1244 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
1245 INIT_LIST_HEAD(&dev->obj_bucket[i].list);
1246 dev->obj_bucket[i].count = 0;
1250 static int yaffs_find_nice_bucket(struct yaffs_dev *dev)
1254 int lowest = 999999;
1256 /* Search for the shortest list or one that
1260 for (i = 0; i < 10 && lowest > 4; i++) {
1261 dev->bucket_finder++;
1262 dev->bucket_finder %= YAFFS_NOBJECT_BUCKETS;
1263 if (dev->obj_bucket[dev->bucket_finder].count < lowest) {
1264 lowest = dev->obj_bucket[dev->bucket_finder].count;
1265 l = dev->bucket_finder;
1273 static int yaffs_new_obj_id(struct yaffs_dev *dev)
1275 int bucket = yaffs_find_nice_bucket(dev);
1277 /* Now find an object value that has not already been taken
1278 * by scanning the list.
1282 struct list_head *i;
1284 u32 n = (u32) bucket;
1286 /* yaffs_check_obj_hash_sane(); */
1290 n += YAFFS_NOBJECT_BUCKETS;
1291 if (1 || dev->obj_bucket[bucket].count > 0) {
1292 list_for_each(i, &dev->obj_bucket[bucket].list) {
1293 /* If there is already one in the list */
1294 if (i && list_entry(i, struct yaffs_obj,
1295 hash_link)->obj_id == n) {
1305 static void yaffs_hash_obj(struct yaffs_obj *in)
1307 int bucket = yaffs_hash_fn(in->obj_id);
1308 struct yaffs_dev *dev = in->my_dev;
1310 list_add(&in->hash_link, &dev->obj_bucket[bucket].list);
1311 dev->obj_bucket[bucket].count++;
1314 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number)
1316 int bucket = yaffs_hash_fn(number);
1317 struct list_head *i;
1318 struct yaffs_obj *in;
1320 list_for_each(i, &dev->obj_bucket[bucket].list) {
1321 /* Look if it is in the list */
1323 in = list_entry(i, struct yaffs_obj, hash_link);
1324 if (in->obj_id == number) {
1326 /* Don't tell the VFS about this one if it is defered free */
1327 if (in->defered_free)
1338 struct yaffs_obj *yaffs_new_obj(struct yaffs_dev *dev, int number,
1339 enum yaffs_obj_type type)
1341 struct yaffs_obj *the_obj = NULL;
1342 struct yaffs_tnode *tn = NULL;
1345 number = yaffs_new_obj_id(dev);
1347 if (type == YAFFS_OBJECT_TYPE_FILE) {
1348 tn = yaffs_get_tnode(dev);
1353 the_obj = yaffs_alloc_empty_obj(dev);
1356 yaffs_free_tnode(dev, tn);
1362 the_obj->rename_allowed = 1;
1363 the_obj->unlink_allowed = 1;
1364 the_obj->obj_id = number;
1365 yaffs_hash_obj(the_obj);
1366 the_obj->variant_type = type;
1367 yaffs_load_current_time(the_obj, 1, 1);
1370 case YAFFS_OBJECT_TYPE_FILE:
1371 the_obj->variant.file_variant.file_size = 0;
1372 the_obj->variant.file_variant.scanned_size = 0;
1373 the_obj->variant.file_variant.shrink_size = ~0; /* max */
1374 the_obj->variant.file_variant.top_level = 0;
1375 the_obj->variant.file_variant.top = tn;
1377 case YAFFS_OBJECT_TYPE_DIRECTORY:
1378 INIT_LIST_HEAD(&the_obj->variant.dir_variant.children);
1379 INIT_LIST_HEAD(&the_obj->variant.dir_variant.dirty);
1381 case YAFFS_OBJECT_TYPE_SYMLINK:
1382 case YAFFS_OBJECT_TYPE_HARDLINK:
1383 case YAFFS_OBJECT_TYPE_SPECIAL:
1384 /* No action required */
1386 case YAFFS_OBJECT_TYPE_UNKNOWN:
1387 /* todo this should not happen */
1395 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
1397 enum yaffs_obj_type type)
1399 struct yaffs_obj *the_obj = NULL;
1402 the_obj = yaffs_find_by_number(dev, number);
1405 the_obj = yaffs_new_obj(dev, number, type);
1411 YCHAR *yaffs_clone_str(const YCHAR * str)
1413 YCHAR *new_str = NULL;
1419 len = yaffs_strnlen(str, YAFFS_MAX_ALIAS_LENGTH);
1420 new_str = YMALLOC((len + 1) * sizeof(YCHAR));
1422 yaffs_strncpy(new_str, str, len);
1430 * Mknod (create) a new object.
1431 * equiv_obj only has meaning for a hard link;
1432 * alias_str only has meaning for a symlink.
1433 * rdev only has meaning for devices (a subset of special objects)
1436 static struct yaffs_obj *yaffs_create_obj(enum yaffs_obj_type type,
1437 struct yaffs_obj *parent,
1442 struct yaffs_obj *equiv_obj,
1443 const YCHAR * alias_str, u32 rdev)
1445 struct yaffs_obj *in;
1448 struct yaffs_dev *dev = parent->my_dev;
1450 /* Check if the entry exists. If it does then fail the call since we don't want a dup. */
1451 if (yaffs_find_by_name(parent, name))
1454 if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
1455 str = yaffs_clone_str(alias_str);
1460 in = yaffs_new_obj(dev, -1, type);
1471 in->variant_type = type;
1473 in->yst_mode = mode;
1475 yaffs_attribs_init(in, gid, uid, rdev);
1477 in->n_data_chunks = 0;
1479 yaffs_set_obj_name(in, name);
1482 yaffs_add_obj_to_dir(parent, in);
1484 in->my_dev = parent->my_dev;
1487 case YAFFS_OBJECT_TYPE_SYMLINK:
1488 in->variant.symlink_variant.alias = str;
1490 case YAFFS_OBJECT_TYPE_HARDLINK:
1491 in->variant.hardlink_variant.equiv_obj = equiv_obj;
1492 in->variant.hardlink_variant.equiv_id =
1494 list_add(&in->hard_links, &equiv_obj->hard_links);
1496 case YAFFS_OBJECT_TYPE_FILE:
1497 case YAFFS_OBJECT_TYPE_DIRECTORY:
1498 case YAFFS_OBJECT_TYPE_SPECIAL:
1499 case YAFFS_OBJECT_TYPE_UNKNOWN:
1504 if (yaffs_update_oh(in, name, 0, 0, 0, NULL) < 0) {
1505 /* Could not create the object header, fail the creation */
1510 yaffs_update_parent(parent);
1516 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
1517 const YCHAR * name, u32 mode, u32 uid,
1520 return yaffs_create_obj(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
1521 uid, gid, NULL, NULL, 0);
1524 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR * name,
1525 u32 mode, u32 uid, u32 gid)
1527 return yaffs_create_obj(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
1528 mode, uid, gid, NULL, NULL, 0);
1531 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
1532 const YCHAR * name, u32 mode, u32 uid,
1535 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
1536 uid, gid, NULL, NULL, rdev);
1539 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
1540 const YCHAR * name, u32 mode, u32 uid,
1541 u32 gid, const YCHAR * alias)
1543 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
1544 uid, gid, NULL, alias, 0);
1547 /* yaffs_link_obj returns the object id of the equivalent object.*/
1548 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR * name,
1549 struct yaffs_obj *equiv_obj)
1551 /* Get the real object in case we were fed a hard link as an equivalent object */
1552 equiv_obj = yaffs_get_equivalent_obj(equiv_obj);
1554 if (yaffs_create_obj
1555 (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
1556 equiv_obj, NULL, 0)) {
1564 static int yaffs_change_obj_name(struct yaffs_obj *obj,
1565 struct yaffs_obj *new_dir,
1566 const YCHAR * new_name, int force, int shadows)
1571 struct yaffs_obj *existing_target;
1573 if (new_dir == NULL)
1574 new_dir = obj->parent; /* use the old directory */
1576 if (new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1577 T(YAFFS_TRACE_ALWAYS,
1579 ("tragedy: yaffs_change_obj_name: new_dir is not a directory"
1584 /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
1585 if (obj->my_dev->param.is_yaffs2)
1586 unlink_op = (new_dir == obj->my_dev->unlinked_dir);
1588 unlink_op = (new_dir == obj->my_dev->unlinked_dir
1589 && obj->variant_type == YAFFS_OBJECT_TYPE_FILE);
1591 del_op = (new_dir == obj->my_dev->del_dir);
1593 existing_target = yaffs_find_by_name(new_dir, new_name);
1595 /* If the object is a file going into the unlinked directory,
1596 * then it is OK to just stuff it in since duplicate names are allowed.
1597 * else only proceed if the new name does not exist and if we're putting
1598 * it into a directory.
1604 !existing_target) &&
1605 new_dir->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) {
1606 yaffs_set_obj_name(obj, new_name);
1609 yaffs_add_obj_to_dir(new_dir, obj);
1614 /* If it is a deletion then we mark it as a shrink for gc purposes. */
1615 if (yaffs_update_oh(obj, new_name, 0, del_op, shadows, NULL) >=
1625 * If old_name is NULL then we take old_dir as the object to be renamed.
1627 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
1628 struct yaffs_obj *new_dir, const YCHAR * new_name)
1630 struct yaffs_obj *obj = NULL;
1631 struct yaffs_obj *existing_target = NULL;
1634 struct yaffs_dev *dev;
1636 if (!old_dir || old_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
1638 if (!new_dir || new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
1641 dev = old_dir->my_dev;
1643 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
1644 /* Special case for case insemsitive systems.
1645 * While look-up is case insensitive, the name isn't.
1646 * Therefore we might want to change x.txt to X.txt
1648 if (old_dir == new_dir &&
1649 old_name && new_name &&
1650 yaffs_strcmp(old_name, new_name) == 0)
1654 if (yaffs_strnlen(new_name, YAFFS_MAX_NAME_LENGTH + 1) >
1655 YAFFS_MAX_NAME_LENGTH)
1660 obj = yaffs_find_by_name(old_dir, old_name);
1663 old_dir = obj->parent;
1667 if (obj && obj->rename_allowed) {
1669 /* Now do the handling for an existing target, if there is one */
1671 existing_target = yaffs_find_by_name(new_dir, new_name);
1672 if (existing_target &&
1673 existing_target->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY
1674 && !list_empty(&existing_target->variant.dir_variant.
1676 /* There is a target that is a non-empty directory, so we fail */
1677 return YAFFS_FAIL; /* EEXIST or ENOTEMPTY */
1678 } else if (existing_target && existing_target != obj) {
1679 /* Nuke the target first, using shadowing,
1680 * but only if it isn't the same object.
1682 * Note we must disable gc otherwise it can mess up the shadowing.
1685 dev->gc_disable = 1;
1686 yaffs_change_obj_name(obj, new_dir, new_name, force,
1687 existing_target->obj_id);
1688 existing_target->is_shadowed = 1;
1689 yaffs_unlink_obj(existing_target);
1690 dev->gc_disable = 0;
1693 result = yaffs_change_obj_name(obj, new_dir, new_name, 1, 0);
1695 yaffs_update_parent(old_dir);
1696 if (new_dir != old_dir)
1697 yaffs_update_parent(new_dir);
1704 /*------------------------- Block Management and Page Allocation ----------------*/
1706 static int yaffs_init_blocks(struct yaffs_dev *dev)
1708 int n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
1710 dev->block_info = NULL;
1711 dev->chunk_bits = NULL;
1713 dev->alloc_block = -1; /* force it to get a new one */
1715 /* If the first allocation strategy fails, thry the alternate one */
1716 dev->block_info = YMALLOC(n_blocks * sizeof(struct yaffs_block_info));
1717 if (!dev->block_info) {
1719 YMALLOC_ALT(n_blocks * sizeof(struct yaffs_block_info));
1720 dev->block_info_alt = 1;
1722 dev->block_info_alt = 0;
1725 if (dev->block_info) {
1726 /* Set up dynamic blockinfo stuff. */
1727 dev->chunk_bit_stride = (dev->param.chunks_per_block + 7) / 8; /* round up bytes */
1728 dev->chunk_bits = YMALLOC(dev->chunk_bit_stride * n_blocks);
1729 if (!dev->chunk_bits) {
1731 YMALLOC_ALT(dev->chunk_bit_stride * n_blocks);
1732 dev->chunk_bits_alt = 1;
1734 dev->chunk_bits_alt = 0;
1738 if (dev->block_info && dev->chunk_bits) {
1739 memset(dev->block_info, 0,
1740 n_blocks * sizeof(struct yaffs_block_info));
1741 memset(dev->chunk_bits, 0, dev->chunk_bit_stride * n_blocks);
1748 static void yaffs_deinit_blocks(struct yaffs_dev *dev)
1750 if (dev->block_info_alt && dev->block_info)
1751 YFREE_ALT(dev->block_info);
1752 else if (dev->block_info)
1753 YFREE(dev->block_info);
1755 dev->block_info_alt = 0;
1757 dev->block_info = NULL;
1759 if (dev->chunk_bits_alt && dev->chunk_bits)
1760 YFREE_ALT(dev->chunk_bits);
1761 else if (dev->chunk_bits)
1762 YFREE(dev->chunk_bits);
1763 dev->chunk_bits_alt = 0;
1764 dev->chunk_bits = NULL;
1767 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no)
1769 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block_no);
1773 /* If the block is still healthy erase it and mark as clean.
1774 * If the block has had a data failure, then retire it.
1777 T(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
1778 (TSTR("yaffs_block_became_dirty block %d state %d %s" TENDSTR),
1779 block_no, bi->block_state,
1780 (bi->needs_retiring) ? "needs retiring" : ""));
1782 yaffs2_clear_oldest_dirty_seq(dev, bi);
1784 bi->block_state = YAFFS_BLOCK_STATE_DIRTY;
1786 /* If this is the block being garbage collected then stop gc'ing this block */
1787 if (block_no == dev->gc_block)
1790 /* If this block is currently the best candidate for gc then drop as a candidate */
1791 if (block_no == dev->gc_dirtiest) {
1792 dev->gc_dirtiest = 0;
1793 dev->gc_pages_in_use = 0;
1796 if (!bi->needs_retiring) {
1797 yaffs2_checkpt_invalidate(dev);
1798 erased_ok = yaffs_erase_block(dev, block_no);
1800 dev->n_erase_failures++;
1801 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1802 (TSTR("**>> Erasure failed %d" TENDSTR), block_no));
1807 ((yaffs_trace_mask & YAFFS_TRACE_ERASE)
1808 || !yaffs_skip_verification(dev))) {
1810 for (i = 0; i < dev->param.chunks_per_block; i++) {
1811 if (!yaffs_check_chunk_erased
1812 (dev, block_no * dev->param.chunks_per_block + i)) {
1813 T(YAFFS_TRACE_ERROR,
1815 (">>Block %d erasure supposedly OK, but chunk %d not erased"
1816 TENDSTR), block_no, i));
1822 /* Clean it up... */
1823 bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
1825 dev->n_erased_blocks++;
1826 bi->pages_in_use = 0;
1827 bi->soft_del_pages = 0;
1828 bi->has_shrink_hdr = 0;
1829 bi->skip_erased_check = 1; /* This is clean, so no need to check */
1830 bi->gc_prioritise = 0;
1831 yaffs_clear_chunk_bits(dev, block_no);
1833 T(YAFFS_TRACE_ERASE,
1834 (TSTR("Erased block %d" TENDSTR), block_no));
1836 dev->n_free_chunks -= dev->param.chunks_per_block; /* We lost a block of free space */
1838 yaffs_retire_block(dev, block_no);
1839 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
1840 (TSTR("**>> Block %d retired" TENDSTR), block_no));
1844 static int yaffs_find_alloc_block(struct yaffs_dev *dev)
1848 struct yaffs_block_info *bi;
1850 if (dev->n_erased_blocks < 1) {
1851 /* Hoosterman we've got a problem.
1852 * Can't get space to gc
1854 T(YAFFS_TRACE_ERROR,
1855 (TSTR("yaffs tragedy: no more erased blocks" TENDSTR)));
1860 /* Find an empty block. */
1862 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
1863 dev->alloc_block_finder++;
1864 if (dev->alloc_block_finder < dev->internal_start_block
1865 || dev->alloc_block_finder > dev->internal_end_block) {
1866 dev->alloc_block_finder = dev->internal_start_block;
1869 bi = yaffs_get_block_info(dev, dev->alloc_block_finder);
1871 if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
1872 bi->block_state = YAFFS_BLOCK_STATE_ALLOCATING;
1874 bi->seq_number = dev->seq_number;
1875 dev->n_erased_blocks--;
1876 T(YAFFS_TRACE_ALLOCATE,
1877 (TSTR("Allocated block %d, seq %d, %d left" TENDSTR),
1878 dev->alloc_block_finder, dev->seq_number,
1879 dev->n_erased_blocks));
1880 return dev->alloc_block_finder;
1884 T(YAFFS_TRACE_ALWAYS,
1886 ("yaffs tragedy: no more erased blocks, but there should have been %d"
1887 TENDSTR), dev->n_erased_blocks));
1893 * Check if there's space to allocate...
1894 * Thinks.... do we need top make this ths same as yaffs_get_free_chunks()?
1896 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks)
1898 int reserved_chunks;
1899 int reserved_blocks = dev->param.n_reserved_blocks;
1902 checkpt_blocks = yaffs_calc_checkpt_blocks_required(dev);
1905 ((reserved_blocks + checkpt_blocks) * dev->param.chunks_per_block);
1907 return (dev->n_free_chunks > (reserved_chunks + n_chunks));
1910 static int yaffs_alloc_chunk(struct yaffs_dev *dev, int use_reserver,
1911 struct yaffs_block_info **block_ptr)
1914 struct yaffs_block_info *bi;
1916 if (dev->alloc_block < 0) {
1917 /* Get next block to allocate off */
1918 dev->alloc_block = yaffs_find_alloc_block(dev);
1919 dev->alloc_page = 0;
1922 if (!use_reserver && !yaffs_check_alloc_available(dev, 1)) {
1923 /* Not enough space to allocate unless we're allowed to use the reserve. */
1927 if (dev->n_erased_blocks < dev->param.n_reserved_blocks
1928 && dev->alloc_page == 0) {
1929 T(YAFFS_TRACE_ALLOCATE, (TSTR("Allocating reserve" TENDSTR)));
1932 /* Next page please.... */
1933 if (dev->alloc_block >= 0) {
1934 bi = yaffs_get_block_info(dev, dev->alloc_block);
1936 ret_val = (dev->alloc_block * dev->param.chunks_per_block) +
1939 yaffs_set_chunk_bit(dev, dev->alloc_block, dev->alloc_page);
1943 dev->n_free_chunks--;
1945 /* If the block is full set the state to full */
1946 if (dev->alloc_page >= dev->param.chunks_per_block) {
1947 bi->block_state = YAFFS_BLOCK_STATE_FULL;
1948 dev->alloc_block = -1;
1957 T(YAFFS_TRACE_ERROR,
1958 (TSTR("!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!" TENDSTR)));
1963 static int yaffs_get_erased_chunks(struct yaffs_dev *dev)
1967 n = dev->n_erased_blocks * dev->param.chunks_per_block;
1969 if (dev->alloc_block > 0)
1970 n += (dev->param.chunks_per_block - dev->alloc_page);
1977 * yaffs_skip_rest_of_block() skips over the rest of the allocation block
1978 * if we don't want to write to it.
1980 void yaffs_skip_rest_of_block(struct yaffs_dev *dev)
1982 if (dev->alloc_block > 0) {
1983 struct yaffs_block_info *bi =
1984 yaffs_get_block_info(dev, dev->alloc_block);
1985 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING) {
1986 bi->block_state = YAFFS_BLOCK_STATE_FULL;
1987 dev->alloc_block = -1;
1992 static int yaffs_gc_block(struct yaffs_dev *dev, int block, int whole_block)
1997 int ret_val = YAFFS_OK;
1999 int is_checkpt_block;
2003 int chunks_before = yaffs_get_erased_chunks(dev);
2006 struct yaffs_ext_tags tags;
2008 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block);
2010 struct yaffs_obj *object;
2012 is_checkpt_block = (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT);
2014 T(YAFFS_TRACE_TRACING,
2016 ("Collecting block %d, in use %d, shrink %d, whole_block %d"
2017 TENDSTR), block, bi->pages_in_use, bi->has_shrink_hdr,
2020 /*yaffs_verify_free_chunks(dev); */
2022 if (bi->block_state == YAFFS_BLOCK_STATE_FULL)
2023 bi->block_state = YAFFS_BLOCK_STATE_COLLECTING;
2025 bi->has_shrink_hdr = 0; /* clear the flag so that the block can erase */
2027 dev->gc_disable = 1;
2029 if (is_checkpt_block || !yaffs_still_some_chunks(dev, block)) {
2030 T(YAFFS_TRACE_TRACING,
2032 ("Collecting block %d that has no chunks in use" TENDSTR),
2034 yaffs_block_became_dirty(dev, block);
2037 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
2039 yaffs_verify_blk(dev, bi, block);
2041 max_copies = (whole_block) ? dev->param.chunks_per_block : 5;
2042 old_chunk = block * dev->param.chunks_per_block + dev->gc_chunk;
2044 for ( /* init already done */ ;
2045 ret_val == YAFFS_OK &&
2046 dev->gc_chunk < dev->param.chunks_per_block &&
2047 (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) &&
2048 max_copies > 0; dev->gc_chunk++, old_chunk++) {
2049 if (yaffs_check_chunk_bit(dev, block, dev->gc_chunk)) {
2051 /* This page is in use and might need to be copied off */
2057 yaffs_init_tags(&tags);
2059 yaffs_rd_chunk_tags_nand(dev, old_chunk,
2062 object = yaffs_find_by_number(dev, tags.obj_id);
2064 T(YAFFS_TRACE_GC_DETAIL,
2066 ("Collecting chunk in block %d, %d %d %d "
2067 TENDSTR), dev->gc_chunk, tags.obj_id,
2068 tags.chunk_id, tags.n_bytes));
2070 if (object && !yaffs_skip_verification(dev)) {
2071 if (tags.chunk_id == 0)
2074 else if (object->soft_del)
2075 matching_chunk = old_chunk; /* Defeat the test */
2078 yaffs_find_chunk_in_file
2079 (object, tags.chunk_id,
2082 if (old_chunk != matching_chunk)
2083 T(YAFFS_TRACE_ERROR,
2085 ("gc: page in gc mismatch: %d %d %d %d"
2086 TENDSTR), old_chunk,
2087 matching_chunk, tags.obj_id,
2093 T(YAFFS_TRACE_ERROR,
2095 ("page %d in gc has no object: %d %d %d "
2096 TENDSTR), old_chunk,
2097 tags.obj_id, tags.chunk_id,
2103 object->soft_del && tags.chunk_id != 0) {
2104 /* Data chunk in a soft deleted file, throw it away
2105 * It's a soft deleted data chunk,
2106 * No need to copy this, just forget about it and
2107 * fix up the object.
2110 /* Free chunks already includes softdeleted chunks.
2111 * How ever this chunk is going to soon be really deleted
2112 * which will increment free chunks.
2113 * We have to decrement free chunks so this works out properly.
2115 dev->n_free_chunks--;
2116 bi->soft_del_pages--;
2118 object->n_data_chunks--;
2120 if (object->n_data_chunks <= 0) {
2121 /* remeber to clean up the object */
2122 dev->gc_cleanup_list[dev->
2129 /* Todo object && object->deleted && object->n_data_chunks == 0 */
2130 /* Deleted object header with no data chunks.
2131 * Can be discarded and the file deleted.
2133 object->hdr_chunk = 0;
2134 yaffs_free_tnode(object->my_dev,
2136 variant.file_variant.
2138 object->variant.file_variant.top = NULL;
2139 yaffs_generic_obj_del(object);
2141 } else if (object) {
2142 /* It's either a data chunk in a live file or
2143 * an ObjectHeader, so we're interested in it.
2144 * NB Need to keep the ObjectHeaders of deleted files
2145 * until the whole file has been deleted off
2147 tags.serial_number++;
2151 if (tags.chunk_id == 0) {
2152 /* It is an object Id,
2153 * We need to nuke the shrinkheader flags first
2154 * Also need to clean up shadowing.
2155 * We no longer want the shrink_header flag since its work is done
2156 * and if it is left in place it will mess up scanning.
2159 struct yaffs_obj_hdr *oh;
2160 oh = (struct yaffs_obj_hdr *)
2164 tags.extra_is_shrink = 0;
2166 oh->shadows_obj = 0;
2167 oh->inband_shadowed_obj_id = 0;
2168 tags.extra_shadows = 0;
2170 /* Update file size */
2171 if (object->variant_type ==
2172 YAFFS_OBJECT_TYPE_FILE) {
2181 yaffs_verify_oh(object, oh,
2184 yaffs_write_new_chunk(dev,
2191 yaffs_write_new_chunk(dev,
2197 if (new_chunk < 0) {
2198 ret_val = YAFFS_FAIL;
2201 /* Ok, now fix up the Tnodes etc. */
2203 if (tags.chunk_id == 0) {
2210 /* It's a data chunk */
2212 ok = yaffs_put_chunk_in_file(object, tags.chunk_id, new_chunk, 0);
2217 if (ret_val == YAFFS_OK)
2218 yaffs_chunk_del(dev, old_chunk,
2219 mark_flash, __LINE__);
2224 yaffs_release_temp_buffer(dev, buffer, __LINE__);
2228 yaffs_verify_collected_blk(dev, bi, block);
2230 if (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2232 * The gc did not complete. Set block state back to FULL
2233 * because checkpointing does not restore gc.
2235 bi->block_state = YAFFS_BLOCK_STATE_FULL;
2237 /* The gc completed. */
2238 /* Do any required cleanups */
2239 for (i = 0; i < dev->n_clean_ups; i++) {
2240 /* Time to delete the file too */
2242 yaffs_find_by_number(dev, dev->gc_cleanup_list[i]);
2244 yaffs_free_tnode(dev,
2247 object->variant.file_variant.top = NULL;
2250 ("yaffs: About to finally delete object %d"
2251 TENDSTR), object->obj_id));
2252 yaffs_generic_obj_del(object);
2253 object->my_dev->n_deleted_files--;
2258 chunks_after = yaffs_get_erased_chunks(dev);
2259 if (chunks_before >= chunks_after) {
2262 ("gc did not increase free chunks before %d after %d"
2263 TENDSTR), chunks_before, chunks_after));
2267 dev->n_clean_ups = 0;
2270 dev->gc_disable = 0;
2276 * FindBlockForgarbageCollection is used to select the dirtiest block (or close enough)
2277 * for garbage collection.
2280 static unsigned yaffs_find_gc_block(struct yaffs_dev *dev,
2281 int aggressive, int background)
2285 unsigned selected = 0;
2286 int prioritised = 0;
2287 int prioritised_exist = 0;
2288 struct yaffs_block_info *bi;
2291 /* First let's see if we need to grab a prioritised block */
2292 if (dev->has_pending_prioritised_gc && !aggressive) {
2293 dev->gc_dirtiest = 0;
2294 bi = dev->block_info;
2295 for (i = dev->internal_start_block;
2296 i <= dev->internal_end_block && !selected; i++) {
2298 if (bi->gc_prioritise) {
2299 prioritised_exist = 1;
2300 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2301 yaffs_block_ok_for_gc(dev, bi)) {
2310 * If there is a prioritised block and none was selected then
2311 * this happened because there is at least one old dirty block gumming
2312 * up the works. Let's gc the oldest dirty block.
2315 if (prioritised_exist &&
2316 !selected && dev->oldest_dirty_block > 0)
2317 selected = dev->oldest_dirty_block;
2319 if (!prioritised_exist) /* None found, so we can clear this */
2320 dev->has_pending_prioritised_gc = 0;
2323 /* If we're doing aggressive GC then we are happy to take a less-dirty block, and
2325 * else (we're doing a leasurely gc), then we only bother to do this if the
2326 * block has only a few pages in use.
2332 dev->internal_end_block - dev->internal_start_block + 1;
2334 threshold = dev->param.chunks_per_block;
2335 iterations = n_blocks;
2340 max_threshold = dev->param.chunks_per_block / 2;
2342 max_threshold = dev->param.chunks_per_block / 8;
2344 if (max_threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2345 max_threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2347 threshold = background ? (dev->gc_not_done + 2) * 2 : 0;
2348 if (threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2349 threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2350 if (threshold > max_threshold)
2351 threshold = max_threshold;
2353 iterations = n_blocks / 16 + 1;
2354 if (iterations > 100)
2360 (dev->gc_dirtiest < 1 ||
2361 dev->gc_pages_in_use > YAFFS_GC_GOOD_ENOUGH); i++) {
2362 dev->gc_block_finder++;
2363 if (dev->gc_block_finder < dev->internal_start_block ||
2364 dev->gc_block_finder > dev->internal_end_block)
2365 dev->gc_block_finder =
2366 dev->internal_start_block;
2368 bi = yaffs_get_block_info(dev, dev->gc_block_finder);
2370 pages_used = bi->pages_in_use - bi->soft_del_pages;
2372 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2373 pages_used < dev->param.chunks_per_block &&
2374 (dev->gc_dirtiest < 1
2375 || pages_used < dev->gc_pages_in_use)
2376 && yaffs_block_ok_for_gc(dev, bi)) {
2377 dev->gc_dirtiest = dev->gc_block_finder;
2378 dev->gc_pages_in_use = pages_used;
2382 if (dev->gc_dirtiest > 0 && dev->gc_pages_in_use <= threshold)
2383 selected = dev->gc_dirtiest;
2387 * If nothing has been selected for a while, try selecting the oldest dirty
2388 * because that's gumming up the works.
2391 if (!selected && dev->param.is_yaffs2 &&
2392 dev->gc_not_done >= (background ? 10 : 20)) {
2393 yaffs2_find_oldest_dirty_seq(dev);
2394 if (dev->oldest_dirty_block > 0) {
2395 selected = dev->oldest_dirty_block;
2396 dev->gc_dirtiest = selected;
2397 dev->oldest_dirty_gc_count++;
2398 bi = yaffs_get_block_info(dev, selected);
2399 dev->gc_pages_in_use =
2400 bi->pages_in_use - bi->soft_del_pages;
2402 dev->gc_not_done = 0;
2409 ("GC Selected block %d with %d free, prioritised:%d"
2411 dev->param.chunks_per_block - dev->gc_pages_in_use,
2418 dev->gc_dirtiest = 0;
2419 dev->gc_pages_in_use = 0;
2420 dev->gc_not_done = 0;
2421 if (dev->refresh_skip > 0)
2422 dev->refresh_skip--;
2427 ("GC none: finder %d skip %d threshold %d dirtiest %d using %d oldest %d%s"
2428 TENDSTR), dev->gc_block_finder, dev->gc_not_done, threshold,
2429 dev->gc_dirtiest, dev->gc_pages_in_use,
2430 dev->oldest_dirty_block, background ? " bg" : ""));
2436 /* New garbage collector
2437 * If we're very low on erased blocks then we do aggressive garbage collection
2438 * otherwise we do "leasurely" garbage collection.
2439 * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2440 * Passive gc only inspects smaller areas and will only accept more dirty blocks.
2442 * The idea is to help clear out space in a more spread-out manner.
2443 * Dunno if it really does anything useful.
2445 static int yaffs_check_gc(struct yaffs_dev *dev, int background)
2448 int gc_ok = YAFFS_OK;
2452 int checkpt_block_adjust;
2454 if (dev->param.gc_control && (dev->param.gc_control(dev) & 1) == 0)
2457 if (dev->gc_disable) {
2458 /* Bail out so we don't get recursive gc */
2462 /* This loop should pass the first time.
2463 * We'll only see looping here if the collection does not increase space.
2469 checkpt_block_adjust = yaffs_calc_checkpt_blocks_required(dev);
2472 dev->param.n_reserved_blocks + checkpt_block_adjust + 1;
2474 dev->n_erased_blocks * dev->param.chunks_per_block;
2476 /* If we need a block soon then do aggressive gc. */
2477 if (dev->n_erased_blocks < min_erased)
2481 && erased_chunks > (dev->n_free_chunks / 4))
2484 if (dev->gc_skip > 20)
2486 if (erased_chunks < dev->n_free_chunks / 2 ||
2487 dev->gc_skip < 1 || background)
2497 /* If we don't already have a block being gc'd then see if we should start another */
2499 if (dev->gc_block < 1 && !aggressive) {
2500 dev->gc_block = yaffs2_find_refresh_block(dev);
2502 dev->n_clean_ups = 0;
2504 if (dev->gc_block < 1) {
2506 yaffs_find_gc_block(dev, aggressive, background);
2508 dev->n_clean_ups = 0;
2511 if (dev->gc_block > 0) {
2514 dev->passive_gc_count++;
2518 ("yaffs: GC n_erased_blocks %d aggressive %d"
2519 TENDSTR), dev->n_erased_blocks, aggressive));
2521 gc_ok = yaffs_gc_block(dev, dev->gc_block, aggressive);
2524 if (dev->n_erased_blocks < (dev->param.n_reserved_blocks)
2525 && dev->gc_block > 0) {
2528 ("yaffs: GC !!!no reclaim!!! n_erased_blocks %d after try %d block %d"
2529 TENDSTR), dev->n_erased_blocks, max_tries,
2532 } while ((dev->n_erased_blocks < dev->param.n_reserved_blocks) &&
2533 (dev->gc_block > 0) && (max_tries < 2));
2535 return aggressive ? gc_ok : YAFFS_OK;
2540 * Garbage collects. Intended to be called from a background thread.
2541 * Returns non-zero if at least half the free chunks are erased.
2543 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency)
2545 int erased_chunks = dev->n_erased_blocks * dev->param.chunks_per_block;
2547 T(YAFFS_TRACE_BACKGROUND, (TSTR("Background gc %u" TENDSTR), urgency));
2549 yaffs_check_gc(dev, 1);
2550 return erased_chunks > dev->n_free_chunks / 2;
2553 /*------------------------- TAGS --------------------------------*/
2555 static int yaffs_tags_match(const struct yaffs_ext_tags *tags, int obj_id,
2558 return (tags->chunk_id == chunk_obj &&
2559 tags->obj_id == obj_id && !tags->is_deleted) ? 1 : 0;
2563 /*-------------------- Data file manipulation -----------------*/
2565 static int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
2566 struct yaffs_ext_tags *tags)
2568 /*Get the Tnode, then get the level 0 offset chunk offset */
2569 struct yaffs_tnode *tn;
2571 struct yaffs_ext_tags local_tags;
2574 struct yaffs_dev *dev = in->my_dev;
2577 /* Passed a NULL, so use our own tags space */
2581 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
2584 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
2587 yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
2593 static int yaffs_find_del_file_chunk(struct yaffs_obj *in, int inode_chunk,
2594 struct yaffs_ext_tags *tags)
2596 /* Get the Tnode, then get the level 0 offset chunk offset */
2597 struct yaffs_tnode *tn;
2599 struct yaffs_ext_tags local_tags;
2601 struct yaffs_dev *dev = in->my_dev;
2605 /* Passed a NULL, so use our own tags space */
2609 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
2613 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
2616 yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
2619 /* Delete the entry in the filestructure (if found) */
2621 yaffs_load_tnode_0(dev, tn, inode_chunk, 0);
2627 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
2628 int nand_chunk, int in_scan)
2630 /* NB in_scan is zero unless scanning.
2631 * For forward scanning, in_scan is > 0;
2632 * for backward scanning in_scan is < 0
2634 * nand_chunk = 0 is a dummy insert to make sure the tnodes are there.
2637 struct yaffs_tnode *tn;
2638 struct yaffs_dev *dev = in->my_dev;
2640 struct yaffs_ext_tags existing_tags;
2641 struct yaffs_ext_tags new_tags;
2642 unsigned existing_serial, new_serial;
2644 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE) {
2645 /* Just ignore an attempt at putting a chunk into a non-file during scanning
2646 * If it is not during Scanning then something went wrong!
2649 T(YAFFS_TRACE_ERROR,
2651 ("yaffs tragedy:attempt to put data chunk into a non-file"
2656 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
2660 tn = yaffs_add_find_tnode_0(dev,
2661 &in->variant.file_variant,
2667 /* Dummy insert, bail now */
2670 existing_cunk = yaffs_get_group_base(dev, tn, inode_chunk);
2673 /* If we're scanning then we need to test for duplicates
2674 * NB This does not need to be efficient since it should only ever
2675 * happen when the power fails during a write, then only one
2676 * chunk should ever be affected.
2678 * Correction for YAFFS2: This could happen quite a lot and we need to think about efficiency! TODO
2679 * Update: For backward scanning we don't need to re-read tags so this is quite cheap.
2682 if (existing_cunk > 0) {
2683 /* NB Right now existing chunk will not be real chunk_id if the chunk group size > 1
2684 * thus we have to do a FindChunkInFile to get the real chunk id.
2686 * We have a duplicate now we need to decide which one to use:
2688 * Backwards scanning YAFFS2: The old one is what we use, dump the new one.
2689 * Forward scanning YAFFS2: The new one is what we use, dump the old one.
2690 * YAFFS1: Get both sets of tags and compare serial numbers.
2694 /* Only do this for forward scanning */
2695 yaffs_rd_chunk_tags_nand(dev,
2699 /* Do a proper find */
2701 yaffs_find_chunk_in_file(in, inode_chunk,
2705 if (existing_cunk <= 0) {
2706 /*Hoosterman - how did this happen? */
2708 T(YAFFS_TRACE_ERROR,
2710 ("yaffs tragedy: existing chunk < 0 in scan"
2715 /* NB The deleted flags should be false, otherwise the chunks will
2716 * not be loaded during a scan
2720 new_serial = new_tags.serial_number;
2721 existing_serial = existing_tags.serial_number;
2724 if ((in_scan > 0) &&
2725 (existing_cunk <= 0 ||
2726 ((existing_serial + 1) & 3) == new_serial)) {
2727 /* Forward scanning.
2729 * Delete the old one and drop through to update the tnode
2731 yaffs_chunk_del(dev, existing_cunk, 1,
2734 /* Backward scanning or we want to use the existing one
2736 * Delete the new one and return early so that the tnode isn't changed
2738 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
2745 if (existing_cunk == 0)
2746 in->n_data_chunks++;
2748 yaffs_load_tnode_0(dev, tn, inode_chunk, nand_chunk);
2753 static int yaffs_rd_data_obj(struct yaffs_obj *in, int inode_chunk, u8 * buffer)
2755 int nand_chunk = yaffs_find_chunk_in_file(in, inode_chunk, NULL);
2757 if (nand_chunk >= 0)
2758 return yaffs_rd_chunk_tags_nand(in->my_dev, nand_chunk,
2761 T(YAFFS_TRACE_NANDACCESS,
2762 (TSTR("Chunk %d not found zero instead" TENDSTR),
2764 /* get sane (zero) data if you read a hole */
2765 memset(buffer, 0, in->my_dev->data_bytes_per_chunk);
2771 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
2776 struct yaffs_ext_tags tags;
2777 struct yaffs_block_info *bi;
2783 block = chunk_id / dev->param.chunks_per_block;
2784 page = chunk_id % dev->param.chunks_per_block;
2786 if (!yaffs_check_chunk_bit(dev, block, page))
2787 T(YAFFS_TRACE_VERIFY,
2788 (TSTR("Deleting invalid chunk %d" TENDSTR), chunk_id));
2790 bi = yaffs_get_block_info(dev, block);
2792 yaffs2_update_oldest_dirty_seq(dev, block, bi);
2794 T(YAFFS_TRACE_DELETION,
2795 (TSTR("line %d delete of chunk %d" TENDSTR), lyn, chunk_id));
2797 if (!dev->param.is_yaffs2 && mark_flash &&
2798 bi->block_state != YAFFS_BLOCK_STATE_COLLECTING) {
2800 yaffs_init_tags(&tags);
2802 tags.is_deleted = 1;
2804 yaffs_wr_chunk_tags_nand(dev, chunk_id, NULL, &tags);
2805 yaffs_handle_chunk_update(dev, chunk_id, &tags);
2807 dev->n_unmarked_deletions++;
2810 /* Pull out of the management area.
2811 * If the whole block became dirty, this will kick off an erasure.
2813 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING ||
2814 bi->block_state == YAFFS_BLOCK_STATE_FULL ||
2815 bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
2816 bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2817 dev->n_free_chunks++;
2819 yaffs_clear_chunk_bit(dev, block, page);
2823 if (bi->pages_in_use == 0 &&
2824 !bi->has_shrink_hdr &&
2825 bi->block_state != YAFFS_BLOCK_STATE_ALLOCATING &&
2826 bi->block_state != YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
2827 yaffs_block_became_dirty(dev, block);
2834 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
2835 const u8 * buffer, int n_bytes, int use_reserve)
2837 /* Find old chunk Need to do this to get serial number
2838 * Write new one and patch into tree.
2839 * Invalidate old tags.
2843 struct yaffs_ext_tags prev_tags;
2846 struct yaffs_ext_tags new_tags;
2848 struct yaffs_dev *dev = in->my_dev;
2850 yaffs_check_gc(dev, 0);
2852 /* Get the previous chunk at this location in the file if it exists.
2853 * If it does not exist then put a zero into the tree. This creates
2854 * the tnode now, rather than later when it is harder to clean up.
2856 prev_chunk_id = yaffs_find_chunk_in_file(in, inode_chunk, &prev_tags);
2857 if (prev_chunk_id < 1 &&
2858 !yaffs_put_chunk_in_file(in, inode_chunk, 0, 0))
2861 /* Set up new tags */
2862 yaffs_init_tags(&new_tags);
2864 new_tags.chunk_id = inode_chunk;
2865 new_tags.obj_id = in->obj_id;
2866 new_tags.serial_number =
2867 (prev_chunk_id > 0) ? prev_tags.serial_number + 1 : 1;
2868 new_tags.n_bytes = n_bytes;
2870 if (n_bytes < 1 || n_bytes > dev->param.total_bytes_per_chunk) {
2871 T(YAFFS_TRACE_ERROR,
2872 (TSTR("Writing %d bytes to chunk!!!!!!!!!" TENDSTR),
2878 yaffs_write_new_chunk(dev, buffer, &new_tags, use_reserve);
2880 if (new_chunk_id > 0) {
2881 yaffs_put_chunk_in_file(in, inode_chunk, new_chunk_id, 0);
2883 if (prev_chunk_id > 0)
2884 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
2886 yaffs_verify_file_sane(in);
2888 return new_chunk_id;
2892 /* UpdateObjectHeader updates the header on NAND for an object.
2893 * If name is not NULL, then that new name is used.
2895 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR * name, int force,
2896 int is_shrink, int shadows, struct yaffs_xattr_mod *xmod)
2899 struct yaffs_block_info *bi;
2901 struct yaffs_dev *dev = in->my_dev;
2908 struct yaffs_ext_tags new_tags;
2909 struct yaffs_ext_tags old_tags;
2910 const YCHAR *alias = NULL;
2913 YCHAR old_name[YAFFS_MAX_NAME_LENGTH + 1];
2915 struct yaffs_obj_hdr *oh = NULL;
2917 yaffs_strcpy(old_name, _Y("silly old name"));
2919 if (!in->fake || in == dev->root_dir || /* The root_dir should also be saved */
2922 yaffs_check_gc(dev, 0);
2923 yaffs_check_obj_details_loaded(in);
2925 buffer = yaffs_get_temp_buffer(in->my_dev, __LINE__);
2926 oh = (struct yaffs_obj_hdr *)buffer;
2928 prev_chunk_id = in->hdr_chunk;
2930 if (prev_chunk_id > 0) {
2931 result = yaffs_rd_chunk_tags_nand(dev, prev_chunk_id,
2934 yaffs_verify_oh(in, oh, &old_tags, 0);
2936 memcpy(old_name, oh->name, sizeof(oh->name));
2937 memset(buffer, 0xFF, sizeof(struct yaffs_obj_hdr));
2939 memset(buffer, 0xFF, dev->data_bytes_per_chunk);
2942 oh->type = in->variant_type;
2943 oh->yst_mode = in->yst_mode;
2944 oh->shadows_obj = oh->inband_shadowed_obj_id = shadows;
2946 yaffs_load_attribs_oh(oh, in);
2949 oh->parent_obj_id = in->parent->obj_id;
2951 oh->parent_obj_id = 0;
2953 if (name && *name) {
2954 memset(oh->name, 0, sizeof(oh->name));
2955 yaffs_load_oh_from_name(dev, oh->name, name);
2956 } else if (prev_chunk_id > 0) {
2957 memcpy(oh->name, old_name, sizeof(oh->name));
2959 memset(oh->name, 0, sizeof(oh->name));
2962 oh->is_shrink = is_shrink;
2964 switch (in->variant_type) {
2965 case YAFFS_OBJECT_TYPE_UNKNOWN:
2966 /* Should not happen */
2968 case YAFFS_OBJECT_TYPE_FILE:
2970 (oh->parent_obj_id == YAFFS_OBJECTID_DELETED
2971 || oh->parent_obj_id ==
2972 YAFFS_OBJECTID_UNLINKED) ? 0 : in->
2973 variant.file_variant.file_size;
2975 case YAFFS_OBJECT_TYPE_HARDLINK:
2976 oh->equiv_id = in->variant.hardlink_variant.equiv_id;
2978 case YAFFS_OBJECT_TYPE_SPECIAL:
2981 case YAFFS_OBJECT_TYPE_DIRECTORY:
2984 case YAFFS_OBJECT_TYPE_SYMLINK:
2985 alias = in->variant.symlink_variant.alias;
2987 alias = _Y("no alias");
2988 yaffs_strncpy(oh->alias, alias, YAFFS_MAX_ALIAS_LENGTH);
2989 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
2993 /* process any xattrib modifications */
2995 yaffs_apply_xattrib_mod(in, (char *)buffer, xmod);
2998 yaffs_init_tags(&new_tags);
3000 new_tags.chunk_id = 0;
3001 new_tags.obj_id = in->obj_id;
3002 new_tags.serial_number = in->serial;
3004 /* Add extra info for file header */
3006 new_tags.extra_available = 1;
3007 new_tags.extra_parent_id = oh->parent_obj_id;
3008 new_tags.extra_length = oh->file_size;
3009 new_tags.extra_is_shrink = oh->is_shrink;
3010 new_tags.extra_equiv_id = oh->equiv_id;
3011 new_tags.extra_shadows = (oh->shadows_obj > 0) ? 1 : 0;
3012 new_tags.extra_obj_type = in->variant_type;
3014 yaffs_verify_oh(in, oh, &new_tags, 1);
3016 /* Create new chunk in NAND */
3018 yaffs_write_new_chunk(dev, buffer, &new_tags,
3019 (prev_chunk_id > 0) ? 1 : 0);
3021 if (new_chunk_id >= 0) {
3023 in->hdr_chunk = new_chunk_id;
3025 if (prev_chunk_id > 0) {
3026 yaffs_chunk_del(dev, prev_chunk_id, 1,
3030 if (!yaffs_obj_cache_dirty(in))
3033 /* If this was a shrink, then mark the block that the chunk lives on */
3035 bi = yaffs_get_block_info(in->my_dev,
3039 bi->has_shrink_hdr = 1;
3044 ret_val = new_chunk_id;
3049 yaffs_release_temp_buffer(dev, buffer, __LINE__);
3054 /*------------------------ Short Operations Cache ----------------------------------------
3055 * In many situations where there is no high level buffering a lot of
3056 * reads might be short sequential reads, and a lot of writes may be short
3057 * sequential writes. eg. scanning/writing a jpeg file.
3058 * In these cases, a short read/write cache can provide a huge perfomance
3059 * benefit with dumb-as-a-rock code.
3060 * In Linux, the page cache provides read buffering and the short op cache
3061 * provides write buffering.
3063 * There are a limited number (~10) of cache chunks per device so that we don't
3064 * need a very intelligent search.
3067 static int yaffs_obj_cache_dirty(struct yaffs_obj *obj)
3069 struct yaffs_dev *dev = obj->my_dev;
3071 struct yaffs_cache *cache;
3072 int n_caches = obj->my_dev->param.n_caches;
3074 for (i = 0; i < n_caches; i++) {
3075 cache = &dev->cache[i];
3076 if (cache->object == obj && cache->dirty)
3083 static void yaffs_flush_file_cache(struct yaffs_obj *obj)
3085 struct yaffs_dev *dev = obj->my_dev;
3086 int lowest = -99; /* Stop compiler whining. */
3088 struct yaffs_cache *cache;
3089 int chunk_written = 0;
3090 int n_caches = obj->my_dev->param.n_caches;
3096 /* Find the dirty cache for this object with the lowest chunk id. */
3097 for (i = 0; i < n_caches; i++) {
3098 if (dev->cache[i].object == obj &&
3099 dev->cache[i].dirty) {
3101 || dev->cache[i].chunk_id <
3103 cache = &dev->cache[i];
3104 lowest = cache->chunk_id;
3109 if (cache && !cache->locked) {
3110 /* Write it out and free it up */
3113 yaffs_wr_data_obj(cache->object,
3118 cache->object = NULL;
3121 } while (cache && chunk_written > 0);
3124 /* Hoosterman, disk full while writing cache out. */
3125 T(YAFFS_TRACE_ERROR,
3127 ("yaffs tragedy: no space during cache write"
3135 /*yaffs_flush_whole_cache(dev)
3140 void yaffs_flush_whole_cache(struct yaffs_dev *dev)
3142 struct yaffs_obj *obj;
3143 int n_caches = dev->param.n_caches;
3146 /* Find a dirty object in the cache and flush it...
3147 * until there are no further dirty objects.
3151 for (i = 0; i < n_caches && !obj; i++) {
3152 if (dev->cache[i].object && dev->cache[i].dirty)
3153 obj = dev->cache[i].object;
3157 yaffs_flush_file_cache(obj);
3163 /* Grab us a cache chunk for use.
3164 * First look for an empty one.
3165 * Then look for the least recently used non-dirty one.
3166 * Then look for the least recently used dirty one...., flush and look again.
3168 static struct yaffs_cache *yaffs_grab_chunk_worker(struct yaffs_dev *dev)
3172 if (dev->param.n_caches > 0) {
3173 for (i = 0; i < dev->param.n_caches; i++) {
3174 if (!dev->cache[i].object)
3175 return &dev->cache[i];
3182 static struct yaffs_cache *yaffs_grab_chunk_cache(struct yaffs_dev *dev)
3184 struct yaffs_cache *cache;
3185 struct yaffs_obj *the_obj;
3190 if (dev->param.n_caches > 0) {
3191 /* Try find a non-dirty one... */
3193 cache = yaffs_grab_chunk_worker(dev);
3196 /* They were all dirty, find the last recently used object and flush
3197 * its cache, then find again.
3198 * NB what's here is not very accurate, we actually flush the object
3199 * the last recently used page.
3202 /* With locking we can't assume we can use entry zero */
3209 for (i = 0; i < dev->param.n_caches; i++) {
3210 if (dev->cache[i].object &&
3211 !dev->cache[i].locked &&
3212 (dev->cache[i].last_use < usage
3214 usage = dev->cache[i].last_use;
3215 the_obj = dev->cache[i].object;
3216 cache = &dev->cache[i];
3221 if (!cache || cache->dirty) {
3222 /* Flush and try again */
3223 yaffs_flush_file_cache(the_obj);
3224 cache = yaffs_grab_chunk_worker(dev);
3234 /* Find a cached chunk */
3235 static struct yaffs_cache *yaffs_find_chunk_cache(const struct yaffs_obj *obj,
3238 struct yaffs_dev *dev = obj->my_dev;
3240 if (dev->param.n_caches > 0) {
3241 for (i = 0; i < dev->param.n_caches; i++) {
3242 if (dev->cache[i].object == obj &&
3243 dev->cache[i].chunk_id == chunk_id) {
3246 return &dev->cache[i];
3253 /* Mark the chunk for the least recently used algorithym */
3254 static void yaffs_use_cache(struct yaffs_dev *dev, struct yaffs_cache *cache,
3258 if (dev->param.n_caches > 0) {
3259 if (dev->cache_last_use < 0 || dev->cache_last_use > 100000000) {
3260 /* Reset the cache usages */
3262 for (i = 1; i < dev->param.n_caches; i++)
3263 dev->cache[i].last_use = 0;
3265 dev->cache_last_use = 0;
3268 dev->cache_last_use++;
3270 cache->last_use = dev->cache_last_use;
3277 /* Invalidate a single cache page.
3278 * Do this when a whole page gets written,
3279 * ie the short cache for this page is no longer valid.
3281 static void yaffs_invalidate_chunk_cache(struct yaffs_obj *object, int chunk_id)
3283 if (object->my_dev->param.n_caches > 0) {
3284 struct yaffs_cache *cache =
3285 yaffs_find_chunk_cache(object, chunk_id);
3288 cache->object = NULL;
3292 /* Invalidate all the cache pages associated with this object
3293 * Do this whenever ther file is deleted or resized.
3295 static void yaffs_invalidate_whole_cache(struct yaffs_obj *in)
3298 struct yaffs_dev *dev = in->my_dev;
3300 if (dev->param.n_caches > 0) {
3301 /* Invalidate it. */
3302 for (i = 0; i < dev->param.n_caches; i++) {
3303 if (dev->cache[i].object == in)
3304 dev->cache[i].object = NULL;
3309 /*--------------------- File read/write ------------------------
3310 * Read and write have very similar structures.
3311 * In general the read/write has three parts to it
3312 * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3313 * Some complete chunks
3314 * An incomplete chunk to end off with
3316 * Curve-balls: the first chunk might also be the last chunk.
3319 int yaffs_file_rd(struct yaffs_obj *in, u8 * buffer, loff_t offset, int n_bytes)
3327 struct yaffs_cache *cache;
3329 struct yaffs_dev *dev;
3334 /* chunk = offset / dev->data_bytes_per_chunk + 1; */
3335 /* start = offset % dev->data_bytes_per_chunk; */
3336 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3339 /* OK now check for the curveball where the start and end are in
3342 if ((start + n) < dev->data_bytes_per_chunk)
3345 n_copy = dev->data_bytes_per_chunk - start;
3347 cache = yaffs_find_chunk_cache(in, chunk);
3349 /* If the chunk is already in the cache or it is less than a whole chunk
3350 * or we're using inband tags then use the cache (if there is caching)
3351 * else bypass the cache.
3353 if (cache || n_copy != dev->data_bytes_per_chunk
3354 || dev->param.inband_tags) {
3355 if (dev->param.n_caches > 0) {
3357 /* If we can't find the data in the cache, then load it up. */
3361 yaffs_grab_chunk_cache(in->my_dev);
3363 cache->chunk_id = chunk;
3366 yaffs_rd_data_obj(in, chunk,
3371 yaffs_use_cache(dev, cache, 0);
3375 memcpy(buffer, &cache->data[start], n_copy);
3379 /* Read into the local buffer then copy.. */
3382 yaffs_get_temp_buffer(dev, __LINE__);
3383 yaffs_rd_data_obj(in, chunk, local_buffer);
3385 memcpy(buffer, &local_buffer[start], n_copy);
3387 yaffs_release_temp_buffer(dev, local_buffer,
3393 /* A full chunk. Read directly into the supplied buffer. */
3394 yaffs_rd_data_obj(in, chunk, buffer);
3408 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 * buffer, loff_t offset,
3409 int n_bytes, int write_trhrough)
3418 int start_write = offset;
3419 int chunk_written = 0;
3423 struct yaffs_dev *dev;
3427 while (n > 0 && chunk_written >= 0) {
3428 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3430 if (chunk * dev->data_bytes_per_chunk + start != offset ||
3431 start >= dev->data_bytes_per_chunk) {
3432 T(YAFFS_TRACE_ERROR,
3434 ("AddrToChunk of offset %d gives chunk %d start %d"
3435 TENDSTR), (int)offset, chunk, start));
3437 chunk++; /* File pos to chunk in file offset */
3439 /* OK now check for the curveball where the start and end are in
3443 if ((start + n) < dev->data_bytes_per_chunk) {
3446 /* Now folks, to calculate how many bytes to write back....
3447 * If we're overwriting and not writing to then end of file then
3448 * we need to write back as much as was there before.
3451 chunk_start = ((chunk - 1) * dev->data_bytes_per_chunk);
3453 if (chunk_start > in->variant.file_variant.file_size)
3454 n_bytes_read = 0; /* Past end of file */
3457 in->variant.file_variant.file_size -
3460 if (n_bytes_read > dev->data_bytes_per_chunk)
3461 n_bytes_read = dev->data_bytes_per_chunk;
3465 (start + n)) ? n_bytes_read : (start + n);
3468 || n_writeback > dev->data_bytes_per_chunk)
3472 n_copy = dev->data_bytes_per_chunk - start;
3473 n_writeback = dev->data_bytes_per_chunk;
3476 if (n_copy != dev->data_bytes_per_chunk
3477 || dev->param.inband_tags) {
3478 /* An incomplete start or end chunk (or maybe both start and end chunk),
3479 * or we're using inband tags, so we want to use the cache buffers.
3481 if (dev->param.n_caches > 0) {
3482 struct yaffs_cache *cache;
3483 /* If we can't find the data in the cache, then load the cache */
3484 cache = yaffs_find_chunk_cache(in, chunk);
3487 && yaffs_check_alloc_available(dev, 1)) {
3488 cache = yaffs_grab_chunk_cache(dev);
3490 cache->chunk_id = chunk;
3493 yaffs_rd_data_obj(in, chunk,
3497 !yaffs_check_alloc_available(dev,
3499 /* Drop the cache if it was a read cache item and
3500 * no space check has been made for it.
3506 yaffs_use_cache(dev, cache, 1);
3509 memcpy(&cache->data[start], buffer,
3513 cache->n_bytes = n_writeback;
3515 if (write_trhrough) {
3526 chunk_written = -1; /* fail the write */
3529 /* An incomplete start or end chunk (or maybe both start and end chunk)
3530 * Read into the local buffer then copy, then copy over and write back.
3534 yaffs_get_temp_buffer(dev, __LINE__);
3536 yaffs_rd_data_obj(in, chunk, local_buffer);
3538 memcpy(&local_buffer[start], buffer, n_copy);
3541 yaffs_wr_data_obj(in, chunk,
3545 yaffs_release_temp_buffer(dev, local_buffer,
3551 /* A full chunk. Write directly from the supplied buffer. */
3554 yaffs_wr_data_obj(in, chunk, buffer,
3555 dev->data_bytes_per_chunk, 0);
3557 /* Since we've overwritten the cached data, we better invalidate it. */
3558 yaffs_invalidate_chunk_cache(in, chunk);
3561 if (chunk_written >= 0) {
3570 /* Update file object */
3572 if ((start_write + n_done) > in->variant.file_variant.file_size)
3573 in->variant.file_variant.file_size = (start_write + n_done);
3580 int yaffs_wr_file(struct yaffs_obj *in, const u8 * buffer, loff_t offset,
3581 int n_bytes, int write_trhrough)
3583 yaffs2_handle_hole(in, offset);
3584 return yaffs_do_file_wr(in, buffer, offset, n_bytes, write_trhrough);
3587 /* ---------------------- File resizing stuff ------------------ */
3589 static void yaffs_prune_chunks(struct yaffs_obj *in, int new_size)
3592 struct yaffs_dev *dev = in->my_dev;
3593 int old_size = in->variant.file_variant.file_size;
3595 int last_del = 1 + (old_size - 1) / dev->data_bytes_per_chunk;
3597 int start_del = 1 + (new_size + dev->data_bytes_per_chunk - 1) /
3598 dev->data_bytes_per_chunk;
3602 /* Delete backwards so that we don't end up with holes if
3603 * power is lost part-way through the operation.
3605 for (i = last_del; i >= start_del; i--) {
3606 /* NB this could be optimised somewhat,
3607 * eg. could retrieve the tags and write them without
3608 * using yaffs_chunk_del
3611 chunk_id = yaffs_find_del_file_chunk(in, i, NULL);
3614 (dev->internal_start_block *
3615 dev->param.chunks_per_block)
3617 ((dev->internal_end_block +
3618 1) * dev->param.chunks_per_block)) {
3619 T(YAFFS_TRACE_ALWAYS,
3621 ("Found daft chunk_id %d for %d" TENDSTR),
3624 in->n_data_chunks--;
3625 yaffs_chunk_del(dev, chunk_id, 1, __LINE__);
3632 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size)
3636 struct yaffs_dev *dev = obj->my_dev;
3638 yaffs_addr_to_chunk(dev, new_size, &new_full, &new_partial);
3640 yaffs_prune_chunks(obj, new_size);
3642 if (new_partial != 0) {
3643 int last_chunk = 1 + new_full;
3644 u8 *local_buffer = yaffs_get_temp_buffer(dev, __LINE__);
3646 /* Got to read and rewrite the last chunk with its new size and zero pad */
3647 yaffs_rd_data_obj(obj, last_chunk, local_buffer);
3648 memset(local_buffer + new_partial, 0,
3649 dev->data_bytes_per_chunk - new_partial);
3651 yaffs_wr_data_obj(obj, last_chunk, local_buffer,
3654 yaffs_release_temp_buffer(dev, local_buffer, __LINE__);
3657 obj->variant.file_variant.file_size = new_size;
3659 yaffs_prune_tree(dev, &obj->variant.file_variant);
3662 int yaffs_resize_file(struct yaffs_obj *in, loff_t new_size)
3664 struct yaffs_dev *dev = in->my_dev;
3665 int old_size = in->variant.file_variant.file_size;
3667 yaffs_flush_file_cache(in);
3668 yaffs_invalidate_whole_cache(in);
3670 yaffs_check_gc(dev, 0);
3672 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE)
3675 if (new_size == old_size)
3678 if (new_size > old_size) {
3679 yaffs2_handle_hole(in, new_size);
3680 in->variant.file_variant.file_size = new_size;
3682 /* new_size < old_size */
3683 yaffs_resize_file_down(in, new_size);
3686 /* Write a new object header to reflect the resize.
3687 * show we've shrunk the file, if need be
3688 * Do this only if the file is not in the deleted directories
3689 * and is not shadowed.
3693 in->parent->obj_id != YAFFS_OBJECTID_UNLINKED &&
3694 in->parent->obj_id != YAFFS_OBJECTID_DELETED)
3695 yaffs_update_oh(in, NULL, 0, 0, 0, NULL);
3700 int yaffs_flush_file(struct yaffs_obj *in, int update_time, int data_sync)
3704 yaffs_flush_file_cache(in);
3705 if (data_sync) /* Only sync data */
3709 yaffs_load_current_time(in, 0, 0);
3711 ret_val = (yaffs_update_oh(in, NULL, 0, 0, 0, NULL) >=
3712 0) ? YAFFS_OK : YAFFS_FAIL;
3722 static int yaffs_generic_obj_del(struct yaffs_obj *in)
3725 /* First off, invalidate the file's data in the cache, without flushing. */
3726 yaffs_invalidate_whole_cache(in);
3728 if (in->my_dev->param.is_yaffs2 && (in->parent != in->my_dev->del_dir)) {
3729 /* Move to the unlinked directory so we have a record that it was deleted. */
3730 yaffs_change_obj_name(in, in->my_dev->del_dir, _Y("deleted"), 0,
3735 yaffs_remove_obj_from_dir(in);
3736 yaffs_chunk_del(in->my_dev, in->hdr_chunk, 1, __LINE__);
3744 /* yaffs_del_file deletes the whole file data
3745 * and the inode associated with the file.
3746 * It does not delete the links associated with the file.
3748 static int yaffs_unlink_file_if_needed(struct yaffs_obj *in)
3753 struct yaffs_dev *dev = in->my_dev;
3760 yaffs_change_obj_name(in, in->my_dev->del_dir,
3761 _Y("deleted"), 0, 0);
3762 T(YAFFS_TRACE_TRACING,
3763 (TSTR("yaffs: immediate deletion of file %d" TENDSTR),
3766 in->my_dev->n_deleted_files++;
3767 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3768 yaffs_resize_file(in, 0);
3769 yaffs_soft_del_file(in);
3772 yaffs_change_obj_name(in, in->my_dev->unlinked_dir,
3773 _Y("unlinked"), 0, 0);
3779 int yaffs_del_file(struct yaffs_obj *in)
3781 int ret_val = YAFFS_OK;
3782 int deleted; /* Need to cache value on stack if in is freed */
3783 struct yaffs_dev *dev = in->my_dev;
3785 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3786 yaffs_resize_file(in, 0);
3788 if (in->n_data_chunks > 0) {
3789 /* Use soft deletion if there is data in the file.
3790 * That won't be the case if it has been resized to zero.
3793 ret_val = yaffs_unlink_file_if_needed(in);
3795 deleted = in->deleted;
3797 if (ret_val == YAFFS_OK && in->unlinked && !in->deleted) {
3800 in->my_dev->n_deleted_files++;
3801 yaffs_soft_del_file(in);
3803 return deleted ? YAFFS_OK : YAFFS_FAIL;
3805 /* The file has no data chunks so we toss it immediately */
3806 yaffs_free_tnode(in->my_dev, in->variant.file_variant.top);
3807 in->variant.file_variant.top = NULL;
3808 yaffs_generic_obj_del(in);
3814 static int yaffs_is_non_empty_dir(struct yaffs_obj *obj)
3816 return (obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) &&
3817 !(list_empty(&obj->variant.dir_variant.children));
3820 static int yaffs_del_dir(struct yaffs_obj *obj)
3822 /* First check that the directory is empty. */
3823 if (yaffs_is_non_empty_dir(obj))
3826 return yaffs_generic_obj_del(obj);
3829 static int yaffs_del_symlink(struct yaffs_obj *in)
3831 if (in->variant.symlink_variant.alias)
3832 YFREE(in->variant.symlink_variant.alias);
3833 in->variant.symlink_variant.alias = NULL;
3835 return yaffs_generic_obj_del(in);
3838 static int yaffs_del_link(struct yaffs_obj *in)
3840 /* remove this hardlink from the list assocaited with the equivalent
3843 list_del_init(&in->hard_links);
3844 return yaffs_generic_obj_del(in);
3847 int yaffs_del_obj(struct yaffs_obj *obj)
3850 switch (obj->variant_type) {
3851 case YAFFS_OBJECT_TYPE_FILE:
3852 ret_val = yaffs_del_file(obj);
3854 case YAFFS_OBJECT_TYPE_DIRECTORY:
3855 if (!list_empty(&obj->variant.dir_variant.dirty)) {
3856 T(YAFFS_TRACE_BACKGROUND,
3858 ("Remove object %d from dirty directories" TENDSTR),
3860 list_del_init(&obj->variant.dir_variant.dirty);
3862 return yaffs_del_dir(obj);
3864 case YAFFS_OBJECT_TYPE_SYMLINK:
3865 ret_val = yaffs_del_symlink(obj);
3867 case YAFFS_OBJECT_TYPE_HARDLINK:
3868 ret_val = yaffs_del_link(obj);
3870 case YAFFS_OBJECT_TYPE_SPECIAL:
3871 ret_val = yaffs_generic_obj_del(obj);
3873 case YAFFS_OBJECT_TYPE_UNKNOWN:
3875 break; /* should not happen. */
3881 static int yaffs_unlink_worker(struct yaffs_obj *obj)
3890 yaffs_update_parent(obj->parent);
3892 if (obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
3893 return yaffs_del_link(obj);
3894 } else if (!list_empty(&obj->hard_links)) {
3895 /* Curve ball: We're unlinking an object that has a hardlink.
3897 * This problem arises because we are not strictly following
3898 * The Linux link/inode model.
3900 * We can't really delete the object.
3901 * Instead, we do the following:
3902 * - Select a hardlink.
3903 * - Unhook it from the hard links
3904 * - Move it from its parent directory (so that the rename can work)
3905 * - Rename the object to the hardlink's name.
3906 * - Delete the hardlink
3909 struct yaffs_obj *hl;
3910 struct yaffs_obj *parent;
3912 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
3914 hl = list_entry(obj->hard_links.next, struct yaffs_obj,
3917 yaffs_get_obj_name(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
3918 parent = hl->parent;
3920 list_del_init(&hl->hard_links);
3922 yaffs_add_obj_to_dir(obj->my_dev->unlinked_dir, hl);
3924 ret_val = yaffs_change_obj_name(obj, parent, name, 0, 0);
3926 if (ret_val == YAFFS_OK)
3927 ret_val = yaffs_generic_obj_del(hl);
3931 } else if (del_now) {
3932 switch (obj->variant_type) {
3933 case YAFFS_OBJECT_TYPE_FILE:
3934 return yaffs_del_file(obj);
3936 case YAFFS_OBJECT_TYPE_DIRECTORY:
3937 list_del_init(&obj->variant.dir_variant.dirty);
3938 return yaffs_del_dir(obj);
3940 case YAFFS_OBJECT_TYPE_SYMLINK:
3941 return yaffs_del_symlink(obj);
3943 case YAFFS_OBJECT_TYPE_SPECIAL:
3944 return yaffs_generic_obj_del(obj);
3946 case YAFFS_OBJECT_TYPE_HARDLINK:
3947 case YAFFS_OBJECT_TYPE_UNKNOWN:
3951 } else if (yaffs_is_non_empty_dir(obj)) {
3954 return yaffs_change_obj_name(obj, obj->my_dev->unlinked_dir,
3955 _Y("unlinked"), 0, 0);
3959 static int yaffs_unlink_obj(struct yaffs_obj *obj)
3962 if (obj && obj->unlink_allowed)
3963 return yaffs_unlink_worker(obj);
3969 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name)
3971 struct yaffs_obj *obj;
3973 obj = yaffs_find_by_name(dir, name);
3974 return yaffs_unlink_obj(obj);
3977 /*----------------------- Initialisation Scanning ---------------------- */
3979 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
3980 int backward_scanning)
3982 struct yaffs_obj *obj;
3984 if (!backward_scanning) {
3985 /* Handle YAFFS1 forward scanning case
3986 * For YAFFS1 we always do the deletion
3990 /* Handle YAFFS2 case (backward scanning)
3991 * If the shadowed object exists then ignore.
3993 obj = yaffs_find_by_number(dev, obj_id);
3998 /* Let's create it (if it does not exist) assuming it is a file so that it can do shrinking etc.
3999 * We put it in unlinked dir to be cleaned up after the scanning
4002 yaffs_find_or_create_by_number(dev, obj_id, YAFFS_OBJECT_TYPE_FILE);
4005 obj->is_shadowed = 1;
4006 yaffs_add_obj_to_dir(dev->unlinked_dir, obj);
4007 obj->variant.file_variant.shrink_size = 0;
4008 obj->valid = 1; /* So that we don't read any other info for this file */
4012 void yaffs_link_fixup(struct yaffs_dev *dev, struct yaffs_obj *hard_list)
4014 struct yaffs_obj *hl;
4015 struct yaffs_obj *in;
4019 hard_list = (struct yaffs_obj *)(hard_list->hard_links.next);
4021 in = yaffs_find_by_number(dev,
4023 hardlink_variant.equiv_id);
4026 /* Add the hardlink pointers */
4027 hl->variant.hardlink_variant.equiv_obj = in;
4028 list_add(&hl->hard_links, &in->hard_links);
4030 /* Todo Need to report/handle this better.
4031 * Got a problem... hardlink to a non-existant object
4033 hl->variant.hardlink_variant.equiv_obj = NULL;
4034 INIT_LIST_HEAD(&hl->hard_links);
4040 static void yaffs_strip_deleted_objs(struct yaffs_dev *dev)
4043 * Sort out state of unlinked and deleted objects after scanning.
4045 struct list_head *i;
4046 struct list_head *n;
4047 struct yaffs_obj *l;
4052 /* Soft delete all the unlinked files */
4053 list_for_each_safe(i, n,
4054 &dev->unlinked_dir->variant.dir_variant.children) {
4056 l = list_entry(i, struct yaffs_obj, siblings);
4061 list_for_each_safe(i, n, &dev->del_dir->variant.dir_variant.children) {
4063 l = list_entry(i, struct yaffs_obj, siblings);
4071 * This code iterates through all the objects making sure that they are rooted.
4072 * Any unrooted objects are re-rooted in lost+found.
4073 * An object needs to be in one of:
4074 * - Directly under deleted, unlinked
4075 * - Directly or indirectly under root.
4078 * This code assumes that we don't ever change the current relationships between
4080 * root_dir->parent == unlinked_dir->parent == del_dir->parent == NULL
4081 * lost-n-found->parent == root_dir
4083 * This fixes the problem where directories might have inadvertently been deleted
4084 * leaving the object "hanging" without being rooted in the directory tree.
4087 static int yaffs_has_null_parent(struct yaffs_dev *dev, struct yaffs_obj *obj)
4089 return (obj == dev->del_dir ||
4090 obj == dev->unlinked_dir || obj == dev->root_dir);
4093 static void yaffs_fix_hanging_objs(struct yaffs_dev *dev)
4095 struct yaffs_obj *obj;
4096 struct yaffs_obj *parent;
4098 struct list_head *lh;
4099 struct list_head *n;
4106 /* Iterate through the objects in each hash entry,
4107 * looking at each object.
4108 * Make sure it is rooted.
4111 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
4112 list_for_each_safe(lh, n, &dev->obj_bucket[i].list) {
4115 list_entry(lh, struct yaffs_obj, hash_link);
4116 parent = obj->parent;
4118 if (yaffs_has_null_parent(dev, obj)) {
4119 /* These directories are not hanging */
4122 || parent->variant_type !=
4123 YAFFS_OBJECT_TYPE_DIRECTORY) {
4125 } else if (yaffs_has_null_parent(dev, parent)) {
4129 * Need to follow the parent chain to see if it is hanging.
4134 while (parent != dev->root_dir &&
4136 parent->parent->variant_type ==
4137 YAFFS_OBJECT_TYPE_DIRECTORY
4138 && depth_limit > 0) {
4139 parent = parent->parent;
4142 if (parent != dev->root_dir)
4148 ("Hanging object %d moved to lost and found"
4149 TENDSTR), obj->obj_id));
4150 yaffs_add_obj_to_dir(dev->lost_n_found,
4159 * Delete directory contents for cleaning up lost and found.
4161 static void yaffs_del_dir_contents(struct yaffs_obj *dir)
4163 struct yaffs_obj *obj;
4164 struct list_head *lh;
4165 struct list_head *n;
4167 if (dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
4170 list_for_each_safe(lh, n, &dir->variant.dir_variant.children) {
4172 obj = list_entry(lh, struct yaffs_obj, siblings);
4173 if (obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY)
4174 yaffs_del_dir_contents(obj);
4177 (TSTR("Deleting lost_found object %d" TENDSTR),
4180 /* Need to use UnlinkObject since Delete would not handle
4181 * hardlinked objects correctly.
4183 yaffs_unlink_obj(obj);
4189 static void yaffs_empty_l_n_f(struct yaffs_dev *dev)
4191 yaffs_del_dir_contents(dev->lost_n_found);
4194 static void yaffs_check_obj_details_loaded(struct yaffs_obj *in)
4197 struct yaffs_obj_hdr *oh;
4198 struct yaffs_dev *dev;
4199 struct yaffs_ext_tags tags;
4201 int alloc_failed = 0;
4208 if (in->lazy_loaded && in->hdr_chunk > 0) {
4209 in->lazy_loaded = 0;
4210 chunk_data = yaffs_get_temp_buffer(dev, __LINE__);
4213 yaffs_rd_chunk_tags_nand(dev, in->hdr_chunk, chunk_data,
4215 oh = (struct yaffs_obj_hdr *)chunk_data;
4217 in->yst_mode = oh->yst_mode;
4218 yaffs_load_attribs(in, oh);
4219 yaffs_set_obj_name_from_oh(in, oh);
4221 if (in->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
4222 in->variant.symlink_variant.alias =
4223 yaffs_clone_str(oh->alias);
4224 if (!in->variant.symlink_variant.alias)
4225 alloc_failed = 1; /* Not returned to caller */
4228 yaffs_release_temp_buffer(dev, chunk_data, __LINE__);
4232 /*------------------------------ Directory Functions ----------------------------- */
4235 *yaffs_update_parent() handles fixing a directories mtime and ctime when a new
4236 * link (ie. name) is created or deleted in the directory.
4239 * create dir/a : update dir's mtime/ctime
4240 * rm dir/a: update dir's mtime/ctime
4241 * modify dir/a: don't update dir's mtimme/ctime
4243 * This can be handled immediately or defered. Defering helps reduce the number
4244 * of updates when many files in a directory are changed within a brief period.
4246 * If the directory updating is defered then yaffs_update_dirty_dirs must be
4247 * called periodically.
4250 static void yaffs_update_parent(struct yaffs_obj *obj)
4252 struct yaffs_dev *dev;
4257 yaffs_load_current_time(obj, 0, 1);
4258 if (dev->param.defered_dir_update) {
4259 struct list_head *link = &obj->variant.dir_variant.dirty;
4261 if (list_empty(link)) {
4262 list_add(link, &dev->dirty_dirs);
4263 T(YAFFS_TRACE_BACKGROUND,
4264 (TSTR("Added object %d to dirty directories" TENDSTR),
4269 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
4273 void yaffs_update_dirty_dirs(struct yaffs_dev *dev)
4275 struct list_head *link;
4276 struct yaffs_obj *obj;
4277 struct yaffs_dir_var *d_s;
4278 union yaffs_obj_var *o_v;
4280 T(YAFFS_TRACE_BACKGROUND, (TSTR("Update dirty directories" TENDSTR)));
4282 while (!list_empty(&dev->dirty_dirs)) {
4283 link = dev->dirty_dirs.next;
4284 list_del_init(link);
4286 d_s = list_entry(link, struct yaffs_dir_var, dirty);
4287 o_v = list_entry(d_s, union yaffs_obj_var, dir_variant);
4288 obj = list_entry(o_v, struct yaffs_obj, variant);
4290 T(YAFFS_TRACE_BACKGROUND,
4291 (TSTR("Update directory %d" TENDSTR), obj->obj_id));
4294 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
4298 static void yaffs_remove_obj_from_dir(struct yaffs_obj *obj)
4300 struct yaffs_dev *dev = obj->my_dev;
4301 struct yaffs_obj *parent;
4303 yaffs_verify_obj_in_dir(obj);
4304 parent = obj->parent;
4306 yaffs_verify_dir(parent);
4308 if (dev && dev->param.remove_obj_fn)
4309 dev->param.remove_obj_fn(obj);
4311 list_del_init(&obj->siblings);
4314 yaffs_verify_dir(parent);
4317 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj)
4320 T(YAFFS_TRACE_ALWAYS,
4322 ("tragedy: Trying to add an object to a null pointer directory"
4327 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4328 T(YAFFS_TRACE_ALWAYS,
4330 ("tragedy: Trying to add an object to a non-directory"
4335 if (obj->siblings.prev == NULL) {
4336 /* Not initialised */
4340 yaffs_verify_dir(directory);
4342 yaffs_remove_obj_from_dir(obj);
4345 list_add(&obj->siblings, &directory->variant.dir_variant.children);
4346 obj->parent = directory;
4348 if (directory == obj->my_dev->unlinked_dir
4349 || directory == obj->my_dev->del_dir) {
4351 obj->my_dev->n_unlinked_files++;
4352 obj->rename_allowed = 0;
4355 yaffs_verify_dir(directory);
4356 yaffs_verify_obj_in_dir(obj);
4359 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *directory,
4364 struct list_head *i;
4365 YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
4367 struct yaffs_obj *l;
4373 T(YAFFS_TRACE_ALWAYS,
4375 ("tragedy: yaffs_find_by_name: null pointer directory"
4380 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4381 T(YAFFS_TRACE_ALWAYS,
4382 (TSTR("tragedy: yaffs_find_by_name: non-directory" TENDSTR)));
4386 sum = yaffs_calc_name_sum(name);
4388 list_for_each(i, &directory->variant.dir_variant.children) {
4390 l = list_entry(i, struct yaffs_obj, siblings);
4392 if (l->parent != directory)
4395 yaffs_check_obj_details_loaded(l);
4397 /* Special case for lost-n-found */
4398 if (l->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4399 if (!yaffs_strcmp(name, YAFFS_LOSTNFOUND_NAME))
4401 } else if (yaffs_sum_cmp(l->sum, sum)
4402 || l->hdr_chunk <= 0) {
4403 /* LostnFound chunk called Objxxx
4406 yaffs_get_obj_name(l, buffer,
4407 YAFFS_MAX_NAME_LENGTH + 1);
4409 (name, buffer, YAFFS_MAX_NAME_LENGTH) == 0)
4418 /* GetEquivalentObject dereferences any hard links to get to the
4422 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj)
4424 if (obj && obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
4425 /* We want the object id of the equivalent object, not this one */
4426 obj = obj->variant.hardlink_variant.equiv_obj;
4427 yaffs_check_obj_details_loaded(obj);
4433 * A note or two on object names.
4434 * * If the object name is missing, we then make one up in the form objnnn
4436 * * ASCII names are stored in the object header's name field from byte zero
4437 * * Unicode names are historically stored starting from byte zero.
4439 * Then there are automatic Unicode names...
4440 * The purpose of these is to save names in a way that can be read as
4441 * ASCII or Unicode names as appropriate, thus allowing a Unicode and ASCII
4442 * system to share files.
4444 * These automatic unicode are stored slightly differently...
4445 * - If the name can fit in the ASCII character space then they are saved as
4446 * ascii names as per above.
4447 * - If the name needs Unicode then the name is saved in Unicode
4448 * starting at oh->name[1].
4451 static void yaffs_fix_null_name(struct yaffs_obj *obj, YCHAR * name,
4454 /* Create an object name if we could not find one. */
4455 if (yaffs_strnlen(name, YAFFS_MAX_NAME_LENGTH) == 0) {
4456 YCHAR local_name[20];
4457 YCHAR num_string[20];
4458 YCHAR *x = &num_string[19];
4459 unsigned v = obj->obj_id;
4463 *x = '0' + (v % 10);
4466 /* make up a name */
4467 yaffs_strcpy(local_name, YAFFS_LOSTNFOUND_PREFIX);
4468 yaffs_strcat(local_name, x);
4469 yaffs_strncpy(name, local_name, buffer_size - 1);
4473 static void yaffs_load_name_from_oh(struct yaffs_dev *dev, YCHAR * name,
4474 const YCHAR * oh_name, int buff_size)
4476 #ifdef CONFIG_YAFFS_AUTO_UNICODE
4477 if (dev->param.auto_unicode) {
4479 /* It is an ASCII name, so do an ASCII to unicode conversion */
4480 const char *ascii_oh_name = (const char *)oh_name;
4481 int n = buff_size - 1;
4482 while (n > 0 && *ascii_oh_name) {
4483 *name = *ascii_oh_name;
4489 yaffs_strncpy(name, oh_name + 1, buff_size - 1);
4495 yaffs_strncpy(name, oh_name, buff_size - 1);
4499 static void yaffs_load_oh_from_name(struct yaffs_dev *dev, YCHAR * oh_name,
4502 #ifdef CONFIG_YAFFS_AUTO_UNICODE
4507 if (dev->param.auto_unicode) {
4512 /* Figure out if the name will fit in ascii character set */
4513 while (is_ascii && *w) {
4520 /* It is an ASCII name, so do a unicode to ascii conversion */
4521 char *ascii_oh_name = (char *)oh_name;
4522 int n = YAFFS_MAX_NAME_LENGTH - 1;
4523 while (n > 0 && *name) {
4524 *ascii_oh_name = *name;
4530 /* It is a unicode name, so save starting at the second YCHAR */
4532 yaffs_strncpy(oh_name + 1, name,
4533 YAFFS_MAX_NAME_LENGTH - 2);
4539 yaffs_strncpy(oh_name, name, YAFFS_MAX_NAME_LENGTH - 1);
4544 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size)
4546 memset(name, 0, buffer_size * sizeof(YCHAR));
4548 yaffs_check_obj_details_loaded(obj);
4550 if (obj->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4551 yaffs_strncpy(name, YAFFS_LOSTNFOUND_NAME, buffer_size - 1);
4553 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
4554 else if (obj->short_name[0]) {
4555 yaffs_strcpy(name, obj->short_name);
4558 else if (obj->hdr_chunk > 0) {
4560 u8 *buffer = yaffs_get_temp_buffer(obj->my_dev, __LINE__);
4562 struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)buffer;
4564 memset(buffer, 0, obj->my_dev->data_bytes_per_chunk);
4566 if (obj->hdr_chunk > 0) {
4567 result = yaffs_rd_chunk_tags_nand(obj->my_dev,
4571 yaffs_load_name_from_oh(obj->my_dev, name, oh->name,
4574 yaffs_release_temp_buffer(obj->my_dev, buffer, __LINE__);
4577 yaffs_fix_null_name(obj, name, buffer_size);
4579 return yaffs_strnlen(name, YAFFS_MAX_NAME_LENGTH);
4582 int yaffs_get_obj_length(struct yaffs_obj *obj)
4584 /* Dereference any hard linking */
4585 obj = yaffs_get_equivalent_obj(obj);
4587 if (obj->variant_type == YAFFS_OBJECT_TYPE_FILE)
4588 return obj->variant.file_variant.file_size;
4589 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
4590 if (!obj->variant.symlink_variant.alias)
4592 return yaffs_strnlen(obj->variant.symlink_variant.alias,
4593 YAFFS_MAX_ALIAS_LENGTH);
4595 /* Only a directory should drop through to here */
4596 return obj->my_dev->data_bytes_per_chunk;
4600 int yaffs_get_obj_link_count(struct yaffs_obj *obj)
4603 struct list_head *i;
4606 count++; /* the object itself */
4608 list_for_each(i, &obj->hard_links)
4609 count++; /* add the hard links; */
4614 int yaffs_get_obj_inode(struct yaffs_obj *obj)
4616 obj = yaffs_get_equivalent_obj(obj);
4621 unsigned yaffs_get_obj_type(struct yaffs_obj *obj)
4623 obj = yaffs_get_equivalent_obj(obj);
4625 switch (obj->variant_type) {
4626 case YAFFS_OBJECT_TYPE_FILE:
4629 case YAFFS_OBJECT_TYPE_DIRECTORY:
4632 case YAFFS_OBJECT_TYPE_SYMLINK:
4635 case YAFFS_OBJECT_TYPE_HARDLINK:
4638 case YAFFS_OBJECT_TYPE_SPECIAL:
4639 if (S_ISFIFO(obj->yst_mode))
4641 if (S_ISCHR(obj->yst_mode))
4643 if (S_ISBLK(obj->yst_mode))
4645 if (S_ISSOCK(obj->yst_mode))
4653 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj)
4655 obj = yaffs_get_equivalent_obj(obj);
4656 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK)
4657 return yaffs_clone_str(obj->variant.symlink_variant.alias);
4659 return yaffs_clone_str(_Y(""));
4662 static int yaffs_do_xattrib_mod(struct yaffs_obj *obj, int set,
4663 const YCHAR * name, const void *value, int size,
4666 struct yaffs_xattr_mod xmod;
4675 xmod.result = -ENOSPC;
4677 result = yaffs_update_oh(obj, NULL, 0, 0, 0, &xmod);
4685 static int yaffs_apply_xattrib_mod(struct yaffs_obj *obj, char *buffer,
4686 struct yaffs_xattr_mod *xmod)
4689 int x_offs = sizeof(struct yaffs_obj_hdr);
4690 struct yaffs_dev *dev = obj->my_dev;
4691 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
4693 char *x_buffer = buffer + x_offs;
4697 nval_set(x_buffer, x_size, xmod->name, xmod->data,
4698 xmod->size, xmod->flags);
4700 retval = nval_del(x_buffer, x_size, xmod->name);
4702 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
4703 obj->xattr_known = 1;
4705 xmod->result = retval;
4710 static int yaffs_do_xattrib_fetch(struct yaffs_obj *obj, const YCHAR * name,
4711 void *value, int size)
4713 char *buffer = NULL;
4715 struct yaffs_ext_tags tags;
4716 struct yaffs_dev *dev = obj->my_dev;
4717 int x_offs = sizeof(struct yaffs_obj_hdr);
4718 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
4724 if (obj->hdr_chunk < 1)
4727 /* If we know that the object has no xattribs then don't do all the
4728 * reading and parsing.
4730 if (obj->xattr_known && !obj->has_xattr) {
4737 buffer = (char *)yaffs_get_temp_buffer(dev, __LINE__);
4742 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, (u8 *) buffer, &tags);
4744 if (result != YAFFS_OK)
4747 x_buffer = buffer + x_offs;
4749 if (!obj->xattr_known) {
4750 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
4751 obj->xattr_known = 1;
4755 retval = nval_get(x_buffer, x_size, name, value, size);
4757 retval = nval_list(x_buffer, x_size, value, size);
4759 yaffs_release_temp_buffer(dev, (u8 *) buffer, __LINE__);
4763 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR * name,
4764 const void *value, int size, int flags)
4766 return yaffs_do_xattrib_mod(obj, 1, name, value, size, flags);
4769 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR * name)
4771 return yaffs_do_xattrib_mod(obj, 0, name, NULL, 0, 0);
4774 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR * name, void *value,
4777 return yaffs_do_xattrib_fetch(obj, name, value, size);
4780 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size)
4782 return yaffs_do_xattrib_fetch(obj, NULL, buffer, size);
4785 /*---------------------------- Initialisation code -------------------------------------- */
4787 static int yaffs_check_dev_fns(const struct yaffs_dev *dev)
4790 /* Common functions, gotta have */
4791 if (!dev->param.erase_fn || !dev->param.initialise_flash_fn)
4794 #ifdef CONFIG_YAFFS_YAFFS2
4796 /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
4797 if (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)
4805 /* Can use the "spare" style interface for yaffs1 */
4806 if (!dev->param.is_yaffs2 &&
4807 !dev->param.write_chunk_tags_fn &&
4808 !dev->param.read_chunk_tags_fn &&
4809 dev->param.write_chunk_fn &&
4810 dev->param.read_chunk_fn &&
4811 !dev->param.bad_block_fn && !dev->param.query_block_fn)
4817 static int yaffs_create_initial_dir(struct yaffs_dev *dev)
4819 /* Initialise the unlinked, deleted, root and lost and found directories */
4821 dev->lost_n_found = dev->root_dir = NULL;
4822 dev->unlinked_dir = dev->del_dir = NULL;
4825 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
4828 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
4831 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_ROOT,
4832 YAFFS_ROOT_MODE | S_IFDIR);
4834 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_LOSTNFOUND,
4835 YAFFS_LOSTNFOUND_MODE | S_IFDIR);
4837 if (dev->lost_n_found && dev->root_dir && dev->unlinked_dir
4839 yaffs_add_obj_to_dir(dev->root_dir, dev->lost_n_found);
4846 int yaffs_guts_initialise(struct yaffs_dev *dev)
4848 int init_failed = 0;
4852 T(YAFFS_TRACE_TRACING,
4853 (TSTR("yaffs: yaffs_guts_initialise()" TENDSTR)));
4855 /* Check stuff that must be set */
4858 T(YAFFS_TRACE_ALWAYS, (TSTR("yaffs: Need a device" TENDSTR)));
4862 dev->internal_start_block = dev->param.start_block;
4863 dev->internal_end_block = dev->param.end_block;
4864 dev->block_offset = 0;
4865 dev->chunk_offset = 0;
4866 dev->n_free_chunks = 0;
4870 if (dev->param.start_block == 0) {
4871 dev->internal_start_block = dev->param.start_block + 1;
4872 dev->internal_end_block = dev->param.end_block + 1;
4873 dev->block_offset = 1;
4874 dev->chunk_offset = dev->param.chunks_per_block;
4877 /* Check geometry parameters. */
4879 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 */
4880 T(YAFFS_TRACE_ALWAYS,
4882 ("yaffs: NAND geometry problems: chunk size %d, type is yaffs%s, inband_tags %d "
4883 TENDSTR), dev->param.total_bytes_per_chunk,
4884 dev->param.is_yaffs2 ? "2" : "", dev->param.inband_tags));
4888 if (yaffs_init_nand(dev) != YAFFS_OK) {
4889 T(YAFFS_TRACE_ALWAYS,
4890 (TSTR("yaffs: InitialiseNAND failed" TENDSTR)));
4894 /* Sort out space for inband tags, if required */
4895 if (dev->param.inband_tags)
4896 dev->data_bytes_per_chunk =
4897 dev->param.total_bytes_per_chunk -
4898 sizeof(struct yaffs_packed_tags2_tags_only);
4900 dev->data_bytes_per_chunk = dev->param.total_bytes_per_chunk;
4902 /* Got the right mix of functions? */
4903 if (!yaffs_check_dev_fns(dev)) {
4904 /* Function missing */
4905 T(YAFFS_TRACE_ALWAYS,
4907 ("yaffs: device function(s) missing or wrong\n" TENDSTR)));
4912 if (dev->is_mounted) {
4913 T(YAFFS_TRACE_ALWAYS,
4914 (TSTR("yaffs: device already mounted\n" TENDSTR)));
4918 /* Finished with most checks. One or two more checks happen later on too. */
4920 dev->is_mounted = 1;
4922 /* OK now calculate a few things for the device */
4925 * Calculate all the chunk size manipulation numbers:
4927 x = dev->data_bytes_per_chunk;
4928 /* We always use dev->chunk_shift and dev->chunk_div */
4929 dev->chunk_shift = calc_shifts(x);
4930 x >>= dev->chunk_shift;
4932 /* We only use chunk mask if chunk_div is 1 */
4933 dev->chunk_mask = (1 << dev->chunk_shift) - 1;
4936 * Calculate chunk_grp_bits.
4937 * We need to find the next power of 2 > than internal_end_block
4940 x = dev->param.chunks_per_block * (dev->internal_end_block + 1);
4942 bits = calc_shifts_ceiling(x);
4944 /* Set up tnode width if wide tnodes are enabled. */
4945 if (!dev->param.wide_tnodes_disabled) {
4946 /* bits must be even so that we end up with 32-bit words */
4950 dev->tnode_width = 16;
4952 dev->tnode_width = bits;
4954 dev->tnode_width = 16;
4957 dev->tnode_mask = (1 << dev->tnode_width) - 1;
4959 /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
4960 * so if the bitwidth of the
4961 * chunk range we're using is greater than 16 we need
4962 * to figure out chunk shift and chunk_grp_size
4965 if (bits <= dev->tnode_width)
4966 dev->chunk_grp_bits = 0;
4968 dev->chunk_grp_bits = bits - dev->tnode_width;
4970 dev->tnode_size = (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8;
4971 if (dev->tnode_size < sizeof(struct yaffs_tnode))
4972 dev->tnode_size = sizeof(struct yaffs_tnode);
4974 dev->chunk_grp_size = 1 << dev->chunk_grp_bits;
4976 if (dev->param.chunks_per_block < dev->chunk_grp_size) {
4977 /* We have a problem because the soft delete won't work if
4978 * the chunk group size > chunks per block.
4979 * This can be remedied by using larger "virtual blocks".
4981 T(YAFFS_TRACE_ALWAYS,
4982 (TSTR("yaffs: chunk group too large\n" TENDSTR)));
4987 /* OK, we've finished verifying the device, lets continue with initialisation */
4989 /* More device initialisation */
4991 dev->passive_gc_count = 0;
4992 dev->oldest_dirty_gc_count = 0;
4994 dev->gc_block_finder = 0;
4995 dev->buffered_block = -1;
4996 dev->doing_buffered_block_rewrite = 0;
4997 dev->n_deleted_files = 0;
4998 dev->n_bg_deletions = 0;
4999 dev->n_unlinked_files = 0;
5000 dev->n_ecc_fixed = 0;
5001 dev->n_ecc_unfixed = 0;
5002 dev->n_tags_ecc_fixed = 0;
5003 dev->n_tags_ecc_unfixed = 0;
5004 dev->n_erase_failures = 0;
5005 dev->n_erased_blocks = 0;
5006 dev->gc_disable = 0;
5007 dev->has_pending_prioritised_gc = 1; /* Assume the worst for now, will get fixed on first GC */
5008 INIT_LIST_HEAD(&dev->dirty_dirs);
5009 dev->oldest_dirty_seq = 0;
5010 dev->oldest_dirty_block = 0;
5012 /* Initialise temporary buffers and caches. */
5013 if (!yaffs_init_tmp_buffers(dev))
5017 dev->gc_cleanup_list = NULL;
5019 if (!init_failed && dev->param.n_caches > 0) {
5023 dev->param.n_caches * sizeof(struct yaffs_cache);
5025 if (dev->param.n_caches > YAFFS_MAX_SHORT_OP_CACHES)
5026 dev->param.n_caches = YAFFS_MAX_SHORT_OP_CACHES;
5028 dev->cache = YMALLOC(cache_bytes);
5030 buf = (u8 *) dev->cache;
5033 memset(dev->cache, 0, cache_bytes);
5035 for (i = 0; i < dev->param.n_caches && buf; i++) {
5036 dev->cache[i].object = NULL;
5037 dev->cache[i].last_use = 0;
5038 dev->cache[i].dirty = 0;
5039 dev->cache[i].data = buf =
5040 YMALLOC_DMA(dev->param.total_bytes_per_chunk);
5045 dev->cache_last_use = 0;
5048 dev->cache_hits = 0;
5051 dev->gc_cleanup_list =
5052 YMALLOC(dev->param.chunks_per_block * sizeof(u32));
5053 if (!dev->gc_cleanup_list)
5057 if (dev->param.is_yaffs2)
5058 dev->param.use_header_file_size = 1;
5060 if (!init_failed && !yaffs_init_blocks(dev))
5063 yaffs_init_tnodes_and_objs(dev);
5065 if (!init_failed && !yaffs_create_initial_dir(dev))
5069 /* Now scan the flash. */
5070 if (dev->param.is_yaffs2) {
5071 if (yaffs2_checkpt_restore(dev)) {
5072 yaffs_check_obj_details_loaded(dev->root_dir);
5073 T(YAFFS_TRACE_CHECKPOINT | YAFFS_TRACE_MOUNT,
5075 ("yaffs: restored from checkpoint"
5079 /* Clean up the mess caused by an aborted checkpoint load
5080 * and scan backwards.
5082 yaffs_deinit_blocks(dev);
5084 yaffs_deinit_tnodes_and_objs(dev);
5086 dev->n_erased_blocks = 0;
5087 dev->n_free_chunks = 0;
5088 dev->alloc_block = -1;
5089 dev->alloc_page = -1;
5090 dev->n_deleted_files = 0;
5091 dev->n_unlinked_files = 0;
5092 dev->n_bg_deletions = 0;
5094 if (!init_failed && !yaffs_init_blocks(dev))
5097 yaffs_init_tnodes_and_objs(dev);
5100 && !yaffs_create_initial_dir(dev))
5103 if (!init_failed && !yaffs2_scan_backwards(dev))
5106 } else if (!yaffs1_scan(dev)) {
5110 yaffs_strip_deleted_objs(dev);
5111 yaffs_fix_hanging_objs(dev);
5112 if (dev->param.empty_lost_n_found)
5113 yaffs_empty_l_n_f(dev);
5117 /* Clean up the mess */
5118 T(YAFFS_TRACE_TRACING,
5119 (TSTR("yaffs: yaffs_guts_initialise() aborted.\n" TENDSTR)));
5121 yaffs_deinitialise(dev);
5125 /* Zero out stats */
5126 dev->n_page_reads = 0;
5127 dev->n_page_writes = 0;
5128 dev->n_erasures = 0;
5129 dev->n_gc_copies = 0;
5130 dev->n_retired_writes = 0;
5132 dev->n_retired_blocks = 0;
5134 yaffs_verify_free_chunks(dev);
5135 yaffs_verify_blocks(dev);
5137 /* Clean up any aborted checkpoint data */
5138 if (!dev->is_checkpointed && dev->blocks_in_checkpt > 0)
5139 yaffs2_checkpt_invalidate(dev);
5141 T(YAFFS_TRACE_TRACING,
5142 (TSTR("yaffs: yaffs_guts_initialise() done.\n" TENDSTR)));
5147 void yaffs_deinitialise(struct yaffs_dev *dev)
5149 if (dev->is_mounted) {
5152 yaffs_deinit_blocks(dev);
5153 yaffs_deinit_tnodes_and_objs(dev);
5154 if (dev->param.n_caches > 0 && dev->cache) {
5156 for (i = 0; i < dev->param.n_caches; i++) {
5157 if (dev->cache[i].data)
5158 YFREE(dev->cache[i].data);
5159 dev->cache[i].data = NULL;
5166 YFREE(dev->gc_cleanup_list);
5168 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
5169 YFREE(dev->temp_buffer[i].buffer);
5171 dev->is_mounted = 0;
5173 if (dev->param.deinitialise_flash_fn)
5174 dev->param.deinitialise_flash_fn(dev);
5178 int yaffs_count_free_chunks(struct yaffs_dev *dev)
5183 struct yaffs_block_info *blk;
5185 blk = dev->block_info;
5186 for (b = dev->internal_start_block; b <= dev->internal_end_block; b++) {
5187 switch (blk->block_state) {
5188 case YAFFS_BLOCK_STATE_EMPTY:
5189 case YAFFS_BLOCK_STATE_ALLOCATING:
5190 case YAFFS_BLOCK_STATE_COLLECTING:
5191 case YAFFS_BLOCK_STATE_FULL:
5193 (dev->param.chunks_per_block - blk->pages_in_use +
5194 blk->soft_del_pages);
5205 int yaffs_get_n_free_chunks(struct yaffs_dev *dev)
5207 /* This is what we report to the outside world */
5211 int blocks_for_checkpt;
5214 n_free = dev->n_free_chunks;
5215 n_free += dev->n_deleted_files;
5217 /* Now count the number of dirty chunks in the cache and subtract those */
5219 for (n_dirty_caches = 0, i = 0; i < dev->param.n_caches; i++) {
5220 if (dev->cache[i].dirty)
5224 n_free -= n_dirty_caches;
5227 ((dev->param.n_reserved_blocks + 1) * dev->param.chunks_per_block);
5229 /* Now we figure out how much to reserve for the checkpoint and report that... */
5230 blocks_for_checkpt = yaffs_calc_checkpt_blocks_required(dev);
5232 n_free -= (blocks_for_checkpt * dev->param.chunks_per_block);