2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2011 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU 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_getblockinfo.h"
19 #include "yaffs_tagscompat.h"
20 #include "yaffs_nand.h"
21 #include "yaffs_yaffs1.h"
22 #include "yaffs_yaffs2.h"
23 #include "yaffs_bitmap.h"
24 #include "yaffs_verify.h"
25 #include "yaffs_nand.h"
26 #include "yaffs_packedtags2.h"
27 #include "yaffs_nameval.h"
28 #include "yaffs_allocator.h"
29 #include "yaffs_attribs.h"
30 #include "yaffs_summary.h"
32 /* Note YAFFS_GC_GOOD_ENOUGH must be <= YAFFS_GC_PASSIVE_THRESHOLD */
33 #define YAFFS_GC_GOOD_ENOUGH 2
34 #define YAFFS_GC_PASSIVE_THRESHOLD 4
36 #include "yaffs_ecc.h"
38 /* Forward declarations */
40 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
41 const u8 *buffer, int n_bytes, int use_reserve);
45 /* Function to calculate chunk and offset */
47 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
48 int *chunk_out, u32 *offset_out)
53 chunk = (u32) (addr >> dev->chunk_shift);
55 if (dev->chunk_div == 1) {
56 /* easy power of 2 case */
57 offset = (u32) (addr & dev->chunk_mask);
59 /* Non power-of-2 case */
63 chunk /= dev->chunk_div;
65 chunk_base = ((loff_t) chunk) * dev->data_bytes_per_chunk;
66 offset = (u32) (addr - chunk_base);
73 /* Function to return the number of shifts for a power of 2 greater than or
74 * equal to the given number
75 * Note we don't try to cater for all possible numbers and this does not have to
76 * be hellishly efficient.
79 static inline u32 calc_shifts_ceiling(u32 x)
84 shifts = extra_bits = 0;
99 /* Function to return the number of shifts to get a 1 in bit 0
102 static inline u32 calc_shifts(u32 x)
120 * Temporary buffer manipulations.
123 static int yaffs_init_tmp_buffers(struct yaffs_dev *dev)
128 memset(dev->temp_buffer, 0, sizeof(dev->temp_buffer));
130 for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
131 dev->temp_buffer[i].in_use = 0;
132 buf = kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
133 dev->temp_buffer[i].buffer = buf;
136 return buf ? YAFFS_OK : YAFFS_FAIL;
139 u8 *yaffs_get_temp_buffer(struct yaffs_dev * dev)
144 if (dev->temp_in_use > dev->max_temp)
145 dev->max_temp = dev->temp_in_use;
147 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
148 if (dev->temp_buffer[i].in_use == 0) {
149 dev->temp_buffer[i].in_use = 1;
150 return dev->temp_buffer[i].buffer;
154 yaffs_trace(YAFFS_TRACE_BUFFERS, "Out of temp buffers");
156 * If we got here then we have to allocate an unmanaged one
160 dev->unmanaged_buffer_allocs++;
161 return kmalloc(dev->data_bytes_per_chunk, GFP_NOFS);
165 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer)
171 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
172 if (dev->temp_buffer[i].buffer == buffer) {
173 dev->temp_buffer[i].in_use = 0;
179 /* assume it is an unmanaged one. */
180 yaffs_trace(YAFFS_TRACE_BUFFERS,
181 "Releasing unmanaged temp buffer");
183 dev->unmanaged_buffer_deallocs++;
189 * Determine if we have a managed buffer.
191 int yaffs_is_managed_tmp_buffer(struct yaffs_dev *dev, const u8 *buffer)
195 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
196 if (dev->temp_buffer[i].buffer == buffer)
200 for (i = 0; i < dev->param.n_caches; i++) {
201 if (dev->cache[i].data == buffer)
205 if (buffer == dev->checkpt_buffer)
208 yaffs_trace(YAFFS_TRACE_ALWAYS,
209 "yaffs: unmaged buffer detected.");
214 * Functions for robustisizing TODO
218 static void yaffs_handle_chunk_wr_ok(struct yaffs_dev *dev, int nand_chunk,
220 const struct yaffs_ext_tags *tags)
223 nand_chunk = nand_chunk;
228 static void yaffs_handle_chunk_update(struct yaffs_dev *dev, int nand_chunk,
229 const struct yaffs_ext_tags *tags)
232 nand_chunk = nand_chunk;
236 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
237 struct yaffs_block_info *bi)
239 if (!bi->gc_prioritise) {
240 bi->gc_prioritise = 1;
241 dev->has_pending_prioritised_gc = 1;
242 bi->chunk_error_strikes++;
244 if (bi->chunk_error_strikes > 3) {
245 bi->needs_retiring = 1; /* Too many stikes, so retire */
246 yaffs_trace(YAFFS_TRACE_ALWAYS,
247 "yaffs: Block struck out");
253 static void yaffs_handle_chunk_wr_error(struct yaffs_dev *dev, int nand_chunk,
256 int flash_block = nand_chunk / dev->param.chunks_per_block;
257 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
259 yaffs_handle_chunk_error(dev, bi);
262 /* Was an actual write failure,
263 * so mark the block for retirement.*/
264 bi->needs_retiring = 1;
265 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
266 "**>> Block %d needs retiring", flash_block);
269 /* Delete the chunk */
270 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
271 yaffs_skip_rest_of_block(dev);
279 * Simple hash function. Needs to have a reasonable spread
282 static inline int yaffs_hash_fn(int n)
286 return n % YAFFS_NOBJECT_BUCKETS;
290 * Access functions to useful fake objects.
291 * Note that root might have a presence in NAND if permissions are set.
294 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev)
296 return dev->root_dir;
299 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev)
301 return dev->lost_n_found;
305 * Erased NAND checking functions
308 int yaffs_check_ff(u8 *buffer, int n_bytes)
310 /* Horrible, slow implementation */
319 static int yaffs_check_chunk_erased(struct yaffs_dev *dev, int nand_chunk)
321 int retval = YAFFS_OK;
322 u8 *data = yaffs_get_temp_buffer(dev);
323 struct yaffs_ext_tags tags;
326 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, data, &tags);
328 if (tags.ecc_result > YAFFS_ECC_RESULT_NO_ERROR)
331 if (!yaffs_check_ff(data, dev->data_bytes_per_chunk) ||
333 yaffs_trace(YAFFS_TRACE_NANDACCESS,
334 "Chunk %d not erased", nand_chunk);
338 yaffs_release_temp_buffer(dev, data);
344 static int yaffs_verify_chunk_written(struct yaffs_dev *dev,
347 struct yaffs_ext_tags *tags)
349 int retval = YAFFS_OK;
350 struct yaffs_ext_tags temp_tags;
351 u8 *buffer = yaffs_get_temp_buffer(dev);
354 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, buffer, &temp_tags);
355 if (memcmp(buffer, data, dev->data_bytes_per_chunk) ||
356 temp_tags.obj_id != tags->obj_id ||
357 temp_tags.chunk_id != tags->chunk_id ||
358 temp_tags.n_bytes != tags->n_bytes)
361 yaffs_release_temp_buffer(dev, buffer);
367 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks)
370 int reserved_blocks = dev->param.n_reserved_blocks;
373 checkpt_blocks = yaffs_calc_checkpt_blocks_required(dev);
376 (reserved_blocks + checkpt_blocks) * dev->param.chunks_per_block;
378 return (dev->n_free_chunks > (reserved_chunks + n_chunks));
381 static int yaffs_find_alloc_block(struct yaffs_dev *dev)
384 struct yaffs_block_info *bi;
386 if (dev->n_erased_blocks < 1) {
387 /* Hoosterman we've got a problem.
388 * Can't get space to gc
390 yaffs_trace(YAFFS_TRACE_ERROR,
391 "yaffs tragedy: no more erased blocks");
396 /* Find an empty block. */
398 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
399 dev->alloc_block_finder++;
400 if (dev->alloc_block_finder < dev->internal_start_block
401 || dev->alloc_block_finder > dev->internal_end_block) {
402 dev->alloc_block_finder = dev->internal_start_block;
405 bi = yaffs_get_block_info(dev, dev->alloc_block_finder);
407 if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
408 bi->block_state = YAFFS_BLOCK_STATE_ALLOCATING;
410 bi->seq_number = dev->seq_number;
411 dev->n_erased_blocks--;
412 yaffs_trace(YAFFS_TRACE_ALLOCATE,
413 "Allocated block %d, seq %d, %d left" ,
414 dev->alloc_block_finder, dev->seq_number,
415 dev->n_erased_blocks);
416 return dev->alloc_block_finder;
420 yaffs_trace(YAFFS_TRACE_ALWAYS,
421 "yaffs tragedy: no more erased blocks, but there should have been %d",
422 dev->n_erased_blocks);
427 static int yaffs_alloc_chunk(struct yaffs_dev *dev, int use_reserver,
428 struct yaffs_block_info **block_ptr)
431 struct yaffs_block_info *bi;
433 if (dev->alloc_block < 0) {
434 /* Get next block to allocate off */
435 dev->alloc_block = yaffs_find_alloc_block(dev);
439 if (!use_reserver && !yaffs_check_alloc_available(dev, 1)) {
440 /* No space unless we're allowed to use the reserve. */
444 if (dev->n_erased_blocks < dev->param.n_reserved_blocks
445 && dev->alloc_page == 0)
446 yaffs_trace(YAFFS_TRACE_ALLOCATE, "Allocating reserve");
448 /* Next page please.... */
449 if (dev->alloc_block >= 0) {
450 bi = yaffs_get_block_info(dev, dev->alloc_block);
452 ret_val = (dev->alloc_block * dev->param.chunks_per_block) +
455 yaffs_set_chunk_bit(dev, dev->alloc_block, dev->alloc_page);
459 dev->n_free_chunks--;
461 /* If the block is full set the state to full */
462 if (dev->alloc_page >= dev->param.chunks_per_block) {
463 bi->block_state = YAFFS_BLOCK_STATE_FULL;
464 dev->alloc_block = -1;
473 yaffs_trace(YAFFS_TRACE_ERROR,
474 "!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!");
479 static int yaffs_get_erased_chunks(struct yaffs_dev *dev)
483 n = dev->n_erased_blocks * dev->param.chunks_per_block;
485 if (dev->alloc_block > 0)
486 n += (dev->param.chunks_per_block - dev->alloc_page);
493 * yaffs_skip_rest_of_block() skips over the rest of the allocation block
494 * if we don't want to write to it.
496 void yaffs_skip_rest_of_block(struct yaffs_dev *dev)
498 struct yaffs_block_info *bi;
500 if (dev->alloc_block > 0) {
501 bi = yaffs_get_block_info(dev, dev->alloc_block);
502 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING) {
503 bi->block_state = YAFFS_BLOCK_STATE_FULL;
504 dev->alloc_block = -1;
509 static int yaffs_write_new_chunk(struct yaffs_dev *dev,
511 struct yaffs_ext_tags *tags, int use_reserver)
517 yaffs2_checkpt_invalidate(dev);
520 struct yaffs_block_info *bi = 0;
523 chunk = yaffs_alloc_chunk(dev, use_reserver, &bi);
529 /* First check this chunk is erased, if it needs
530 * checking. The checking policy (unless forced
531 * always on) is as follows:
533 * Check the first page we try to write in a block.
534 * If the check passes then we don't need to check any
535 * more. If the check fails, we check again...
536 * If the block has been erased, we don't need to check.
538 * However, if the block has been prioritised for gc,
539 * then we think there might be something odd about
540 * this block and stop using it.
542 * Rationale: We should only ever see chunks that have
543 * not been erased if there was a partially written
544 * chunk due to power loss. This checking policy should
545 * catch that case with very few checks and thus save a
546 * lot of checks that are most likely not needed.
549 * If an erase check fails or the write fails we skip the
553 /* let's give it a try */
556 if (dev->param.always_check_erased)
557 bi->skip_erased_check = 0;
559 if (!bi->skip_erased_check) {
560 erased_ok = yaffs_check_chunk_erased(dev, chunk);
561 if (erased_ok != YAFFS_OK) {
562 yaffs_trace(YAFFS_TRACE_ERROR,
563 "**>> yaffs chunk %d was not erased",
566 /* If not erased, delete this one,
567 * skip rest of block and
568 * try another chunk */
569 yaffs_chunk_del(dev, chunk, 1, __LINE__);
570 yaffs_skip_rest_of_block(dev);
575 write_ok = yaffs_wr_chunk_tags_nand(dev, chunk, data, tags);
577 if (!bi->skip_erased_check)
579 yaffs_verify_chunk_written(dev, chunk, data, tags);
581 if (write_ok != YAFFS_OK) {
582 /* Clean up aborted write, skip to next block and
583 * try another chunk */
584 yaffs_handle_chunk_wr_error(dev, chunk, erased_ok);
588 bi->skip_erased_check = 1;
590 /* Copy the data into the robustification buffer */
591 yaffs_handle_chunk_wr_ok(dev, chunk, data, tags);
593 } while (write_ok != YAFFS_OK &&
594 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
600 yaffs_trace(YAFFS_TRACE_ERROR,
601 "**>> yaffs write required %d attempts",
603 dev->n_retried_writes += (attempts - 1);
610 * Block retiring for handling a broken block.
613 static void yaffs_retire_block(struct yaffs_dev *dev, int flash_block)
615 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
617 yaffs2_checkpt_invalidate(dev);
619 yaffs2_clear_oldest_dirty_seq(dev, bi);
621 if (yaffs_mark_bad(dev, flash_block) != YAFFS_OK) {
622 if (yaffs_erase_block(dev, flash_block) != YAFFS_OK) {
623 yaffs_trace(YAFFS_TRACE_ALWAYS,
624 "yaffs: Failed to mark bad and erase block %d",
627 struct yaffs_ext_tags tags;
629 flash_block * dev->param.chunks_per_block;
631 u8 *buffer = yaffs_get_temp_buffer(dev);
633 memset(buffer, 0xff, dev->data_bytes_per_chunk);
634 memset(&tags, 0, sizeof(tags));
635 tags.seq_number = YAFFS_SEQUENCE_BAD_BLOCK;
636 if (dev->param.write_chunk_tags_fn(dev, chunk_id -
640 yaffs_trace(YAFFS_TRACE_ALWAYS,
641 "yaffs: Failed to write bad block marker to block %d",
644 yaffs_release_temp_buffer(dev, buffer);
648 bi->block_state = YAFFS_BLOCK_STATE_DEAD;
649 bi->gc_prioritise = 0;
650 bi->needs_retiring = 0;
652 dev->n_retired_blocks++;
655 /*---------------- Name handling functions ------------*/
657 static u16 yaffs_calc_name_sum(const YCHAR *name)
665 while ((*name) && i < (YAFFS_MAX_NAME_LENGTH / 2)) {
667 /* 0x1f mask is case insensitive */
668 sum += ((*name) & 0x1f) * i;
675 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR * name)
677 memset(obj->short_name, 0, sizeof(obj->short_name));
679 strnlen(name, YAFFS_SHORT_NAME_LENGTH + 1) <=
680 YAFFS_SHORT_NAME_LENGTH)
681 strcpy(obj->short_name, name);
683 obj->short_name[0] = _Y('\0');
684 obj->sum = yaffs_calc_name_sum(name);
687 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
688 const struct yaffs_obj_hdr *oh)
690 #ifdef CONFIG_YAFFS_AUTO_UNICODE
691 YCHAR tmp_name[YAFFS_MAX_NAME_LENGTH + 1];
692 memset(tmp_name, 0, sizeof(tmp_name));
693 yaffs_load_name_from_oh(obj->my_dev, tmp_name, oh->name,
694 YAFFS_MAX_NAME_LENGTH + 1);
695 yaffs_set_obj_name(obj, tmp_name);
697 yaffs_set_obj_name(obj, oh->name);
701 loff_t yaffs_max_file_size(struct yaffs_dev *dev)
703 return ((loff_t) YAFFS_MAX_CHUNK_ID) * dev->data_bytes_per_chunk;
706 /*-------------------- TNODES -------------------
708 * List of spare tnodes
709 * The list is hooked together using the first pointer
713 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev)
715 struct yaffs_tnode *tn = yaffs_alloc_raw_tnode(dev);
718 memset(tn, 0, dev->tnode_size);
722 dev->checkpoint_blocks_required = 0; /* force recalculation */
727 /* FreeTnode frees up a tnode and puts it back on the free list */
728 static void yaffs_free_tnode(struct yaffs_dev *dev, struct yaffs_tnode *tn)
730 yaffs_free_raw_tnode(dev, tn);
732 dev->checkpoint_blocks_required = 0; /* force recalculation */
735 static void yaffs_deinit_tnodes_and_objs(struct yaffs_dev *dev)
737 yaffs_deinit_raw_tnodes_and_objs(dev);
742 void yaffs_load_tnode_0(struct yaffs_dev *dev, struct yaffs_tnode *tn,
743 unsigned pos, unsigned val)
745 u32 *map = (u32 *) tn;
751 pos &= YAFFS_TNODES_LEVEL0_MASK;
752 val >>= dev->chunk_grp_bits;
754 bit_in_map = pos * dev->tnode_width;
755 word_in_map = bit_in_map / 32;
756 bit_in_word = bit_in_map & (32 - 1);
758 mask = dev->tnode_mask << bit_in_word;
760 map[word_in_map] &= ~mask;
761 map[word_in_map] |= (mask & (val << bit_in_word));
763 if (dev->tnode_width > (32 - bit_in_word)) {
764 bit_in_word = (32 - bit_in_word);
767 dev->tnode_mask >> bit_in_word;
768 map[word_in_map] &= ~mask;
769 map[word_in_map] |= (mask & (val >> bit_in_word));
773 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
776 u32 *map = (u32 *) tn;
782 pos &= YAFFS_TNODES_LEVEL0_MASK;
784 bit_in_map = pos * dev->tnode_width;
785 word_in_map = bit_in_map / 32;
786 bit_in_word = bit_in_map & (32 - 1);
788 val = map[word_in_map] >> bit_in_word;
790 if (dev->tnode_width > (32 - bit_in_word)) {
791 bit_in_word = (32 - bit_in_word);
793 val |= (map[word_in_map] << bit_in_word);
796 val &= dev->tnode_mask;
797 val <<= dev->chunk_grp_bits;
802 /* ------------------- End of individual tnode manipulation -----------------*/
804 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
805 * The look up tree is represented by the top tnode and the number of top_level
806 * in the tree. 0 means only the level 0 tnode is in the tree.
809 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
810 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
811 struct yaffs_file_var *file_struct,
814 struct yaffs_tnode *tn = file_struct->top;
817 int level = file_struct->top_level;
821 /* Check sane level and chunk Id */
822 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
825 if (chunk_id > YAFFS_MAX_CHUNK_ID)
828 /* First check we're tall enough (ie enough top_level) */
830 i = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
833 i >>= YAFFS_TNODES_INTERNAL_BITS;
837 if (required_depth > file_struct->top_level)
838 return NULL; /* Not tall enough, so we can't find it */
840 /* Traverse down to level 0 */
841 while (level > 0 && tn) {
842 tn = tn->internal[(chunk_id >>
843 (YAFFS_TNODES_LEVEL0_BITS +
845 YAFFS_TNODES_INTERNAL_BITS)) &
846 YAFFS_TNODES_INTERNAL_MASK];
853 /* add_find_tnode_0 finds the level 0 tnode if it exists,
854 * otherwise first expands the tree.
855 * This happens in two steps:
856 * 1. If the tree isn't tall enough, then make it taller.
857 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
859 * Used when modifying the tree.
861 * If the tn argument is NULL, then a fresh tnode will be added otherwise the
862 * specified tn will be plugged into the ttree.
865 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
866 struct yaffs_file_var *file_struct,
868 struct yaffs_tnode *passed_tn)
873 struct yaffs_tnode *tn;
876 /* Check sane level and page Id */
877 if (file_struct->top_level < 0 ||
878 file_struct->top_level > YAFFS_TNODES_MAX_LEVEL)
881 if (chunk_id > YAFFS_MAX_CHUNK_ID)
884 /* First check we're tall enough (ie enough top_level) */
886 x = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
889 x >>= YAFFS_TNODES_INTERNAL_BITS;
893 if (required_depth > file_struct->top_level) {
894 /* Not tall enough, gotta make the tree taller */
895 for (i = file_struct->top_level; i < required_depth; i++) {
897 tn = yaffs_get_tnode(dev);
900 tn->internal[0] = file_struct->top;
901 file_struct->top = tn;
902 file_struct->top_level++;
904 yaffs_trace(YAFFS_TRACE_ERROR,
905 "yaffs: no more tnodes");
911 /* Traverse down to level 0, adding anything we need */
913 l = file_struct->top_level;
914 tn = file_struct->top;
917 while (l > 0 && tn) {
919 (YAFFS_TNODES_LEVEL0_BITS +
920 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
921 YAFFS_TNODES_INTERNAL_MASK;
923 if ((l > 1) && !tn->internal[x]) {
924 /* Add missing non-level-zero tnode */
925 tn->internal[x] = yaffs_get_tnode(dev);
926 if (!tn->internal[x])
929 /* Looking from level 1 at level 0 */
931 /* If we already have one, release it */
933 yaffs_free_tnode(dev,
935 tn->internal[x] = passed_tn;
937 } else if (!tn->internal[x]) {
938 /* Don't have one, none passed in */
939 tn->internal[x] = yaffs_get_tnode(dev);
940 if (!tn->internal[x])
945 tn = tn->internal[x];
951 memcpy(tn, passed_tn,
952 (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8);
953 yaffs_free_tnode(dev, passed_tn);
960 static int yaffs_tags_match(const struct yaffs_ext_tags *tags, int obj_id,
963 return (tags->chunk_id == chunk_obj &&
964 tags->obj_id == obj_id &&
965 !tags->is_deleted) ? 1 : 0;
969 static int yaffs_find_chunk_in_group(struct yaffs_dev *dev, int the_chunk,
970 struct yaffs_ext_tags *tags, int obj_id,
975 for (j = 0; the_chunk && j < dev->chunk_grp_size; j++) {
976 if (yaffs_check_chunk_bit
977 (dev, the_chunk / dev->param.chunks_per_block,
978 the_chunk % dev->param.chunks_per_block)) {
980 if (dev->chunk_grp_size == 1)
983 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
985 if (yaffs_tags_match(tags,
986 obj_id, inode_chunk)) {
997 static int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
998 struct yaffs_ext_tags *tags)
1000 /*Get the Tnode, then get the level 0 offset chunk offset */
1001 struct yaffs_tnode *tn;
1003 struct yaffs_ext_tags local_tags;
1005 struct yaffs_dev *dev = in->my_dev;
1008 /* Passed a NULL, so use our own tags space */
1012 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1017 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1019 ret_val = yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1024 static int yaffs_find_del_file_chunk(struct yaffs_obj *in, int inode_chunk,
1025 struct yaffs_ext_tags *tags)
1027 /* Get the Tnode, then get the level 0 offset chunk offset */
1028 struct yaffs_tnode *tn;
1030 struct yaffs_ext_tags local_tags;
1031 struct yaffs_dev *dev = in->my_dev;
1035 /* Passed a NULL, so use our own tags space */
1039 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1044 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1046 ret_val = yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1049 /* Delete the entry in the filestructure (if found) */
1051 yaffs_load_tnode_0(dev, tn, inode_chunk, 0);
1056 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1057 int nand_chunk, int in_scan)
1059 /* NB in_scan is zero unless scanning.
1060 * For forward scanning, in_scan is > 0;
1061 * for backward scanning in_scan is < 0
1063 * nand_chunk = 0 is a dummy insert to make sure the tnodes are there.
1066 struct yaffs_tnode *tn;
1067 struct yaffs_dev *dev = in->my_dev;
1069 struct yaffs_ext_tags existing_tags;
1070 struct yaffs_ext_tags new_tags;
1071 unsigned existing_serial, new_serial;
1073 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE) {
1074 /* Just ignore an attempt at putting a chunk into a non-file
1076 * If it is not during Scanning then something went wrong!
1079 yaffs_trace(YAFFS_TRACE_ERROR,
1080 "yaffs tragedy:attempt to put data chunk into a non-file"
1085 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1089 tn = yaffs_add_find_tnode_0(dev,
1090 &in->variant.file_variant,
1096 /* Dummy insert, bail now */
1099 existing_cunk = yaffs_get_group_base(dev, tn, inode_chunk);
1102 /* If we're scanning then we need to test for duplicates
1103 * NB This does not need to be efficient since it should only
1104 * happen when the power fails during a write, then only one
1105 * chunk should ever be affected.
1107 * Correction for YAFFS2: This could happen quite a lot and we
1108 * need to think about efficiency! TODO
1109 * Update: For backward scanning we don't need to re-read tags
1110 * so this is quite cheap.
1113 if (existing_cunk > 0) {
1114 /* NB Right now existing chunk will not be real
1115 * chunk_id if the chunk group size > 1
1116 * thus we have to do a FindChunkInFile to get the
1119 * We have a duplicate now we need to decide which
1122 * Backwards scanning YAFFS2: The old one is what
1123 * we use, dump the new one.
1124 * YAFFS1: Get both sets of tags and compare serial
1129 /* Only do this for forward scanning */
1130 yaffs_rd_chunk_tags_nand(dev,
1134 /* Do a proper find */
1136 yaffs_find_chunk_in_file(in, inode_chunk,
1140 if (existing_cunk <= 0) {
1141 /*Hoosterman - how did this happen? */
1143 yaffs_trace(YAFFS_TRACE_ERROR,
1144 "yaffs tragedy: existing chunk < 0 in scan"
1149 /* NB The deleted flags should be false, otherwise
1150 * the chunks will not be loaded during a scan
1154 new_serial = new_tags.serial_number;
1155 existing_serial = existing_tags.serial_number;
1158 if ((in_scan > 0) &&
1159 (existing_cunk <= 0 ||
1160 ((existing_serial + 1) & 3) == new_serial)) {
1161 /* Forward scanning.
1163 * Delete the old one and drop through to
1166 yaffs_chunk_del(dev, existing_cunk, 1,
1169 /* Backward scanning or we want to use the
1171 * Delete the new one and return early so that
1172 * the tnode isn't changed
1174 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1181 if (existing_cunk == 0)
1182 in->n_data_chunks++;
1184 yaffs_load_tnode_0(dev, tn, inode_chunk, nand_chunk);
1189 static void yaffs_soft_del_chunk(struct yaffs_dev *dev, int chunk)
1191 struct yaffs_block_info *the_block;
1194 yaffs_trace(YAFFS_TRACE_DELETION, "soft delete chunk %d", chunk);
1196 block_no = chunk / dev->param.chunks_per_block;
1197 the_block = yaffs_get_block_info(dev, block_no);
1199 the_block->soft_del_pages++;
1200 dev->n_free_chunks++;
1201 yaffs2_update_oldest_dirty_seq(dev, block_no, the_block);
1205 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all
1206 * the chunks in the file.
1207 * All soft deleting does is increment the block's softdelete count and pulls
1208 * the chunk out of the tnode.
1209 * Thus, essentially this is the same as DeleteWorker except that the chunks
1213 static int yaffs_soft_del_worker(struct yaffs_obj *in, struct yaffs_tnode *tn,
1214 u32 level, int chunk_offset)
1219 struct yaffs_dev *dev = in->my_dev;
1225 for (i = YAFFS_NTNODES_INTERNAL - 1;
1228 if (tn->internal[i]) {
1230 yaffs_soft_del_worker(in,
1234 YAFFS_TNODES_INTERNAL_BITS)
1237 yaffs_free_tnode(dev,
1239 tn->internal[i] = NULL;
1241 /* Can this happen? */
1245 return (all_done) ? 1 : 0;
1249 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1250 the_chunk = yaffs_get_group_base(dev, tn, i);
1252 yaffs_soft_del_chunk(dev, the_chunk);
1253 yaffs_load_tnode_0(dev, tn, i, 0);
1259 static void yaffs_remove_obj_from_dir(struct yaffs_obj *obj)
1261 struct yaffs_dev *dev = obj->my_dev;
1262 struct yaffs_obj *parent;
1264 yaffs_verify_obj_in_dir(obj);
1265 parent = obj->parent;
1267 yaffs_verify_dir(parent);
1269 if (dev && dev->param.remove_obj_fn)
1270 dev->param.remove_obj_fn(obj);
1272 list_del_init(&obj->siblings);
1275 yaffs_verify_dir(parent);
1278 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj)
1281 yaffs_trace(YAFFS_TRACE_ALWAYS,
1282 "tragedy: Trying to add an object to a null pointer directory"
1287 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1288 yaffs_trace(YAFFS_TRACE_ALWAYS,
1289 "tragedy: Trying to add an object to a non-directory"
1294 if (obj->siblings.prev == NULL) {
1295 /* Not initialised */
1299 yaffs_verify_dir(directory);
1301 yaffs_remove_obj_from_dir(obj);
1304 list_add(&obj->siblings, &directory->variant.dir_variant.children);
1305 obj->parent = directory;
1307 if (directory == obj->my_dev->unlinked_dir
1308 || directory == obj->my_dev->del_dir) {
1310 obj->my_dev->n_unlinked_files++;
1311 obj->rename_allowed = 0;
1314 yaffs_verify_dir(directory);
1315 yaffs_verify_obj_in_dir(obj);
1318 static int yaffs_change_obj_name(struct yaffs_obj *obj,
1319 struct yaffs_obj *new_dir,
1320 const YCHAR *new_name, int force, int shadows)
1324 struct yaffs_obj *existing_target;
1326 if (new_dir == NULL)
1327 new_dir = obj->parent; /* use the old directory */
1329 if (new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1330 yaffs_trace(YAFFS_TRACE_ALWAYS,
1331 "tragedy: yaffs_change_obj_name: new_dir is not a directory"
1336 unlink_op = (new_dir == obj->my_dev->unlinked_dir);
1337 del_op = (new_dir == obj->my_dev->del_dir);
1339 existing_target = yaffs_find_by_name(new_dir, new_name);
1341 /* If the object is a file going into the unlinked directory,
1342 * then it is OK to just stuff it in since duplicate names are OK.
1343 * else only proceed if the new name does not exist and we're putting
1344 * it into a directory.
1346 if (!(unlink_op || del_op || force ||
1347 shadows > 0 || !existing_target) ||
1348 new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
1351 yaffs_set_obj_name(obj, new_name);
1353 yaffs_add_obj_to_dir(new_dir, obj);
1358 /* If it is a deletion then we mark it as a shrink for gc */
1359 if (yaffs_update_oh(obj, new_name, 0, del_op, shadows, NULL) >= 0)
1365 /*------------------------ Short Operations Cache ------------------------------
1366 * In many situations where there is no high level buffering a lot of
1367 * reads might be short sequential reads, and a lot of writes may be short
1368 * sequential writes. eg. scanning/writing a jpeg file.
1369 * In these cases, a short read/write cache can provide a huge perfomance
1370 * benefit with dumb-as-a-rock code.
1371 * In Linux, the page cache provides read buffering and the short op cache
1372 * provides write buffering.
1374 * There are a small number (~10) of cache chunks per device so that we don't
1375 * need a very intelligent search.
1378 static int yaffs_obj_cache_dirty(struct yaffs_obj *obj)
1380 struct yaffs_dev *dev = obj->my_dev;
1382 struct yaffs_cache *cache;
1383 int n_caches = obj->my_dev->param.n_caches;
1385 for (i = 0; i < n_caches; i++) {
1386 cache = &dev->cache[i];
1387 if (cache->object == obj && cache->dirty)
1394 static void yaffs_flush_file_cache(struct yaffs_obj *obj)
1396 struct yaffs_dev *dev = obj->my_dev;
1397 int lowest = -99; /* Stop compiler whining. */
1399 struct yaffs_cache *cache;
1400 int chunk_written = 0;
1401 int n_caches = obj->my_dev->param.n_caches;
1408 /* Find the lowest dirty chunk for this object */
1409 for (i = 0; i < n_caches; i++) {
1410 if (dev->cache[i].object == obj &&
1411 dev->cache[i].dirty) {
1413 dev->cache[i].chunk_id < lowest) {
1414 cache = &dev->cache[i];
1415 lowest = cache->chunk_id;
1420 if (cache && !cache->locked) {
1421 /* Write it out and free it up */
1423 yaffs_wr_data_obj(cache->object,
1428 cache->object = NULL;
1430 } while (cache && chunk_written > 0);
1433 /* Hoosterman, disk full while writing cache out. */
1434 yaffs_trace(YAFFS_TRACE_ERROR,
1435 "yaffs tragedy: no space during cache write");
1438 /*yaffs_flush_whole_cache(dev)
1443 void yaffs_flush_whole_cache(struct yaffs_dev *dev)
1445 struct yaffs_obj *obj;
1446 int n_caches = dev->param.n_caches;
1449 /* Find a dirty object in the cache and flush it...
1450 * until there are no further dirty objects.
1454 for (i = 0; i < n_caches && !obj; i++) {
1455 if (dev->cache[i].object && dev->cache[i].dirty)
1456 obj = dev->cache[i].object;
1459 yaffs_flush_file_cache(obj);
1464 /* Grab us a cache chunk for use.
1465 * First look for an empty one.
1466 * Then look for the least recently used non-dirty one.
1467 * Then look for the least recently used dirty one...., flush and look again.
1469 static struct yaffs_cache *yaffs_grab_chunk_worker(struct yaffs_dev *dev)
1473 if (dev->param.n_caches > 0) {
1474 for (i = 0; i < dev->param.n_caches; i++) {
1475 if (!dev->cache[i].object)
1476 return &dev->cache[i];
1482 static struct yaffs_cache *yaffs_grab_chunk_cache(struct yaffs_dev *dev)
1484 struct yaffs_cache *cache;
1485 struct yaffs_obj *the_obj;
1490 if (dev->param.n_caches < 1)
1493 /* Try find a non-dirty one... */
1495 cache = yaffs_grab_chunk_worker(dev);
1498 /* They were all dirty, find the LRU object and flush
1499 * its cache, then find again.
1500 * NB what's here is not very accurate,
1501 * we actually flush the object with the LRU chunk.
1504 /* With locking we can't assume we can use entry zero,
1505 * Set the_obj to a valid pointer for Coverity. */
1506 the_obj = dev->cache[0].object;
1511 for (i = 0; i < dev->param.n_caches; i++) {
1512 if (dev->cache[i].object &&
1513 !dev->cache[i].locked &&
1514 (dev->cache[i].last_use < usage ||
1516 usage = dev->cache[i].last_use;
1517 the_obj = dev->cache[i].object;
1518 cache = &dev->cache[i];
1523 if (!cache || cache->dirty) {
1524 /* Flush and try again */
1525 yaffs_flush_file_cache(the_obj);
1526 cache = yaffs_grab_chunk_worker(dev);
1532 /* Find a cached chunk */
1533 static struct yaffs_cache *yaffs_find_chunk_cache(const struct yaffs_obj *obj,
1536 struct yaffs_dev *dev = obj->my_dev;
1539 if (dev->param.n_caches < 1)
1542 for (i = 0; i < dev->param.n_caches; i++) {
1543 if (dev->cache[i].object == obj &&
1544 dev->cache[i].chunk_id == chunk_id) {
1547 return &dev->cache[i];
1553 /* Mark the chunk for the least recently used algorithym */
1554 static void yaffs_use_cache(struct yaffs_dev *dev, struct yaffs_cache *cache,
1559 if (dev->param.n_caches < 1)
1562 if (dev->cache_last_use < 0 ||
1563 dev->cache_last_use > 100000000) {
1564 /* Reset the cache usages */
1565 for (i = 1; i < dev->param.n_caches; i++)
1566 dev->cache[i].last_use = 0;
1568 dev->cache_last_use = 0;
1570 dev->cache_last_use++;
1571 cache->last_use = dev->cache_last_use;
1577 /* Invalidate a single cache page.
1578 * Do this when a whole page gets written,
1579 * ie the short cache for this page is no longer valid.
1581 static void yaffs_invalidate_chunk_cache(struct yaffs_obj *object, int chunk_id)
1583 struct yaffs_cache *cache;
1585 if (object->my_dev->param.n_caches > 0) {
1586 cache = yaffs_find_chunk_cache(object, chunk_id);
1589 cache->object = NULL;
1593 /* Invalidate all the cache pages associated with this object
1594 * Do this whenever ther file is deleted or resized.
1596 static void yaffs_invalidate_whole_cache(struct yaffs_obj *in)
1599 struct yaffs_dev *dev = in->my_dev;
1601 if (dev->param.n_caches > 0) {
1602 /* Invalidate it. */
1603 for (i = 0; i < dev->param.n_caches; i++) {
1604 if (dev->cache[i].object == in)
1605 dev->cache[i].object = NULL;
1610 static void yaffs_unhash_obj(struct yaffs_obj *obj)
1613 struct yaffs_dev *dev = obj->my_dev;
1615 /* If it is still linked into the bucket list, free from the list */
1616 if (!list_empty(&obj->hash_link)) {
1617 list_del_init(&obj->hash_link);
1618 bucket = yaffs_hash_fn(obj->obj_id);
1619 dev->obj_bucket[bucket].count--;
1623 /* FreeObject frees up a Object and puts it back on the free list */
1624 static void yaffs_free_obj(struct yaffs_obj *obj)
1626 struct yaffs_dev *dev;
1633 yaffs_trace(YAFFS_TRACE_OS, "FreeObject %p inode %p",
1634 obj, obj->my_inode);
1637 if (!list_empty(&obj->siblings))
1640 if (obj->my_inode) {
1641 /* We're still hooked up to a cached inode.
1642 * Don't delete now, but mark for later deletion
1644 obj->defered_free = 1;
1648 yaffs_unhash_obj(obj);
1650 yaffs_free_raw_obj(dev, obj);
1652 dev->checkpoint_blocks_required = 0; /* force recalculation */
1655 void yaffs_handle_defered_free(struct yaffs_obj *obj)
1657 if (obj->defered_free)
1658 yaffs_free_obj(obj);
1661 static int yaffs_generic_obj_del(struct yaffs_obj *in)
1663 /* Iinvalidate the file's data in the cache, without flushing. */
1664 yaffs_invalidate_whole_cache(in);
1666 if (in->my_dev->param.is_yaffs2 && in->parent != in->my_dev->del_dir) {
1667 /* Move to unlinked directory so we have a deletion record */
1668 yaffs_change_obj_name(in, in->my_dev->del_dir, _Y("deleted"), 0,
1672 yaffs_remove_obj_from_dir(in);
1673 yaffs_chunk_del(in->my_dev, in->hdr_chunk, 1, __LINE__);
1681 static void yaffs_soft_del_file(struct yaffs_obj *obj)
1683 if (!obj->deleted ||
1684 obj->variant_type != YAFFS_OBJECT_TYPE_FILE ||
1688 if (obj->n_data_chunks <= 0) {
1689 /* Empty file with no duplicate object headers,
1690 * just delete it immediately */
1691 yaffs_free_tnode(obj->my_dev, obj->variant.file_variant.top);
1692 obj->variant.file_variant.top = NULL;
1693 yaffs_trace(YAFFS_TRACE_TRACING,
1694 "yaffs: Deleting empty file %d",
1696 yaffs_generic_obj_del(obj);
1698 yaffs_soft_del_worker(obj,
1699 obj->variant.file_variant.top,
1701 file_variant.top_level, 0);
1706 /* Pruning removes any part of the file structure tree that is beyond the
1707 * bounds of the file (ie that does not point to chunks).
1709 * A file should only get pruned when its size is reduced.
1711 * Before pruning, the chunks must be pulled from the tree and the
1712 * level 0 tnode entries must be zeroed out.
1713 * Could also use this for file deletion, but that's probably better handled
1714 * by a special case.
1716 * This function is recursive. For levels > 0 the function is called again on
1717 * any sub-tree. For level == 0 we just check if the sub-tree has data.
1718 * If there is no data in a subtree then it is pruned.
1721 static struct yaffs_tnode *yaffs_prune_worker(struct yaffs_dev *dev,
1722 struct yaffs_tnode *tn, u32 level,
1734 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1735 if (tn->internal[i]) {
1737 yaffs_prune_worker(dev,
1740 (i == 0) ? del0 : 1);
1743 if (tn->internal[i])
1747 int tnode_size_u32 = dev->tnode_size / sizeof(u32);
1748 u32 *map = (u32 *) tn;
1750 for (i = 0; !has_data && i < tnode_size_u32; i++) {
1756 if (has_data == 0 && del0) {
1757 /* Free and return NULL */
1758 yaffs_free_tnode(dev, tn);
1764 static int yaffs_prune_tree(struct yaffs_dev *dev,
1765 struct yaffs_file_var *file_struct)
1770 struct yaffs_tnode *tn;
1772 if (file_struct->top_level < 1)
1776 yaffs_prune_worker(dev, file_struct->top, file_struct->top_level, 0);
1778 /* Now we have a tree with all the non-zero branches NULL but
1779 * the height is the same as it was.
1780 * Let's see if we can trim internal tnodes to shorten the tree.
1781 * We can do this if only the 0th element in the tnode is in use
1782 * (ie all the non-zero are NULL)
1785 while (file_struct->top_level && !done) {
1786 tn = file_struct->top;
1789 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1790 if (tn->internal[i])
1795 file_struct->top = tn->internal[0];
1796 file_struct->top_level--;
1797 yaffs_free_tnode(dev, tn);
1806 /*-------------------- End of File Structure functions.-------------------*/
1808 /* alloc_empty_obj gets us a clean Object.*/
1809 static struct yaffs_obj *yaffs_alloc_empty_obj(struct yaffs_dev *dev)
1811 struct yaffs_obj *obj = yaffs_alloc_raw_obj(dev);
1818 /* Now sweeten it up... */
1820 memset(obj, 0, sizeof(struct yaffs_obj));
1821 obj->being_created = 1;
1825 obj->variant_type = YAFFS_OBJECT_TYPE_UNKNOWN;
1826 INIT_LIST_HEAD(&(obj->hard_links));
1827 INIT_LIST_HEAD(&(obj->hash_link));
1828 INIT_LIST_HEAD(&obj->siblings);
1830 /* Now make the directory sane */
1831 if (dev->root_dir) {
1832 obj->parent = dev->root_dir;
1833 list_add(&(obj->siblings),
1834 &dev->root_dir->variant.dir_variant.children);
1837 /* Add it to the lost and found directory.
1838 * NB Can't put root or lost-n-found in lost-n-found so
1839 * check if lost-n-found exists first
1841 if (dev->lost_n_found)
1842 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
1844 obj->being_created = 0;
1846 dev->checkpoint_blocks_required = 0; /* force recalculation */
1851 static int yaffs_find_nice_bucket(struct yaffs_dev *dev)
1855 int lowest = 999999;
1857 /* Search for the shortest list or one that
1861 for (i = 0; i < 10 && lowest > 4; i++) {
1862 dev->bucket_finder++;
1863 dev->bucket_finder %= YAFFS_NOBJECT_BUCKETS;
1864 if (dev->obj_bucket[dev->bucket_finder].count < lowest) {
1865 lowest = dev->obj_bucket[dev->bucket_finder].count;
1866 l = dev->bucket_finder;
1873 static int yaffs_new_obj_id(struct yaffs_dev *dev)
1875 int bucket = yaffs_find_nice_bucket(dev);
1877 struct list_head *i;
1878 u32 n = (u32) bucket;
1880 /* Now find an object value that has not already been taken
1881 * by scanning the list.
1886 n += YAFFS_NOBJECT_BUCKETS;
1887 if (1 || dev->obj_bucket[bucket].count > 0) {
1888 list_for_each(i, &dev->obj_bucket[bucket].list) {
1889 /* If there is already one in the list */
1890 if (i && list_entry(i, struct yaffs_obj,
1891 hash_link)->obj_id == n) {
1900 static void yaffs_hash_obj(struct yaffs_obj *in)
1902 int bucket = yaffs_hash_fn(in->obj_id);
1903 struct yaffs_dev *dev = in->my_dev;
1905 list_add(&in->hash_link, &dev->obj_bucket[bucket].list);
1906 dev->obj_bucket[bucket].count++;
1909 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number)
1911 int bucket = yaffs_hash_fn(number);
1912 struct list_head *i;
1913 struct yaffs_obj *in;
1915 list_for_each(i, &dev->obj_bucket[bucket].list) {
1916 /* Look if it is in the list */
1917 in = list_entry(i, struct yaffs_obj, hash_link);
1918 if (in->obj_id == number) {
1919 /* Don't show if it is defered free */
1920 if (in->defered_free)
1929 struct yaffs_obj *yaffs_new_obj(struct yaffs_dev *dev, int number,
1930 enum yaffs_obj_type type)
1932 struct yaffs_obj *the_obj = NULL;
1933 struct yaffs_tnode *tn = NULL;
1936 number = yaffs_new_obj_id(dev);
1938 if (type == YAFFS_OBJECT_TYPE_FILE) {
1939 tn = yaffs_get_tnode(dev);
1944 the_obj = yaffs_alloc_empty_obj(dev);
1947 yaffs_free_tnode(dev, tn);
1952 the_obj->rename_allowed = 1;
1953 the_obj->unlink_allowed = 1;
1954 the_obj->obj_id = number;
1955 yaffs_hash_obj(the_obj);
1956 the_obj->variant_type = type;
1957 yaffs_load_current_time(the_obj, 1, 1);
1960 case YAFFS_OBJECT_TYPE_FILE:
1961 the_obj->variant.file_variant.file_size = 0;
1962 the_obj->variant.file_variant.scanned_size = 0;
1963 the_obj->variant.file_variant.shrink_size =
1964 yaffs_max_file_size(dev);
1965 the_obj->variant.file_variant.top_level = 0;
1966 the_obj->variant.file_variant.top = tn;
1968 case YAFFS_OBJECT_TYPE_DIRECTORY:
1969 INIT_LIST_HEAD(&the_obj->variant.dir_variant.children);
1970 INIT_LIST_HEAD(&the_obj->variant.dir_variant.dirty);
1972 case YAFFS_OBJECT_TYPE_SYMLINK:
1973 case YAFFS_OBJECT_TYPE_HARDLINK:
1974 case YAFFS_OBJECT_TYPE_SPECIAL:
1975 /* No action required */
1977 case YAFFS_OBJECT_TYPE_UNKNOWN:
1978 /* todo this should not happen */
1984 static struct yaffs_obj *yaffs_create_fake_dir(struct yaffs_dev *dev,
1985 int number, u32 mode)
1988 struct yaffs_obj *obj =
1989 yaffs_new_obj(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1994 obj->fake = 1; /* it is fake so it might not use NAND */
1995 obj->rename_allowed = 0;
1996 obj->unlink_allowed = 0;
1999 obj->yst_mode = mode;
2001 obj->hdr_chunk = 0; /* Not a valid chunk. */
2007 static void yaffs_init_tnodes_and_objs(struct yaffs_dev *dev)
2013 yaffs_init_raw_tnodes_and_objs(dev);
2015 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2016 INIT_LIST_HEAD(&dev->obj_bucket[i].list);
2017 dev->obj_bucket[i].count = 0;
2021 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
2023 enum yaffs_obj_type type)
2025 struct yaffs_obj *the_obj = NULL;
2028 the_obj = yaffs_find_by_number(dev, number);
2031 the_obj = yaffs_new_obj(dev, number, type);
2037 YCHAR *yaffs_clone_str(const YCHAR *str)
2039 YCHAR *new_str = NULL;
2045 len = strnlen(str, YAFFS_MAX_ALIAS_LENGTH);
2046 new_str = kmalloc((len + 1) * sizeof(YCHAR), GFP_NOFS);
2048 strncpy(new_str, str, len);
2055 *yaffs_update_parent() handles fixing a directories mtime and ctime when a new
2056 * link (ie. name) is created or deleted in the directory.
2059 * create dir/a : update dir's mtime/ctime
2060 * rm dir/a: update dir's mtime/ctime
2061 * modify dir/a: don't update dir's mtimme/ctime
2063 * This can be handled immediately or defered. Defering helps reduce the number
2064 * of updates when many files in a directory are changed within a brief period.
2066 * If the directory updating is defered then yaffs_update_dirty_dirs must be
2067 * called periodically.
2070 static void yaffs_update_parent(struct yaffs_obj *obj)
2072 struct yaffs_dev *dev;
2078 yaffs_load_current_time(obj, 0, 1);
2079 if (dev->param.defered_dir_update) {
2080 struct list_head *link = &obj->variant.dir_variant.dirty;
2082 if (list_empty(link)) {
2083 list_add(link, &dev->dirty_dirs);
2084 yaffs_trace(YAFFS_TRACE_BACKGROUND,
2085 "Added object %d to dirty directories",
2090 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2094 void yaffs_update_dirty_dirs(struct yaffs_dev *dev)
2096 struct list_head *link;
2097 struct yaffs_obj *obj;
2098 struct yaffs_dir_var *d_s;
2099 union yaffs_obj_var *o_v;
2101 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update dirty directories");
2103 while (!list_empty(&dev->dirty_dirs)) {
2104 link = dev->dirty_dirs.next;
2105 list_del_init(link);
2107 d_s = list_entry(link, struct yaffs_dir_var, dirty);
2108 o_v = list_entry(d_s, union yaffs_obj_var, dir_variant);
2109 obj = list_entry(o_v, struct yaffs_obj, variant);
2111 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update directory %d",
2115 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2120 * Mknod (create) a new object.
2121 * equiv_obj only has meaning for a hard link;
2122 * alias_str only has meaning for a symlink.
2123 * rdev only has meaning for devices (a subset of special objects)
2126 static struct yaffs_obj *yaffs_create_obj(enum yaffs_obj_type type,
2127 struct yaffs_obj *parent,
2132 struct yaffs_obj *equiv_obj,
2133 const YCHAR *alias_str, u32 rdev)
2135 struct yaffs_obj *in;
2137 struct yaffs_dev *dev = parent->my_dev;
2139 /* Check if the entry exists.
2140 * If it does then fail the call since we don't want a dup. */
2141 if (yaffs_find_by_name(parent, name))
2144 if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2145 str = yaffs_clone_str(alias_str);
2150 in = yaffs_new_obj(dev, -1, type);
2159 in->variant_type = type;
2161 in->yst_mode = mode;
2163 yaffs_attribs_init(in, gid, uid, rdev);
2165 in->n_data_chunks = 0;
2167 yaffs_set_obj_name(in, name);
2170 yaffs_add_obj_to_dir(parent, in);
2172 in->my_dev = parent->my_dev;
2175 case YAFFS_OBJECT_TYPE_SYMLINK:
2176 in->variant.symlink_variant.alias = str;
2178 case YAFFS_OBJECT_TYPE_HARDLINK:
2179 in->variant.hardlink_variant.equiv_obj = equiv_obj;
2180 in->variant.hardlink_variant.equiv_id = equiv_obj->obj_id;
2181 list_add(&in->hard_links, &equiv_obj->hard_links);
2183 case YAFFS_OBJECT_TYPE_FILE:
2184 case YAFFS_OBJECT_TYPE_DIRECTORY:
2185 case YAFFS_OBJECT_TYPE_SPECIAL:
2186 case YAFFS_OBJECT_TYPE_UNKNOWN:
2191 if (yaffs_update_oh(in, name, 0, 0, 0, NULL) < 0) {
2192 /* Could not create the object header, fail */
2198 yaffs_update_parent(parent);
2203 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
2204 const YCHAR *name, u32 mode, u32 uid,
2207 return yaffs_create_obj(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2208 uid, gid, NULL, NULL, 0);
2211 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
2212 u32 mode, u32 uid, u32 gid)
2214 return yaffs_create_obj(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2215 mode, uid, gid, NULL, NULL, 0);
2218 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
2219 const YCHAR *name, u32 mode, u32 uid,
2222 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2223 uid, gid, NULL, NULL, rdev);
2226 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
2227 const YCHAR *name, u32 mode, u32 uid,
2228 u32 gid, const YCHAR *alias)
2230 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2231 uid, gid, NULL, alias, 0);
2234 /* yaffs_link_obj returns the object id of the equivalent object.*/
2235 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR * name,
2236 struct yaffs_obj *equiv_obj)
2238 /* Get the real object in case we were fed a hard link obj */
2239 equiv_obj = yaffs_get_equivalent_obj(equiv_obj);
2241 if (yaffs_create_obj(YAFFS_OBJECT_TYPE_HARDLINK,
2242 parent, name, 0, 0, 0,
2243 equiv_obj, NULL, 0))
2252 /*---------------------- Block Management and Page Allocation -------------*/
2254 static void yaffs_deinit_blocks(struct yaffs_dev *dev)
2256 if (dev->block_info_alt && dev->block_info)
2257 vfree(dev->block_info);
2259 kfree(dev->block_info);
2261 dev->block_info_alt = 0;
2263 dev->block_info = NULL;
2265 if (dev->chunk_bits_alt && dev->chunk_bits)
2266 vfree(dev->chunk_bits);
2268 kfree(dev->chunk_bits);
2269 dev->chunk_bits_alt = 0;
2270 dev->chunk_bits = NULL;
2273 static int yaffs_init_blocks(struct yaffs_dev *dev)
2275 int n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
2277 dev->block_info = NULL;
2278 dev->chunk_bits = NULL;
2279 dev->alloc_block = -1; /* force it to get a new one */
2281 /* If the first allocation strategy fails, thry the alternate one */
2283 kmalloc(n_blocks * sizeof(struct yaffs_block_info), GFP_NOFS);
2284 if (!dev->block_info) {
2286 vmalloc(n_blocks * sizeof(struct yaffs_block_info));
2287 dev->block_info_alt = 1;
2289 dev->block_info_alt = 0;
2292 if (!dev->block_info)
2295 /* Set up dynamic blockinfo stuff. Round up bytes. */
2296 dev->chunk_bit_stride = (dev->param.chunks_per_block + 7) / 8;
2298 kmalloc(dev->chunk_bit_stride * n_blocks, GFP_NOFS);
2299 if (!dev->chunk_bits) {
2301 vmalloc(dev->chunk_bit_stride * n_blocks);
2302 dev->chunk_bits_alt = 1;
2304 dev->chunk_bits_alt = 0;
2306 if (!dev->chunk_bits)
2310 memset(dev->block_info, 0, n_blocks * sizeof(struct yaffs_block_info));
2311 memset(dev->chunk_bits, 0, dev->chunk_bit_stride * n_blocks);
2315 yaffs_deinit_blocks(dev);
2320 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no)
2322 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block_no);
2326 /* If the block is still healthy erase it and mark as clean.
2327 * If the block has had a data failure, then retire it.
2330 yaffs_trace(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2331 "yaffs_block_became_dirty block %d state %d %s",
2332 block_no, bi->block_state,
2333 (bi->needs_retiring) ? "needs retiring" : "");
2335 yaffs2_clear_oldest_dirty_seq(dev, bi);
2337 bi->block_state = YAFFS_BLOCK_STATE_DIRTY;
2339 /* If this is the block being garbage collected then stop gc'ing */
2340 if (block_no == dev->gc_block)
2343 /* If this block is currently the best candidate for gc
2344 * then drop as a candidate */
2345 if (block_no == dev->gc_dirtiest) {
2346 dev->gc_dirtiest = 0;
2347 dev->gc_pages_in_use = 0;
2350 if (!bi->needs_retiring) {
2351 yaffs2_checkpt_invalidate(dev);
2352 erased_ok = yaffs_erase_block(dev, block_no);
2354 dev->n_erase_failures++;
2355 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2356 "**>> Erasure failed %d", block_no);
2360 /* Verify erasure if needed */
2362 ((yaffs_trace_mask & YAFFS_TRACE_ERASE) ||
2363 !yaffs_skip_verification(dev))) {
2364 for (i = 0; i < dev->param.chunks_per_block; i++) {
2365 if (!yaffs_check_chunk_erased(dev,
2366 block_no * dev->param.chunks_per_block + i)) {
2367 yaffs_trace(YAFFS_TRACE_ERROR,
2368 ">>Block %d erasure supposedly OK, but chunk %d not erased",
2375 /* We lost a block of free space */
2376 dev->n_free_chunks -= dev->param.chunks_per_block;
2377 yaffs_retire_block(dev, block_no);
2378 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2379 "**>> Block %d retired", block_no);
2383 /* Clean it up... */
2384 bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
2386 dev->n_erased_blocks++;
2387 bi->pages_in_use = 0;
2388 bi->soft_del_pages = 0;
2389 bi->has_shrink_hdr = 0;
2390 bi->skip_erased_check = 1; /* Clean, so no need to check */
2391 bi->gc_prioritise = 0;
2392 bi->has_summary = 0;
2394 yaffs_clear_chunk_bits(dev, block_no);
2396 yaffs_trace(YAFFS_TRACE_ERASE, "Erased block %d", block_no);
2399 static inline int yaffs_gc_process_chunk(struct yaffs_dev *dev,
2400 struct yaffs_block_info *bi,
2401 int old_chunk, u8 *buffer)
2405 struct yaffs_ext_tags tags;
2406 struct yaffs_obj *object;
2408 int ret_val = YAFFS_OK;
2410 memset(&tags, 0, sizeof(tags));
2411 yaffs_rd_chunk_tags_nand(dev, old_chunk,
2413 object = yaffs_find_by_number(dev, tags.obj_id);
2415 yaffs_trace(YAFFS_TRACE_GC_DETAIL,
2416 "Collecting chunk in block %d, %d %d %d ",
2417 dev->gc_chunk, tags.obj_id,
2418 tags.chunk_id, tags.n_bytes);
2420 if (object && !yaffs_skip_verification(dev)) {
2421 if (tags.chunk_id == 0)
2424 else if (object->soft_del)
2425 /* Defeat the test */
2426 matching_chunk = old_chunk;
2429 yaffs_find_chunk_in_file
2430 (object, tags.chunk_id,
2433 if (old_chunk != matching_chunk)
2434 yaffs_trace(YAFFS_TRACE_ERROR,
2435 "gc: page in gc mismatch: %d %d %d %d",
2443 yaffs_trace(YAFFS_TRACE_ERROR,
2444 "page %d in gc has no object: %d %d %d ",
2446 tags.obj_id, tags.chunk_id,
2452 object->soft_del && tags.chunk_id != 0) {
2453 /* Data chunk in a soft deleted file,
2455 * It's a soft deleted data chunk,
2456 * No need to copy this, just forget
2457 * about it and fix up the object.
2460 /* Free chunks already includes
2461 * softdeleted chunks, how ever this
2462 * chunk is going to soon be really
2463 * deleted which will increment free
2464 * chunks. We have to decrement free
2465 * chunks so this works out properly.
2467 dev->n_free_chunks--;
2468 bi->soft_del_pages--;
2470 object->n_data_chunks--;
2471 if (object->n_data_chunks <= 0) {
2472 /* remeber to clean up obj */
2473 dev->gc_cleanup_list[dev->n_clean_ups] = tags.obj_id;
2477 } else if (object) {
2478 /* It's either a data chunk in a live
2479 * file or an ObjectHeader, so we're
2481 * NB Need to keep the ObjectHeaders of
2482 * deleted files until the whole file
2483 * has been deleted off
2485 tags.serial_number++;
2488 if (tags.chunk_id == 0) {
2489 /* It is an object Id,
2490 * We need to nuke the
2491 * shrinkheader flags since its
2493 * Also need to clean up
2496 struct yaffs_obj_hdr *oh;
2497 oh = (struct yaffs_obj_hdr *) buffer;
2500 tags.extra_is_shrink = 0;
2501 oh->shadows_obj = 0;
2502 oh->inband_shadowed_obj_id = 0;
2503 tags.extra_shadows = 0;
2505 /* Update file size */
2506 if (object->variant_type == YAFFS_OBJECT_TYPE_FILE) {
2507 yaffs_oh_size_load(oh,
2508 object->variant.file_variant.file_size);
2509 tags.extra_file_size =
2510 object->variant.file_variant.file_size;
2513 yaffs_verify_oh(object, oh, &tags, 1);
2515 yaffs_write_new_chunk(dev, (u8 *) oh, &tags, 1);
2518 yaffs_write_new_chunk(dev, buffer, &tags, 1);
2521 if (new_chunk < 0) {
2522 ret_val = YAFFS_FAIL;
2525 /* Now fix up the Tnodes etc. */
2527 if (tags.chunk_id == 0) {
2529 object->hdr_chunk = new_chunk;
2530 object->serial = tags.serial_number;
2532 /* It's a data chunk */
2533 yaffs_put_chunk_in_file(object, tags.chunk_id,
2538 if (ret_val == YAFFS_OK)
2539 yaffs_chunk_del(dev, old_chunk, mark_flash, __LINE__);
2543 static int yaffs_gc_block(struct yaffs_dev *dev, int block, int whole_block)
2546 int ret_val = YAFFS_OK;
2548 int is_checkpt_block;
2550 int chunks_before = yaffs_get_erased_chunks(dev);
2552 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block);
2554 is_checkpt_block = (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT);
2556 yaffs_trace(YAFFS_TRACE_TRACING,
2557 "Collecting block %d, in use %d, shrink %d, whole_block %d",
2558 block, bi->pages_in_use, bi->has_shrink_hdr,
2561 /*yaffs_verify_free_chunks(dev); */
2563 if (bi->block_state == YAFFS_BLOCK_STATE_FULL)
2564 bi->block_state = YAFFS_BLOCK_STATE_COLLECTING;
2566 bi->has_shrink_hdr = 0; /* clear the flag so that the block can erase */
2568 dev->gc_disable = 1;
2570 yaffs_summary_gc(dev, block);
2572 if (is_checkpt_block || !yaffs_still_some_chunks(dev, block)) {
2573 yaffs_trace(YAFFS_TRACE_TRACING,
2574 "Collecting block %d that has no chunks in use",
2576 yaffs_block_became_dirty(dev, block);
2579 u8 *buffer = yaffs_get_temp_buffer(dev);
2581 yaffs_verify_blk(dev, bi, block);
2583 max_copies = (whole_block) ? dev->param.chunks_per_block : 5;
2584 old_chunk = block * dev->param.chunks_per_block + dev->gc_chunk;
2586 for (/* init already done */ ;
2587 ret_val == YAFFS_OK &&
2588 dev->gc_chunk < dev->param.chunks_per_block &&
2589 (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) &&
2591 dev->gc_chunk++, old_chunk++) {
2592 if (yaffs_check_chunk_bit(dev, block, dev->gc_chunk)) {
2593 /* Page is in use and might need to be copied */
2595 ret_val = yaffs_gc_process_chunk(dev, bi,
2599 yaffs_release_temp_buffer(dev, buffer);
2602 yaffs_verify_collected_blk(dev, bi, block);
2604 if (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2606 * The gc did not complete. Set block state back to FULL
2607 * because checkpointing does not restore gc.
2609 bi->block_state = YAFFS_BLOCK_STATE_FULL;
2611 /* The gc completed. */
2612 /* Do any required cleanups */
2613 for (i = 0; i < dev->n_clean_ups; i++) {
2614 /* Time to delete the file too */
2615 struct yaffs_obj *object =
2616 yaffs_find_by_number(dev, dev->gc_cleanup_list[i]);
2618 yaffs_free_tnode(dev,
2619 object->variant.file_variant.top);
2620 object->variant.file_variant.top = NULL;
2621 yaffs_trace(YAFFS_TRACE_GC,
2622 "yaffs: About to finally delete object %d",
2624 yaffs_generic_obj_del(object);
2625 object->my_dev->n_deleted_files--;
2629 chunks_after = yaffs_get_erased_chunks(dev);
2630 if (chunks_before >= chunks_after)
2631 yaffs_trace(YAFFS_TRACE_GC,
2632 "gc did not increase free chunks before %d after %d",
2633 chunks_before, chunks_after);
2636 dev->n_clean_ups = 0;
2639 dev->gc_disable = 0;
2645 * find_gc_block() selects the dirtiest block (or close enough)
2646 * for garbage collection.
2649 static unsigned yaffs_find_gc_block(struct yaffs_dev *dev,
2650 int aggressive, int background)
2654 unsigned selected = 0;
2655 int prioritised = 0;
2656 int prioritised_exist = 0;
2657 struct yaffs_block_info *bi;
2660 /* First let's see if we need to grab a prioritised block */
2661 if (dev->has_pending_prioritised_gc && !aggressive) {
2662 dev->gc_dirtiest = 0;
2663 bi = dev->block_info;
2664 for (i = dev->internal_start_block;
2665 i <= dev->internal_end_block && !selected; i++) {
2667 if (bi->gc_prioritise) {
2668 prioritised_exist = 1;
2669 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2670 yaffs_block_ok_for_gc(dev, bi)) {
2679 * If there is a prioritised block and none was selected then
2680 * this happened because there is at least one old dirty block
2681 * gumming up the works. Let's gc the oldest dirty block.
2684 if (prioritised_exist &&
2685 !selected && dev->oldest_dirty_block > 0)
2686 selected = dev->oldest_dirty_block;
2688 if (!prioritised_exist) /* None found, so we can clear this */
2689 dev->has_pending_prioritised_gc = 0;
2692 /* If we're doing aggressive GC then we are happy to take a less-dirty
2693 * block, and search harder.
2694 * else (leasurely gc), then we only bother to do this if the
2695 * block has only a few pages in use.
2701 dev->internal_end_block - dev->internal_start_block + 1;
2703 threshold = dev->param.chunks_per_block;
2704 iterations = n_blocks;
2709 max_threshold = dev->param.chunks_per_block / 2;
2711 max_threshold = dev->param.chunks_per_block / 8;
2713 if (max_threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2714 max_threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2716 threshold = background ? (dev->gc_not_done + 2) * 2 : 0;
2717 if (threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2718 threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2719 if (threshold > max_threshold)
2720 threshold = max_threshold;
2722 iterations = n_blocks / 16 + 1;
2723 if (iterations > 100)
2729 (dev->gc_dirtiest < 1 ||
2730 dev->gc_pages_in_use > YAFFS_GC_GOOD_ENOUGH);
2732 dev->gc_block_finder++;
2733 if (dev->gc_block_finder < dev->internal_start_block ||
2734 dev->gc_block_finder > dev->internal_end_block)
2735 dev->gc_block_finder =
2736 dev->internal_start_block;
2738 bi = yaffs_get_block_info(dev, dev->gc_block_finder);
2740 pages_used = bi->pages_in_use - bi->soft_del_pages;
2742 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2743 pages_used < dev->param.chunks_per_block &&
2744 (dev->gc_dirtiest < 1 ||
2745 pages_used < dev->gc_pages_in_use) &&
2746 yaffs_block_ok_for_gc(dev, bi)) {
2747 dev->gc_dirtiest = dev->gc_block_finder;
2748 dev->gc_pages_in_use = pages_used;
2752 if (dev->gc_dirtiest > 0 && dev->gc_pages_in_use <= threshold)
2753 selected = dev->gc_dirtiest;
2757 * If nothing has been selected for a while, try the oldest dirty
2758 * because that's gumming up the works.
2761 if (!selected && dev->param.is_yaffs2 &&
2762 dev->gc_not_done >= (background ? 10 : 20)) {
2763 yaffs2_find_oldest_dirty_seq(dev);
2764 if (dev->oldest_dirty_block > 0) {
2765 selected = dev->oldest_dirty_block;
2766 dev->gc_dirtiest = selected;
2767 dev->oldest_dirty_gc_count++;
2768 bi = yaffs_get_block_info(dev, selected);
2769 dev->gc_pages_in_use =
2770 bi->pages_in_use - bi->soft_del_pages;
2772 dev->gc_not_done = 0;
2777 yaffs_trace(YAFFS_TRACE_GC,
2778 "GC Selected block %d with %d free, prioritised:%d",
2780 dev->param.chunks_per_block - dev->gc_pages_in_use,
2787 dev->gc_dirtiest = 0;
2788 dev->gc_pages_in_use = 0;
2789 dev->gc_not_done = 0;
2790 if (dev->refresh_skip > 0)
2791 dev->refresh_skip--;
2794 yaffs_trace(YAFFS_TRACE_GC,
2795 "GC none: finder %d skip %d threshold %d dirtiest %d using %d oldest %d%s",
2796 dev->gc_block_finder, dev->gc_not_done, threshold,
2797 dev->gc_dirtiest, dev->gc_pages_in_use,
2798 dev->oldest_dirty_block, background ? " bg" : "");
2804 /* New garbage collector
2805 * If we're very low on erased blocks then we do aggressive garbage collection
2806 * otherwise we do "leasurely" garbage collection.
2807 * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2808 * Passive gc only inspects smaller areas and only accepts more dirty blocks.
2810 * The idea is to help clear out space in a more spread-out manner.
2811 * Dunno if it really does anything useful.
2813 static int yaffs_check_gc(struct yaffs_dev *dev, int background)
2816 int gc_ok = YAFFS_OK;
2820 int checkpt_block_adjust;
2822 if (dev->param.gc_control && (dev->param.gc_control(dev) & 1) == 0)
2825 if (dev->gc_disable)
2826 /* Bail out so we don't get recursive gc */
2829 /* This loop should pass the first time.
2830 * Only loops here if the collection does not increase space.
2836 checkpt_block_adjust = yaffs_calc_checkpt_blocks_required(dev);
2839 dev->param.n_reserved_blocks + checkpt_block_adjust + 1;
2841 dev->n_erased_blocks * dev->param.chunks_per_block;
2843 /* If we need a block soon then do aggressive gc. */
2844 if (dev->n_erased_blocks < min_erased)
2848 && erased_chunks > (dev->n_free_chunks / 4))
2851 if (dev->gc_skip > 20)
2853 if (erased_chunks < dev->n_free_chunks / 2 ||
2854 dev->gc_skip < 1 || background)
2864 /* If we don't already have a block being gc'd then see if we
2865 * should start another */
2867 if (dev->gc_block < 1 && !aggressive) {
2868 dev->gc_block = yaffs2_find_refresh_block(dev);
2870 dev->n_clean_ups = 0;
2872 if (dev->gc_block < 1) {
2874 yaffs_find_gc_block(dev, aggressive, background);
2876 dev->n_clean_ups = 0;
2879 if (dev->gc_block > 0) {
2882 dev->passive_gc_count++;
2884 yaffs_trace(YAFFS_TRACE_GC,
2885 "yaffs: GC n_erased_blocks %d aggressive %d",
2886 dev->n_erased_blocks, aggressive);
2888 gc_ok = yaffs_gc_block(dev, dev->gc_block, aggressive);
2891 if (dev->n_erased_blocks < (dev->param.n_reserved_blocks) &&
2892 dev->gc_block > 0) {
2893 yaffs_trace(YAFFS_TRACE_GC,
2894 "yaffs: GC !!!no reclaim!!! n_erased_blocks %d after try %d block %d",
2895 dev->n_erased_blocks, max_tries,
2898 } while ((dev->n_erased_blocks < dev->param.n_reserved_blocks) &&
2899 (dev->gc_block > 0) && (max_tries < 2));
2901 return aggressive ? gc_ok : YAFFS_OK;
2906 * Garbage collects. Intended to be called from a background thread.
2907 * Returns non-zero if at least half the free chunks are erased.
2909 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency)
2911 int erased_chunks = dev->n_erased_blocks * dev->param.chunks_per_block;
2913 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Background gc %u", urgency);
2915 yaffs_check_gc(dev, 1);
2916 return erased_chunks > dev->n_free_chunks / 2;
2919 /*-------------------- Data file manipulation -----------------*/
2921 static int yaffs_rd_data_obj(struct yaffs_obj *in, int inode_chunk, u8 * buffer)
2923 int nand_chunk = yaffs_find_chunk_in_file(in, inode_chunk, NULL);
2925 if (nand_chunk >= 0)
2926 return yaffs_rd_chunk_tags_nand(in->my_dev, nand_chunk,
2929 yaffs_trace(YAFFS_TRACE_NANDACCESS,
2930 "Chunk %d not found zero instead",
2932 /* get sane (zero) data if you read a hole */
2933 memset(buffer, 0, in->my_dev->data_bytes_per_chunk);
2939 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
2944 struct yaffs_ext_tags tags;
2945 struct yaffs_block_info *bi;
2951 block = chunk_id / dev->param.chunks_per_block;
2952 page = chunk_id % dev->param.chunks_per_block;
2954 if (!yaffs_check_chunk_bit(dev, block, page))
2955 yaffs_trace(YAFFS_TRACE_VERIFY,
2956 "Deleting invalid chunk %d", chunk_id);
2958 bi = yaffs_get_block_info(dev, block);
2960 yaffs2_update_oldest_dirty_seq(dev, block, bi);
2962 yaffs_trace(YAFFS_TRACE_DELETION,
2963 "line %d delete of chunk %d",
2966 if (!dev->param.is_yaffs2 && mark_flash &&
2967 bi->block_state != YAFFS_BLOCK_STATE_COLLECTING) {
2969 memset(&tags, 0, sizeof(tags));
2970 tags.is_deleted = 1;
2971 yaffs_wr_chunk_tags_nand(dev, chunk_id, NULL, &tags);
2972 yaffs_handle_chunk_update(dev, chunk_id, &tags);
2974 dev->n_unmarked_deletions++;
2977 /* Pull out of the management area.
2978 * If the whole block became dirty, this will kick off an erasure.
2980 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING ||
2981 bi->block_state == YAFFS_BLOCK_STATE_FULL ||
2982 bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCAN ||
2983 bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2984 dev->n_free_chunks++;
2985 yaffs_clear_chunk_bit(dev, block, page);
2988 if (bi->pages_in_use == 0 &&
2989 !bi->has_shrink_hdr &&
2990 bi->block_state != YAFFS_BLOCK_STATE_ALLOCATING &&
2991 bi->block_state != YAFFS_BLOCK_STATE_NEEDS_SCAN) {
2992 yaffs_block_became_dirty(dev, block);
2997 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
2998 const u8 *buffer, int n_bytes, int use_reserve)
3000 /* Find old chunk Need to do this to get serial number
3001 * Write new one and patch into tree.
3002 * Invalidate old tags.
3006 struct yaffs_ext_tags prev_tags;
3008 struct yaffs_ext_tags new_tags;
3009 struct yaffs_dev *dev = in->my_dev;
3011 yaffs_check_gc(dev, 0);
3013 /* Get the previous chunk at this location in the file if it exists.
3014 * If it does not exist then put a zero into the tree. This creates
3015 * the tnode now, rather than later when it is harder to clean up.
3017 prev_chunk_id = yaffs_find_chunk_in_file(in, inode_chunk, &prev_tags);
3018 if (prev_chunk_id < 1 &&
3019 !yaffs_put_chunk_in_file(in, inode_chunk, 0, 0))
3022 /* Set up new tags */
3023 memset(&new_tags, 0, sizeof(new_tags));
3025 new_tags.chunk_id = inode_chunk;
3026 new_tags.obj_id = in->obj_id;
3027 new_tags.serial_number =
3028 (prev_chunk_id > 0) ? prev_tags.serial_number + 1 : 1;
3029 new_tags.n_bytes = n_bytes;
3031 if (n_bytes < 1 || n_bytes > dev->param.total_bytes_per_chunk) {
3032 yaffs_trace(YAFFS_TRACE_ERROR,
3033 "Writing %d bytes to chunk!!!!!!!!!",
3039 yaffs_write_new_chunk(dev, buffer, &new_tags, use_reserve);
3041 if (new_chunk_id > 0) {
3042 yaffs_put_chunk_in_file(in, inode_chunk, new_chunk_id, 0);
3044 if (prev_chunk_id > 0)
3045 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3047 yaffs_verify_file_sane(in);
3049 return new_chunk_id;
3055 static int yaffs_do_xattrib_mod(struct yaffs_obj *obj, int set,
3056 const YCHAR *name, const void *value, int size,
3059 struct yaffs_xattr_mod xmod;
3067 xmod.result = -ENOSPC;
3069 result = yaffs_update_oh(obj, NULL, 0, 0, 0, &xmod);
3077 static int yaffs_apply_xattrib_mod(struct yaffs_obj *obj, char *buffer,
3078 struct yaffs_xattr_mod *xmod)
3081 int x_offs = sizeof(struct yaffs_obj_hdr);
3082 struct yaffs_dev *dev = obj->my_dev;
3083 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3084 char *x_buffer = buffer + x_offs;
3088 nval_set(x_buffer, x_size, xmod->name, xmod->data,
3089 xmod->size, xmod->flags);
3091 retval = nval_del(x_buffer, x_size, xmod->name);
3093 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3094 obj->xattr_known = 1;
3095 xmod->result = retval;
3100 static int yaffs_do_xattrib_fetch(struct yaffs_obj *obj, const YCHAR *name,
3101 void *value, int size)
3103 char *buffer = NULL;
3105 struct yaffs_ext_tags tags;
3106 struct yaffs_dev *dev = obj->my_dev;
3107 int x_offs = sizeof(struct yaffs_obj_hdr);
3108 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3112 if (obj->hdr_chunk < 1)
3115 /* If we know that the object has no xattribs then don't do all the
3116 * reading and parsing.
3118 if (obj->xattr_known && !obj->has_xattr) {
3125 buffer = (char *)yaffs_get_temp_buffer(dev);
3130 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, (u8 *) buffer, &tags);
3132 if (result != YAFFS_OK)
3135 x_buffer = buffer + x_offs;
3137 if (!obj->xattr_known) {
3138 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3139 obj->xattr_known = 1;
3143 retval = nval_get(x_buffer, x_size, name, value, size);
3145 retval = nval_list(x_buffer, x_size, value, size);
3147 yaffs_release_temp_buffer(dev, (u8 *) buffer);
3151 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR * name,
3152 const void *value, int size, int flags)
3154 return yaffs_do_xattrib_mod(obj, 1, name, value, size, flags);
3157 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR * name)
3159 return yaffs_do_xattrib_mod(obj, 0, name, NULL, 0, 0);
3162 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR * name, void *value,
3165 return yaffs_do_xattrib_fetch(obj, name, value, size);
3168 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size)
3170 return yaffs_do_xattrib_fetch(obj, NULL, buffer, size);
3173 static void yaffs_check_obj_details_loaded(struct yaffs_obj *in)
3176 struct yaffs_obj_hdr *oh;
3177 struct yaffs_dev *dev;
3178 struct yaffs_ext_tags tags;
3180 int alloc_failed = 0;
3182 if (!in || !in->lazy_loaded || in->hdr_chunk < 1)
3186 in->lazy_loaded = 0;
3187 buf = yaffs_get_temp_buffer(dev);
3189 result = yaffs_rd_chunk_tags_nand(dev, in->hdr_chunk, buf, &tags);
3190 oh = (struct yaffs_obj_hdr *)buf;
3192 in->yst_mode = oh->yst_mode;
3193 yaffs_load_attribs(in, oh);
3194 yaffs_set_obj_name_from_oh(in, oh);
3196 if (in->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
3197 in->variant.symlink_variant.alias =
3198 yaffs_clone_str(oh->alias);
3199 if (!in->variant.symlink_variant.alias)
3200 alloc_failed = 1; /* Not returned */
3202 yaffs_release_temp_buffer(dev, buf);
3205 static void yaffs_load_name_from_oh(struct yaffs_dev *dev, YCHAR *name,
3206 const YCHAR *oh_name, int buff_size)
3208 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3209 if (dev->param.auto_unicode) {
3211 /* It is an ASCII name, do an ASCII to
3212 * unicode conversion */
3213 const char *ascii_oh_name = (const char *)oh_name;
3214 int n = buff_size - 1;
3215 while (n > 0 && *ascii_oh_name) {
3216 *name = *ascii_oh_name;
3222 strncpy(name, oh_name + 1, buff_size - 1);
3229 strncpy(name, oh_name, buff_size - 1);
3233 static void yaffs_load_oh_from_name(struct yaffs_dev *dev, YCHAR *oh_name,
3236 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3241 if (dev->param.auto_unicode) {
3246 /* Figure out if the name will fit in ascii character set */
3247 while (is_ascii && *w) {
3254 /* It is an ASCII name, so convert unicode to ascii */
3255 char *ascii_oh_name = (char *)oh_name;
3256 int n = YAFFS_MAX_NAME_LENGTH - 1;
3257 while (n > 0 && *name) {
3258 *ascii_oh_name = *name;
3264 /* Unicode name, so save starting at the second YCHAR */
3266 strncpy(oh_name + 1, name, YAFFS_MAX_NAME_LENGTH - 2);
3273 strncpy(oh_name, name, YAFFS_MAX_NAME_LENGTH - 1);
3277 /* UpdateObjectHeader updates the header on NAND for an object.
3278 * If name is not NULL, then that new name is used.
3280 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name, int force,
3281 int is_shrink, int shadows, struct yaffs_xattr_mod *xmod)
3284 struct yaffs_block_info *bi;
3285 struct yaffs_dev *dev = in->my_dev;
3290 struct yaffs_ext_tags new_tags;
3291 struct yaffs_ext_tags old_tags;
3292 const YCHAR *alias = NULL;
3294 YCHAR old_name[YAFFS_MAX_NAME_LENGTH + 1];
3295 struct yaffs_obj_hdr *oh = NULL;
3296 loff_t file_size = 0;
3298 strcpy(old_name, _Y("silly old name"));
3300 if (in->fake && in != dev->root_dir && !force && !xmod)
3303 yaffs_check_gc(dev, 0);
3304 yaffs_check_obj_details_loaded(in);
3306 buffer = yaffs_get_temp_buffer(in->my_dev);
3307 oh = (struct yaffs_obj_hdr *)buffer;
3309 prev_chunk_id = in->hdr_chunk;
3311 if (prev_chunk_id > 0) {
3312 result = yaffs_rd_chunk_tags_nand(dev, prev_chunk_id,
3315 yaffs_verify_oh(in, oh, &old_tags, 0);
3316 memcpy(old_name, oh->name, sizeof(oh->name));
3317 memset(buffer, 0xff, sizeof(struct yaffs_obj_hdr));
3319 memset(buffer, 0xff, dev->data_bytes_per_chunk);
3322 oh->type = in->variant_type;
3323 oh->yst_mode = in->yst_mode;
3324 oh->shadows_obj = oh->inband_shadowed_obj_id = shadows;
3326 yaffs_load_attribs_oh(oh, in);
3329 oh->parent_obj_id = in->parent->obj_id;
3331 oh->parent_obj_id = 0;
3333 if (name && *name) {
3334 memset(oh->name, 0, sizeof(oh->name));
3335 yaffs_load_oh_from_name(dev, oh->name, name);
3336 } else if (prev_chunk_id > 0) {
3337 memcpy(oh->name, old_name, sizeof(oh->name));
3339 memset(oh->name, 0, sizeof(oh->name));
3342 oh->is_shrink = is_shrink;
3344 switch (in->variant_type) {
3345 case YAFFS_OBJECT_TYPE_UNKNOWN:
3346 /* Should not happen */
3348 case YAFFS_OBJECT_TYPE_FILE:
3349 if (oh->parent_obj_id != YAFFS_OBJECTID_DELETED &&
3350 oh->parent_obj_id != YAFFS_OBJECTID_UNLINKED)
3351 file_size = in->variant.file_variant.file_size;
3352 yaffs_oh_size_load(oh, file_size);
3354 case YAFFS_OBJECT_TYPE_HARDLINK:
3355 oh->equiv_id = in->variant.hardlink_variant.equiv_id;
3357 case YAFFS_OBJECT_TYPE_SPECIAL:
3360 case YAFFS_OBJECT_TYPE_DIRECTORY:
3363 case YAFFS_OBJECT_TYPE_SYMLINK:
3364 alias = in->variant.symlink_variant.alias;
3366 alias = _Y("no alias");
3367 strncpy(oh->alias, alias, YAFFS_MAX_ALIAS_LENGTH);
3368 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3372 /* process any xattrib modifications */
3374 yaffs_apply_xattrib_mod(in, (char *)buffer, xmod);
3377 memset(&new_tags, 0, sizeof(new_tags));
3379 new_tags.chunk_id = 0;
3380 new_tags.obj_id = in->obj_id;
3381 new_tags.serial_number = in->serial;
3383 /* Add extra info for file header */
3384 new_tags.extra_available = 1;
3385 new_tags.extra_parent_id = oh->parent_obj_id;
3386 new_tags.extra_file_size = file_size;
3387 new_tags.extra_is_shrink = oh->is_shrink;
3388 new_tags.extra_equiv_id = oh->equiv_id;
3389 new_tags.extra_shadows = (oh->shadows_obj > 0) ? 1 : 0;
3390 new_tags.extra_obj_type = in->variant_type;
3391 yaffs_verify_oh(in, oh, &new_tags, 1);
3393 /* Create new chunk in NAND */
3395 yaffs_write_new_chunk(dev, buffer, &new_tags,
3396 (prev_chunk_id > 0) ? 1 : 0);
3399 yaffs_release_temp_buffer(dev, buffer);
3401 if (new_chunk_id < 0)
3402 return new_chunk_id;
3404 in->hdr_chunk = new_chunk_id;
3406 if (prev_chunk_id > 0)
3407 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3409 if (!yaffs_obj_cache_dirty(in))
3412 /* If this was a shrink, then mark the block
3413 * that the chunk lives on */
3415 bi = yaffs_get_block_info(in->my_dev,
3417 in->my_dev->param.chunks_per_block);
3418 bi->has_shrink_hdr = 1;