2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2011 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
15 #include "yaffs_trace.h"
17 #include "yaffs_guts.h"
18 #include "yaffs_getblockinfo.h"
19 #include "yaffs_tagscompat.h"
20 #include "yaffs_nand.h"
21 #include "yaffs_yaffs1.h"
22 #include "yaffs_yaffs2.h"
23 #include "yaffs_bitmap.h"
24 #include "yaffs_verify.h"
25 #include "yaffs_nand.h"
26 #include "yaffs_packedtags2.h"
27 #include "yaffs_nameval.h"
28 #include "yaffs_allocator.h"
29 #include "yaffs_attribs.h"
30 #include "yaffs_summary.h"
32 /* Note YAFFS_GC_GOOD_ENOUGH must be <= YAFFS_GC_PASSIVE_THRESHOLD */
33 #define YAFFS_GC_GOOD_ENOUGH 2
34 #define YAFFS_GC_PASSIVE_THRESHOLD 4
36 #include "yaffs_ecc.h"
38 /* Forward declarations */
40 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
41 const u8 *buffer, int n_bytes, int use_reserve);
45 /* Function to calculate chunk and offset */
47 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
48 int *chunk_out, u32 *offset_out)
53 chunk = (u32) (addr >> dev->chunk_shift);
55 if (dev->chunk_div == 1) {
56 /* easy power of 2 case */
57 offset = (u32) (addr & dev->chunk_mask);
59 /* Non power-of-2 case */
63 chunk /= dev->chunk_div;
65 chunk_base = ((loff_t) chunk) * dev->data_bytes_per_chunk;
66 offset = (u32) (addr - chunk_base);
73 /* Function to return the number of shifts for a power of 2 greater than or
74 * equal to the given number
75 * Note we don't try to cater for all possible numbers and this does not have to
76 * be hellishly efficient.
79 static inline u32 calc_shifts_ceiling(u32 x)
84 shifts = extra_bits = 0;
99 /* Function to return the number of shifts to get a 1 in bit 0
102 static inline u32 calc_shifts(u32 x)
120 * Temporary buffer manipulations.
123 static int yaffs_init_tmp_buffers(struct yaffs_dev *dev)
128 memset(dev->temp_buffer, 0, sizeof(dev->temp_buffer));
130 for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
131 dev->temp_buffer[i].in_use = 0;
132 buf = kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
133 dev->temp_buffer[i].buffer = buf;
136 return buf ? YAFFS_OK : YAFFS_FAIL;
139 u8 *yaffs_get_temp_buffer(struct yaffs_dev * dev)
144 if (dev->temp_in_use > dev->max_temp)
145 dev->max_temp = dev->temp_in_use;
147 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
148 if (dev->temp_buffer[i].in_use == 0) {
149 dev->temp_buffer[i].in_use = 1;
150 return dev->temp_buffer[i].buffer;
154 yaffs_trace(YAFFS_TRACE_BUFFERS, "Out of temp buffers");
156 * If we got here then we have to allocate an unmanaged one
160 dev->unmanaged_buffer_allocs++;
161 return kmalloc(dev->data_bytes_per_chunk, GFP_NOFS);
165 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer)
171 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
172 if (dev->temp_buffer[i].buffer == buffer) {
173 dev->temp_buffer[i].in_use = 0;
179 /* assume it is an unmanaged one. */
180 yaffs_trace(YAFFS_TRACE_BUFFERS,
181 "Releasing unmanaged temp buffer");
183 dev->unmanaged_buffer_deallocs++;
189 * Functions for robustisizing TODO
193 static void yaffs_handle_chunk_wr_ok(struct yaffs_dev *dev, int nand_chunk,
195 const struct yaffs_ext_tags *tags)
203 static void yaffs_handle_chunk_update(struct yaffs_dev *dev, int nand_chunk,
204 const struct yaffs_ext_tags *tags)
211 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
212 struct yaffs_block_info *bi)
214 if (!bi->gc_prioritise) {
215 bi->gc_prioritise = 1;
216 dev->has_pending_prioritised_gc = 1;
217 bi->chunk_error_strikes++;
219 if (bi->chunk_error_strikes > 3) {
220 bi->needs_retiring = 1; /* Too many stikes, so retire */
221 yaffs_trace(YAFFS_TRACE_ALWAYS,
222 "yaffs: Block struck out");
228 static void yaffs_handle_chunk_wr_error(struct yaffs_dev *dev, int nand_chunk,
231 int flash_block = nand_chunk / dev->param.chunks_per_block;
232 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
234 yaffs_handle_chunk_error(dev, bi);
237 /* Was an actual write failure,
238 * so mark the block for retirement.*/
239 bi->needs_retiring = 1;
240 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
241 "**>> Block %d needs retiring", flash_block);
244 /* Delete the chunk */
245 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
246 yaffs_skip_rest_of_block(dev);
254 * Simple hash function. Needs to have a reasonable spread
257 static inline int yaffs_hash_fn(int n)
261 return n % YAFFS_NOBJECT_BUCKETS;
265 * Access functions to useful fake objects.
266 * Note that root might have a presence in NAND if permissions are set.
269 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev)
271 return dev->root_dir;
274 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev)
276 return dev->lost_n_found;
280 * Erased NAND checking functions
283 int yaffs_check_ff(u8 *buffer, int n_bytes)
285 /* Horrible, slow implementation */
294 static int yaffs_check_chunk_erased(struct yaffs_dev *dev, int nand_chunk)
296 int retval = YAFFS_OK;
297 u8 *data = yaffs_get_temp_buffer(dev);
298 struct yaffs_ext_tags tags;
301 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, data, &tags);
303 if (tags.ecc_result > YAFFS_ECC_RESULT_NO_ERROR)
306 if (!yaffs_check_ff(data, dev->data_bytes_per_chunk) ||
308 yaffs_trace(YAFFS_TRACE_NANDACCESS,
309 "Chunk %d not erased", nand_chunk);
313 yaffs_release_temp_buffer(dev, data);
319 static int yaffs_verify_chunk_written(struct yaffs_dev *dev,
322 struct yaffs_ext_tags *tags)
324 int retval = YAFFS_OK;
325 struct yaffs_ext_tags temp_tags;
326 u8 *buffer = yaffs_get_temp_buffer(dev);
329 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, buffer, &temp_tags);
330 if (memcmp(buffer, data, dev->data_bytes_per_chunk) ||
331 temp_tags.obj_id != tags->obj_id ||
332 temp_tags.chunk_id != tags->chunk_id ||
333 temp_tags.n_bytes != tags->n_bytes)
336 yaffs_release_temp_buffer(dev, buffer);
342 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks)
345 int reserved_blocks = dev->param.n_reserved_blocks;
348 checkpt_blocks = yaffs_calc_checkpt_blocks_required(dev);
351 (reserved_blocks + checkpt_blocks) * dev->param.chunks_per_block;
353 return (dev->n_free_chunks > (reserved_chunks + n_chunks));
356 static int yaffs_find_alloc_block(struct yaffs_dev *dev)
359 struct yaffs_block_info *bi;
361 if (dev->n_erased_blocks < 1) {
362 /* Hoosterman we've got a problem.
363 * Can't get space to gc
365 yaffs_trace(YAFFS_TRACE_ERROR,
366 "yaffs tragedy: no more erased blocks");
371 /* Find an empty block. */
373 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
374 dev->alloc_block_finder++;
375 if (dev->alloc_block_finder < dev->internal_start_block
376 || dev->alloc_block_finder > dev->internal_end_block) {
377 dev->alloc_block_finder = dev->internal_start_block;
380 bi = yaffs_get_block_info(dev, dev->alloc_block_finder);
382 if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
383 bi->block_state = YAFFS_BLOCK_STATE_ALLOCATING;
385 bi->seq_number = dev->seq_number;
386 dev->n_erased_blocks--;
387 yaffs_trace(YAFFS_TRACE_ALLOCATE,
388 "Allocated block %d, seq %d, %d left" ,
389 dev->alloc_block_finder, dev->seq_number,
390 dev->n_erased_blocks);
391 return dev->alloc_block_finder;
395 yaffs_trace(YAFFS_TRACE_ALWAYS,
396 "yaffs tragedy: no more erased blocks, but there should have been %d",
397 dev->n_erased_blocks);
402 static int yaffs_alloc_chunk(struct yaffs_dev *dev, int use_reserver,
403 struct yaffs_block_info **block_ptr)
406 struct yaffs_block_info *bi;
408 if (dev->alloc_block < 0) {
409 /* Get next block to allocate off */
410 dev->alloc_block = yaffs_find_alloc_block(dev);
414 if (!use_reserver && !yaffs_check_alloc_available(dev, 1)) {
415 /* No space unless we're allowed to use the reserve. */
419 if (dev->n_erased_blocks < dev->param.n_reserved_blocks
420 && dev->alloc_page == 0)
421 yaffs_trace(YAFFS_TRACE_ALLOCATE, "Allocating reserve");
423 /* Next page please.... */
424 if (dev->alloc_block >= 0) {
425 bi = yaffs_get_block_info(dev, dev->alloc_block);
427 ret_val = (dev->alloc_block * dev->param.chunks_per_block) +
430 yaffs_set_chunk_bit(dev, dev->alloc_block, dev->alloc_page);
434 dev->n_free_chunks--;
436 /* If the block is full set the state to full */
437 if (dev->alloc_page >= dev->param.chunks_per_block) {
438 bi->block_state = YAFFS_BLOCK_STATE_FULL;
439 dev->alloc_block = -1;
448 yaffs_trace(YAFFS_TRACE_ERROR,
449 "!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!");
454 static int yaffs_get_erased_chunks(struct yaffs_dev *dev)
458 n = dev->n_erased_blocks * dev->param.chunks_per_block;
460 if (dev->alloc_block > 0)
461 n += (dev->param.chunks_per_block - dev->alloc_page);
468 * yaffs_skip_rest_of_block() skips over the rest of the allocation block
469 * if we don't want to write to it.
471 void yaffs_skip_rest_of_block(struct yaffs_dev *dev)
473 struct yaffs_block_info *bi;
475 if (dev->alloc_block > 0) {
476 bi = yaffs_get_block_info(dev, dev->alloc_block);
477 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING) {
478 bi->block_state = YAFFS_BLOCK_STATE_FULL;
479 dev->alloc_block = -1;
484 static int yaffs_write_new_chunk(struct yaffs_dev *dev,
486 struct yaffs_ext_tags *tags, int use_reserver)
492 yaffs2_checkpt_invalidate(dev);
495 struct yaffs_block_info *bi = 0;
498 chunk = yaffs_alloc_chunk(dev, use_reserver, &bi);
504 /* First check this chunk is erased, if it needs
505 * checking. The checking policy (unless forced
506 * always on) is as follows:
508 * Check the first page we try to write in a block.
509 * If the check passes then we don't need to check any
510 * more. If the check fails, we check again...
511 * If the block has been erased, we don't need to check.
513 * However, if the block has been prioritised for gc,
514 * then we think there might be something odd about
515 * this block and stop using it.
517 * Rationale: We should only ever see chunks that have
518 * not been erased if there was a partially written
519 * chunk due to power loss. This checking policy should
520 * catch that case with very few checks and thus save a
521 * lot of checks that are most likely not needed.
524 * If an erase check fails or the write fails we skip the
528 /* let's give it a try */
531 if (dev->param.always_check_erased)
532 bi->skip_erased_check = 0;
534 if (!bi->skip_erased_check) {
535 erased_ok = yaffs_check_chunk_erased(dev, chunk);
536 if (erased_ok != YAFFS_OK) {
537 yaffs_trace(YAFFS_TRACE_ERROR,
538 "**>> yaffs chunk %d was not erased",
541 /* If not erased, delete this one,
542 * skip rest of block and
543 * try another chunk */
544 yaffs_chunk_del(dev, chunk, 1, __LINE__);
545 yaffs_skip_rest_of_block(dev);
550 write_ok = yaffs_wr_chunk_tags_nand(dev, chunk, data, tags);
552 if (!bi->skip_erased_check)
554 yaffs_verify_chunk_written(dev, chunk, data, tags);
556 if (write_ok != YAFFS_OK) {
557 /* Clean up aborted write, skip to next block and
558 * try another chunk */
559 yaffs_handle_chunk_wr_error(dev, chunk, erased_ok);
563 bi->skip_erased_check = 1;
565 /* Copy the data into the robustification buffer */
566 yaffs_handle_chunk_wr_ok(dev, chunk, data, tags);
568 } while (write_ok != YAFFS_OK &&
569 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
575 yaffs_trace(YAFFS_TRACE_ERROR,
576 "**>> yaffs write required %d attempts",
578 dev->n_retried_writes += (attempts - 1);
585 * Block retiring for handling a broken block.
588 static void yaffs_retire_block(struct yaffs_dev *dev, int flash_block)
590 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
592 yaffs2_checkpt_invalidate(dev);
594 yaffs2_clear_oldest_dirty_seq(dev, bi);
596 if (yaffs_mark_bad(dev, flash_block) != YAFFS_OK) {
597 if (yaffs_erase_block(dev, flash_block) != YAFFS_OK) {
598 yaffs_trace(YAFFS_TRACE_ALWAYS,
599 "yaffs: Failed to mark bad and erase block %d",
602 struct yaffs_ext_tags tags;
604 flash_block * dev->param.chunks_per_block;
606 u8 *buffer = yaffs_get_temp_buffer(dev);
608 memset(buffer, 0xff, dev->data_bytes_per_chunk);
609 memset(&tags, 0, sizeof(tags));
610 tags.seq_number = YAFFS_SEQUENCE_BAD_BLOCK;
611 if (dev->param.write_chunk_tags_fn(dev, chunk_id -
615 yaffs_trace(YAFFS_TRACE_ALWAYS,
616 "yaffs: Failed to write bad block marker to block %d",
619 yaffs_release_temp_buffer(dev, buffer);
623 bi->block_state = YAFFS_BLOCK_STATE_DEAD;
624 bi->gc_prioritise = 0;
625 bi->needs_retiring = 0;
627 dev->n_retired_blocks++;
630 /*---------------- Name handling functions ------------*/
632 static u16 yaffs_calc_name_sum(const YCHAR *name)
640 while ((*name) && i < (YAFFS_MAX_NAME_LENGTH / 2)) {
642 /* 0x1f mask is case insensitive */
643 sum += ((*name) & 0x1f) * i;
650 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR * name)
652 memset(obj->short_name, 0, sizeof(obj->short_name));
654 strnlen(name, YAFFS_SHORT_NAME_LENGTH + 1) <=
655 YAFFS_SHORT_NAME_LENGTH)
656 strcpy(obj->short_name, name);
658 obj->short_name[0] = _Y('\0');
659 obj->sum = yaffs_calc_name_sum(name);
662 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
663 const struct yaffs_obj_hdr *oh)
665 #ifdef CONFIG_YAFFS_AUTO_UNICODE
666 YCHAR tmp_name[YAFFS_MAX_NAME_LENGTH + 1];
667 memset(tmp_name, 0, sizeof(tmp_name));
668 yaffs_load_name_from_oh(obj->my_dev, tmp_name, oh->name,
669 YAFFS_MAX_NAME_LENGTH + 1);
670 yaffs_set_obj_name(obj, tmp_name);
672 yaffs_set_obj_name(obj, oh->name);
676 loff_t yaffs_max_file_size(struct yaffs_dev *dev)
678 if(sizeof(loff_t) < 8)
679 return YAFFS_MAX_FILE_SIZE_32;
681 return ((loff_t) YAFFS_MAX_CHUNK_ID) * dev->data_bytes_per_chunk;
684 /*-------------------- TNODES -------------------
686 * List of spare tnodes
687 * The list is hooked together using the first pointer
691 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev)
693 struct yaffs_tnode *tn = yaffs_alloc_raw_tnode(dev);
696 memset(tn, 0, dev->tnode_size);
700 dev->checkpoint_blocks_required = 0; /* force recalculation */
705 /* FreeTnode frees up a tnode and puts it back on the free list */
706 static void yaffs_free_tnode(struct yaffs_dev *dev, struct yaffs_tnode *tn)
708 yaffs_free_raw_tnode(dev, tn);
710 dev->checkpoint_blocks_required = 0; /* force recalculation */
713 static void yaffs_deinit_tnodes_and_objs(struct yaffs_dev *dev)
715 yaffs_deinit_raw_tnodes_and_objs(dev);
720 static void yaffs_load_tnode_0(struct yaffs_dev *dev, struct yaffs_tnode *tn,
721 unsigned pos, unsigned val)
723 u32 *map = (u32 *) tn;
729 pos &= YAFFS_TNODES_LEVEL0_MASK;
730 val >>= dev->chunk_grp_bits;
732 bit_in_map = pos * dev->tnode_width;
733 word_in_map = bit_in_map / 32;
734 bit_in_word = bit_in_map & (32 - 1);
736 mask = dev->tnode_mask << bit_in_word;
738 map[word_in_map] &= ~mask;
739 map[word_in_map] |= (mask & (val << bit_in_word));
741 if (dev->tnode_width > (32 - bit_in_word)) {
742 bit_in_word = (32 - bit_in_word);
745 dev->tnode_mask >> bit_in_word;
746 map[word_in_map] &= ~mask;
747 map[word_in_map] |= (mask & (val >> bit_in_word));
751 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
754 u32 *map = (u32 *) tn;
760 pos &= YAFFS_TNODES_LEVEL0_MASK;
762 bit_in_map = pos * dev->tnode_width;
763 word_in_map = bit_in_map / 32;
764 bit_in_word = bit_in_map & (32 - 1);
766 val = map[word_in_map] >> bit_in_word;
768 if (dev->tnode_width > (32 - bit_in_word)) {
769 bit_in_word = (32 - bit_in_word);
771 val |= (map[word_in_map] << bit_in_word);
774 val &= dev->tnode_mask;
775 val <<= dev->chunk_grp_bits;
780 /* ------------------- End of individual tnode manipulation -----------------*/
782 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
783 * The look up tree is represented by the top tnode and the number of top_level
784 * in the tree. 0 means only the level 0 tnode is in the tree.
787 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
788 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
789 struct yaffs_file_var *file_struct,
792 struct yaffs_tnode *tn = file_struct->top;
795 int level = file_struct->top_level;
799 /* Check sane level and chunk Id */
800 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
803 if (chunk_id > YAFFS_MAX_CHUNK_ID)
806 /* First check we're tall enough (ie enough top_level) */
808 i = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
811 i >>= YAFFS_TNODES_INTERNAL_BITS;
815 if (required_depth > file_struct->top_level)
816 return NULL; /* Not tall enough, so we can't find it */
818 /* Traverse down to level 0 */
819 while (level > 0 && tn) {
820 tn = tn->internal[(chunk_id >>
821 (YAFFS_TNODES_LEVEL0_BITS +
823 YAFFS_TNODES_INTERNAL_BITS)) &
824 YAFFS_TNODES_INTERNAL_MASK];
831 /* add_find_tnode_0 finds the level 0 tnode if it exists,
832 * otherwise first expands the tree.
833 * This happens in two steps:
834 * 1. If the tree isn't tall enough, then make it taller.
835 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
837 * Used when modifying the tree.
839 * If the tn argument is NULL, then a fresh tnode will be added otherwise the
840 * specified tn will be plugged into the ttree.
843 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
844 struct yaffs_file_var *file_struct,
846 struct yaffs_tnode *passed_tn)
851 struct yaffs_tnode *tn;
854 /* Check sane level and page Id */
855 if (file_struct->top_level < 0 ||
856 file_struct->top_level > YAFFS_TNODES_MAX_LEVEL)
859 if (chunk_id > YAFFS_MAX_CHUNK_ID)
862 /* First check we're tall enough (ie enough top_level) */
864 x = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
867 x >>= YAFFS_TNODES_INTERNAL_BITS;
871 if (required_depth > file_struct->top_level) {
872 /* Not tall enough, gotta make the tree taller */
873 for (i = file_struct->top_level; i < required_depth; i++) {
875 tn = yaffs_get_tnode(dev);
878 tn->internal[0] = file_struct->top;
879 file_struct->top = tn;
880 file_struct->top_level++;
882 yaffs_trace(YAFFS_TRACE_ERROR,
883 "yaffs: no more tnodes");
889 /* Traverse down to level 0, adding anything we need */
891 l = file_struct->top_level;
892 tn = file_struct->top;
895 while (l > 0 && tn) {
897 (YAFFS_TNODES_LEVEL0_BITS +
898 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
899 YAFFS_TNODES_INTERNAL_MASK;
901 if ((l > 1) && !tn->internal[x]) {
902 /* Add missing non-level-zero tnode */
903 tn->internal[x] = yaffs_get_tnode(dev);
904 if (!tn->internal[x])
907 /* Looking from level 1 at level 0 */
909 /* If we already have one, release it */
911 yaffs_free_tnode(dev,
913 tn->internal[x] = passed_tn;
915 } else if (!tn->internal[x]) {
916 /* Don't have one, none passed in */
917 tn->internal[x] = yaffs_get_tnode(dev);
918 if (!tn->internal[x])
923 tn = tn->internal[x];
929 memcpy(tn, passed_tn,
930 (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8);
931 yaffs_free_tnode(dev, passed_tn);
938 static int yaffs_tags_match(const struct yaffs_ext_tags *tags, int obj_id,
941 return (tags->chunk_id == chunk_obj &&
942 tags->obj_id == obj_id &&
943 !tags->is_deleted) ? 1 : 0;
947 static int yaffs_find_chunk_in_group(struct yaffs_dev *dev, int the_chunk,
948 struct yaffs_ext_tags *tags, int obj_id,
953 for (j = 0; the_chunk && j < dev->chunk_grp_size; j++) {
954 if (yaffs_check_chunk_bit
955 (dev, the_chunk / dev->param.chunks_per_block,
956 the_chunk % dev->param.chunks_per_block)) {
958 if (dev->chunk_grp_size == 1)
961 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
963 if (yaffs_tags_match(tags,
964 obj_id, inode_chunk)) {
975 static int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
976 struct yaffs_ext_tags *tags)
978 /*Get the Tnode, then get the level 0 offset chunk offset */
979 struct yaffs_tnode *tn;
981 struct yaffs_ext_tags local_tags;
983 struct yaffs_dev *dev = in->my_dev;
986 /* Passed a NULL, so use our own tags space */
990 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
995 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
997 ret_val = yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1002 static int yaffs_find_del_file_chunk(struct yaffs_obj *in, int inode_chunk,
1003 struct yaffs_ext_tags *tags)
1005 /* Get the Tnode, then get the level 0 offset chunk offset */
1006 struct yaffs_tnode *tn;
1008 struct yaffs_ext_tags local_tags;
1009 struct yaffs_dev *dev = in->my_dev;
1013 /* Passed a NULL, so use our own tags space */
1017 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1022 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1024 ret_val = yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1027 /* Delete the entry in the filestructure (if found) */
1029 yaffs_load_tnode_0(dev, tn, inode_chunk, 0);
1034 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1035 int nand_chunk, int in_scan)
1037 /* NB in_scan is zero unless scanning.
1038 * For forward scanning, in_scan is > 0;
1039 * for backward scanning in_scan is < 0
1041 * nand_chunk = 0 is a dummy insert to make sure the tnodes are there.
1044 struct yaffs_tnode *tn;
1045 struct yaffs_dev *dev = in->my_dev;
1047 struct yaffs_ext_tags existing_tags;
1048 struct yaffs_ext_tags new_tags;
1049 unsigned existing_serial, new_serial;
1051 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE) {
1052 /* Just ignore an attempt at putting a chunk into a non-file
1054 * If it is not during Scanning then something went wrong!
1057 yaffs_trace(YAFFS_TRACE_ERROR,
1058 "yaffs tragedy:attempt to put data chunk into a non-file"
1063 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1067 tn = yaffs_add_find_tnode_0(dev,
1068 &in->variant.file_variant,
1074 /* Dummy insert, bail now */
1077 existing_cunk = yaffs_get_group_base(dev, tn, inode_chunk);
1080 /* If we're scanning then we need to test for duplicates
1081 * NB This does not need to be efficient since it should only
1082 * happen when the power fails during a write, then only one
1083 * chunk should ever be affected.
1085 * Correction for YAFFS2: This could happen quite a lot and we
1086 * need to think about efficiency! TODO
1087 * Update: For backward scanning we don't need to re-read tags
1088 * so this is quite cheap.
1091 if (existing_cunk > 0) {
1092 /* NB Right now existing chunk will not be real
1093 * chunk_id if the chunk group size > 1
1094 * thus we have to do a FindChunkInFile to get the
1097 * We have a duplicate now we need to decide which
1100 * Backwards scanning YAFFS2: The old one is what
1101 * we use, dump the new one.
1102 * YAFFS1: Get both sets of tags and compare serial
1107 /* Only do this for forward scanning */
1108 yaffs_rd_chunk_tags_nand(dev,
1112 /* Do a proper find */
1114 yaffs_find_chunk_in_file(in, inode_chunk,
1118 if (existing_cunk <= 0) {
1119 /*Hoosterman - how did this happen? */
1121 yaffs_trace(YAFFS_TRACE_ERROR,
1122 "yaffs tragedy: existing chunk < 0 in scan"
1127 /* NB The deleted flags should be false, otherwise
1128 * the chunks will not be loaded during a scan
1132 new_serial = new_tags.serial_number;
1133 existing_serial = existing_tags.serial_number;
1136 if ((in_scan > 0) &&
1137 (existing_cunk <= 0 ||
1138 ((existing_serial + 1) & 3) == new_serial)) {
1139 /* Forward scanning.
1141 * Delete the old one and drop through to
1144 yaffs_chunk_del(dev, existing_cunk, 1,
1147 /* Backward scanning or we want to use the
1149 * Delete the new one and return early so that
1150 * the tnode isn't changed
1152 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1159 if (existing_cunk == 0)
1160 in->n_data_chunks++;
1162 yaffs_load_tnode_0(dev, tn, inode_chunk, nand_chunk);
1167 static void yaffs_soft_del_chunk(struct yaffs_dev *dev, int chunk)
1169 struct yaffs_block_info *the_block;
1172 yaffs_trace(YAFFS_TRACE_DELETION, "soft delete chunk %d", chunk);
1174 block_no = chunk / dev->param.chunks_per_block;
1175 the_block = yaffs_get_block_info(dev, block_no);
1177 the_block->soft_del_pages++;
1178 dev->n_free_chunks++;
1179 yaffs2_update_oldest_dirty_seq(dev, block_no, the_block);
1183 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all
1184 * the chunks in the file.
1185 * All soft deleting does is increment the block's softdelete count and pulls
1186 * the chunk out of the tnode.
1187 * Thus, essentially this is the same as DeleteWorker except that the chunks
1191 static int yaffs_soft_del_worker(struct yaffs_obj *in, struct yaffs_tnode *tn,
1192 u32 level, int chunk_offset)
1197 struct yaffs_dev *dev = in->my_dev;
1203 for (i = YAFFS_NTNODES_INTERNAL - 1;
1206 if (tn->internal[i]) {
1208 yaffs_soft_del_worker(in,
1212 YAFFS_TNODES_INTERNAL_BITS)
1215 yaffs_free_tnode(dev,
1217 tn->internal[i] = NULL;
1219 /* Can this happen? */
1223 return (all_done) ? 1 : 0;
1227 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1228 the_chunk = yaffs_get_group_base(dev, tn, i);
1230 yaffs_soft_del_chunk(dev, the_chunk);
1231 yaffs_load_tnode_0(dev, tn, i, 0);
1237 static void yaffs_remove_obj_from_dir(struct yaffs_obj *obj)
1239 struct yaffs_dev *dev = obj->my_dev;
1240 struct yaffs_obj *parent;
1242 yaffs_verify_obj_in_dir(obj);
1243 parent = obj->parent;
1245 yaffs_verify_dir(parent);
1247 if (dev && dev->param.remove_obj_fn)
1248 dev->param.remove_obj_fn(obj);
1250 list_del_init(&obj->siblings);
1253 yaffs_verify_dir(parent);
1256 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj)
1259 yaffs_trace(YAFFS_TRACE_ALWAYS,
1260 "tragedy: Trying to add an object to a null pointer directory"
1265 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1266 yaffs_trace(YAFFS_TRACE_ALWAYS,
1267 "tragedy: Trying to add an object to a non-directory"
1272 if (obj->siblings.prev == NULL) {
1273 /* Not initialised */
1277 yaffs_verify_dir(directory);
1279 yaffs_remove_obj_from_dir(obj);
1282 list_add(&obj->siblings, &directory->variant.dir_variant.children);
1283 obj->parent = directory;
1285 if (directory == obj->my_dev->unlinked_dir
1286 || directory == obj->my_dev->del_dir) {
1288 obj->my_dev->n_unlinked_files++;
1289 obj->rename_allowed = 0;
1292 yaffs_verify_dir(directory);
1293 yaffs_verify_obj_in_dir(obj);
1296 static int yaffs_change_obj_name(struct yaffs_obj *obj,
1297 struct yaffs_obj *new_dir,
1298 const YCHAR *new_name, int force, int shadows)
1302 struct yaffs_obj *existing_target;
1304 if (new_dir == NULL)
1305 new_dir = obj->parent; /* use the old directory */
1307 if (new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1308 yaffs_trace(YAFFS_TRACE_ALWAYS,
1309 "tragedy: yaffs_change_obj_name: new_dir is not a directory"
1314 unlink_op = (new_dir == obj->my_dev->unlinked_dir);
1315 del_op = (new_dir == obj->my_dev->del_dir);
1317 existing_target = yaffs_find_by_name(new_dir, new_name);
1319 /* If the object is a file going into the unlinked directory,
1320 * then it is OK to just stuff it in since duplicate names are OK.
1321 * else only proceed if the new name does not exist and we're putting
1322 * it into a directory.
1324 if (!(unlink_op || del_op || force ||
1325 shadows > 0 || !existing_target) ||
1326 new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
1329 yaffs_set_obj_name(obj, new_name);
1331 yaffs_add_obj_to_dir(new_dir, obj);
1336 /* If it is a deletion then we mark it as a shrink for gc */
1337 if (yaffs_update_oh(obj, new_name, 0, del_op, shadows, NULL) >= 0)
1343 /*------------------------ Short Operations Cache ------------------------------
1344 * In many situations where there is no high level buffering a lot of
1345 * reads might be short sequential reads, and a lot of writes may be short
1346 * sequential writes. eg. scanning/writing a jpeg file.
1347 * In these cases, a short read/write cache can provide a huge perfomance
1348 * benefit with dumb-as-a-rock code.
1349 * In Linux, the page cache provides read buffering and the short op cache
1350 * provides write buffering.
1352 * There are a small number (~10) of cache chunks per device so that we don't
1353 * need a very intelligent search.
1356 static int yaffs_obj_cache_dirty(struct yaffs_obj *obj)
1358 struct yaffs_dev *dev = obj->my_dev;
1360 struct yaffs_cache *cache;
1361 int n_caches = obj->my_dev->param.n_caches;
1363 for (i = 0; i < n_caches; i++) {
1364 cache = &dev->cache[i];
1365 if (cache->object == obj && cache->dirty)
1372 static void yaffs_flush_file_cache(struct yaffs_obj *obj)
1374 struct yaffs_dev *dev = obj->my_dev;
1375 int lowest = -99; /* Stop compiler whining. */
1377 struct yaffs_cache *cache;
1378 int chunk_written = 0;
1379 int n_caches = obj->my_dev->param.n_caches;
1386 /* Find the lowest dirty chunk for this object */
1387 for (i = 0; i < n_caches; i++) {
1388 if (dev->cache[i].object == obj &&
1389 dev->cache[i].dirty) {
1391 dev->cache[i].chunk_id < lowest) {
1392 cache = &dev->cache[i];
1393 lowest = cache->chunk_id;
1398 if (cache && !cache->locked) {
1399 /* Write it out and free it up */
1401 yaffs_wr_data_obj(cache->object,
1406 cache->object = NULL;
1408 } while (cache && chunk_written > 0);
1411 /* Hoosterman, disk full while writing cache out. */
1412 yaffs_trace(YAFFS_TRACE_ERROR,
1413 "yaffs tragedy: no space during cache write");
1416 /*yaffs_flush_whole_cache(dev)
1421 void yaffs_flush_whole_cache(struct yaffs_dev *dev)
1423 struct yaffs_obj *obj;
1424 int n_caches = dev->param.n_caches;
1427 /* Find a dirty object in the cache and flush it...
1428 * until there are no further dirty objects.
1432 for (i = 0; i < n_caches && !obj; i++) {
1433 if (dev->cache[i].object && dev->cache[i].dirty)
1434 obj = dev->cache[i].object;
1437 yaffs_flush_file_cache(obj);
1442 /* Grab us a cache chunk for use.
1443 * First look for an empty one.
1444 * Then look for the least recently used non-dirty one.
1445 * Then look for the least recently used dirty one...., flush and look again.
1447 static struct yaffs_cache *yaffs_grab_chunk_worker(struct yaffs_dev *dev)
1451 if (dev->param.n_caches > 0) {
1452 for (i = 0; i < dev->param.n_caches; i++) {
1453 if (!dev->cache[i].object)
1454 return &dev->cache[i];
1460 static struct yaffs_cache *yaffs_grab_chunk_cache(struct yaffs_dev *dev)
1462 struct yaffs_cache *cache;
1463 struct yaffs_obj *the_obj;
1468 if (dev->param.n_caches < 1)
1471 /* Try find a non-dirty one... */
1473 cache = yaffs_grab_chunk_worker(dev);
1476 /* They were all dirty, find the LRU object and flush
1477 * its cache, then find again.
1478 * NB what's here is not very accurate,
1479 * we actually flush the object with the LRU chunk.
1482 /* With locking we can't assume we can use entry zero,
1483 * Set the_obj to a valid pointer for Coverity. */
1484 the_obj = dev->cache[0].object;
1489 for (i = 0; i < dev->param.n_caches; i++) {
1490 if (dev->cache[i].object &&
1491 !dev->cache[i].locked &&
1492 (dev->cache[i].last_use < usage ||
1494 usage = dev->cache[i].last_use;
1495 the_obj = dev->cache[i].object;
1496 cache = &dev->cache[i];
1501 if (!cache || cache->dirty) {
1502 /* Flush and try again */
1503 yaffs_flush_file_cache(the_obj);
1504 cache = yaffs_grab_chunk_worker(dev);
1510 /* Find a cached chunk */
1511 static struct yaffs_cache *yaffs_find_chunk_cache(const struct yaffs_obj *obj,
1514 struct yaffs_dev *dev = obj->my_dev;
1517 if (dev->param.n_caches < 1)
1520 for (i = 0; i < dev->param.n_caches; i++) {
1521 if (dev->cache[i].object == obj &&
1522 dev->cache[i].chunk_id == chunk_id) {
1525 return &dev->cache[i];
1531 /* Mark the chunk for the least recently used algorithym */
1532 static void yaffs_use_cache(struct yaffs_dev *dev, struct yaffs_cache *cache,
1537 if (dev->param.n_caches < 1)
1540 if (dev->cache_last_use < 0 ||
1541 dev->cache_last_use > 100000000) {
1542 /* Reset the cache usages */
1543 for (i = 1; i < dev->param.n_caches; i++)
1544 dev->cache[i].last_use = 0;
1546 dev->cache_last_use = 0;
1548 dev->cache_last_use++;
1549 cache->last_use = dev->cache_last_use;
1555 /* Invalidate a single cache page.
1556 * Do this when a whole page gets written,
1557 * ie the short cache for this page is no longer valid.
1559 static void yaffs_invalidate_chunk_cache(struct yaffs_obj *object, int chunk_id)
1561 struct yaffs_cache *cache;
1563 if (object->my_dev->param.n_caches > 0) {
1564 cache = yaffs_find_chunk_cache(object, chunk_id);
1567 cache->object = NULL;
1571 /* Invalidate all the cache pages associated with this object
1572 * Do this whenever ther file is deleted or resized.
1574 static void yaffs_invalidate_whole_cache(struct yaffs_obj *in)
1577 struct yaffs_dev *dev = in->my_dev;
1579 if (dev->param.n_caches > 0) {
1580 /* Invalidate it. */
1581 for (i = 0; i < dev->param.n_caches; i++) {
1582 if (dev->cache[i].object == in)
1583 dev->cache[i].object = NULL;
1588 static void yaffs_unhash_obj(struct yaffs_obj *obj)
1591 struct yaffs_dev *dev = obj->my_dev;
1593 /* If it is still linked into the bucket list, free from the list */
1594 if (!list_empty(&obj->hash_link)) {
1595 list_del_init(&obj->hash_link);
1596 bucket = yaffs_hash_fn(obj->obj_id);
1597 dev->obj_bucket[bucket].count--;
1601 /* FreeObject frees up a Object and puts it back on the free list */
1602 static void yaffs_free_obj(struct yaffs_obj *obj)
1604 struct yaffs_dev *dev;
1611 yaffs_trace(YAFFS_TRACE_OS, "FreeObject %p inode %p",
1612 obj, obj->my_inode);
1615 if (!list_empty(&obj->siblings))
1618 if (obj->my_inode) {
1619 /* We're still hooked up to a cached inode.
1620 * Don't delete now, but mark for later deletion
1622 obj->defered_free = 1;
1626 yaffs_unhash_obj(obj);
1628 yaffs_free_raw_obj(dev, obj);
1630 dev->checkpoint_blocks_required = 0; /* force recalculation */
1633 void yaffs_handle_defered_free(struct yaffs_obj *obj)
1635 if (obj->defered_free)
1636 yaffs_free_obj(obj);
1639 static int yaffs_generic_obj_del(struct yaffs_obj *in)
1641 /* Iinvalidate the file's data in the cache, without flushing. */
1642 yaffs_invalidate_whole_cache(in);
1644 if (in->my_dev->param.is_yaffs2 && in->parent != in->my_dev->del_dir) {
1645 /* Move to unlinked directory so we have a deletion record */
1646 yaffs_change_obj_name(in, in->my_dev->del_dir, _Y("deleted"), 0,
1650 yaffs_remove_obj_from_dir(in);
1651 yaffs_chunk_del(in->my_dev, in->hdr_chunk, 1, __LINE__);
1659 static void yaffs_soft_del_file(struct yaffs_obj *obj)
1661 if (!obj->deleted ||
1662 obj->variant_type != YAFFS_OBJECT_TYPE_FILE ||
1666 if (obj->n_data_chunks <= 0) {
1667 /* Empty file with no duplicate object headers,
1668 * just delete it immediately */
1669 yaffs_free_tnode(obj->my_dev, obj->variant.file_variant.top);
1670 obj->variant.file_variant.top = NULL;
1671 yaffs_trace(YAFFS_TRACE_TRACING,
1672 "yaffs: Deleting empty file %d",
1674 yaffs_generic_obj_del(obj);
1676 yaffs_soft_del_worker(obj,
1677 obj->variant.file_variant.top,
1679 file_variant.top_level, 0);
1684 /* Pruning removes any part of the file structure tree that is beyond the
1685 * bounds of the file (ie that does not point to chunks).
1687 * A file should only get pruned when its size is reduced.
1689 * Before pruning, the chunks must be pulled from the tree and the
1690 * level 0 tnode entries must be zeroed out.
1691 * Could also use this for file deletion, but that's probably better handled
1692 * by a special case.
1694 * This function is recursive. For levels > 0 the function is called again on
1695 * any sub-tree. For level == 0 we just check if the sub-tree has data.
1696 * If there is no data in a subtree then it is pruned.
1699 static struct yaffs_tnode *yaffs_prune_worker(struct yaffs_dev *dev,
1700 struct yaffs_tnode *tn, u32 level,
1712 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1713 if (tn->internal[i]) {
1715 yaffs_prune_worker(dev,
1718 (i == 0) ? del0 : 1);
1721 if (tn->internal[i])
1725 int tnode_size_u32 = dev->tnode_size / sizeof(u32);
1726 u32 *map = (u32 *) tn;
1728 for (i = 0; !has_data && i < tnode_size_u32; i++) {
1734 if (has_data == 0 && del0) {
1735 /* Free and return NULL */
1736 yaffs_free_tnode(dev, tn);
1742 static int yaffs_prune_tree(struct yaffs_dev *dev,
1743 struct yaffs_file_var *file_struct)
1748 struct yaffs_tnode *tn;
1750 if (file_struct->top_level < 1)
1754 yaffs_prune_worker(dev, file_struct->top, file_struct->top_level, 0);
1756 /* Now we have a tree with all the non-zero branches NULL but
1757 * the height is the same as it was.
1758 * Let's see if we can trim internal tnodes to shorten the tree.
1759 * We can do this if only the 0th element in the tnode is in use
1760 * (ie all the non-zero are NULL)
1763 while (file_struct->top_level && !done) {
1764 tn = file_struct->top;
1767 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1768 if (tn->internal[i])
1773 file_struct->top = tn->internal[0];
1774 file_struct->top_level--;
1775 yaffs_free_tnode(dev, tn);
1784 /*-------------------- End of File Structure functions.-------------------*/
1786 /* alloc_empty_obj gets us a clean Object.*/
1787 static struct yaffs_obj *yaffs_alloc_empty_obj(struct yaffs_dev *dev)
1789 struct yaffs_obj *obj = yaffs_alloc_raw_obj(dev);
1796 /* Now sweeten it up... */
1798 memset(obj, 0, sizeof(struct yaffs_obj));
1799 obj->being_created = 1;
1803 obj->variant_type = YAFFS_OBJECT_TYPE_UNKNOWN;
1804 INIT_LIST_HEAD(&(obj->hard_links));
1805 INIT_LIST_HEAD(&(obj->hash_link));
1806 INIT_LIST_HEAD(&obj->siblings);
1808 /* Now make the directory sane */
1809 if (dev->root_dir) {
1810 obj->parent = dev->root_dir;
1811 list_add(&(obj->siblings),
1812 &dev->root_dir->variant.dir_variant.children);
1815 /* Add it to the lost and found directory.
1816 * NB Can't put root or lost-n-found in lost-n-found so
1817 * check if lost-n-found exists first
1819 if (dev->lost_n_found)
1820 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
1822 obj->being_created = 0;
1824 dev->checkpoint_blocks_required = 0; /* force recalculation */
1829 static int yaffs_find_nice_bucket(struct yaffs_dev *dev)
1833 int lowest = 999999;
1835 /* Search for the shortest list or one that
1839 for (i = 0; i < 10 && lowest > 4; i++) {
1840 dev->bucket_finder++;
1841 dev->bucket_finder %= YAFFS_NOBJECT_BUCKETS;
1842 if (dev->obj_bucket[dev->bucket_finder].count < lowest) {
1843 lowest = dev->obj_bucket[dev->bucket_finder].count;
1844 l = dev->bucket_finder;
1851 static int yaffs_new_obj_id(struct yaffs_dev *dev)
1853 int bucket = yaffs_find_nice_bucket(dev);
1855 struct list_head *i;
1856 u32 n = (u32) bucket;
1858 /* Now find an object value that has not already been taken
1859 * by scanning the list.
1864 n += YAFFS_NOBJECT_BUCKETS;
1865 if (1 || dev->obj_bucket[bucket].count > 0) {
1866 list_for_each(i, &dev->obj_bucket[bucket].list) {
1867 /* If there is already one in the list */
1868 if (i && list_entry(i, struct yaffs_obj,
1869 hash_link)->obj_id == n) {
1878 static void yaffs_hash_obj(struct yaffs_obj *in)
1880 int bucket = yaffs_hash_fn(in->obj_id);
1881 struct yaffs_dev *dev = in->my_dev;
1883 list_add(&in->hash_link, &dev->obj_bucket[bucket].list);
1884 dev->obj_bucket[bucket].count++;
1887 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number)
1889 int bucket = yaffs_hash_fn(number);
1890 struct list_head *i;
1891 struct yaffs_obj *in;
1893 list_for_each(i, &dev->obj_bucket[bucket].list) {
1894 /* Look if it is in the list */
1895 in = list_entry(i, struct yaffs_obj, hash_link);
1896 if (in->obj_id == number) {
1897 /* Don't show if it is defered free */
1898 if (in->defered_free)
1907 static struct yaffs_obj *yaffs_new_obj(struct yaffs_dev *dev, int number,
1908 enum yaffs_obj_type type)
1910 struct yaffs_obj *the_obj = NULL;
1911 struct yaffs_tnode *tn = NULL;
1914 number = yaffs_new_obj_id(dev);
1916 if (type == YAFFS_OBJECT_TYPE_FILE) {
1917 tn = yaffs_get_tnode(dev);
1922 the_obj = yaffs_alloc_empty_obj(dev);
1925 yaffs_free_tnode(dev, tn);
1930 the_obj->rename_allowed = 1;
1931 the_obj->unlink_allowed = 1;
1932 the_obj->obj_id = number;
1933 yaffs_hash_obj(the_obj);
1934 the_obj->variant_type = type;
1935 yaffs_load_current_time(the_obj, 1, 1);
1938 case YAFFS_OBJECT_TYPE_FILE:
1939 the_obj->variant.file_variant.file_size = 0;
1940 the_obj->variant.file_variant.scanned_size = 0;
1941 the_obj->variant.file_variant.shrink_size =
1942 yaffs_max_file_size(dev);
1943 the_obj->variant.file_variant.top_level = 0;
1944 the_obj->variant.file_variant.top = tn;
1946 case YAFFS_OBJECT_TYPE_DIRECTORY:
1947 INIT_LIST_HEAD(&the_obj->variant.dir_variant.children);
1948 INIT_LIST_HEAD(&the_obj->variant.dir_variant.dirty);
1950 case YAFFS_OBJECT_TYPE_SYMLINK:
1951 case YAFFS_OBJECT_TYPE_HARDLINK:
1952 case YAFFS_OBJECT_TYPE_SPECIAL:
1953 /* No action required */
1955 case YAFFS_OBJECT_TYPE_UNKNOWN:
1956 /* todo this should not happen */
1962 static struct yaffs_obj *yaffs_create_fake_dir(struct yaffs_dev *dev,
1963 int number, u32 mode)
1966 struct yaffs_obj *obj =
1967 yaffs_new_obj(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1972 obj->fake = 1; /* it is fake so it might not use NAND */
1973 obj->rename_allowed = 0;
1974 obj->unlink_allowed = 0;
1977 obj->yst_mode = mode;
1979 obj->hdr_chunk = 0; /* Not a valid chunk. */
1985 static void yaffs_init_tnodes_and_objs(struct yaffs_dev *dev)
1991 yaffs_init_raw_tnodes_and_objs(dev);
1993 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
1994 INIT_LIST_HEAD(&dev->obj_bucket[i].list);
1995 dev->obj_bucket[i].count = 0;
1999 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
2001 enum yaffs_obj_type type)
2003 struct yaffs_obj *the_obj = NULL;
2006 the_obj = yaffs_find_by_number(dev, number);
2009 the_obj = yaffs_new_obj(dev, number, type);
2015 YCHAR *yaffs_clone_str(const YCHAR *str)
2017 YCHAR *new_str = NULL;
2023 len = strnlen(str, YAFFS_MAX_ALIAS_LENGTH);
2024 new_str = kmalloc((len + 1) * sizeof(YCHAR), GFP_NOFS);
2026 strncpy(new_str, str, len);
2033 *yaffs_update_parent() handles fixing a directories mtime and ctime when a new
2034 * link (ie. name) is created or deleted in the directory.
2037 * create dir/a : update dir's mtime/ctime
2038 * rm dir/a: update dir's mtime/ctime
2039 * modify dir/a: don't update dir's mtimme/ctime
2041 * This can be handled immediately or defered. Defering helps reduce the number
2042 * of updates when many files in a directory are changed within a brief period.
2044 * If the directory updating is defered then yaffs_update_dirty_dirs must be
2045 * called periodically.
2048 static void yaffs_update_parent(struct yaffs_obj *obj)
2050 struct yaffs_dev *dev;
2056 yaffs_load_current_time(obj, 0, 1);
2057 if (dev->param.defered_dir_update) {
2058 struct list_head *link = &obj->variant.dir_variant.dirty;
2060 if (list_empty(link)) {
2061 list_add(link, &dev->dirty_dirs);
2062 yaffs_trace(YAFFS_TRACE_BACKGROUND,
2063 "Added object %d to dirty directories",
2068 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2072 void yaffs_update_dirty_dirs(struct yaffs_dev *dev)
2074 struct list_head *link;
2075 struct yaffs_obj *obj;
2076 struct yaffs_dir_var *d_s;
2077 union yaffs_obj_var *o_v;
2079 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update dirty directories");
2081 while (!list_empty(&dev->dirty_dirs)) {
2082 link = dev->dirty_dirs.next;
2083 list_del_init(link);
2085 d_s = list_entry(link, struct yaffs_dir_var, dirty);
2086 o_v = list_entry(d_s, union yaffs_obj_var, dir_variant);
2087 obj = list_entry(o_v, struct yaffs_obj, variant);
2089 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update directory %d",
2093 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2098 * Mknod (create) a new object.
2099 * equiv_obj only has meaning for a hard link;
2100 * alias_str only has meaning for a symlink.
2101 * rdev only has meaning for devices (a subset of special objects)
2104 static struct yaffs_obj *yaffs_create_obj(enum yaffs_obj_type type,
2105 struct yaffs_obj *parent,
2110 struct yaffs_obj *equiv_obj,
2111 const YCHAR *alias_str, u32 rdev)
2113 struct yaffs_obj *in;
2115 struct yaffs_dev *dev = parent->my_dev;
2117 /* Check if the entry exists.
2118 * If it does then fail the call since we don't want a dup. */
2119 if (yaffs_find_by_name(parent, name))
2122 if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2123 str = yaffs_clone_str(alias_str);
2128 in = yaffs_new_obj(dev, -1, type);
2137 in->variant_type = type;
2139 in->yst_mode = mode;
2141 yaffs_attribs_init(in, gid, uid, rdev);
2143 in->n_data_chunks = 0;
2145 yaffs_set_obj_name(in, name);
2148 yaffs_add_obj_to_dir(parent, in);
2150 in->my_dev = parent->my_dev;
2153 case YAFFS_OBJECT_TYPE_SYMLINK:
2154 in->variant.symlink_variant.alias = str;
2156 case YAFFS_OBJECT_TYPE_HARDLINK:
2157 in->variant.hardlink_variant.equiv_obj = equiv_obj;
2158 in->variant.hardlink_variant.equiv_id = equiv_obj->obj_id;
2159 list_add(&in->hard_links, &equiv_obj->hard_links);
2161 case YAFFS_OBJECT_TYPE_FILE:
2162 case YAFFS_OBJECT_TYPE_DIRECTORY:
2163 case YAFFS_OBJECT_TYPE_SPECIAL:
2164 case YAFFS_OBJECT_TYPE_UNKNOWN:
2169 if (yaffs_update_oh(in, name, 0, 0, 0, NULL) < 0) {
2170 /* Could not create the object header, fail */
2176 yaffs_update_parent(parent);
2181 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
2182 const YCHAR *name, u32 mode, u32 uid,
2185 return yaffs_create_obj(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2186 uid, gid, NULL, NULL, 0);
2189 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
2190 u32 mode, u32 uid, u32 gid)
2192 return yaffs_create_obj(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2193 mode, uid, gid, NULL, NULL, 0);
2196 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
2197 const YCHAR *name, u32 mode, u32 uid,
2200 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2201 uid, gid, NULL, NULL, rdev);
2204 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
2205 const YCHAR *name, u32 mode, u32 uid,
2206 u32 gid, const YCHAR *alias)
2208 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2209 uid, gid, NULL, alias, 0);
2212 /* yaffs_link_obj returns the object id of the equivalent object.*/
2213 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR * name,
2214 struct yaffs_obj *equiv_obj)
2216 /* Get the real object in case we were fed a hard link obj */
2217 equiv_obj = yaffs_get_equivalent_obj(equiv_obj);
2219 if (yaffs_create_obj(YAFFS_OBJECT_TYPE_HARDLINK,
2220 parent, name, 0, 0, 0,
2221 equiv_obj, NULL, 0))
2230 /*---------------------- Block Management and Page Allocation -------------*/
2232 static void yaffs_deinit_blocks(struct yaffs_dev *dev)
2234 if (dev->block_info_alt && dev->block_info)
2235 vfree(dev->block_info);
2237 kfree(dev->block_info);
2239 dev->block_info_alt = 0;
2241 dev->block_info = NULL;
2243 if (dev->chunk_bits_alt && dev->chunk_bits)
2244 vfree(dev->chunk_bits);
2246 kfree(dev->chunk_bits);
2247 dev->chunk_bits_alt = 0;
2248 dev->chunk_bits = NULL;
2251 static int yaffs_init_blocks(struct yaffs_dev *dev)
2253 int n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
2255 dev->block_info = NULL;
2256 dev->chunk_bits = NULL;
2257 dev->alloc_block = -1; /* force it to get a new one */
2259 /* If the first allocation strategy fails, thry the alternate one */
2261 kmalloc(n_blocks * sizeof(struct yaffs_block_info), GFP_NOFS);
2262 if (!dev->block_info) {
2264 vmalloc(n_blocks * sizeof(struct yaffs_block_info));
2265 dev->block_info_alt = 1;
2267 dev->block_info_alt = 0;
2270 if (!dev->block_info)
2273 /* Set up dynamic blockinfo stuff. Round up bytes. */
2274 dev->chunk_bit_stride = (dev->param.chunks_per_block + 7) / 8;
2276 kmalloc(dev->chunk_bit_stride * n_blocks, GFP_NOFS);
2277 if (!dev->chunk_bits) {
2279 vmalloc(dev->chunk_bit_stride * n_blocks);
2280 dev->chunk_bits_alt = 1;
2282 dev->chunk_bits_alt = 0;
2284 if (!dev->chunk_bits)
2288 memset(dev->block_info, 0, n_blocks * sizeof(struct yaffs_block_info));
2289 memset(dev->chunk_bits, 0, dev->chunk_bit_stride * n_blocks);
2293 yaffs_deinit_blocks(dev);
2298 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no)
2300 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block_no);
2304 /* If the block is still healthy erase it and mark as clean.
2305 * If the block has had a data failure, then retire it.
2308 yaffs_trace(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2309 "yaffs_block_became_dirty block %d state %d %s",
2310 block_no, bi->block_state,
2311 (bi->needs_retiring) ? "needs retiring" : "");
2313 yaffs2_clear_oldest_dirty_seq(dev, bi);
2315 bi->block_state = YAFFS_BLOCK_STATE_DIRTY;
2317 /* If this is the block being garbage collected then stop gc'ing */
2318 if (block_no == dev->gc_block)
2321 /* If this block is currently the best candidate for gc
2322 * then drop as a candidate */
2323 if (block_no == dev->gc_dirtiest) {
2324 dev->gc_dirtiest = 0;
2325 dev->gc_pages_in_use = 0;
2328 if (!bi->needs_retiring) {
2329 yaffs2_checkpt_invalidate(dev);
2330 erased_ok = yaffs_erase_block(dev, block_no);
2332 dev->n_erase_failures++;
2333 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2334 "**>> Erasure failed %d", block_no);
2338 /* Verify erasure if needed */
2340 ((yaffs_trace_mask & YAFFS_TRACE_ERASE) ||
2341 !yaffs_skip_verification(dev))) {
2342 for (i = 0; i < dev->param.chunks_per_block; i++) {
2343 if (!yaffs_check_chunk_erased(dev,
2344 block_no * dev->param.chunks_per_block + i)) {
2345 yaffs_trace(YAFFS_TRACE_ERROR,
2346 ">>Block %d erasure supposedly OK, but chunk %d not erased",
2353 /* We lost a block of free space */
2354 dev->n_free_chunks -= dev->param.chunks_per_block;
2355 yaffs_retire_block(dev, block_no);
2356 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2357 "**>> Block %d retired", block_no);
2361 /* Clean it up... */
2362 bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
2364 dev->n_erased_blocks++;
2365 bi->pages_in_use = 0;
2366 bi->soft_del_pages = 0;
2367 bi->has_shrink_hdr = 0;
2368 bi->skip_erased_check = 1; /* Clean, so no need to check */
2369 bi->gc_prioritise = 0;
2370 bi->has_summary = 0;
2372 yaffs_clear_chunk_bits(dev, block_no);
2374 yaffs_trace(YAFFS_TRACE_ERASE, "Erased block %d", block_no);
2377 static inline int yaffs_gc_process_chunk(struct yaffs_dev *dev,
2378 struct yaffs_block_info *bi,
2379 int old_chunk, u8 *buffer)
2383 struct yaffs_ext_tags tags;
2384 struct yaffs_obj *object;
2386 int ret_val = YAFFS_OK;
2388 memset(&tags, 0, sizeof(tags));
2389 yaffs_rd_chunk_tags_nand(dev, old_chunk,
2391 object = yaffs_find_by_number(dev, tags.obj_id);
2393 yaffs_trace(YAFFS_TRACE_GC_DETAIL,
2394 "Collecting chunk in block %d, %d %d %d ",
2395 dev->gc_chunk, tags.obj_id,
2396 tags.chunk_id, tags.n_bytes);
2398 if (object && !yaffs_skip_verification(dev)) {
2399 if (tags.chunk_id == 0)
2402 else if (object->soft_del)
2403 /* Defeat the test */
2404 matching_chunk = old_chunk;
2407 yaffs_find_chunk_in_file
2408 (object, tags.chunk_id,
2411 if (old_chunk != matching_chunk)
2412 yaffs_trace(YAFFS_TRACE_ERROR,
2413 "gc: page in gc mismatch: %d %d %d %d",
2421 yaffs_trace(YAFFS_TRACE_ERROR,
2422 "page %d in gc has no object: %d %d %d ",
2424 tags.obj_id, tags.chunk_id,
2430 object->soft_del && tags.chunk_id != 0) {
2431 /* Data chunk in a soft deleted file,
2433 * It's a soft deleted data chunk,
2434 * No need to copy this, just forget
2435 * about it and fix up the object.
2438 /* Free chunks already includes
2439 * softdeleted chunks, how ever this
2440 * chunk is going to soon be really
2441 * deleted which will increment free
2442 * chunks. We have to decrement free
2443 * chunks so this works out properly.
2445 dev->n_free_chunks--;
2446 bi->soft_del_pages--;
2448 object->n_data_chunks--;
2449 if (object->n_data_chunks <= 0) {
2450 /* remeber to clean up obj */
2451 dev->gc_cleanup_list[dev->n_clean_ups] = tags.obj_id;
2455 } else if (object) {
2456 /* It's either a data chunk in a live
2457 * file or an ObjectHeader, so we're
2459 * NB Need to keep the ObjectHeaders of
2460 * deleted files until the whole file
2461 * has been deleted off
2463 tags.serial_number++;
2466 if (tags.chunk_id == 0) {
2467 /* It is an object Id,
2468 * We need to nuke the
2469 * shrinkheader flags since its
2471 * Also need to clean up
2474 struct yaffs_obj_hdr *oh;
2475 oh = (struct yaffs_obj_hdr *) buffer;
2478 tags.extra_is_shrink = 0;
2479 oh->shadows_obj = 0;
2480 oh->inband_shadowed_obj_id = 0;
2481 tags.extra_shadows = 0;
2483 /* Update file size */
2484 if (object->variant_type == YAFFS_OBJECT_TYPE_FILE) {
2485 yaffs_oh_size_load(oh,
2486 object->variant.file_variant.file_size);
2487 tags.extra_file_size =
2488 object->variant.file_variant.file_size;
2491 yaffs_verify_oh(object, oh, &tags, 1);
2493 yaffs_write_new_chunk(dev, (u8 *) oh, &tags, 1);
2496 yaffs_write_new_chunk(dev, buffer, &tags, 1);
2499 if (new_chunk < 0) {
2500 ret_val = YAFFS_FAIL;
2503 /* Now fix up the Tnodes etc. */
2505 if (tags.chunk_id == 0) {
2507 object->hdr_chunk = new_chunk;
2508 object->serial = tags.serial_number;
2510 /* It's a data chunk */
2511 yaffs_put_chunk_in_file(object, tags.chunk_id,
2516 if (ret_val == YAFFS_OK)
2517 yaffs_chunk_del(dev, old_chunk, mark_flash, __LINE__);
2521 static int yaffs_gc_block(struct yaffs_dev *dev, int block, int whole_block)
2524 int ret_val = YAFFS_OK;
2526 int is_checkpt_block;
2528 int chunks_before = yaffs_get_erased_chunks(dev);
2530 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block);
2532 is_checkpt_block = (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT);
2534 yaffs_trace(YAFFS_TRACE_TRACING,
2535 "Collecting block %d, in use %d, shrink %d, whole_block %d",
2536 block, bi->pages_in_use, bi->has_shrink_hdr,
2539 /*yaffs_verify_free_chunks(dev); */
2541 if (bi->block_state == YAFFS_BLOCK_STATE_FULL)
2542 bi->block_state = YAFFS_BLOCK_STATE_COLLECTING;
2544 bi->has_shrink_hdr = 0; /* clear the flag so that the block can erase */
2546 dev->gc_disable = 1;
2548 yaffs_summary_gc(dev, block);
2550 if (is_checkpt_block || !yaffs_still_some_chunks(dev, block)) {
2551 yaffs_trace(YAFFS_TRACE_TRACING,
2552 "Collecting block %d that has no chunks in use",
2554 yaffs_block_became_dirty(dev, block);
2557 u8 *buffer = yaffs_get_temp_buffer(dev);
2559 yaffs_verify_blk(dev, bi, block);
2561 max_copies = (whole_block) ? dev->param.chunks_per_block : 5;
2562 old_chunk = block * dev->param.chunks_per_block + dev->gc_chunk;
2564 for (/* init already done */ ;
2565 ret_val == YAFFS_OK &&
2566 dev->gc_chunk < dev->param.chunks_per_block &&
2567 (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) &&
2569 dev->gc_chunk++, old_chunk++) {
2570 if (yaffs_check_chunk_bit(dev, block, dev->gc_chunk)) {
2571 /* Page is in use and might need to be copied */
2573 ret_val = yaffs_gc_process_chunk(dev, bi,
2577 yaffs_release_temp_buffer(dev, buffer);
2580 yaffs_verify_collected_blk(dev, bi, block);
2582 if (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2584 * The gc did not complete. Set block state back to FULL
2585 * because checkpointing does not restore gc.
2587 bi->block_state = YAFFS_BLOCK_STATE_FULL;
2589 /* The gc completed. */
2590 /* Do any required cleanups */
2591 for (i = 0; i < dev->n_clean_ups; i++) {
2592 /* Time to delete the file too */
2593 struct yaffs_obj *object =
2594 yaffs_find_by_number(dev, dev->gc_cleanup_list[i]);
2596 yaffs_free_tnode(dev,
2597 object->variant.file_variant.top);
2598 object->variant.file_variant.top = NULL;
2599 yaffs_trace(YAFFS_TRACE_GC,
2600 "yaffs: About to finally delete object %d",
2602 yaffs_generic_obj_del(object);
2603 object->my_dev->n_deleted_files--;
2607 chunks_after = yaffs_get_erased_chunks(dev);
2608 if (chunks_before >= chunks_after)
2609 yaffs_trace(YAFFS_TRACE_GC,
2610 "gc did not increase free chunks before %d after %d",
2611 chunks_before, chunks_after);
2614 dev->n_clean_ups = 0;
2617 dev->gc_disable = 0;
2623 * find_gc_block() selects the dirtiest block (or close enough)
2624 * for garbage collection.
2627 static unsigned yaffs_find_gc_block(struct yaffs_dev *dev,
2628 int aggressive, int background)
2632 unsigned selected = 0;
2633 int prioritised = 0;
2634 int prioritised_exist = 0;
2635 struct yaffs_block_info *bi;
2638 /* First let's see if we need to grab a prioritised block */
2639 if (dev->has_pending_prioritised_gc && !aggressive) {
2640 dev->gc_dirtiest = 0;
2641 bi = dev->block_info;
2642 for (i = dev->internal_start_block;
2643 i <= dev->internal_end_block && !selected; i++) {
2645 if (bi->gc_prioritise) {
2646 prioritised_exist = 1;
2647 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2648 yaffs_block_ok_for_gc(dev, bi)) {
2657 * If there is a prioritised block and none was selected then
2658 * this happened because there is at least one old dirty block
2659 * gumming up the works. Let's gc the oldest dirty block.
2662 if (prioritised_exist &&
2663 !selected && dev->oldest_dirty_block > 0)
2664 selected = dev->oldest_dirty_block;
2666 if (!prioritised_exist) /* None found, so we can clear this */
2667 dev->has_pending_prioritised_gc = 0;
2670 /* If we're doing aggressive GC then we are happy to take a less-dirty
2671 * block, and search harder.
2672 * else (leasurely gc), then we only bother to do this if the
2673 * block has only a few pages in use.
2679 dev->internal_end_block - dev->internal_start_block + 1;
2681 threshold = dev->param.chunks_per_block;
2682 iterations = n_blocks;
2687 max_threshold = dev->param.chunks_per_block / 2;
2689 max_threshold = dev->param.chunks_per_block / 8;
2691 if (max_threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2692 max_threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2694 threshold = background ? (dev->gc_not_done + 2) * 2 : 0;
2695 if (threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2696 threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2697 if (threshold > max_threshold)
2698 threshold = max_threshold;
2700 iterations = n_blocks / 16 + 1;
2701 if (iterations > 100)
2707 (dev->gc_dirtiest < 1 ||
2708 dev->gc_pages_in_use > YAFFS_GC_GOOD_ENOUGH);
2710 dev->gc_block_finder++;
2711 if (dev->gc_block_finder < dev->internal_start_block ||
2712 dev->gc_block_finder > dev->internal_end_block)
2713 dev->gc_block_finder =
2714 dev->internal_start_block;
2716 bi = yaffs_get_block_info(dev, dev->gc_block_finder);
2718 pages_used = bi->pages_in_use - bi->soft_del_pages;
2720 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2721 pages_used < dev->param.chunks_per_block &&
2722 (dev->gc_dirtiest < 1 ||
2723 pages_used < dev->gc_pages_in_use) &&
2724 yaffs_block_ok_for_gc(dev, bi)) {
2725 dev->gc_dirtiest = dev->gc_block_finder;
2726 dev->gc_pages_in_use = pages_used;
2730 if (dev->gc_dirtiest > 0 && dev->gc_pages_in_use <= threshold)
2731 selected = dev->gc_dirtiest;
2735 * If nothing has been selected for a while, try the oldest dirty
2736 * because that's gumming up the works.
2739 if (!selected && dev->param.is_yaffs2 &&
2740 dev->gc_not_done >= (background ? 10 : 20)) {
2741 yaffs2_find_oldest_dirty_seq(dev);
2742 if (dev->oldest_dirty_block > 0) {
2743 selected = dev->oldest_dirty_block;
2744 dev->gc_dirtiest = selected;
2745 dev->oldest_dirty_gc_count++;
2746 bi = yaffs_get_block_info(dev, selected);
2747 dev->gc_pages_in_use =
2748 bi->pages_in_use - bi->soft_del_pages;
2750 dev->gc_not_done = 0;
2755 yaffs_trace(YAFFS_TRACE_GC,
2756 "GC Selected block %d with %d free, prioritised:%d",
2758 dev->param.chunks_per_block - dev->gc_pages_in_use,
2765 dev->gc_dirtiest = 0;
2766 dev->gc_pages_in_use = 0;
2767 dev->gc_not_done = 0;
2768 if (dev->refresh_skip > 0)
2769 dev->refresh_skip--;
2772 yaffs_trace(YAFFS_TRACE_GC,
2773 "GC none: finder %d skip %d threshold %d dirtiest %d using %d oldest %d%s",
2774 dev->gc_block_finder, dev->gc_not_done, threshold,
2775 dev->gc_dirtiest, dev->gc_pages_in_use,
2776 dev->oldest_dirty_block, background ? " bg" : "");
2782 /* New garbage collector
2783 * If we're very low on erased blocks then we do aggressive garbage collection
2784 * otherwise we do "leasurely" garbage collection.
2785 * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2786 * Passive gc only inspects smaller areas and only accepts more dirty blocks.
2788 * The idea is to help clear out space in a more spread-out manner.
2789 * Dunno if it really does anything useful.
2791 static int yaffs_check_gc(struct yaffs_dev *dev, int background)
2794 int gc_ok = YAFFS_OK;
2798 int checkpt_block_adjust;
2800 if (dev->param.gc_control && (dev->param.gc_control(dev) & 1) == 0)
2803 if (dev->gc_disable)
2804 /* Bail out so we don't get recursive gc */
2807 /* This loop should pass the first time.
2808 * Only loops here if the collection does not increase space.
2814 checkpt_block_adjust = yaffs_calc_checkpt_blocks_required(dev);
2817 dev->param.n_reserved_blocks + checkpt_block_adjust + 1;
2819 dev->n_erased_blocks * dev->param.chunks_per_block;
2821 /* If we need a block soon then do aggressive gc. */
2822 if (dev->n_erased_blocks < min_erased)
2826 && erased_chunks > (dev->n_free_chunks / 4))
2829 if (dev->gc_skip > 20)
2831 if (erased_chunks < dev->n_free_chunks / 2 ||
2832 dev->gc_skip < 1 || background)
2842 /* If we don't already have a block being gc'd then see if we
2843 * should start another */
2845 if (dev->gc_block < 1 && !aggressive) {
2846 dev->gc_block = yaffs2_find_refresh_block(dev);
2848 dev->n_clean_ups = 0;
2850 if (dev->gc_block < 1) {
2852 yaffs_find_gc_block(dev, aggressive, background);
2854 dev->n_clean_ups = 0;
2857 if (dev->gc_block > 0) {
2860 dev->passive_gc_count++;
2862 yaffs_trace(YAFFS_TRACE_GC,
2863 "yaffs: GC n_erased_blocks %d aggressive %d",
2864 dev->n_erased_blocks, aggressive);
2866 gc_ok = yaffs_gc_block(dev, dev->gc_block, aggressive);
2869 if (dev->n_erased_blocks < (dev->param.n_reserved_blocks) &&
2870 dev->gc_block > 0) {
2871 yaffs_trace(YAFFS_TRACE_GC,
2872 "yaffs: GC !!!no reclaim!!! n_erased_blocks %d after try %d block %d",
2873 dev->n_erased_blocks, max_tries,
2876 } while ((dev->n_erased_blocks < dev->param.n_reserved_blocks) &&
2877 (dev->gc_block > 0) && (max_tries < 2));
2879 return aggressive ? gc_ok : YAFFS_OK;
2884 * Garbage collects. Intended to be called from a background thread.
2885 * Returns non-zero if at least half the free chunks are erased.
2887 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency)
2889 int erased_chunks = dev->n_erased_blocks * dev->param.chunks_per_block;
2891 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Background gc %u", urgency);
2893 yaffs_check_gc(dev, 1);
2894 return erased_chunks > dev->n_free_chunks / 2;
2897 /*-------------------- Data file manipulation -----------------*/
2899 static int yaffs_rd_data_obj(struct yaffs_obj *in, int inode_chunk, u8 * buffer)
2901 int nand_chunk = yaffs_find_chunk_in_file(in, inode_chunk, NULL);
2903 if (nand_chunk >= 0)
2904 return yaffs_rd_chunk_tags_nand(in->my_dev, nand_chunk,
2907 yaffs_trace(YAFFS_TRACE_NANDACCESS,
2908 "Chunk %d not found zero instead",
2910 /* get sane (zero) data if you read a hole */
2911 memset(buffer, 0, in->my_dev->data_bytes_per_chunk);
2917 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
2922 struct yaffs_ext_tags tags;
2923 struct yaffs_block_info *bi;
2929 block = chunk_id / dev->param.chunks_per_block;
2930 page = chunk_id % dev->param.chunks_per_block;
2932 if (!yaffs_check_chunk_bit(dev, block, page))
2933 yaffs_trace(YAFFS_TRACE_VERIFY,
2934 "Deleting invalid chunk %d", chunk_id);
2936 bi = yaffs_get_block_info(dev, block);
2938 yaffs2_update_oldest_dirty_seq(dev, block, bi);
2940 yaffs_trace(YAFFS_TRACE_DELETION,
2941 "line %d delete of chunk %d",
2944 if (!dev->param.is_yaffs2 && mark_flash &&
2945 bi->block_state != YAFFS_BLOCK_STATE_COLLECTING) {
2947 memset(&tags, 0, sizeof(tags));
2948 tags.is_deleted = 1;
2949 yaffs_wr_chunk_tags_nand(dev, chunk_id, NULL, &tags);
2950 yaffs_handle_chunk_update(dev, chunk_id, &tags);
2952 dev->n_unmarked_deletions++;
2955 /* Pull out of the management area.
2956 * If the whole block became dirty, this will kick off an erasure.
2958 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING ||
2959 bi->block_state == YAFFS_BLOCK_STATE_FULL ||
2960 bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCAN ||
2961 bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2962 dev->n_free_chunks++;
2963 yaffs_clear_chunk_bit(dev, block, page);
2966 if (bi->pages_in_use == 0 &&
2967 !bi->has_shrink_hdr &&
2968 bi->block_state != YAFFS_BLOCK_STATE_ALLOCATING &&
2969 bi->block_state != YAFFS_BLOCK_STATE_NEEDS_SCAN) {
2970 yaffs_block_became_dirty(dev, block);
2975 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
2976 const u8 *buffer, int n_bytes, int use_reserve)
2978 /* Find old chunk Need to do this to get serial number
2979 * Write new one and patch into tree.
2980 * Invalidate old tags.
2984 struct yaffs_ext_tags prev_tags;
2986 struct yaffs_ext_tags new_tags;
2987 struct yaffs_dev *dev = in->my_dev;
2989 yaffs_check_gc(dev, 0);
2991 /* Get the previous chunk at this location in the file if it exists.
2992 * If it does not exist then put a zero into the tree. This creates
2993 * the tnode now, rather than later when it is harder to clean up.
2995 prev_chunk_id = yaffs_find_chunk_in_file(in, inode_chunk, &prev_tags);
2996 if (prev_chunk_id < 1 &&
2997 !yaffs_put_chunk_in_file(in, inode_chunk, 0, 0))
3000 /* Set up new tags */
3001 memset(&new_tags, 0, sizeof(new_tags));
3003 new_tags.chunk_id = inode_chunk;
3004 new_tags.obj_id = in->obj_id;
3005 new_tags.serial_number =
3006 (prev_chunk_id > 0) ? prev_tags.serial_number + 1 : 1;
3007 new_tags.n_bytes = n_bytes;
3009 if (n_bytes < 1 || n_bytes > dev->param.total_bytes_per_chunk) {
3010 yaffs_trace(YAFFS_TRACE_ERROR,
3011 "Writing %d bytes to chunk!!!!!!!!!",
3017 yaffs_write_new_chunk(dev, buffer, &new_tags, use_reserve);
3019 if (new_chunk_id > 0) {
3020 yaffs_put_chunk_in_file(in, inode_chunk, new_chunk_id, 0);
3022 if (prev_chunk_id > 0)
3023 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3025 yaffs_verify_file_sane(in);
3027 return new_chunk_id;
3033 static int yaffs_do_xattrib_mod(struct yaffs_obj *obj, int set,
3034 const YCHAR *name, const void *value, int size,
3037 struct yaffs_xattr_mod xmod;
3045 xmod.result = -ENOSPC;
3047 result = yaffs_update_oh(obj, NULL, 0, 0, 0, &xmod);
3055 static int yaffs_apply_xattrib_mod(struct yaffs_obj *obj, char *buffer,
3056 struct yaffs_xattr_mod *xmod)
3059 int x_offs = sizeof(struct yaffs_obj_hdr);
3060 struct yaffs_dev *dev = obj->my_dev;
3061 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3062 char *x_buffer = buffer + x_offs;
3066 nval_set(x_buffer, x_size, xmod->name, xmod->data,
3067 xmod->size, xmod->flags);
3069 retval = nval_del(x_buffer, x_size, xmod->name);
3071 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3072 obj->xattr_known = 1;
3073 xmod->result = retval;
3078 static int yaffs_do_xattrib_fetch(struct yaffs_obj *obj, const YCHAR *name,
3079 void *value, int size)
3081 char *buffer = NULL;
3083 struct yaffs_ext_tags tags;
3084 struct yaffs_dev *dev = obj->my_dev;
3085 int x_offs = sizeof(struct yaffs_obj_hdr);
3086 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3090 if (obj->hdr_chunk < 1)
3093 /* If we know that the object has no xattribs then don't do all the
3094 * reading and parsing.
3096 if (obj->xattr_known && !obj->has_xattr) {
3103 buffer = (char *)yaffs_get_temp_buffer(dev);
3108 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, (u8 *) buffer, &tags);
3110 if (result != YAFFS_OK)
3113 x_buffer = buffer + x_offs;
3115 if (!obj->xattr_known) {
3116 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3117 obj->xattr_known = 1;
3121 retval = nval_get(x_buffer, x_size, name, value, size);
3123 retval = nval_list(x_buffer, x_size, value, size);
3125 yaffs_release_temp_buffer(dev, (u8 *) buffer);
3129 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR * name,
3130 const void *value, int size, int flags)
3132 return yaffs_do_xattrib_mod(obj, 1, name, value, size, flags);
3135 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR * name)
3137 return yaffs_do_xattrib_mod(obj, 0, name, NULL, 0, 0);
3140 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR * name, void *value,
3143 return yaffs_do_xattrib_fetch(obj, name, value, size);
3146 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size)
3148 return yaffs_do_xattrib_fetch(obj, NULL, buffer, size);
3151 static void yaffs_check_obj_details_loaded(struct yaffs_obj *in)
3154 struct yaffs_obj_hdr *oh;
3155 struct yaffs_dev *dev;
3156 struct yaffs_ext_tags tags;
3158 int alloc_failed = 0;
3160 if (!in || !in->lazy_loaded || in->hdr_chunk < 1)
3164 in->lazy_loaded = 0;
3165 buf = yaffs_get_temp_buffer(dev);
3167 result = yaffs_rd_chunk_tags_nand(dev, in->hdr_chunk, buf, &tags);
3168 oh = (struct yaffs_obj_hdr *)buf;
3170 in->yst_mode = oh->yst_mode;
3171 yaffs_load_attribs(in, oh);
3172 yaffs_set_obj_name_from_oh(in, oh);
3174 if (in->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
3175 in->variant.symlink_variant.alias =
3176 yaffs_clone_str(oh->alias);
3177 if (!in->variant.symlink_variant.alias)
3178 alloc_failed = 1; /* Not returned */
3180 yaffs_release_temp_buffer(dev, buf);
3183 static void yaffs_load_name_from_oh(struct yaffs_dev *dev, YCHAR *name,
3184 const YCHAR *oh_name, int buff_size)
3186 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3187 if (dev->param.auto_unicode) {
3189 /* It is an ASCII name, do an ASCII to
3190 * unicode conversion */
3191 const char *ascii_oh_name = (const char *)oh_name;
3192 int n = buff_size - 1;
3193 while (n > 0 && *ascii_oh_name) {
3194 *name = *ascii_oh_name;
3200 strncpy(name, oh_name + 1, buff_size - 1);
3207 strncpy(name, oh_name, buff_size - 1);
3211 static void yaffs_load_oh_from_name(struct yaffs_dev *dev, YCHAR *oh_name,
3214 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3219 if (dev->param.auto_unicode) {
3224 /* Figure out if the name will fit in ascii character set */
3225 while (is_ascii && *w) {
3232 /* It is an ASCII name, so convert unicode to ascii */
3233 char *ascii_oh_name = (char *)oh_name;
3234 int n = YAFFS_MAX_NAME_LENGTH - 1;
3235 while (n > 0 && *name) {
3236 *ascii_oh_name = *name;
3242 /* Unicode name, so save starting at the second YCHAR */
3244 strncpy(oh_name + 1, name, YAFFS_MAX_NAME_LENGTH - 2);
3251 strncpy(oh_name, name, YAFFS_MAX_NAME_LENGTH - 1);
3255 /* UpdateObjectHeader updates the header on NAND for an object.
3256 * If name is not NULL, then that new name is used.
3258 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name, int force,
3259 int is_shrink, int shadows, struct yaffs_xattr_mod *xmod)
3262 struct yaffs_block_info *bi;
3263 struct yaffs_dev *dev = in->my_dev;
3268 struct yaffs_ext_tags new_tags;
3269 struct yaffs_ext_tags old_tags;
3270 const YCHAR *alias = NULL;
3272 YCHAR old_name[YAFFS_MAX_NAME_LENGTH + 1];
3273 struct yaffs_obj_hdr *oh = NULL;
3274 loff_t file_size = 0;
3276 strcpy(old_name, _Y("silly old name"));
3278 if (in->fake && in != dev->root_dir && !force && !xmod)
3281 yaffs_check_gc(dev, 0);
3282 yaffs_check_obj_details_loaded(in);
3284 buffer = yaffs_get_temp_buffer(in->my_dev);
3285 oh = (struct yaffs_obj_hdr *)buffer;
3287 prev_chunk_id = in->hdr_chunk;
3289 if (prev_chunk_id > 0) {
3290 result = yaffs_rd_chunk_tags_nand(dev, prev_chunk_id,
3293 yaffs_verify_oh(in, oh, &old_tags, 0);
3294 memcpy(old_name, oh->name, sizeof(oh->name));
3295 memset(buffer, 0xff, sizeof(struct yaffs_obj_hdr));
3297 memset(buffer, 0xff, dev->data_bytes_per_chunk);
3300 oh->type = in->variant_type;
3301 oh->yst_mode = in->yst_mode;
3302 oh->shadows_obj = oh->inband_shadowed_obj_id = shadows;
3304 yaffs_load_attribs_oh(oh, in);
3307 oh->parent_obj_id = in->parent->obj_id;
3309 oh->parent_obj_id = 0;
3311 if (name && *name) {
3312 memset(oh->name, 0, sizeof(oh->name));
3313 yaffs_load_oh_from_name(dev, oh->name, name);
3314 } else if (prev_chunk_id > 0) {
3315 memcpy(oh->name, old_name, sizeof(oh->name));
3317 memset(oh->name, 0, sizeof(oh->name));
3320 oh->is_shrink = is_shrink;
3322 switch (in->variant_type) {
3323 case YAFFS_OBJECT_TYPE_UNKNOWN:
3324 /* Should not happen */
3326 case YAFFS_OBJECT_TYPE_FILE:
3327 if (oh->parent_obj_id != YAFFS_OBJECTID_DELETED &&
3328 oh->parent_obj_id != YAFFS_OBJECTID_UNLINKED)
3329 file_size = in->variant.file_variant.file_size;
3330 yaffs_oh_size_load(oh, file_size);
3332 case YAFFS_OBJECT_TYPE_HARDLINK:
3333 oh->equiv_id = in->variant.hardlink_variant.equiv_id;
3335 case YAFFS_OBJECT_TYPE_SPECIAL:
3338 case YAFFS_OBJECT_TYPE_DIRECTORY:
3341 case YAFFS_OBJECT_TYPE_SYMLINK:
3342 alias = in->variant.symlink_variant.alias;
3344 alias = _Y("no alias");
3345 strncpy(oh->alias, alias, YAFFS_MAX_ALIAS_LENGTH);
3346 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3350 /* process any xattrib modifications */
3352 yaffs_apply_xattrib_mod(in, (char *)buffer, xmod);
3355 memset(&new_tags, 0, sizeof(new_tags));
3357 new_tags.chunk_id = 0;
3358 new_tags.obj_id = in->obj_id;
3359 new_tags.serial_number = in->serial;
3361 /* Add extra info for file header */
3362 new_tags.extra_available = 1;
3363 new_tags.extra_parent_id = oh->parent_obj_id;
3364 new_tags.extra_file_size = file_size;
3365 new_tags.extra_is_shrink = oh->is_shrink;
3366 new_tags.extra_equiv_id = oh->equiv_id;
3367 new_tags.extra_shadows = (oh->shadows_obj > 0) ? 1 : 0;
3368 new_tags.extra_obj_type = in->variant_type;
3369 yaffs_verify_oh(in, oh, &new_tags, 1);
3371 /* Create new chunk in NAND */
3373 yaffs_write_new_chunk(dev, buffer, &new_tags,
3374 (prev_chunk_id > 0) ? 1 : 0);
3377 yaffs_release_temp_buffer(dev, buffer);
3379 if (new_chunk_id < 0)
3380 return new_chunk_id;
3382 in->hdr_chunk = new_chunk_id;
3384 if (prev_chunk_id > 0)
3385 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3387 if (!yaffs_obj_cache_dirty(in))
3390 /* If this was a shrink, then mark the block
3391 * that the chunk lives on */
3393 bi = yaffs_get_block_info(in->my_dev,
3395 in->my_dev->param.chunks_per_block);
3396 bi->has_shrink_hdr = 1;
3400 return new_chunk_id;
3403 /*--------------------- File read/write ------------------------
3404 * Read and write have very similar structures.
3405 * In general the read/write has three parts to it
3406 * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3407 * Some complete chunks
3408 * An incomplete chunk to end off with
3410 * Curve-balls: the first chunk might also be the last chunk.
3413 int yaffs_file_rd(struct yaffs_obj *in, u8 * buffer, loff_t offset, int n_bytes)
3420 struct yaffs_cache *cache;
3421 struct yaffs_dev *dev;
3426 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3429 /* OK now check for the curveball where the start and end are in
3432 if ((start + n) < dev->data_bytes_per_chunk)
3435 n_copy = dev->data_bytes_per_chunk - start;
3437 cache = yaffs_find_chunk_cache(in, chunk);
3439 /* If the chunk is already in the cache or it is less than
3440 * a whole chunk or we're using inband tags then use the cache
3441 * (if there is caching) else bypass the cache.
3443 if (cache || n_copy != dev->data_bytes_per_chunk ||
3444 dev->param.inband_tags) {
3445 if (dev->param.n_caches > 0) {
3447 /* If we can't find the data in the cache,
3448 * then load it up. */
3452 yaffs_grab_chunk_cache(in->my_dev);
3454 cache->chunk_id = chunk;
3457 yaffs_rd_data_obj(in, chunk,
3462 yaffs_use_cache(dev, cache, 0);
3466 memcpy(buffer, &cache->data[start], n_copy);
3470 /* Read into the local buffer then copy.. */
3473 yaffs_get_temp_buffer(dev);
3474 yaffs_rd_data_obj(in, chunk, local_buffer);
3476 memcpy(buffer, &local_buffer[start], n_copy);
3478 yaffs_release_temp_buffer(dev, local_buffer);
3481 /* A full chunk. Read directly into the buffer. */
3482 yaffs_rd_data_obj(in, chunk, buffer);
3492 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
3493 int n_bytes, int write_through)
3502 loff_t start_write = offset;
3503 int chunk_written = 0;
3506 struct yaffs_dev *dev;
3510 while (n > 0 && chunk_written >= 0) {
3511 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3513 if (((loff_t)chunk) *
3514 dev->data_bytes_per_chunk + start != offset ||
3515 start >= dev->data_bytes_per_chunk) {
3516 yaffs_trace(YAFFS_TRACE_ERROR,
3517 "AddrToChunk of offset %lld gives chunk %d start %d",
3518 offset, chunk, start);
3520 chunk++; /* File pos to chunk in file offset */
3522 /* OK now check for the curveball where the start and end are in
3526 if ((start + n) < dev->data_bytes_per_chunk) {
3529 /* Now calculate how many bytes to write back....
3530 * If we're overwriting and not writing to then end of
3531 * file then we need to write back as much as was there
3535 chunk_start = (((loff_t)(chunk - 1)) *
3536 dev->data_bytes_per_chunk);
3538 if (chunk_start > in->variant.file_variant.file_size)
3539 n_bytes_read = 0; /* Past end of file */
3542 in->variant.file_variant.file_size -
3545 if (n_bytes_read > dev->data_bytes_per_chunk)
3546 n_bytes_read = dev->data_bytes_per_chunk;
3550 (start + n)) ? n_bytes_read : (start + n);
3552 if (n_writeback < 0 ||
3553 n_writeback > dev->data_bytes_per_chunk)
3557 n_copy = dev->data_bytes_per_chunk - start;
3558 n_writeback = dev->data_bytes_per_chunk;
3561 if (n_copy != dev->data_bytes_per_chunk ||
3562 dev->param.inband_tags) {
3563 /* An incomplete start or end chunk (or maybe both
3564 * start and end chunk), or we're using inband tags,
3565 * so we want to use the cache buffers.
3567 if (dev->param.n_caches > 0) {
3568 struct yaffs_cache *cache;
3570 /* If we can't find the data in the cache, then
3572 cache = yaffs_find_chunk_cache(in, chunk);
3575 yaffs_check_alloc_available(dev, 1)) {
3576 cache = yaffs_grab_chunk_cache(dev);
3578 cache->chunk_id = chunk;
3581 yaffs_rd_data_obj(in, chunk,
3585 !yaffs_check_alloc_available(dev,
3587 /* Drop the cache if it was a read cache
3588 * item and no space check has been made
3595 yaffs_use_cache(dev, cache, 1);
3598 memcpy(&cache->data[start], buffer,
3602 cache->n_bytes = n_writeback;
3604 if (write_through) {
3614 chunk_written = -1; /* fail write */
3617 /* An incomplete start or end chunk (or maybe
3618 * both start and end chunk). Read into the
3619 * local buffer then copy over and write back.
3622 u8 *local_buffer = yaffs_get_temp_buffer(dev);
3624 yaffs_rd_data_obj(in, chunk, local_buffer);
3625 memcpy(&local_buffer[start], buffer, n_copy);
3628 yaffs_wr_data_obj(in, chunk,
3632 yaffs_release_temp_buffer(dev, local_buffer);
3635 /* A full chunk. Write directly from the buffer. */
3638 yaffs_wr_data_obj(in, chunk, buffer,
3639 dev->data_bytes_per_chunk, 0);
3641 /* Since we've overwritten the cached data,
3642 * we better invalidate it. */
3643 yaffs_invalidate_chunk_cache(in, chunk);
3646 if (chunk_written >= 0) {
3654 /* Update file object */
3656 if ((start_write + n_done) > in->variant.file_variant.file_size)
3657 in->variant.file_variant.file_size = (start_write + n_done);
3663 int yaffs_wr_file(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
3664 int n_bytes, int write_through)
3666 yaffs2_handle_hole(in, offset);
3667 return yaffs_do_file_wr(in, buffer, offset, n_bytes, write_through);
3670 /* ---------------------- File resizing stuff ------------------ */
3672 static void yaffs_prune_chunks(struct yaffs_obj *in, loff_t new_size)
3675 struct yaffs_dev *dev = in->my_dev;
3676 loff_t old_size = in->variant.file_variant.file_size;
3684 yaffs_addr_to_chunk(dev, old_size - 1, &last_del, &dummy);
3688 yaffs_addr_to_chunk(dev, new_size + dev->data_bytes_per_chunk - 1,
3689 &start_del, &dummy);
3693 /* Delete backwards so that we don't end up with holes if
3694 * power is lost part-way through the operation.
3696 for (i = last_del; i >= start_del; i--) {
3697 /* NB this could be optimised somewhat,
3698 * eg. could retrieve the tags and write them without
3699 * using yaffs_chunk_del
3702 chunk_id = yaffs_find_del_file_chunk(in, i, NULL);
3708 (dev->internal_start_block * dev->param.chunks_per_block) ||
3710 ((dev->internal_end_block + 1) *
3711 dev->param.chunks_per_block)) {
3712 yaffs_trace(YAFFS_TRACE_ALWAYS,
3713 "Found daft chunk_id %d for %d",
3716 in->n_data_chunks--;
3717 yaffs_chunk_del(dev, chunk_id, 1, __LINE__);
3722 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size)
3726 struct yaffs_dev *dev = obj->my_dev;
3728 yaffs_addr_to_chunk(dev, new_size, &new_full, &new_partial);
3730 yaffs_prune_chunks(obj, new_size);
3732 if (new_partial != 0) {
3733 int last_chunk = 1 + new_full;
3734 u8 *local_buffer = yaffs_get_temp_buffer(dev);
3736 /* Rewrite the last chunk with its new size and zero pad */
3737 yaffs_rd_data_obj(obj, last_chunk, local_buffer);
3738 memset(local_buffer + new_partial, 0,
3739 dev->data_bytes_per_chunk - new_partial);
3741 yaffs_wr_data_obj(obj, last_chunk, local_buffer,
3744 yaffs_release_temp_buffer(dev, local_buffer);
3747 obj->variant.file_variant.file_size = new_size;
3749 yaffs_prune_tree(dev, &obj->variant.file_variant);
3752 int yaffs_resize_file(struct yaffs_obj *in, loff_t new_size)
3754 struct yaffs_dev *dev = in->my_dev;
3755 loff_t old_size = in->variant.file_variant.file_size;
3757 yaffs_flush_file_cache(in);
3758 yaffs_invalidate_whole_cache(in);
3760 yaffs_check_gc(dev, 0);
3762 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE)
3765 if (new_size == old_size)
3768 if (new_size > old_size) {
3769 yaffs2_handle_hole(in, new_size);
3770 in->variant.file_variant.file_size = new_size;
3772 /* new_size < old_size */
3773 yaffs_resize_file_down(in, new_size);
3776 /* Write a new object header to reflect the resize.
3777 * show we've shrunk the file, if need be
3778 * Do this only if the file is not in the deleted directories
3779 * and is not shadowed.
3783 in->parent->obj_id != YAFFS_OBJECTID_UNLINKED &&
3784 in->parent->obj_id != YAFFS_OBJECTID_DELETED)
3785 yaffs_update_oh(in, NULL, 0, 0, 0, NULL);
3790 int yaffs_flush_file(struct yaffs_obj *in, int update_time, int data_sync)
3795 yaffs_flush_file_cache(in);
3801 yaffs_load_current_time(in, 0, 0);
3803 return (yaffs_update_oh(in, NULL, 0, 0, 0, NULL) >= 0) ?
3804 YAFFS_OK : YAFFS_FAIL;
3808 /* yaffs_del_file deletes the whole file data
3809 * and the inode associated with the file.
3810 * It does not delete the links associated with the file.
3812 static int yaffs_unlink_file_if_needed(struct yaffs_obj *in)
3816 struct yaffs_dev *dev = in->my_dev;
3823 yaffs_change_obj_name(in, in->my_dev->del_dir,
3824 _Y("deleted"), 0, 0);
3825 yaffs_trace(YAFFS_TRACE_TRACING,
3826 "yaffs: immediate deletion of file %d",
3829 in->my_dev->n_deleted_files++;
3830 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3831 yaffs_resize_file(in, 0);
3832 yaffs_soft_del_file(in);
3835 yaffs_change_obj_name(in, in->my_dev->unlinked_dir,
3836 _Y("unlinked"), 0, 0);
3841 static int yaffs_del_file(struct yaffs_obj *in)
3843 int ret_val = YAFFS_OK;
3844 int deleted; /* Need to cache value on stack if in is freed */
3845 struct yaffs_dev *dev = in->my_dev;
3847 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3848 yaffs_resize_file(in, 0);
3850 if (in->n_data_chunks > 0) {
3851 /* Use soft deletion if there is data in the file.
3852 * That won't be the case if it has been resized to zero.
3855 ret_val = yaffs_unlink_file_if_needed(in);
3857 deleted = in->deleted;
3859 if (ret_val == YAFFS_OK && in->unlinked && !in->deleted) {
3862 in->my_dev->n_deleted_files++;
3863 yaffs_soft_del_file(in);
3865 return deleted ? YAFFS_OK : YAFFS_FAIL;
3867 /* The file has no data chunks so we toss it immediately */
3868 yaffs_free_tnode(in->my_dev, in->variant.file_variant.top);
3869 in->variant.file_variant.top = NULL;
3870 yaffs_generic_obj_del(in);
3876 int yaffs_is_non_empty_dir(struct yaffs_obj *obj)
3879 obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) &&
3880 !(list_empty(&obj->variant.dir_variant.children));
3883 static int yaffs_del_dir(struct yaffs_obj *obj)
3885 /* First check that the directory is empty. */
3886 if (yaffs_is_non_empty_dir(obj))
3889 return yaffs_generic_obj_del(obj);
3892 static int yaffs_del_symlink(struct yaffs_obj *in)
3894 kfree(in->variant.symlink_variant.alias);
3895 in->variant.symlink_variant.alias = NULL;
3897 return yaffs_generic_obj_del(in);
3900 static int yaffs_del_link(struct yaffs_obj *in)
3902 /* remove this hardlink from the list associated with the equivalent
3905 list_del_init(&in->hard_links);
3906 return yaffs_generic_obj_del(in);
3909 int yaffs_del_obj(struct yaffs_obj *obj)
3913 switch (obj->variant_type) {
3914 case YAFFS_OBJECT_TYPE_FILE:
3915 ret_val = yaffs_del_file(obj);
3917 case YAFFS_OBJECT_TYPE_DIRECTORY:
3918 if (!list_empty(&obj->variant.dir_variant.dirty)) {
3919 yaffs_trace(YAFFS_TRACE_BACKGROUND,
3920 "Remove object %d from dirty directories",
3922 list_del_init(&obj->variant.dir_variant.dirty);
3924 return yaffs_del_dir(obj);
3926 case YAFFS_OBJECT_TYPE_SYMLINK:
3927 ret_val = yaffs_del_symlink(obj);
3929 case YAFFS_OBJECT_TYPE_HARDLINK:
3930 ret_val = yaffs_del_link(obj);
3932 case YAFFS_OBJECT_TYPE_SPECIAL:
3933 ret_val = yaffs_generic_obj_del(obj);
3935 case YAFFS_OBJECT_TYPE_UNKNOWN:
3937 break; /* should not happen. */
3942 static int yaffs_unlink_worker(struct yaffs_obj *obj)
3952 yaffs_update_parent(obj->parent);
3954 if (obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
3955 return yaffs_del_link(obj);
3956 } else if (!list_empty(&obj->hard_links)) {
3957 /* Curve ball: We're unlinking an object that has a hardlink.
3959 * This problem arises because we are not strictly following
3960 * The Linux link/inode model.
3962 * We can't really delete the object.
3963 * Instead, we do the following:
3964 * - Select a hardlink.
3965 * - Unhook it from the hard links
3966 * - Move it from its parent directory so that the rename works.
3967 * - Rename the object to the hardlink's name.
3968 * - Delete the hardlink
3971 struct yaffs_obj *hl;
3972 struct yaffs_obj *parent;
3974 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
3976 hl = list_entry(obj->hard_links.next, struct yaffs_obj,
3979 yaffs_get_obj_name(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
3980 parent = hl->parent;
3982 list_del_init(&hl->hard_links);
3984 yaffs_add_obj_to_dir(obj->my_dev->unlinked_dir, hl);
3986 ret_val = yaffs_change_obj_name(obj, parent, name, 0, 0);
3988 if (ret_val == YAFFS_OK)
3989 ret_val = yaffs_generic_obj_del(hl);
3993 } else if (del_now) {
3994 switch (obj->variant_type) {
3995 case YAFFS_OBJECT_TYPE_FILE:
3996 return yaffs_del_file(obj);
3998 case YAFFS_OBJECT_TYPE_DIRECTORY:
3999 list_del_init(&obj->variant.dir_variant.dirty);
4000 return yaffs_del_dir(obj);
4002 case YAFFS_OBJECT_TYPE_SYMLINK:
4003 return yaffs_del_symlink(obj);
4005 case YAFFS_OBJECT_TYPE_SPECIAL:
4006 return yaffs_generic_obj_del(obj);
4008 case YAFFS_OBJECT_TYPE_HARDLINK:
4009 case YAFFS_OBJECT_TYPE_UNKNOWN:
4013 } else if (yaffs_is_non_empty_dir(obj)) {
4016 return yaffs_change_obj_name(obj, obj->my_dev->unlinked_dir,
4017 _Y("unlinked"), 0, 0);
4021 static int yaffs_unlink_obj(struct yaffs_obj *obj)
4023 if (obj && obj->unlink_allowed)
4024 return yaffs_unlink_worker(obj);
4029 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR *name)
4031 struct yaffs_obj *obj;
4033 obj = yaffs_find_by_name(dir, name);
4034 return yaffs_unlink_obj(obj);
4038 * If old_name is NULL then we take old_dir as the object to be renamed.
4040 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR *old_name,
4041 struct yaffs_obj *new_dir, const YCHAR *new_name)
4043 struct yaffs_obj *obj = NULL;
4044 struct yaffs_obj *existing_target = NULL;
4047 struct yaffs_dev *dev;
4049 if (!old_dir || old_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4053 if (!new_dir || new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4058 dev = old_dir->my_dev;
4060 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
4061 /* Special case for case insemsitive systems.
4062 * While look-up is case insensitive, the name isn't.
4063 * Therefore we might want to change x.txt to X.txt
4065 if (old_dir == new_dir &&
4066 old_name && new_name &&
4067 strcmp(old_name, new_name) == 0)
4071 if (strnlen(new_name, YAFFS_MAX_NAME_LENGTH + 1) >
4072 YAFFS_MAX_NAME_LENGTH)
4077 obj = yaffs_find_by_name(old_dir, old_name);
4080 old_dir = obj->parent;
4083 if (obj && obj->rename_allowed) {
4084 /* Now handle an existing target, if there is one */
4085 existing_target = yaffs_find_by_name(new_dir, new_name);
4086 if (yaffs_is_non_empty_dir(existing_target)) {
4087 return YAFFS_FAIL; /* ENOTEMPTY */
4088 } else if (existing_target && existing_target != obj) {
4089 /* Nuke the target first, using shadowing,
4090 * but only if it isn't the same object.
4092 * Note we must disable gc here otherwise it can mess
4096 dev->gc_disable = 1;
4097 yaffs_change_obj_name(obj, new_dir, new_name, force,
4098 existing_target->obj_id);
4099 existing_target->is_shadowed = 1;
4100 yaffs_unlink_obj(existing_target);
4101 dev->gc_disable = 0;
4104 result = yaffs_change_obj_name(obj, new_dir, new_name, 1, 0);
4106 yaffs_update_parent(old_dir);
4107 if (new_dir != old_dir)
4108 yaffs_update_parent(new_dir);
4115 /*----------------------- Initialisation Scanning ---------------------- */
4117 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
4118 int backward_scanning)
4120 struct yaffs_obj *obj;
4122 if (backward_scanning) {
4123 /* Handle YAFFS2 case (backward scanning)
4124 * If the shadowed object exists then ignore.
4126 obj = yaffs_find_by_number(dev, obj_id);
4131 /* Let's create it (if it does not exist) assuming it is a file so that
4132 * it can do shrinking etc.
4133 * We put it in unlinked dir to be cleaned up after the scanning
4136 yaffs_find_or_create_by_number(dev, obj_id, YAFFS_OBJECT_TYPE_FILE);
4139 obj->is_shadowed = 1;
4140 yaffs_add_obj_to_dir(dev->unlinked_dir, obj);
4141 obj->variant.file_variant.shrink_size = 0;
4142 obj->valid = 1; /* So that we don't read any other info. */
4145 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list)
4147 struct list_head *lh;
4148 struct list_head *save;
4149 struct yaffs_obj *hl;
4150 struct yaffs_obj *in;
4152 list_for_each_safe(lh, save, hard_list) {
4153 hl = list_entry(lh, struct yaffs_obj, hard_links);
4154 in = yaffs_find_by_number(dev,
4155 hl->variant.hardlink_variant.equiv_id);
4158 /* Add the hardlink pointers */
4159 hl->variant.hardlink_variant.equiv_obj = in;
4160 list_add(&hl->hard_links, &in->hard_links);
4162 /* Todo Need to report/handle this better.
4163 * Got a problem... hardlink to a non-existant object
4165 hl->variant.hardlink_variant.equiv_obj = NULL;
4166 INIT_LIST_HEAD(&hl->hard_links);
4171 static void yaffs_strip_deleted_objs(struct yaffs_dev *dev)
4174 * Sort out state of unlinked and deleted objects after scanning.
4176 struct list_head *i;
4177 struct list_head *n;
4178 struct yaffs_obj *l;
4183 /* Soft delete all the unlinked files */
4184 list_for_each_safe(i, n,
4185 &dev->unlinked_dir->variant.dir_variant.children) {
4186 l = list_entry(i, struct yaffs_obj, siblings);
4190 list_for_each_safe(i, n, &dev->del_dir->variant.dir_variant.children) {
4191 l = list_entry(i, struct yaffs_obj, siblings);
4197 * This code iterates through all the objects making sure that they are rooted.
4198 * Any unrooted objects are re-rooted in lost+found.
4199 * An object needs to be in one of:
4200 * - Directly under deleted, unlinked
4201 * - Directly or indirectly under root.
4204 * This code assumes that we don't ever change the current relationships
4205 * between directories:
4206 * root_dir->parent == unlinked_dir->parent == del_dir->parent == NULL
4207 * lost-n-found->parent == root_dir
4209 * This fixes the problem where directories might have inadvertently been
4210 * deleted leaving the object "hanging" without being rooted in the
4214 static int yaffs_has_null_parent(struct yaffs_dev *dev, struct yaffs_obj *obj)
4216 return (obj == dev->del_dir ||
4217 obj == dev->unlinked_dir || obj == dev->root_dir);
4220 static void yaffs_fix_hanging_objs(struct yaffs_dev *dev)
4222 struct yaffs_obj *obj;
4223 struct yaffs_obj *parent;
4225 struct list_head *lh;
4226 struct list_head *n;
4233 /* Iterate through the objects in each hash entry,
4234 * looking at each object.
4235 * Make sure it is rooted.
4238 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
4239 list_for_each_safe(lh, n, &dev->obj_bucket[i].list) {
4240 obj = list_entry(lh, struct yaffs_obj, hash_link);
4241 parent = obj->parent;
4243 if (yaffs_has_null_parent(dev, obj)) {
4244 /* These directories are not hanging */
4246 } else if (!parent ||
4247 parent->variant_type !=
4248 YAFFS_OBJECT_TYPE_DIRECTORY) {
4250 } else if (yaffs_has_null_parent(dev, parent)) {
4254 * Need to follow the parent chain to
4255 * see if it is hanging.
4260 while (parent != dev->root_dir &&
4262 parent->parent->variant_type ==
4263 YAFFS_OBJECT_TYPE_DIRECTORY &&
4265 parent = parent->parent;
4268 if (parent != dev->root_dir)
4272 yaffs_trace(YAFFS_TRACE_SCAN,
4273 "Hanging object %d moved to lost and found",
4275 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
4282 * Delete directory contents for cleaning up lost and found.
4284 static void yaffs_del_dir_contents(struct yaffs_obj *dir)
4286 struct yaffs_obj *obj;
4287 struct list_head *lh;
4288 struct list_head *n;
4290 if (dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
4293 list_for_each_safe(lh, n, &dir->variant.dir_variant.children) {
4294 obj = list_entry(lh, struct yaffs_obj, siblings);
4295 if (obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY)
4296 yaffs_del_dir_contents(obj);
4297 yaffs_trace(YAFFS_TRACE_SCAN,
4298 "Deleting lost_found object %d",
4300 yaffs_unlink_obj(obj);
4304 static void yaffs_empty_l_n_f(struct yaffs_dev *dev)
4306 yaffs_del_dir_contents(dev->lost_n_found);
4310 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *directory,
4314 struct list_head *i;
4315 YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
4316 struct yaffs_obj *l;
4322 yaffs_trace(YAFFS_TRACE_ALWAYS,
4323 "tragedy: yaffs_find_by_name: null pointer directory"
4328 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4329 yaffs_trace(YAFFS_TRACE_ALWAYS,
4330 "tragedy: yaffs_find_by_name: non-directory"
4335 sum = yaffs_calc_name_sum(name);
4337 list_for_each(i, &directory->variant.dir_variant.children) {
4338 l = list_entry(i, struct yaffs_obj, siblings);
4340 if (l->parent != directory)
4343 yaffs_check_obj_details_loaded(l);
4345 /* Special case for lost-n-found */
4346 if (l->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4347 if (!strcmp(name, YAFFS_LOSTNFOUND_NAME))
4349 } else if (l->sum == sum || l->hdr_chunk <= 0) {
4350 /* LostnFound chunk called Objxxx
4353 yaffs_get_obj_name(l, buffer,
4354 YAFFS_MAX_NAME_LENGTH + 1);
4355 if (!strncmp(name, buffer, YAFFS_MAX_NAME_LENGTH))
4362 /* GetEquivalentObject dereferences any hard links to get to the
4366 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj)
4368 if (obj && obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
4369 obj = obj->variant.hardlink_variant.equiv_obj;
4370 yaffs_check_obj_details_loaded(obj);
4376 * A note or two on object names.
4377 * * If the object name is missing, we then make one up in the form objnnn
4379 * * ASCII names are stored in the object header's name field from byte zero
4380 * * Unicode names are historically stored starting from byte zero.
4382 * Then there are automatic Unicode names...
4383 * The purpose of these is to save names in a way that can be read as
4384 * ASCII or Unicode names as appropriate, thus allowing a Unicode and ASCII
4385 * system to share files.
4387 * These automatic unicode are stored slightly differently...
4388 * - If the name can fit in the ASCII character space then they are saved as
4389 * ascii names as per above.
4390 * - If the name needs Unicode then the name is saved in Unicode
4391 * starting at oh->name[1].
4394 static void yaffs_fix_null_name(struct yaffs_obj *obj, YCHAR *name,
4397 /* Create an object name if we could not find one. */
4398 if (strnlen(name, YAFFS_MAX_NAME_LENGTH) == 0) {
4399 YCHAR local_name[20];
4400 YCHAR num_string[20];
4401 YCHAR *x = &num_string[19];
4402 unsigned v = obj->obj_id;
4406 *x = '0' + (v % 10);
4409 /* make up a name */
4410 strcpy(local_name, YAFFS_LOSTNFOUND_PREFIX);
4411 strcat(local_name, x);
4412 strncpy(name, local_name, buffer_size - 1);
4416 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR *name, int buffer_size)
4418 memset(name, 0, buffer_size * sizeof(YCHAR));
4419 yaffs_check_obj_details_loaded(obj);
4420 if (obj->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4421 strncpy(name, YAFFS_LOSTNFOUND_NAME, buffer_size - 1);
4422 } else if (obj->short_name[0]) {
4423 strcpy(name, obj->short_name);
4424 } else if (obj->hdr_chunk > 0) {
4426 u8 *buffer = yaffs_get_temp_buffer(obj->my_dev);
4428 struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)buffer;
4430 memset(buffer, 0, obj->my_dev->data_bytes_per_chunk);
4432 if (obj->hdr_chunk > 0) {
4433 result = yaffs_rd_chunk_tags_nand(obj->my_dev,
4437 yaffs_load_name_from_oh(obj->my_dev, name, oh->name,
4440 yaffs_release_temp_buffer(obj->my_dev, buffer);
4443 yaffs_fix_null_name(obj, name, buffer_size);
4445 return strnlen(name, YAFFS_MAX_NAME_LENGTH);
4448 loff_t yaffs_get_obj_length(struct yaffs_obj *obj)
4450 /* Dereference any hard linking */
4451 obj = yaffs_get_equivalent_obj(obj);
4453 if (obj->variant_type == YAFFS_OBJECT_TYPE_FILE)
4454 return obj->variant.file_variant.file_size;
4455 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
4456 if (!obj->variant.symlink_variant.alias)
4458 return strnlen(obj->variant.symlink_variant.alias,
4459 YAFFS_MAX_ALIAS_LENGTH);
4461 /* Only a directory should drop through to here */
4462 return obj->my_dev->data_bytes_per_chunk;
4466 int yaffs_get_obj_link_count(struct yaffs_obj *obj)
4469 struct list_head *i;
4472 count++; /* the object itself */
4474 list_for_each(i, &obj->hard_links)
4475 count++; /* add the hard links; */
4480 int yaffs_get_obj_inode(struct yaffs_obj *obj)
4482 obj = yaffs_get_equivalent_obj(obj);
4487 unsigned yaffs_get_obj_type(struct yaffs_obj *obj)
4489 obj = yaffs_get_equivalent_obj(obj);
4491 switch (obj->variant_type) {
4492 case YAFFS_OBJECT_TYPE_FILE:
4495 case YAFFS_OBJECT_TYPE_DIRECTORY:
4498 case YAFFS_OBJECT_TYPE_SYMLINK:
4501 case YAFFS_OBJECT_TYPE_HARDLINK:
4504 case YAFFS_OBJECT_TYPE_SPECIAL:
4505 if (S_ISFIFO(obj->yst_mode))
4507 if (S_ISCHR(obj->yst_mode))
4509 if (S_ISBLK(obj->yst_mode))
4511 if (S_ISSOCK(obj->yst_mode))
4521 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj)
4523 obj = yaffs_get_equivalent_obj(obj);
4524 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK)
4525 return yaffs_clone_str(obj->variant.symlink_variant.alias);
4527 return yaffs_clone_str(_Y(""));
4530 /*--------------------------- Initialisation code -------------------------- */
4532 static int yaffs_check_dev_fns(const struct yaffs_dev *dev)
4534 /* Common functions, gotta have */
4535 if (!dev->param.erase_fn || !dev->param.initialise_flash_fn)
4538 /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
4539 if (dev->param.write_chunk_tags_fn &&
4540 dev->param.read_chunk_tags_fn &&
4541 !dev->param.write_chunk_fn &&
4542 !dev->param.read_chunk_fn &&
4543 dev->param.bad_block_fn && dev->param.query_block_fn)
4546 /* Can use the "spare" style interface for yaffs1 */
4547 if (!dev->param.is_yaffs2 &&
4548 !dev->param.write_chunk_tags_fn &&
4549 !dev->param.read_chunk_tags_fn &&
4550 dev->param.write_chunk_fn &&
4551 dev->param.read_chunk_fn &&
4552 !dev->param.bad_block_fn && !dev->param.query_block_fn)
4558 static int yaffs_create_initial_dir(struct yaffs_dev *dev)
4560 /* Initialise the unlinked, deleted, root and lost+found directories */
4561 dev->lost_n_found = dev->root_dir = NULL;
4562 dev->unlinked_dir = dev->del_dir = NULL;
4564 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
4566 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
4568 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_ROOT,
4569 YAFFS_ROOT_MODE | S_IFDIR);
4571 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_LOSTNFOUND,
4572 YAFFS_LOSTNFOUND_MODE | S_IFDIR);
4574 if (dev->lost_n_found && dev->root_dir && dev->unlinked_dir
4576 yaffs_add_obj_to_dir(dev->root_dir, dev->lost_n_found);
4582 int yaffs_guts_initialise(struct yaffs_dev *dev)
4584 int init_failed = 0;
4588 yaffs_trace(YAFFS_TRACE_TRACING, "yaffs: yaffs_guts_initialise()");
4590 /* Check stuff that must be set */
4593 yaffs_trace(YAFFS_TRACE_ALWAYS,
4594 "yaffs: Need a device"
4599 if (dev->is_mounted) {
4600 yaffs_trace(YAFFS_TRACE_ALWAYS, "device already mounted");
4604 dev->internal_start_block = dev->param.start_block;
4605 dev->internal_end_block = dev->param.end_block;
4606 dev->block_offset = 0;
4607 dev->chunk_offset = 0;
4608 dev->n_free_chunks = 0;
4612 if (dev->param.start_block == 0) {
4613 dev->internal_start_block = dev->param.start_block + 1;
4614 dev->internal_end_block = dev->param.end_block + 1;
4615 dev->block_offset = 1;
4616 dev->chunk_offset = dev->param.chunks_per_block;
4619 /* Check geometry parameters. */
4621 if ((!dev->param.inband_tags && dev->param.is_yaffs2 &&
4622 dev->param.total_bytes_per_chunk < 1024) ||
4623 (!dev->param.is_yaffs2 &&
4624 dev->param.total_bytes_per_chunk < 512) ||
4625 (dev->param.inband_tags && !dev->param.is_yaffs2) ||
4626 dev->param.chunks_per_block < 2 ||
4627 dev->param.n_reserved_blocks < 2 ||
4628 dev->internal_start_block <= 0 ||
4629 dev->internal_end_block <= 0 ||
4630 dev->internal_end_block <=
4631 (dev->internal_start_block + dev->param.n_reserved_blocks + 2)
4633 /* otherwise it is too small */
4634 yaffs_trace(YAFFS_TRACE_ALWAYS,
4635 "NAND geometry problems: chunk size %d, type is yaffs%s, inband_tags %d ",
4636 dev->param.total_bytes_per_chunk,
4637 dev->param.is_yaffs2 ? "2" : "",
4638 dev->param.inband_tags);
4642 if (yaffs_init_nand(dev) != YAFFS_OK) {
4643 yaffs_trace(YAFFS_TRACE_ALWAYS, "InitialiseNAND failed");
4647 /* Sort out space for inband tags, if required */
4648 if (dev->param.inband_tags)
4649 dev->data_bytes_per_chunk =
4650 dev->param.total_bytes_per_chunk -
4651 sizeof(struct yaffs_packed_tags2_tags_only);
4653 dev->data_bytes_per_chunk = dev->param.total_bytes_per_chunk;
4655 /* Got the right mix of functions? */
4656 if (!yaffs_check_dev_fns(dev)) {
4657 /* Function missing */
4658 yaffs_trace(YAFFS_TRACE_ALWAYS,
4659 "device function(s) missing or wrong");
4664 /* Finished with most checks. Further checks happen later on too. */
4666 dev->is_mounted = 1;
4668 /* OK now calculate a few things for the device */
4671 * Calculate all the chunk size manipulation numbers:
4673 x = dev->data_bytes_per_chunk;
4674 /* We always use dev->chunk_shift and dev->chunk_div */
4675 dev->chunk_shift = calc_shifts(x);
4676 x >>= dev->chunk_shift;
4678 /* We only use chunk mask if chunk_div is 1 */
4679 dev->chunk_mask = (1 << dev->chunk_shift) - 1;
4682 * Calculate chunk_grp_bits.
4683 * We need to find the next power of 2 > than internal_end_block
4686 x = dev->param.chunks_per_block * (dev->internal_end_block + 1);
4688 bits = calc_shifts_ceiling(x);
4690 /* Set up tnode width if wide tnodes are enabled. */
4691 if (!dev->param.wide_tnodes_disabled) {
4692 /* bits must be even so that we end up with 32-bit words */
4696 dev->tnode_width = 16;
4698 dev->tnode_width = bits;
4700 dev->tnode_width = 16;
4703 dev->tnode_mask = (1 << dev->tnode_width) - 1;
4705 /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
4706 * so if the bitwidth of the
4707 * chunk range we're using is greater than 16 we need
4708 * to figure out chunk shift and chunk_grp_size
4711 if (bits <= dev->tnode_width)
4712 dev->chunk_grp_bits = 0;
4714 dev->chunk_grp_bits = bits - dev->tnode_width;
4716 dev->tnode_size = (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8;
4717 if (dev->tnode_size < sizeof(struct yaffs_tnode))
4718 dev->tnode_size = sizeof(struct yaffs_tnode);
4720 dev->chunk_grp_size = 1 << dev->chunk_grp_bits;
4722 if (dev->param.chunks_per_block < dev->chunk_grp_size) {
4723 /* We have a problem because the soft delete won't work if
4724 * the chunk group size > chunks per block.
4725 * This can be remedied by using larger "virtual blocks".
4727 yaffs_trace(YAFFS_TRACE_ALWAYS, "chunk group too large");
4732 /* Finished verifying the device, continue with initialisation */
4734 /* More device initialisation */
4736 dev->passive_gc_count = 0;
4737 dev->oldest_dirty_gc_count = 0;
4739 dev->gc_block_finder = 0;
4740 dev->buffered_block = -1;
4741 dev->doing_buffered_block_rewrite = 0;
4742 dev->n_deleted_files = 0;
4743 dev->n_bg_deletions = 0;
4744 dev->n_unlinked_files = 0;
4745 dev->n_ecc_fixed = 0;
4746 dev->n_ecc_unfixed = 0;
4747 dev->n_tags_ecc_fixed = 0;
4748 dev->n_tags_ecc_unfixed = 0;
4749 dev->n_erase_failures = 0;
4750 dev->n_erased_blocks = 0;
4751 dev->gc_disable = 0;
4752 dev->has_pending_prioritised_gc = 1;
4753 /* Assume the worst for now, will get fixed on first GC */
4754 INIT_LIST_HEAD(&dev->dirty_dirs);
4755 dev->oldest_dirty_seq = 0;
4756 dev->oldest_dirty_block = 0;
4758 /* Initialise temporary buffers and caches. */
4759 if (!yaffs_init_tmp_buffers(dev))
4763 dev->gc_cleanup_list = NULL;
4765 if (!init_failed && dev->param.n_caches > 0) {
4769 dev->param.n_caches * sizeof(struct yaffs_cache);
4771 if (dev->param.n_caches > YAFFS_MAX_SHORT_OP_CACHES)
4772 dev->param.n_caches = YAFFS_MAX_SHORT_OP_CACHES;
4774 dev->cache = kmalloc(cache_bytes, GFP_NOFS);
4776 buf = (u8 *) dev->cache;
4779 memset(dev->cache, 0, cache_bytes);
4781 for (i = 0; i < dev->param.n_caches && buf; i++) {
4782 dev->cache[i].object = NULL;
4783 dev->cache[i].last_use = 0;
4784 dev->cache[i].dirty = 0;
4785 dev->cache[i].data = buf =
4786 kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
4791 dev->cache_last_use = 0;
4794 dev->cache_hits = 0;
4797 dev->gc_cleanup_list =
4798 kmalloc(dev->param.chunks_per_block * sizeof(u32),
4800 if (!dev->gc_cleanup_list)
4804 if (dev->param.is_yaffs2)
4805 dev->param.use_header_file_size = 1;
4807 if (!init_failed && !yaffs_init_blocks(dev))
4810 yaffs_init_tnodes_and_objs(dev);
4812 if (!init_failed && !yaffs_create_initial_dir(dev))
4815 if (!init_failed && dev->param.is_yaffs2 &&
4816 !dev->param.disable_summary &&
4817 !yaffs_summary_init(dev))
4821 /* Now scan the flash. */
4822 if (dev->param.is_yaffs2) {
4823 if (yaffs2_checkpt_restore(dev)) {
4824 yaffs_check_obj_details_loaded(dev->root_dir);
4825 yaffs_trace(YAFFS_TRACE_CHECKPOINT |
4827 "yaffs: restored from checkpoint"
4831 /* Clean up the mess caused by an aborted
4832 * checkpoint load then scan backwards.
4834 yaffs_deinit_blocks(dev);
4836 yaffs_deinit_tnodes_and_objs(dev);
4838 dev->n_erased_blocks = 0;
4839 dev->n_free_chunks = 0;
4840 dev->alloc_block = -1;
4841 dev->alloc_page = -1;
4842 dev->n_deleted_files = 0;
4843 dev->n_unlinked_files = 0;
4844 dev->n_bg_deletions = 0;
4846 if (!init_failed && !yaffs_init_blocks(dev))
4849 yaffs_init_tnodes_and_objs(dev);
4852 && !yaffs_create_initial_dir(dev))
4855 if (!init_failed && !yaffs2_scan_backwards(dev))
4858 } else if (!yaffs1_scan(dev)) {
4862 yaffs_strip_deleted_objs(dev);
4863 yaffs_fix_hanging_objs(dev);
4864 if (dev->param.empty_lost_n_found)
4865 yaffs_empty_l_n_f(dev);
4869 /* Clean up the mess */
4870 yaffs_trace(YAFFS_TRACE_TRACING,
4871 "yaffs: yaffs_guts_initialise() aborted.");
4873 yaffs_deinitialise(dev);
4877 /* Zero out stats */
4878 dev->n_page_reads = 0;
4879 dev->n_page_writes = 0;
4880 dev->n_erasures = 0;
4881 dev->n_gc_copies = 0;
4882 dev->n_retried_writes = 0;
4884 dev->n_retired_blocks = 0;
4886 yaffs_verify_free_chunks(dev);
4887 yaffs_verify_blocks(dev);
4889 /* Clean up any aborted checkpoint data */
4890 if (!dev->is_checkpointed && dev->blocks_in_checkpt > 0)
4891 yaffs2_checkpt_invalidate(dev);
4893 yaffs_trace(YAFFS_TRACE_TRACING,
4894 "yaffs: yaffs_guts_initialise() done.");
4898 void yaffs_deinitialise(struct yaffs_dev *dev)
4900 if (dev->is_mounted) {
4903 yaffs_deinit_blocks(dev);
4904 yaffs_deinit_tnodes_and_objs(dev);
4905 yaffs_summary_deinit(dev);
4907 if (dev->param.n_caches > 0 && dev->cache) {
4909 for (i = 0; i < dev->param.n_caches; i++) {
4910 kfree(dev->cache[i].data);
4911 dev->cache[i].data = NULL;
4918 kfree(dev->gc_cleanup_list);
4920 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
4921 kfree(dev->temp_buffer[i].buffer);
4923 dev->is_mounted = 0;
4925 if (dev->param.deinitialise_flash_fn)
4926 dev->param.deinitialise_flash_fn(dev);
4930 int yaffs_count_free_chunks(struct yaffs_dev *dev)
4934 struct yaffs_block_info *blk;
4936 blk = dev->block_info;
4937 for (b = dev->internal_start_block; b <= dev->internal_end_block; b++) {
4938 switch (blk->block_state) {
4939 case YAFFS_BLOCK_STATE_EMPTY:
4940 case YAFFS_BLOCK_STATE_ALLOCATING:
4941 case YAFFS_BLOCK_STATE_COLLECTING:
4942 case YAFFS_BLOCK_STATE_FULL:
4944 (dev->param.chunks_per_block - blk->pages_in_use +
4945 blk->soft_del_pages);
4955 int yaffs_get_n_free_chunks(struct yaffs_dev *dev)
4957 /* This is what we report to the outside world */
4960 int blocks_for_checkpt;
4963 n_free = dev->n_free_chunks;
4964 n_free += dev->n_deleted_files;
4966 /* Now count and subtract the number of dirty chunks in the cache. */
4968 for (n_dirty_caches = 0, i = 0; i < dev->param.n_caches; i++) {
4969 if (dev->cache[i].dirty)
4973 n_free -= n_dirty_caches;
4976 ((dev->param.n_reserved_blocks + 1) * dev->param.chunks_per_block);
4978 /* Now figure checkpoint space and report that... */
4979 blocks_for_checkpt = yaffs_calc_checkpt_blocks_required(dev);
4981 n_free -= (blocks_for_checkpt * dev->param.chunks_per_block);
4990 * Marshalling functions to get loff_t file sizes into and out of
4993 void yaffs_oh_size_load(struct yaffs_obj_hdr *oh, loff_t fsize)
4995 oh->file_size_low = (fsize & 0xFFFFFFFF);
4996 oh->file_size_high = ((fsize >> 32) & 0xFFFFFFFF);
4999 loff_t yaffs_oh_to_size(struct yaffs_obj_hdr *oh)
5003 if (sizeof(loff_t) >= 8 && ~(oh->file_size_high))
5004 retval = (((loff_t) oh->file_size_high) << 32) |
5005 (((loff_t) oh->file_size_low) & 0xFFFFFFFF);
5007 retval = (loff_t) oh->file_size_low;