2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2010 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
15 #include "yaffs_trace.h"
17 #include "yaffs_guts.h"
18 #include "yaffs_tagsvalidity.h"
19 #include "yaffs_getblockinfo.h"
20 #include "yaffs_tagscompat.h"
21 #include "yaffs_nand.h"
22 #include "yaffs_yaffs1.h"
23 #include "yaffs_yaffs2.h"
24 #include "yaffs_bitmap.h"
25 #include "yaffs_verify.h"
26 #include "yaffs_nand.h"
27 #include "yaffs_packedtags2.h"
28 #include "yaffs_nameval.h"
29 #include "yaffs_allocator.h"
30 #include "yaffs_attribs.h"
32 /* Note YAFFS_GC_GOOD_ENOUGH must be <= YAFFS_GC_PASSIVE_THRESHOLD */
33 #define YAFFS_GC_GOOD_ENOUGH 2
34 #define YAFFS_GC_PASSIVE_THRESHOLD 4
36 #include "yaffs_ecc.h"
38 /* Forward declarations */
40 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
41 const u8 *buffer, int n_bytes, int use_reserve);
45 /* Function to calculate chunk and offset */
47 static 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 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 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].line = 0; /* not in use */
132 dev->temp_buffer[i].buffer = buf =
133 kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
136 return buf ? YAFFS_OK : YAFFS_FAIL;
139 u8 *yaffs_get_temp_buffer(struct yaffs_dev * dev, int line_no)
145 if (dev->temp_in_use > dev->max_temp)
146 dev->max_temp = dev->temp_in_use;
148 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
149 if (dev->temp_buffer[i].line == 0) {
150 dev->temp_buffer[i].line = line_no;
151 if ((i + 1) > dev->max_temp) {
152 dev->max_temp = i + 1;
153 for (j = 0; j <= i; j++)
154 dev->temp_buffer[j].max_line =
155 dev->temp_buffer[j].line;
158 return dev->temp_buffer[i].buffer;
162 yaffs_trace(YAFFS_TRACE_BUFFERS,
163 "Out of temp buffers at line %d, other held by lines:",
165 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
166 yaffs_trace(YAFFS_TRACE_BUFFERS,
167 " %d", dev->temp_buffer[i].line);
170 * If we got here then we have to allocate an unmanaged one
174 dev->unmanaged_buffer_allocs++;
175 return kmalloc(dev->data_bytes_per_chunk, GFP_NOFS);
179 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer, int line_no)
185 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
186 if (dev->temp_buffer[i].buffer == buffer) {
187 dev->temp_buffer[i].line = 0;
193 /* assume it is an unmanaged one. */
194 yaffs_trace(YAFFS_TRACE_BUFFERS,
195 "Releasing unmanaged temp buffer in line %d",
198 dev->unmanaged_buffer_deallocs++;
204 * Determine if we have a managed buffer.
206 int yaffs_is_managed_tmp_buffer(struct yaffs_dev *dev, const u8 *buffer)
210 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
211 if (dev->temp_buffer[i].buffer == buffer)
215 for (i = 0; i < dev->param.n_caches; i++) {
216 if (dev->cache[i].data == buffer)
220 if (buffer == dev->checkpt_buffer)
223 yaffs_trace(YAFFS_TRACE_ALWAYS,
224 "yaffs: unmaged buffer detected.");
229 * Functions for robustisizing TODO
233 static void yaffs_handle_chunk_wr_ok(struct yaffs_dev *dev, int nand_chunk,
235 const struct yaffs_ext_tags *tags)
238 nand_chunk = nand_chunk;
243 static void yaffs_handle_chunk_update(struct yaffs_dev *dev, int nand_chunk,
244 const struct yaffs_ext_tags *tags)
247 nand_chunk = nand_chunk;
251 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
252 struct yaffs_block_info *bi)
254 if (!bi->gc_prioritise) {
255 bi->gc_prioritise = 1;
256 dev->has_pending_prioritised_gc = 1;
257 bi->chunk_error_strikes++;
259 if (bi->chunk_error_strikes > 3) {
260 bi->needs_retiring = 1; /* Too many stikes, so retire */
261 yaffs_trace(YAFFS_TRACE_ALWAYS,
262 "yaffs: Block struck out");
268 static void yaffs_handle_chunk_wr_error(struct yaffs_dev *dev, int nand_chunk,
271 int flash_block = nand_chunk / dev->param.chunks_per_block;
272 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
274 yaffs_handle_chunk_error(dev, bi);
277 /* Was an actual write failure,
278 * so mark the block for retirement.*/
279 bi->needs_retiring = 1;
280 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
281 "**>> Block %d needs retiring", flash_block);
284 /* Delete the chunk */
285 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
286 yaffs_skip_rest_of_block(dev);
294 * Simple hash function. Needs to have a reasonable spread
297 static inline int yaffs_hash_fn(int n)
300 return n % YAFFS_NOBJECT_BUCKETS;
304 * Access functions to useful fake objects.
305 * Note that root might have a presence in NAND if permissions are set.
308 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev)
310 return dev->root_dir;
313 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev)
315 return dev->lost_n_found;
319 * Erased NAND checking functions
322 int yaffs_check_ff(u8 *buffer, int n_bytes)
324 /* Horrible, slow implementation */
333 static int yaffs_check_chunk_erased(struct yaffs_dev *dev, int nand_chunk)
335 int retval = YAFFS_OK;
336 u8 *data = yaffs_get_temp_buffer(dev, __LINE__);
337 struct yaffs_ext_tags tags;
340 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, data, &tags);
342 if (tags.ecc_result > YAFFS_ECC_RESULT_NO_ERROR)
345 if (!yaffs_check_ff(data, dev->data_bytes_per_chunk) ||
347 yaffs_trace(YAFFS_TRACE_NANDACCESS,
348 "Chunk %d not erased", nand_chunk);
352 yaffs_release_temp_buffer(dev, data, __LINE__);
358 static int yaffs_verify_chunk_written(struct yaffs_dev *dev,
361 struct yaffs_ext_tags *tags)
363 int retval = YAFFS_OK;
364 struct yaffs_ext_tags temp_tags;
365 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
368 result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, buffer, &temp_tags);
369 if (memcmp(buffer, data, dev->data_bytes_per_chunk) ||
370 temp_tags.obj_id != tags->obj_id ||
371 temp_tags.chunk_id != tags->chunk_id ||
372 temp_tags.n_bytes != tags->n_bytes)
375 yaffs_release_temp_buffer(dev, buffer, __LINE__);
381 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks)
384 int reserved_blocks = dev->param.n_reserved_blocks;
387 checkpt_blocks = yaffs_calc_checkpt_blocks_required(dev);
390 ((reserved_blocks + checkpt_blocks) * dev->param.chunks_per_block);
392 return (dev->n_free_chunks > (reserved_chunks + n_chunks));
395 static int yaffs_find_alloc_block(struct yaffs_dev *dev)
398 struct yaffs_block_info *bi;
400 if (dev->n_erased_blocks < 1) {
401 /* Hoosterman we've got a problem.
402 * Can't get space to gc
404 yaffs_trace(YAFFS_TRACE_ERROR,
405 "yaffs tragedy: no more erased blocks");
410 /* Find an empty block. */
412 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
413 dev->alloc_block_finder++;
414 if (dev->alloc_block_finder < dev->internal_start_block
415 || dev->alloc_block_finder > dev->internal_end_block) {
416 dev->alloc_block_finder = dev->internal_start_block;
419 bi = yaffs_get_block_info(dev, dev->alloc_block_finder);
421 if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
422 bi->block_state = YAFFS_BLOCK_STATE_ALLOCATING;
424 bi->seq_number = dev->seq_number;
425 dev->n_erased_blocks--;
426 yaffs_trace(YAFFS_TRACE_ALLOCATE,
427 "Allocated block %d, seq %d, %d left" ,
428 dev->alloc_block_finder, dev->seq_number,
429 dev->n_erased_blocks);
430 return dev->alloc_block_finder;
434 yaffs_trace(YAFFS_TRACE_ALWAYS,
435 "yaffs tragedy: no more erased blocks, but there should have been %d",
436 dev->n_erased_blocks);
441 static int yaffs_alloc_chunk(struct yaffs_dev *dev, int use_reserver,
442 struct yaffs_block_info **block_ptr)
445 struct yaffs_block_info *bi;
447 if (dev->alloc_block < 0) {
448 /* Get next block to allocate off */
449 dev->alloc_block = yaffs_find_alloc_block(dev);
453 if (!use_reserver && !yaffs_check_alloc_available(dev, 1)) {
454 /* No space unless we're allowed to use the reserve. */
458 if (dev->n_erased_blocks < dev->param.n_reserved_blocks
459 && dev->alloc_page == 0)
460 yaffs_trace(YAFFS_TRACE_ALLOCATE, "Allocating reserve");
462 /* Next page please.... */
463 if (dev->alloc_block >= 0) {
464 bi = yaffs_get_block_info(dev, dev->alloc_block);
466 ret_val = (dev->alloc_block * dev->param.chunks_per_block) +
469 yaffs_set_chunk_bit(dev, dev->alloc_block, dev->alloc_page);
473 dev->n_free_chunks--;
475 /* If the block is full set the state to full */
476 if (dev->alloc_page >= dev->param.chunks_per_block) {
477 bi->block_state = YAFFS_BLOCK_STATE_FULL;
478 dev->alloc_block = -1;
487 yaffs_trace(YAFFS_TRACE_ERROR,
488 "!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!");
493 static int yaffs_get_erased_chunks(struct yaffs_dev *dev)
497 n = dev->n_erased_blocks * dev->param.chunks_per_block;
499 if (dev->alloc_block > 0)
500 n += (dev->param.chunks_per_block - dev->alloc_page);
507 * yaffs_skip_rest_of_block() skips over the rest of the allocation block
508 * if we don't want to write to it.
510 void yaffs_skip_rest_of_block(struct yaffs_dev *dev)
512 if (dev->alloc_block > 0) {
513 struct yaffs_block_info *bi =
514 yaffs_get_block_info(dev, dev->alloc_block);
515 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING) {
516 bi->block_state = YAFFS_BLOCK_STATE_FULL;
517 dev->alloc_block = -1;
522 static int yaffs_write_new_chunk(struct yaffs_dev *dev,
524 struct yaffs_ext_tags *tags, int use_reserver)
530 yaffs2_checkpt_invalidate(dev);
533 struct yaffs_block_info *bi = 0;
536 chunk = yaffs_alloc_chunk(dev, use_reserver, &bi);
542 /* First check this chunk is erased, if it needs
543 * checking. The checking policy (unless forced
544 * always on) is as follows:
546 * Check the first page we try to write in a block.
547 * If the check passes then we don't need to check any
548 * more. If the check fails, we check again...
549 * If the block has been erased, we don't need to check.
551 * However, if the block has been prioritised for gc,
552 * then we think there might be something odd about
553 * this block and stop using it.
555 * Rationale: We should only ever see chunks that have
556 * not been erased if there was a partially written
557 * chunk due to power loss. This checking policy should
558 * catch that case with very few checks and thus save a
559 * lot of checks that are most likely not needed.
562 * If an erase check fails or the write fails we skip the
566 /* let's give it a try */
569 if (dev->param.always_check_erased)
570 bi->skip_erased_check = 0;
572 if (!bi->skip_erased_check) {
573 erased_ok = yaffs_check_chunk_erased(dev, chunk);
574 if (erased_ok != YAFFS_OK) {
575 yaffs_trace(YAFFS_TRACE_ERROR,
576 "**>> yaffs chunk %d was not erased",
579 /* If not erased, delete this one,
580 * skip rest of block and
581 * try another chunk */
582 yaffs_chunk_del(dev, chunk, 1, __LINE__);
583 yaffs_skip_rest_of_block(dev);
588 write_ok = yaffs_wr_chunk_tags_nand(dev, chunk, data, tags);
590 if (!bi->skip_erased_check)
592 yaffs_verify_chunk_written(dev, chunk, data, tags);
594 if (write_ok != YAFFS_OK) {
595 /* Clean up aborted write, skip to next block and
596 * try another chunk */
597 yaffs_handle_chunk_wr_error(dev, chunk, erased_ok);
601 bi->skip_erased_check = 1;
603 /* Copy the data into the robustification buffer */
604 yaffs_handle_chunk_wr_ok(dev, chunk, data, tags);
606 } while (write_ok != YAFFS_OK &&
607 (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
613 yaffs_trace(YAFFS_TRACE_ERROR,
614 "**>> yaffs write required %d attempts",
616 dev->n_retired_writes += (attempts - 1);
623 * Block retiring for handling a broken block.
626 static void yaffs_retire_block(struct yaffs_dev *dev, int flash_block)
628 struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
630 yaffs2_checkpt_invalidate(dev);
632 yaffs2_clear_oldest_dirty_seq(dev, bi);
634 if (yaffs_mark_bad(dev, flash_block) != YAFFS_OK) {
635 if (yaffs_erase_block(dev, flash_block) != YAFFS_OK) {
636 yaffs_trace(YAFFS_TRACE_ALWAYS,
637 "yaffs: Failed to mark bad and erase block %d",
640 struct yaffs_ext_tags tags;
642 flash_block * dev->param.chunks_per_block;
644 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
646 memset(buffer, 0xff, dev->data_bytes_per_chunk);
647 yaffs_init_tags(&tags);
648 tags.seq_number = YAFFS_SEQUENCE_BAD_BLOCK;
649 if (dev->param.write_chunk_tags_fn(dev, chunk_id -
653 yaffs_trace(YAFFS_TRACE_ALWAYS,
654 "yaffs: Failed to write bad block marker to block %d",
657 yaffs_release_temp_buffer(dev, buffer, __LINE__);
661 bi->block_state = YAFFS_BLOCK_STATE_DEAD;
662 bi->gc_prioritise = 0;
663 bi->needs_retiring = 0;
665 dev->n_retired_blocks++;
668 /*---------------- Name handling functions ------------*/
670 static u16 yaffs_calc_name_sum(const YCHAR *name)
674 const YUCHAR *bname = (const YUCHAR *)name;
677 while ((*bname) && (i < (YAFFS_MAX_NAME_LENGTH / 2))) {
679 /* 0x1f mask is case insensitive */
680 sum += ((*bname) & 0x1f) * i;
688 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR * name)
690 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
691 memset(obj->short_name, 0, sizeof(obj->short_name));
693 strnlen(name, YAFFS_SHORT_NAME_LENGTH + 1) <=
694 YAFFS_SHORT_NAME_LENGTH)
695 strcpy(obj->short_name, name);
697 obj->short_name[0] = _Y('\0');
699 obj->sum = yaffs_calc_name_sum(name);
702 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
703 const struct yaffs_obj_hdr *oh)
705 #ifdef CONFIG_YAFFS_AUTO_UNICODE
706 YCHAR tmp_name[YAFFS_MAX_NAME_LENGTH + 1];
707 memset(tmp_name, 0, sizeof(tmp_name));
708 yaffs_load_name_from_oh(obj->my_dev, tmp_name, oh->name,
709 YAFFS_MAX_NAME_LENGTH + 1);
710 yaffs_set_obj_name(obj, tmp_name);
712 yaffs_set_obj_name(obj, oh->name);
716 /*-------------------- TNODES -------------------
718 * List of spare tnodes
719 * The list is hooked together using the first pointer
723 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev)
725 struct yaffs_tnode *tn = yaffs_alloc_raw_tnode(dev);
728 memset(tn, 0, dev->tnode_size);
732 dev->checkpoint_blocks_required = 0; /* force recalculation */
737 /* FreeTnode frees up a tnode and puts it back on the free list */
738 static void yaffs_free_tnode(struct yaffs_dev *dev, struct yaffs_tnode *tn)
740 yaffs_free_raw_tnode(dev, tn);
742 dev->checkpoint_blocks_required = 0; /* force recalculation */
745 static void yaffs_deinit_tnodes_and_objs(struct yaffs_dev *dev)
747 yaffs_deinit_raw_tnodes_and_objs(dev);
752 void yaffs_load_tnode_0(struct yaffs_dev *dev, struct yaffs_tnode *tn,
753 unsigned pos, unsigned val)
755 u32 *map = (u32 *) tn;
761 pos &= YAFFS_TNODES_LEVEL0_MASK;
762 val >>= dev->chunk_grp_bits;
764 bit_in_map = pos * dev->tnode_width;
765 word_in_map = bit_in_map / 32;
766 bit_in_word = bit_in_map & (32 - 1);
768 mask = dev->tnode_mask << bit_in_word;
770 map[word_in_map] &= ~mask;
771 map[word_in_map] |= (mask & (val << bit_in_word));
773 if (dev->tnode_width > (32 - bit_in_word)) {
774 bit_in_word = (32 - bit_in_word);
777 dev->tnode_mask >> bit_in_word;
778 map[word_in_map] &= ~mask;
779 map[word_in_map] |= (mask & (val >> bit_in_word));
783 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
786 u32 *map = (u32 *) tn;
792 pos &= YAFFS_TNODES_LEVEL0_MASK;
794 bit_in_map = pos * dev->tnode_width;
795 word_in_map = bit_in_map / 32;
796 bit_in_word = bit_in_map & (32 - 1);
798 val = map[word_in_map] >> bit_in_word;
800 if (dev->tnode_width > (32 - bit_in_word)) {
801 bit_in_word = (32 - bit_in_word);
803 val |= (map[word_in_map] << bit_in_word);
806 val &= dev->tnode_mask;
807 val <<= dev->chunk_grp_bits;
812 /* ------------------- End of individual tnode manipulation -----------------*/
814 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
815 * The look up tree is represented by the top tnode and the number of top_level
816 * in the tree. 0 means only the level 0 tnode is in the tree.
819 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
820 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
821 struct yaffs_file_var *file_struct,
824 struct yaffs_tnode *tn = file_struct->top;
827 int level = file_struct->top_level;
831 /* Check sane level and chunk Id */
832 if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
835 if (chunk_id > YAFFS_MAX_CHUNK_ID)
838 /* First check we're tall enough (ie enough top_level) */
840 i = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
843 i >>= YAFFS_TNODES_INTERNAL_BITS;
847 if (required_depth > file_struct->top_level)
848 return NULL; /* Not tall enough, so we can't find it */
850 /* Traverse down to level 0 */
851 while (level > 0 && tn) {
852 tn = tn->internal[(chunk_id >>
853 (YAFFS_TNODES_LEVEL0_BITS +
855 YAFFS_TNODES_INTERNAL_BITS)) &
856 YAFFS_TNODES_INTERNAL_MASK];
863 /* add_find_tnode_0 finds the level 0 tnode if it exists,
864 * otherwise first expands the tree.
865 * This happens in two steps:
866 * 1. If the tree isn't tall enough, then make it taller.
867 * 2. Scan down the tree towards the level 0 tnode adding tnodes if required.
869 * Used when modifying the tree.
871 * If the tn argument is NULL, then a fresh tnode will be added otherwise the
872 * specified tn will be plugged into the ttree.
875 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
876 struct yaffs_file_var *file_struct,
878 struct yaffs_tnode *passed_tn)
883 struct yaffs_tnode *tn;
886 /* Check sane level and page Id */
887 if (file_struct->top_level < 0
888 || file_struct->top_level > YAFFS_TNODES_MAX_LEVEL)
891 if (chunk_id > YAFFS_MAX_CHUNK_ID)
894 /* First check we're tall enough (ie enough top_level) */
896 x = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
899 x >>= YAFFS_TNODES_INTERNAL_BITS;
903 if (required_depth > file_struct->top_level) {
904 /* Not tall enough, gotta make the tree taller */
905 for (i = file_struct->top_level; i < required_depth; i++) {
907 tn = yaffs_get_tnode(dev);
910 tn->internal[0] = file_struct->top;
911 file_struct->top = tn;
912 file_struct->top_level++;
914 yaffs_trace(YAFFS_TRACE_ERROR,
915 "yaffs: no more tnodes");
921 /* Traverse down to level 0, adding anything we need */
923 l = file_struct->top_level;
924 tn = file_struct->top;
927 while (l > 0 && tn) {
929 (YAFFS_TNODES_LEVEL0_BITS +
930 (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
931 YAFFS_TNODES_INTERNAL_MASK;
933 if ((l > 1) && !tn->internal[x]) {
934 /* Add missing non-level-zero tnode */
935 tn->internal[x] = yaffs_get_tnode(dev);
936 if (!tn->internal[x])
939 /* Looking from level 1 at level 0 */
941 /* If we already have one, release it */
943 yaffs_free_tnode(dev,
945 tn->internal[x] = passed_tn;
947 } else if (!tn->internal[x]) {
948 /* Don't have one, none passed in */
949 tn->internal[x] = yaffs_get_tnode(dev);
950 if (!tn->internal[x])
955 tn = tn->internal[x];
961 memcpy(tn, passed_tn,
962 (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8);
963 yaffs_free_tnode(dev, passed_tn);
970 static int yaffs_tags_match(const struct yaffs_ext_tags *tags, int obj_id,
973 return (tags->chunk_id == chunk_obj &&
974 tags->obj_id == obj_id && !tags->is_deleted) ? 1 : 0;
978 static int yaffs_find_chunk_in_group(struct yaffs_dev *dev, int the_chunk,
979 struct yaffs_ext_tags *tags, int obj_id,
984 for (j = 0; the_chunk && j < dev->chunk_grp_size; j++) {
985 if (yaffs_check_chunk_bit
986 (dev, the_chunk / dev->param.chunks_per_block,
987 the_chunk % dev->param.chunks_per_block)) {
989 if (dev->chunk_grp_size == 1)
992 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
994 if (yaffs_tags_match(tags,
995 obj_id, inode_chunk)) {
1006 static int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1007 struct yaffs_ext_tags *tags)
1009 /*Get the Tnode, then get the level 0 offset chunk offset */
1010 struct yaffs_tnode *tn;
1012 struct yaffs_ext_tags local_tags;
1014 struct yaffs_dev *dev = in->my_dev;
1017 /* Passed a NULL, so use our own tags space */
1021 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1024 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1027 yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1033 static int yaffs_find_del_file_chunk(struct yaffs_obj *in, int inode_chunk,
1034 struct yaffs_ext_tags *tags)
1036 /* Get the Tnode, then get the level 0 offset chunk offset */
1037 struct yaffs_tnode *tn;
1039 struct yaffs_ext_tags local_tags;
1040 struct yaffs_dev *dev = in->my_dev;
1044 /* Passed a NULL, so use our own tags space */
1048 tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1052 the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1055 yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1058 /* Delete the entry in the filestructure (if found) */
1060 yaffs_load_tnode_0(dev, tn, inode_chunk, 0);
1066 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1067 int nand_chunk, int in_scan)
1069 /* NB in_scan is zero unless scanning.
1070 * For forward scanning, in_scan is > 0;
1071 * for backward scanning in_scan is < 0
1073 * nand_chunk = 0 is a dummy insert to make sure the tnodes are there.
1076 struct yaffs_tnode *tn;
1077 struct yaffs_dev *dev = in->my_dev;
1079 struct yaffs_ext_tags existing_tags;
1080 struct yaffs_ext_tags new_tags;
1081 unsigned existing_serial, new_serial;
1083 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE) {
1084 /* Just ignore an attempt at putting a chunk into a non-file
1086 * If it is not during Scanning then something went wrong!
1089 yaffs_trace(YAFFS_TRACE_ERROR,
1090 "yaffs tragedy:attempt to put data chunk into a non-file"
1095 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1099 tn = yaffs_add_find_tnode_0(dev,
1100 &in->variant.file_variant,
1106 /* Dummy insert, bail now */
1109 existing_cunk = yaffs_get_group_base(dev, tn, inode_chunk);
1112 /* If we're scanning then we need to test for duplicates
1113 * NB This does not need to be efficient since it should only
1114 * happen when the power fails during a write, then only one
1115 * chunk should ever be affected.
1117 * Correction for YAFFS2: This could happen quite a lot and we
1118 * need to think about efficiency! TODO
1119 * Update: For backward scanning we don't need to re-read tags
1120 * so this is quite cheap.
1123 if (existing_cunk > 0) {
1124 /* NB Right now existing chunk will not be real
1125 * chunk_id if the chunk group size > 1
1126 * thus we have to do a FindChunkInFile to get the
1129 * We have a duplicate now we need to decide which
1132 * Backwards scanning YAFFS2: The old one is what
1133 * we use, dump the new one.
1134 * YAFFS1: Get both sets of tags and compare serial
1139 /* Only do this for forward scanning */
1140 yaffs_rd_chunk_tags_nand(dev,
1144 /* Do a proper find */
1146 yaffs_find_chunk_in_file(in, inode_chunk,
1150 if (existing_cunk <= 0) {
1151 /*Hoosterman - how did this happen? */
1153 yaffs_trace(YAFFS_TRACE_ERROR,
1154 "yaffs tragedy: existing chunk < 0 in scan"
1159 /* NB The deleted flags should be false, otherwise
1160 * the chunks will not be loaded during a scan
1164 new_serial = new_tags.serial_number;
1165 existing_serial = existing_tags.serial_number;
1168 if ((in_scan > 0) &&
1169 (existing_cunk <= 0 ||
1170 ((existing_serial + 1) & 3) == new_serial)) {
1171 /* Forward scanning.
1173 * Delete the old one and drop through to
1176 yaffs_chunk_del(dev, existing_cunk, 1,
1179 /* Backward scanning or we want to use the
1181 * Delete the new one and return early so that
1182 * the tnode isn't changed
1184 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1191 if (existing_cunk == 0)
1192 in->n_data_chunks++;
1194 yaffs_load_tnode_0(dev, tn, inode_chunk, nand_chunk);
1199 static void yaffs_soft_del_chunk(struct yaffs_dev *dev, int chunk)
1201 struct yaffs_block_info *the_block;
1204 yaffs_trace(YAFFS_TRACE_DELETION, "soft delete chunk %d", chunk);
1206 block_no = chunk / dev->param.chunks_per_block;
1207 the_block = yaffs_get_block_info(dev, block_no);
1209 the_block->soft_del_pages++;
1210 dev->n_free_chunks++;
1211 yaffs2_update_oldest_dirty_seq(dev, block_no, the_block);
1215 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all
1216 * the chunks in the file.
1217 * All soft deleting does is increment the block's softdelete count and pulls
1218 * the chunk out of the tnode.
1219 * Thus, essentially this is the same as DeleteWorker except that the chunks
1223 static int yaffs_soft_del_worker(struct yaffs_obj *in, struct yaffs_tnode *tn,
1224 u32 level, int chunk_offset)
1229 struct yaffs_dev *dev = in->my_dev;
1233 for (i = YAFFS_NTNODES_INTERNAL - 1;
1236 if (tn->internal[i]) {
1238 yaffs_soft_del_worker(in,
1242 YAFFS_TNODES_INTERNAL_BITS)
1245 yaffs_free_tnode(dev,
1247 tn->internal[i] = NULL;
1249 /* Can this happen? */
1253 return (all_done) ? 1 : 0;
1254 } else if (level == 0) {
1255 for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1256 the_chunk = yaffs_get_group_base(dev, tn, i);
1258 yaffs_soft_del_chunk(dev, the_chunk);
1259 yaffs_load_tnode_0(dev, tn, i, 0);
1268 static void yaffs_remove_obj_from_dir(struct yaffs_obj *obj)
1270 struct yaffs_dev *dev = obj->my_dev;
1271 struct yaffs_obj *parent;
1273 yaffs_verify_obj_in_dir(obj);
1274 parent = obj->parent;
1276 yaffs_verify_dir(parent);
1278 if (dev && dev->param.remove_obj_fn)
1279 dev->param.remove_obj_fn(obj);
1281 list_del_init(&obj->siblings);
1284 yaffs_verify_dir(parent);
1287 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj)
1290 yaffs_trace(YAFFS_TRACE_ALWAYS,
1291 "tragedy: Trying to add an object to a null pointer directory"
1296 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1297 yaffs_trace(YAFFS_TRACE_ALWAYS,
1298 "tragedy: Trying to add an object to a non-directory"
1303 if (obj->siblings.prev == NULL) {
1304 /* Not initialised */
1308 yaffs_verify_dir(directory);
1310 yaffs_remove_obj_from_dir(obj);
1313 list_add(&obj->siblings, &directory->variant.dir_variant.children);
1314 obj->parent = directory;
1316 if (directory == obj->my_dev->unlinked_dir
1317 || directory == obj->my_dev->del_dir) {
1319 obj->my_dev->n_unlinked_files++;
1320 obj->rename_allowed = 0;
1323 yaffs_verify_dir(directory);
1324 yaffs_verify_obj_in_dir(obj);
1327 static int yaffs_change_obj_name(struct yaffs_obj *obj,
1328 struct yaffs_obj *new_dir,
1329 const YCHAR *new_name, int force, int shadows)
1333 struct yaffs_obj *existing_target;
1335 if (new_dir == NULL)
1336 new_dir = obj->parent; /* use the old directory */
1338 if (new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1339 yaffs_trace(YAFFS_TRACE_ALWAYS,
1340 "tragedy: yaffs_change_obj_name: new_dir is not a directory"
1345 /* TODO: Do we need this different handling for YAFFS2 and YAFFS1?? */
1346 if (obj->my_dev->param.is_yaffs2)
1347 unlink_op = (new_dir == obj->my_dev->unlinked_dir);
1349 unlink_op = (new_dir == obj->my_dev->unlinked_dir
1350 && obj->variant_type == YAFFS_OBJECT_TYPE_FILE);
1352 del_op = (new_dir == obj->my_dev->del_dir);
1354 existing_target = yaffs_find_by_name(new_dir, new_name);
1356 /* If the object is a file going into the unlinked directory,
1357 * then it is OK to just stuff it in since duplicate names are OK.
1358 * else only proceed if the new name does not exist and we're putting
1359 * it into a directory.
1365 !existing_target) &&
1366 new_dir->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) {
1367 yaffs_set_obj_name(obj, new_name);
1370 yaffs_add_obj_to_dir(new_dir, obj);
1375 /* If it is a deletion then we mark it as a shrink for gc */
1376 if (yaffs_update_oh(obj, new_name, 0, del_op, shadows, NULL) >=
1383 /*------------------------ Short Operations Cache ------------------------------
1384 * In many situations where there is no high level buffering a lot of
1385 * reads might be short sequential reads, and a lot of writes may be short
1386 * sequential writes. eg. scanning/writing a jpeg file.
1387 * In these cases, a short read/write cache can provide a huge perfomance
1388 * benefit with dumb-as-a-rock code.
1389 * In Linux, the page cache provides read buffering and the short op cache
1390 * provides write buffering.
1392 * There are a small number (~10) of cache chunks per device so that we don't
1393 * need a very intelligent search.
1396 static int yaffs_obj_cache_dirty(struct yaffs_obj *obj)
1398 struct yaffs_dev *dev = obj->my_dev;
1400 struct yaffs_cache *cache;
1401 int n_caches = obj->my_dev->param.n_caches;
1403 for (i = 0; i < n_caches; i++) {
1404 cache = &dev->cache[i];
1405 if (cache->object == obj && cache->dirty)
1412 static void yaffs_flush_file_cache(struct yaffs_obj *obj)
1414 struct yaffs_dev *dev = obj->my_dev;
1415 int lowest = -99; /* Stop compiler whining. */
1417 struct yaffs_cache *cache;
1418 int chunk_written = 0;
1419 int n_caches = obj->my_dev->param.n_caches;
1425 /* Find the lowest dirty chunk for this object */
1426 for (i = 0; i < n_caches; i++) {
1427 if (dev->cache[i].object == obj &&
1428 dev->cache[i].dirty) {
1430 || dev->cache[i].chunk_id <
1432 cache = &dev->cache[i];
1433 lowest = cache->chunk_id;
1438 if (cache && !cache->locked) {
1439 /* Write it out and free it up */
1441 yaffs_wr_data_obj(cache->object,
1446 cache->object = NULL;
1448 } while (cache && chunk_written > 0);
1451 /* Hoosterman, disk full while writing cache out. */
1452 yaffs_trace(YAFFS_TRACE_ERROR,
1453 "yaffs tragedy: no space during cache write");
1457 /*yaffs_flush_whole_cache(dev)
1462 void yaffs_flush_whole_cache(struct yaffs_dev *dev)
1464 struct yaffs_obj *obj;
1465 int n_caches = dev->param.n_caches;
1468 /* Find a dirty object in the cache and flush it...
1469 * until there are no further dirty objects.
1473 for (i = 0; i < n_caches && !obj; i++) {
1474 if (dev->cache[i].object && dev->cache[i].dirty)
1475 obj = dev->cache[i].object;
1478 yaffs_flush_file_cache(obj);
1483 /* Grab us a cache chunk for use.
1484 * First look for an empty one.
1485 * Then look for the least recently used non-dirty one.
1486 * Then look for the least recently used dirty one...., flush and look again.
1488 static struct yaffs_cache *yaffs_grab_chunk_worker(struct yaffs_dev *dev)
1492 if (dev->param.n_caches > 0) {
1493 for (i = 0; i < dev->param.n_caches; i++) {
1494 if (!dev->cache[i].object)
1495 return &dev->cache[i];
1501 static struct yaffs_cache *yaffs_grab_chunk_cache(struct yaffs_dev *dev)
1503 struct yaffs_cache *cache;
1504 struct yaffs_obj *the_obj;
1509 if (dev->param.n_caches > 0) {
1510 /* Try find a non-dirty one... */
1512 cache = yaffs_grab_chunk_worker(dev);
1515 /* They were all dirty, find the LRU object and flush
1516 * its cache, then find again.
1517 * NB what's here is not very accurate,
1518 * we actually flush the object with the LRU chunk.
1521 /* With locking we can't assume we can use entry zero,
1522 * Set the_obj to a valid pointer for Coverity. */
1524 the_obj = dev->cache[0].object;
1529 for (i = 0; i < dev->param.n_caches; i++) {
1530 if (dev->cache[i].object &&
1531 !dev->cache[i].locked &&
1532 (dev->cache[i].last_use < usage
1534 usage = dev->cache[i].last_use;
1535 the_obj = dev->cache[i].object;
1536 cache = &dev->cache[i];
1541 if (!cache || cache->dirty) {
1542 /* Flush and try again */
1543 yaffs_flush_file_cache(the_obj);
1544 cache = yaffs_grab_chunk_worker(dev);
1553 /* Find a cached chunk */
1554 static struct yaffs_cache *yaffs_find_chunk_cache(const struct yaffs_obj *obj,
1557 struct yaffs_dev *dev = obj->my_dev;
1560 if (dev->param.n_caches > 0) {
1561 for (i = 0; i < dev->param.n_caches; i++) {
1562 if (dev->cache[i].object == obj &&
1563 dev->cache[i].chunk_id == chunk_id) {
1566 return &dev->cache[i];
1573 /* Mark the chunk for the least recently used algorithym */
1574 static void yaffs_use_cache(struct yaffs_dev *dev, struct yaffs_cache *cache,
1577 if (dev->param.n_caches > 0) {
1578 if (dev->cache_last_use < 0 ||
1579 dev->cache_last_use > 100000000) {
1580 /* Reset the cache usages */
1582 for (i = 1; i < dev->param.n_caches; i++)
1583 dev->cache[i].last_use = 0;
1585 dev->cache_last_use = 0;
1587 dev->cache_last_use++;
1588 cache->last_use = dev->cache_last_use;
1595 /* Invalidate a single cache page.
1596 * Do this when a whole page gets written,
1597 * ie the short cache for this page is no longer valid.
1599 static void yaffs_invalidate_chunk_cache(struct yaffs_obj *object, int chunk_id)
1601 if (object->my_dev->param.n_caches > 0) {
1602 struct yaffs_cache *cache =
1603 yaffs_find_chunk_cache(object, chunk_id);
1606 cache->object = NULL;
1610 /* Invalidate all the cache pages associated with this object
1611 * Do this whenever ther file is deleted or resized.
1613 static void yaffs_invalidate_whole_cache(struct yaffs_obj *in)
1616 struct yaffs_dev *dev = in->my_dev;
1618 if (dev->param.n_caches > 0) {
1619 /* Invalidate it. */
1620 for (i = 0; i < dev->param.n_caches; i++) {
1621 if (dev->cache[i].object == in)
1622 dev->cache[i].object = NULL;
1627 static void yaffs_unhash_obj(struct yaffs_obj *obj)
1630 struct yaffs_dev *dev = obj->my_dev;
1632 /* If it is still linked into the bucket list, free from the list */
1633 if (!list_empty(&obj->hash_link)) {
1634 list_del_init(&obj->hash_link);
1635 bucket = yaffs_hash_fn(obj->obj_id);
1636 dev->obj_bucket[bucket].count--;
1640 /* FreeObject frees up a Object and puts it back on the free list */
1641 static void yaffs_free_obj(struct yaffs_obj *obj)
1643 struct yaffs_dev *dev;
1650 yaffs_trace(YAFFS_TRACE_OS, "FreeObject %p inode %p",
1651 obj, obj->my_inode);
1654 if (!list_empty(&obj->siblings))
1657 if (obj->my_inode) {
1658 /* We're still hooked up to a cached inode.
1659 * Don't delete now, but mark for later deletion
1661 obj->defered_free = 1;
1665 yaffs_unhash_obj(obj);
1667 yaffs_free_raw_obj(dev, obj);
1669 dev->checkpoint_blocks_required = 0; /* force recalculation */
1672 void yaffs_handle_defered_free(struct yaffs_obj *obj)
1674 if (obj->defered_free)
1675 yaffs_free_obj(obj);
1678 static int yaffs_generic_obj_del(struct yaffs_obj *in)
1680 /* Iinvalidate the file's data in the cache, without flushing. */
1681 yaffs_invalidate_whole_cache(in);
1683 if (in->my_dev->param.is_yaffs2 && in->parent != in->my_dev->del_dir) {
1684 /* Move to unlinked directory so we have a deletion record */
1685 yaffs_change_obj_name(in, in->my_dev->del_dir, _Y("deleted"), 0,
1689 yaffs_remove_obj_from_dir(in);
1690 yaffs_chunk_del(in->my_dev, in->hdr_chunk, 1, __LINE__);
1698 static void yaffs_soft_del_file(struct yaffs_obj *obj)
1701 obj->variant_type == YAFFS_OBJECT_TYPE_FILE && !obj->soft_del) {
1702 if (obj->n_data_chunks <= 0) {
1703 /* Empty file with no duplicate object headers,
1704 * just delete it immediately */
1705 yaffs_free_tnode(obj->my_dev,
1706 obj->variant.file_variant.top);
1707 obj->variant.file_variant.top = NULL;
1708 yaffs_trace(YAFFS_TRACE_TRACING,
1709 "yaffs: Deleting empty file %d",
1711 yaffs_generic_obj_del(obj);
1713 yaffs_soft_del_worker(obj,
1714 obj->variant.file_variant.top,
1716 file_variant.top_level, 0);
1722 /* Pruning removes any part of the file structure tree that is beyond the
1723 * bounds of the file (ie that does not point to chunks).
1725 * A file should only get pruned when its size is reduced.
1727 * Before pruning, the chunks must be pulled from the tree and the
1728 * level 0 tnode entries must be zeroed out.
1729 * Could also use this for file deletion, but that's probably better handled
1730 * by a special case.
1732 * This function is recursive. For levels > 0 the function is called again on
1733 * any sub-tree. For level == 0 we just check if the sub-tree has data.
1734 * If there is no data in a subtree then it is pruned.
1737 static struct yaffs_tnode *yaffs_prune_worker(struct yaffs_dev *dev,
1738 struct yaffs_tnode *tn, u32 level,
1748 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1749 if (tn->internal[i]) {
1751 yaffs_prune_worker(dev,
1754 (i == 0) ? del0 : 1);
1757 if (tn->internal[i])
1761 int tnode_size_u32 = dev->tnode_size / sizeof(u32);
1762 u32 *map = (u32 *) tn;
1764 for (i = 0; !has_data && i < tnode_size_u32; i++) {
1770 if (has_data == 0 && del0) {
1771 /* Free and return NULL */
1773 yaffs_free_tnode(dev, tn);
1780 static int yaffs_prune_tree(struct yaffs_dev *dev,
1781 struct yaffs_file_var *file_struct)
1786 struct yaffs_tnode *tn;
1788 if (file_struct->top_level > 0) {
1790 yaffs_prune_worker(dev, file_struct->top,
1791 file_struct->top_level, 0);
1793 /* Now we have a tree with all the non-zero branches NULL but
1794 * the height is the same as it was.
1795 * Let's see if we can trim internal tnodes to shorten the tree.
1796 * We can do this if only the 0th element in the tnode is in use
1797 * (ie all the non-zero are NULL)
1800 while (file_struct->top_level && !done) {
1801 tn = file_struct->top;
1804 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1805 if (tn->internal[i])
1810 file_struct->top = tn->internal[0];
1811 file_struct->top_level--;
1812 yaffs_free_tnode(dev, tn);
1821 /*-------------------- End of File Structure functions.-------------------*/
1823 /* alloc_empty_obj gets us a clean Object.*/
1824 static struct yaffs_obj *yaffs_alloc_empty_obj(struct yaffs_dev *dev)
1826 struct yaffs_obj *obj = yaffs_alloc_raw_obj(dev);
1831 /* Now sweeten it up... */
1833 memset(obj, 0, sizeof(struct yaffs_obj));
1834 obj->being_created = 1;
1838 obj->variant_type = YAFFS_OBJECT_TYPE_UNKNOWN;
1839 INIT_LIST_HEAD(&(obj->hard_links));
1840 INIT_LIST_HEAD(&(obj->hash_link));
1841 INIT_LIST_HEAD(&obj->siblings);
1843 /* Now make the directory sane */
1844 if (dev->root_dir) {
1845 obj->parent = dev->root_dir;
1846 list_add(&(obj->siblings),
1847 &dev->root_dir->variant.dir_variant.children);
1850 /* Add it to the lost and found directory.
1851 * NB Can't put root or lost-n-found in lost-n-found so
1852 * check if lost-n-found exists first
1854 if (dev->lost_n_found)
1855 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
1857 obj->being_created = 0;
1860 dev->checkpoint_blocks_required = 0; /* force recalculation */
1865 static int yaffs_find_nice_bucket(struct yaffs_dev *dev)
1869 int lowest = 999999;
1871 /* Search for the shortest list or one that
1875 for (i = 0; i < 10 && lowest > 4; i++) {
1876 dev->bucket_finder++;
1877 dev->bucket_finder %= YAFFS_NOBJECT_BUCKETS;
1878 if (dev->obj_bucket[dev->bucket_finder].count < lowest) {
1879 lowest = dev->obj_bucket[dev->bucket_finder].count;
1880 l = dev->bucket_finder;
1887 static int yaffs_new_obj_id(struct yaffs_dev *dev)
1889 int bucket = yaffs_find_nice_bucket(dev);
1891 struct list_head *i;
1892 u32 n = (u32) bucket;
1894 /* Now find an object value that has not already been taken
1895 * by scanning the list.
1900 n += YAFFS_NOBJECT_BUCKETS;
1901 if (1 || dev->obj_bucket[bucket].count > 0) {
1902 list_for_each(i, &dev->obj_bucket[bucket].list) {
1903 /* If there is already one in the list */
1904 if (i && list_entry(i, struct yaffs_obj,
1905 hash_link)->obj_id == n) {
1914 static void yaffs_hash_obj(struct yaffs_obj *in)
1916 int bucket = yaffs_hash_fn(in->obj_id);
1917 struct yaffs_dev *dev = in->my_dev;
1919 list_add(&in->hash_link, &dev->obj_bucket[bucket].list);
1920 dev->obj_bucket[bucket].count++;
1923 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number)
1925 int bucket = yaffs_hash_fn(number);
1926 struct list_head *i;
1927 struct yaffs_obj *in;
1929 list_for_each(i, &dev->obj_bucket[bucket].list) {
1930 /* Look if it is in the list */
1931 in = list_entry(i, struct yaffs_obj, hash_link);
1932 if (in->obj_id == number) {
1933 /* Don't show if it is defered free */
1934 if (in->defered_free)
1943 struct yaffs_obj *yaffs_new_obj(struct yaffs_dev *dev, int number,
1944 enum yaffs_obj_type type)
1946 struct yaffs_obj *the_obj = NULL;
1947 struct yaffs_tnode *tn = NULL;
1950 number = yaffs_new_obj_id(dev);
1952 if (type == YAFFS_OBJECT_TYPE_FILE) {
1953 tn = yaffs_get_tnode(dev);
1958 the_obj = yaffs_alloc_empty_obj(dev);
1961 yaffs_free_tnode(dev, tn);
1967 the_obj->rename_allowed = 1;
1968 the_obj->unlink_allowed = 1;
1969 the_obj->obj_id = number;
1970 yaffs_hash_obj(the_obj);
1971 the_obj->variant_type = type;
1972 yaffs_load_current_time(the_obj, 1, 1);
1975 case YAFFS_OBJECT_TYPE_FILE:
1976 the_obj->variant.file_variant.file_size = 0;
1977 the_obj->variant.file_variant.scanned_size = 0;
1978 the_obj->variant.file_variant.shrink_size = ~0;
1980 the_obj->variant.file_variant.top_level = 0;
1981 the_obj->variant.file_variant.top = tn;
1983 case YAFFS_OBJECT_TYPE_DIRECTORY:
1984 INIT_LIST_HEAD(&the_obj->variant.dir_variant.children);
1985 INIT_LIST_HEAD(&the_obj->variant.dir_variant.dirty);
1987 case YAFFS_OBJECT_TYPE_SYMLINK:
1988 case YAFFS_OBJECT_TYPE_HARDLINK:
1989 case YAFFS_OBJECT_TYPE_SPECIAL:
1990 /* No action required */
1992 case YAFFS_OBJECT_TYPE_UNKNOWN:
1993 /* todo this should not happen */
2001 static struct yaffs_obj *yaffs_create_fake_dir(struct yaffs_dev *dev,
2002 int number, u32 mode)
2005 struct yaffs_obj *obj =
2006 yaffs_new_obj(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
2009 obj->fake = 1; /* it is fake so it might not use NAND */
2010 obj->rename_allowed = 0;
2011 obj->unlink_allowed = 0;
2014 obj->yst_mode = mode;
2016 obj->hdr_chunk = 0; /* Not a valid chunk. */
2023 static void yaffs_init_tnodes_and_objs(struct yaffs_dev *dev)
2029 yaffs_init_raw_tnodes_and_objs(dev);
2031 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2032 INIT_LIST_HEAD(&dev->obj_bucket[i].list);
2033 dev->obj_bucket[i].count = 0;
2037 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
2039 enum yaffs_obj_type type)
2041 struct yaffs_obj *the_obj = NULL;
2044 the_obj = yaffs_find_by_number(dev, number);
2047 the_obj = yaffs_new_obj(dev, number, type);
2053 YCHAR *yaffs_clone_str(const YCHAR *str)
2055 YCHAR *new_str = NULL;
2061 len = strnlen(str, YAFFS_MAX_ALIAS_LENGTH);
2062 new_str = kmalloc((len + 1) * sizeof(YCHAR), GFP_NOFS);
2064 strncpy(new_str, str, len);
2071 *yaffs_update_parent() handles fixing a directories mtime and ctime when a new
2072 * link (ie. name) is created or deleted in the directory.
2075 * create dir/a : update dir's mtime/ctime
2076 * rm dir/a: update dir's mtime/ctime
2077 * modify dir/a: don't update dir's mtimme/ctime
2079 * This can be handled immediately or defered. Defering helps reduce the number
2080 * of updates when many files in a directory are changed within a brief period.
2082 * If the directory updating is defered then yaffs_update_dirty_dirs must be
2083 * called periodically.
2086 static void yaffs_update_parent(struct yaffs_obj *obj)
2088 struct yaffs_dev *dev;
2094 yaffs_load_current_time(obj, 0, 1);
2095 if (dev->param.defered_dir_update) {
2096 struct list_head *link = &obj->variant.dir_variant.dirty;
2098 if (list_empty(link)) {
2099 list_add(link, &dev->dirty_dirs);
2100 yaffs_trace(YAFFS_TRACE_BACKGROUND,
2101 "Added object %d to dirty directories",
2106 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2110 void yaffs_update_dirty_dirs(struct yaffs_dev *dev)
2112 struct list_head *link;
2113 struct yaffs_obj *obj;
2114 struct yaffs_dir_var *d_s;
2115 union yaffs_obj_var *o_v;
2117 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update dirty directories");
2119 while (!list_empty(&dev->dirty_dirs)) {
2120 link = dev->dirty_dirs.next;
2121 list_del_init(link);
2123 d_s = list_entry(link, struct yaffs_dir_var, dirty);
2124 o_v = list_entry(d_s, union yaffs_obj_var, dir_variant);
2125 obj = list_entry(o_v, struct yaffs_obj, variant);
2127 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update directory %d",
2131 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2136 * Mknod (create) a new object.
2137 * equiv_obj only has meaning for a hard link;
2138 * alias_str only has meaning for a symlink.
2139 * rdev only has meaning for devices (a subset of special objects)
2142 static struct yaffs_obj *yaffs_create_obj(enum yaffs_obj_type type,
2143 struct yaffs_obj *parent,
2148 struct yaffs_obj *equiv_obj,
2149 const YCHAR *alias_str, u32 rdev)
2151 struct yaffs_obj *in;
2153 struct yaffs_dev *dev = parent->my_dev;
2155 /* Check if the entry exists.
2156 * If it does then fail the call since we don't want a dup. */
2157 if (yaffs_find_by_name(parent, name))
2160 if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2161 str = yaffs_clone_str(alias_str);
2166 in = yaffs_new_obj(dev, -1, type);
2176 in->variant_type = type;
2178 in->yst_mode = mode;
2180 yaffs_attribs_init(in, gid, uid, rdev);
2182 in->n_data_chunks = 0;
2184 yaffs_set_obj_name(in, name);
2187 yaffs_add_obj_to_dir(parent, in);
2189 in->my_dev = parent->my_dev;
2192 case YAFFS_OBJECT_TYPE_SYMLINK:
2193 in->variant.symlink_variant.alias = str;
2195 case YAFFS_OBJECT_TYPE_HARDLINK:
2196 in->variant.hardlink_variant.equiv_obj = equiv_obj;
2197 in->variant.hardlink_variant.equiv_id =
2199 list_add(&in->hard_links, &equiv_obj->hard_links);
2201 case YAFFS_OBJECT_TYPE_FILE:
2202 case YAFFS_OBJECT_TYPE_DIRECTORY:
2203 case YAFFS_OBJECT_TYPE_SPECIAL:
2204 case YAFFS_OBJECT_TYPE_UNKNOWN:
2209 if (yaffs_update_oh(in, name, 0, 0, 0, NULL) < 0) {
2210 /* Could not create the object header, fail */
2215 yaffs_update_parent(parent);
2221 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
2222 const YCHAR *name, u32 mode, u32 uid,
2225 return yaffs_create_obj(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2226 uid, gid, NULL, NULL, 0);
2229 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
2230 u32 mode, u32 uid, u32 gid)
2232 return yaffs_create_obj(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2233 mode, uid, gid, NULL, NULL, 0);
2236 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
2237 const YCHAR *name, u32 mode, u32 uid,
2240 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2241 uid, gid, NULL, NULL, rdev);
2244 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
2245 const YCHAR *name, u32 mode, u32 uid,
2246 u32 gid, const YCHAR *alias)
2248 return yaffs_create_obj(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2249 uid, gid, NULL, alias, 0);
2252 /* yaffs_link_obj returns the object id of the equivalent object.*/
2253 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR * name,
2254 struct yaffs_obj *equiv_obj)
2256 /* Get the real object in case we were fed a hard link obj */
2257 equiv_obj = yaffs_get_equivalent_obj(equiv_obj);
2259 if (yaffs_create_obj
2260 (YAFFS_OBJECT_TYPE_HARDLINK, parent, name, 0, 0, 0,
2261 equiv_obj, NULL, 0))
2270 /*---------------------- Block Management and Page Allocation -------------*/
2272 static int yaffs_init_blocks(struct yaffs_dev *dev)
2274 int n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
2276 dev->block_info = NULL;
2277 dev->chunk_bits = NULL;
2278 dev->alloc_block = -1; /* force it to get a new one */
2280 /* If the first allocation strategy fails, thry the alternate one */
2282 kmalloc(n_blocks * sizeof(struct yaffs_block_info), GFP_NOFS);
2283 if (!dev->block_info) {
2285 vmalloc(n_blocks * sizeof(struct yaffs_block_info));
2286 dev->block_info_alt = 1;
2288 dev->block_info_alt = 0;
2291 if (dev->block_info) {
2292 /* Set up dynamic blockinfo stuff. Round up bytes. */
2293 dev->chunk_bit_stride = (dev->param.chunks_per_block + 7) / 8;
2295 kmalloc(dev->chunk_bit_stride * n_blocks, GFP_NOFS);
2296 if (!dev->chunk_bits) {
2298 vmalloc(dev->chunk_bit_stride * n_blocks);
2299 dev->chunk_bits_alt = 1;
2301 dev->chunk_bits_alt = 0;
2305 if (dev->block_info && dev->chunk_bits) {
2306 memset(dev->block_info, 0,
2307 n_blocks * sizeof(struct yaffs_block_info));
2308 memset(dev->chunk_bits, 0, dev->chunk_bit_stride * n_blocks);
2315 static void yaffs_deinit_blocks(struct yaffs_dev *dev)
2317 if (dev->block_info_alt && dev->block_info)
2318 vfree(dev->block_info);
2320 kfree(dev->block_info);
2322 dev->block_info_alt = 0;
2324 dev->block_info = NULL;
2326 if (dev->chunk_bits_alt && dev->chunk_bits)
2327 vfree(dev->chunk_bits);
2329 kfree(dev->chunk_bits);
2330 dev->chunk_bits_alt = 0;
2331 dev->chunk_bits = NULL;
2334 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no)
2336 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block_no);
2339 /* If the block is still healthy erase it and mark as clean.
2340 * If the block has had a data failure, then retire it.
2343 yaffs_trace(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2344 "yaffs_block_became_dirty block %d state %d %s",
2345 block_no, bi->block_state,
2346 (bi->needs_retiring) ? "needs retiring" : "");
2348 yaffs2_clear_oldest_dirty_seq(dev, bi);
2350 bi->block_state = YAFFS_BLOCK_STATE_DIRTY;
2352 /* If this is the block being garbage collected then stop gc'ing */
2353 if (block_no == dev->gc_block)
2356 /* If this block is currently the best candidate for gc
2357 * then drop as a candidate */
2358 if (block_no == dev->gc_dirtiest) {
2359 dev->gc_dirtiest = 0;
2360 dev->gc_pages_in_use = 0;
2363 if (!bi->needs_retiring) {
2364 yaffs2_checkpt_invalidate(dev);
2365 erased_ok = yaffs_erase_block(dev, block_no);
2367 dev->n_erase_failures++;
2368 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2369 "**>> Erasure failed %d", block_no);
2374 ((yaffs_trace_mask & YAFFS_TRACE_ERASE)
2375 || !yaffs_skip_verification(dev))) {
2377 for (i = 0; i < dev->param.chunks_per_block; i++) {
2378 if (!yaffs_check_chunk_erased
2379 (dev, block_no * dev->param.chunks_per_block + i)) {
2380 yaffs_trace(YAFFS_TRACE_ERROR,
2381 ">>Block %d erasure supposedly OK, but chunk %d not erased",
2388 /* Clean it up... */
2389 bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
2391 dev->n_erased_blocks++;
2392 bi->pages_in_use = 0;
2393 bi->soft_del_pages = 0;
2394 bi->has_shrink_hdr = 0;
2395 bi->skip_erased_check = 1; /* Clean, so no need to check */
2396 bi->gc_prioritise = 0;
2397 yaffs_clear_chunk_bits(dev, block_no);
2399 yaffs_trace(YAFFS_TRACE_ERASE,
2400 "Erased block %d", block_no);
2402 /* We lost a block of free space */
2403 dev->n_free_chunks -= dev->param.chunks_per_block;
2404 yaffs_retire_block(dev, block_no);
2405 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2406 "**>> Block %d retired", block_no);
2410 static int yaffs_gc_process_chunk(struct yaffs_dev *dev,
2411 struct yaffs_block_info *bi,
2412 int old_chunk, u8 *buffer)
2416 struct yaffs_ext_tags tags;
2417 struct yaffs_obj *object;
2419 int ret_val = YAFFS_OK;
2421 yaffs_init_tags(&tags);
2422 yaffs_rd_chunk_tags_nand(dev, old_chunk,
2424 object = yaffs_find_by_number(dev, tags.obj_id);
2426 yaffs_trace(YAFFS_TRACE_GC_DETAIL,
2427 "Collecting chunk in block %d, %d %d %d ",
2428 dev->gc_chunk, tags.obj_id,
2429 tags.chunk_id, tags.n_bytes);
2431 if (object && !yaffs_skip_verification(dev)) {
2432 if (tags.chunk_id == 0)
2435 else if (object->soft_del)
2436 /* Defeat the test */
2437 matching_chunk = old_chunk;
2440 yaffs_find_chunk_in_file
2441 (object, tags.chunk_id,
2444 if (old_chunk != matching_chunk)
2445 yaffs_trace(YAFFS_TRACE_ERROR,
2446 "gc: page in gc mismatch: %d %d %d %d",
2454 yaffs_trace(YAFFS_TRACE_ERROR,
2455 "page %d in gc has no object: %d %d %d ",
2457 tags.obj_id, tags.chunk_id,
2463 object->soft_del && tags.chunk_id != 0) {
2464 /* Data chunk in a soft deleted file,
2466 * It's a soft deleted data chunk,
2467 * No need to copy this, just forget
2468 * about it and fix up the object.
2471 /* Free chunks already includes
2472 * softdeleted chunks, how ever this
2473 * chunk is going to soon be really
2474 * deleted which will increment free
2475 * chunks. We have to decrement free
2476 * chunks so this works out properly.
2478 dev->n_free_chunks--;
2479 bi->soft_del_pages--;
2481 object->n_data_chunks--;
2482 if (object->n_data_chunks <= 0) {
2483 /* remeber to clean up obj */
2484 dev->gc_cleanup_list[dev->n_clean_ups] = tags.obj_id;
2488 } else if (object) {
2489 /* It's either a data chunk in a live
2490 * file or an ObjectHeader, so we're
2492 * NB Need to keep the ObjectHeaders of
2493 * deleted files until the whole file
2494 * has been deleted off
2496 tags.serial_number++;
2499 if (tags.chunk_id == 0) {
2500 /* It is an object Id,
2501 * We need to nuke the
2502 * shrinkheader flags since its
2504 * Also need to clean up
2507 struct yaffs_obj_hdr *oh;
2508 oh = (struct yaffs_obj_hdr *) buffer;
2511 tags.extra_is_shrink = 0;
2512 oh->shadows_obj = 0;
2513 oh->inband_shadowed_obj_id = 0;
2514 tags.extra_shadows = 0;
2516 /* Update file size */
2517 if (object->variant_type == YAFFS_OBJECT_TYPE_FILE) {
2519 object->variant.file_variant.file_size;
2520 tags.extra_length = oh->file_size;
2523 yaffs_verify_oh(object, oh, &tags, 1);
2525 yaffs_write_new_chunk(dev, (u8 *) oh, &tags, 1);
2528 yaffs_write_new_chunk(dev, buffer, &tags, 1);
2531 if (new_chunk < 0) {
2532 ret_val = YAFFS_FAIL;
2535 /* Now fix up the Tnodes etc. */
2537 if (tags.chunk_id == 0) {
2539 object->hdr_chunk = new_chunk;
2540 object->serial = tags.serial_number;
2542 /* It's a data chunk */
2543 yaffs_put_chunk_in_file(object, tags.chunk_id,
2548 if (ret_val == YAFFS_OK)
2549 yaffs_chunk_del(dev, old_chunk, mark_flash, __LINE__);
2553 static int yaffs_gc_block(struct yaffs_dev *dev, int block, int whole_block)
2556 int ret_val = YAFFS_OK;
2558 int is_checkpt_block;
2560 int chunks_before = yaffs_get_erased_chunks(dev);
2562 struct yaffs_block_info *bi = yaffs_get_block_info(dev, block);
2564 is_checkpt_block = (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT);
2566 yaffs_trace(YAFFS_TRACE_TRACING,
2567 "Collecting block %d, in use %d, shrink %d, whole_block %d",
2568 block, bi->pages_in_use, bi->has_shrink_hdr,
2571 /*yaffs_verify_free_chunks(dev); */
2573 if (bi->block_state == YAFFS_BLOCK_STATE_FULL)
2574 bi->block_state = YAFFS_BLOCK_STATE_COLLECTING;
2576 bi->has_shrink_hdr = 0; /* clear the flag so that the block can erase */
2578 dev->gc_disable = 1;
2580 if (is_checkpt_block || !yaffs_still_some_chunks(dev, block)) {
2581 yaffs_trace(YAFFS_TRACE_TRACING,
2582 "Collecting block %d that has no chunks in use",
2584 yaffs_block_became_dirty(dev, block);
2587 u8 *buffer = yaffs_get_temp_buffer(dev, __LINE__);
2589 yaffs_verify_blk(dev, bi, block);
2591 max_copies = (whole_block) ? dev->param.chunks_per_block : 5;
2592 old_chunk = block * dev->param.chunks_per_block + dev->gc_chunk;
2594 for (/* init already done */ ;
2595 ret_val == YAFFS_OK &&
2596 dev->gc_chunk < dev->param.chunks_per_block &&
2597 (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) &&
2599 dev->gc_chunk++, old_chunk++) {
2600 if (yaffs_check_chunk_bit(dev, block, dev->gc_chunk)) {
2601 /* Page is in use and might need to be copied */
2603 ret_val = yaffs_gc_process_chunk(dev, bi,
2607 yaffs_release_temp_buffer(dev, buffer, __LINE__);
2610 yaffs_verify_collected_blk(dev, bi, block);
2612 if (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2614 * The gc did not complete. Set block state back to FULL
2615 * because checkpointing does not restore gc.
2617 bi->block_state = YAFFS_BLOCK_STATE_FULL;
2619 /* The gc completed. */
2620 /* Do any required cleanups */
2621 for (i = 0; i < dev->n_clean_ups; i++) {
2622 /* Time to delete the file too */
2623 struct yaffs_obj *object =
2624 yaffs_find_by_number(dev, dev->gc_cleanup_list[i]);
2626 yaffs_free_tnode(dev,
2627 object->variant.file_variant.top);
2628 object->variant.file_variant.top = NULL;
2629 yaffs_trace(YAFFS_TRACE_GC,
2630 "yaffs: About to finally delete object %d",
2632 yaffs_generic_obj_del(object);
2633 object->my_dev->n_deleted_files--;
2637 chunks_after = yaffs_get_erased_chunks(dev);
2638 if (chunks_before >= chunks_after)
2639 yaffs_trace(YAFFS_TRACE_GC,
2640 "gc did not increase free chunks before %d after %d",
2641 chunks_before, chunks_after);
2644 dev->n_clean_ups = 0;
2647 dev->gc_disable = 0;
2653 * find_gc_block() selects the dirtiest block (or close enough)
2654 * for garbage collection.
2657 static unsigned yaffs_find_gc_block(struct yaffs_dev *dev,
2658 int aggressive, int background)
2662 unsigned selected = 0;
2663 int prioritised = 0;
2664 int prioritised_exist = 0;
2665 struct yaffs_block_info *bi;
2668 /* First let's see if we need to grab a prioritised block */
2669 if (dev->has_pending_prioritised_gc && !aggressive) {
2670 dev->gc_dirtiest = 0;
2671 bi = dev->block_info;
2672 for (i = dev->internal_start_block;
2673 i <= dev->internal_end_block && !selected; i++) {
2675 if (bi->gc_prioritise) {
2676 prioritised_exist = 1;
2677 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2678 yaffs_block_ok_for_gc(dev, bi)) {
2687 * If there is a prioritised block and none was selected then
2688 * this happened because there is at least one old dirty block
2689 * gumming up the works. Let's gc the oldest dirty block.
2692 if (prioritised_exist &&
2693 !selected && dev->oldest_dirty_block > 0)
2694 selected = dev->oldest_dirty_block;
2696 if (!prioritised_exist) /* None found, so we can clear this */
2697 dev->has_pending_prioritised_gc = 0;
2700 /* If we're doing aggressive GC then we are happy to take a less-dirty
2701 * block, and search harder.
2702 * else (leasurely gc), then we only bother to do this if the
2703 * block has only a few pages in use.
2709 dev->internal_end_block - dev->internal_start_block + 1;
2711 threshold = dev->param.chunks_per_block;
2712 iterations = n_blocks;
2717 max_threshold = dev->param.chunks_per_block / 2;
2719 max_threshold = dev->param.chunks_per_block / 8;
2721 if (max_threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2722 max_threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2724 threshold = background ? (dev->gc_not_done + 2) * 2 : 0;
2725 if (threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2726 threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2727 if (threshold > max_threshold)
2728 threshold = max_threshold;
2730 iterations = n_blocks / 16 + 1;
2731 if (iterations > 100)
2737 (dev->gc_dirtiest < 1 ||
2738 dev->gc_pages_in_use > YAFFS_GC_GOOD_ENOUGH);
2740 dev->gc_block_finder++;
2741 if (dev->gc_block_finder < dev->internal_start_block ||
2742 dev->gc_block_finder > dev->internal_end_block)
2743 dev->gc_block_finder =
2744 dev->internal_start_block;
2746 bi = yaffs_get_block_info(dev, dev->gc_block_finder);
2748 pages_used = bi->pages_in_use - bi->soft_del_pages;
2750 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2751 pages_used < dev->param.chunks_per_block &&
2752 (dev->gc_dirtiest < 1 ||
2753 pages_used < dev->gc_pages_in_use) &&
2754 yaffs_block_ok_for_gc(dev, bi)) {
2755 dev->gc_dirtiest = dev->gc_block_finder;
2756 dev->gc_pages_in_use = pages_used;
2760 if (dev->gc_dirtiest > 0 && dev->gc_pages_in_use <= threshold)
2761 selected = dev->gc_dirtiest;
2765 * If nothing has been selected for a while, try the oldest dirty
2766 * because that's gumming up the works.
2769 if (!selected && dev->param.is_yaffs2 &&
2770 dev->gc_not_done >= (background ? 10 : 20)) {
2771 yaffs2_find_oldest_dirty_seq(dev);
2772 if (dev->oldest_dirty_block > 0) {
2773 selected = dev->oldest_dirty_block;
2774 dev->gc_dirtiest = selected;
2775 dev->oldest_dirty_gc_count++;
2776 bi = yaffs_get_block_info(dev, selected);
2777 dev->gc_pages_in_use =
2778 bi->pages_in_use - bi->soft_del_pages;
2780 dev->gc_not_done = 0;
2785 yaffs_trace(YAFFS_TRACE_GC,
2786 "GC Selected block %d with %d free, prioritised:%d",
2788 dev->param.chunks_per_block - dev->gc_pages_in_use,
2795 dev->gc_dirtiest = 0;
2796 dev->gc_pages_in_use = 0;
2797 dev->gc_not_done = 0;
2798 if (dev->refresh_skip > 0)
2799 dev->refresh_skip--;
2802 yaffs_trace(YAFFS_TRACE_GC,
2803 "GC none: finder %d skip %d threshold %d dirtiest %d using %d oldest %d%s",
2804 dev->gc_block_finder, dev->gc_not_done, threshold,
2805 dev->gc_dirtiest, dev->gc_pages_in_use,
2806 dev->oldest_dirty_block, background ? " bg" : "");
2812 /* New garbage collector
2813 * If we're very low on erased blocks then we do aggressive garbage collection
2814 * otherwise we do "leasurely" garbage collection.
2815 * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2816 * Passive gc only inspects smaller areas and only accepts more dirty blocks.
2818 * The idea is to help clear out space in a more spread-out manner.
2819 * Dunno if it really does anything useful.
2821 static int yaffs_check_gc(struct yaffs_dev *dev, int background)
2824 int gc_ok = YAFFS_OK;
2828 int checkpt_block_adjust;
2830 if (dev->param.gc_control && (dev->param.gc_control(dev) & 1) == 0)
2833 if (dev->gc_disable) {
2834 /* Bail out so we don't get recursive gc */
2838 /* This loop should pass the first time.
2839 * Only loops here if the collection does not increase space.
2845 checkpt_block_adjust = yaffs_calc_checkpt_blocks_required(dev);
2848 dev->param.n_reserved_blocks + checkpt_block_adjust + 1;
2850 dev->n_erased_blocks * dev->param.chunks_per_block;
2852 /* If we need a block soon then do aggressive gc. */
2853 if (dev->n_erased_blocks < min_erased)
2857 && erased_chunks > (dev->n_free_chunks / 4))
2860 if (dev->gc_skip > 20)
2862 if (erased_chunks < dev->n_free_chunks / 2 ||
2863 dev->gc_skip < 1 || background)
2873 /* If we don't already have a block being gc'd then see if we
2874 * should start another */
2876 if (dev->gc_block < 1 && !aggressive) {
2877 dev->gc_block = yaffs2_find_refresh_block(dev);
2879 dev->n_clean_ups = 0;
2881 if (dev->gc_block < 1) {
2883 yaffs_find_gc_block(dev, aggressive, background);
2885 dev->n_clean_ups = 0;
2888 if (dev->gc_block > 0) {
2891 dev->passive_gc_count++;
2893 yaffs_trace(YAFFS_TRACE_GC,
2894 "yaffs: GC n_erased_blocks %d aggressive %d",
2895 dev->n_erased_blocks, aggressive);
2897 gc_ok = yaffs_gc_block(dev, dev->gc_block, aggressive);
2900 if (dev->n_erased_blocks < (dev->param.n_reserved_blocks)
2901 && dev->gc_block > 0) {
2902 yaffs_trace(YAFFS_TRACE_GC,
2903 "yaffs: GC !!!no reclaim!!! n_erased_blocks %d after try %d block %d",
2904 dev->n_erased_blocks, max_tries,
2907 } while ((dev->n_erased_blocks < dev->param.n_reserved_blocks) &&
2908 (dev->gc_block > 0) && (max_tries < 2));
2910 return aggressive ? gc_ok : YAFFS_OK;
2915 * Garbage collects. Intended to be called from a background thread.
2916 * Returns non-zero if at least half the free chunks are erased.
2918 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency)
2920 int erased_chunks = dev->n_erased_blocks * dev->param.chunks_per_block;
2922 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Background gc %u", urgency);
2924 yaffs_check_gc(dev, 1);
2925 return erased_chunks > dev->n_free_chunks / 2;
2928 /*-------------------- Data file manipulation -----------------*/
2930 static int yaffs_rd_data_obj(struct yaffs_obj *in, int inode_chunk, u8 * buffer)
2932 int nand_chunk = yaffs_find_chunk_in_file(in, inode_chunk, NULL);
2934 if (nand_chunk >= 0)
2935 return yaffs_rd_chunk_tags_nand(in->my_dev, nand_chunk,
2938 yaffs_trace(YAFFS_TRACE_NANDACCESS,
2939 "Chunk %d not found zero instead",
2941 /* get sane (zero) data if you read a hole */
2942 memset(buffer, 0, in->my_dev->data_bytes_per_chunk);
2948 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
2953 struct yaffs_ext_tags tags;
2954 struct yaffs_block_info *bi;
2960 block = chunk_id / dev->param.chunks_per_block;
2961 page = chunk_id % dev->param.chunks_per_block;
2963 if (!yaffs_check_chunk_bit(dev, block, page))
2964 yaffs_trace(YAFFS_TRACE_VERIFY,
2965 "Deleting invalid chunk %d", chunk_id);
2967 bi = yaffs_get_block_info(dev, block);
2969 yaffs2_update_oldest_dirty_seq(dev, block, bi);
2971 yaffs_trace(YAFFS_TRACE_DELETION,
2972 "line %d delete of chunk %d",
2975 if (!dev->param.is_yaffs2 && mark_flash &&
2976 bi->block_state != YAFFS_BLOCK_STATE_COLLECTING) {
2978 yaffs_init_tags(&tags);
2979 tags.is_deleted = 1;
2980 yaffs_wr_chunk_tags_nand(dev, chunk_id, NULL, &tags);
2981 yaffs_handle_chunk_update(dev, chunk_id, &tags);
2983 dev->n_unmarked_deletions++;
2986 /* Pull out of the management area.
2987 * If the whole block became dirty, this will kick off an erasure.
2989 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING ||
2990 bi->block_state == YAFFS_BLOCK_STATE_FULL ||
2991 bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCANNING ||
2992 bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2993 dev->n_free_chunks++;
2994 yaffs_clear_chunk_bit(dev, block, page);
2997 if (bi->pages_in_use == 0 &&
2998 !bi->has_shrink_hdr &&
2999 bi->block_state != YAFFS_BLOCK_STATE_ALLOCATING &&
3000 bi->block_state != YAFFS_BLOCK_STATE_NEEDS_SCANNING) {
3001 yaffs_block_became_dirty(dev, block);
3006 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
3007 const u8 *buffer, int n_bytes, int use_reserve)
3009 /* Find old chunk Need to do this to get serial number
3010 * Write new one and patch into tree.
3011 * Invalidate old tags.
3015 struct yaffs_ext_tags prev_tags;
3017 struct yaffs_ext_tags new_tags;
3018 struct yaffs_dev *dev = in->my_dev;
3020 yaffs_check_gc(dev, 0);
3022 /* Get the previous chunk at this location in the file if it exists.
3023 * If it does not exist then put a zero into the tree. This creates
3024 * the tnode now, rather than later when it is harder to clean up.
3026 prev_chunk_id = yaffs_find_chunk_in_file(in, inode_chunk, &prev_tags);
3027 if (prev_chunk_id < 1 &&
3028 !yaffs_put_chunk_in_file(in, inode_chunk, 0, 0))
3031 /* Set up new tags */
3032 yaffs_init_tags(&new_tags);
3034 new_tags.chunk_id = inode_chunk;
3035 new_tags.obj_id = in->obj_id;
3036 new_tags.serial_number =
3037 (prev_chunk_id > 0) ? prev_tags.serial_number + 1 : 1;
3038 new_tags.n_bytes = n_bytes;
3040 if (n_bytes < 1 || n_bytes > dev->param.total_bytes_per_chunk) {
3041 yaffs_trace(YAFFS_TRACE_ERROR,
3042 "Writing %d bytes to chunk!!!!!!!!!",
3048 yaffs_write_new_chunk(dev, buffer, &new_tags, use_reserve);
3050 if (new_chunk_id > 0) {
3051 yaffs_put_chunk_in_file(in, inode_chunk, new_chunk_id, 0);
3053 if (prev_chunk_id > 0)
3054 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3056 yaffs_verify_file_sane(in);
3058 return new_chunk_id;
3064 static int yaffs_do_xattrib_mod(struct yaffs_obj *obj, int set,
3065 const YCHAR *name, const void *value, int size,
3068 struct yaffs_xattr_mod xmod;
3076 xmod.result = -ENOSPC;
3078 result = yaffs_update_oh(obj, NULL, 0, 0, 0, &xmod);
3086 static int yaffs_apply_xattrib_mod(struct yaffs_obj *obj, char *buffer,
3087 struct yaffs_xattr_mod *xmod)
3090 int x_offs = sizeof(struct yaffs_obj_hdr);
3091 struct yaffs_dev *dev = obj->my_dev;
3092 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3093 char *x_buffer = buffer + x_offs;
3097 nval_set(x_buffer, x_size, xmod->name, xmod->data,
3098 xmod->size, xmod->flags);
3100 retval = nval_del(x_buffer, x_size, xmod->name);
3102 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3103 obj->xattr_known = 1;
3104 xmod->result = retval;
3109 static int yaffs_do_xattrib_fetch(struct yaffs_obj *obj, const YCHAR *name,
3110 void *value, int size)
3112 char *buffer = NULL;
3114 struct yaffs_ext_tags tags;
3115 struct yaffs_dev *dev = obj->my_dev;
3116 int x_offs = sizeof(struct yaffs_obj_hdr);
3117 int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3121 if (obj->hdr_chunk < 1)
3124 /* If we know that the object has no xattribs then don't do all the
3125 * reading and parsing.
3127 if (obj->xattr_known && !obj->has_xattr) {
3134 buffer = (char *)yaffs_get_temp_buffer(dev, __LINE__);
3139 yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, (u8 *) buffer, &tags);
3141 if (result != YAFFS_OK)
3144 x_buffer = buffer + x_offs;
3146 if (!obj->xattr_known) {
3147 obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3148 obj->xattr_known = 1;
3152 retval = nval_get(x_buffer, x_size, name, value, size);
3154 retval = nval_list(x_buffer, x_size, value, size);
3156 yaffs_release_temp_buffer(dev, (u8 *) buffer, __LINE__);
3160 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR * name,
3161 const void *value, int size, int flags)
3163 return yaffs_do_xattrib_mod(obj, 1, name, value, size, flags);
3166 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR * name)
3168 return yaffs_do_xattrib_mod(obj, 0, name, NULL, 0, 0);
3171 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR * name, void *value,
3174 return yaffs_do_xattrib_fetch(obj, name, value, size);
3177 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size)
3179 return yaffs_do_xattrib_fetch(obj, NULL, buffer, size);
3182 static void yaffs_check_obj_details_loaded(struct yaffs_obj *in)
3185 struct yaffs_obj_hdr *oh;
3186 struct yaffs_dev *dev;
3187 struct yaffs_ext_tags tags;
3189 int alloc_failed = 0;
3196 if (in->lazy_loaded && in->hdr_chunk > 0) {
3197 in->lazy_loaded = 0;
3198 chunk_data = yaffs_get_temp_buffer(dev, __LINE__);
3201 yaffs_rd_chunk_tags_nand(dev, in->hdr_chunk, chunk_data,
3203 oh = (struct yaffs_obj_hdr *)chunk_data;
3205 in->yst_mode = oh->yst_mode;
3206 yaffs_load_attribs(in, oh);
3207 yaffs_set_obj_name_from_oh(in, oh);
3209 if (in->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
3210 in->variant.symlink_variant.alias =
3211 yaffs_clone_str(oh->alias);
3212 if (!in->variant.symlink_variant.alias)
3213 alloc_failed = 1; /* Not returned */
3216 yaffs_release_temp_buffer(dev, chunk_data, __LINE__);
3220 static void yaffs_load_name_from_oh(struct yaffs_dev *dev, YCHAR *name,
3221 const YCHAR *oh_name, int buff_size)
3223 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3224 if (dev->param.auto_unicode) {
3226 /* It is an ASCII name, do an ASCII to
3227 * unicode conversion */
3228 const char *ascii_oh_name = (const char *)oh_name;
3229 int n = buff_size - 1;
3230 while (n > 0 && *ascii_oh_name) {
3231 *name = *ascii_oh_name;
3237 strncpy(name, oh_name + 1, buff_size - 1);
3243 strncpy(name, oh_name, buff_size - 1);
3247 static void yaffs_load_oh_from_name(struct yaffs_dev *dev, YCHAR *oh_name,
3250 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3255 if (dev->param.auto_unicode) {
3260 /* Figure out if the name will fit in ascii character set */
3261 while (is_ascii && *w) {
3268 /* It is an ASCII name, so convert unicode to ascii */
3269 char *ascii_oh_name = (char *)oh_name;
3270 int n = YAFFS_MAX_NAME_LENGTH - 1;
3271 while (n > 0 && *name) {
3272 *ascii_oh_name = *name;
3278 /* Unicode name, so save starting at the second YCHAR */
3280 strncpy(oh_name + 1, name,
3281 YAFFS_MAX_NAME_LENGTH - 2);
3287 strncpy(oh_name, name, YAFFS_MAX_NAME_LENGTH - 1);
3291 /* UpdateObjectHeader updates the header on NAND for an object.
3292 * If name is not NULL, then that new name is used.
3294 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name, int force,
3295 int is_shrink, int shadows, struct yaffs_xattr_mod *xmod)
3298 struct yaffs_block_info *bi;
3299 struct yaffs_dev *dev = in->my_dev;
3304 struct yaffs_ext_tags new_tags;
3305 struct yaffs_ext_tags old_tags;
3306 const YCHAR *alias = NULL;
3308 YCHAR old_name[YAFFS_MAX_NAME_LENGTH + 1];
3309 struct yaffs_obj_hdr *oh = NULL;
3311 strcpy(old_name, _Y("silly old name"));
3313 if (!in->fake || in == dev->root_dir ||
3316 yaffs_check_gc(dev, 0);
3317 yaffs_check_obj_details_loaded(in);
3319 buffer = yaffs_get_temp_buffer(in->my_dev, __LINE__);
3320 oh = (struct yaffs_obj_hdr *)buffer;
3322 prev_chunk_id = in->hdr_chunk;
3324 if (prev_chunk_id > 0) {
3325 result = yaffs_rd_chunk_tags_nand(dev, prev_chunk_id,
3328 yaffs_verify_oh(in, oh, &old_tags, 0);
3330 memcpy(old_name, oh->name, sizeof(oh->name));
3331 memset(buffer, 0xFF, sizeof(struct yaffs_obj_hdr));
3333 memset(buffer, 0xFF, dev->data_bytes_per_chunk);
3336 oh->type = in->variant_type;
3337 oh->yst_mode = in->yst_mode;
3338 oh->shadows_obj = oh->inband_shadowed_obj_id = shadows;
3340 yaffs_load_attribs_oh(oh, in);
3343 oh->parent_obj_id = in->parent->obj_id;
3345 oh->parent_obj_id = 0;
3347 if (name && *name) {
3348 memset(oh->name, 0, sizeof(oh->name));
3349 yaffs_load_oh_from_name(dev, oh->name, name);
3350 } else if (prev_chunk_id > 0) {
3351 memcpy(oh->name, old_name, sizeof(oh->name));
3353 memset(oh->name, 0, sizeof(oh->name));
3356 oh->is_shrink = is_shrink;
3358 switch (in->variant_type) {
3359 case YAFFS_OBJECT_TYPE_UNKNOWN:
3360 /* Should not happen */
3362 case YAFFS_OBJECT_TYPE_FILE:
3364 (oh->parent_obj_id == YAFFS_OBJECTID_DELETED
3365 || oh->parent_obj_id ==
3366 YAFFS_OBJECTID_UNLINKED) ? 0 : in->
3367 variant.file_variant.file_size;
3369 case YAFFS_OBJECT_TYPE_HARDLINK:
3370 oh->equiv_id = in->variant.hardlink_variant.equiv_id;
3372 case YAFFS_OBJECT_TYPE_SPECIAL:
3375 case YAFFS_OBJECT_TYPE_DIRECTORY:
3378 case YAFFS_OBJECT_TYPE_SYMLINK:
3379 alias = in->variant.symlink_variant.alias;
3381 alias = _Y("no alias");
3382 strncpy(oh->alias, alias, YAFFS_MAX_ALIAS_LENGTH);
3383 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3387 /* process any xattrib modifications */
3389 yaffs_apply_xattrib_mod(in, (char *)buffer, xmod);
3392 yaffs_init_tags(&new_tags);
3394 new_tags.chunk_id = 0;
3395 new_tags.obj_id = in->obj_id;
3396 new_tags.serial_number = in->serial;
3398 /* Add extra info for file header */
3399 new_tags.extra_available = 1;
3400 new_tags.extra_parent_id = oh->parent_obj_id;
3401 new_tags.extra_length = oh->file_size;
3402 new_tags.extra_is_shrink = oh->is_shrink;
3403 new_tags.extra_equiv_id = oh->equiv_id;
3404 new_tags.extra_shadows = (oh->shadows_obj > 0) ? 1 : 0;
3405 new_tags.extra_obj_type = in->variant_type;
3406 yaffs_verify_oh(in, oh, &new_tags, 1);
3408 /* Create new chunk in NAND */
3410 yaffs_write_new_chunk(dev, buffer, &new_tags,
3411 (prev_chunk_id > 0) ? 1 : 0);
3413 if (new_chunk_id >= 0) {
3415 in->hdr_chunk = new_chunk_id;
3417 if (prev_chunk_id > 0) {
3418 yaffs_chunk_del(dev, prev_chunk_id, 1,
3422 if (!yaffs_obj_cache_dirty(in))
3425 /* If this was a shrink, then mark the block
3426 * that the chunk lives on */
3428 bi = yaffs_get_block_info(in->my_dev,
3432 bi->has_shrink_hdr = 1;
3435 ret_val = new_chunk_id;
3439 yaffs_release_temp_buffer(dev, buffer, __LINE__);
3444 /*--------------------- File read/write ------------------------
3445 * Read and write have very similar structures.
3446 * In general the read/write has three parts to it
3447 * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3448 * Some complete chunks
3449 * An incomplete chunk to end off with
3451 * Curve-balls: the first chunk might also be the last chunk.
3454 int yaffs_file_rd(struct yaffs_obj *in, u8 * buffer, loff_t offset, int n_bytes)
3461 struct yaffs_cache *cache;
3462 struct yaffs_dev *dev;
3467 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3470 /* OK now check for the curveball where the start and end are in
3473 if ((start + n) < dev->data_bytes_per_chunk)
3476 n_copy = dev->data_bytes_per_chunk - start;
3478 cache = yaffs_find_chunk_cache(in, chunk);
3480 /* If the chunk is already in the cache or it is less than
3481 * a whole chunk or we're using inband tags then use the cache
3482 * (if there is caching) else bypass the cache.
3484 if (cache || n_copy != dev->data_bytes_per_chunk
3485 || dev->param.inband_tags) {
3486 if (dev->param.n_caches > 0) {
3488 /* If we can't find the data in the cache,
3489 * then load it up. */
3493 yaffs_grab_chunk_cache(in->my_dev);
3495 cache->chunk_id = chunk;
3498 yaffs_rd_data_obj(in, chunk,
3503 yaffs_use_cache(dev, cache, 0);
3507 memcpy(buffer, &cache->data[start], n_copy);
3511 /* Read into the local buffer then copy.. */
3514 yaffs_get_temp_buffer(dev, __LINE__);
3515 yaffs_rd_data_obj(in, chunk, local_buffer);
3517 memcpy(buffer, &local_buffer[start], n_copy);
3519 yaffs_release_temp_buffer(dev, local_buffer,
3523 /* A full chunk. Read directly into the buffer. */
3524 yaffs_rd_data_obj(in, chunk, buffer);
3534 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
3535 int n_bytes, int write_trhrough)
3544 int start_write = offset;
3545 int chunk_written = 0;
3548 struct yaffs_dev *dev;
3552 while (n > 0 && chunk_written >= 0) {
3553 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3555 if (chunk * dev->data_bytes_per_chunk + start != offset ||
3556 start >= dev->data_bytes_per_chunk) {
3557 yaffs_trace(YAFFS_TRACE_ERROR,
3558 "AddrToChunk of offset %d gives chunk %d start %d",
3559 (int)offset, chunk, start);
3561 chunk++; /* File pos to chunk in file offset */
3563 /* OK now check for the curveball where the start and end are in
3567 if ((start + n) < dev->data_bytes_per_chunk) {
3570 /* Now calculate how many bytes to write back....
3571 * If we're overwriting and not writing to then end of
3572 * file then we need to write back as much as was there
3576 chunk_start = ((chunk - 1) * dev->data_bytes_per_chunk);
3578 if (chunk_start > in->variant.file_variant.file_size)
3579 n_bytes_read = 0; /* Past end of file */
3582 in->variant.file_variant.file_size -
3585 if (n_bytes_read > dev->data_bytes_per_chunk)
3586 n_bytes_read = dev->data_bytes_per_chunk;
3590 (start + n)) ? n_bytes_read : (start + n);
3592 if (n_writeback < 0 ||
3593 n_writeback > dev->data_bytes_per_chunk)
3597 n_copy = dev->data_bytes_per_chunk - start;
3598 n_writeback = dev->data_bytes_per_chunk;
3601 if (n_copy != dev->data_bytes_per_chunk ||
3602 dev->param.inband_tags) {
3603 /* An incomplete start or end chunk (or maybe both
3604 * start and end chunk), or we're using inband tags,
3605 * so we want to use the cache buffers.
3607 if (dev->param.n_caches > 0) {
3608 struct yaffs_cache *cache;
3610 /* If we can't find the data in the cache, then
3612 cache = yaffs_find_chunk_cache(in, chunk);
3615 && yaffs_check_alloc_available(dev, 1)) {
3616 cache = yaffs_grab_chunk_cache(dev);
3618 cache->chunk_id = chunk;
3621 yaffs_rd_data_obj(in, chunk,
3625 !yaffs_check_alloc_available(dev,
3627 /* Drop the cache if it was a read cache
3628 * item and no space check has been made
3635 yaffs_use_cache(dev, cache, 1);
3638 memcpy(&cache->data[start], buffer,
3642 cache->n_bytes = n_writeback;
3644 if (write_trhrough) {
3654 chunk_written = -1; /* fail write */
3657 /* An incomplete start or end chunk (or maybe
3658 * both start and end chunk). Read into the
3659 * local buffer then copy over and write back.
3663 yaffs_get_temp_buffer(dev, __LINE__);
3665 yaffs_rd_data_obj(in, chunk, local_buffer);
3666 memcpy(&local_buffer[start], buffer, n_copy);
3669 yaffs_wr_data_obj(in, chunk,
3673 yaffs_release_temp_buffer(dev, local_buffer,
3677 /* A full chunk. Write directly from the buffer. */
3680 yaffs_wr_data_obj(in, chunk, buffer,
3681 dev->data_bytes_per_chunk, 0);
3683 /* Since we've overwritten the cached data,
3684 * we better invalidate it. */
3685 yaffs_invalidate_chunk_cache(in, chunk);
3688 if (chunk_written >= 0) {
3696 /* Update file object */
3698 if ((start_write + n_done) > in->variant.file_variant.file_size)
3699 in->variant.file_variant.file_size = (start_write + n_done);
3705 int yaffs_wr_file(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
3706 int n_bytes, int write_trhrough)
3708 yaffs2_handle_hole(in, offset);
3709 return yaffs_do_file_wr(in, buffer, offset, n_bytes, write_trhrough);
3712 /* ---------------------- File resizing stuff ------------------ */
3714 static void yaffs_prune_chunks(struct yaffs_obj *in, int new_size)
3717 struct yaffs_dev *dev = in->my_dev;
3718 int old_size = in->variant.file_variant.file_size;
3721 int last_del = 1 + (old_size - 1) / dev->data_bytes_per_chunk;
3722 int start_del = 1 + (new_size + dev->data_bytes_per_chunk - 1) /
3723 dev->data_bytes_per_chunk;
3726 /* Delete backwards so that we don't end up with holes if
3727 * power is lost part-way through the operation.
3729 for (i = last_del; i >= start_del; i--) {
3730 /* NB this could be optimised somewhat,
3731 * eg. could retrieve the tags and write them without
3732 * using yaffs_chunk_del
3735 chunk_id = yaffs_find_del_file_chunk(in, i, NULL);
3738 (dev->internal_start_block *
3739 dev->param.chunks_per_block) ||
3741 ((dev->internal_end_block + 1) *
3742 dev->param.chunks_per_block)) {
3743 yaffs_trace(YAFFS_TRACE_ALWAYS,
3744 "Found daft chunk_id %d for %d",
3747 in->n_data_chunks--;
3748 yaffs_chunk_del(dev, chunk_id, 1, __LINE__);
3754 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size)
3758 struct yaffs_dev *dev = obj->my_dev;
3760 yaffs_addr_to_chunk(dev, new_size, &new_full, &new_partial);
3762 yaffs_prune_chunks(obj, new_size);
3764 if (new_partial != 0) {
3765 int last_chunk = 1 + new_full;
3766 u8 *local_buffer = yaffs_get_temp_buffer(dev, __LINE__);
3768 /* Rewrite the last chunk with its new size and zero pad */
3769 yaffs_rd_data_obj(obj, last_chunk, local_buffer);
3770 memset(local_buffer + new_partial, 0,
3771 dev->data_bytes_per_chunk - new_partial);
3773 yaffs_wr_data_obj(obj, last_chunk, local_buffer,
3776 yaffs_release_temp_buffer(dev, local_buffer, __LINE__);
3779 obj->variant.file_variant.file_size = new_size;
3781 yaffs_prune_tree(dev, &obj->variant.file_variant);
3784 int yaffs_resize_file(struct yaffs_obj *in, loff_t new_size)
3786 struct yaffs_dev *dev = in->my_dev;
3787 int old_size = in->variant.file_variant.file_size;
3789 yaffs_flush_file_cache(in);
3790 yaffs_invalidate_whole_cache(in);
3792 yaffs_check_gc(dev, 0);
3794 if (in->variant_type != YAFFS_OBJECT_TYPE_FILE)
3797 if (new_size == old_size)
3800 if (new_size > old_size) {
3801 yaffs2_handle_hole(in, new_size);
3802 in->variant.file_variant.file_size = new_size;
3804 /* new_size < old_size */
3805 yaffs_resize_file_down(in, new_size);
3808 /* Write a new object header to reflect the resize.
3809 * show we've shrunk the file, if need be
3810 * Do this only if the file is not in the deleted directories
3811 * and is not shadowed.
3815 in->parent->obj_id != YAFFS_OBJECTID_UNLINKED &&
3816 in->parent->obj_id != YAFFS_OBJECTID_DELETED)
3817 yaffs_update_oh(in, NULL, 0, 0, 0, NULL);
3822 int yaffs_flush_file(struct yaffs_obj *in, int update_time, int data_sync)
3827 yaffs_flush_file_cache(in);
3828 if (data_sync) /* Only sync data */
3832 yaffs_load_current_time(in, 0, 0);
3834 ret_val = (yaffs_update_oh(in, NULL, 0, 0, 0, NULL) >=
3835 0) ? YAFFS_OK : YAFFS_FAIL;
3844 /* yaffs_del_file deletes the whole file data
3845 * and the inode associated with the file.
3846 * It does not delete the links associated with the file.
3848 static int yaffs_unlink_file_if_needed(struct yaffs_obj *in)
3852 struct yaffs_dev *dev = in->my_dev;
3859 yaffs_change_obj_name(in, in->my_dev->del_dir,
3860 _Y("deleted"), 0, 0);
3861 yaffs_trace(YAFFS_TRACE_TRACING,
3862 "yaffs: immediate deletion of file %d",
3865 in->my_dev->n_deleted_files++;
3866 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3867 yaffs_resize_file(in, 0);
3868 yaffs_soft_del_file(in);
3871 yaffs_change_obj_name(in, in->my_dev->unlinked_dir,
3872 _Y("unlinked"), 0, 0);
3877 int yaffs_del_file(struct yaffs_obj *in)
3879 int ret_val = YAFFS_OK;
3880 int deleted; /* Need to cache value on stack if in is freed */
3881 struct yaffs_dev *dev = in->my_dev;
3883 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3884 yaffs_resize_file(in, 0);
3886 if (in->n_data_chunks > 0) {
3887 /* Use soft deletion if there is data in the file.
3888 * That won't be the case if it has been resized to zero.
3891 ret_val = yaffs_unlink_file_if_needed(in);
3893 deleted = in->deleted;
3895 if (ret_val == YAFFS_OK && in->unlinked && !in->deleted) {
3898 in->my_dev->n_deleted_files++;
3899 yaffs_soft_del_file(in);
3901 return deleted ? YAFFS_OK : YAFFS_FAIL;
3903 /* The file has no data chunks so we toss it immediately */
3904 yaffs_free_tnode(in->my_dev, in->variant.file_variant.top);
3905 in->variant.file_variant.top = NULL;
3906 yaffs_generic_obj_del(in);
3912 int yaffs_is_non_empty_dir(struct yaffs_obj *obj)
3915 obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) &&
3916 !(list_empty(&obj->variant.dir_variant.children));
3919 static int yaffs_del_dir(struct yaffs_obj *obj)
3921 /* First check that the directory is empty. */
3922 if (yaffs_is_non_empty_dir(obj))
3925 return yaffs_generic_obj_del(obj);
3928 static int yaffs_del_symlink(struct yaffs_obj *in)
3930 kfree(in->variant.symlink_variant.alias);
3931 in->variant.symlink_variant.alias = NULL;
3933 return yaffs_generic_obj_del(in);
3936 static int yaffs_del_link(struct yaffs_obj *in)
3938 /* remove this hardlink from the list associated with the equivalent
3941 list_del_init(&in->hard_links);
3942 return yaffs_generic_obj_del(in);
3945 int yaffs_del_obj(struct yaffs_obj *obj)
3949 switch (obj->variant_type) {
3950 case YAFFS_OBJECT_TYPE_FILE:
3951 ret_val = yaffs_del_file(obj);
3953 case YAFFS_OBJECT_TYPE_DIRECTORY:
3954 if (!list_empty(&obj->variant.dir_variant.dirty)) {
3955 yaffs_trace(YAFFS_TRACE_BACKGROUND,
3956 "Remove object %d from dirty directories",
3958 list_del_init(&obj->variant.dir_variant.dirty);
3960 return yaffs_del_dir(obj);
3962 case YAFFS_OBJECT_TYPE_SYMLINK:
3963 ret_val = yaffs_del_symlink(obj);
3965 case YAFFS_OBJECT_TYPE_HARDLINK:
3966 ret_val = yaffs_del_link(obj);
3968 case YAFFS_OBJECT_TYPE_SPECIAL:
3969 ret_val = yaffs_generic_obj_del(obj);
3971 case YAFFS_OBJECT_TYPE_UNKNOWN:
3973 break; /* should not happen. */
3978 static int yaffs_unlink_worker(struct yaffs_obj *obj)
3988 yaffs_update_parent(obj->parent);
3990 if (obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
3991 return yaffs_del_link(obj);
3992 } else if (!list_empty(&obj->hard_links)) {
3993 /* Curve ball: We're unlinking an object that has a hardlink.
3995 * This problem arises because we are not strictly following
3996 * The Linux link/inode model.
3998 * We can't really delete the object.
3999 * Instead, we do the following:
4000 * - Select a hardlink.
4001 * - Unhook it from the hard links
4002 * - Move it from its parent directory so that the rename works.
4003 * - Rename the object to the hardlink's name.
4004 * - Delete the hardlink
4007 struct yaffs_obj *hl;
4008 struct yaffs_obj *parent;
4010 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
4012 hl = list_entry(obj->hard_links.next, struct yaffs_obj,
4015 yaffs_get_obj_name(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
4016 parent = hl->parent;
4018 list_del_init(&hl->hard_links);
4020 yaffs_add_obj_to_dir(obj->my_dev->unlinked_dir, hl);
4022 ret_val = yaffs_change_obj_name(obj, parent, name, 0, 0);
4024 if (ret_val == YAFFS_OK)
4025 ret_val = yaffs_generic_obj_del(hl);
4029 } else if (del_now) {
4030 switch (obj->variant_type) {
4031 case YAFFS_OBJECT_TYPE_FILE:
4032 return yaffs_del_file(obj);
4034 case YAFFS_OBJECT_TYPE_DIRECTORY:
4035 list_del_init(&obj->variant.dir_variant.dirty);
4036 return yaffs_del_dir(obj);
4038 case YAFFS_OBJECT_TYPE_SYMLINK:
4039 return yaffs_del_symlink(obj);
4041 case YAFFS_OBJECT_TYPE_SPECIAL:
4042 return yaffs_generic_obj_del(obj);
4044 case YAFFS_OBJECT_TYPE_HARDLINK:
4045 case YAFFS_OBJECT_TYPE_UNKNOWN:
4049 } else if (yaffs_is_non_empty_dir(obj)) {
4052 return yaffs_change_obj_name(obj, obj->my_dev->unlinked_dir,
4053 _Y("unlinked"), 0, 0);
4057 static int yaffs_unlink_obj(struct yaffs_obj *obj)
4059 if (obj && obj->unlink_allowed)
4060 return yaffs_unlink_worker(obj);
4065 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR *name)
4067 struct yaffs_obj *obj;
4069 obj = yaffs_find_by_name(dir, name);
4070 return yaffs_unlink_obj(obj);
4074 * If old_name is NULL then we take old_dir as the object to be renamed.
4076 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR *old_name,
4077 struct yaffs_obj *new_dir, const YCHAR *new_name)
4079 struct yaffs_obj *obj = NULL;
4080 struct yaffs_obj *existing_target = NULL;
4083 struct yaffs_dev *dev;
4085 if (!old_dir || old_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4089 if (!new_dir || new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4094 dev = old_dir->my_dev;
4096 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
4097 /* Special case for case insemsitive systems.
4098 * While look-up is case insensitive, the name isn't.
4099 * Therefore we might want to change x.txt to X.txt
4101 if (old_dir == new_dir &&
4102 old_name && new_name &&
4103 strcmp(old_name, new_name) == 0)
4107 if (strnlen(new_name, YAFFS_MAX_NAME_LENGTH + 1) >
4108 YAFFS_MAX_NAME_LENGTH)
4113 obj = yaffs_find_by_name(old_dir, old_name);
4116 old_dir = obj->parent;
4119 if (obj && obj->rename_allowed) {
4120 /* Now handle an existing target, if there is one */
4121 existing_target = yaffs_find_by_name(new_dir, new_name);
4122 if (yaffs_is_non_empty_dir(existing_target)) {
4123 return YAFFS_FAIL; /* ENOTEMPTY */
4124 } else if (existing_target && existing_target != obj) {
4125 /* Nuke the target first, using shadowing,
4126 * but only if it isn't the same object.
4128 * Note we must disable gc here otherwise it can mess
4132 dev->gc_disable = 1;
4133 yaffs_change_obj_name(obj, new_dir, new_name, force,
4134 existing_target->obj_id);
4135 existing_target->is_shadowed = 1;
4136 yaffs_unlink_obj(existing_target);
4137 dev->gc_disable = 0;
4140 result = yaffs_change_obj_name(obj, new_dir, new_name, 1, 0);
4142 yaffs_update_parent(old_dir);
4143 if (new_dir != old_dir)
4144 yaffs_update_parent(new_dir);
4151 /*----------------------- Initialisation Scanning ---------------------- */
4153 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
4154 int backward_scanning)
4156 struct yaffs_obj *obj;
4158 if (!backward_scanning) {
4159 /* Handle YAFFS1 forward scanning case
4160 * For YAFFS1 we always do the deletion
4164 /* Handle YAFFS2 case (backward scanning)
4165 * If the shadowed object exists then ignore.
4167 obj = yaffs_find_by_number(dev, obj_id);
4172 /* Let's create it (if it does not exist) assuming it is a file so that
4173 * it can do shrinking etc.
4174 * We put it in unlinked dir to be cleaned up after the scanning
4177 yaffs_find_or_create_by_number(dev, obj_id, YAFFS_OBJECT_TYPE_FILE);
4180 obj->is_shadowed = 1;
4181 yaffs_add_obj_to_dir(dev->unlinked_dir, obj);
4182 obj->variant.file_variant.shrink_size = 0;
4183 obj->valid = 1; /* So that we don't read any other info. */
4186 void yaffs_link_fixup(struct yaffs_dev *dev, struct yaffs_obj *hard_list)
4188 struct yaffs_obj *hl;
4189 struct yaffs_obj *in;
4193 hard_list = (struct yaffs_obj *)(hard_list->hard_links.next);
4195 in = yaffs_find_by_number(dev,
4197 hardlink_variant.equiv_id);
4200 /* Add the hardlink pointers */
4201 hl->variant.hardlink_variant.equiv_obj = in;
4202 list_add(&hl->hard_links, &in->hard_links);
4204 /* Todo Need to report/handle this better.
4205 * Got a problem... hardlink to a non-existant object
4207 hl->variant.hardlink_variant.equiv_obj = NULL;
4208 INIT_LIST_HEAD(&hl->hard_links);
4213 static void yaffs_strip_deleted_objs(struct yaffs_dev *dev)
4216 * Sort out state of unlinked and deleted objects after scanning.
4218 struct list_head *i;
4219 struct list_head *n;
4220 struct yaffs_obj *l;
4225 /* Soft delete all the unlinked files */
4226 list_for_each_safe(i, n,
4227 &dev->unlinked_dir->variant.dir_variant.children) {
4228 l = list_entry(i, struct yaffs_obj, siblings);
4232 list_for_each_safe(i, n, &dev->del_dir->variant.dir_variant.children) {
4233 l = list_entry(i, struct yaffs_obj, siblings);
4239 * This code iterates through all the objects making sure that they are rooted.
4240 * Any unrooted objects are re-rooted in lost+found.
4241 * An object needs to be in one of:
4242 * - Directly under deleted, unlinked
4243 * - Directly or indirectly under root.
4246 * This code assumes that we don't ever change the current relationships
4247 * between directories:
4248 * root_dir->parent == unlinked_dir->parent == del_dir->parent == NULL
4249 * lost-n-found->parent == root_dir
4251 * This fixes the problem where directories might have inadvertently been
4252 * deleted leaving the object "hanging" without being rooted in the
4256 static int yaffs_has_null_parent(struct yaffs_dev *dev, struct yaffs_obj *obj)
4258 return (obj == dev->del_dir ||
4259 obj == dev->unlinked_dir || obj == dev->root_dir);
4262 static void yaffs_fix_hanging_objs(struct yaffs_dev *dev)
4264 struct yaffs_obj *obj;
4265 struct yaffs_obj *parent;
4267 struct list_head *lh;
4268 struct list_head *n;
4275 /* Iterate through the objects in each hash entry,
4276 * looking at each object.
4277 * Make sure it is rooted.
4280 for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
4281 list_for_each_safe(lh, n, &dev->obj_bucket[i].list) {
4282 obj = list_entry(lh, struct yaffs_obj, hash_link);
4283 parent = obj->parent;
4285 if (yaffs_has_null_parent(dev, obj)) {
4286 /* These directories are not hanging */
4288 } else if (!parent ||
4289 parent->variant_type !=
4290 YAFFS_OBJECT_TYPE_DIRECTORY) {
4292 } else if (yaffs_has_null_parent(dev, parent)) {
4296 * Need to follow the parent chain to
4297 * see if it is hanging.
4302 while (parent != dev->root_dir &&
4304 parent->parent->variant_type ==
4305 YAFFS_OBJECT_TYPE_DIRECTORY &&
4307 parent = parent->parent;
4310 if (parent != dev->root_dir)
4314 yaffs_trace(YAFFS_TRACE_SCAN,
4315 "Hanging object %d moved to lost and found",
4317 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
4324 * Delete directory contents for cleaning up lost and found.
4326 static void yaffs_del_dir_contents(struct yaffs_obj *dir)
4328 struct yaffs_obj *obj;
4329 struct list_head *lh;
4330 struct list_head *n;
4332 if (dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
4335 list_for_each_safe(lh, n, &dir->variant.dir_variant.children) {
4336 obj = list_entry(lh, struct yaffs_obj, siblings);
4337 if (obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY)
4338 yaffs_del_dir_contents(obj);
4339 yaffs_trace(YAFFS_TRACE_SCAN,
4340 "Deleting lost_found object %d",
4342 yaffs_unlink_obj(obj);
4346 static void yaffs_empty_l_n_f(struct yaffs_dev *dev)
4348 yaffs_del_dir_contents(dev->lost_n_found);
4352 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *directory,
4356 struct list_head *i;
4357 YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
4358 struct yaffs_obj *l;
4364 yaffs_trace(YAFFS_TRACE_ALWAYS,
4365 "tragedy: yaffs_find_by_name: null pointer directory"
4370 if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4371 yaffs_trace(YAFFS_TRACE_ALWAYS,
4372 "tragedy: yaffs_find_by_name: non-directory"
4377 sum = yaffs_calc_name_sum(name);
4379 list_for_each(i, &directory->variant.dir_variant.children) {
4380 l = list_entry(i, struct yaffs_obj, siblings);
4382 if (l->parent != directory)
4385 yaffs_check_obj_details_loaded(l);
4387 /* Special case for lost-n-found */
4388 if (l->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4389 if (!strcmp(name, YAFFS_LOSTNFOUND_NAME))
4391 } else if (l->sum == sum
4392 || l->hdr_chunk <= 0) {
4393 /* LostnFound chunk called Objxxx
4396 yaffs_get_obj_name(l, buffer,
4397 YAFFS_MAX_NAME_LENGTH + 1);
4398 if (strncmp(name, buffer, YAFFS_MAX_NAME_LENGTH) == 0)
4405 /* GetEquivalentObject dereferences any hard links to get to the
4409 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj)
4411 if (obj && obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
4412 obj = obj->variant.hardlink_variant.equiv_obj;
4413 yaffs_check_obj_details_loaded(obj);
4419 * A note or two on object names.
4420 * * If the object name is missing, we then make one up in the form objnnn
4422 * * ASCII names are stored in the object header's name field from byte zero
4423 * * Unicode names are historically stored starting from byte zero.
4425 * Then there are automatic Unicode names...
4426 * The purpose of these is to save names in a way that can be read as
4427 * ASCII or Unicode names as appropriate, thus allowing a Unicode and ASCII
4428 * system to share files.
4430 * These automatic unicode are stored slightly differently...
4431 * - If the name can fit in the ASCII character space then they are saved as
4432 * ascii names as per above.
4433 * - If the name needs Unicode then the name is saved in Unicode
4434 * starting at oh->name[1].
4437 static void yaffs_fix_null_name(struct yaffs_obj *obj, YCHAR *name,
4440 /* Create an object name if we could not find one. */
4441 if (strnlen(name, YAFFS_MAX_NAME_LENGTH) == 0) {
4442 YCHAR local_name[20];
4443 YCHAR num_string[20];
4444 YCHAR *x = &num_string[19];
4445 unsigned v = obj->obj_id;
4449 *x = '0' + (v % 10);
4452 /* make up a name */
4453 strcpy(local_name, YAFFS_LOSTNFOUND_PREFIX);
4454 strcat(local_name, x);
4455 strncpy(name, local_name, buffer_size - 1);
4459 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR *name, int buffer_size)
4461 memset(name, 0, buffer_size * sizeof(YCHAR));
4462 yaffs_check_obj_details_loaded(obj);
4463 if (obj->obj_id == YAFFS_OBJECTID_LOSTNFOUND)
4464 strncpy(name, YAFFS_LOSTNFOUND_NAME, buffer_size - 1);
4465 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
4466 else if (obj->short_name[0])
4467 strcpy(name, obj->short_name);
4469 else if (obj->hdr_chunk > 0) {
4471 u8 *buffer = yaffs_get_temp_buffer(obj->my_dev, __LINE__);
4473 struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)buffer;
4475 memset(buffer, 0, obj->my_dev->data_bytes_per_chunk);
4477 if (obj->hdr_chunk > 0) {
4478 result = yaffs_rd_chunk_tags_nand(obj->my_dev,
4482 yaffs_load_name_from_oh(obj->my_dev, name, oh->name,
4485 yaffs_release_temp_buffer(obj->my_dev, buffer, __LINE__);
4488 yaffs_fix_null_name(obj, name, buffer_size);
4490 return strnlen(name, YAFFS_MAX_NAME_LENGTH);
4493 int yaffs_get_obj_length(struct yaffs_obj *obj)
4495 /* Dereference any hard linking */
4496 obj = yaffs_get_equivalent_obj(obj);
4498 if (obj->variant_type == YAFFS_OBJECT_TYPE_FILE)
4499 return obj->variant.file_variant.file_size;
4500 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
4501 if (!obj->variant.symlink_variant.alias)
4503 return strnlen(obj->variant.symlink_variant.alias,
4504 YAFFS_MAX_ALIAS_LENGTH);
4506 /* Only a directory should drop through to here */
4507 return obj->my_dev->data_bytes_per_chunk;
4511 int yaffs_get_obj_link_count(struct yaffs_obj *obj)
4514 struct list_head *i;
4517 count++; /* the object itself */
4519 list_for_each(i, &obj->hard_links)
4520 count++; /* add the hard links; */
4525 int yaffs_get_obj_inode(struct yaffs_obj *obj)
4527 obj = yaffs_get_equivalent_obj(obj);
4532 unsigned yaffs_get_obj_type(struct yaffs_obj *obj)
4534 obj = yaffs_get_equivalent_obj(obj);
4536 switch (obj->variant_type) {
4537 case YAFFS_OBJECT_TYPE_FILE:
4540 case YAFFS_OBJECT_TYPE_DIRECTORY:
4543 case YAFFS_OBJECT_TYPE_SYMLINK:
4546 case YAFFS_OBJECT_TYPE_HARDLINK:
4549 case YAFFS_OBJECT_TYPE_SPECIAL:
4550 if (S_ISFIFO(obj->yst_mode))
4552 if (S_ISCHR(obj->yst_mode))
4554 if (S_ISBLK(obj->yst_mode))
4556 if (S_ISSOCK(obj->yst_mode))
4566 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj)
4568 obj = yaffs_get_equivalent_obj(obj);
4569 if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK)
4570 return yaffs_clone_str(obj->variant.symlink_variant.alias);
4572 return yaffs_clone_str(_Y(""));
4575 /*--------------------------- Initialisation code -------------------------- */
4577 static int yaffs_check_dev_fns(const struct yaffs_dev *dev)
4579 /* Common functions, gotta have */
4580 if (!dev->param.erase_fn || !dev->param.initialise_flash_fn)
4583 #ifdef CONFIG_YAFFS_YAFFS2
4585 /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
4586 if (dev->param.write_chunk_tags_fn &&
4587 dev->param.read_chunk_tags_fn &&
4588 !dev->param.write_chunk_fn &&
4589 !dev->param.read_chunk_fn &&
4590 dev->param.bad_block_fn && dev->param.query_block_fn)
4594 /* Can use the "spare" style interface for yaffs1 */
4595 if (!dev->param.is_yaffs2 &&
4596 !dev->param.write_chunk_tags_fn &&
4597 !dev->param.read_chunk_tags_fn &&
4598 dev->param.write_chunk_fn &&
4599 dev->param.read_chunk_fn &&
4600 !dev->param.bad_block_fn && !dev->param.query_block_fn)
4606 static int yaffs_create_initial_dir(struct yaffs_dev *dev)
4608 /* Initialise the unlinked, deleted, root and lost+found directories */
4609 dev->lost_n_found = dev->root_dir = NULL;
4610 dev->unlinked_dir = dev->del_dir = NULL;
4612 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
4614 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
4616 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_ROOT,
4617 YAFFS_ROOT_MODE | S_IFDIR);
4619 yaffs_create_fake_dir(dev, YAFFS_OBJECTID_LOSTNFOUND,
4620 YAFFS_LOSTNFOUND_MODE | S_IFDIR);
4622 if (dev->lost_n_found && dev->root_dir && dev->unlinked_dir
4624 yaffs_add_obj_to_dir(dev->root_dir, dev->lost_n_found);
4630 int yaffs_guts_initialise(struct yaffs_dev *dev)
4632 int init_failed = 0;
4636 yaffs_trace(YAFFS_TRACE_TRACING, "yaffs: yaffs_guts_initialise()");
4638 /* Check stuff that must be set */
4641 yaffs_trace(YAFFS_TRACE_ALWAYS,
4642 "yaffs: Need a device"
4647 dev->internal_start_block = dev->param.start_block;
4648 dev->internal_end_block = dev->param.end_block;
4649 dev->block_offset = 0;
4650 dev->chunk_offset = 0;
4651 dev->n_free_chunks = 0;
4655 if (dev->param.start_block == 0) {
4656 dev->internal_start_block = dev->param.start_block + 1;
4657 dev->internal_end_block = dev->param.end_block + 1;
4658 dev->block_offset = 1;
4659 dev->chunk_offset = dev->param.chunks_per_block;
4662 /* Check geometry parameters. */
4664 if ((!dev->param.inband_tags && dev->param.is_yaffs2 &&
4665 dev->param.total_bytes_per_chunk < 1024) ||
4666 (!dev->param.is_yaffs2 &&
4667 dev->param.total_bytes_per_chunk < 512) ||
4668 (dev->param.inband_tags && !dev->param.is_yaffs2) ||
4669 dev->param.chunks_per_block < 2 ||
4670 dev->param.n_reserved_blocks < 2 ||
4671 dev->internal_start_block <= 0 ||
4672 dev->internal_end_block <= 0 ||
4673 dev->internal_end_block <=
4674 (dev->internal_start_block + dev->param.n_reserved_blocks + 2)
4676 /* otherwise it is too small */
4677 yaffs_trace(YAFFS_TRACE_ALWAYS,
4678 "NAND geometry problems: chunk size %d, type is yaffs%s, inband_tags %d ",
4679 dev->param.total_bytes_per_chunk,
4680 dev->param.is_yaffs2 ? "2" : "",
4681 dev->param.inband_tags);
4685 if (yaffs_init_nand(dev) != YAFFS_OK) {
4686 yaffs_trace(YAFFS_TRACE_ALWAYS, "InitialiseNAND failed");
4690 /* Sort out space for inband tags, if required */
4691 if (dev->param.inband_tags)
4692 dev->data_bytes_per_chunk =
4693 dev->param.total_bytes_per_chunk -
4694 sizeof(struct yaffs_packed_tags2_tags_only);
4696 dev->data_bytes_per_chunk = dev->param.total_bytes_per_chunk;
4698 /* Got the right mix of functions? */
4699 if (!yaffs_check_dev_fns(dev)) {
4700 /* Function missing */
4701 yaffs_trace(YAFFS_TRACE_ALWAYS,
4702 "device function(s) missing or wrong");
4707 if (dev->is_mounted) {
4708 yaffs_trace(YAFFS_TRACE_ALWAYS, "device already mounted");
4712 /* Finished with most checks. Further checks happen later on too. */
4714 dev->is_mounted = 1;
4716 /* OK now calculate a few things for the device */
4719 * Calculate all the chunk size manipulation numbers:
4721 x = dev->data_bytes_per_chunk;
4722 /* We always use dev->chunk_shift and dev->chunk_div */
4723 dev->chunk_shift = calc_shifts(x);
4724 x >>= dev->chunk_shift;
4726 /* We only use chunk mask if chunk_div is 1 */
4727 dev->chunk_mask = (1 << dev->chunk_shift) - 1;
4730 * Calculate chunk_grp_bits.
4731 * We need to find the next power of 2 > than internal_end_block
4734 x = dev->param.chunks_per_block * (dev->internal_end_block + 1);
4736 bits = calc_shifts_ceiling(x);
4738 /* Set up tnode width if wide tnodes are enabled. */
4739 if (!dev->param.wide_tnodes_disabled) {
4740 /* bits must be even so that we end up with 32-bit words */
4744 dev->tnode_width = 16;
4746 dev->tnode_width = bits;
4748 dev->tnode_width = 16;
4751 dev->tnode_mask = (1 << dev->tnode_width) - 1;
4753 /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
4754 * so if the bitwidth of the
4755 * chunk range we're using is greater than 16 we need
4756 * to figure out chunk shift and chunk_grp_size
4759 if (bits <= dev->tnode_width)
4760 dev->chunk_grp_bits = 0;
4762 dev->chunk_grp_bits = bits - dev->tnode_width;
4764 dev->tnode_size = (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8;
4765 if (dev->tnode_size < sizeof(struct yaffs_tnode))
4766 dev->tnode_size = sizeof(struct yaffs_tnode);
4768 dev->chunk_grp_size = 1 << dev->chunk_grp_bits;
4770 if (dev->param.chunks_per_block < dev->chunk_grp_size) {
4771 /* We have a problem because the soft delete won't work if
4772 * the chunk group size > chunks per block.
4773 * This can be remedied by using larger "virtual blocks".
4775 yaffs_trace(YAFFS_TRACE_ALWAYS, "chunk group too large");
4780 /* Finished verifying the device, continue with initialisation */
4782 /* More device initialisation */
4784 dev->passive_gc_count = 0;
4785 dev->oldest_dirty_gc_count = 0;
4787 dev->gc_block_finder = 0;
4788 dev->buffered_block = -1;
4789 dev->doing_buffered_block_rewrite = 0;
4790 dev->n_deleted_files = 0;
4791 dev->n_bg_deletions = 0;
4792 dev->n_unlinked_files = 0;
4793 dev->n_ecc_fixed = 0;
4794 dev->n_ecc_unfixed = 0;
4795 dev->n_tags_ecc_fixed = 0;
4796 dev->n_tags_ecc_unfixed = 0;
4797 dev->n_erase_failures = 0;
4798 dev->n_erased_blocks = 0;
4799 dev->gc_disable = 0;
4800 dev->has_pending_prioritised_gc = 1;
4801 /* Assume the worst for now, will get fixed on first GC */
4802 INIT_LIST_HEAD(&dev->dirty_dirs);
4803 dev->oldest_dirty_seq = 0;
4804 dev->oldest_dirty_block = 0;
4806 /* Initialise temporary buffers and caches. */
4807 if (!yaffs_init_tmp_buffers(dev))
4811 dev->gc_cleanup_list = NULL;
4813 if (!init_failed && dev->param.n_caches > 0) {
4817 dev->param.n_caches * sizeof(struct yaffs_cache);
4819 if (dev->param.n_caches > YAFFS_MAX_SHORT_OP_CACHES)
4820 dev->param.n_caches = YAFFS_MAX_SHORT_OP_CACHES;
4822 dev->cache = kmalloc(cache_bytes, GFP_NOFS);
4824 buf = (u8 *) dev->cache;
4827 memset(dev->cache, 0, cache_bytes);
4829 for (i = 0; i < dev->param.n_caches && buf; i++) {
4830 dev->cache[i].object = NULL;
4831 dev->cache[i].last_use = 0;
4832 dev->cache[i].dirty = 0;
4833 dev->cache[i].data = buf =
4834 kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
4839 dev->cache_last_use = 0;
4842 dev->cache_hits = 0;
4845 dev->gc_cleanup_list =
4846 kmalloc(dev->param.chunks_per_block * sizeof(u32),
4848 if (!dev->gc_cleanup_list)
4852 if (dev->param.is_yaffs2)
4853 dev->param.use_header_file_size = 1;
4855 if (!init_failed && !yaffs_init_blocks(dev))
4858 yaffs_init_tnodes_and_objs(dev);
4860 if (!init_failed && !yaffs_create_initial_dir(dev))
4864 /* Now scan the flash. */
4865 if (dev->param.is_yaffs2) {
4866 if (yaffs2_checkpt_restore(dev)) {
4867 yaffs_check_obj_details_loaded(dev->root_dir);
4868 yaffs_trace(YAFFS_TRACE_CHECKPOINT |
4870 "yaffs: restored from checkpoint"
4874 /* Clean up the mess caused by an aborted
4875 * checkpoint load then scan backwards.
4877 yaffs_deinit_blocks(dev);
4879 yaffs_deinit_tnodes_and_objs(dev);
4881 dev->n_erased_blocks = 0;
4882 dev->n_free_chunks = 0;
4883 dev->alloc_block = -1;
4884 dev->alloc_page = -1;
4885 dev->n_deleted_files = 0;
4886 dev->n_unlinked_files = 0;
4887 dev->n_bg_deletions = 0;
4889 if (!init_failed && !yaffs_init_blocks(dev))
4892 yaffs_init_tnodes_and_objs(dev);
4895 && !yaffs_create_initial_dir(dev))
4898 if (!init_failed && !yaffs2_scan_backwards(dev))
4901 } else if (!yaffs1_scan(dev)) {
4905 yaffs_strip_deleted_objs(dev);
4906 yaffs_fix_hanging_objs(dev);
4907 if (dev->param.empty_lost_n_found)
4908 yaffs_empty_l_n_f(dev);
4912 /* Clean up the mess */
4913 yaffs_trace(YAFFS_TRACE_TRACING,
4914 "yaffs: yaffs_guts_initialise() aborted.");
4916 yaffs_deinitialise(dev);
4920 /* Zero out stats */
4921 dev->n_page_reads = 0;
4922 dev->n_page_writes = 0;
4923 dev->n_erasures = 0;
4924 dev->n_gc_copies = 0;
4925 dev->n_retired_writes = 0;
4927 dev->n_retired_blocks = 0;
4929 yaffs_verify_free_chunks(dev);
4930 yaffs_verify_blocks(dev);
4932 /* Clean up any aborted checkpoint data */
4933 if (!dev->is_checkpointed && dev->blocks_in_checkpt > 0)
4934 yaffs2_checkpt_invalidate(dev);
4936 yaffs_trace(YAFFS_TRACE_TRACING,
4937 "yaffs: yaffs_guts_initialise() done.");
4941 void yaffs_deinitialise(struct yaffs_dev *dev)
4943 if (dev->is_mounted) {
4946 yaffs_deinit_blocks(dev);
4947 yaffs_deinit_tnodes_and_objs(dev);
4948 if (dev->param.n_caches > 0 && dev->cache) {
4950 for (i = 0; i < dev->param.n_caches; i++) {
4951 kfree(dev->cache[i].data);
4952 dev->cache[i].data = NULL;
4959 kfree(dev->gc_cleanup_list);
4961 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
4962 kfree(dev->temp_buffer[i].buffer);
4964 dev->is_mounted = 0;
4966 if (dev->param.deinitialise_flash_fn)
4967 dev->param.deinitialise_flash_fn(dev);
4971 int yaffs_count_free_chunks(struct yaffs_dev *dev)
4975 struct yaffs_block_info *blk;
4977 blk = dev->block_info;
4978 for (b = dev->internal_start_block; b <= dev->internal_end_block; b++) {
4979 switch (blk->block_state) {
4980 case YAFFS_BLOCK_STATE_EMPTY:
4981 case YAFFS_BLOCK_STATE_ALLOCATING:
4982 case YAFFS_BLOCK_STATE_COLLECTING:
4983 case YAFFS_BLOCK_STATE_FULL:
4985 (dev->param.chunks_per_block - blk->pages_in_use +
4986 blk->soft_del_pages);
4996 int yaffs_get_n_free_chunks(struct yaffs_dev *dev)
4998 /* This is what we report to the outside world */
5001 int blocks_for_checkpt;
5004 n_free = dev->n_free_chunks;
5005 n_free += dev->n_deleted_files;
5007 /* Now count and subtract the number of dirty chunks in the cache. */
5009 for (n_dirty_caches = 0, i = 0; i < dev->param.n_caches; i++) {
5010 if (dev->cache[i].dirty)
5014 n_free -= n_dirty_caches;
5017 ((dev->param.n_reserved_blocks + 1) * dev->param.chunks_per_block);
5019 /* Now figure checkpoint space and report that... */
5020 blocks_for_checkpt = yaffs_calc_checkpt_blocks_required(dev);
5022 n_free -= (blocks_for_checkpt * dev->param.chunks_per_block);