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 static inline 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, "Releasing unmanaged temp buffer");
182 dev->unmanaged_buffer_deallocs++;
188 * Determine if we have a managed buffer.
190 int yaffs_is_managed_tmp_buffer(struct yaffs_dev *dev, const u8 *buffer)
194 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
195 if (dev->temp_buffer[i].buffer == buffer)
199 for (i = 0; i < dev->param.n_caches; i++) {
200 if (dev->cache[i].data == buffer)
204 if (buffer == dev->checkpt_buffer)
207 yaffs_trace(YAFFS_TRACE_ALWAYS,
208 "yaffs: unmaged buffer detected.");
213 * Functions for robustisizing TODO
217 static void yaffs_handle_chunk_wr_ok(struct yaffs_dev *dev, int nand_chunk,
219 const struct yaffs_ext_tags *tags)
222 nand_chunk = nand_chunk;
227 static void yaffs_handle_chunk_update(struct yaffs_dev *dev, int nand_chunk,
228 const struct yaffs_ext_tags *tags)
231 nand_chunk = nand_chunk;
235 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
236 struct yaffs_block_info *bi)
238 if (!bi->gc_prioritise) {
239 bi->gc_prioritise = 1;
240 dev->has_pending_prioritised_gc = 1;
241 bi->chunk_error_strikes++;
243 if (bi->chunk_error_strikes > 3) {
244 bi->needs_retiring = 1; /* Too many stikes, so retire */
245 yaffs_trace(YAFFS_TRACE_ALWAYS,
246 "yaffs: Block struck out");
252 static void yaffs_handle_chunk_wr_error(struct yaffs_dev *dev, int nand_chunk,
255 int flash_block = nand_chunk / dev->param.chunks_per_block;
256 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
258 yaffs_handle_chunk_error(dev, bi);
261 /* Was an actual write failure,
262 * so mark the block for retirement.*/
263 bi->needs_retiring = 1;
264 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
265 "**>> Block %d needs retiring", flash_block);
268 /* Delete the chunk */
269 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
270 yaffs_skip_rest_of_block(dev);
278 * Simple hash function. Needs to have a reasonable spread
281 static inline int yaffs_hash_fn(int n)
284 return n % YAFFS_NOBJECT_BUCKETS;
288 * Access functions to useful fake objects.
289 * Note that root might have a presence in NAND if permissions are set.
292 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev)
294 return dev->root_dir;
297 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev)
299 return dev->lost_n_found;
303 * Erased NAND checking functions
306 int yaffs_check_ff(u8 *buffer, int n_bytes)
308 /* Horrible, slow implementation */
317 static int yaffs_check_chunk_erased(struct yaffs_dev *dev, int nand_chunk)
319 int retval = YAFFS_OK;
320 u8 *data = yaffs_get_temp_buffer(dev);
321 struct yaffs_ext_tags tags;
324 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, data, &tags);
326 if (tags.ecc_result > YAFFS_ECC_RESULT_NO_ERROR)
329 if (!yaffs_check_ff(data, dev->data_bytes_per_chunk) ||
331 yaffs_trace(YAFFS_TRACE_NANDACCESS,
332 "Chunk %d not erased", nand_chunk);
336 yaffs_release_temp_buffer(dev, data);
342 static int yaffs_verify_chunk_written(struct yaffs_dev *dev,
345 struct yaffs_ext_tags *tags)
347 int retval = YAFFS_OK;
348 struct yaffs_ext_tags temp_tags;
349 u8 *buffer = yaffs_get_temp_buffer(dev);
352 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, buffer, &temp_tags);
353 if (memcmp(buffer, data, dev->data_bytes_per_chunk) ||
354 temp_tags.obj_id != tags->obj_id ||
355 temp_tags.chunk_id != tags->chunk_id ||
356 temp_tags.n_bytes != tags->n_bytes)
359 yaffs_release_temp_buffer(dev, buffer);
365 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks)
368 int reserved_blocks = dev->param.n_reserved_blocks;
371 checkpt_blocks = yaffs_calc_checkpt_blocks_required(dev);
374 (reserved_blocks + checkpt_blocks) * dev->param.chunks_per_block;
376 return (dev->n_free_chunks > (reserved_chunks + n_chunks));
379 static int yaffs_find_alloc_block(struct yaffs_dev *dev)
382 struct yaffs_block_info *bi;
384 if (dev->n_erased_blocks < 1) {
385 /* Hoosterman we've got a problem.
386 * Can't get space to gc
388 yaffs_trace(YAFFS_TRACE_ERROR,
389 "yaffs tragedy: no more erased blocks");
394 /* Find an empty block. */
396 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
397 dev->alloc_block_finder++;
398 if (dev->alloc_block_finder < dev->internal_start_block
399 || dev->alloc_block_finder > dev->internal_end_block) {
400 dev->alloc_block_finder = dev->internal_start_block;
403 bi = yaffs_get_block_info(dev, dev->alloc_block_finder);
405 if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
406 bi->block_state = YAFFS_BLOCK_STATE_ALLOCATING;
408 bi->seq_number = dev->seq_number;
409 dev->n_erased_blocks--;
410 yaffs_trace(YAFFS_TRACE_ALLOCATE,
411 "Allocated block %d, seq %d, %d left" ,
412 dev->alloc_block_finder, dev->seq_number,
413 dev->n_erased_blocks);
414 return dev->alloc_block_finder;
418 yaffs_trace(YAFFS_TRACE_ALWAYS,
419 "yaffs tragedy: no more erased blocks, but there should have been %d",
420 dev->n_erased_blocks);
425 static int yaffs_alloc_chunk(struct yaffs_dev *dev, int use_reserver,
426 struct yaffs_block_info **block_ptr)
429 struct yaffs_block_info *bi;
431 if (dev->alloc_block < 0) {
432 /* Get next block to allocate off */
433 dev->alloc_block = yaffs_find_alloc_block(dev);
437 if (!use_reserver && !yaffs_check_alloc_available(dev, 1)) {
438 /* No space unless we're allowed to use the reserve. */
442 if (dev->n_erased_blocks < dev->param.n_reserved_blocks
443 && dev->alloc_page == 0)
444 yaffs_trace(YAFFS_TRACE_ALLOCATE, "Allocating reserve");
446 /* Next page please.... */
447 if (dev->alloc_block >= 0) {
448 bi = yaffs_get_block_info(dev, dev->alloc_block);
450 ret_val = (dev->alloc_block * dev->param.chunks_per_block) +
453 yaffs_set_chunk_bit(dev, dev->alloc_block, dev->alloc_page);
457 dev->n_free_chunks--;
459 /* If the block is full set the state to full */
460 if (dev->alloc_page >= dev->param.chunks_per_block) {
461 bi->block_state = YAFFS_BLOCK_STATE_FULL;
462 dev->alloc_block = -1;
471 yaffs_trace(YAFFS_TRACE_ERROR,
472 "!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!");
477 static int yaffs_get_erased_chunks(struct yaffs_dev *dev)
481 n = dev->n_erased_blocks * dev->param.chunks_per_block;
483 if (dev->alloc_block > 0)
484 n += (dev->param.chunks_per_block - dev->alloc_page);
491 * yaffs_skip_rest_of_block() skips over the rest of the allocation block
492 * if we don't want to write to it.
494 void yaffs_skip_rest_of_block(struct yaffs_dev *dev)
496 struct yaffs_block_info *bi;
498 if (dev->alloc_block > 0) {
499 bi = yaffs_get_block_info(dev, dev->alloc_block);
500 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING) {
501 bi->block_state = YAFFS_BLOCK_STATE_FULL;
502 dev->alloc_block = -1;
507 static int yaffs_write_new_chunk(struct yaffs_dev *dev,
509 struct yaffs_ext_tags *tags, int use_reserver)
515 yaffs2_checkpt_invalidate(dev);
518 struct yaffs_block_info *bi = 0;
521 chunk = yaffs_alloc_chunk(dev, use_reserver, &bi);
527 /* First check this chunk is erased, if it needs
528 * checking. The checking policy (unless forced
529 * always on) is as follows:
531 * Check the first page we try to write in a block.
532 * If the check passes then we don't need to check any
533 * more. If the check fails, we check again...
534 * If the block has been erased, we don't need to check.
536 * However, if the block has been prioritised for gc,
537 * then we think there might be something odd about
538 * this block and stop using it.
540 * Rationale: We should only ever see chunks that have
541 * not been erased if there was a partially written
542 * chunk due to power loss. This checking policy should
543 * catch that case with very few checks and thus save a
544 * lot of checks that are most likely not needed.
547 * If an erase check fails or the write fails we skip the
551 /* let's give it a try */
554 if (dev->param.always_check_erased)
555 bi->skip_erased_check = 0;
557 if (!bi->skip_erased_check) {
558 erased_ok = yaffs_check_chunk_erased(dev, chunk);
559 if (erased_ok != YAFFS_OK) {
560 yaffs_trace(YAFFS_TRACE_ERROR,
561 "**>> yaffs chunk %d was not erased",
564 /* If not erased, delete this one,
565 * skip rest of block and
566 * try another chunk */
567 yaffs_chunk_del(dev, chunk, 1, __LINE__);
568 yaffs_skip_rest_of_block(dev);
573 write_ok = yaffs_wr_chunk_tags_nand(dev, chunk, data, tags);
575 if (!bi->skip_erased_check)
577 yaffs_verify_chunk_written(dev, chunk, data, tags);
579 if (write_ok != YAFFS_OK) {
580 /* Clean up aborted write, skip to next block and
581 * try another chunk */
582 yaffs_handle_chunk_wr_error(dev, chunk, erased_ok);
586 bi->skip_erased_check = 1;
588 /* Copy the data into the robustification buffer */
589 yaffs_handle_chunk_wr_ok(dev, chunk, data, tags);
591 } while (write_ok != YAFFS_OK &&
592 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
598 yaffs_trace(YAFFS_TRACE_ERROR,
599 "**>> yaffs write required %d attempts",
601 dev->n_retired_writes += (attempts - 1);
608 * Block retiring for handling a broken block.
611 static void yaffs_retire_block(struct yaffs_dev *dev, int flash_block)
613 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
615 yaffs2_checkpt_invalidate(dev);
617 yaffs2_clear_oldest_dirty_seq(dev, bi);
619 if (yaffs_mark_bad(dev, flash_block) != YAFFS_OK) {
620 if (yaffs_erase_block(dev, flash_block) != YAFFS_OK) {
621 yaffs_trace(YAFFS_TRACE_ALWAYS,
622 "yaffs: Failed to mark bad and erase block %d",
625 struct yaffs_ext_tags tags;
627 flash_block * dev->param.chunks_per_block;
629 u8 *buffer = yaffs_get_temp_buffer(dev);
631 memset(buffer, 0xff, dev->data_bytes_per_chunk);
632 memset(&tags, 0, sizeof(tags));
633 tags.seq_number = YAFFS_SEQUENCE_BAD_BLOCK;
634 if (dev->param.write_chunk_tags_fn(dev, chunk_id -
638 yaffs_trace(YAFFS_TRACE_ALWAYS,
639 "yaffs: Failed to write bad block marker to block %d",
642 yaffs_release_temp_buffer(dev, buffer);
646 bi->block_state = YAFFS_BLOCK_STATE_DEAD;
647 bi->gc_prioritise = 0;
648 bi->needs_retiring = 0;
650 dev->n_retired_blocks++;
653 /*---------------- Name handling functions ------------*/
655 static u16 yaffs_calc_name_sum(const YCHAR *name)
663 while ((*name) && i < (YAFFS_MAX_NAME_LENGTH / 2)) {
665 /* 0x1f mask is case insensitive */
666 sum += ((*name) & 0x1f) * i;
673 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR * name)
675 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
676 memset(obj->short_name, 0, sizeof(obj->short_name));
678 strnlen(name, YAFFS_SHORT_NAME_LENGTH + 1) <=
679 YAFFS_SHORT_NAME_LENGTH)
680 strcpy(obj->short_name, name);
682 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 /*-------------------- TNODES -------------------
703 * List of spare tnodes
704 * The list is hooked together using the first pointer
708 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev)
710 struct yaffs_tnode *tn = yaffs_alloc_raw_tnode(dev);
713 memset(tn, 0, dev->tnode_size);
717 dev->checkpoint_blocks_required = 0; /* force recalculation */
722 /* FreeTnode frees up a tnode and puts it back on the free list */
723 static void yaffs_free_tnode(struct yaffs_dev *dev, struct yaffs_tnode *tn)
725 yaffs_free_raw_tnode(dev, tn);
727 dev->checkpoint_blocks_required = 0; /* force recalculation */
730 static void yaffs_deinit_tnodes_and_objs(struct yaffs_dev *dev)
732 yaffs_deinit_raw_tnodes_and_objs(dev);
737 void yaffs_load_tnode_0(struct yaffs_dev *dev, struct yaffs_tnode *tn,
738 unsigned pos, unsigned val)
740 u32 *map = (u32 *) tn;
746 pos &= YAFFS_TNODES_LEVEL0_MASK;
747 val >>= dev->chunk_grp_bits;
749 bit_in_map = pos * dev->tnode_width;
750 word_in_map = bit_in_map / 32;
751 bit_in_word = bit_in_map & (32 - 1);
753 mask = dev->tnode_mask << bit_in_word;
755 map[word_in_map] &= ~mask;
756 map[word_in_map] |= (mask & (val << bit_in_word));
758 if (dev->tnode_width > (32 - bit_in_word)) {
759 bit_in_word = (32 - bit_in_word);
762 dev->tnode_mask >> bit_in_word;
763 map[word_in_map] &= ~mask;
764 map[word_in_map] |= (mask & (val >> bit_in_word));
768 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
771 u32 *map = (u32 *) tn;
777 pos &= YAFFS_TNODES_LEVEL0_MASK;
779 bit_in_map = pos * dev->tnode_width;
780 word_in_map = bit_in_map / 32;
781 bit_in_word = bit_in_map & (32 - 1);
783 val = map[word_in_map] >> bit_in_word;
785 if (dev->tnode_width > (32 - bit_in_word)) {
786 bit_in_word = (32 - bit_in_word);
788 val |= (map[word_in_map] << bit_in_word);
791 val &= dev->tnode_mask;
792 val <<= dev->chunk_grp_bits;
797 /* ------------------- End of individual tnode manipulation -----------------*/
799 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
800 * The look up tree is represented by the top tnode and the number of top_level
801 * in the tree. 0 means only the level 0 tnode is in the tree.
804 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
805 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
806 struct yaffs_file_var *file_struct,
809 struct yaffs_tnode *tn = file_struct->top;
812 int level = file_struct->top_level;
816 /* Check sane level and chunk Id */
817 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
820 if (chunk_id > YAFFS_MAX_CHUNK_ID)
823 /* First check we're tall enough (ie enough top_level) */
825 i = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
828 i >>= YAFFS_TNODES_INTERNAL_BITS;
832 if (required_depth > file_struct->top_level)
833 return NULL; /* Not tall enough, so we can't find it */
835 /* Traverse down to level 0 */
836 while (level > 0 && tn) {
837 tn = tn->internal[(chunk_id >>
838 (YAFFS_TNODES_LEVEL0_BITS +
840 YAFFS_TNODES_INTERNAL_BITS)) &
841 YAFFS_TNODES_INTERNAL_MASK];
848 /* add_find_tnode_0 finds the level 0 tnode if it exists,
849 * otherwise first expands the tree.
850 * This happens in two steps:
851 * 1. If the tree isn't tall enough, then make it taller.
852 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
854 * Used when modifying the tree.
856 * If the tn argument is NULL, then a fresh tnode will be added otherwise the
857 * specified tn will be plugged into the ttree.
860 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
861 struct yaffs_file_var *file_struct,
863 struct yaffs_tnode *passed_tn)
868 struct yaffs_tnode *tn;
871 /* Check sane level and page Id */
872 if (file_struct->top_level < 0 ||
873 file_struct->top_level > YAFFS_TNODES_MAX_LEVEL)
876 if (chunk_id > YAFFS_MAX_CHUNK_ID)
879 /* First check we're tall enough (ie enough top_level) */
881 x = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
884 x >>= YAFFS_TNODES_INTERNAL_BITS;
888 if (required_depth > file_struct->top_level) {
889 /* Not tall enough, gotta make the tree taller */
890 for (i = file_struct->top_level; i < required_depth; i++) {
892 tn = yaffs_get_tnode(dev);
895 tn->internal[0] = file_struct->top;
896 file_struct->top = tn;
897 file_struct->top_level++;
899 yaffs_trace(YAFFS_TRACE_ERROR,
900 "yaffs: no more tnodes");
906 /* Traverse down to level 0, adding anything we need */
908 l = file_struct->top_level;
909 tn = file_struct->top;
912 while (l > 0 && tn) {
914 (YAFFS_TNODES_LEVEL0_BITS +
915 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
916 YAFFS_TNODES_INTERNAL_MASK;
918 if ((l > 1) && !tn->internal[x]) {
919 /* Add missing non-level-zero tnode */
920 tn->internal[x] = yaffs_get_tnode(dev);
921 if (!tn->internal[x])
924 /* Looking from level 1 at level 0 */
926 /* If we already have one, release it */
928 yaffs_free_tnode(dev,
930 tn->internal[x] = passed_tn;
932 } else if (!tn->internal[x]) {
933 /* Don't have one, none passed in */
934 tn->internal[x] = yaffs_get_tnode(dev);
935 if (!tn->internal[x])
940 tn = tn->internal[x];
946 memcpy(tn, passed_tn,
947 (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8);
948 yaffs_free_tnode(dev, passed_tn);
955 static int yaffs_tags_match(const struct yaffs_ext_tags *tags, int obj_id,
958 return (tags->chunk_id == chunk_obj &&
959 tags->obj_id == obj_id &&
960 !tags->is_deleted) ? 1 : 0;
964 static int yaffs_find_chunk_in_group(struct yaffs_dev *dev, int the_chunk,
965 struct yaffs_ext_tags *tags, int obj_id,
970 for (j = 0; the_chunk && j < dev->chunk_grp_size; j++) {
971 if (yaffs_check_chunk_bit
972 (dev, the_chunk / dev->param.chunks_per_block,
973 the_chunk % dev->param.chunks_per_block)) {
975 if (dev->chunk_grp_size == 1)
978 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
980 if (yaffs_tags_match(tags,
981 obj_id, inode_chunk)) {
992 static int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
993 struct yaffs_ext_tags *tags)
995 /*Get the Tnode, then get the level 0 offset chunk offset */
996 struct yaffs_tnode *tn;
998 struct yaffs_ext_tags local_tags;
1000 struct yaffs_dev *dev = in->my_dev;
1003 /* Passed a NULL, so use our own tags space */
1007 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1012 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1014 ret_val = yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1019 static int yaffs_find_del_file_chunk(struct yaffs_obj *in, int inode_chunk,
1020 struct yaffs_ext_tags *tags)
1022 /* Get the Tnode, then get the level 0 offset chunk offset */
1023 struct yaffs_tnode *tn;
1025 struct yaffs_ext_tags local_tags;
1026 struct yaffs_dev *dev = in->my_dev;
1030 /* Passed a NULL, so use our own tags space */
1034 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1039 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1041 ret_val = yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1044 /* Delete the entry in the filestructure (if found) */
1046 yaffs_load_tnode_0(dev, tn, inode_chunk, 0);
1051 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1052 int nand_chunk, int in_scan)
1054 /* NB in_scan is zero unless scanning.
1055 * For forward scanning, in_scan is > 0;
1056 * for backward scanning in_scan is < 0
1058 * nand_chunk = 0 is a dummy insert to make sure the tnodes are there.
1061 struct yaffs_tnode *tn;
1062 struct yaffs_dev *dev = in->my_dev;
1064 struct yaffs_ext_tags existing_tags;
1065 struct yaffs_ext_tags new_tags;
1066 unsigned existing_serial, new_serial;
1068 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE) {
1069 /* Just ignore an attempt at putting a chunk into a non-file
1071 * If it is not during Scanning then something went wrong!
1074 yaffs_trace(YAFFS_TRACE_ERROR,
1075 "yaffs tragedy:attempt to put data chunk into a non-file"
1080 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1084 tn = yaffs_add_find_tnode_0(dev,
1085 &in->variant.file_variant,
1091 /* Dummy insert, bail now */
1094 existing_cunk = yaffs_get_group_base(dev, tn, inode_chunk);
1097 /* If we're scanning then we need to test for duplicates
1098 * NB This does not need to be efficient since it should only
1099 * happen when the power fails during a write, then only one
1100 * chunk should ever be affected.
1102 * Correction for YAFFS2: This could happen quite a lot and we
1103 * need to think about efficiency! TODO
1104 * Update: For backward scanning we don't need to re-read tags
1105 * so this is quite cheap.
1108 if (existing_cunk > 0) {
1109 /* NB Right now existing chunk will not be real
1110 * chunk_id if the chunk group size > 1
1111 * thus we have to do a FindChunkInFile to get the
1114 * We have a duplicate now we need to decide which
1117 * Backwards scanning YAFFS2: The old one is what
1118 * we use, dump the new one.
1119 * YAFFS1: Get both sets of tags and compare serial
1124 /* Only do this for forward scanning */
1125 yaffs_rd_chunk_tags_nand(dev,
1129 /* Do a proper find */
1131 yaffs_find_chunk_in_file(in, inode_chunk,
1135 if (existing_cunk <= 0) {
1136 /*Hoosterman - how did this happen? */
1138 yaffs_trace(YAFFS_TRACE_ERROR,
1139 "yaffs tragedy: existing chunk < 0 in scan"
1144 /* NB The deleted flags should be false, otherwise
1145 * the chunks will not be loaded during a scan
1149 new_serial = new_tags.serial_number;
1150 existing_serial = existing_tags.serial_number;
1153 if ((in_scan > 0) &&
1154 (existing_cunk <= 0 ||
1155 ((existing_serial + 1) & 3) == new_serial)) {
1156 /* Forward scanning.
1158 * Delete the old one and drop through to
1161 yaffs_chunk_del(dev, existing_cunk, 1,
1164 /* Backward scanning or we want to use the
1166 * Delete the new one and return early so that
1167 * the tnode isn't changed
1169 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1176 if (existing_cunk == 0)
1177 in->n_data_chunks++;
1179 yaffs_load_tnode_0(dev, tn, inode_chunk, nand_chunk);
1184 static void yaffs_soft_del_chunk(struct yaffs_dev *dev, int chunk)
1186 struct yaffs_block_info *the_block;
1189 yaffs_trace(YAFFS_TRACE_DELETION, "soft delete chunk %d", chunk);
1191 block_no = chunk / dev->param.chunks_per_block;
1192 the_block = yaffs_get_block_info(dev, block_no);
1194 the_block->soft_del_pages++;
1195 dev->n_free_chunks++;
1196 yaffs2_update_oldest_dirty_seq(dev, block_no, the_block);
1200 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all
1201 * the chunks in the file.
1202 * All soft deleting does is increment the block's softdelete count and pulls
1203 * the chunk out of the tnode.
1204 * Thus, essentially this is the same as DeleteWorker except that the chunks
1208 static int yaffs_soft_del_worker(struct yaffs_obj *in, struct yaffs_tnode *tn,
1209 u32 level, int chunk_offset)
1214 struct yaffs_dev *dev = in->my_dev;
1220 for (i = YAFFS_NTNODES_INTERNAL - 1;
1223 if (tn->internal[i]) {
1225 yaffs_soft_del_worker(in,
1229 YAFFS_TNODES_INTERNAL_BITS)
1232 yaffs_free_tnode(dev,
1234 tn->internal[i] = NULL;
1236 /* Can this happen? */
1240 return (all_done) ? 1 : 0;
1244 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1245 the_chunk = yaffs_get_group_base(dev, tn, i);
1247 yaffs_soft_del_chunk(dev, the_chunk);
1248 yaffs_load_tnode_0(dev, tn, i, 0);
1254 static void yaffs_remove_obj_from_dir(struct yaffs_obj *obj)
1256 struct yaffs_dev *dev = obj->my_dev;
1257 struct yaffs_obj *parent;
1259 yaffs_verify_obj_in_dir(obj);
1260 parent = obj->parent;
1262 yaffs_verify_dir(parent);
1264 if (dev && dev->param.remove_obj_fn)
1265 dev->param.remove_obj_fn(obj);
1267 list_del_init(&obj->siblings);
1270 yaffs_verify_dir(parent);
1273 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj)
1276 yaffs_trace(YAFFS_TRACE_ALWAYS,
1277 "tragedy: Trying to add an object to a null pointer directory"
1282 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1283 yaffs_trace(YAFFS_TRACE_ALWAYS,
1284 "tragedy: Trying to add an object to a non-directory"
1289 if (obj->siblings.prev == NULL) {
1290 /* Not initialised */
1294 yaffs_verify_dir(directory);
1296 yaffs_remove_obj_from_dir(obj);
1299 list_add(&obj->siblings, &directory->variant.dir_variant.children);
1300 obj->parent = directory;
1302 if (directory == obj->my_dev->unlinked_dir
1303 || directory == obj->my_dev->del_dir) {
1305 obj->my_dev->n_unlinked_files++;
1306 obj->rename_allowed = 0;
1309 yaffs_verify_dir(directory);
1310 yaffs_verify_obj_in_dir(obj);
1313 static int yaffs_change_obj_name(struct yaffs_obj *obj,
1314 struct yaffs_obj *new_dir,
1315 const YCHAR *new_name, int force, int shadows)
1319 struct yaffs_obj *existing_target;
1321 if (new_dir == NULL)
1322 new_dir = obj->parent; /* use the old directory */
1324 if (new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1325 yaffs_trace(YAFFS_TRACE_ALWAYS,
1326 "tragedy: yaffs_change_obj_name: new_dir is not a directory"
1331 unlink_op = (new_dir == obj->my_dev->unlinked_dir);
1332 del_op = (new_dir == obj->my_dev->del_dir);
1334 existing_target = yaffs_find_by_name(new_dir, new_name);
1336 /* If the object is a file going into the unlinked directory,
1337 * then it is OK to just stuff it in since duplicate names are OK.
1338 * else only proceed if the new name does not exist and we're putting
1339 * it into a directory.
1341 if (!(unlink_op || del_op || force ||
1342 shadows > 0 || !existing_target) ||
1343 new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
1346 yaffs_set_obj_name(obj, new_name);
1348 yaffs_add_obj_to_dir(new_dir, obj);
1353 /* If it is a deletion then we mark it as a shrink for gc */
1354 if (yaffs_update_oh(obj, new_name, 0, del_op, shadows, NULL) >= 0)
1360 /*------------------------ Short Operations Cache ------------------------------
1361 * In many situations where there is no high level buffering a lot of
1362 * reads might be short sequential reads, and a lot of writes may be short
1363 * sequential writes. eg. scanning/writing a jpeg file.
1364 * In these cases, a short read/write cache can provide a huge perfomance
1365 * benefit with dumb-as-a-rock code.
1366 * In Linux, the page cache provides read buffering and the short op cache
1367 * provides write buffering.
1369 * There are a small number (~10) of cache chunks per device so that we don't
1370 * need a very intelligent search.
1373 static int yaffs_obj_cache_dirty(struct yaffs_obj *obj)
1375 struct yaffs_dev *dev = obj->my_dev;
1377 struct yaffs_cache *cache;
1378 int n_caches = obj->my_dev->param.n_caches;
1380 for (i = 0; i < n_caches; i++) {
1381 cache = &dev->cache[i];
1382 if (cache->object == obj && cache->dirty)
1389 static void yaffs_flush_file_cache(struct yaffs_obj *obj)
1391 struct yaffs_dev *dev = obj->my_dev;
1392 int lowest = -99; /* Stop compiler whining. */
1394 struct yaffs_cache *cache;
1395 int chunk_written = 0;
1396 int n_caches = obj->my_dev->param.n_caches;
1403 /* Find the lowest dirty chunk for this object */
1404 for (i = 0; i < n_caches; i++) {
1405 if (dev->cache[i].object == obj &&
1406 dev->cache[i].dirty) {
1408 dev->cache[i].chunk_id < lowest) {
1409 cache = &dev->cache[i];
1410 lowest = cache->chunk_id;
1415 if (cache && !cache->locked) {
1416 /* Write it out and free it up */
1418 yaffs_wr_data_obj(cache->object,
1423 cache->object = NULL;
1425 } while (cache && chunk_written > 0);
1428 /* Hoosterman, disk full while writing cache out. */
1429 yaffs_trace(YAFFS_TRACE_ERROR,
1430 "yaffs tragedy: no space during cache write");
1433 /*yaffs_flush_whole_cache(dev)
1438 void yaffs_flush_whole_cache(struct yaffs_dev *dev)
1440 struct yaffs_obj *obj;
1441 int n_caches = dev->param.n_caches;
1444 /* Find a dirty object in the cache and flush it...
1445 * until there are no further dirty objects.
1449 for (i = 0; i < n_caches && !obj; i++) {
1450 if (dev->cache[i].object && dev->cache[i].dirty)
1451 obj = dev->cache[i].object;
1454 yaffs_flush_file_cache(obj);
1459 /* Grab us a cache chunk for use.
1460 * First look for an empty one.
1461 * Then look for the least recently used non-dirty one.
1462 * Then look for the least recently used dirty one...., flush and look again.
1464 static struct yaffs_cache *yaffs_grab_chunk_worker(struct yaffs_dev *dev)
1468 if (dev->param.n_caches > 0) {
1469 for (i = 0; i < dev->param.n_caches; i++) {
1470 if (!dev->cache[i].object)
1471 return &dev->cache[i];
1477 static struct yaffs_cache *yaffs_grab_chunk_cache(struct yaffs_dev *dev)
1479 struct yaffs_cache *cache;
1480 struct yaffs_obj *the_obj;
1485 if (dev->param.n_caches < 1)
1488 /* Try find a non-dirty one... */
1490 cache = yaffs_grab_chunk_worker(dev);
1493 /* They were all dirty, find the LRU object and flush
1494 * its cache, then find again.
1495 * NB what's here is not very accurate,
1496 * we actually flush the object with the LRU chunk.
1499 /* With locking we can't assume we can use entry zero,
1500 * Set the_obj to a valid pointer for Coverity. */
1501 the_obj = dev->cache[0].object;
1506 for (i = 0; i < dev->param.n_caches; i++) {
1507 if (dev->cache[i].object &&
1508 !dev->cache[i].locked &&
1509 (dev->cache[i].last_use < usage ||
1511 usage = dev->cache[i].last_use;
1512 the_obj = dev->cache[i].object;
1513 cache = &dev->cache[i];
1518 if (!cache || cache->dirty) {
1519 /* Flush and try again */
1520 yaffs_flush_file_cache(the_obj);
1521 cache = yaffs_grab_chunk_worker(dev);
1527 /* Find a cached chunk */
1528 static struct yaffs_cache *yaffs_find_chunk_cache(const struct yaffs_obj *obj,
1531 struct yaffs_dev *dev = obj->my_dev;
1534 if (dev->param.n_caches < 1)
1537 for (i = 0; i < dev->param.n_caches; i++) {
1538 if (dev->cache[i].object == obj &&
1539 dev->cache[i].chunk_id == chunk_id) {
1542 return &dev->cache[i];
1548 /* Mark the chunk for the least recently used algorithym */
1549 static void yaffs_use_cache(struct yaffs_dev *dev, struct yaffs_cache *cache,
1554 if (dev->param.n_caches < 1)
1557 if (dev->cache_last_use < 0 ||
1558 dev->cache_last_use > 100000000) {
1559 /* Reset the cache usages */
1560 for (i = 1; i < dev->param.n_caches; i++)
1561 dev->cache[i].last_use = 0;
1563 dev->cache_last_use = 0;
1565 dev->cache_last_use++;
1566 cache->last_use = dev->cache_last_use;
1572 /* Invalidate a single cache page.
1573 * Do this when a whole page gets written,
1574 * ie the short cache for this page is no longer valid.
1576 static void yaffs_invalidate_chunk_cache(struct yaffs_obj *object, int chunk_id)
1578 struct yaffs_cache *cache;
1580 if (object->my_dev->param.n_caches > 0) {
1581 cache = yaffs_find_chunk_cache(object, chunk_id);
1584 cache->object = NULL;
1588 /* Invalidate all the cache pages associated with this object
1589 * Do this whenever ther file is deleted or resized.
1591 static void yaffs_invalidate_whole_cache(struct yaffs_obj *in)
1594 struct yaffs_dev *dev = in->my_dev;
1596 if (dev->param.n_caches > 0) {
1597 /* Invalidate it. */
1598 for (i = 0; i < dev->param.n_caches; i++) {
1599 if (dev->cache[i].object == in)
1600 dev->cache[i].object = NULL;
1605 static void yaffs_unhash_obj(struct yaffs_obj *obj)
1608 struct yaffs_dev *dev = obj->my_dev;
1610 /* If it is still linked into the bucket list, free from the list */
1611 if (!list_empty(&obj->hash_link)) {
1612 list_del_init(&obj->hash_link);
1613 bucket = yaffs_hash_fn(obj->obj_id);
1614 dev->obj_bucket[bucket].count--;
1618 /* FreeObject frees up a Object and puts it back on the free list */
1619 static void yaffs_free_obj(struct yaffs_obj *obj)
1621 struct yaffs_dev *dev;
1628 yaffs_trace(YAFFS_TRACE_OS, "FreeObject %p inode %p",
1629 obj, obj->my_inode);
1632 if (!list_empty(&obj->siblings))
1635 if (obj->my_inode) {
1636 /* We're still hooked up to a cached inode.
1637 * Don't delete now, but mark for later deletion
1639 obj->defered_free = 1;
1643 yaffs_unhash_obj(obj);
1645 yaffs_free_raw_obj(dev, obj);
1647 dev->checkpoint_blocks_required = 0; /* force recalculation */
1650 void yaffs_handle_defered_free(struct yaffs_obj *obj)
1652 if (obj->defered_free)
1653 yaffs_free_obj(obj);
1656 static int yaffs_generic_obj_del(struct yaffs_obj *in)
1658 /* Iinvalidate the file's data in the cache, without flushing. */
1659 yaffs_invalidate_whole_cache(in);
1661 if (in->my_dev->param.is_yaffs2 && in->parent != in->my_dev->del_dir) {
1662 /* Move to unlinked directory so we have a deletion record */
1663 yaffs_change_obj_name(in, in->my_dev->del_dir, _Y("deleted"), 0,
1667 yaffs_remove_obj_from_dir(in);
1668 yaffs_chunk_del(in->my_dev, in->hdr_chunk, 1, __LINE__);
1676 static void yaffs_soft_del_file(struct yaffs_obj *obj)
1678 if (!obj->deleted ||
1679 obj->variant_type != YAFFS_OBJECT_TYPE_FILE ||
1683 if (obj->n_data_chunks <= 0) {
1684 /* Empty file with no duplicate object headers,
1685 * just delete it immediately */
1686 yaffs_free_tnode(obj->my_dev, obj->variant.file_variant.top);
1687 obj->variant.file_variant.top = NULL;
1688 yaffs_trace(YAFFS_TRACE_TRACING,
1689 "yaffs: Deleting empty file %d",
1691 yaffs_generic_obj_del(obj);
1693 yaffs_soft_del_worker(obj,
1694 obj->variant.file_variant.top,
1696 file_variant.top_level, 0);
1701 /* Pruning removes any part of the file structure tree that is beyond the
1702 * bounds of the file (ie that does not point to chunks).
1704 * A file should only get pruned when its size is reduced.
1706 * Before pruning, the chunks must be pulled from the tree and the
1707 * level 0 tnode entries must be zeroed out.
1708 * Could also use this for file deletion, but that's probably better handled
1709 * by a special case.
1711 * This function is recursive. For levels > 0 the function is called again on
1712 * any sub-tree. For level == 0 we just check if the sub-tree has data.
1713 * If there is no data in a subtree then it is pruned.
1716 static struct yaffs_tnode *yaffs_prune_worker(struct yaffs_dev *dev,
1717 struct yaffs_tnode *tn, u32 level,
1729 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1730 if (tn->internal[i]) {
1732 yaffs_prune_worker(dev,
1735 (i == 0) ? del0 : 1);
1738 if (tn->internal[i])
1742 int tnode_size_u32 = dev->tnode_size / sizeof(u32);
1743 u32 *map = (u32 *) tn;
1745 for (i = 0; !has_data && i < tnode_size_u32; i++) {
1751 if (has_data == 0 && del0) {
1752 /* Free and return NULL */
1753 yaffs_free_tnode(dev, tn);
1759 static int yaffs_prune_tree(struct yaffs_dev *dev,
1760 struct yaffs_file_var *file_struct)
1765 struct yaffs_tnode *tn;
1767 if (file_struct->top_level < 1)
1771 yaffs_prune_worker(dev, file_struct->top, file_struct->top_level, 0);
1773 /* Now we have a tree with all the non-zero branches NULL but
1774 * the height is the same as it was.
1775 * Let's see if we can trim internal tnodes to shorten the tree.
1776 * We can do this if only the 0th element in the tnode is in use
1777 * (ie all the non-zero are NULL)
1780 while (file_struct->top_level && !done) {
1781 tn = file_struct->top;
1784 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1785 if (tn->internal[i])
1790 file_struct->top = tn->internal[0];
1791 file_struct->top_level--;
1792 yaffs_free_tnode(dev, tn);
1801 /*-------------------- End of File Structure functions.-------------------*/
1803 /* alloc_empty_obj gets us a clean Object.*/
1804 static struct yaffs_obj *yaffs_alloc_empty_obj(struct yaffs_dev *dev)
1806 struct yaffs_obj *obj = yaffs_alloc_raw_obj(dev);
1813 /* Now sweeten it up... */
1815 memset(obj, 0, sizeof(struct yaffs_obj));
1816 obj->being_created = 1;
1820 obj->variant_type = YAFFS_OBJECT_TYPE_UNKNOWN;
1821 INIT_LIST_HEAD(&(obj->hard_links));
1822 INIT_LIST_HEAD(&(obj->hash_link));
1823 INIT_LIST_HEAD(&obj->siblings);
1825 /* Now make the directory sane */
1826 if (dev->root_dir) {
1827 obj->parent = dev->root_dir;
1828 list_add(&(obj->siblings),
1829 &dev->root_dir->variant.dir_variant.children);
1832 /* Add it to the lost and found directory.
1833 * NB Can't put root or lost-n-found in lost-n-found so
1834 * check if lost-n-found exists first
1836 if (dev->lost_n_found)
1837 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
1839 obj->being_created = 0;
1841 dev->checkpoint_blocks_required = 0; /* force recalculation */
1846 static int yaffs_find_nice_bucket(struct yaffs_dev *dev)
1850 int lowest = 999999;
1852 /* Search for the shortest list or one that
1856 for (i = 0; i < 10 && lowest > 4; i++) {
1857 dev->bucket_finder++;
1858 dev->bucket_finder %= YAFFS_NOBJECT_BUCKETS;
1859 if (dev->obj_bucket[dev->bucket_finder].count < lowest) {
1860 lowest = dev->obj_bucket[dev->bucket_finder].count;
1861 l = dev->bucket_finder;
1868 static int yaffs_new_obj_id(struct yaffs_dev *dev)
1870 int bucket = yaffs_find_nice_bucket(dev);
1872 struct list_head *i;
1873 u32 n = (u32) bucket;
1875 /* Now find an object value that has not already been taken
1876 * by scanning the list.
1881 n += YAFFS_NOBJECT_BUCKETS;
1882 if (1 || dev->obj_bucket[bucket].count > 0) {
1883 list_for_each(i, &dev->obj_bucket[bucket].list) {
1884 /* If there is already one in the list */
1885 if (i && list_entry(i, struct yaffs_obj,
1886 hash_link)->obj_id == n) {
1895 static void yaffs_hash_obj(struct yaffs_obj *in)
1897 int bucket = yaffs_hash_fn(in->obj_id);
1898 struct yaffs_dev *dev = in->my_dev;
1900 list_add(&in->hash_link, &dev->obj_bucket[bucket].list);
1901 dev->obj_bucket[bucket].count++;
1904 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number)
1906 int bucket = yaffs_hash_fn(number);
1907 struct list_head *i;
1908 struct yaffs_obj *in;
1910 list_for_each(i, &dev->obj_bucket[bucket].list) {
1911 /* Look if it is in the list */
1912 in = list_entry(i, struct yaffs_obj, hash_link);
1913 if (in->obj_id == number) {
1914 /* Don't show if it is defered free */
1915 if (in->defered_free)
1924 struct yaffs_obj *yaffs_new_obj(struct yaffs_dev *dev, int number,
1925 enum yaffs_obj_type type)
1927 struct yaffs_obj *the_obj = NULL;
1928 struct yaffs_tnode *tn = NULL;
1931 number = yaffs_new_obj_id(dev);
1933 if (type == YAFFS_OBJECT_TYPE_FILE) {
1934 tn = yaffs_get_tnode(dev);
1939 the_obj = yaffs_alloc_empty_obj(dev);
1942 yaffs_free_tnode(dev, tn);
1947 the_obj->rename_allowed = 1;
1948 the_obj->unlink_allowed = 1;
1949 the_obj->obj_id = number;
1950 yaffs_hash_obj(the_obj);
1951 the_obj->variant_type = type;
1952 yaffs_load_current_time(the_obj, 1, 1);
1955 case YAFFS_OBJECT_TYPE_FILE:
1956 the_obj->variant.file_variant.file_size = 0;
1957 the_obj->variant.file_variant.scanned_size = 0;
1958 the_obj->variant.file_variant.shrink_size = ~0; /* max */
1959 the_obj->variant.file_variant.top_level = 0;
1960 the_obj->variant.file_variant.top = tn;
1962 case YAFFS_OBJECT_TYPE_DIRECTORY:
1963 INIT_LIST_HEAD(&the_obj->variant.dir_variant.children);
1964 INIT_LIST_HEAD(&the_obj->variant.dir_variant.dirty);
1966 case YAFFS_OBJECT_TYPE_SYMLINK:
1967 case YAFFS_OBJECT_TYPE_HARDLINK:
1968 case YAFFS_OBJECT_TYPE_SPECIAL:
1969 /* No action required */
1971 case YAFFS_OBJECT_TYPE_UNKNOWN:
1972 /* todo this should not happen */
1978 static struct yaffs_obj *yaffs_create_fake_dir(struct yaffs_dev *dev,
1979 int number, u32 mode)
1982 struct yaffs_obj *obj =
1983 yaffs_new_obj(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1988 obj->fake = 1; /* it is fake so it might not use NAND */
1989 obj->rename_allowed = 0;
1990 obj->unlink_allowed = 0;
1993 obj->yst_mode = mode;
1995 obj->hdr_chunk = 0; /* Not a valid chunk. */
2001 static void yaffs_init_tnodes_and_objs(struct yaffs_dev *dev)
2007 yaffs_init_raw_tnodes_and_objs(dev);
2009 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2010 INIT_LIST_HEAD(&dev->obj_bucket[i].list);
2011 dev->obj_bucket[i].count = 0;
2015 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
2017 enum yaffs_obj_type type)
2019 struct yaffs_obj *the_obj = NULL;
2022 the_obj = yaffs_find_by_number(dev, number);
2025 the_obj = yaffs_new_obj(dev, number, type);
2031 YCHAR *yaffs_clone_str(const YCHAR *str)
2033 YCHAR *new_str = NULL;
2039 len = strnlen(str, YAFFS_MAX_ALIAS_LENGTH);
2040 new_str = kmalloc((len + 1) * sizeof(YCHAR), GFP_NOFS);
2042 strncpy(new_str, str, len);
2049 *yaffs_update_parent() handles fixing a directories mtime and ctime when a new
2050 * link (ie. name) is created or deleted in the directory.
2053 * create dir/a : update dir's mtime/ctime
2054 * rm dir/a: update dir's mtime/ctime
2055 * modify dir/a: don't update dir's mtimme/ctime
2057 * This can be handled immediately or defered. Defering helps reduce the number
2058 * of updates when many files in a directory are changed within a brief period.
2060 * If the directory updating is defered then yaffs_update_dirty_dirs must be
2061 * called periodically.
2064 static void yaffs_update_parent(struct yaffs_obj *obj)
2066 struct yaffs_dev *dev;
2072 yaffs_load_current_time(obj, 0, 1);
2073 if (dev->param.defered_dir_update) {
2074 struct list_head *link = &obj->variant.dir_variant.dirty;
2076 if (list_empty(link)) {
2077 list_add(link, &dev->dirty_dirs);
2078 yaffs_trace(YAFFS_TRACE_BACKGROUND,
2079 "Added object %d to dirty directories",
2084 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2088 void yaffs_update_dirty_dirs(struct yaffs_dev *dev)
2090 struct list_head *link;
2091 struct yaffs_obj *obj;
2092 struct yaffs_dir_var *d_s;
2093 union yaffs_obj_var *o_v;
2095 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update dirty directories");
2097 while (!list_empty(&dev->dirty_dirs)) {
2098 link = dev->dirty_dirs.next;
2099 list_del_init(link);
2101 d_s = list_entry(link, struct yaffs_dir_var, dirty);
2102 o_v = list_entry(d_s, union yaffs_obj_var, dir_variant);
2103 obj = list_entry(o_v, struct yaffs_obj, variant);
2105 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update directory %d",
2109 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2114 * Mknod (create) a new object.
2115 * equiv_obj only has meaning for a hard link;
2116 * alias_str only has meaning for a symlink.
2117 * rdev only has meaning for devices (a subset of special objects)
2120 static struct yaffs_obj *yaffs_create_obj(enum yaffs_obj_type type,
2121 struct yaffs_obj *parent,
2126 struct yaffs_obj *equiv_obj,
2127 const YCHAR *alias_str, u32 rdev)
2129 struct yaffs_obj *in;
2131 struct yaffs_dev *dev = parent->my_dev;
2133 /* Check if the entry exists.
2134 * If it does then fail the call since we don't want a dup. */
2135 if (yaffs_find_by_name(parent, name))
2138 if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2139 str = yaffs_clone_str(alias_str);
2144 in = yaffs_new_obj(dev, -1, type);
2153 in->variant_type = type;
2155 in->yst_mode = mode;
2157 yaffs_attribs_init(in, gid, uid, rdev);
2159 in->n_data_chunks = 0;
2161 yaffs_set_obj_name(in, name);
2164 yaffs_add_obj_to_dir(parent, in);
2166 in->my_dev = parent->my_dev;
2169 case YAFFS_OBJECT_TYPE_SYMLINK:
2170 in->variant.symlink_variant.alias = str;
2172 case YAFFS_OBJECT_TYPE_HARDLINK:
2173 in->variant.hardlink_variant.equiv_obj = equiv_obj;
2174 in->variant.hardlink_variant.equiv_id = equiv_obj->obj_id;
2175 list_add(&in->hard_links, &equiv_obj->hard_links);
2177 case YAFFS_OBJECT_TYPE_FILE:
2178 case YAFFS_OBJECT_TYPE_DIRECTORY:
2179 case YAFFS_OBJECT_TYPE_SPECIAL:
2180 case YAFFS_OBJECT_TYPE_UNKNOWN:
2185 if (yaffs_update_oh(in, name, 0, 0, 0, NULL) < 0) {
2186 /* Could not create the object header, fail */
2192 yaffs_update_parent(parent);
2197 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
2198 const YCHAR *name, u32 mode, u32 uid,
2201 return yaffs_create_obj(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2202 uid, gid, NULL, NULL, 0);
2205 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
2206 u32 mode, u32 uid, u32 gid)
2208 return yaffs_create_obj(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2209 mode, uid, gid, NULL, NULL, 0);
2212 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
2213 const YCHAR *name, u32 mode, u32 uid,
2216 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2217 uid, gid, NULL, NULL, rdev);
2220 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
2221 const YCHAR *name, u32 mode, u32 uid,
2222 u32 gid, const YCHAR *alias)
2224 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2225 uid, gid, NULL, alias, 0);
2228 /* yaffs_link_obj returns the object id of the equivalent object.*/
2229 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR * name,
2230 struct yaffs_obj *equiv_obj)
2232 /* Get the real object in case we were fed a hard link obj */
2233 equiv_obj = yaffs_get_equivalent_obj(equiv_obj);
2235 if (yaffs_create_obj(YAFFS_OBJECT_TYPE_HARDLINK,
2236 parent, name, 0, 0, 0,
2237 equiv_obj, NULL, 0))
2246 /*---------------------- Block Management and Page Allocation -------------*/
2248 static void yaffs_deinit_blocks(struct yaffs_dev *dev)
2250 if (dev->block_info_alt && dev->block_info)
2251 vfree(dev->block_info);
2253 kfree(dev->block_info);
2255 dev->block_info_alt = 0;
2257 dev->block_info = NULL;
2259 if (dev->chunk_bits_alt && dev->chunk_bits)
2260 vfree(dev->chunk_bits);
2262 kfree(dev->chunk_bits);
2263 dev->chunk_bits_alt = 0;
2264 dev->chunk_bits = NULL;
2267 static int yaffs_init_blocks(struct yaffs_dev *dev)
2269 int n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
2271 dev->block_info = NULL;
2272 dev->chunk_bits = NULL;
2273 dev->alloc_block = -1; /* force it to get a new one */
2275 /* If the first allocation strategy fails, thry the alternate one */
2277 kmalloc(n_blocks * sizeof(struct yaffs_block_info), GFP_NOFS);
2278 if (!dev->block_info) {
2280 vmalloc(n_blocks * sizeof(struct yaffs_block_info));
2281 dev->block_info_alt = 1;
2283 dev->block_info_alt = 0;
2286 if (!dev->block_info)
2289 /* Set up dynamic blockinfo stuff. Round up bytes. */
2290 dev->chunk_bit_stride = (dev->param.chunks_per_block + 7) / 8;
2292 kmalloc(dev->chunk_bit_stride * n_blocks, GFP_NOFS);
2293 if (!dev->chunk_bits) {
2295 vmalloc(dev->chunk_bit_stride * n_blocks);
2296 dev->chunk_bits_alt = 1;
2298 dev->chunk_bits_alt = 0;
2300 if (!dev->chunk_bits)
2304 memset(dev->block_info, 0, n_blocks * sizeof(struct yaffs_block_info));
2305 memset(dev->chunk_bits, 0, dev->chunk_bit_stride * n_blocks);
2309 yaffs_deinit_blocks(dev);
2314 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no)
2316 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block_no);
2320 /* If the block is still healthy erase it and mark as clean.
2321 * If the block has had a data failure, then retire it.
2324 yaffs_trace(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2325 "yaffs_block_became_dirty block %d state %d %s",
2326 block_no, bi->block_state,
2327 (bi->needs_retiring) ? "needs retiring" : "");
2329 yaffs2_clear_oldest_dirty_seq(dev, bi);
2331 bi->block_state = YAFFS_BLOCK_STATE_DIRTY;
2333 /* If this is the block being garbage collected then stop gc'ing */
2334 if (block_no == dev->gc_block)
2337 /* If this block is currently the best candidate for gc
2338 * then drop as a candidate */
2339 if (block_no == dev->gc_dirtiest) {
2340 dev->gc_dirtiest = 0;
2341 dev->gc_pages_in_use = 0;
2344 if (!bi->needs_retiring) {
2345 yaffs2_checkpt_invalidate(dev);
2346 erased_ok = yaffs_erase_block(dev, block_no);
2348 dev->n_erase_failures++;
2349 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2350 "**>> Erasure failed %d", block_no);
2354 /* Verify erasure if needed */
2356 ((yaffs_trace_mask & YAFFS_TRACE_ERASE) ||
2357 !yaffs_skip_verification(dev))) {
2358 for (i = 0; i < dev->param.chunks_per_block; i++) {
2359 if (!yaffs_check_chunk_erased(dev,
2360 block_no * dev->param.chunks_per_block + i)) {
2361 yaffs_trace(YAFFS_TRACE_ERROR,
2362 ">>Block %d erasure supposedly OK, but chunk %d not erased",
2369 /* We lost a block of free space */
2370 dev->n_free_chunks -= dev->param.chunks_per_block;
2371 yaffs_retire_block(dev, block_no);
2372 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2373 "**>> Block %d retired", block_no);
2377 /* Clean it up... */
2378 bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
2380 dev->n_erased_blocks++;
2381 bi->pages_in_use = 0;
2382 bi->soft_del_pages = 0;
2383 bi->has_shrink_hdr = 0;
2384 bi->skip_erased_check = 1; /* Clean, so no need to check */
2385 bi->gc_prioritise = 0;
2388 yaffs_clear_chunk_bits(dev, block_no);
2390 yaffs_trace(YAFFS_TRACE_ERASE, "Erased block %d", block_no);
2393 static inline int yaffs_gc_process_chunk(struct yaffs_dev *dev,
2394 struct yaffs_block_info *bi,
2395 int old_chunk, u8 *buffer)
2399 struct yaffs_ext_tags tags;
2400 struct yaffs_obj *object;
2402 int ret_val = YAFFS_OK;
2404 memset(&tags, 0, sizeof(tags));
2405 yaffs_rd_chunk_tags_nand(dev, old_chunk,
2407 object = yaffs_find_by_number(dev, tags.obj_id);
2409 yaffs_trace(YAFFS_TRACE_GC_DETAIL,
2410 "Collecting chunk in block %d, %d %d %d ",
2411 dev->gc_chunk, tags.obj_id,
2412 tags.chunk_id, tags.n_bytes);
2414 if (object && !yaffs_skip_verification(dev)) {
2415 if (tags.chunk_id == 0)
2418 else if (object->soft_del)
2419 /* Defeat the test */
2420 matching_chunk = old_chunk;
2423 yaffs_find_chunk_in_file
2424 (object, tags.chunk_id,
2427 if (old_chunk != matching_chunk)
2428 yaffs_trace(YAFFS_TRACE_ERROR,
2429 "gc: page in gc mismatch: %d %d %d %d",
2437 yaffs_trace(YAFFS_TRACE_ERROR,
2438 "page %d in gc has no object: %d %d %d ",
2440 tags.obj_id, tags.chunk_id,
2446 object->soft_del && tags.chunk_id != 0) {
2447 /* Data chunk in a soft deleted file,
2449 * It's a soft deleted data chunk,
2450 * No need to copy this, just forget
2451 * about it and fix up the object.
2454 /* Free chunks already includes
2455 * softdeleted chunks, how ever this
2456 * chunk is going to soon be really
2457 * deleted which will increment free
2458 * chunks. We have to decrement free
2459 * chunks so this works out properly.
2461 dev->n_free_chunks--;
2462 bi->soft_del_pages--;
2464 object->n_data_chunks--;
2465 if (object->n_data_chunks <= 0) {
2466 /* remeber to clean up obj */
2467 dev->gc_cleanup_list[dev->n_clean_ups] = tags.obj_id;
2471 } else if (object) {
2472 /* It's either a data chunk in a live
2473 * file or an ObjectHeader, so we're
2475 * NB Need to keep the ObjectHeaders of
2476 * deleted files until the whole file
2477 * has been deleted off
2479 tags.serial_number++;
2482 if (tags.chunk_id == 0) {
2483 /* It is an object Id,
2484 * We need to nuke the
2485 * shrinkheader flags since its
2487 * Also need to clean up
2490 struct yaffs_obj_hdr *oh;
2491 oh = (struct yaffs_obj_hdr *) buffer;
2494 tags.extra_is_shrink = 0;
2495 oh->shadows_obj = 0;
2496 oh->inband_shadowed_obj_id = 0;
2497 tags.extra_shadows = 0;
2499 /* Update file size */
2500 if (object->variant_type == YAFFS_OBJECT_TYPE_FILE) {
2502 object->variant.file_variant.file_size;
2503 tags.extra_length = oh->file_size;
2506 yaffs_verify_oh(object, oh, &tags, 1);
2508 yaffs_write_new_chunk(dev, (u8 *) oh, &tags, 1);
2511 yaffs_write_new_chunk(dev, buffer, &tags, 1);
2514 if (new_chunk < 0) {
2515 ret_val = YAFFS_FAIL;
2518 /* Now fix up the Tnodes etc. */
2520 if (tags.chunk_id == 0) {
2522 object->hdr_chunk = new_chunk;
2523 object->serial = tags.serial_number;
2525 /* It's a data chunk */
2526 yaffs_put_chunk_in_file(object, tags.chunk_id,
2531 if (ret_val == YAFFS_OK)
2532 yaffs_chunk_del(dev, old_chunk, mark_flash, __LINE__);
2536 static int yaffs_gc_block(struct yaffs_dev *dev, int block, int whole_block)
2539 int ret_val = YAFFS_OK;
2541 int is_checkpt_block;
2543 int chunks_before = yaffs_get_erased_chunks(dev);
2545 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block);
2547 is_checkpt_block = (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT);
2549 yaffs_trace(YAFFS_TRACE_TRACING,
2550 "Collecting block %d, in use %d, shrink %d, whole_block %d",
2551 block, bi->pages_in_use, bi->has_shrink_hdr,
2554 /*yaffs_verify_free_chunks(dev); */
2556 if (bi->block_state == YAFFS_BLOCK_STATE_FULL)
2557 bi->block_state = YAFFS_BLOCK_STATE_COLLECTING;
2559 bi->has_shrink_hdr = 0; /* clear the flag so that the block can erase */
2561 dev->gc_disable = 1;
2563 yaffs_summary_gc(dev, block);
2565 if (is_checkpt_block || !yaffs_still_some_chunks(dev, block)) {
2566 yaffs_trace(YAFFS_TRACE_TRACING,
2567 "Collecting block %d that has no chunks in use",
2569 yaffs_block_became_dirty(dev, block);
2572 u8 *buffer = yaffs_get_temp_buffer(dev);
2574 yaffs_verify_blk(dev, bi, block);
2576 max_copies = (whole_block) ? dev->param.chunks_per_block : 5;
2577 old_chunk = block * dev->param.chunks_per_block + dev->gc_chunk;
2579 for (/* init already done */ ;
2580 ret_val == YAFFS_OK &&
2581 dev->gc_chunk < dev->param.chunks_per_block &&
2582 (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) &&
2584 dev->gc_chunk++, old_chunk++) {
2585 if (yaffs_check_chunk_bit(dev, block, dev->gc_chunk)) {
2586 /* Page is in use and might need to be copied */
2588 ret_val = yaffs_gc_process_chunk(dev, bi,
2592 yaffs_release_temp_buffer(dev, buffer);
2595 yaffs_verify_collected_blk(dev, bi, block);
2597 if (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2599 * The gc did not complete. Set block state back to FULL
2600 * because checkpointing does not restore gc.
2602 bi->block_state = YAFFS_BLOCK_STATE_FULL;
2604 /* The gc completed. */
2605 /* Do any required cleanups */
2606 for (i = 0; i < dev->n_clean_ups; i++) {
2607 /* Time to delete the file too */
2608 struct yaffs_obj *object =
2609 yaffs_find_by_number(dev, dev->gc_cleanup_list[i]);
2611 yaffs_free_tnode(dev,
2612 object->variant.file_variant.top);
2613 object->variant.file_variant.top = NULL;
2614 yaffs_trace(YAFFS_TRACE_GC,
2615 "yaffs: About to finally delete object %d",
2617 yaffs_generic_obj_del(object);
2618 object->my_dev->n_deleted_files--;
2622 chunks_after = yaffs_get_erased_chunks(dev);
2623 if (chunks_before >= chunks_after)
2624 yaffs_trace(YAFFS_TRACE_GC,
2625 "gc did not increase free chunks before %d after %d",
2626 chunks_before, chunks_after);
2629 dev->n_clean_ups = 0;
2632 dev->gc_disable = 0;
2638 * find_gc_block() selects the dirtiest block (or close enough)
2639 * for garbage collection.
2642 static unsigned yaffs_find_gc_block(struct yaffs_dev *dev,
2643 int aggressive, int background)
2647 unsigned selected = 0;
2648 int prioritised = 0;
2649 int prioritised_exist = 0;
2650 struct yaffs_block_info *bi;
2653 /* First let's see if we need to grab a prioritised block */
2654 if (dev->has_pending_prioritised_gc && !aggressive) {
2655 dev->gc_dirtiest = 0;
2656 bi = dev->block_info;
2657 for (i = dev->internal_start_block;
2658 i <= dev->internal_end_block && !selected; i++) {
2660 if (bi->gc_prioritise) {
2661 prioritised_exist = 1;
2662 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2663 yaffs_block_ok_for_gc(dev, bi)) {
2672 * If there is a prioritised block and none was selected then
2673 * this happened because there is at least one old dirty block
2674 * gumming up the works. Let's gc the oldest dirty block.
2677 if (prioritised_exist &&
2678 !selected && dev->oldest_dirty_block > 0)
2679 selected = dev->oldest_dirty_block;
2681 if (!prioritised_exist) /* None found, so we can clear this */
2682 dev->has_pending_prioritised_gc = 0;
2685 /* If we're doing aggressive GC then we are happy to take a less-dirty
2686 * block, and search harder.
2687 * else (leasurely gc), then we only bother to do this if the
2688 * block has only a few pages in use.
2694 dev->internal_end_block - dev->internal_start_block + 1;
2696 threshold = dev->param.chunks_per_block;
2697 iterations = n_blocks;
2702 max_threshold = dev->param.chunks_per_block / 2;
2704 max_threshold = dev->param.chunks_per_block / 8;
2706 if (max_threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2707 max_threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2709 threshold = background ? (dev->gc_not_done + 2) * 2 : 0;
2710 if (threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2711 threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2712 if (threshold > max_threshold)
2713 threshold = max_threshold;
2715 iterations = n_blocks / 16 + 1;
2716 if (iterations > 100)
2722 (dev->gc_dirtiest < 1 ||
2723 dev->gc_pages_in_use > YAFFS_GC_GOOD_ENOUGH);
2725 dev->gc_block_finder++;
2726 if (dev->gc_block_finder < dev->internal_start_block ||
2727 dev->gc_block_finder > dev->internal_end_block)
2728 dev->gc_block_finder =
2729 dev->internal_start_block;
2731 bi = yaffs_get_block_info(dev, dev->gc_block_finder);
2733 pages_used = bi->pages_in_use - bi->soft_del_pages;
2735 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2736 pages_used < dev->param.chunks_per_block &&
2737 (dev->gc_dirtiest < 1 ||
2738 pages_used < dev->gc_pages_in_use) &&
2739 yaffs_block_ok_for_gc(dev, bi)) {
2740 dev->gc_dirtiest = dev->gc_block_finder;
2741 dev->gc_pages_in_use = pages_used;
2745 if (dev->gc_dirtiest > 0 && dev->gc_pages_in_use <= threshold)
2746 selected = dev->gc_dirtiest;
2750 * If nothing has been selected for a while, try the oldest dirty
2751 * because that's gumming up the works.
2754 if (!selected && dev->param.is_yaffs2 &&
2755 dev->gc_not_done >= (background ? 10 : 20)) {
2756 yaffs2_find_oldest_dirty_seq(dev);
2757 if (dev->oldest_dirty_block > 0) {
2758 selected = dev->oldest_dirty_block;
2759 dev->gc_dirtiest = selected;
2760 dev->oldest_dirty_gc_count++;
2761 bi = yaffs_get_block_info(dev, selected);
2762 dev->gc_pages_in_use =
2763 bi->pages_in_use - bi->soft_del_pages;
2765 dev->gc_not_done = 0;
2770 yaffs_trace(YAFFS_TRACE_GC,
2771 "GC Selected block %d with %d free, prioritised:%d",
2773 dev->param.chunks_per_block - dev->gc_pages_in_use,
2780 dev->gc_dirtiest = 0;
2781 dev->gc_pages_in_use = 0;
2782 dev->gc_not_done = 0;
2783 if (dev->refresh_skip > 0)
2784 dev->refresh_skip--;
2787 yaffs_trace(YAFFS_TRACE_GC,
2788 "GC none: finder %d skip %d threshold %d dirtiest %d using %d oldest %d%s",
2789 dev->gc_block_finder, dev->gc_not_done, threshold,
2790 dev->gc_dirtiest, dev->gc_pages_in_use,
2791 dev->oldest_dirty_block, background ? " bg" : "");
2797 /* New garbage collector
2798 * If we're very low on erased blocks then we do aggressive garbage collection
2799 * otherwise we do "leasurely" garbage collection.
2800 * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2801 * Passive gc only inspects smaller areas and only accepts more dirty blocks.
2803 * The idea is to help clear out space in a more spread-out manner.
2804 * Dunno if it really does anything useful.
2806 static int yaffs_check_gc(struct yaffs_dev *dev, int background)
2809 int gc_ok = YAFFS_OK;
2813 int checkpt_block_adjust;
2815 if (dev->param.gc_control && (dev->param.gc_control(dev) & 1) == 0)
2818 if (dev->gc_disable)
2819 /* Bail out so we don't get recursive gc */
2822 /* This loop should pass the first time.
2823 * Only loops here if the collection does not increase space.
2829 checkpt_block_adjust = yaffs_calc_checkpt_blocks_required(dev);
2832 dev->param.n_reserved_blocks + checkpt_block_adjust + 1;
2834 dev->n_erased_blocks * dev->param.chunks_per_block;
2836 /* If we need a block soon then do aggressive gc. */
2837 if (dev->n_erased_blocks < min_erased)
2841 && erased_chunks > (dev->n_free_chunks / 4))
2844 if (dev->gc_skip > 20)
2846 if (erased_chunks < dev->n_free_chunks / 2 ||
2847 dev->gc_skip < 1 || background)
2857 /* If we don't already have a block being gc'd then see if we
2858 * should start another */
2860 if (dev->gc_block < 1 && !aggressive) {
2861 dev->gc_block = yaffs2_find_refresh_block(dev);
2863 dev->n_clean_ups = 0;
2865 if (dev->gc_block < 1) {
2867 yaffs_find_gc_block(dev, aggressive, background);
2869 dev->n_clean_ups = 0;
2872 if (dev->gc_block > 0) {
2875 dev->passive_gc_count++;
2877 yaffs_trace(YAFFS_TRACE_GC,
2878 "yaffs: GC n_erased_blocks %d aggressive %d",
2879 dev->n_erased_blocks, aggressive);
2881 gc_ok = yaffs_gc_block(dev, dev->gc_block, aggressive);
2884 if (dev->n_erased_blocks < (dev->param.n_reserved_blocks) &&
2885 dev->gc_block > 0) {
2886 yaffs_trace(YAFFS_TRACE_GC,
2887 "yaffs: GC !!!no reclaim!!! n_erased_blocks %d after try %d block %d",
2888 dev->n_erased_blocks, max_tries,
2891 } while ((dev->n_erased_blocks < dev->param.n_reserved_blocks) &&
2892 (dev->gc_block > 0) && (max_tries < 2));
2894 return aggressive ? gc_ok : YAFFS_OK;
2899 * Garbage collects. Intended to be called from a background thread.
2900 * Returns non-zero if at least half the free chunks are erased.
2902 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency)
2904 int erased_chunks = dev->n_erased_blocks * dev->param.chunks_per_block;
2906 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Background gc %u", urgency);
2908 yaffs_check_gc(dev, 1);
2909 return erased_chunks > dev->n_free_chunks / 2;
2912 /*-------------------- Data file manipulation -----------------*/
2914 static int yaffs_rd_data_obj(struct yaffs_obj *in, int inode_chunk, u8 * buffer)
2916 int nand_chunk = yaffs_find_chunk_in_file(in, inode_chunk, NULL);
2918 if (nand_chunk >= 0)
2919 return yaffs_rd_chunk_tags_nand(in->my_dev, nand_chunk,
2922 yaffs_trace(YAFFS_TRACE_NANDACCESS,
2923 "Chunk %d not found zero instead",
2925 /* get sane (zero) data if you read a hole */
2926 memset(buffer, 0, in->my_dev->data_bytes_per_chunk);
2932 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
2937 struct yaffs_ext_tags tags;
2938 struct yaffs_block_info *bi;
2944 block = chunk_id / dev->param.chunks_per_block;
2945 page = chunk_id % dev->param.chunks_per_block;
2947 if (!yaffs_check_chunk_bit(dev, block, page))
2948 yaffs_trace(YAFFS_TRACE_VERIFY,
2949 "Deleting invalid chunk %d", chunk_id);
2951 bi = yaffs_get_block_info(dev, block);
2953 yaffs2_update_oldest_dirty_seq(dev, block, bi);
2955 yaffs_trace(YAFFS_TRACE_DELETION,
2956 "line %d delete of chunk %d",
2959 if (!dev->param.is_yaffs2 && mark_flash &&
2960 bi->block_state != YAFFS_BLOCK_STATE_COLLECTING) {
2962 memset(&tags, 0, sizeof(tags));
2963 tags.is_deleted = 1;
2964 yaffs_wr_chunk_tags_nand(dev, chunk_id, NULL, &tags);
2965 yaffs_handle_chunk_update(dev, chunk_id, &tags);
2967 dev->n_unmarked_deletions++;
2970 /* Pull out of the management area.
2971 * If the whole block became dirty, this will kick off an erasure.
2973 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING ||
2974 bi->block_state == YAFFS_BLOCK_STATE_FULL ||
2975 bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCAN ||
2976 bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2977 dev->n_free_chunks++;
2978 yaffs_clear_chunk_bit(dev, block, page);
2981 if (bi->pages_in_use == 0 &&
2982 !bi->has_shrink_hdr &&
2983 bi->block_state != YAFFS_BLOCK_STATE_ALLOCATING &&
2984 bi->block_state != YAFFS_BLOCK_STATE_NEEDS_SCAN) {
2985 yaffs_block_became_dirty(dev, block);
2990 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
2991 const u8 *buffer, int n_bytes, int use_reserve)
2993 /* Find old chunk Need to do this to get serial number
2994 * Write new one and patch into tree.
2995 * Invalidate old tags.
2999 struct yaffs_ext_tags prev_tags;
3001 struct yaffs_ext_tags new_tags;
3002 struct yaffs_dev *dev = in->my_dev;
3004 yaffs_check_gc(dev, 0);
3006 /* Get the previous chunk at this location in the file if it exists.
3007 * If it does not exist then put a zero into the tree. This creates
3008 * the tnode now, rather than later when it is harder to clean up.
3010 prev_chunk_id = yaffs_find_chunk_in_file(in, inode_chunk, &prev_tags);
3011 if (prev_chunk_id < 1 &&
3012 !yaffs_put_chunk_in_file(in, inode_chunk, 0, 0))
3015 /* Set up new tags */
3016 memset(&new_tags, 0, sizeof(new_tags));
3018 new_tags.chunk_id = inode_chunk;
3019 new_tags.obj_id = in->obj_id;
3020 new_tags.serial_number =
3021 (prev_chunk_id > 0) ? prev_tags.serial_number + 1 : 1;
3022 new_tags.n_bytes = n_bytes;
3024 if (n_bytes < 1 || n_bytes > dev->param.total_bytes_per_chunk) {
3025 yaffs_trace(YAFFS_TRACE_ERROR,
3026 "Writing %d bytes to chunk!!!!!!!!!",
3032 yaffs_write_new_chunk(dev, buffer, &new_tags, use_reserve);
3034 if (new_chunk_id > 0) {
3035 yaffs_put_chunk_in_file(in, inode_chunk, new_chunk_id, 0);
3037 if (prev_chunk_id > 0)
3038 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3040 yaffs_verify_file_sane(in);
3042 return new_chunk_id;
3048 static int yaffs_do_xattrib_mod(struct yaffs_obj *obj, int set,
3049 const YCHAR *name, const void *value, int size,
3052 struct yaffs_xattr_mod xmod;
3060 xmod.result = -ENOSPC;
3062 result = yaffs_update_oh(obj, NULL, 0, 0, 0, &xmod);
3070 static int yaffs_apply_xattrib_mod(struct yaffs_obj *obj, char *buffer,
3071 struct yaffs_xattr_mod *xmod)
3074 int x_offs = sizeof(struct yaffs_obj_hdr);
3075 struct yaffs_dev *dev = obj->my_dev;
3076 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3077 char *x_buffer = buffer + x_offs;
3081 nval_set(x_buffer, x_size, xmod->name, xmod->data,
3082 xmod->size, xmod->flags);
3084 retval = nval_del(x_buffer, x_size, xmod->name);
3086 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3087 obj->xattr_known = 1;
3088 xmod->result = retval;
3093 static int yaffs_do_xattrib_fetch(struct yaffs_obj *obj, const YCHAR *name,
3094 void *value, int size)
3096 char *buffer = NULL;
3098 struct yaffs_ext_tags tags;
3099 struct yaffs_dev *dev = obj->my_dev;
3100 int x_offs = sizeof(struct yaffs_obj_hdr);
3101 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3105 if (obj->hdr_chunk < 1)
3108 /* If we know that the object has no xattribs then don't do all the
3109 * reading and parsing.
3111 if (obj->xattr_known && !obj->has_xattr) {
3118 buffer = (char *)yaffs_get_temp_buffer(dev);
3123 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, (u8 *) buffer, &tags);
3125 if (result != YAFFS_OK)
3128 x_buffer = buffer + x_offs;
3130 if (!obj->xattr_known) {
3131 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3132 obj->xattr_known = 1;
3136 retval = nval_get(x_buffer, x_size, name, value, size);
3138 retval = nval_list(x_buffer, x_size, value, size);
3140 yaffs_release_temp_buffer(dev, (u8 *) buffer);
3144 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR * name,
3145 const void *value, int size, int flags)
3147 return yaffs_do_xattrib_mod(obj, 1, name, value, size, flags);
3150 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR * name)
3152 return yaffs_do_xattrib_mod(obj, 0, name, NULL, 0, 0);
3155 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR * name, void *value,
3158 return yaffs_do_xattrib_fetch(obj, name, value, size);
3161 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size)
3163 return yaffs_do_xattrib_fetch(obj, NULL, buffer, size);
3166 static void yaffs_check_obj_details_loaded(struct yaffs_obj *in)
3169 struct yaffs_obj_hdr *oh;
3170 struct yaffs_dev *dev;
3171 struct yaffs_ext_tags tags;
3173 int alloc_failed = 0;
3175 if (!in || !in->lazy_loaded || in->hdr_chunk < 1)
3179 in->lazy_loaded = 0;
3180 buf = yaffs_get_temp_buffer(dev);
3182 result = yaffs_rd_chunk_tags_nand(dev, in->hdr_chunk, buf, &tags);
3183 oh = (struct yaffs_obj_hdr *)buf;
3185 in->yst_mode = oh->yst_mode;
3186 yaffs_load_attribs(in, oh);
3187 yaffs_set_obj_name_from_oh(in, oh);
3189 if (in->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
3190 in->variant.symlink_variant.alias =
3191 yaffs_clone_str(oh->alias);
3192 if (!in->variant.symlink_variant.alias)
3193 alloc_failed = 1; /* Not returned */
3195 yaffs_release_temp_buffer(dev, buf);
3198 static void yaffs_load_name_from_oh(struct yaffs_dev *dev, YCHAR *name,
3199 const YCHAR *oh_name, int buff_size)
3201 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3202 if (dev->param.auto_unicode) {
3204 /* It is an ASCII name, do an ASCII to
3205 * unicode conversion */
3206 const char *ascii_oh_name = (const char *)oh_name;
3207 int n = buff_size - 1;
3208 while (n > 0 && *ascii_oh_name) {
3209 *name = *ascii_oh_name;
3215 strncpy(name, oh_name + 1, buff_size - 1);
3221 strncpy(name, oh_name, buff_size - 1);
3225 static void yaffs_load_oh_from_name(struct yaffs_dev *dev, YCHAR *oh_name,
3228 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3233 if (dev->param.auto_unicode) {
3238 /* Figure out if the name will fit in ascii character set */
3239 while (is_ascii && *w) {
3246 /* It is an ASCII name, so convert unicode to ascii */
3247 char *ascii_oh_name = (char *)oh_name;
3248 int n = YAFFS_MAX_NAME_LENGTH - 1;
3249 while (n > 0 && *name) {
3250 *ascii_oh_name = *name;
3256 /* Unicode name, so save starting at the second YCHAR */
3258 strncpy(oh_name + 1, name, YAFFS_MAX_NAME_LENGTH - 2);
3264 strncpy(oh_name, name, YAFFS_MAX_NAME_LENGTH - 1);
3268 /* UpdateObjectHeader updates the header on NAND for an object.
3269 * If name is not NULL, then that new name is used.
3271 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name, int force,
3272 int is_shrink, int shadows, struct yaffs_xattr_mod *xmod)
3275 struct yaffs_block_info *bi;
3276 struct yaffs_dev *dev = in->my_dev;
3281 struct yaffs_ext_tags new_tags;
3282 struct yaffs_ext_tags old_tags;
3283 const YCHAR *alias = NULL;
3285 YCHAR old_name[YAFFS_MAX_NAME_LENGTH + 1];
3286 struct yaffs_obj_hdr *oh = NULL;
3288 strcpy(old_name, _Y("silly old name"));
3290 if (in->fake && in != dev->root_dir && !force && !xmod)
3293 yaffs_check_gc(dev, 0);
3294 yaffs_check_obj_details_loaded(in);
3296 buffer = yaffs_get_temp_buffer(in->my_dev);
3297 oh = (struct yaffs_obj_hdr *)buffer;
3299 prev_chunk_id = in->hdr_chunk;
3301 if (prev_chunk_id > 0) {
3302 result = yaffs_rd_chunk_tags_nand(dev, prev_chunk_id,
3305 yaffs_verify_oh(in, oh, &old_tags, 0);
3306 memcpy(old_name, oh->name, sizeof(oh->name));
3307 memset(buffer, 0xff, sizeof(struct yaffs_obj_hdr));
3309 memset(buffer, 0xff, dev->data_bytes_per_chunk);
3312 oh->type = in->variant_type;
3313 oh->yst_mode = in->yst_mode;
3314 oh->shadows_obj = oh->inband_shadowed_obj_id = shadows;
3316 yaffs_load_attribs_oh(oh, in);
3319 oh->parent_obj_id = in->parent->obj_id;
3321 oh->parent_obj_id = 0;
3323 if (name && *name) {
3324 memset(oh->name, 0, sizeof(oh->name));
3325 yaffs_load_oh_from_name(dev, oh->name, name);
3326 } else if (prev_chunk_id > 0) {
3327 memcpy(oh->name, old_name, sizeof(oh->name));
3329 memset(oh->name, 0, sizeof(oh->name));
3332 oh->is_shrink = is_shrink;
3334 switch (in->variant_type) {
3335 case YAFFS_OBJECT_TYPE_UNKNOWN:
3336 /* Should not happen */
3338 case YAFFS_OBJECT_TYPE_FILE:
3340 (oh->parent_obj_id == YAFFS_OBJECTID_DELETED ||
3341 oh->parent_obj_id == YAFFS_OBJECTID_UNLINKED) ?
3342 0 : in->variant.file_variant.file_size;
3344 case YAFFS_OBJECT_TYPE_HARDLINK:
3345 oh->equiv_id = in->variant.hardlink_variant.equiv_id;
3347 case YAFFS_OBJECT_TYPE_SPECIAL:
3350 case YAFFS_OBJECT_TYPE_DIRECTORY:
3353 case YAFFS_OBJECT_TYPE_SYMLINK:
3354 alias = in->variant.symlink_variant.alias;
3356 alias = _Y("no alias");
3357 strncpy(oh->alias, alias, YAFFS_MAX_ALIAS_LENGTH);
3358 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3362 /* process any xattrib modifications */
3364 yaffs_apply_xattrib_mod(in, (char *)buffer, xmod);
3367 memset(&new_tags, 0, sizeof(new_tags));
3369 new_tags.chunk_id = 0;
3370 new_tags.obj_id = in->obj_id;
3371 new_tags.serial_number = in->serial;
3373 /* Add extra info for file header */
3374 new_tags.extra_available = 1;
3375 new_tags.extra_parent_id = oh->parent_obj_id;
3376 new_tags.extra_length = oh->file_size;
3377 new_tags.extra_is_shrink = oh->is_shrink;
3378 new_tags.extra_equiv_id = oh->equiv_id;
3379 new_tags.extra_shadows = (oh->shadows_obj > 0) ? 1 : 0;
3380 new_tags.extra_obj_type = in->variant_type;
3381 yaffs_verify_oh(in, oh, &new_tags, 1);
3383 /* Create new chunk in NAND */
3385 yaffs_write_new_chunk(dev, buffer, &new_tags,
3386 (prev_chunk_id > 0) ? 1 : 0);
3389 yaffs_release_temp_buffer(dev, buffer);
3391 if (new_chunk_id < 0)
3392 return new_chunk_id;
3394 in->hdr_chunk = new_chunk_id;
3396 if (prev_chunk_id > 0)
3397 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3399 if (!yaffs_obj_cache_dirty(in))
3402 /* If this was a shrink, then mark the block
3403 * that the chunk lives on */
3405 bi = yaffs_get_block_info(in->my_dev,
3407 in->my_dev->param.chunks_per_block);
3408 bi->has_shrink_hdr = 1;
3412 return new_chunk_id;
3415 /*--------------------- File read/write ------------------------
3416 * Read and write have very similar structures.
3417 * In general the read/write has three parts to it
3418 * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3419 * Some complete chunks
3420 * An incomplete chunk to end off with
3422 * Curve-balls: the first chunk might also be the last chunk.
3425 int yaffs_file_rd(struct yaffs_obj *in, u8 * buffer, loff_t offset, int n_bytes)
3432 struct yaffs_cache *cache;
3433 struct yaffs_dev *dev;
3438 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3441 /* OK now check for the curveball where the start and end are in
3444 if ((start + n) < dev->data_bytes_per_chunk)
3447 n_copy = dev->data_bytes_per_chunk - start;
3449 cache = yaffs_find_chunk_cache(in, chunk);
3451 /* If the chunk is already in the cache or it is less than
3452 * a whole chunk or we're using inband tags then use the cache
3453 * (if there is caching) else bypass the cache.
3455 if (cache || n_copy != dev->data_bytes_per_chunk ||
3456 dev->param.inband_tags) {
3457 if (dev->param.n_caches > 0) {
3459 /* If we can't find the data in the cache,
3460 * then load it up. */
3464 yaffs_grab_chunk_cache(in->my_dev);
3466 cache->chunk_id = chunk;
3469 yaffs_rd_data_obj(in, chunk,
3474 yaffs_use_cache(dev, cache, 0);
3478 memcpy(buffer, &cache->data[start], n_copy);
3482 /* Read into the local buffer then copy.. */
3485 yaffs_get_temp_buffer(dev);
3486 yaffs_rd_data_obj(in, chunk, local_buffer);
3488 memcpy(buffer, &local_buffer[start], n_copy);
3490 yaffs_release_temp_buffer(dev, local_buffer);
3493 /* A full chunk. Read directly into the buffer. */
3494 yaffs_rd_data_obj(in, chunk, buffer);
3504 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
3505 int n_bytes, int write_trhrough)
3514 int start_write = offset;
3515 int chunk_written = 0;
3518 struct yaffs_dev *dev;
3522 while (n > 0 && chunk_written >= 0) {
3523 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3525 if (chunk * dev->data_bytes_per_chunk + start != offset ||
3526 start >= dev->data_bytes_per_chunk) {
3527 yaffs_trace(YAFFS_TRACE_ERROR,
3528 "AddrToChunk of offset %d gives chunk %d start %d",
3529 (int)offset, chunk, start);
3531 chunk++; /* File pos to chunk in file offset */
3533 /* OK now check for the curveball where the start and end are in
3537 if ((start + n) < dev->data_bytes_per_chunk) {
3540 /* Now calculate how many bytes to write back....
3541 * If we're overwriting and not writing to then end of
3542 * file then we need to write back as much as was there
3546 chunk_start = ((chunk - 1) * dev->data_bytes_per_chunk);
3548 if (chunk_start > in->variant.file_variant.file_size)
3549 n_bytes_read = 0; /* Past end of file */
3552 in->variant.file_variant.file_size -
3555 if (n_bytes_read > dev->data_bytes_per_chunk)
3556 n_bytes_read = dev->data_bytes_per_chunk;
3560 (start + n)) ? n_bytes_read : (start + n);
3562 if (n_writeback < 0 ||
3563 n_writeback > dev->data_bytes_per_chunk)
3567 n_copy = dev->data_bytes_per_chunk - start;
3568 n_writeback = dev->data_bytes_per_chunk;
3571 if (n_copy != dev->data_bytes_per_chunk ||
3572 dev->param.inband_tags) {
3573 /* An incomplete start or end chunk (or maybe both
3574 * start and end chunk), or we're using inband tags,
3575 * so we want to use the cache buffers.
3577 if (dev->param.n_caches > 0) {
3578 struct yaffs_cache *cache;
3580 /* If we can't find the data in the cache, then
3582 cache = yaffs_find_chunk_cache(in, chunk);
3585 yaffs_check_alloc_available(dev, 1)) {
3586 cache = yaffs_grab_chunk_cache(dev);
3588 cache->chunk_id = chunk;
3591 yaffs_rd_data_obj(in, chunk,
3595 !yaffs_check_alloc_available(dev,
3597 /* Drop the cache if it was a read cache
3598 * item and no space check has been made
3605 yaffs_use_cache(dev, cache, 1);
3608 memcpy(&cache->data[start], buffer,
3612 cache->n_bytes = n_writeback;
3614 if (write_trhrough) {
3624 chunk_written = -1; /* fail write */
3627 /* An incomplete start or end chunk (or maybe
3628 * both start and end chunk). Read into the
3629 * local buffer then copy over and write back.
3632 u8 *local_buffer = yaffs_get_temp_buffer(dev);
3634 yaffs_rd_data_obj(in, chunk, local_buffer);
3635 memcpy(&local_buffer[start], buffer, n_copy);
3638 yaffs_wr_data_obj(in, chunk,
3642 yaffs_release_temp_buffer(dev, local_buffer);
3645 /* A full chunk. Write directly from the buffer. */
3648 yaffs_wr_data_obj(in, chunk, buffer,
3649 dev->data_bytes_per_chunk, 0);
3651 /* Since we've overwritten the cached data,
3652 * we better invalidate it. */
3653 yaffs_invalidate_chunk_cache(in, chunk);
3656 if (chunk_written >= 0) {
3664 /* Update file object */
3666 if ((start_write + n_done) > in->variant.file_variant.file_size)
3667 in->variant.file_variant.file_size = (start_write + n_done);
3673 int yaffs_wr_file(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
3674 int n_bytes, int write_trhrough)
3676 yaffs2_handle_hole(in, offset);
3677 return yaffs_do_file_wr(in, buffer, offset, n_bytes, write_trhrough);
3680 /* ---------------------- File resizing stuff ------------------ */
3682 static void yaffs_prune_chunks(struct yaffs_obj *in, int new_size)
3685 struct yaffs_dev *dev = in->my_dev;
3686 int old_size = in->variant.file_variant.file_size;
3689 int last_del = 1 + (old_size - 1) / dev->data_bytes_per_chunk;
3690 int start_del = 1 + (new_size + dev->data_bytes_per_chunk - 1) /
3691 dev->data_bytes_per_chunk;
3694 /* Delete backwards so that we don't end up with holes if
3695 * power is lost part-way through the operation.
3697 for (i = last_del; i >= start_del; i--) {
3698 /* NB this could be optimised somewhat,
3699 * eg. could retrieve the tags and write them without
3700 * using yaffs_chunk_del
3703 chunk_id = yaffs_find_del_file_chunk(in, i, NULL);
3709 (dev->internal_start_block * dev->param.chunks_per_block) ||
3711 ((dev->internal_end_block + 1) *
3712 dev->param.chunks_per_block)) {
3713 yaffs_trace(YAFFS_TRACE_ALWAYS,
3714 "Found daft chunk_id %d for %d",
3717 in->n_data_chunks--;
3718 yaffs_chunk_del(dev, chunk_id, 1, __LINE__);
3723 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size)
3727 struct yaffs_dev *dev = obj->my_dev;
3729 yaffs_addr_to_chunk(dev, new_size, &new_full, &new_partial);
3731 yaffs_prune_chunks(obj, new_size);
3733 if (new_partial != 0) {
3734 int last_chunk = 1 + new_full;
3735 u8 *local_buffer = yaffs_get_temp_buffer(dev);
3737 /* Rewrite the last chunk with its new size and zero pad */
3738 yaffs_rd_data_obj(obj, last_chunk, local_buffer);
3739 memset(local_buffer + new_partial, 0,
3740 dev->data_bytes_per_chunk - new_partial);
3742 yaffs_wr_data_obj(obj, last_chunk, local_buffer,
3745 yaffs_release_temp_buffer(dev, local_buffer);
3748 obj->variant.file_variant.file_size = new_size;
3750 yaffs_prune_tree(dev, &obj->variant.file_variant);
3753 int yaffs_resize_file(struct yaffs_obj *in, loff_t new_size)
3755 struct yaffs_dev *dev = in->my_dev;
3756 int old_size = in->variant.file_variant.file_size;
3758 yaffs_flush_file_cache(in);
3759 yaffs_invalidate_whole_cache(in);
3761 yaffs_check_gc(dev, 0);
3763 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE)
3766 if (new_size == old_size)
3769 if (new_size > old_size) {
3770 yaffs2_handle_hole(in, new_size);
3771 in->variant.file_variant.file_size = new_size;
3773 /* new_size < old_size */
3774 yaffs_resize_file_down(in, new_size);
3777 /* Write a new object header to reflect the resize.
3778 * show we've shrunk the file, if need be
3779 * Do this only if the file is not in the deleted directories
3780 * and is not shadowed.
3784 in->parent->obj_id != YAFFS_OBJECTID_UNLINKED &&
3785 in->parent->obj_id != YAFFS_OBJECTID_DELETED)
3786 yaffs_update_oh(in, NULL, 0, 0, 0, NULL);
3791 int yaffs_flush_file(struct yaffs_obj *in, int update_time, int data_sync)
3796 yaffs_flush_file_cache(in);
3802 yaffs_load_current_time(in, 0, 0);
3804 return (yaffs_update_oh(in, NULL, 0, 0, 0, NULL) >= 0) ?
3805 YAFFS_OK : YAFFS_FAIL;
3809 /* yaffs_del_file deletes the whole file data
3810 * and the inode associated with the file.
3811 * It does not delete the links associated with the file.
3813 static int yaffs_unlink_file_if_needed(struct yaffs_obj *in)
3817 struct yaffs_dev *dev = in->my_dev;
3824 yaffs_change_obj_name(in, in->my_dev->del_dir,
3825 _Y("deleted"), 0, 0);
3826 yaffs_trace(YAFFS_TRACE_TRACING,
3827 "yaffs: immediate deletion of file %d",
3830 in->my_dev->n_deleted_files++;
3831 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3832 yaffs_resize_file(in, 0);
3833 yaffs_soft_del_file(in);
3836 yaffs_change_obj_name(in, in->my_dev->unlinked_dir,
3837 _Y("unlinked"), 0, 0);
3842 int yaffs_del_file(struct yaffs_obj *in)
3844 int ret_val = YAFFS_OK;
3845 int deleted; /* Need to cache value on stack if in is freed */
3846 struct yaffs_dev *dev = in->my_dev;
3848 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3849 yaffs_resize_file(in, 0);
3851 if (in->n_data_chunks > 0) {
3852 /* Use soft deletion if there is data in the file.
3853 * That won't be the case if it has been resized to zero.
3856 ret_val = yaffs_unlink_file_if_needed(in);
3858 deleted = in->deleted;
3860 if (ret_val == YAFFS_OK && in->unlinked && !in->deleted) {
3863 in->my_dev->n_deleted_files++;
3864 yaffs_soft_del_file(in);
3866 return deleted ? YAFFS_OK : YAFFS_FAIL;
3868 /* The file has no data chunks so we toss it immediately */
3869 yaffs_free_tnode(in->my_dev, in->variant.file_variant.top);
3870 in->variant.file_variant.top = NULL;
3871 yaffs_generic_obj_del(in);
3877 int yaffs_is_non_empty_dir(struct yaffs_obj *obj)
3880 obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) &&
3881 !(list_empty(&obj->variant.dir_variant.children));
3884 static int yaffs_del_dir(struct yaffs_obj *obj)
3886 /* First check that the directory is empty. */
3887 if (yaffs_is_non_empty_dir(obj))
3890 return yaffs_generic_obj_del(obj);
3893 static int yaffs_del_symlink(struct yaffs_obj *in)
3895 kfree(in->variant.symlink_variant.alias);
3896 in->variant.symlink_variant.alias = NULL;
3898 return yaffs_generic_obj_del(in);
3901 static int yaffs_del_link(struct yaffs_obj *in)
3903 /* remove this hardlink from the list associated with the equivalent
3906 list_del_init(&in->hard_links);
3907 return yaffs_generic_obj_del(in);
3910 int yaffs_del_obj(struct yaffs_obj *obj)
3914 switch (obj->variant_type) {
3915 case YAFFS_OBJECT_TYPE_FILE:
3916 ret_val = yaffs_del_file(obj);
3918 case YAFFS_OBJECT_TYPE_DIRECTORY:
3919 if (!list_empty(&obj->variant.dir_variant.dirty)) {
3920 yaffs_trace(YAFFS_TRACE_BACKGROUND,
3921 "Remove object %d from dirty directories",
3923 list_del_init(&obj->variant.dir_variant.dirty);
3925 return yaffs_del_dir(obj);
3927 case YAFFS_OBJECT_TYPE_SYMLINK:
3928 ret_val = yaffs_del_symlink(obj);
3930 case YAFFS_OBJECT_TYPE_HARDLINK:
3931 ret_val = yaffs_del_link(obj);
3933 case YAFFS_OBJECT_TYPE_SPECIAL:
3934 ret_val = yaffs_generic_obj_del(obj);
3936 case YAFFS_OBJECT_TYPE_UNKNOWN:
3938 break; /* should not happen. */
3943 static int yaffs_unlink_worker(struct yaffs_obj *obj)
3953 yaffs_update_parent(obj->parent);
3955 if (obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
3956 return yaffs_del_link(obj);
3957 } else if (!list_empty(&obj->hard_links)) {
3958 /* Curve ball: We're unlinking an object that has a hardlink.
3960 * This problem arises because we are not strictly following
3961 * The Linux link/inode model.
3963 * We can't really delete the object.
3964 * Instead, we do the following:
3965 * - Select a hardlink.
3966 * - Unhook it from the hard links
3967 * - Move it from its parent directory so that the rename works.
3968 * - Rename the object to the hardlink's name.
3969 * - Delete the hardlink
3972 struct yaffs_obj *hl;
3973 struct yaffs_obj *parent;
3975 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
3977 hl = list_entry(obj->hard_links.next, struct yaffs_obj,
3980 yaffs_get_obj_name(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
3981 parent = hl->parent;
3983 list_del_init(&hl->hard_links);
3985 yaffs_add_obj_to_dir(obj->my_dev->unlinked_dir, hl);
3987 ret_val = yaffs_change_obj_name(obj, parent, name, 0, 0);
3989 if (ret_val == YAFFS_OK)
3990 ret_val = yaffs_generic_obj_del(hl);
3994 } else if (del_now) {
3995 switch (obj->variant_type) {
3996 case YAFFS_OBJECT_TYPE_FILE:
3997 return yaffs_del_file(obj);
3999 case YAFFS_OBJECT_TYPE_DIRECTORY:
4000 list_del_init(&obj->variant.dir_variant.dirty);
4001 return yaffs_del_dir(obj);
4003 case YAFFS_OBJECT_TYPE_SYMLINK:
4004 return yaffs_del_symlink(obj);
4006 case YAFFS_OBJECT_TYPE_SPECIAL:
4007 return yaffs_generic_obj_del(obj);
4009 case YAFFS_OBJECT_TYPE_HARDLINK:
4010 case YAFFS_OBJECT_TYPE_UNKNOWN:
4014 } else if (yaffs_is_non_empty_dir(obj)) {
4017 return yaffs_change_obj_name(obj, obj->my_dev->unlinked_dir,
4018 _Y("unlinked"), 0, 0);
4022 static int yaffs_unlink_obj(struct yaffs_obj *obj)
4024 if (obj && obj->unlink_allowed)
4025 return yaffs_unlink_worker(obj);
4030 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR *name)
4032 struct yaffs_obj *obj;
4034 obj = yaffs_find_by_name(dir, name);
4035 return yaffs_unlink_obj(obj);
4039 * If old_name is NULL then we take old_dir as the object to be renamed.
4041 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR *old_name,
4042 struct yaffs_obj *new_dir, const YCHAR *new_name)
4044 struct yaffs_obj *obj = NULL;
4045 struct yaffs_obj *existing_target = NULL;
4048 struct yaffs_dev *dev;
4050 if (!old_dir || old_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4054 if (!new_dir || new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4059 dev = old_dir->my_dev;
4061 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
4062 /* Special case for case insemsitive systems.
4063 * While look-up is case insensitive, the name isn't.
4064 * Therefore we might want to change x.txt to X.txt
4066 if (old_dir == new_dir &&
4067 old_name && new_name &&
4068 strcmp(old_name, new_name) == 0)
4072 if (strnlen(new_name, YAFFS_MAX_NAME_LENGTH + 1) >
4073 YAFFS_MAX_NAME_LENGTH)
4078 obj = yaffs_find_by_name(old_dir, old_name);
4081 old_dir = obj->parent;
4084 if (obj && obj->rename_allowed) {
4085 /* Now handle an existing target, if there is one */
4086 existing_target = yaffs_find_by_name(new_dir, new_name);
4087 if (yaffs_is_non_empty_dir(existing_target)) {
4088 return YAFFS_FAIL; /* ENOTEMPTY */
4089 } else if (existing_target && existing_target != obj) {
4090 /* Nuke the target first, using shadowing,
4091 * but only if it isn't the same object.
4093 * Note we must disable gc here otherwise it can mess
4097 dev->gc_disable = 1;
4098 yaffs_change_obj_name(obj, new_dir, new_name, force,
4099 existing_target->obj_id);
4100 existing_target->is_shadowed = 1;
4101 yaffs_unlink_obj(existing_target);
4102 dev->gc_disable = 0;
4105 result = yaffs_change_obj_name(obj, new_dir, new_name, 1, 0);
4107 yaffs_update_parent(old_dir);
4108 if (new_dir != old_dir)
4109 yaffs_update_parent(new_dir);
4116 /*----------------------- Initialisation Scanning ---------------------- */
4118 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
4119 int backward_scanning)
4121 struct yaffs_obj *obj;
4123 if (backward_scanning) {
4124 /* Handle YAFFS2 case (backward scanning)
4125 * If the shadowed object exists then ignore.
4127 obj = yaffs_find_by_number(dev, obj_id);
4132 /* Let's create it (if it does not exist) assuming it is a file so that
4133 * it can do shrinking etc.
4134 * We put it in unlinked dir to be cleaned up after the scanning
4137 yaffs_find_or_create_by_number(dev, obj_id, YAFFS_OBJECT_TYPE_FILE);
4140 obj->is_shadowed = 1;
4141 yaffs_add_obj_to_dir(dev->unlinked_dir, obj);
4142 obj->variant.file_variant.shrink_size = 0;
4143 obj->valid = 1; /* So that we don't read any other info. */
4146 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list)
4148 struct list_head *lh;
4149 struct list_head *save;
4150 struct yaffs_obj *hl;
4151 struct yaffs_obj *in;
4153 list_for_each_safe(lh, save, hard_list) {
4154 hl = list_entry(lh, struct yaffs_obj, hard_links);
4155 in = yaffs_find_by_number(dev,
4156 hl->variant.hardlink_variant.equiv_id);
4159 /* Add the hardlink pointers */
4160 hl->variant.hardlink_variant.equiv_obj = in;
4161 list_add(&hl->hard_links, &in->hard_links);
4163 /* Todo Need to report/handle this better.
4164 * Got a problem... hardlink to a non-existant object
4166 hl->variant.hardlink_variant.equiv_obj = NULL;
4167 INIT_LIST_HEAD(&hl->hard_links);
4172 static void yaffs_strip_deleted_objs(struct yaffs_dev *dev)
4175 * Sort out state of unlinked and deleted objects after scanning.
4177 struct list_head *i;
4178 struct list_head *n;
4179 struct yaffs_obj *l;
4184 /* Soft delete all the unlinked files */
4185 list_for_each_safe(i, n,
4186 &dev->unlinked_dir->variant.dir_variant.children) {
4187 l = list_entry(i, struct yaffs_obj, siblings);
4191 list_for_each_safe(i, n, &dev->del_dir->variant.dir_variant.children) {
4192 l = list_entry(i, struct yaffs_obj, siblings);
4198 * This code iterates through all the objects making sure that they are rooted.
4199 * Any unrooted objects are re-rooted in lost+found.
4200 * An object needs to be in one of:
4201 * - Directly under deleted, unlinked
4202 * - Directly or indirectly under root.
4205 * This code assumes that we don't ever change the current relationships
4206 * between directories:
4207 * root_dir->parent == unlinked_dir->parent == del_dir->parent == NULL
4208 * lost-n-found->parent == root_dir
4210 * This fixes the problem where directories might have inadvertently been
4211 * deleted leaving the object "hanging" without being rooted in the
4215 static int yaffs_has_null_parent(struct yaffs_dev *dev, struct yaffs_obj *obj)
4217 return (obj == dev->del_dir ||
4218 obj == dev->unlinked_dir || obj == dev->root_dir);
4221 static void yaffs_fix_hanging_objs(struct yaffs_dev *dev)
4223 struct yaffs_obj *obj;
4224 struct yaffs_obj *parent;
4226 struct list_head *lh;
4227 struct list_head *n;
4234 /* Iterate through the objects in each hash entry,
4235 * looking at each object.
4236 * Make sure it is rooted.
4239 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
4240 list_for_each_safe(lh, n, &dev->obj_bucket[i].list) {
4241 obj = list_entry(lh, struct yaffs_obj, hash_link);
4242 parent = obj->parent;
4244 if (yaffs_has_null_parent(dev, obj)) {
4245 /* These directories are not hanging */
4247 } else if (!parent ||
4248 parent->variant_type !=
4249 YAFFS_OBJECT_TYPE_DIRECTORY) {
4251 } else if (yaffs_has_null_parent(dev, parent)) {
4255 * Need to follow the parent chain to
4256 * see if it is hanging.
4261 while (parent != dev->root_dir &&
4263 parent->parent->variant_type ==
4264 YAFFS_OBJECT_TYPE_DIRECTORY &&
4266 parent = parent->parent;
4269 if (parent != dev->root_dir)
4273 yaffs_trace(YAFFS_TRACE_SCAN,
4274 "Hanging object %d moved to lost and found",
4276 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
4283 * Delete directory contents for cleaning up lost and found.
4285 static void yaffs_del_dir_contents(struct yaffs_obj *dir)
4287 struct yaffs_obj *obj;
4288 struct list_head *lh;
4289 struct list_head *n;
4291 if (dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
4294 list_for_each_safe(lh, n, &dir->variant.dir_variant.children) {
4295 obj = list_entry(lh, struct yaffs_obj, siblings);
4296 if (obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY)
4297 yaffs_del_dir_contents(obj);
4298 yaffs_trace(YAFFS_TRACE_SCAN,
4299 "Deleting lost_found object %d",
4301 yaffs_unlink_obj(obj);
4305 static void yaffs_empty_l_n_f(struct yaffs_dev *dev)
4307 yaffs_del_dir_contents(dev->lost_n_found);
4311 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *directory,
4315 struct list_head *i;
4316 YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
4317 struct yaffs_obj *l;
4323 yaffs_trace(YAFFS_TRACE_ALWAYS,
4324 "tragedy: yaffs_find_by_name: null pointer directory"
4329 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4330 yaffs_trace(YAFFS_TRACE_ALWAYS,
4331 "tragedy: yaffs_find_by_name: non-directory"
4336 sum = yaffs_calc_name_sum(name);
4338 list_for_each(i, &directory->variant.dir_variant.children) {
4339 l = list_entry(i, struct yaffs_obj, siblings);
4341 if (l->parent != directory)
4344 yaffs_check_obj_details_loaded(l);
4346 /* Special case for lost-n-found */
4347 if (l->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4348 if (!strcmp(name, YAFFS_LOSTNFOUND_NAME))
4350 } else if (l->sum == sum || l->hdr_chunk <= 0) {
4351 /* LostnFound chunk called Objxxx
4354 yaffs_get_obj_name(l, buffer,
4355 YAFFS_MAX_NAME_LENGTH + 1);
4356 if (strncmp(name, buffer, YAFFS_MAX_NAME_LENGTH) == 0)
4363 /* GetEquivalentObject dereferences any hard links to get to the
4367 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj)
4369 if (obj && obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
4370 obj = obj->variant.hardlink_variant.equiv_obj;
4371 yaffs_check_obj_details_loaded(obj);
4377 * A note or two on object names.
4378 * * If the object name is missing, we then make one up in the form objnnn
4380 * * ASCII names are stored in the object header's name field from byte zero
4381 * * Unicode names are historically stored starting from byte zero.
4383 * Then there are automatic Unicode names...
4384 * The purpose of these is to save names in a way that can be read as
4385 * ASCII or Unicode names as appropriate, thus allowing a Unicode and ASCII
4386 * system to share files.
4388 * These automatic unicode are stored slightly differently...
4389 * - If the name can fit in the ASCII character space then they are saved as
4390 * ascii names as per above.
4391 * - If the name needs Unicode then the name is saved in Unicode
4392 * starting at oh->name[1].
4395 static void yaffs_fix_null_name(struct yaffs_obj *obj, YCHAR *name,
4398 /* Create an object name if we could not find one. */
4399 if (strnlen(name, YAFFS_MAX_NAME_LENGTH) == 0) {
4400 YCHAR local_name[20];
4401 YCHAR num_string[20];
4402 YCHAR *x = &num_string[19];
4403 unsigned v = obj->obj_id;
4407 *x = '0' + (v % 10);
4410 /* make up a name */
4411 strcpy(local_name, YAFFS_LOSTNFOUND_PREFIX);
4412 strcat(local_name, x);
4413 strncpy(name, local_name, buffer_size - 1);
4417 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR *name, int buffer_size)
4419 memset(name, 0, buffer_size * sizeof(YCHAR));
4420 yaffs_check_obj_details_loaded(obj);
4421 if (obj->obj_id == YAFFS_OBJECTID_LOSTNFOUND)
4422 strncpy(name, YAFFS_LOSTNFOUND_NAME, buffer_size - 1);
4423 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
4424 else if (obj->short_name[0])
4425 strcpy(name, obj->short_name);
4427 else if (obj->hdr_chunk > 0) {
4429 u8 *buffer = yaffs_get_temp_buffer(obj->my_dev);
4431 struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)buffer;
4433 memset(buffer, 0, obj->my_dev->data_bytes_per_chunk);
4435 if (obj->hdr_chunk > 0) {
4436 result = yaffs_rd_chunk_tags_nand(obj->my_dev,
4440 yaffs_load_name_from_oh(obj->my_dev, name, oh->name,
4443 yaffs_release_temp_buffer(obj->my_dev, buffer);
4446 yaffs_fix_null_name(obj, name, buffer_size);
4448 return strnlen(name, YAFFS_MAX_NAME_LENGTH);
4451 int yaffs_get_obj_length(struct yaffs_obj *obj)
4453 /* Dereference any hard linking */
4454 obj = yaffs_get_equivalent_obj(obj);
4456 if (obj->variant_type == YAFFS_OBJECT_TYPE_FILE)
4457 return obj->variant.file_variant.file_size;
4458 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
4459 if (!obj->variant.symlink_variant.alias)
4461 return strnlen(obj->variant.symlink_variant.alias,
4462 YAFFS_MAX_ALIAS_LENGTH);
4464 /* Only a directory should drop through to here */
4465 return obj->my_dev->data_bytes_per_chunk;
4469 int yaffs_get_obj_link_count(struct yaffs_obj *obj)
4472 struct list_head *i;
4475 count++; /* the object itself */
4477 list_for_each(i, &obj->hard_links)
4478 count++; /* add the hard links; */
4483 int yaffs_get_obj_inode(struct yaffs_obj *obj)
4485 obj = yaffs_get_equivalent_obj(obj);
4490 unsigned yaffs_get_obj_type(struct yaffs_obj *obj)
4492 obj = yaffs_get_equivalent_obj(obj);
4494 switch (obj->variant_type) {
4495 case YAFFS_OBJECT_TYPE_FILE:
4498 case YAFFS_OBJECT_TYPE_DIRECTORY:
4501 case YAFFS_OBJECT_TYPE_SYMLINK:
4504 case YAFFS_OBJECT_TYPE_HARDLINK:
4507 case YAFFS_OBJECT_TYPE_SPECIAL:
4508 if (S_ISFIFO(obj->yst_mode))
4510 if (S_ISCHR(obj->yst_mode))
4512 if (S_ISBLK(obj->yst_mode))
4514 if (S_ISSOCK(obj->yst_mode))
4524 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj)
4526 obj = yaffs_get_equivalent_obj(obj);
4527 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK)
4528 return yaffs_clone_str(obj->variant.symlink_variant.alias);
4530 return yaffs_clone_str(_Y(""));
4533 /*--------------------------- Initialisation code -------------------------- */
4535 static int yaffs_check_dev_fns(const struct yaffs_dev *dev)
4537 /* Common functions, gotta have */
4538 if (!dev->param.erase_fn || !dev->param.initialise_flash_fn)
4541 #ifdef CONFIG_YAFFS_YAFFS2
4543 /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
4544 if (dev->param.write_chunk_tags_fn &&
4545 dev->param.read_chunk_tags_fn &&
4546 !dev->param.write_chunk_fn &&
4547 !dev->param.read_chunk_fn &&
4548 dev->param.bad_block_fn && dev->param.query_block_fn)
4552 /* Can use the "spare" style interface for yaffs1 */
4553 if (!dev->param.is_yaffs2 &&
4554 !dev->param.write_chunk_tags_fn &&
4555 !dev->param.read_chunk_tags_fn &&
4556 dev->param.write_chunk_fn &&
4557 dev->param.read_chunk_fn &&
4558 !dev->param.bad_block_fn && !dev->param.query_block_fn)
4564 static int yaffs_create_initial_dir(struct yaffs_dev *dev)
4566 /* Initialise the unlinked, deleted, root and lost+found directories */
4567 dev->lost_n_found = dev->root_dir = NULL;
4568 dev->unlinked_dir = dev->del_dir = NULL;
4570 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
4572 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
4574 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_ROOT,
4575 YAFFS_ROOT_MODE | S_IFDIR);
4577 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_LOSTNFOUND,
4578 YAFFS_LOSTNFOUND_MODE | S_IFDIR);
4580 if (dev->lost_n_found && dev->root_dir && dev->unlinked_dir
4582 yaffs_add_obj_to_dir(dev->root_dir, dev->lost_n_found);
4588 int yaffs_guts_initialise(struct yaffs_dev *dev)
4590 int init_failed = 0;
4594 yaffs_trace(YAFFS_TRACE_TRACING, "yaffs: yaffs_guts_initialise()");
4596 /* Check stuff that must be set */
4599 yaffs_trace(YAFFS_TRACE_ALWAYS,
4600 "yaffs: Need a device"
4605 if (dev->is_mounted) {
4606 yaffs_trace(YAFFS_TRACE_ALWAYS, "device already mounted");
4610 dev->internal_start_block = dev->param.start_block;
4611 dev->internal_end_block = dev->param.end_block;
4612 dev->block_offset = 0;
4613 dev->chunk_offset = 0;
4614 dev->n_free_chunks = 0;
4618 if (dev->param.start_block == 0) {
4619 dev->internal_start_block = dev->param.start_block + 1;
4620 dev->internal_end_block = dev->param.end_block + 1;
4621 dev->block_offset = 1;
4622 dev->chunk_offset = dev->param.chunks_per_block;
4625 /* Check geometry parameters. */
4627 if ((!dev->param.inband_tags && dev->param.is_yaffs2 &&
4628 dev->param.total_bytes_per_chunk < 1024) ||
4629 (!dev->param.is_yaffs2 &&
4630 dev->param.total_bytes_per_chunk < 512) ||
4631 (dev->param.inband_tags && !dev->param.is_yaffs2) ||
4632 dev->param.chunks_per_block < 2 ||
4633 dev->param.n_reserved_blocks < 2 ||
4634 dev->internal_start_block <= 0 ||
4635 dev->internal_end_block <= 0 ||
4636 dev->internal_end_block <=
4637 (dev->internal_start_block + dev->param.n_reserved_blocks + 2)
4639 /* otherwise it is too small */
4640 yaffs_trace(YAFFS_TRACE_ALWAYS,
4641 "NAND geometry problems: chunk size %d, type is yaffs%s, inband_tags %d ",
4642 dev->param.total_bytes_per_chunk,
4643 dev->param.is_yaffs2 ? "2" : "",
4644 dev->param.inband_tags);
4648 if (yaffs_init_nand(dev) != YAFFS_OK) {
4649 yaffs_trace(YAFFS_TRACE_ALWAYS, "InitialiseNAND failed");
4653 /* Sort out space for inband tags, if required */
4654 if (dev->param.inband_tags)
4655 dev->data_bytes_per_chunk =
4656 dev->param.total_bytes_per_chunk -
4657 sizeof(struct yaffs_packed_tags2_tags_only);
4659 dev->data_bytes_per_chunk = dev->param.total_bytes_per_chunk;
4661 /* Got the right mix of functions? */
4662 if (!yaffs_check_dev_fns(dev)) {
4663 /* Function missing */
4664 yaffs_trace(YAFFS_TRACE_ALWAYS,
4665 "device function(s) missing or wrong");
4670 /* Finished with most checks. Further checks happen later on too. */
4672 dev->is_mounted = 1;
4674 /* OK now calculate a few things for the device */
4677 * Calculate all the chunk size manipulation numbers:
4679 x = dev->data_bytes_per_chunk;
4680 /* We always use dev->chunk_shift and dev->chunk_div */
4681 dev->chunk_shift = calc_shifts(x);
4682 x >>= dev->chunk_shift;
4684 /* We only use chunk mask if chunk_div is 1 */
4685 dev->chunk_mask = (1 << dev->chunk_shift) - 1;
4688 * Calculate chunk_grp_bits.
4689 * We need to find the next power of 2 > than internal_end_block
4692 x = dev->param.chunks_per_block * (dev->internal_end_block + 1);
4694 bits = calc_shifts_ceiling(x);
4696 /* Set up tnode width if wide tnodes are enabled. */
4697 if (!dev->param.wide_tnodes_disabled) {
4698 /* bits must be even so that we end up with 32-bit words */
4702 dev->tnode_width = 16;
4704 dev->tnode_width = bits;
4706 dev->tnode_width = 16;
4709 dev->tnode_mask = (1 << dev->tnode_width) - 1;
4711 /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
4712 * so if the bitwidth of the
4713 * chunk range we're using is greater than 16 we need
4714 * to figure out chunk shift and chunk_grp_size
4717 if (bits <= dev->tnode_width)
4718 dev->chunk_grp_bits = 0;
4720 dev->chunk_grp_bits = bits - dev->tnode_width;
4722 dev->tnode_size = (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8;
4723 if (dev->tnode_size < sizeof(struct yaffs_tnode))
4724 dev->tnode_size = sizeof(struct yaffs_tnode);
4726 dev->chunk_grp_size = 1 << dev->chunk_grp_bits;
4728 if (dev->param.chunks_per_block < dev->chunk_grp_size) {
4729 /* We have a problem because the soft delete won't work if
4730 * the chunk group size > chunks per block.
4731 * This can be remedied by using larger "virtual blocks".
4733 yaffs_trace(YAFFS_TRACE_ALWAYS, "chunk group too large");
4738 /* Finished verifying the device, continue with initialisation */
4740 /* More device initialisation */
4742 dev->passive_gc_count = 0;
4743 dev->oldest_dirty_gc_count = 0;
4745 dev->gc_block_finder = 0;
4746 dev->buffered_block = -1;
4747 dev->doing_buffered_block_rewrite = 0;
4748 dev->n_deleted_files = 0;
4749 dev->n_bg_deletions = 0;
4750 dev->n_unlinked_files = 0;
4751 dev->n_ecc_fixed = 0;
4752 dev->n_ecc_unfixed = 0;
4753 dev->n_tags_ecc_fixed = 0;
4754 dev->n_tags_ecc_unfixed = 0;
4755 dev->n_erase_failures = 0;
4756 dev->n_erased_blocks = 0;
4757 dev->gc_disable = 0;
4758 dev->has_pending_prioritised_gc = 1;
4759 /* Assume the worst for now, will get fixed on first GC */
4760 INIT_LIST_HEAD(&dev->dirty_dirs);
4761 dev->oldest_dirty_seq = 0;
4762 dev->oldest_dirty_block = 0;
4764 /* Initialise temporary buffers and caches. */
4765 if (!yaffs_init_tmp_buffers(dev))
4769 dev->gc_cleanup_list = NULL;
4771 if (!init_failed && dev->param.n_caches > 0) {
4775 dev->param.n_caches * sizeof(struct yaffs_cache);
4777 if (dev->param.n_caches > YAFFS_MAX_SHORT_OP_CACHES)
4778 dev->param.n_caches = YAFFS_MAX_SHORT_OP_CACHES;
4780 dev->cache = kmalloc(cache_bytes, GFP_NOFS);
4782 buf = (u8 *) dev->cache;
4785 memset(dev->cache, 0, cache_bytes);
4787 for (i = 0; i < dev->param.n_caches && buf; i++) {
4788 dev->cache[i].object = NULL;
4789 dev->cache[i].last_use = 0;
4790 dev->cache[i].dirty = 0;
4791 dev->cache[i].data = buf =
4792 kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
4797 dev->cache_last_use = 0;
4800 dev->cache_hits = 0;
4803 dev->gc_cleanup_list =
4804 kmalloc(dev->param.chunks_per_block * sizeof(u32),
4806 if (!dev->gc_cleanup_list)
4810 if (dev->param.is_yaffs2)
4811 dev->param.use_header_file_size = 1;
4813 if (!init_failed && !yaffs_init_blocks(dev))
4816 yaffs_init_tnodes_and_objs(dev);
4818 if (!init_failed && !yaffs_create_initial_dir(dev))
4821 if(!init_failed && dev->param.is_yaffs2 &&
4822 !dev->param.disable_summary &&
4823 !yaffs_summary_init(dev))
4827 /* Now scan the flash. */
4828 if (dev->param.is_yaffs2) {
4829 if (yaffs2_checkpt_restore(dev)) {
4830 yaffs_check_obj_details_loaded(dev->root_dir);
4831 yaffs_trace(YAFFS_TRACE_CHECKPOINT |
4833 "yaffs: restored from checkpoint"
4837 /* Clean up the mess caused by an aborted
4838 * checkpoint load then scan backwards.
4840 yaffs_deinit_blocks(dev);
4842 yaffs_deinit_tnodes_and_objs(dev);
4844 dev->n_erased_blocks = 0;
4845 dev->n_free_chunks = 0;
4846 dev->alloc_block = -1;
4847 dev->alloc_page = -1;
4848 dev->n_deleted_files = 0;
4849 dev->n_unlinked_files = 0;
4850 dev->n_bg_deletions = 0;
4852 if (!init_failed && !yaffs_init_blocks(dev))
4855 yaffs_init_tnodes_and_objs(dev);
4858 && !yaffs_create_initial_dir(dev))
4861 if (!init_failed && !yaffs2_scan_backwards(dev))
4864 } else if (!yaffs1_scan(dev)) {
4868 yaffs_strip_deleted_objs(dev);
4869 yaffs_fix_hanging_objs(dev);
4870 if (dev->param.empty_lost_n_found)
4871 yaffs_empty_l_n_f(dev);
4875 /* Clean up the mess */
4876 yaffs_trace(YAFFS_TRACE_TRACING,
4877 "yaffs: yaffs_guts_initialise() aborted.");
4879 yaffs_deinitialise(dev);
4883 /* Zero out stats */
4884 dev->n_page_reads = 0;
4885 dev->n_page_writes = 0;
4886 dev->n_erasures = 0;
4887 dev->n_gc_copies = 0;
4888 dev->n_retired_writes = 0;
4890 dev->n_retired_blocks = 0;
4892 yaffs_verify_free_chunks(dev);
4893 yaffs_verify_blocks(dev);
4895 /* Clean up any aborted checkpoint data */
4896 if (!dev->is_checkpointed && dev->blocks_in_checkpt > 0)
4897 yaffs2_checkpt_invalidate(dev);
4899 yaffs_trace(YAFFS_TRACE_TRACING,
4900 "yaffs: yaffs_guts_initialise() done.");
4904 void yaffs_deinitialise(struct yaffs_dev *dev)
4906 if (dev->is_mounted) {
4909 yaffs_deinit_blocks(dev);
4910 yaffs_deinit_tnodes_and_objs(dev);
4911 yaffs_summary_deinit(dev);
4913 if (dev->param.n_caches > 0 && dev->cache) {
4915 for (i = 0; i < dev->param.n_caches; i++) {
4916 kfree(dev->cache[i].data);
4917 dev->cache[i].data = NULL;
4924 kfree(dev->gc_cleanup_list);
4926 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
4927 kfree(dev->temp_buffer[i].buffer);
4929 dev->is_mounted = 0;
4931 if (dev->param.deinitialise_flash_fn)
4932 dev->param.deinitialise_flash_fn(dev);
4936 int yaffs_count_free_chunks(struct yaffs_dev *dev)
4940 struct yaffs_block_info *blk;
4942 blk = dev->block_info;
4943 for (b = dev->internal_start_block; b <= dev->internal_end_block; b++) {
4944 switch (blk->block_state) {
4945 case YAFFS_BLOCK_STATE_EMPTY:
4946 case YAFFS_BLOCK_STATE_ALLOCATING:
4947 case YAFFS_BLOCK_STATE_COLLECTING:
4948 case YAFFS_BLOCK_STATE_FULL:
4950 (dev->param.chunks_per_block - blk->pages_in_use +
4951 blk->soft_del_pages);
4961 int yaffs_get_n_free_chunks(struct yaffs_dev *dev)
4963 /* This is what we report to the outside world */
4966 int blocks_for_checkpt;
4969 n_free = dev->n_free_chunks;
4970 n_free += dev->n_deleted_files;
4972 /* Now count and subtract the number of dirty chunks in the cache. */
4974 for (n_dirty_caches = 0, i = 0; i < dev->param.n_caches; i++) {
4975 if (dev->cache[i].dirty)
4979 n_free -= n_dirty_caches;
4982 ((dev->param.n_reserved_blocks + 1) * dev->param.chunks_per_block);
4984 /* Now figure checkpoint space and report that... */
4985 blocks_for_checkpt = yaffs_calc_checkpt_blocks_required(dev);
4987 n_free -= (blocks_for_checkpt * dev->param.chunks_per_block);