yaffs_guts.c

   1 /*
   2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2011 Aleph One Ltd.
   5  *   for Toby Churchill Ltd and Brightstar Engineering
   6  *
   7  * Created by Charles Manning <charles@aleph1.co.uk>
   8  *
   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.
  12  */
  13
  14 #include "yportenv.h"
  15 #include "yaffs_trace.h"
  16
  17 #include "yaffs_guts.h"
  18 #include "yaffs_getblockinfo.h"
  19 #include "yaffs_tagscompat.h"
  20 #include "yaffs_nand.h"
  21 #include "yaffs_yaffs1.h"
  22 #include "yaffs_yaffs2.h"
  23 #include "yaffs_bitmap.h"
  24 #include "yaffs_verify.h"
  25 #include "yaffs_nand.h"
  26 #include "yaffs_packedtags2.h"
  27 #include "yaffs_nameval.h"
  28 #include "yaffs_allocator.h"
  29 #include "yaffs_attribs.h"
  30 #include "yaffs_summary.h"
  31
  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
  35
  36 #include "yaffs_ecc.h"
  37
  38 /* Forward declarations */
  39
  40 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
  41                              const u8 *buffer, int n_bytes, int use_reserve);
  42
  43
  44
  45 /* Function to calculate chunk and offset */
  46
  47 static inline void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
  48                                         int *chunk_out, u32 *offset_out)
  49 {
  50         int chunk;
  51         u32 offset;
  52
  53         chunk = (u32) (addr >> dev->chunk_shift);
  54
  55         if (dev->chunk_div == 1) {
  56                 /* easy power of 2 case */
  57                 offset = (u32) (addr & dev->chunk_mask);
  58         } else {
  59                 /* Non power-of-2 case */
  60
  61                 loff_t chunk_base;
  62
  63                 chunk /= dev->chunk_div;
  64
  65                 chunk_base = ((loff_t) chunk) * dev->data_bytes_per_chunk;
  66                 offset = (u32) (addr - chunk_base);
  67         }
  68
  69         *chunk_out = chunk;
  70         *offset_out = offset;
  71 }
  72
  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.
  77  */
  78
  79 static inline u32 calc_shifts_ceiling(u32 x)
  80 {
  81         int extra_bits;
  82         int shifts;
  83
  84         shifts = extra_bits = 0;
  85
  86         while (x > 1) {
  87                 if (x & 1)
  88                         extra_bits++;
  89                 x >>= 1;
  90                 shifts++;
  91         }
  92
  93         if (extra_bits)
  94                 shifts++;
  95
  96         return shifts;
  97 }
  98
  99 /* Function to return the number of shifts to get a 1 in bit 0
 100  */
 101
 102 static inline u32 calc_shifts(u32 x)
 103 {
 104         u32 shifts;
 105
 106         shifts = 0;
 107
 108         if (!x)
 109                 return 0;
 110
 111         while (!(x & 1)) {
 112                 x >>= 1;
 113                 shifts++;
 114         }
 115
 116         return shifts;
 117 }
 118
 119 /*
 120  * Temporary buffer manipulations.
 121  */
 122
 123 static int yaffs_init_tmp_buffers(struct yaffs_dev *dev)
 124 {
 125         int i;
 126         u8 *buf = (u8 *) 1;
 127
 128         memset(dev->temp_buffer, 0, sizeof(dev->temp_buffer));
 129
 130         for (i = 0; buf && i < YAFFS_N_TEMP_BUFFERS; i++) {
 131                 dev->temp_buffer[i].in_use = 0;
 132                 buf = kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
 133                 dev->temp_buffer[i].buffer = buf;
 134         }
 135
 136         return buf ? YAFFS_OK : YAFFS_FAIL;
 137 }
 138
 139 u8 *yaffs_get_temp_buffer(struct yaffs_dev * dev)
 140 {
 141         int i;
 142
 143         dev->temp_in_use++;
 144         if (dev->temp_in_use > dev->max_temp)
 145                 dev->max_temp = dev->temp_in_use;
 146
 147         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 148                 if (dev->temp_buffer[i].in_use == 0) {
 149                         dev->temp_buffer[i].in_use = 1;
 150                         return dev->temp_buffer[i].buffer;
 151                 }
 152         }
 153
 154         yaffs_trace(YAFFS_TRACE_BUFFERS, "Out of temp buffers");
 155         /*
 156          * If we got here then we have to allocate an unmanaged one
 157          * This is not good.
 158          */
 159
 160         dev->unmanaged_buffer_allocs++;
 161         return kmalloc(dev->data_bytes_per_chunk, GFP_NOFS);
 162
 163 }
 164
 165 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer)
 166 {
 167         int i;
 168
 169         dev->temp_in_use--;
 170
 171         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 172                 if (dev->temp_buffer[i].buffer == buffer) {
 173                         dev->temp_buffer[i].in_use = 0;
 174                         return;
 175                 }
 176         }
 177
 178         if (buffer) {
 179                 /* assume it is an unmanaged one. */
 180                 yaffs_trace(YAFFS_TRACE_BUFFERS, "Releasing unmanaged temp buffer");
 181                 kfree(buffer);
 182                 dev->unmanaged_buffer_deallocs++;
 183         }
 184
 185 }
 186
 187 /*
 188  * Determine if we have a managed buffer.
 189  */
 190 int yaffs_is_managed_tmp_buffer(struct yaffs_dev *dev, const u8 *buffer)
 191 {
 192         int i;
 193
 194         for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++) {
 195                 if (dev->temp_buffer[i].buffer == buffer)
 196                         return 1;
 197         }
 198
 199         for (i = 0; i < dev->param.n_caches; i++) {
 200                 if (dev->cache[i].data == buffer)
 201                         return 1;
 202         }
 203
 204         if (buffer == dev->checkpt_buffer)
 205                 return 1;
 206
 207         yaffs_trace(YAFFS_TRACE_ALWAYS,
 208           "yaffs: unmaged buffer detected.");
 209         return 0;
 210 }
 211
 212 /*
 213  * Functions for robustisizing TODO
 214  *
 215  */
 216
 217 static void yaffs_handle_chunk_wr_ok(struct yaffs_dev *dev, int nand_chunk,
 218                                      const u8 *data,
 219                                      const struct yaffs_ext_tags *tags)
 220 {
 221         dev = dev;
 222         nand_chunk = nand_chunk;
 223         data = data;
 224         tags = tags;
 225 }
 226
 227 static void yaffs_handle_chunk_update(struct yaffs_dev *dev, int nand_chunk,
 228                                       const struct yaffs_ext_tags *tags)
 229 {
 230         dev = dev;
 231         nand_chunk = nand_chunk;
 232         tags = tags;
 233 }
 234
 235 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
 236                               struct yaffs_block_info *bi)
 237 {
 238         if (!bi->gc_prioritise) {
 239                 bi->gc_prioritise = 1;
 240                 dev->has_pending_prioritised_gc = 1;
 241                 bi->chunk_error_strikes++;
 242
 243                 if (bi->chunk_error_strikes > 3) {
 244                         bi->needs_retiring = 1; /* Too many stikes, so retire */
 245                         yaffs_trace(YAFFS_TRACE_ALWAYS,
 246                                 "yaffs: Block struck out");
 247
 248                 }
 249         }
 250 }
 251
 252 static void yaffs_handle_chunk_wr_error(struct yaffs_dev *dev, int nand_chunk,
 253                                         int erased_ok)
 254 {
 255         int flash_block = nand_chunk / dev->param.chunks_per_block;
 256         struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
 257
 258         yaffs_handle_chunk_error(dev, bi);
 259
 260         if (erased_ok) {
 261                 /* Was an actual write failure,
 262                  * so mark the block for retirement.*/
 263                 bi->needs_retiring = 1;
 264                 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
 265                   "**>> Block %d needs retiring", flash_block);
 266         }
 267
 268         /* Delete the chunk */
 269         yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
 270         yaffs_skip_rest_of_block(dev);
 271 }
 272
 273 /*
 274  * Verification code
 275  */
 276
 277 /*
 278  *  Simple hash function. Needs to have a reasonable spread
 279  */
 280
 281 static inline int yaffs_hash_fn(int n)
 282 {
 283         n = abs(n);
 284         return n % YAFFS_NOBJECT_BUCKETS;
 285 }
 286
 287 /*
 288  * Access functions to useful fake objects.
 289  * Note that root might have a presence in NAND if permissions are set.
 290  */
 291
 292 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev)
 293 {
 294         return dev->root_dir;
 295 }
 296
 297 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev)
 298 {
 299         return dev->lost_n_found;
 300 }
 301
 302 /*
 303  *  Erased NAND checking functions
 304  */
 305
 306 int yaffs_check_ff(u8 *buffer, int n_bytes)
 307 {
 308         /* Horrible, slow implementation */
 309         while (n_bytes--) {
 310                 if (*buffer != 0xff)
 311                         return 0;
 312                 buffer++;
 313         }
 314         return 1;
 315 }
 316
 317 static int yaffs_check_chunk_erased(struct yaffs_dev *dev, int nand_chunk)
 318 {
 319         int retval = YAFFS_OK;
 320         u8 *data = yaffs_get_temp_buffer(dev);
 321         struct yaffs_ext_tags tags;
 322         int result;
 323
 324         result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, data, &tags);
 325
 326         if (tags.ecc_result > YAFFS_ECC_RESULT_NO_ERROR)
 327                 retval = YAFFS_FAIL;
 328
 329         if (!yaffs_check_ff(data, dev->data_bytes_per_chunk) ||
 330                 tags.chunk_used) {
 331                 yaffs_trace(YAFFS_TRACE_NANDACCESS,
 332                         "Chunk %d not erased", nand_chunk);
 333                 retval = YAFFS_FAIL;
 334         }
 335
 336         yaffs_release_temp_buffer(dev, data);
 337
 338         return retval;
 339
 340 }
 341
 342 static int yaffs_verify_chunk_written(struct yaffs_dev *dev,
 343                                       int nand_chunk,
 344                                       const u8 *data,
 345                                       struct yaffs_ext_tags *tags)
 346 {
 347         int retval = YAFFS_OK;
 348         struct yaffs_ext_tags temp_tags;
 349         u8 *buffer = yaffs_get_temp_buffer(dev);
 350         int result;
 351
 352         result = yaffs_rd_chunk_tags_nand(dev, nand_chunk, buffer, &temp_tags);
 353         if (memcmp(buffer, data, dev->data_bytes_per_chunk) ||
 354             temp_tags.obj_id != tags->obj_id ||
 355             temp_tags.chunk_id != tags->chunk_id ||
 356             temp_tags.n_bytes != tags->n_bytes)
 357                 retval = YAFFS_FAIL;
 358
 359         yaffs_release_temp_buffer(dev, buffer);
 360
 361         return retval;
 362 }
 363
 364
 365 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks)
 366 {
 367         int reserved_chunks;
 368         int reserved_blocks = dev->param.n_reserved_blocks;
 369         int checkpt_blocks;
 370
 371         checkpt_blocks = yaffs_calc_checkpt_blocks_required(dev);
 372
 373         reserved_chunks =
 374             (reserved_blocks + checkpt_blocks) * dev->param.chunks_per_block;
 375
 376         return (dev->n_free_chunks > (reserved_chunks + n_chunks));
 377 }
 378
 379 static int yaffs_find_alloc_block(struct yaffs_dev *dev)
 380 {
 381         int i;
 382         struct yaffs_block_info *bi;
 383
 384         if (dev->n_erased_blocks < 1) {
 385                 /* Hoosterman we've got a problem.
 386                  * Can't get space to gc
 387                  */
 388                 yaffs_trace(YAFFS_TRACE_ERROR,
 389                   "yaffs tragedy: no more erased blocks");
 390
 391                 return -1;
 392         }
 393
 394         /* Find an empty block. */
 395
 396         for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
 397                 dev->alloc_block_finder++;
 398                 if (dev->alloc_block_finder < dev->internal_start_block
 399                     || dev->alloc_block_finder > dev->internal_end_block) {
 400                         dev->alloc_block_finder = dev->internal_start_block;
 401                 }
 402
 403                 bi = yaffs_get_block_info(dev, dev->alloc_block_finder);
 404
 405                 if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
 406                         bi->block_state = YAFFS_BLOCK_STATE_ALLOCATING;
 407                         dev->seq_number++;
 408                         bi->seq_number = dev->seq_number;
 409                         dev->n_erased_blocks--;
 410                         yaffs_trace(YAFFS_TRACE_ALLOCATE,
 411                           "Allocated block %d, seq  %d, %d left" ,
 412                            dev->alloc_block_finder, dev->seq_number,
 413                            dev->n_erased_blocks);
 414                         return dev->alloc_block_finder;
 415                 }
 416         }
 417
 418         yaffs_trace(YAFFS_TRACE_ALWAYS,
 419                 "yaffs tragedy: no more erased blocks, but there should have been %d",
 420                 dev->n_erased_blocks);
 421
 422         return -1;
 423 }
 424
 425 static int yaffs_alloc_chunk(struct yaffs_dev *dev, int use_reserver,
 426                              struct yaffs_block_info **block_ptr)
 427 {
 428         int ret_val;
 429         struct yaffs_block_info *bi;
 430
 431         if (dev->alloc_block < 0) {
 432                 /* Get next block to allocate off */
 433                 dev->alloc_block = yaffs_find_alloc_block(dev);
 434                 dev->alloc_page = 0;
 435         }
 436
 437         if (!use_reserver && !yaffs_check_alloc_available(dev, 1)) {
 438                 /* No space unless we're allowed to use the reserve. */
 439                 return -1;
 440         }
 441
 442         if (dev->n_erased_blocks < dev->param.n_reserved_blocks
 443             && dev->alloc_page == 0)
 444                 yaffs_trace(YAFFS_TRACE_ALLOCATE, "Allocating reserve");
 445
 446         /* Next page please.... */
 447         if (dev->alloc_block >= 0) {
 448                 bi = yaffs_get_block_info(dev, dev->alloc_block);
 449
 450                 ret_val = (dev->alloc_block * dev->param.chunks_per_block) +
 451                     dev->alloc_page;
 452                 bi->pages_in_use++;
 453                 yaffs_set_chunk_bit(dev, dev->alloc_block, dev->alloc_page);
 454
 455                 dev->alloc_page++;
 456
 457                 dev->n_free_chunks--;
 458
 459                 /* If the block is full set the state to full */
 460                 if (dev->alloc_page >= dev->param.chunks_per_block) {
 461                         bi->block_state = YAFFS_BLOCK_STATE_FULL;
 462                         dev->alloc_block = -1;
 463                 }
 464
 465                 if (block_ptr)
 466                         *block_ptr = bi;
 467
 468                 return ret_val;
 469         }
 470
 471         yaffs_trace(YAFFS_TRACE_ERROR,
 472                 "!!!!!!!!! Allocator out !!!!!!!!!!!!!!!!!");
 473
 474         return -1;
 475 }
 476
 477 static int yaffs_get_erased_chunks(struct yaffs_dev *dev)
 478 {
 479         int n;
 480
 481         n = dev->n_erased_blocks * dev->param.chunks_per_block;
 482
 483         if (dev->alloc_block > 0)
 484                 n += (dev->param.chunks_per_block - dev->alloc_page);
 485
 486         return n;
 487
 488 }
 489
 490 /*
 491  * yaffs_skip_rest_of_block() skips over the rest of the allocation block
 492  * if we don't want to write to it.
 493  */
 494 void yaffs_skip_rest_of_block(struct yaffs_dev *dev)
 495 {
 496         struct yaffs_block_info *bi;
 497
 498         if (dev->alloc_block > 0) {
 499                 bi = yaffs_get_block_info(dev, dev->alloc_block);
 500                 if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING) {
 501                         bi->block_state = YAFFS_BLOCK_STATE_FULL;
 502                         dev->alloc_block = -1;
 503                 }
 504         }
 505 }
 506
 507 static int yaffs_write_new_chunk(struct yaffs_dev *dev,
 508                                  const u8 *data,
 509                                  struct yaffs_ext_tags *tags, int use_reserver)
 510 {
 511         int attempts = 0;
 512         int write_ok = 0;
 513         int chunk;
 514
 515         yaffs2_checkpt_invalidate(dev);
 516
 517         do {
 518                 struct yaffs_block_info *bi = 0;
 519                 int erased_ok = 0;
 520
 521                 chunk = yaffs_alloc_chunk(dev, use_reserver, &bi);
 522                 if (chunk < 0) {
 523                         /* no space */
 524                         break;
 525                 }
 526
 527                 /* First check this chunk is erased, if it needs
 528                  * checking.  The checking policy (unless forced
 529                  * always on) is as follows:
 530                  *
 531                  * Check the first page we try to write in a block.
 532                  * If the check passes then we don't need to check any
 533                  * more.        If the check fails, we check again...
 534                  * If the block has been erased, we don't need to check.
 535                  *
 536                  * However, if the block has been prioritised for gc,
 537                  * then we think there might be something odd about
 538                  * this block and stop using it.
 539                  *
 540                  * Rationale: We should only ever see chunks that have
 541                  * not been erased if there was a partially written
 542                  * chunk due to power loss.  This checking policy should
 543                  * catch that case with very few checks and thus save a
 544                  * lot of checks that are most likely not needed.
 545                  *
 546                  * Mods to the above
 547                  * If an erase check fails or the write fails we skip the
 548                  * rest of the block.
 549                  */
 550
 551                 /* let's give it a try */
 552                 attempts++;
 553
 554                 if (dev->param.always_check_erased)
 555                         bi->skip_erased_check = 0;
 556
 557                 if (!bi->skip_erased_check) {
 558                         erased_ok = yaffs_check_chunk_erased(dev, chunk);
 559                         if (erased_ok != YAFFS_OK) {
 560                                 yaffs_trace(YAFFS_TRACE_ERROR,
 561                                   "**>> yaffs chunk %d was not erased",
 562                                   chunk);
 563
 564                                 /* If not erased, delete this one,
 565                                  * skip rest of block and
 566                                  * try another chunk */
 567                                 yaffs_chunk_del(dev, chunk, 1, __LINE__);
 568                                 yaffs_skip_rest_of_block(dev);
 569                                 continue;
 570                         }
 571                 }
 572
 573                 write_ok = yaffs_wr_chunk_tags_nand(dev, chunk, data, tags);
 574
 575                 if (!bi->skip_erased_check)
 576                         write_ok =
 577                             yaffs_verify_chunk_written(dev, chunk, data, tags);
 578
 579                 if (write_ok != YAFFS_OK) {
 580                         /* Clean up aborted write, skip to next block and
 581                          * try another chunk */
 582                         yaffs_handle_chunk_wr_error(dev, chunk, erased_ok);
 583                         continue;
 584                 }
 585
 586                 bi->skip_erased_check = 1;
 587
 588                 /* Copy the data into the robustification buffer */
 589                 yaffs_handle_chunk_wr_ok(dev, chunk, data, tags);
 590
 591         } while (write_ok != YAFFS_OK &&
 592                  (yaffs_wr_attempts <= 0 || attempts <= yaffs_wr_attempts));
 593
 594         if (!write_ok)
 595                 chunk = -1;
 596
 597         if (attempts > 1) {
 598                 yaffs_trace(YAFFS_TRACE_ERROR,
 599                         "**>> yaffs write required %d attempts",
 600                         attempts);
 601                 dev->n_retried_writes += (attempts - 1);
 602         }
 603
 604         return chunk;
 605 }
 606
 607 /*
 608  * Block retiring for handling a broken block.
 609  */
 610
 611 static void yaffs_retire_block(struct yaffs_dev *dev, int flash_block)
 612 {
 613         struct yaffs_block_info *bi = yaffs_get_block_info(dev, flash_block);
 614
 615         yaffs2_checkpt_invalidate(dev);
 616
 617         yaffs2_clear_oldest_dirty_seq(dev, bi);
 618
 619         if (yaffs_mark_bad(dev, flash_block) != YAFFS_OK) {
 620                 if (yaffs_erase_block(dev, flash_block) != YAFFS_OK) {
 621                         yaffs_trace(YAFFS_TRACE_ALWAYS,
 622                                 "yaffs: Failed to mark bad and erase block %d",
 623                                 flash_block);
 624                 } else {
 625                         struct yaffs_ext_tags tags;
 626                         int chunk_id =
 627                             flash_block * dev->param.chunks_per_block;
 628
 629                         u8 *buffer = yaffs_get_temp_buffer(dev);
 630
 631                         memset(buffer, 0xff, dev->data_bytes_per_chunk);
 632                         memset(&tags, 0, sizeof(tags));
 633                         tags.seq_number = YAFFS_SEQUENCE_BAD_BLOCK;
 634                         if (dev->param.write_chunk_tags_fn(dev, chunk_id -
 635                                                            dev->chunk_offset,
 636                                                            buffer,
 637                                                            &tags) != YAFFS_OK)
 638                                 yaffs_trace(YAFFS_TRACE_ALWAYS,
 639                                         "yaffs: Failed to write bad block marker to block %d",
 640                                         flash_block);
 641
 642                         yaffs_release_temp_buffer(dev, buffer);
 643                 }
 644         }
 645
 646         bi->block_state = YAFFS_BLOCK_STATE_DEAD;
 647         bi->gc_prioritise = 0;
 648         bi->needs_retiring = 0;
 649
 650         dev->n_retired_blocks++;
 651 }
 652
 653 /*---------------- Name handling functions ------------*/
 654
 655 static u16 yaffs_calc_name_sum(const YCHAR *name)
 656 {
 657         u16 sum = 0;
 658         u16 i = 1;
 659
 660         if (!name)
 661                 return 0;
 662
 663         while ((*name) && i < (YAFFS_MAX_NAME_LENGTH / 2)) {
 664
 665                 /* 0x1f mask is case insensitive */
 666                 sum += ((*name) & 0x1f) * i;
 667                 i++;
 668                 name++;
 669         }
 670         return sum;
 671 }
 672
 673 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR * name)
 674 {
 675         memset(obj->short_name, 0, sizeof(obj->short_name));
 676         if (name &&
 677                 strnlen(name, YAFFS_SHORT_NAME_LENGTH + 1) <=
 678                 YAFFS_SHORT_NAME_LENGTH)
 679                 strcpy(obj->short_name, name);
 680         else
 681                 obj->short_name[0] = _Y('\0');
 682         obj->sum = yaffs_calc_name_sum(name);
 683 }
 684
 685 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
 686                                 const struct yaffs_obj_hdr *oh)
 687 {
 688 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 689         YCHAR tmp_name[YAFFS_MAX_NAME_LENGTH + 1];
 690         memset(tmp_name, 0, sizeof(tmp_name));
 691         yaffs_load_name_from_oh(obj->my_dev, tmp_name, oh->name,
 692                                 YAFFS_MAX_NAME_LENGTH + 1);
 693         yaffs_set_obj_name(obj, tmp_name);
 694 #else
 695         yaffs_set_obj_name(obj, oh->name);
 696 #endif
 697 }
 698
 699 /*-------------------- TNODES -------------------
 700
 701  * List of spare tnodes
 702  * The list is hooked together using the first pointer
 703  * in the tnode.
 704  */
 705
 706 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev)
 707 {
 708         struct yaffs_tnode *tn = yaffs_alloc_raw_tnode(dev);
 709
 710         if (tn) {
 711                 memset(tn, 0, dev->tnode_size);
 712                 dev->n_tnodes++;
 713         }
 714
 715         dev->checkpoint_blocks_required = 0;    /* force recalculation */
 716
 717         return tn;
 718 }
 719
 720 /* FreeTnode frees up a tnode and puts it back on the free list */
 721 static void yaffs_free_tnode(struct yaffs_dev *dev, struct yaffs_tnode *tn)
 722 {
 723         yaffs_free_raw_tnode(dev, tn);
 724         dev->n_tnodes--;
 725         dev->checkpoint_blocks_required = 0;    /* force recalculation */
 726 }
 727
 728 static void yaffs_deinit_tnodes_and_objs(struct yaffs_dev *dev)
 729 {
 730         yaffs_deinit_raw_tnodes_and_objs(dev);
 731         dev->n_obj = 0;
 732         dev->n_tnodes = 0;
 733 }
 734
 735 void yaffs_load_tnode_0(struct yaffs_dev *dev, struct yaffs_tnode *tn,
 736                         unsigned pos, unsigned val)
 737 {
 738         u32 *map = (u32 *) tn;
 739         u32 bit_in_map;
 740         u32 bit_in_word;
 741         u32 word_in_map;
 742         u32 mask;
 743
 744         pos &= YAFFS_TNODES_LEVEL0_MASK;
 745         val >>= dev->chunk_grp_bits;
 746
 747         bit_in_map = pos * dev->tnode_width;
 748         word_in_map = bit_in_map / 32;
 749         bit_in_word = bit_in_map & (32 - 1);
 750
 751         mask = dev->tnode_mask << bit_in_word;
 752
 753         map[word_in_map] &= ~mask;
 754         map[word_in_map] |= (mask & (val << bit_in_word));
 755
 756         if (dev->tnode_width > (32 - bit_in_word)) {
 757                 bit_in_word = (32 - bit_in_word);
 758                 word_in_map++;
 759                 mask =
 760                     dev->tnode_mask >> bit_in_word;
 761                 map[word_in_map] &= ~mask;
 762                 map[word_in_map] |= (mask & (val >> bit_in_word));
 763         }
 764 }
 765
 766 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
 767                          unsigned pos)
 768 {
 769         u32 *map = (u32 *) tn;
 770         u32 bit_in_map;
 771         u32 bit_in_word;
 772         u32 word_in_map;
 773         u32 val;
 774
 775         pos &= YAFFS_TNODES_LEVEL0_MASK;
 776
 777         bit_in_map = pos * dev->tnode_width;
 778         word_in_map = bit_in_map / 32;
 779         bit_in_word = bit_in_map & (32 - 1);
 780
 781         val = map[word_in_map] >> bit_in_word;
 782
 783         if (dev->tnode_width > (32 - bit_in_word)) {
 784                 bit_in_word = (32 - bit_in_word);
 785                 word_in_map++;
 786                 val |= (map[word_in_map] << bit_in_word);
 787         }
 788
 789         val &= dev->tnode_mask;
 790         val <<= dev->chunk_grp_bits;
 791
 792         return val;
 793 }
 794
 795 /* ------------------- End of individual tnode manipulation -----------------*/
 796
 797 /* ---------Functions to manipulate the look-up tree (made up of tnodes) ------
 798  * The look up tree is represented by the top tnode and the number of top_level
 799  * in the tree. 0 means only the level 0 tnode is in the tree.
 800  */
 801
 802 /* FindLevel0Tnode finds the level 0 tnode, if one exists. */
 803 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
 804                                        struct yaffs_file_var *file_struct,
 805                                        u32 chunk_id)
 806 {
 807         struct yaffs_tnode *tn = file_struct->top;
 808         u32 i;
 809         int required_depth;
 810         int level = file_struct->top_level;
 811
 812         dev = dev;
 813
 814         /* Check sane level and chunk Id */
 815         if (level < 0 || level > YAFFS_TNODES_MAX_LEVEL)
 816                 return NULL;
 817
 818         if (chunk_id > YAFFS_MAX_CHUNK_ID)
 819                 return NULL;
 820
 821         /* First check we're tall enough (ie enough top_level) */
 822
 823         i = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
 824         required_depth = 0;
 825         while (i) {
 826                 i >>= YAFFS_TNODES_INTERNAL_BITS;
 827                 required_depth++;
 828         }
 829
 830         if (required_depth > file_struct->top_level)
 831                 return NULL;    /* Not tall enough, so we can't find it */
 832
 833         /* Traverse down to level 0 */
 834         while (level > 0 && tn) {
 835                 tn = tn->internal[(chunk_id >>
 836                                    (YAFFS_TNODES_LEVEL0_BITS +
 837                                     (level - 1) *
 838                                     YAFFS_TNODES_INTERNAL_BITS)) &
 839                                   YAFFS_TNODES_INTERNAL_MASK];
 840                 level--;
 841         }
 842
 843         return tn;
 844 }
 845
 846 /* add_find_tnode_0 finds the level 0 tnode if it exists,
 847  * otherwise first expands the tree.
 848  * This happens in two steps:
 849  *  1. If the tree isn't tall enough, then make it taller.
 850  *  2. Scan down the tree towards the level 0 tnode adding tnodes if required.
 851  *
 852  * Used when modifying the tree.
 853  *
 854  *  If the tn argument is NULL, then a fresh tnode will be added otherwise the
 855  *  specified tn will be plugged into the ttree.
 856  */
 857
 858 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
 859                                            struct yaffs_file_var *file_struct,
 860                                            u32 chunk_id,
 861                                            struct yaffs_tnode *passed_tn)
 862 {
 863         int required_depth;
 864         int i;
 865         int l;
 866         struct yaffs_tnode *tn;
 867         u32 x;
 868
 869         /* Check sane level and page Id */
 870         if (file_struct->top_level < 0 ||
 871             file_struct->top_level > YAFFS_TNODES_MAX_LEVEL)
 872                 return NULL;
 873
 874         if (chunk_id > YAFFS_MAX_CHUNK_ID)
 875                 return NULL;
 876
 877         /* First check we're tall enough (ie enough top_level) */
 878
 879         x = chunk_id >> YAFFS_TNODES_LEVEL0_BITS;
 880         required_depth = 0;
 881         while (x) {
 882                 x >>= YAFFS_TNODES_INTERNAL_BITS;
 883                 required_depth++;
 884         }
 885
 886         if (required_depth > file_struct->top_level) {
 887                 /* Not tall enough, gotta make the tree taller */
 888                 for (i = file_struct->top_level; i < required_depth; i++) {
 889
 890                         tn = yaffs_get_tnode(dev);
 891
 892                         if (tn) {
 893                                 tn->internal[0] = file_struct->top;
 894                                 file_struct->top = tn;
 895                                 file_struct->top_level++;
 896                         } else {
 897                                 yaffs_trace(YAFFS_TRACE_ERROR,
 898                                         "yaffs: no more tnodes");
 899                                 return NULL;
 900                         }
 901                 }
 902         }
 903
 904         /* Traverse down to level 0, adding anything we need */
 905
 906         l = file_struct->top_level;
 907         tn = file_struct->top;
 908
 909         if (l > 0) {
 910                 while (l > 0 && tn) {
 911                         x = (chunk_id >>
 912                              (YAFFS_TNODES_LEVEL0_BITS +
 913                               (l - 1) * YAFFS_TNODES_INTERNAL_BITS)) &
 914                             YAFFS_TNODES_INTERNAL_MASK;
 915
 916                         if ((l > 1) && !tn->internal[x]) {
 917                                 /* Add missing non-level-zero tnode */
 918                                 tn->internal[x] = yaffs_get_tnode(dev);
 919                                 if (!tn->internal[x])
 920                                         return NULL;
 921                         } else if (l == 1) {
 922                                 /* Looking from level 1 at level 0 */
 923                                 if (passed_tn) {
 924                                         /* If we already have one, release it */
 925                                         if (tn->internal[x])
 926                                                 yaffs_free_tnode(dev,
 927                                                         tn->internal[x]);
 928                                         tn->internal[x] = passed_tn;
 929
 930                                 } else if (!tn->internal[x]) {
 931                                         /* Don't have one, none passed in */
 932                                         tn->internal[x] = yaffs_get_tnode(dev);
 933                                         if (!tn->internal[x])
 934                                                 return NULL;
 935                                 }
 936                         }
 937
 938                         tn = tn->internal[x];
 939                         l--;
 940                 }
 941         } else {
 942                 /* top is level 0 */
 943                 if (passed_tn) {
 944                         memcpy(tn, passed_tn,
 945                                (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8);
 946                         yaffs_free_tnode(dev, passed_tn);
 947                 }
 948         }
 949
 950         return tn;
 951 }
 952
 953 static int yaffs_tags_match(const struct yaffs_ext_tags *tags, int obj_id,
 954                             int chunk_obj)
 955 {
 956         return (tags->chunk_id == chunk_obj &&
 957                 tags->obj_id == obj_id &&
 958                 !tags->is_deleted) ? 1 : 0;
 959
 960 }
 961
 962 static int yaffs_find_chunk_in_group(struct yaffs_dev *dev, int the_chunk,
 963                                         struct yaffs_ext_tags *tags, int obj_id,
 964                                         int inode_chunk)
 965 {
 966         int j;
 967
 968         for (j = 0; the_chunk && j < dev->chunk_grp_size; j++) {
 969                 if (yaffs_check_chunk_bit
 970                     (dev, the_chunk / dev->param.chunks_per_block,
 971                      the_chunk % dev->param.chunks_per_block)) {
 972
 973                         if (dev->chunk_grp_size == 1)
 974                                 return the_chunk;
 975                         else {
 976                                 yaffs_rd_chunk_tags_nand(dev, the_chunk, NULL,
 977                                                          tags);
 978                                 if (yaffs_tags_match(tags,
 979                                                         obj_id, inode_chunk)) {
 980                                         /* found it; */
 981                                         return the_chunk;
 982                                 }
 983                         }
 984                 }
 985                 the_chunk++;
 986         }
 987         return -1;
 988 }
 989
 990 static int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
 991                                     struct yaffs_ext_tags *tags)
 992 {
 993         /*Get the Tnode, then get the level 0 offset chunk offset */
 994         struct yaffs_tnode *tn;
 995         int the_chunk = -1;
 996         struct yaffs_ext_tags local_tags;
 997         int ret_val = -1;
 998         struct yaffs_dev *dev = in->my_dev;
 999
1000         if (!tags) {
1001                 /* Passed a NULL, so use our own tags space */
1002                 tags = &local_tags;
1003         }
1004
1005         tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1006
1007         if (!tn)
1008                 return ret_val;
1009
1010         the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1011
1012         ret_val = yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1013                                               inode_chunk);
1014         return ret_val;
1015 }
1016
1017 static int yaffs_find_del_file_chunk(struct yaffs_obj *in, int inode_chunk,
1018                                      struct yaffs_ext_tags *tags)
1019 {
1020         /* Get the Tnode, then get the level 0 offset chunk offset */
1021         struct yaffs_tnode *tn;
1022         int the_chunk = -1;
1023         struct yaffs_ext_tags local_tags;
1024         struct yaffs_dev *dev = in->my_dev;
1025         int ret_val = -1;
1026
1027         if (!tags) {
1028                 /* Passed a NULL, so use our own tags space */
1029                 tags = &local_tags;
1030         }
1031
1032         tn = yaffs_find_tnode_0(dev, &in->variant.file_variant, inode_chunk);
1033
1034         if (!tn)
1035                 return ret_val;
1036
1037         the_chunk = yaffs_get_group_base(dev, tn, inode_chunk);
1038
1039         ret_val = yaffs_find_chunk_in_group(dev, the_chunk, tags, in->obj_id,
1040                                               inode_chunk);
1041
1042         /* Delete the entry in the filestructure (if found) */
1043         if (ret_val != -1)
1044                 yaffs_load_tnode_0(dev, tn, inode_chunk, 0);
1045
1046         return ret_val;
1047 }
1048
1049 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1050                             int nand_chunk, int in_scan)
1051 {
1052         /* NB in_scan is zero unless scanning.
1053          * For forward scanning, in_scan is > 0;
1054          * for backward scanning in_scan is < 0
1055          *
1056          * nand_chunk = 0 is a dummy insert to make sure the tnodes are there.
1057          */
1058
1059         struct yaffs_tnode *tn;
1060         struct yaffs_dev *dev = in->my_dev;
1061         int existing_cunk;
1062         struct yaffs_ext_tags existing_tags;
1063         struct yaffs_ext_tags new_tags;
1064         unsigned existing_serial, new_serial;
1065
1066         if (in->variant_type != YAFFS_OBJECT_TYPE_FILE) {
1067                 /* Just ignore an attempt at putting a chunk into a non-file
1068                  * during scanning.
1069                  * If it is not during Scanning then something went wrong!
1070                  */
1071                 if (!in_scan) {
1072                         yaffs_trace(YAFFS_TRACE_ERROR,
1073                                 "yaffs tragedy:attempt to put data chunk into a non-file"
1074                                 );
1075                         BUG();
1076                 }
1077
1078                 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1079                 return YAFFS_OK;
1080         }
1081
1082         tn = yaffs_add_find_tnode_0(dev,
1083                                     &in->variant.file_variant,
1084                                     inode_chunk, NULL);
1085         if (!tn)
1086                 return YAFFS_FAIL;
1087
1088         if (!nand_chunk)
1089                 /* Dummy insert, bail now */
1090                 return YAFFS_OK;
1091
1092         existing_cunk = yaffs_get_group_base(dev, tn, inode_chunk);
1093
1094         if (in_scan != 0) {
1095                 /* If we're scanning then we need to test for duplicates
1096                  * NB This does not need to be efficient since it should only
1097                  * happen when the power fails during a write, then only one
1098                  * chunk should ever be affected.
1099                  *
1100                  * Correction for YAFFS2: This could happen quite a lot and we
1101                  * need to think about efficiency! TODO
1102                  * Update: For backward scanning we don't need to re-read tags
1103                  * so this is quite cheap.
1104                  */
1105
1106                 if (existing_cunk > 0) {
1107                         /* NB Right now existing chunk will not be real
1108                          * chunk_id if the chunk group size > 1
1109                          * thus we have to do a FindChunkInFile to get the
1110                          * real chunk id.
1111                          *
1112                          * We have a duplicate now we need to decide which
1113                          * one to use:
1114                          *
1115                          * Backwards scanning YAFFS2: The old one is what
1116                          * we use, dump the new one.
1117                          * YAFFS1: Get both sets of tags and compare serial
1118                          * numbers.
1119                          */
1120
1121                         if (in_scan > 0) {
1122                                 /* Only do this for forward scanning */
1123                                 yaffs_rd_chunk_tags_nand(dev,
1124                                                          nand_chunk,
1125                                                          NULL, &new_tags);
1126
1127                                 /* Do a proper find */
1128                                 existing_cunk =
1129                                     yaffs_find_chunk_in_file(in, inode_chunk,
1130                                                              &existing_tags);
1131                         }
1132
1133                         if (existing_cunk <= 0) {
1134                                 /*Hoosterman - how did this happen? */
1135
1136                                 yaffs_trace(YAFFS_TRACE_ERROR,
1137                                         "yaffs tragedy: existing chunk < 0 in scan"
1138                                         );
1139
1140                         }
1141
1142                         /* NB The deleted flags should be false, otherwise
1143                          * the chunks will not be loaded during a scan
1144                          */
1145
1146                         if (in_scan > 0) {
1147                                 new_serial = new_tags.serial_number;
1148                                 existing_serial = existing_tags.serial_number;
1149                         }
1150
1151                         if ((in_scan > 0) &&
1152                             (existing_cunk <= 0 ||
1153                              ((existing_serial + 1) & 3) == new_serial)) {
1154                                 /* Forward scanning.
1155                                  * Use new
1156                                  * Delete the old one and drop through to
1157                                  * update the tnode
1158                                  */
1159                                 yaffs_chunk_del(dev, existing_cunk, 1,
1160                                                 __LINE__);
1161                         } else {
1162                                 /* Backward scanning or we want to use the
1163                                  * existing one
1164                                  * Delete the new one and return early so that
1165                                  * the tnode isn't changed
1166                                  */
1167                                 yaffs_chunk_del(dev, nand_chunk, 1, __LINE__);
1168                                 return YAFFS_OK;
1169                         }
1170                 }
1171
1172         }
1173
1174         if (existing_cunk == 0)
1175                 in->n_data_chunks++;
1176
1177         yaffs_load_tnode_0(dev, tn, inode_chunk, nand_chunk);
1178
1179         return YAFFS_OK;
1180 }
1181
1182 static void yaffs_soft_del_chunk(struct yaffs_dev *dev, int chunk)
1183 {
1184         struct yaffs_block_info *the_block;
1185         unsigned block_no;
1186
1187         yaffs_trace(YAFFS_TRACE_DELETION, "soft delete chunk %d", chunk);
1188
1189         block_no = chunk / dev->param.chunks_per_block;
1190         the_block = yaffs_get_block_info(dev, block_no);
1191         if (the_block) {
1192                 the_block->soft_del_pages++;
1193                 dev->n_free_chunks++;
1194                 yaffs2_update_oldest_dirty_seq(dev, block_no, the_block);
1195         }
1196 }
1197
1198 /* SoftDeleteWorker scans backwards through the tnode tree and soft deletes all
1199  * the chunks in the file.
1200  * All soft deleting does is increment the block's softdelete count and pulls
1201  * the chunk out of the tnode.
1202  * Thus, essentially this is the same as DeleteWorker except that the chunks
1203  * are soft deleted.
1204  */
1205
1206 static int yaffs_soft_del_worker(struct yaffs_obj *in, struct yaffs_tnode *tn,
1207                                  u32 level, int chunk_offset)
1208 {
1209         int i;
1210         int the_chunk;
1211         int all_done = 1;
1212         struct yaffs_dev *dev = in->my_dev;
1213
1214         if (!tn)
1215                 return 1;
1216
1217         if (level > 0) {
1218                 for (i = YAFFS_NTNODES_INTERNAL - 1;
1219                         all_done && i >= 0;
1220                         i--) {
1221                         if (tn->internal[i]) {
1222                                 all_done =
1223                                     yaffs_soft_del_worker(in,
1224                                         tn->internal[i],
1225                                         level - 1,
1226                                         (chunk_offset <<
1227                                         YAFFS_TNODES_INTERNAL_BITS)
1228                                         + i);
1229                                 if (all_done) {
1230                                         yaffs_free_tnode(dev,
1231                                                 tn->internal[i]);
1232                                         tn->internal[i] = NULL;
1233                                 } else {
1234                                         /* Can this happen? */
1235                                 }
1236                         }
1237                 }
1238                 return (all_done) ? 1 : 0;
1239         }
1240
1241         /* level 0 */
1242          for (i = YAFFS_NTNODES_LEVEL0 - 1; i >= 0; i--) {
1243                 the_chunk = yaffs_get_group_base(dev, tn, i);
1244                 if (the_chunk) {
1245                         yaffs_soft_del_chunk(dev, the_chunk);
1246                         yaffs_load_tnode_0(dev, tn, i, 0);
1247                 }
1248         }
1249         return 1;
1250 }
1251
1252 static void yaffs_remove_obj_from_dir(struct yaffs_obj *obj)
1253 {
1254         struct yaffs_dev *dev = obj->my_dev;
1255         struct yaffs_obj *parent;
1256
1257         yaffs_verify_obj_in_dir(obj);
1258         parent = obj->parent;
1259
1260         yaffs_verify_dir(parent);
1261
1262         if (dev && dev->param.remove_obj_fn)
1263                 dev->param.remove_obj_fn(obj);
1264
1265         list_del_init(&obj->siblings);
1266         obj->parent = NULL;
1267
1268         yaffs_verify_dir(parent);
1269 }
1270
1271 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj)
1272 {
1273         if (!directory) {
1274                 yaffs_trace(YAFFS_TRACE_ALWAYS,
1275                         "tragedy: Trying to add an object to a null pointer directory"
1276                         );
1277                 BUG();
1278                 return;
1279         }
1280         if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1281                 yaffs_trace(YAFFS_TRACE_ALWAYS,
1282                         "tragedy: Trying to add an object to a non-directory"
1283                         );
1284                 BUG();
1285         }
1286
1287         if (obj->siblings.prev == NULL) {
1288                 /* Not initialised */
1289                 BUG();
1290         }
1291
1292         yaffs_verify_dir(directory);
1293
1294         yaffs_remove_obj_from_dir(obj);
1295
1296         /* Now add it */
1297         list_add(&obj->siblings, &directory->variant.dir_variant.children);
1298         obj->parent = directory;
1299
1300         if (directory == obj->my_dev->unlinked_dir
1301             || directory == obj->my_dev->del_dir) {
1302                 obj->unlinked = 1;
1303                 obj->my_dev->n_unlinked_files++;
1304                 obj->rename_allowed = 0;
1305         }
1306
1307         yaffs_verify_dir(directory);
1308         yaffs_verify_obj_in_dir(obj);
1309 }
1310
1311 static int yaffs_change_obj_name(struct yaffs_obj *obj,
1312                                  struct yaffs_obj *new_dir,
1313                                  const YCHAR *new_name, int force, int shadows)
1314 {
1315         int unlink_op;
1316         int del_op;
1317         struct yaffs_obj *existing_target;
1318
1319         if (new_dir == NULL)
1320                 new_dir = obj->parent;  /* use the old directory */
1321
1322         if (new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
1323                 yaffs_trace(YAFFS_TRACE_ALWAYS,
1324                         "tragedy: yaffs_change_obj_name: new_dir is not a directory"
1325                         );
1326                 BUG();
1327         }
1328
1329         unlink_op = (new_dir == obj->my_dev->unlinked_dir);
1330         del_op = (new_dir == obj->my_dev->del_dir);
1331
1332         existing_target = yaffs_find_by_name(new_dir, new_name);
1333
1334         /* If the object is a file going into the unlinked directory,
1335          *   then it is OK to just stuff it in since duplicate names are OK.
1336          *   else only proceed if the new name does not exist and we're putting
1337          *   it into a directory.
1338          */
1339         if (!(unlink_op || del_op || force ||
1340               shadows > 0 || !existing_target) ||
1341               new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
1342                 return YAFFS_FAIL;
1343
1344         yaffs_set_obj_name(obj, new_name);
1345         obj->dirty = 1;
1346         yaffs_add_obj_to_dir(new_dir, obj);
1347
1348         if (unlink_op)
1349                 obj->unlinked = 1;
1350
1351         /* If it is a deletion then we mark it as a shrink for gc  */
1352         if (yaffs_update_oh(obj, new_name, 0, del_op, shadows, NULL) >= 0)
1353                 return YAFFS_OK;
1354
1355         return YAFFS_FAIL;
1356 }
1357
1358 /*------------------------ Short Operations Cache ------------------------------
1359  *   In many situations where there is no high level buffering  a lot of
1360  *   reads might be short sequential reads, and a lot of writes may be short
1361  *   sequential writes. eg. scanning/writing a jpeg file.
1362  *   In these cases, a short read/write cache can provide a huge perfomance
1363  *   benefit with dumb-as-a-rock code.
1364  *   In Linux, the page cache provides read buffering and the short op cache
1365  *   provides write buffering.
1366  *
1367  *   There are a small number (~10) of cache chunks per device so that we don't
1368  *   need a very intelligent search.
1369  */
1370
1371 static int yaffs_obj_cache_dirty(struct yaffs_obj *obj)
1372 {
1373         struct yaffs_dev *dev = obj->my_dev;
1374         int i;
1375         struct yaffs_cache *cache;
1376         int n_caches = obj->my_dev->param.n_caches;
1377
1378         for (i = 0; i < n_caches; i++) {
1379                 cache = &dev->cache[i];
1380                 if (cache->object == obj && cache->dirty)
1381                         return 1;
1382         }
1383
1384         return 0;
1385 }
1386
1387 static void yaffs_flush_file_cache(struct yaffs_obj *obj)
1388 {
1389         struct yaffs_dev *dev = obj->my_dev;
1390         int lowest = -99;       /* Stop compiler whining. */
1391         int i;
1392         struct yaffs_cache *cache;
1393         int chunk_written = 0;
1394         int n_caches = obj->my_dev->param.n_caches;
1395
1396         if (n_caches < 1)
1397                 return;
1398         do {
1399                 cache = NULL;
1400
1401                 /* Find the lowest dirty chunk for this object */
1402                 for (i = 0; i < n_caches; i++) {
1403                         if (dev->cache[i].object == obj &&
1404                             dev->cache[i].dirty) {
1405                                 if (!cache ||
1406                                     dev->cache[i].chunk_id < lowest) {
1407                                         cache = &dev->cache[i];
1408                                         lowest = cache->chunk_id;
1409                                 }
1410                         }
1411                 }
1412
1413                 if (cache && !cache->locked) {
1414                         /* Write it out and free it up */
1415                         chunk_written =
1416                             yaffs_wr_data_obj(cache->object,
1417                                               cache->chunk_id,
1418                                               cache->data,
1419                                               cache->n_bytes, 1);
1420                         cache->dirty = 0;
1421                         cache->object = NULL;
1422                 }
1423         } while (cache && chunk_written > 0);
1424
1425         if (cache)
1426                 /* Hoosterman, disk full while writing cache out. */
1427                 yaffs_trace(YAFFS_TRACE_ERROR,
1428                         "yaffs tragedy: no space during cache write");
1429 }
1430
1431 /*yaffs_flush_whole_cache(dev)
1432  *
1433  *
1434  */
1435
1436 void yaffs_flush_whole_cache(struct yaffs_dev *dev)
1437 {
1438         struct yaffs_obj *obj;
1439         int n_caches = dev->param.n_caches;
1440         int i;
1441
1442         /* Find a dirty object in the cache and flush it...
1443          * until there are no further dirty objects.
1444          */
1445         do {
1446                 obj = NULL;
1447                 for (i = 0; i < n_caches && !obj; i++) {
1448                         if (dev->cache[i].object && dev->cache[i].dirty)
1449                                 obj = dev->cache[i].object;
1450                 }
1451                 if (obj)
1452                         yaffs_flush_file_cache(obj);
1453         } while (obj);
1454
1455 }
1456
1457 /* Grab us a cache chunk for use.
1458  * First look for an empty one.
1459  * Then look for the least recently used non-dirty one.
1460  * Then look for the least recently used dirty one...., flush and look again.
1461  */
1462 static struct yaffs_cache *yaffs_grab_chunk_worker(struct yaffs_dev *dev)
1463 {
1464         int i;
1465
1466         if (dev->param.n_caches > 0) {
1467                 for (i = 0; i < dev->param.n_caches; i++) {
1468                         if (!dev->cache[i].object)
1469                                 return &dev->cache[i];
1470                 }
1471         }
1472         return NULL;
1473 }
1474
1475 static struct yaffs_cache *yaffs_grab_chunk_cache(struct yaffs_dev *dev)
1476 {
1477         struct yaffs_cache *cache;
1478         struct yaffs_obj *the_obj;
1479         int usage;
1480         int i;
1481         int pushout;
1482
1483         if (dev->param.n_caches < 1)
1484                 return NULL;
1485
1486         /* Try find a non-dirty one... */
1487
1488         cache = yaffs_grab_chunk_worker(dev);
1489
1490         if (!cache) {
1491                 /* They were all dirty, find the LRU object and flush
1492                  * its cache, then  find again.
1493                  * NB what's here is not very accurate,
1494                  * we actually flush the object with the LRU chunk.
1495                  */
1496
1497                 /* With locking we can't assume we can use entry zero,
1498                  * Set the_obj to a valid pointer for Coverity. */
1499                 the_obj = dev->cache[0].object;
1500                 usage = -1;
1501                 cache = NULL;
1502                 pushout = -1;
1503
1504                 for (i = 0; i < dev->param.n_caches; i++) {
1505                         if (dev->cache[i].object &&
1506                             !dev->cache[i].locked &&
1507                             (dev->cache[i].last_use < usage ||
1508                             !cache)) {
1509                                 usage = dev->cache[i].last_use;
1510                                 the_obj = dev->cache[i].object;
1511                                 cache = &dev->cache[i];
1512                                 pushout = i;
1513                         }
1514                 }
1515
1516                 if (!cache || cache->dirty) {
1517                         /* Flush and try again */
1518                         yaffs_flush_file_cache(the_obj);
1519                         cache = yaffs_grab_chunk_worker(dev);
1520                 }
1521         }
1522         return cache;
1523 }
1524
1525 /* Find a cached chunk */
1526 static struct yaffs_cache *yaffs_find_chunk_cache(const struct yaffs_obj *obj,
1527                                                   int chunk_id)
1528 {
1529         struct yaffs_dev *dev = obj->my_dev;
1530         int i;
1531
1532         if (dev->param.n_caches < 1)
1533                 return NULL;
1534
1535         for (i = 0; i < dev->param.n_caches; i++) {
1536                 if (dev->cache[i].object == obj &&
1537                     dev->cache[i].chunk_id == chunk_id) {
1538                         dev->cache_hits++;
1539
1540                         return &dev->cache[i];
1541                 }
1542         }
1543         return NULL;
1544 }
1545
1546 /* Mark the chunk for the least recently used algorithym */
1547 static void yaffs_use_cache(struct yaffs_dev *dev, struct yaffs_cache *cache,
1548                             int is_write)
1549 {
1550         int i;
1551
1552         if (dev->param.n_caches < 1)
1553                 return;
1554
1555         if (dev->cache_last_use < 0 ||
1556                 dev->cache_last_use > 100000000) {
1557                 /* Reset the cache usages */
1558                 for (i = 1; i < dev->param.n_caches; i++)
1559                         dev->cache[i].last_use = 0;
1560
1561                 dev->cache_last_use = 0;
1562         }
1563         dev->cache_last_use++;
1564         cache->last_use = dev->cache_last_use;
1565
1566         if (is_write)
1567                 cache->dirty = 1;
1568 }
1569
1570 /* Invalidate a single cache page.
1571  * Do this when a whole page gets written,
1572  * ie the short cache for this page is no longer valid.
1573  */
1574 static void yaffs_invalidate_chunk_cache(struct yaffs_obj *object, int chunk_id)
1575 {
1576         struct yaffs_cache *cache;
1577
1578         if (object->my_dev->param.n_caches > 0) {
1579                 cache = yaffs_find_chunk_cache(object, chunk_id);
1580
1581                 if (cache)
1582                         cache->object = NULL;
1583         }
1584 }
1585
1586 /* Invalidate all the cache pages associated with this object
1587  * Do this whenever ther file is deleted or resized.
1588  */
1589 static void yaffs_invalidate_whole_cache(struct yaffs_obj *in)
1590 {
1591         int i;
1592         struct yaffs_dev *dev = in->my_dev;
1593
1594         if (dev->param.n_caches > 0) {
1595                 /* Invalidate it. */
1596                 for (i = 0; i < dev->param.n_caches; i++) {
1597                         if (dev->cache[i].object == in)
1598                                 dev->cache[i].object = NULL;
1599                 }
1600         }
1601 }
1602
1603 static void yaffs_unhash_obj(struct yaffs_obj *obj)
1604 {
1605         int bucket;
1606         struct yaffs_dev *dev = obj->my_dev;
1607
1608         /* If it is still linked into the bucket list, free from the list */
1609         if (!list_empty(&obj->hash_link)) {
1610                 list_del_init(&obj->hash_link);
1611                 bucket = yaffs_hash_fn(obj->obj_id);
1612                 dev->obj_bucket[bucket].count--;
1613         }
1614 }
1615
1616 /*  FreeObject frees up a Object and puts it back on the free list */
1617 static void yaffs_free_obj(struct yaffs_obj *obj)
1618 {
1619         struct yaffs_dev *dev;
1620
1621         if (!obj) {
1622                 BUG();
1623                 return;
1624         }
1625         dev = obj->my_dev;
1626         yaffs_trace(YAFFS_TRACE_OS, "FreeObject %p inode %p",
1627                 obj, obj->my_inode);
1628         if (obj->parent)
1629                 BUG();
1630         if (!list_empty(&obj->siblings))
1631                 BUG();
1632
1633         if (obj->my_inode) {
1634                 /* We're still hooked up to a cached inode.
1635                  * Don't delete now, but mark for later deletion
1636                  */
1637                 obj->defered_free = 1;
1638                 return;
1639         }
1640
1641         yaffs_unhash_obj(obj);
1642
1643         yaffs_free_raw_obj(dev, obj);
1644         dev->n_obj--;
1645         dev->checkpoint_blocks_required = 0;    /* force recalculation */
1646 }
1647
1648 void yaffs_handle_defered_free(struct yaffs_obj *obj)
1649 {
1650         if (obj->defered_free)
1651                 yaffs_free_obj(obj);
1652 }
1653
1654 static int yaffs_generic_obj_del(struct yaffs_obj *in)
1655 {
1656         /* Iinvalidate the file's data in the cache, without flushing. */
1657         yaffs_invalidate_whole_cache(in);
1658
1659         if (in->my_dev->param.is_yaffs2 && in->parent != in->my_dev->del_dir) {
1660                 /* Move to unlinked directory so we have a deletion record */
1661                 yaffs_change_obj_name(in, in->my_dev->del_dir, _Y("deleted"), 0,
1662                                       0);
1663         }
1664
1665         yaffs_remove_obj_from_dir(in);
1666         yaffs_chunk_del(in->my_dev, in->hdr_chunk, 1, __LINE__);
1667         in->hdr_chunk = 0;
1668
1669         yaffs_free_obj(in);
1670         return YAFFS_OK;
1671
1672 }
1673
1674 static void yaffs_soft_del_file(struct yaffs_obj *obj)
1675 {
1676         if (!obj->deleted ||
1677             obj->variant_type != YAFFS_OBJECT_TYPE_FILE ||
1678             obj->soft_del)
1679                 return;
1680
1681         if (obj->n_data_chunks <= 0) {
1682                 /* Empty file with no duplicate object headers,
1683                  * just delete it immediately */
1684                 yaffs_free_tnode(obj->my_dev, obj->variant.file_variant.top);
1685                 obj->variant.file_variant.top = NULL;
1686                 yaffs_trace(YAFFS_TRACE_TRACING,
1687                         "yaffs: Deleting empty file %d",
1688                         obj->obj_id);
1689                 yaffs_generic_obj_del(obj);
1690         } else {
1691                 yaffs_soft_del_worker(obj,
1692                                       obj->variant.file_variant.top,
1693                                       obj->variant.
1694                                       file_variant.top_level, 0);
1695                 obj->soft_del = 1;
1696         }
1697 }
1698
1699 /* Pruning removes any part of the file structure tree that is beyond the
1700  * bounds of the file (ie that does not point to chunks).
1701  *
1702  * A file should only get pruned when its size is reduced.
1703  *
1704  * Before pruning, the chunks must be pulled from the tree and the
1705  * level 0 tnode entries must be zeroed out.
1706  * Could also use this for file deletion, but that's probably better handled
1707  * by a special case.
1708  *
1709  * This function is recursive. For levels > 0 the function is called again on
1710  * any sub-tree. For level == 0 we just check if the sub-tree has data.
1711  * If there is no data in a subtree then it is pruned.
1712  */
1713
1714 static struct yaffs_tnode *yaffs_prune_worker(struct yaffs_dev *dev,
1715                                               struct yaffs_tnode *tn, u32 level,
1716                                               int del0)
1717 {
1718         int i;
1719         int has_data;
1720
1721         if (!tn)
1722                 return tn;
1723
1724         has_data = 0;
1725
1726         if (level > 0) {
1727                 for (i = 0; i < YAFFS_NTNODES_INTERNAL; i++) {
1728                         if (tn->internal[i]) {
1729                                 tn->internal[i] =
1730                                     yaffs_prune_worker(dev,
1731                                                 tn->internal[i],
1732                                                 level - 1,
1733                                                 (i == 0) ? del0 : 1);
1734                         }
1735
1736                         if (tn->internal[i])
1737                                 has_data++;
1738                 }
1739         } else {
1740                 int tnode_size_u32 = dev->tnode_size / sizeof(u32);
1741                 u32 *map = (u32 *) tn;
1742
1743                 for (i = 0; !has_data && i < tnode_size_u32; i++) {
1744                         if (map[i])
1745                                 has_data++;
1746                 }
1747         }
1748
1749         if (has_data == 0 && del0) {
1750                 /* Free and return NULL */
1751                 yaffs_free_tnode(dev, tn);
1752                 tn = NULL;
1753         }
1754         return tn;
1755 }
1756
1757 static int yaffs_prune_tree(struct yaffs_dev *dev,
1758                             struct yaffs_file_var *file_struct)
1759 {
1760         int i;
1761         int has_data;
1762         int done = 0;
1763         struct yaffs_tnode *tn;
1764
1765         if (file_struct->top_level < 1)
1766                 return YAFFS_OK;
1767
1768         file_struct->top =
1769            yaffs_prune_worker(dev, file_struct->top, file_struct->top_level, 0);
1770
1771         /* Now we have a tree with all the non-zero branches NULL but
1772          * the height is the same as it was.
1773          * Let's see if we can trim internal tnodes to shorten the tree.
1774          * We can do this if only the 0th element in the tnode is in use
1775          * (ie all the non-zero are NULL)
1776          */
1777
1778         while (file_struct->top_level && !done) {
1779                 tn = file_struct->top;
1780
1781                 has_data = 0;
1782                 for (i = 1; i < YAFFS_NTNODES_INTERNAL; i++) {
1783                         if (tn->internal[i])
1784                                 has_data++;
1785                 }
1786
1787                 if (!has_data) {
1788                         file_struct->top = tn->internal[0];
1789                         file_struct->top_level--;
1790                         yaffs_free_tnode(dev, tn);
1791                 } else {
1792                         done = 1;
1793                 }
1794         }
1795
1796         return YAFFS_OK;
1797 }
1798
1799 /*-------------------- End of File Structure functions.-------------------*/
1800
1801 /* alloc_empty_obj gets us a clean Object.*/
1802 static struct yaffs_obj *yaffs_alloc_empty_obj(struct yaffs_dev *dev)
1803 {
1804         struct yaffs_obj *obj = yaffs_alloc_raw_obj(dev);
1805
1806         if (!obj)
1807                 return obj;
1808
1809         dev->n_obj++;
1810
1811         /* Now sweeten it up... */
1812
1813         memset(obj, 0, sizeof(struct yaffs_obj));
1814         obj->being_created = 1;
1815
1816         obj->my_dev = dev;
1817         obj->hdr_chunk = 0;
1818         obj->variant_type = YAFFS_OBJECT_TYPE_UNKNOWN;
1819         INIT_LIST_HEAD(&(obj->hard_links));
1820         INIT_LIST_HEAD(&(obj->hash_link));
1821         INIT_LIST_HEAD(&obj->siblings);
1822
1823         /* Now make the directory sane */
1824         if (dev->root_dir) {
1825                 obj->parent = dev->root_dir;
1826                 list_add(&(obj->siblings),
1827                          &dev->root_dir->variant.dir_variant.children);
1828         }
1829
1830         /* Add it to the lost and found directory.
1831          * NB Can't put root or lost-n-found in lost-n-found so
1832          * check if lost-n-found exists first
1833          */
1834         if (dev->lost_n_found)
1835                 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
1836
1837         obj->being_created = 0;
1838
1839         dev->checkpoint_blocks_required = 0;    /* force recalculation */
1840
1841         return obj;
1842 }
1843
1844 static int yaffs_find_nice_bucket(struct yaffs_dev *dev)
1845 {
1846         int i;
1847         int l = 999;
1848         int lowest = 999999;
1849
1850         /* Search for the shortest list or one that
1851          * isn't too long.
1852          */
1853
1854         for (i = 0; i < 10 && lowest > 4; i++) {
1855                 dev->bucket_finder++;
1856                 dev->bucket_finder %= YAFFS_NOBJECT_BUCKETS;
1857                 if (dev->obj_bucket[dev->bucket_finder].count < lowest) {
1858                         lowest = dev->obj_bucket[dev->bucket_finder].count;
1859                         l = dev->bucket_finder;
1860                 }
1861         }
1862
1863         return l;
1864 }
1865
1866 static int yaffs_new_obj_id(struct yaffs_dev *dev)
1867 {
1868         int bucket = yaffs_find_nice_bucket(dev);
1869         int found = 0;
1870         struct list_head *i;
1871         u32 n = (u32) bucket;
1872
1873         /* Now find an object value that has not already been taken
1874          * by scanning the list.
1875          */
1876
1877         while (!found) {
1878                 found = 1;
1879                 n += YAFFS_NOBJECT_BUCKETS;
1880                 if (1 || dev->obj_bucket[bucket].count > 0) {
1881                         list_for_each(i, &dev->obj_bucket[bucket].list) {
1882                                 /* If there is already one in the list */
1883                                 if (i && list_entry(i, struct yaffs_obj,
1884                                                     hash_link)->obj_id == n) {
1885                                         found = 0;
1886                                 }
1887                         }
1888                 }
1889         }
1890         return n;
1891 }
1892
1893 static void yaffs_hash_obj(struct yaffs_obj *in)
1894 {
1895         int bucket = yaffs_hash_fn(in->obj_id);
1896         struct yaffs_dev *dev = in->my_dev;
1897
1898         list_add(&in->hash_link, &dev->obj_bucket[bucket].list);
1899         dev->obj_bucket[bucket].count++;
1900 }
1901
1902 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number)
1903 {
1904         int bucket = yaffs_hash_fn(number);
1905         struct list_head *i;
1906         struct yaffs_obj *in;
1907
1908         list_for_each(i, &dev->obj_bucket[bucket].list) {
1909                 /* Look if it is in the list */
1910                 in = list_entry(i, struct yaffs_obj, hash_link);
1911                 if (in->obj_id == number) {
1912                         /* Don't show if it is defered free */
1913                         if (in->defered_free)
1914                                 return NULL;
1915                         return in;
1916                 }
1917         }
1918
1919         return NULL;
1920 }
1921
1922 struct yaffs_obj *yaffs_new_obj(struct yaffs_dev *dev, int number,
1923                                 enum yaffs_obj_type type)
1924 {
1925         struct yaffs_obj *the_obj = NULL;
1926         struct yaffs_tnode *tn = NULL;
1927
1928         if (number < 0)
1929                 number = yaffs_new_obj_id(dev);
1930
1931         if (type == YAFFS_OBJECT_TYPE_FILE) {
1932                 tn = yaffs_get_tnode(dev);
1933                 if (!tn)
1934                         return NULL;
1935         }
1936
1937         the_obj = yaffs_alloc_empty_obj(dev);
1938         if (!the_obj) {
1939                 if (tn)
1940                         yaffs_free_tnode(dev, tn);
1941                 return NULL;
1942         }
1943
1944         the_obj->fake = 0;
1945         the_obj->rename_allowed = 1;
1946         the_obj->unlink_allowed = 1;
1947         the_obj->obj_id = number;
1948         yaffs_hash_obj(the_obj);
1949         the_obj->variant_type = type;
1950         yaffs_load_current_time(the_obj, 1, 1);
1951
1952         switch (type) {
1953         case YAFFS_OBJECT_TYPE_FILE:
1954                 the_obj->variant.file_variant.file_size = 0;
1955                 the_obj->variant.file_variant.scanned_size = 0;
1956                 the_obj->variant.file_variant.shrink_size = ~0; /* max */
1957                 the_obj->variant.file_variant.top_level = 0;
1958                 the_obj->variant.file_variant.top = tn;
1959                 break;
1960         case YAFFS_OBJECT_TYPE_DIRECTORY:
1961                 INIT_LIST_HEAD(&the_obj->variant.dir_variant.children);
1962                 INIT_LIST_HEAD(&the_obj->variant.dir_variant.dirty);
1963                 break;
1964         case YAFFS_OBJECT_TYPE_SYMLINK:
1965         case YAFFS_OBJECT_TYPE_HARDLINK:
1966         case YAFFS_OBJECT_TYPE_SPECIAL:
1967                 /* No action required */
1968                 break;
1969         case YAFFS_OBJECT_TYPE_UNKNOWN:
1970                 /* todo this should not happen */
1971                 break;
1972         }
1973         return the_obj;
1974 }
1975
1976 static struct yaffs_obj *yaffs_create_fake_dir(struct yaffs_dev *dev,
1977                                                int number, u32 mode)
1978 {
1979
1980         struct yaffs_obj *obj =
1981             yaffs_new_obj(dev, number, YAFFS_OBJECT_TYPE_DIRECTORY);
1982
1983         if (!obj)
1984                 return NULL;
1985
1986         obj->fake = 1;  /* it is fake so it might not use NAND */
1987         obj->rename_allowed = 0;
1988         obj->unlink_allowed = 0;
1989         obj->deleted = 0;
1990         obj->unlinked = 0;
1991         obj->yst_mode = mode;
1992         obj->my_dev = dev;
1993         obj->hdr_chunk = 0;     /* Not a valid chunk. */
1994         return obj;
1995
1996 }
1997
1998
1999 static void yaffs_init_tnodes_and_objs(struct yaffs_dev *dev)
2000 {
2001         int i;
2002
2003         dev->n_obj = 0;
2004         dev->n_tnodes = 0;
2005         yaffs_init_raw_tnodes_and_objs(dev);
2006
2007         for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
2008                 INIT_LIST_HEAD(&dev->obj_bucket[i].list);
2009                 dev->obj_bucket[i].count = 0;
2010         }
2011 }
2012
2013 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
2014                                                  int number,
2015                                                  enum yaffs_obj_type type)
2016 {
2017         struct yaffs_obj *the_obj = NULL;
2018
2019         if (number > 0)
2020                 the_obj = yaffs_find_by_number(dev, number);
2021
2022         if (!the_obj)
2023                 the_obj = yaffs_new_obj(dev, number, type);
2024
2025         return the_obj;
2026
2027 }
2028
2029 YCHAR *yaffs_clone_str(const YCHAR *str)
2030 {
2031         YCHAR *new_str = NULL;
2032         int len;
2033
2034         if (!str)
2035                 str = _Y("");
2036
2037         len = strnlen(str, YAFFS_MAX_ALIAS_LENGTH);
2038         new_str = kmalloc((len + 1) * sizeof(YCHAR), GFP_NOFS);
2039         if (new_str) {
2040                 strncpy(new_str, str, len);
2041                 new_str[len] = 0;
2042         }
2043         return new_str;
2044
2045 }
2046 /*
2047  *yaffs_update_parent() handles fixing a directories mtime and ctime when a new
2048  * link (ie. name) is created or deleted in the directory.
2049  *
2050  * ie.
2051  *   create dir/a : update dir's mtime/ctime
2052  *   rm dir/a:   update dir's mtime/ctime
2053  *   modify dir/a: don't update dir's mtimme/ctime
2054  *
2055  * This can be handled immediately or defered. Defering helps reduce the number
2056  * of updates when many files in a directory are changed within a brief period.
2057  *
2058  * If the directory updating is defered then yaffs_update_dirty_dirs must be
2059  * called periodically.
2060  */
2061
2062 static void yaffs_update_parent(struct yaffs_obj *obj)
2063 {
2064         struct yaffs_dev *dev;
2065
2066         if (!obj)
2067                 return;
2068         dev = obj->my_dev;
2069         obj->dirty = 1;
2070         yaffs_load_current_time(obj, 0, 1);
2071         if (dev->param.defered_dir_update) {
2072                 struct list_head *link = &obj->variant.dir_variant.dirty;
2073
2074                 if (list_empty(link)) {
2075                         list_add(link, &dev->dirty_dirs);
2076                         yaffs_trace(YAFFS_TRACE_BACKGROUND,
2077                           "Added object %d to dirty directories",
2078                            obj->obj_id);
2079                 }
2080
2081         } else {
2082                 yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2083         }
2084 }
2085
2086 void yaffs_update_dirty_dirs(struct yaffs_dev *dev)
2087 {
2088         struct list_head *link;
2089         struct yaffs_obj *obj;
2090         struct yaffs_dir_var *d_s;
2091         union yaffs_obj_var *o_v;
2092
2093         yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update dirty directories");
2094
2095         while (!list_empty(&dev->dirty_dirs)) {
2096                 link = dev->dirty_dirs.next;
2097                 list_del_init(link);
2098
2099                 d_s = list_entry(link, struct yaffs_dir_var, dirty);
2100                 o_v = list_entry(d_s, union yaffs_obj_var, dir_variant);
2101                 obj = list_entry(o_v, struct yaffs_obj, variant);
2102
2103                 yaffs_trace(YAFFS_TRACE_BACKGROUND, "Update directory %d",
2104                         obj->obj_id);
2105
2106                 if (obj->dirty)
2107                         yaffs_update_oh(obj, NULL, 0, 0, 0, NULL);
2108         }
2109 }
2110
2111 /*
2112  * Mknod (create) a new object.
2113  * equiv_obj only has meaning for a hard link;
2114  * alias_str only has meaning for a symlink.
2115  * rdev only has meaning for devices (a subset of special objects)
2116  */
2117
2118 static struct yaffs_obj *yaffs_create_obj(enum yaffs_obj_type type,
2119                                           struct yaffs_obj *parent,
2120                                           const YCHAR *name,
2121                                           u32 mode,
2122                                           u32 uid,
2123                                           u32 gid,
2124                                           struct yaffs_obj *equiv_obj,
2125                                           const YCHAR *alias_str, u32 rdev)
2126 {
2127         struct yaffs_obj *in;
2128         YCHAR *str = NULL;
2129         struct yaffs_dev *dev = parent->my_dev;
2130
2131         /* Check if the entry exists.
2132          * If it does then fail the call since we don't want a dup. */
2133         if (yaffs_find_by_name(parent, name))
2134                 return NULL;
2135
2136         if (type == YAFFS_OBJECT_TYPE_SYMLINK) {
2137                 str = yaffs_clone_str(alias_str);
2138                 if (!str)
2139                         return NULL;
2140         }
2141
2142         in = yaffs_new_obj(dev, -1, type);
2143
2144         if (!in) {
2145                 kfree(str);
2146                 return NULL;
2147         }
2148
2149         in->hdr_chunk = 0;
2150         in->valid = 1;
2151         in->variant_type = type;
2152
2153         in->yst_mode = mode;
2154
2155         yaffs_attribs_init(in, gid, uid, rdev);
2156
2157         in->n_data_chunks = 0;
2158
2159         yaffs_set_obj_name(in, name);
2160         in->dirty = 1;
2161
2162         yaffs_add_obj_to_dir(parent, in);
2163
2164         in->my_dev = parent->my_dev;
2165
2166         switch (type) {
2167         case YAFFS_OBJECT_TYPE_SYMLINK:
2168                 in->variant.symlink_variant.alias = str;
2169                 break;
2170         case YAFFS_OBJECT_TYPE_HARDLINK:
2171                 in->variant.hardlink_variant.equiv_obj = equiv_obj;
2172                 in->variant.hardlink_variant.equiv_id = equiv_obj->obj_id;
2173                 list_add(&in->hard_links, &equiv_obj->hard_links);
2174                 break;
2175         case YAFFS_OBJECT_TYPE_FILE:
2176         case YAFFS_OBJECT_TYPE_DIRECTORY:
2177         case YAFFS_OBJECT_TYPE_SPECIAL:
2178         case YAFFS_OBJECT_TYPE_UNKNOWN:
2179                 /* do nothing */
2180                 break;
2181         }
2182
2183         if (yaffs_update_oh(in, name, 0, 0, 0, NULL) < 0) {
2184                 /* Could not create the object header, fail */
2185                 yaffs_del_obj(in);
2186                 in = NULL;
2187         }
2188
2189         if (in)
2190                 yaffs_update_parent(parent);
2191
2192         return in;
2193 }
2194
2195 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
2196                                     const YCHAR *name, u32 mode, u32 uid,
2197                                     u32 gid)
2198 {
2199         return yaffs_create_obj(YAFFS_OBJECT_TYPE_FILE, parent, name, mode,
2200                                 uid, gid, NULL, NULL, 0);
2201 }
2202
2203 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
2204                                    u32 mode, u32 uid, u32 gid)
2205 {
2206         return yaffs_create_obj(YAFFS_OBJECT_TYPE_DIRECTORY, parent, name,
2207                                 mode, uid, gid, NULL, NULL, 0);
2208 }
2209
2210 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
2211                                        const YCHAR *name, u32 mode, u32 uid,
2212                                        u32 gid, u32 rdev)
2213 {
2214         return yaffs_create_obj(YAFFS_OBJECT_TYPE_SPECIAL, parent, name, mode,
2215                                 uid, gid, NULL, NULL, rdev);
2216 }
2217
2218 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
2219                                        const YCHAR *name, u32 mode, u32 uid,
2220                                        u32 gid, const YCHAR *alias)
2221 {
2222         return yaffs_create_obj(YAFFS_OBJECT_TYPE_SYMLINK, parent, name, mode,
2223                                 uid, gid, NULL, alias, 0);
2224 }
2225
2226 /* yaffs_link_obj returns the object id of the equivalent object.*/
2227 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR * name,
2228                                  struct yaffs_obj *equiv_obj)
2229 {
2230         /* Get the real object in case we were fed a hard link obj */
2231         equiv_obj = yaffs_get_equivalent_obj(equiv_obj);
2232
2233         if (yaffs_create_obj(YAFFS_OBJECT_TYPE_HARDLINK,
2234                         parent, name, 0, 0, 0,
2235                         equiv_obj, NULL, 0))
2236                 return equiv_obj;
2237
2238         return NULL;
2239
2240 }
2241
2242
2243
2244 /*---------------------- Block Management and Page Allocation -------------*/
2245
2246 static void yaffs_deinit_blocks(struct yaffs_dev *dev)
2247 {
2248         if (dev->block_info_alt && dev->block_info)
2249                 vfree(dev->block_info);
2250         else
2251                 kfree(dev->block_info);
2252
2253         dev->block_info_alt = 0;
2254
2255         dev->block_info = NULL;
2256
2257         if (dev->chunk_bits_alt && dev->chunk_bits)
2258                 vfree(dev->chunk_bits);
2259         else
2260                 kfree(dev->chunk_bits);
2261         dev->chunk_bits_alt = 0;
2262         dev->chunk_bits = NULL;
2263 }
2264
2265 static int yaffs_init_blocks(struct yaffs_dev *dev)
2266 {
2267         int n_blocks = dev->internal_end_block - dev->internal_start_block + 1;
2268
2269         dev->block_info = NULL;
2270         dev->chunk_bits = NULL;
2271         dev->alloc_block = -1;  /* force it to get a new one */
2272
2273         /* If the first allocation strategy fails, thry the alternate one */
2274         dev->block_info =
2275                 kmalloc(n_blocks * sizeof(struct yaffs_block_info), GFP_NOFS);
2276         if (!dev->block_info) {
2277                 dev->block_info =
2278                     vmalloc(n_blocks * sizeof(struct yaffs_block_info));
2279                 dev->block_info_alt = 1;
2280         } else {
2281                 dev->block_info_alt = 0;
2282         }
2283
2284         if (!dev->block_info)
2285                 goto alloc_error;
2286
2287         /* Set up dynamic blockinfo stuff. Round up bytes. */
2288         dev->chunk_bit_stride = (dev->param.chunks_per_block + 7) / 8;
2289         dev->chunk_bits =
2290                 kmalloc(dev->chunk_bit_stride * n_blocks, GFP_NOFS);
2291         if (!dev->chunk_bits) {
2292                 dev->chunk_bits =
2293                     vmalloc(dev->chunk_bit_stride * n_blocks);
2294                 dev->chunk_bits_alt = 1;
2295         } else {
2296                 dev->chunk_bits_alt = 0;
2297         }
2298         if (!dev->chunk_bits)
2299                 goto alloc_error;
2300
2301
2302         memset(dev->block_info, 0, n_blocks * sizeof(struct yaffs_block_info));
2303         memset(dev->chunk_bits, 0, dev->chunk_bit_stride * n_blocks);
2304         return YAFFS_OK;
2305
2306 alloc_error:
2307         yaffs_deinit_blocks(dev);
2308         return YAFFS_FAIL;
2309 }
2310
2311
2312 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no)
2313 {
2314         struct yaffs_block_info *bi = yaffs_get_block_info(dev, block_no);
2315         int erased_ok = 0;
2316         int i;
2317
2318         /* If the block is still healthy erase it and mark as clean.
2319          * If the block has had a data failure, then retire it.
2320          */
2321
2322         yaffs_trace(YAFFS_TRACE_GC | YAFFS_TRACE_ERASE,
2323                 "yaffs_block_became_dirty block %d state %d %s",
2324                 block_no, bi->block_state,
2325                 (bi->needs_retiring) ? "needs retiring" : "");
2326
2327         yaffs2_clear_oldest_dirty_seq(dev, bi);
2328
2329         bi->block_state = YAFFS_BLOCK_STATE_DIRTY;
2330
2331         /* If this is the block being garbage collected then stop gc'ing */
2332         if (block_no == dev->gc_block)
2333                 dev->gc_block = 0;
2334
2335         /* If this block is currently the best candidate for gc
2336          * then drop as a candidate */
2337         if (block_no == dev->gc_dirtiest) {
2338                 dev->gc_dirtiest = 0;
2339                 dev->gc_pages_in_use = 0;
2340         }
2341
2342         if (!bi->needs_retiring) {
2343                 yaffs2_checkpt_invalidate(dev);
2344                 erased_ok = yaffs_erase_block(dev, block_no);
2345                 if (!erased_ok) {
2346                         dev->n_erase_failures++;
2347                         yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2348                           "**>> Erasure failed %d", block_no);
2349                 }
2350         }
2351
2352         /* Verify erasure if needed */
2353         if (erased_ok &&
2354             ((yaffs_trace_mask & YAFFS_TRACE_ERASE) ||
2355              !yaffs_skip_verification(dev))) {
2356                 for (i = 0; i < dev->param.chunks_per_block; i++) {
2357                         if (!yaffs_check_chunk_erased(dev,
2358                                 block_no * dev->param.chunks_per_block + i)) {
2359                                 yaffs_trace(YAFFS_TRACE_ERROR,
2360                                         ">>Block %d erasure supposedly OK, but chunk %d not erased",
2361                                         block_no, i);
2362                         }
2363                 }
2364         }
2365
2366         if (!erased_ok) {
2367                 /* We lost a block of free space */
2368                 dev->n_free_chunks -= dev->param.chunks_per_block;
2369                 yaffs_retire_block(dev, block_no);
2370                 yaffs_trace(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,
2371                         "**>> Block %d retired", block_no);
2372                 return;
2373         }
2374
2375         /* Clean it up... */
2376         bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
2377         bi->seq_number = 0;
2378         dev->n_erased_blocks++;
2379         bi->pages_in_use = 0;
2380         bi->soft_del_pages = 0;
2381         bi->has_shrink_hdr = 0;
2382         bi->skip_erased_check = 1;      /* Clean, so no need to check */
2383         bi->gc_prioritise = 0;
2384         bi->has_summary=0;
2385
2386         yaffs_clear_chunk_bits(dev, block_no);
2387
2388         yaffs_trace(YAFFS_TRACE_ERASE, "Erased block %d", block_no);
2389 }
2390
2391 static inline int yaffs_gc_process_chunk(struct yaffs_dev *dev,
2392                                         struct yaffs_block_info *bi,
2393                                         int old_chunk, u8 *buffer)
2394 {
2395         int new_chunk;
2396         int mark_flash = 1;
2397         struct yaffs_ext_tags tags;
2398         struct yaffs_obj *object;
2399         int matching_chunk;
2400         int ret_val = YAFFS_OK;
2401
2402         memset(&tags, 0, sizeof(tags));
2403         yaffs_rd_chunk_tags_nand(dev, old_chunk,
2404                                  buffer, &tags);
2405         object = yaffs_find_by_number(dev, tags.obj_id);
2406
2407         yaffs_trace(YAFFS_TRACE_GC_DETAIL,
2408                 "Collecting chunk in block %d, %d %d %d ",
2409                 dev->gc_chunk, tags.obj_id,
2410                 tags.chunk_id, tags.n_bytes);
2411
2412         if (object && !yaffs_skip_verification(dev)) {
2413                 if (tags.chunk_id == 0)
2414                         matching_chunk =
2415                             object->hdr_chunk;
2416                 else if (object->soft_del)
2417                         /* Defeat the test */
2418                         matching_chunk = old_chunk;
2419                 else
2420                         matching_chunk =
2421                             yaffs_find_chunk_in_file
2422                             (object, tags.chunk_id,
2423                              NULL);
2424
2425                 if (old_chunk != matching_chunk)
2426                         yaffs_trace(YAFFS_TRACE_ERROR,
2427                                 "gc: page in gc mismatch: %d %d %d %d",
2428                                 old_chunk,
2429                                 matching_chunk,
2430                                 tags.obj_id,
2431                                 tags.chunk_id);
2432         }
2433
2434         if (!object) {
2435                 yaffs_trace(YAFFS_TRACE_ERROR,
2436                         "page %d in gc has no object: %d %d %d ",
2437                         old_chunk,
2438                         tags.obj_id, tags.chunk_id,
2439                         tags.n_bytes);
2440         }
2441
2442         if (object &&
2443             object->deleted &&
2444             object->soft_del && tags.chunk_id != 0) {
2445                 /* Data chunk in a soft deleted file,
2446                  * throw it away.
2447                  * It's a soft deleted data chunk,
2448                  * No need to copy this, just forget
2449                  * about it and fix up the object.
2450                  */
2451
2452                 /* Free chunks already includes
2453                  * softdeleted chunks, how ever this
2454                  * chunk is going to soon be really
2455                  * deleted which will increment free
2456                  * chunks. We have to decrement free
2457                  * chunks so this works out properly.
2458                  */
2459                 dev->n_free_chunks--;
2460                 bi->soft_del_pages--;
2461
2462                 object->n_data_chunks--;
2463                 if (object->n_data_chunks <= 0) {
2464                         /* remeber to clean up obj */
2465                         dev->gc_cleanup_list[dev->n_clean_ups] = tags.obj_id;
2466                         dev->n_clean_ups++;
2467                 }
2468                 mark_flash = 0;
2469         } else if (object) {
2470                 /* It's either a data chunk in a live
2471                  * file or an ObjectHeader, so we're
2472                  * interested in it.
2473                  * NB Need to keep the ObjectHeaders of
2474                  * deleted files until the whole file
2475                  * has been deleted off
2476                  */
2477                 tags.serial_number++;
2478                 dev->n_gc_copies++;
2479
2480                 if (tags.chunk_id == 0) {
2481                         /* It is an object Id,
2482                          * We need to nuke the
2483                          * shrinkheader flags since its
2484                          * work is done.
2485                          * Also need to clean up
2486                          * shadowing.
2487                          */
2488                         struct yaffs_obj_hdr *oh;
2489                         oh = (struct yaffs_obj_hdr *) buffer;
2490
2491                         oh->is_shrink = 0;
2492                         tags.extra_is_shrink = 0;
2493                         oh->shadows_obj = 0;
2494                         oh->inband_shadowed_obj_id = 0;
2495                         tags.extra_shadows = 0;
2496
2497                         /* Update file size */
2498                         if (object->variant_type == YAFFS_OBJECT_TYPE_FILE) {
2499                                 oh->file_size =
2500                                     object->variant.file_variant.file_size;
2501                                 tags.extra_length = oh->file_size;
2502                         }
2503
2504                         yaffs_verify_oh(object, oh, &tags, 1);
2505                         new_chunk =
2506                             yaffs_write_new_chunk(dev, (u8 *) oh, &tags, 1);
2507                 } else {
2508                         new_chunk =
2509                             yaffs_write_new_chunk(dev, buffer, &tags, 1);
2510                 }
2511
2512                 if (new_chunk < 0) {
2513                         ret_val = YAFFS_FAIL;
2514                 } else {
2515
2516                         /* Now fix up the Tnodes etc. */
2517
2518                         if (tags.chunk_id == 0) {
2519                                 /* It's a header */
2520                                 object->hdr_chunk = new_chunk;
2521                                 object->serial = tags.serial_number;
2522                         } else {
2523                                 /* It's a data chunk */
2524                                 yaffs_put_chunk_in_file(object, tags.chunk_id,
2525                                                         new_chunk, 0);
2526                         }
2527                 }
2528         }
2529         if (ret_val == YAFFS_OK)
2530                 yaffs_chunk_del(dev, old_chunk, mark_flash, __LINE__);
2531         return ret_val;
2532 }
2533
2534 static int yaffs_gc_block(struct yaffs_dev *dev, int block, int whole_block)
2535 {
2536         int old_chunk;
2537         int ret_val = YAFFS_OK;
2538         int i;
2539         int is_checkpt_block;
2540         int max_copies;
2541         int chunks_before = yaffs_get_erased_chunks(dev);
2542         int chunks_after;
2543         struct yaffs_block_info *bi = yaffs_get_block_info(dev, block);
2544
2545         is_checkpt_block = (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT);
2546
2547         yaffs_trace(YAFFS_TRACE_TRACING,
2548                 "Collecting block %d, in use %d, shrink %d, whole_block %d",
2549                 block, bi->pages_in_use, bi->has_shrink_hdr,
2550                 whole_block);
2551
2552         /*yaffs_verify_free_chunks(dev); */
2553
2554         if (bi->block_state == YAFFS_BLOCK_STATE_FULL)
2555                 bi->block_state = YAFFS_BLOCK_STATE_COLLECTING;
2556
2557         bi->has_shrink_hdr = 0; /* clear the flag so that the block can erase */
2558
2559         dev->gc_disable = 1;
2560
2561         yaffs_summary_gc(dev, block);
2562
2563         if (is_checkpt_block || !yaffs_still_some_chunks(dev, block)) {
2564                 yaffs_trace(YAFFS_TRACE_TRACING,
2565                         "Collecting block %d that has no chunks in use",
2566                         block);
2567                 yaffs_block_became_dirty(dev, block);
2568         } else {
2569
2570                 u8 *buffer = yaffs_get_temp_buffer(dev);
2571
2572                 yaffs_verify_blk(dev, bi, block);
2573
2574                 max_copies = (whole_block) ? dev->param.chunks_per_block : 5;
2575                 old_chunk = block * dev->param.chunks_per_block + dev->gc_chunk;
2576
2577                 for (/* init already done */ ;
2578                      ret_val == YAFFS_OK &&
2579                      dev->gc_chunk < dev->param.chunks_per_block &&
2580                      (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) &&
2581                      max_copies > 0;
2582                      dev->gc_chunk++, old_chunk++) {
2583                         if (yaffs_check_chunk_bit(dev, block, dev->gc_chunk)) {
2584                                 /* Page is in use and might need to be copied */
2585                                 max_copies--;
2586                                 ret_val = yaffs_gc_process_chunk(dev, bi,
2587                                                         old_chunk, buffer);
2588                         }
2589                 }
2590                 yaffs_release_temp_buffer(dev, buffer);
2591         }
2592
2593         yaffs_verify_collected_blk(dev, bi, block);
2594
2595         if (bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2596                 /*
2597                  * The gc did not complete. Set block state back to FULL
2598                  * because checkpointing does not restore gc.
2599                  */
2600                 bi->block_state = YAFFS_BLOCK_STATE_FULL;
2601         } else {
2602                 /* The gc completed. */
2603                 /* Do any required cleanups */
2604                 for (i = 0; i < dev->n_clean_ups; i++) {
2605                         /* Time to delete the file too */
2606                         struct yaffs_obj *object =
2607                             yaffs_find_by_number(dev, dev->gc_cleanup_list[i]);
2608                         if (object) {
2609                                 yaffs_free_tnode(dev,
2610                                           object->variant.file_variant.top);
2611                                 object->variant.file_variant.top = NULL;
2612                                 yaffs_trace(YAFFS_TRACE_GC,
2613                                         "yaffs: About to finally delete object %d",
2614                                         object->obj_id);
2615                                 yaffs_generic_obj_del(object);
2616                                 object->my_dev->n_deleted_files--;
2617                         }
2618
2619                 }
2620                 chunks_after = yaffs_get_erased_chunks(dev);
2621                 if (chunks_before >= chunks_after)
2622                         yaffs_trace(YAFFS_TRACE_GC,
2623                                 "gc did not increase free chunks before %d after %d",
2624                                 chunks_before, chunks_after);
2625                 dev->gc_block = 0;
2626                 dev->gc_chunk = 0;
2627                 dev->n_clean_ups = 0;
2628         }
2629
2630         dev->gc_disable = 0;
2631
2632         return ret_val;
2633 }
2634
2635 /*
2636  * find_gc_block() selects the dirtiest block (or close enough)
2637  * for garbage collection.
2638  */
2639
2640 static unsigned yaffs_find_gc_block(struct yaffs_dev *dev,
2641                                     int aggressive, int background)
2642 {
2643         int i;
2644         int iterations;
2645         unsigned selected = 0;
2646         int prioritised = 0;
2647         int prioritised_exist = 0;
2648         struct yaffs_block_info *bi;
2649         int threshold;
2650
2651         /* First let's see if we need to grab a prioritised block */
2652         if (dev->has_pending_prioritised_gc && !aggressive) {
2653                 dev->gc_dirtiest = 0;
2654                 bi = dev->block_info;
2655                 for (i = dev->internal_start_block;
2656                      i <= dev->internal_end_block && !selected; i++) {
2657
2658                         if (bi->gc_prioritise) {
2659                                 prioritised_exist = 1;
2660                                 if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2661                                     yaffs_block_ok_for_gc(dev, bi)) {
2662                                         selected = i;
2663                                         prioritised = 1;
2664                                 }
2665                         }
2666                         bi++;
2667                 }
2668
2669                 /*
2670                  * If there is a prioritised block and none was selected then
2671                  * this happened because there is at least one old dirty block
2672                  * gumming up the works. Let's gc the oldest dirty block.
2673                  */
2674
2675                 if (prioritised_exist &&
2676                     !selected && dev->oldest_dirty_block > 0)
2677                         selected = dev->oldest_dirty_block;
2678
2679                 if (!prioritised_exist) /* None found, so we can clear this */
2680                         dev->has_pending_prioritised_gc = 0;
2681         }
2682
2683         /* If we're doing aggressive GC then we are happy to take a less-dirty
2684          * block, and search harder.
2685          * else (leasurely gc), then we only bother to do this if the
2686          * block has only a few pages in use.
2687          */
2688
2689         if (!selected) {
2690                 int pages_used;
2691                 int n_blocks =
2692                     dev->internal_end_block - dev->internal_start_block + 1;
2693                 if (aggressive) {
2694                         threshold = dev->param.chunks_per_block;
2695                         iterations = n_blocks;
2696                 } else {
2697                         int max_threshold;
2698
2699                         if (background)
2700                                 max_threshold = dev->param.chunks_per_block / 2;
2701                         else
2702                                 max_threshold = dev->param.chunks_per_block / 8;
2703
2704                         if (max_threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2705                                 max_threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2706
2707                         threshold = background ? (dev->gc_not_done + 2) * 2 : 0;
2708                         if (threshold < YAFFS_GC_PASSIVE_THRESHOLD)
2709                                 threshold = YAFFS_GC_PASSIVE_THRESHOLD;
2710                         if (threshold > max_threshold)
2711                                 threshold = max_threshold;
2712
2713                         iterations = n_blocks / 16 + 1;
2714                         if (iterations > 100)
2715                                 iterations = 100;
2716                 }
2717
2718                 for (i = 0;
2719                      i < iterations &&
2720                      (dev->gc_dirtiest < 1 ||
2721                       dev->gc_pages_in_use > YAFFS_GC_GOOD_ENOUGH);
2722                      i++) {
2723                         dev->gc_block_finder++;
2724                         if (dev->gc_block_finder < dev->internal_start_block ||
2725                             dev->gc_block_finder > dev->internal_end_block)
2726                                 dev->gc_block_finder =
2727                                     dev->internal_start_block;
2728
2729                         bi = yaffs_get_block_info(dev, dev->gc_block_finder);
2730
2731                         pages_used = bi->pages_in_use - bi->soft_del_pages;
2732
2733                         if (bi->block_state == YAFFS_BLOCK_STATE_FULL &&
2734                             pages_used < dev->param.chunks_per_block &&
2735                             (dev->gc_dirtiest < 1 ||
2736                              pages_used < dev->gc_pages_in_use) &&
2737                             yaffs_block_ok_for_gc(dev, bi)) {
2738                                 dev->gc_dirtiest = dev->gc_block_finder;
2739                                 dev->gc_pages_in_use = pages_used;
2740                         }
2741                 }
2742
2743                 if (dev->gc_dirtiest > 0 && dev->gc_pages_in_use <= threshold)
2744                         selected = dev->gc_dirtiest;
2745         }
2746
2747         /*
2748          * If nothing has been selected for a while, try the oldest dirty
2749          * because that's gumming up the works.
2750          */
2751
2752         if (!selected && dev->param.is_yaffs2 &&
2753             dev->gc_not_done >= (background ? 10 : 20)) {
2754                 yaffs2_find_oldest_dirty_seq(dev);
2755                 if (dev->oldest_dirty_block > 0) {
2756                         selected = dev->oldest_dirty_block;
2757                         dev->gc_dirtiest = selected;
2758                         dev->oldest_dirty_gc_count++;
2759                         bi = yaffs_get_block_info(dev, selected);
2760                         dev->gc_pages_in_use =
2761                             bi->pages_in_use - bi->soft_del_pages;
2762                 } else {
2763                         dev->gc_not_done = 0;
2764                 }
2765         }
2766
2767         if (selected) {
2768                 yaffs_trace(YAFFS_TRACE_GC,
2769                         "GC Selected block %d with %d free, prioritised:%d",
2770                         selected,
2771                         dev->param.chunks_per_block - dev->gc_pages_in_use,
2772                         prioritised);
2773
2774                 dev->n_gc_blocks++;
2775                 if (background)
2776                         dev->bg_gcs++;
2777
2778                 dev->gc_dirtiest = 0;
2779                 dev->gc_pages_in_use = 0;
2780                 dev->gc_not_done = 0;
2781                 if (dev->refresh_skip > 0)
2782                         dev->refresh_skip--;
2783         } else {
2784                 dev->gc_not_done++;
2785                 yaffs_trace(YAFFS_TRACE_GC,
2786                         "GC none: finder %d skip %d threshold %d dirtiest %d using %d oldest %d%s",
2787                         dev->gc_block_finder, dev->gc_not_done, threshold,
2788                         dev->gc_dirtiest, dev->gc_pages_in_use,
2789                         dev->oldest_dirty_block, background ? " bg" : "");
2790         }
2791
2792         return selected;
2793 }
2794
2795 /* New garbage collector
2796  * If we're very low on erased blocks then we do aggressive garbage collection
2797  * otherwise we do "leasurely" garbage collection.
2798  * Aggressive gc looks further (whole array) and will accept less dirty blocks.
2799  * Passive gc only inspects smaller areas and only accepts more dirty blocks.
2800  *
2801  * The idea is to help clear out space in a more spread-out manner.
2802  * Dunno if it really does anything useful.
2803  */
2804 static int yaffs_check_gc(struct yaffs_dev *dev, int background)
2805 {
2806         int aggressive = 0;
2807         int gc_ok = YAFFS_OK;
2808         int max_tries = 0;
2809         int min_erased;
2810         int erased_chunks;
2811         int checkpt_block_adjust;
2812
2813         if (dev->param.gc_control && (dev->param.gc_control(dev) & 1) == 0)
2814                 return YAFFS_OK;
2815
2816         if (dev->gc_disable)
2817                 /* Bail out so we don't get recursive gc */
2818                 return YAFFS_OK;
2819
2820         /* This loop should pass the first time.
2821          * Only loops here if the collection does not increase space.
2822          */
2823
2824         do {
2825                 max_tries++;
2826
2827                 checkpt_block_adjust = yaffs_calc_checkpt_blocks_required(dev);
2828
2829                 min_erased =
2830                     dev->param.n_reserved_blocks + checkpt_block_adjust + 1;
2831                 erased_chunks =
2832                     dev->n_erased_blocks * dev->param.chunks_per_block;
2833
2834                 /* If we need a block soon then do aggressive gc. */
2835                 if (dev->n_erased_blocks < min_erased)
2836                         aggressive = 1;
2837                 else {
2838                         if (!background
2839                             && erased_chunks > (dev->n_free_chunks / 4))
2840                                 break;
2841
2842                         if (dev->gc_skip > 20)
2843                                 dev->gc_skip = 20;
2844                         if (erased_chunks < dev->n_free_chunks / 2 ||
2845                             dev->gc_skip < 1 || background)
2846                                 aggressive = 0;
2847                         else {
2848                                 dev->gc_skip--;
2849                                 break;
2850                         }
2851                 }
2852
2853                 dev->gc_skip = 5;
2854
2855                 /* If we don't already have a block being gc'd then see if we
2856                  * should start another */
2857
2858                 if (dev->gc_block < 1 && !aggressive) {
2859                         dev->gc_block = yaffs2_find_refresh_block(dev);
2860                         dev->gc_chunk = 0;
2861                         dev->n_clean_ups = 0;
2862                 }
2863                 if (dev->gc_block < 1) {
2864                         dev->gc_block =
2865                             yaffs_find_gc_block(dev, aggressive, background);
2866                         dev->gc_chunk = 0;
2867                         dev->n_clean_ups = 0;
2868                 }
2869
2870                 if (dev->gc_block > 0) {
2871                         dev->all_gcs++;
2872                         if (!aggressive)
2873                                 dev->passive_gc_count++;
2874
2875                         yaffs_trace(YAFFS_TRACE_GC,
2876                                 "yaffs: GC n_erased_blocks %d aggressive %d",
2877                                 dev->n_erased_blocks, aggressive);
2878
2879                         gc_ok = yaffs_gc_block(dev, dev->gc_block, aggressive);
2880                 }
2881
2882                 if (dev->n_erased_blocks < (dev->param.n_reserved_blocks) &&
2883                     dev->gc_block > 0) {
2884                         yaffs_trace(YAFFS_TRACE_GC,
2885                                 "yaffs: GC !!!no reclaim!!! n_erased_blocks %d after try %d block %d",
2886                                 dev->n_erased_blocks, max_tries,
2887                                 dev->gc_block);
2888                 }
2889         } while ((dev->n_erased_blocks < dev->param.n_reserved_blocks) &&
2890                  (dev->gc_block > 0) && (max_tries < 2));
2891
2892         return aggressive ? gc_ok : YAFFS_OK;
2893 }
2894
2895 /*
2896  * yaffs_bg_gc()
2897  * Garbage collects. Intended to be called from a background thread.
2898  * Returns non-zero if at least half the free chunks are erased.
2899  */
2900 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency)
2901 {
2902         int erased_chunks = dev->n_erased_blocks * dev->param.chunks_per_block;
2903
2904         yaffs_trace(YAFFS_TRACE_BACKGROUND, "Background gc %u", urgency);
2905
2906         yaffs_check_gc(dev, 1);
2907         return erased_chunks > dev->n_free_chunks / 2;
2908 }
2909
2910 /*-------------------- Data file manipulation -----------------*/
2911
2912 static int yaffs_rd_data_obj(struct yaffs_obj *in, int inode_chunk, u8 * buffer)
2913 {
2914         int nand_chunk = yaffs_find_chunk_in_file(in, inode_chunk, NULL);
2915
2916         if (nand_chunk >= 0)
2917                 return yaffs_rd_chunk_tags_nand(in->my_dev, nand_chunk,
2918                                                 buffer, NULL);
2919         else {
2920                 yaffs_trace(YAFFS_TRACE_NANDACCESS,
2921                         "Chunk %d not found zero instead",
2922                         nand_chunk);
2923                 /* get sane (zero) data if you read a hole */
2924                 memset(buffer, 0, in->my_dev->data_bytes_per_chunk);
2925                 return 0;
2926         }
2927
2928 }
2929
2930 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
2931                      int lyn)
2932 {
2933         int block;
2934         int page;
2935         struct yaffs_ext_tags tags;
2936         struct yaffs_block_info *bi;
2937
2938         if (chunk_id <= 0)
2939                 return;
2940
2941         dev->n_deletions++;
2942         block = chunk_id / dev->param.chunks_per_block;
2943         page = chunk_id % dev->param.chunks_per_block;
2944
2945         if (!yaffs_check_chunk_bit(dev, block, page))
2946                 yaffs_trace(YAFFS_TRACE_VERIFY,
2947                         "Deleting invalid chunk %d", chunk_id);
2948
2949         bi = yaffs_get_block_info(dev, block);
2950
2951         yaffs2_update_oldest_dirty_seq(dev, block, bi);
2952
2953         yaffs_trace(YAFFS_TRACE_DELETION,
2954                 "line %d delete of chunk %d",
2955                 lyn, chunk_id);
2956
2957         if (!dev->param.is_yaffs2 && mark_flash &&
2958             bi->block_state != YAFFS_BLOCK_STATE_COLLECTING) {
2959
2960                 memset(&tags, 0, sizeof(tags));
2961                 tags.is_deleted = 1;
2962                 yaffs_wr_chunk_tags_nand(dev, chunk_id, NULL, &tags);
2963                 yaffs_handle_chunk_update(dev, chunk_id, &tags);
2964         } else {
2965                 dev->n_unmarked_deletions++;
2966         }
2967
2968         /* Pull out of the management area.
2969          * If the whole block became dirty, this will kick off an erasure.
2970          */
2971         if (bi->block_state == YAFFS_BLOCK_STATE_ALLOCATING ||
2972             bi->block_state == YAFFS_BLOCK_STATE_FULL ||
2973             bi->block_state == YAFFS_BLOCK_STATE_NEEDS_SCAN ||
2974             bi->block_state == YAFFS_BLOCK_STATE_COLLECTING) {
2975                 dev->n_free_chunks++;
2976                 yaffs_clear_chunk_bit(dev, block, page);
2977                 bi->pages_in_use--;
2978
2979                 if (bi->pages_in_use == 0 &&
2980                     !bi->has_shrink_hdr &&
2981                     bi->block_state != YAFFS_BLOCK_STATE_ALLOCATING &&
2982                     bi->block_state != YAFFS_BLOCK_STATE_NEEDS_SCAN) {
2983                         yaffs_block_became_dirty(dev, block);
2984                 }
2985         }
2986 }
2987
2988 static int yaffs_wr_data_obj(struct yaffs_obj *in, int inode_chunk,
2989                              const u8 *buffer, int n_bytes, int use_reserve)
2990 {
2991         /* Find old chunk Need to do this to get serial number
2992          * Write new one and patch into tree.
2993          * Invalidate old tags.
2994          */
2995
2996         int prev_chunk_id;
2997         struct yaffs_ext_tags prev_tags;
2998         int new_chunk_id;
2999         struct yaffs_ext_tags new_tags;
3000         struct yaffs_dev *dev = in->my_dev;
3001
3002         yaffs_check_gc(dev, 0);
3003
3004         /* Get the previous chunk at this location in the file if it exists.
3005          * If it does not exist then put a zero into the tree. This creates
3006          * the tnode now, rather than later when it is harder to clean up.
3007          */
3008         prev_chunk_id = yaffs_find_chunk_in_file(in, inode_chunk, &prev_tags);
3009         if (prev_chunk_id < 1 &&
3010             !yaffs_put_chunk_in_file(in, inode_chunk, 0, 0))
3011                 return 0;
3012
3013         /* Set up new tags */
3014         memset(&new_tags, 0, sizeof(new_tags));
3015
3016         new_tags.chunk_id = inode_chunk;
3017         new_tags.obj_id = in->obj_id;
3018         new_tags.serial_number =
3019             (prev_chunk_id > 0) ? prev_tags.serial_number + 1 : 1;
3020         new_tags.n_bytes = n_bytes;
3021
3022         if (n_bytes < 1 || n_bytes > dev->param.total_bytes_per_chunk) {
3023                 yaffs_trace(YAFFS_TRACE_ERROR,
3024                   "Writing %d bytes to chunk!!!!!!!!!",
3025                    n_bytes);
3026                 BUG();
3027         }
3028
3029         new_chunk_id =
3030             yaffs_write_new_chunk(dev, buffer, &new_tags, use_reserve);
3031
3032         if (new_chunk_id > 0) {
3033                 yaffs_put_chunk_in_file(in, inode_chunk, new_chunk_id, 0);
3034
3035                 if (prev_chunk_id > 0)
3036                         yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3037
3038                 yaffs_verify_file_sane(in);
3039         }
3040         return new_chunk_id;
3041
3042 }
3043
3044
3045
3046 static int yaffs_do_xattrib_mod(struct yaffs_obj *obj, int set,
3047                                 const YCHAR *name, const void *value, int size,
3048                                 int flags)
3049 {
3050         struct yaffs_xattr_mod xmod;
3051         int result;
3052
3053         xmod.set = set;
3054         xmod.name = name;
3055         xmod.data = value;
3056         xmod.size = size;
3057         xmod.flags = flags;
3058         xmod.result = -ENOSPC;
3059
3060         result = yaffs_update_oh(obj, NULL, 0, 0, 0, &xmod);
3061
3062         if (result > 0)
3063                 return xmod.result;
3064         else
3065                 return -ENOSPC;
3066 }
3067
3068 static int yaffs_apply_xattrib_mod(struct yaffs_obj *obj, char *buffer,
3069                                    struct yaffs_xattr_mod *xmod)
3070 {
3071         int retval = 0;
3072         int x_offs = sizeof(struct yaffs_obj_hdr);
3073         struct yaffs_dev *dev = obj->my_dev;
3074         int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3075         char *x_buffer = buffer + x_offs;
3076
3077         if (xmod->set)
3078                 retval =
3079                     nval_set(x_buffer, x_size, xmod->name, xmod->data,
3080                              xmod->size, xmod->flags);
3081         else
3082                 retval = nval_del(x_buffer, x_size, xmod->name);
3083
3084         obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3085         obj->xattr_known = 1;
3086         xmod->result = retval;
3087
3088         return retval;
3089 }
3090
3091 static int yaffs_do_xattrib_fetch(struct yaffs_obj *obj, const YCHAR *name,
3092                                   void *value, int size)
3093 {
3094         char *buffer = NULL;
3095         int result;
3096         struct yaffs_ext_tags tags;
3097         struct yaffs_dev *dev = obj->my_dev;
3098         int x_offs = sizeof(struct yaffs_obj_hdr);
3099         int x_size = dev->data_bytes_per_chunk - sizeof(struct yaffs_obj_hdr);
3100         char *x_buffer;
3101         int retval = 0;
3102
3103         if (obj->hdr_chunk < 1)
3104                 return -ENODATA;
3105
3106         /* If we know that the object has no xattribs then don't do all the
3107          * reading and parsing.
3108          */
3109         if (obj->xattr_known && !obj->has_xattr) {
3110                 if (name)
3111                         return -ENODATA;
3112                 else
3113                         return 0;
3114         }
3115
3116         buffer = (char *)yaffs_get_temp_buffer(dev);
3117         if (!buffer)
3118                 return -ENOMEM;
3119
3120         result =
3121             yaffs_rd_chunk_tags_nand(dev, obj->hdr_chunk, (u8 *) buffer, &tags);
3122
3123         if (result != YAFFS_OK)
3124                 retval = -ENOENT;
3125         else {
3126                 x_buffer = buffer + x_offs;
3127
3128                 if (!obj->xattr_known) {
3129                         obj->has_xattr = nval_hasvalues(x_buffer, x_size);
3130                         obj->xattr_known = 1;
3131                 }
3132
3133                 if (name)
3134                         retval = nval_get(x_buffer, x_size, name, value, size);
3135                 else
3136                         retval = nval_list(x_buffer, x_size, value, size);
3137         }
3138         yaffs_release_temp_buffer(dev, (u8 *) buffer);
3139         return retval;
3140 }
3141
3142 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR * name,
3143                       const void *value, int size, int flags)
3144 {
3145         return yaffs_do_xattrib_mod(obj, 1, name, value, size, flags);
3146 }
3147
3148 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR * name)
3149 {
3150         return yaffs_do_xattrib_mod(obj, 0, name, NULL, 0, 0);
3151 }
3152
3153 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR * name, void *value,
3154                       int size)
3155 {
3156         return yaffs_do_xattrib_fetch(obj, name, value, size);
3157 }
3158
3159 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size)
3160 {
3161         return yaffs_do_xattrib_fetch(obj, NULL, buffer, size);
3162 }
3163
3164 static void yaffs_check_obj_details_loaded(struct yaffs_obj *in)
3165 {
3166         u8 *buf;
3167         struct yaffs_obj_hdr *oh;
3168         struct yaffs_dev *dev;
3169         struct yaffs_ext_tags tags;
3170         int result;
3171         int alloc_failed = 0;
3172
3173         if (!in || !in->lazy_loaded || in->hdr_chunk < 1)
3174                 return;
3175
3176         dev = in->my_dev;
3177         in->lazy_loaded = 0;
3178         buf = yaffs_get_temp_buffer(dev);
3179
3180         result = yaffs_rd_chunk_tags_nand(dev, in->hdr_chunk, buf, &tags);
3181         oh = (struct yaffs_obj_hdr *)buf;
3182
3183         in->yst_mode = oh->yst_mode;
3184         yaffs_load_attribs(in, oh);
3185         yaffs_set_obj_name_from_oh(in, oh);
3186
3187         if (in->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
3188                 in->variant.symlink_variant.alias =
3189                     yaffs_clone_str(oh->alias);
3190                 if (!in->variant.symlink_variant.alias)
3191                         alloc_failed = 1;       /* Not returned */
3192         }
3193         yaffs_release_temp_buffer(dev, buf);
3194 }
3195
3196 static void yaffs_load_name_from_oh(struct yaffs_dev *dev, YCHAR *name,
3197                                     const YCHAR *oh_name, int buff_size)
3198 {
3199 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3200         if (dev->param.auto_unicode) {
3201                 if (*oh_name) {
3202                         /* It is an ASCII name, do an ASCII to
3203                          * unicode conversion */
3204                         const char *ascii_oh_name = (const char *)oh_name;
3205                         int n = buff_size - 1;
3206                         while (n > 0 && *ascii_oh_name) {
3207                                 *name = *ascii_oh_name;
3208                                 name++;
3209                                 ascii_oh_name++;
3210                                 n--;
3211                         }
3212                 } else {
3213                         strncpy(name, oh_name + 1, buff_size - 1);
3214                 }
3215         } else {
3216 #else
3217         {
3218 #endif
3219                 strncpy(name, oh_name, buff_size - 1);
3220         }
3221 }
3222
3223 static void yaffs_load_oh_from_name(struct yaffs_dev *dev, YCHAR *oh_name,
3224                                     const YCHAR *name)
3225 {
3226 #ifdef CONFIG_YAFFS_AUTO_UNICODE
3227
3228         int is_ascii;
3229         YCHAR *w;
3230
3231         if (dev->param.auto_unicode) {
3232
3233                 is_ascii = 1;
3234                 w = name;
3235
3236                 /* Figure out if the name will fit in ascii character set */
3237                 while (is_ascii && *w) {
3238                         if ((*w) & 0xff00)
3239                                 is_ascii = 0;
3240                         w++;
3241                 }
3242
3243                 if (is_ascii) {
3244                         /* It is an ASCII name, so convert unicode to ascii */
3245                         char *ascii_oh_name = (char *)oh_name;
3246                         int n = YAFFS_MAX_NAME_LENGTH - 1;
3247                         while (n > 0 && *name) {
3248                                 *ascii_oh_name = *name;
3249                                 name++;
3250                                 ascii_oh_name++;
3251                                 n--;
3252                         }
3253                 } else {
3254                         /* Unicode name, so save starting at the second YCHAR */
3255                         *oh_name = 0;
3256                         strncpy(oh_name + 1, name, YAFFS_MAX_NAME_LENGTH - 2);
3257                 }
3258         } else {
3259 #else
3260         {
3261 #endif
3262                 strncpy(oh_name, name, YAFFS_MAX_NAME_LENGTH - 1);
3263         }
3264 }
3265
3266 /* UpdateObjectHeader updates the header on NAND for an object.
3267  * If name is not NULL, then that new name is used.
3268  */
3269 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name, int force,
3270                     int is_shrink, int shadows, struct yaffs_xattr_mod *xmod)
3271 {
3272
3273         struct yaffs_block_info *bi;
3274         struct yaffs_dev *dev = in->my_dev;
3275         int prev_chunk_id;
3276         int ret_val = 0;
3277         int result = 0;
3278         int new_chunk_id;
3279         struct yaffs_ext_tags new_tags;
3280         struct yaffs_ext_tags old_tags;
3281         const YCHAR *alias = NULL;
3282         u8 *buffer = NULL;
3283         YCHAR old_name[YAFFS_MAX_NAME_LENGTH + 1];
3284         struct yaffs_obj_hdr *oh = NULL;
3285
3286         strcpy(old_name, _Y("silly old name"));
3287
3288         if (in->fake && in != dev->root_dir && !force && !xmod)
3289                 return ret_val;
3290
3291         yaffs_check_gc(dev, 0);
3292         yaffs_check_obj_details_loaded(in);
3293
3294         buffer = yaffs_get_temp_buffer(in->my_dev);
3295         oh = (struct yaffs_obj_hdr *)buffer;
3296
3297         prev_chunk_id = in->hdr_chunk;
3298
3299         if (prev_chunk_id > 0) {
3300                 result = yaffs_rd_chunk_tags_nand(dev, prev_chunk_id,
3301                                                   buffer, &old_tags);
3302
3303                 yaffs_verify_oh(in, oh, &old_tags, 0);
3304                 memcpy(old_name, oh->name, sizeof(oh->name));
3305                 memset(buffer, 0xff, sizeof(struct yaffs_obj_hdr));
3306         } else {
3307                 memset(buffer, 0xff, dev->data_bytes_per_chunk);
3308         }
3309
3310         oh->type = in->variant_type;
3311         oh->yst_mode = in->yst_mode;
3312         oh->shadows_obj = oh->inband_shadowed_obj_id = shadows;
3313
3314         yaffs_load_attribs_oh(oh, in);
3315
3316         if (in->parent)
3317                 oh->parent_obj_id = in->parent->obj_id;
3318         else
3319                 oh->parent_obj_id = 0;
3320
3321         if (name && *name) {
3322                 memset(oh->name, 0, sizeof(oh->name));
3323                 yaffs_load_oh_from_name(dev, oh->name, name);
3324         } else if (prev_chunk_id > 0) {
3325                 memcpy(oh->name, old_name, sizeof(oh->name));
3326         } else {
3327                 memset(oh->name, 0, sizeof(oh->name));
3328         }
3329
3330         oh->is_shrink = is_shrink;
3331
3332         switch (in->variant_type) {
3333         case YAFFS_OBJECT_TYPE_UNKNOWN:
3334                 /* Should not happen */
3335                 break;
3336         case YAFFS_OBJECT_TYPE_FILE:
3337                 oh->file_size =
3338                     (oh->parent_obj_id == YAFFS_OBJECTID_DELETED ||
3339                      oh->parent_obj_id == YAFFS_OBJECTID_UNLINKED) ?
3340                      0 : in->variant.file_variant.file_size;
3341                 break;
3342         case YAFFS_OBJECT_TYPE_HARDLINK:
3343                 oh->equiv_id = in->variant.hardlink_variant.equiv_id;
3344                 break;
3345         case YAFFS_OBJECT_TYPE_SPECIAL:
3346                 /* Do nothing */
3347                 break;
3348         case YAFFS_OBJECT_TYPE_DIRECTORY:
3349                 /* Do nothing */
3350                 break;
3351         case YAFFS_OBJECT_TYPE_SYMLINK:
3352                 alias = in->variant.symlink_variant.alias;
3353                 if (!alias)
3354                         alias = _Y("no alias");
3355                 strncpy(oh->alias, alias, YAFFS_MAX_ALIAS_LENGTH);
3356                 oh->alias[YAFFS_MAX_ALIAS_LENGTH] = 0;
3357                 break;
3358         }
3359
3360         /* process any xattrib modifications */
3361         if (xmod)
3362                 yaffs_apply_xattrib_mod(in, (char *)buffer, xmod);
3363
3364         /* Tags */
3365         memset(&new_tags, 0, sizeof(new_tags));
3366         in->serial++;
3367         new_tags.chunk_id = 0;
3368         new_tags.obj_id = in->obj_id;
3369         new_tags.serial_number = in->serial;
3370
3371         /* Add extra info for file header */
3372         new_tags.extra_available = 1;
3373         new_tags.extra_parent_id = oh->parent_obj_id;
3374         new_tags.extra_length = oh->file_size;
3375         new_tags.extra_is_shrink = oh->is_shrink;
3376         new_tags.extra_equiv_id = oh->equiv_id;
3377         new_tags.extra_shadows = (oh->shadows_obj > 0) ? 1 : 0;
3378         new_tags.extra_obj_type = in->variant_type;
3379         yaffs_verify_oh(in, oh, &new_tags, 1);
3380
3381         /* Create new chunk in NAND */
3382         new_chunk_id =
3383             yaffs_write_new_chunk(dev, buffer, &new_tags,
3384                                   (prev_chunk_id > 0) ? 1 : 0);
3385
3386         if (buffer)
3387                 yaffs_release_temp_buffer(dev, buffer);
3388
3389         if (new_chunk_id < 0)
3390                 return new_chunk_id;
3391
3392         in->hdr_chunk = new_chunk_id;
3393
3394         if (prev_chunk_id > 0)
3395                 yaffs_chunk_del(dev, prev_chunk_id, 1, __LINE__);
3396
3397         if (!yaffs_obj_cache_dirty(in))
3398                 in->dirty = 0;
3399
3400         /* If this was a shrink, then mark the block
3401          * that the chunk lives on */
3402         if (is_shrink) {
3403                 bi = yaffs_get_block_info(in->my_dev,
3404                                           new_chunk_id /
3405                                           in->my_dev->param.chunks_per_block);
3406                 bi->has_shrink_hdr = 1;
3407         }
3408
3409
3410         return new_chunk_id;
3411 }
3412
3413 /*--------------------- File read/write ------------------------
3414  * Read and write have very similar structures.
3415  * In general the read/write has three parts to it
3416  * An incomplete chunk to start with (if the read/write is not chunk-aligned)
3417  * Some complete chunks
3418  * An incomplete chunk to end off with
3419  *
3420  * Curve-balls: the first chunk might also be the last chunk.
3421  */
3422
3423 int yaffs_file_rd(struct yaffs_obj *in, u8 * buffer, loff_t offset, int n_bytes)
3424 {
3425         int chunk;
3426         u32 start;
3427         int n_copy;
3428         int n = n_bytes;
3429         int n_done = 0;
3430         struct yaffs_cache *cache;
3431         struct yaffs_dev *dev;
3432
3433         dev = in->my_dev;
3434
3435         while (n > 0) {
3436                 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3437                 chunk++;
3438
3439                 /* OK now check for the curveball where the start and end are in
3440                  * the same chunk.
3441                  */
3442                 if ((start + n) < dev->data_bytes_per_chunk)
3443                         n_copy = n;
3444                 else
3445                         n_copy = dev->data_bytes_per_chunk - start;
3446
3447                 cache = yaffs_find_chunk_cache(in, chunk);
3448
3449                 /* If the chunk is already in the cache or it is less than
3450                  * a whole chunk or we're using inband tags then use the cache
3451                  * (if there is caching) else bypass the cache.
3452                  */
3453                 if (cache || n_copy != dev->data_bytes_per_chunk ||
3454                     dev->param.inband_tags) {
3455                         if (dev->param.n_caches > 0) {
3456
3457                                 /* If we can't find the data in the cache,
3458                                  * then load it up. */
3459
3460                                 if (!cache) {
3461                                         cache =
3462                                             yaffs_grab_chunk_cache(in->my_dev);
3463                                         cache->object = in;
3464                                         cache->chunk_id = chunk;
3465                                         cache->dirty = 0;
3466                                         cache->locked = 0;
3467                                         yaffs_rd_data_obj(in, chunk,
3468                                                           cache->data);
3469                                         cache->n_bytes = 0;
3470                                 }
3471
3472                                 yaffs_use_cache(dev, cache, 0);
3473
3474                                 cache->locked = 1;
3475
3476                                 memcpy(buffer, &cache->data[start], n_copy);
3477
3478                                 cache->locked = 0;
3479                         } else {
3480                                 /* Read into the local buffer then copy.. */
3481
3482                                 u8 *local_buffer =
3483                                     yaffs_get_temp_buffer(dev);
3484                                 yaffs_rd_data_obj(in, chunk, local_buffer);
3485
3486                                 memcpy(buffer, &local_buffer[start], n_copy);
3487
3488                                 yaffs_release_temp_buffer(dev, local_buffer);
3489                         }
3490                 } else {
3491                         /* A full chunk. Read directly into the buffer. */
3492                         yaffs_rd_data_obj(in, chunk, buffer);
3493                 }
3494                 n -= n_copy;
3495                 offset += n_copy;
3496                 buffer += n_copy;
3497                 n_done += n_copy;
3498         }
3499         return n_done;
3500 }
3501
3502 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
3503                      int n_bytes, int write_trhrough)
3504 {
3505
3506         int chunk;
3507         u32 start;
3508         int n_copy;
3509         int n = n_bytes;
3510         int n_done = 0;
3511         int n_writeback;
3512         int start_write = offset;
3513         int chunk_written = 0;
3514         u32 n_bytes_read;
3515         u32 chunk_start;
3516         struct yaffs_dev *dev;
3517
3518         dev = in->my_dev;
3519
3520         while (n > 0 && chunk_written >= 0) {
3521                 yaffs_addr_to_chunk(dev, offset, &chunk, &start);
3522
3523                 if (chunk * dev->data_bytes_per_chunk + start != offset ||
3524                     start >= dev->data_bytes_per_chunk) {
3525                         yaffs_trace(YAFFS_TRACE_ERROR,
3526                                 "AddrToChunk of offset %d gives chunk %d start %d",
3527                                 (int)offset, chunk, start);
3528                 }
3529                 chunk++;        /* File pos to chunk in file offset */
3530
3531                 /* OK now check for the curveball where the start and end are in
3532                  * the same chunk.
3533                  */
3534
3535                 if ((start + n) < dev->data_bytes_per_chunk) {
3536                         n_copy = n;
3537
3538                         /* Now calculate how many bytes to write back....
3539                          * If we're overwriting and not writing to then end of
3540                          * file then we need to write back as much as was there
3541                          * before.
3542                          */
3543
3544                         chunk_start = ((chunk - 1) * dev->data_bytes_per_chunk);
3545
3546                         if (chunk_start > in->variant.file_variant.file_size)
3547                                 n_bytes_read = 0;       /* Past end of file */
3548                         else
3549                                 n_bytes_read =
3550                                     in->variant.file_variant.file_size -
3551                                     chunk_start;
3552
3553                         if (n_bytes_read > dev->data_bytes_per_chunk)
3554                                 n_bytes_read = dev->data_bytes_per_chunk;
3555
3556                         n_writeback =
3557                             (n_bytes_read >
3558                              (start + n)) ? n_bytes_read : (start + n);
3559
3560                         if (n_writeback < 0 ||
3561                             n_writeback > dev->data_bytes_per_chunk)
3562                                 BUG();
3563
3564                 } else {
3565                         n_copy = dev->data_bytes_per_chunk - start;
3566                         n_writeback = dev->data_bytes_per_chunk;
3567                 }
3568
3569                 if (n_copy != dev->data_bytes_per_chunk ||
3570                     dev->param.inband_tags) {
3571                         /* An incomplete start or end chunk (or maybe both
3572                          * start and end chunk), or we're using inband tags,
3573                          * so we want to use the cache buffers.
3574                          */
3575                         if (dev->param.n_caches > 0) {
3576                                 struct yaffs_cache *cache;
3577
3578                                 /* If we can't find the data in the cache, then
3579                                  * load the cache */
3580                                 cache = yaffs_find_chunk_cache(in, chunk);
3581
3582                                 if (!cache &&
3583                                     yaffs_check_alloc_available(dev, 1)) {
3584                                         cache = yaffs_grab_chunk_cache(dev);
3585                                         cache->object = in;
3586                                         cache->chunk_id = chunk;
3587                                         cache->dirty = 0;
3588                                         cache->locked = 0;
3589                                         yaffs_rd_data_obj(in, chunk,
3590                                                           cache->data);
3591                                 } else if (cache &&
3592                                            !cache->dirty &&
3593                                            !yaffs_check_alloc_available(dev,
3594                                                                         1)) {
3595                                         /* Drop the cache if it was a read cache
3596                                          * item and no space check has been made
3597                                          * for it.
3598                                          */
3599                                         cache = NULL;
3600                                 }
3601
3602                                 if (cache) {
3603                                         yaffs_use_cache(dev, cache, 1);
3604                                         cache->locked = 1;
3605
3606                                         memcpy(&cache->data[start], buffer,
3607                                                n_copy);
3608
3609                                         cache->locked = 0;
3610                                         cache->n_bytes = n_writeback;
3611
3612                                         if (write_trhrough) {
3613                                                 chunk_written =
3614                                                     yaffs_wr_data_obj
3615                                                     (cache->object,
3616                                                      cache->chunk_id,
3617                                                      cache->data,
3618                                                      cache->n_bytes, 1);
3619                                                 cache->dirty = 0;
3620                                         }
3621                                 } else {
3622                                         chunk_written = -1;     /* fail write */
3623                                 }
3624                         } else {
3625                                 /* An incomplete start or end chunk (or maybe
3626                                  * both start and end chunk). Read into the
3627                                  * local buffer then copy over and write back.
3628                                  */
3629
3630                                 u8 *local_buffer = yaffs_get_temp_buffer(dev);
3631
3632                                 yaffs_rd_data_obj(in, chunk, local_buffer);
3633                                 memcpy(&local_buffer[start], buffer, n_copy);
3634
3635                                 chunk_written =
3636                                     yaffs_wr_data_obj(in, chunk,
3637                                                       local_buffer,
3638                                                       n_writeback, 0);
3639
3640                                 yaffs_release_temp_buffer(dev, local_buffer);
3641                         }
3642                 } else {
3643                         /* A full chunk. Write directly from the buffer. */
3644
3645                         chunk_written =
3646                             yaffs_wr_data_obj(in, chunk, buffer,
3647                                               dev->data_bytes_per_chunk, 0);
3648
3649                         /* Since we've overwritten the cached data,
3650                          * we better invalidate it. */
3651                         yaffs_invalidate_chunk_cache(in, chunk);
3652                 }
3653
3654                 if (chunk_written >= 0) {
3655                         n -= n_copy;
3656                         offset += n_copy;
3657                         buffer += n_copy;
3658                         n_done += n_copy;
3659                 }
3660         }
3661
3662         /* Update file object */
3663
3664         if ((start_write + n_done) > in->variant.file_variant.file_size)
3665                 in->variant.file_variant.file_size = (start_write + n_done);
3666
3667         in->dirty = 1;
3668         return n_done;
3669 }
3670
3671 int yaffs_wr_file(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
3672                   int n_bytes, int write_trhrough)
3673 {
3674         yaffs2_handle_hole(in, offset);
3675         return yaffs_do_file_wr(in, buffer, offset, n_bytes, write_trhrough);
3676 }
3677
3678 /* ---------------------- File resizing stuff ------------------ */
3679
3680 static void yaffs_prune_chunks(struct yaffs_obj *in, int new_size)
3681 {
3682
3683         struct yaffs_dev *dev = in->my_dev;
3684         int old_size = in->variant.file_variant.file_size;
3685         int i;
3686         int chunk_id;
3687         int last_del = 1 + (old_size - 1) / dev->data_bytes_per_chunk;
3688         int start_del = 1 + (new_size + dev->data_bytes_per_chunk - 1) /
3689             dev->data_bytes_per_chunk;
3690
3691
3692         /* Delete backwards so that we don't end up with holes if
3693          * power is lost part-way through the operation.
3694          */
3695         for (i = last_del; i >= start_del; i--) {
3696                 /* NB this could be optimised somewhat,
3697                  * eg. could retrieve the tags and write them without
3698                  * using yaffs_chunk_del
3699                  */
3700
3701                 chunk_id = yaffs_find_del_file_chunk(in, i, NULL);
3702
3703                 if (chunk_id < 1)
3704                         continue;
3705
3706                 if (chunk_id <
3707                     (dev->internal_start_block * dev->param.chunks_per_block) ||
3708                     chunk_id >=
3709                     ((dev->internal_end_block + 1) *
3710                       dev->param.chunks_per_block)) {
3711                         yaffs_trace(YAFFS_TRACE_ALWAYS,
3712                                 "Found daft chunk_id %d for %d",
3713                                 chunk_id, i);
3714                 } else {
3715                         in->n_data_chunks--;
3716                         yaffs_chunk_del(dev, chunk_id, 1, __LINE__);
3717                 }
3718         }
3719 }
3720
3721 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size)
3722 {
3723         int new_full;
3724         u32 new_partial;
3725         struct yaffs_dev *dev = obj->my_dev;
3726
3727         yaffs_addr_to_chunk(dev, new_size, &new_full, &new_partial);
3728
3729         yaffs_prune_chunks(obj, new_size);
3730
3731         if (new_partial != 0) {
3732                 int last_chunk = 1 + new_full;
3733                 u8 *local_buffer = yaffs_get_temp_buffer(dev);
3734
3735                 /* Rewrite the last chunk with its new size and zero pad */
3736                 yaffs_rd_data_obj(obj, last_chunk, local_buffer);
3737                 memset(local_buffer + new_partial, 0,
3738                        dev->data_bytes_per_chunk - new_partial);
3739
3740                 yaffs_wr_data_obj(obj, last_chunk, local_buffer,
3741                                   new_partial, 1);
3742
3743                 yaffs_release_temp_buffer(dev, local_buffer);
3744         }
3745
3746         obj->variant.file_variant.file_size = new_size;
3747
3748         yaffs_prune_tree(dev, &obj->variant.file_variant);
3749 }
3750
3751 int yaffs_resize_file(struct yaffs_obj *in, loff_t new_size)
3752 {
3753         struct yaffs_dev *dev = in->my_dev;
3754         int old_size = in->variant.file_variant.file_size;
3755
3756         yaffs_flush_file_cache(in);
3757         yaffs_invalidate_whole_cache(in);
3758
3759         yaffs_check_gc(dev, 0);
3760
3761         if (in->variant_type != YAFFS_OBJECT_TYPE_FILE)
3762                 return YAFFS_FAIL;
3763
3764         if (new_size == old_size)
3765                 return YAFFS_OK;
3766
3767         if (new_size > old_size) {
3768                 yaffs2_handle_hole(in, new_size);
3769                 in->variant.file_variant.file_size = new_size;
3770         } else {
3771                 /* new_size < old_size */
3772                 yaffs_resize_file_down(in, new_size);
3773         }
3774
3775         /* Write a new object header to reflect the resize.
3776          * show we've shrunk the file, if need be
3777          * Do this only if the file is not in the deleted directories
3778          * and is not shadowed.
3779          */
3780         if (in->parent &&
3781             !in->is_shadowed &&
3782             in->parent->obj_id != YAFFS_OBJECTID_UNLINKED &&
3783             in->parent->obj_id != YAFFS_OBJECTID_DELETED)
3784                 yaffs_update_oh(in, NULL, 0, 0, 0, NULL);
3785
3786         return YAFFS_OK;
3787 }
3788
3789 int yaffs_flush_file(struct yaffs_obj *in, int update_time, int data_sync)
3790 {
3791         if (!in->dirty)
3792                 return YAFFS_OK;
3793
3794         yaffs_flush_file_cache(in);
3795
3796         if (data_sync)
3797                 return YAFFS_OK;
3798
3799         if (update_time)
3800                 yaffs_load_current_time(in, 0, 0);
3801
3802         return (yaffs_update_oh(in, NULL, 0, 0, 0, NULL) >= 0) ?
3803                                 YAFFS_OK : YAFFS_FAIL;
3804 }
3805
3806
3807 /* yaffs_del_file deletes the whole file data
3808  * and the inode associated with the file.
3809  * It does not delete the links associated with the file.
3810  */
3811 static int yaffs_unlink_file_if_needed(struct yaffs_obj *in)
3812 {
3813         int ret_val;
3814         int del_now = 0;
3815         struct yaffs_dev *dev = in->my_dev;
3816
3817         if (!in->my_inode)
3818                 del_now = 1;
3819
3820         if (del_now) {
3821                 ret_val =
3822                     yaffs_change_obj_name(in, in->my_dev->del_dir,
3823                                           _Y("deleted"), 0, 0);
3824                 yaffs_trace(YAFFS_TRACE_TRACING,
3825                         "yaffs: immediate deletion of file %d",
3826                         in->obj_id);
3827                 in->deleted = 1;
3828                 in->my_dev->n_deleted_files++;
3829                 if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3830                         yaffs_resize_file(in, 0);
3831                 yaffs_soft_del_file(in);
3832         } else {
3833                 ret_val =
3834                     yaffs_change_obj_name(in, in->my_dev->unlinked_dir,
3835                                           _Y("unlinked"), 0, 0);
3836         }
3837         return ret_val;
3838 }
3839
3840 int yaffs_del_file(struct yaffs_obj *in)
3841 {
3842         int ret_val = YAFFS_OK;
3843         int deleted;    /* Need to cache value on stack if in is freed */
3844         struct yaffs_dev *dev = in->my_dev;
3845
3846         if (dev->param.disable_soft_del || dev->param.is_yaffs2)
3847                 yaffs_resize_file(in, 0);
3848
3849         if (in->n_data_chunks > 0) {
3850                 /* Use soft deletion if there is data in the file.
3851                  * That won't be the case if it has been resized to zero.
3852                  */
3853                 if (!in->unlinked)
3854                         ret_val = yaffs_unlink_file_if_needed(in);
3855
3856                 deleted = in->deleted;
3857
3858                 if (ret_val == YAFFS_OK && in->unlinked && !in->deleted) {
3859                         in->deleted = 1;
3860                         deleted = 1;
3861                         in->my_dev->n_deleted_files++;
3862                         yaffs_soft_del_file(in);
3863                 }
3864                 return deleted ? YAFFS_OK : YAFFS_FAIL;
3865         } else {
3866                 /* The file has no data chunks so we toss it immediately */
3867                 yaffs_free_tnode(in->my_dev, in->variant.file_variant.top);
3868                 in->variant.file_variant.top = NULL;
3869                 yaffs_generic_obj_del(in);
3870
3871                 return YAFFS_OK;
3872         }
3873 }
3874
3875 int yaffs_is_non_empty_dir(struct yaffs_obj *obj)
3876 {
3877         return (obj &&
3878                 obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY) &&
3879                 !(list_empty(&obj->variant.dir_variant.children));
3880 }
3881
3882 static int yaffs_del_dir(struct yaffs_obj *obj)
3883 {
3884         /* First check that the directory is empty. */
3885         if (yaffs_is_non_empty_dir(obj))
3886                 return YAFFS_FAIL;
3887
3888         return yaffs_generic_obj_del(obj);
3889 }
3890
3891 static int yaffs_del_symlink(struct yaffs_obj *in)
3892 {
3893         kfree(in->variant.symlink_variant.alias);
3894         in->variant.symlink_variant.alias = NULL;
3895
3896         return yaffs_generic_obj_del(in);
3897 }
3898
3899 static int yaffs_del_link(struct yaffs_obj *in)
3900 {
3901         /* remove this hardlink from the list associated with the equivalent
3902          * object
3903          */
3904         list_del_init(&in->hard_links);
3905         return yaffs_generic_obj_del(in);
3906 }
3907
3908 int yaffs_del_obj(struct yaffs_obj *obj)
3909 {
3910         int ret_val = -1;
3911
3912         switch (obj->variant_type) {
3913         case YAFFS_OBJECT_TYPE_FILE:
3914                 ret_val = yaffs_del_file(obj);
3915                 break;
3916         case YAFFS_OBJECT_TYPE_DIRECTORY:
3917                 if (!list_empty(&obj->variant.dir_variant.dirty)) {
3918                         yaffs_trace(YAFFS_TRACE_BACKGROUND,
3919                                 "Remove object %d from dirty directories",
3920                                 obj->obj_id);
3921                         list_del_init(&obj->variant.dir_variant.dirty);
3922                 }
3923                 return yaffs_del_dir(obj);
3924                 break;
3925         case YAFFS_OBJECT_TYPE_SYMLINK:
3926                 ret_val = yaffs_del_symlink(obj);
3927                 break;
3928         case YAFFS_OBJECT_TYPE_HARDLINK:
3929                 ret_val = yaffs_del_link(obj);
3930                 break;
3931         case YAFFS_OBJECT_TYPE_SPECIAL:
3932                 ret_val = yaffs_generic_obj_del(obj);
3933                 break;
3934         case YAFFS_OBJECT_TYPE_UNKNOWN:
3935                 ret_val = 0;
3936                 break;          /* should not happen. */
3937         }
3938         return ret_val;
3939 }
3940
3941 static int yaffs_unlink_worker(struct yaffs_obj *obj)
3942 {
3943         int del_now = 0;
3944
3945         if (!obj)
3946                 return YAFFS_FAIL;
3947
3948         if (!obj->my_inode)
3949                 del_now = 1;
3950
3951         yaffs_update_parent(obj->parent);
3952
3953         if (obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
3954                 return yaffs_del_link(obj);
3955         } else if (!list_empty(&obj->hard_links)) {
3956                 /* Curve ball: We're unlinking an object that has a hardlink.
3957                  *
3958                  * This problem arises because we are not strictly following
3959                  * The Linux link/inode model.
3960                  *
3961                  * We can't really delete the object.
3962                  * Instead, we do the following:
3963                  * - Select a hardlink.
3964                  * - Unhook it from the hard links
3965                  * - Move it from its parent directory so that the rename works.
3966                  * - Rename the object to the hardlink's name.
3967                  * - Delete the hardlink
3968                  */
3969
3970                 struct yaffs_obj *hl;
3971                 struct yaffs_obj *parent;
3972                 int ret_val;
3973                 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
3974
3975                 hl = list_entry(obj->hard_links.next, struct yaffs_obj,
3976                                 hard_links);
3977
3978                 yaffs_get_obj_name(hl, name, YAFFS_MAX_NAME_LENGTH + 1);
3979                 parent = hl->parent;
3980
3981                 list_del_init(&hl->hard_links);
3982
3983                 yaffs_add_obj_to_dir(obj->my_dev->unlinked_dir, hl);
3984
3985                 ret_val = yaffs_change_obj_name(obj, parent, name, 0, 0);
3986
3987                 if (ret_val == YAFFS_OK)
3988                         ret_val = yaffs_generic_obj_del(hl);
3989
3990                 return ret_val;
3991
3992         } else if (del_now) {
3993                 switch (obj->variant_type) {
3994                 case YAFFS_OBJECT_TYPE_FILE:
3995                         return yaffs_del_file(obj);
3996                         break;
3997                 case YAFFS_OBJECT_TYPE_DIRECTORY:
3998                         list_del_init(&obj->variant.dir_variant.dirty);
3999                         return yaffs_del_dir(obj);
4000                         break;
4001                 case YAFFS_OBJECT_TYPE_SYMLINK:
4002                         return yaffs_del_symlink(obj);
4003                         break;
4004                 case YAFFS_OBJECT_TYPE_SPECIAL:
4005                         return yaffs_generic_obj_del(obj);
4006                         break;
4007                 case YAFFS_OBJECT_TYPE_HARDLINK:
4008                 case YAFFS_OBJECT_TYPE_UNKNOWN:
4009                 default:
4010                         return YAFFS_FAIL;
4011                 }
4012         } else if (yaffs_is_non_empty_dir(obj)) {
4013                 return YAFFS_FAIL;
4014         } else {
4015                 return yaffs_change_obj_name(obj, obj->my_dev->unlinked_dir,
4016                                                 _Y("unlinked"), 0, 0);
4017         }
4018 }
4019
4020 static int yaffs_unlink_obj(struct yaffs_obj *obj)
4021 {
4022         if (obj && obj->unlink_allowed)
4023                 return yaffs_unlink_worker(obj);
4024
4025         return YAFFS_FAIL;
4026 }
4027
4028 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR *name)
4029 {
4030         struct yaffs_obj *obj;
4031
4032         obj = yaffs_find_by_name(dir, name);
4033         return yaffs_unlink_obj(obj);
4034 }
4035
4036 /* Note:
4037  * If old_name is NULL then we take old_dir as the object to be renamed.
4038  */
4039 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR *old_name,
4040                      struct yaffs_obj *new_dir, const YCHAR *new_name)
4041 {
4042         struct yaffs_obj *obj = NULL;
4043         struct yaffs_obj *existing_target = NULL;
4044         int force = 0;
4045         int result;
4046         struct yaffs_dev *dev;
4047
4048         if (!old_dir || old_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4049                 BUG();
4050                 return YAFFS_FAIL;
4051         }
4052         if (!new_dir || new_dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4053                 BUG();
4054                 return YAFFS_FAIL;
4055         }
4056
4057         dev = old_dir->my_dev;
4058
4059 #ifdef CONFIG_YAFFS_CASE_INSENSITIVE
4060         /* Special case for case insemsitive systems.
4061          * While look-up is case insensitive, the name isn't.
4062          * Therefore we might want to change x.txt to X.txt
4063          */
4064         if (old_dir == new_dir &&
4065                 old_name && new_name &&
4066                 strcmp(old_name, new_name) == 0)
4067                 force = 1;
4068 #endif
4069
4070         if (strnlen(new_name, YAFFS_MAX_NAME_LENGTH + 1) >
4071             YAFFS_MAX_NAME_LENGTH)
4072                 /* ENAMETOOLONG */
4073                 return YAFFS_FAIL;
4074
4075         if (old_name)
4076                 obj = yaffs_find_by_name(old_dir, old_name);
4077         else{
4078                 obj = old_dir;
4079                 old_dir = obj->parent;
4080         }
4081
4082         if (obj && obj->rename_allowed) {
4083                 /* Now handle an existing target, if there is one */
4084                 existing_target = yaffs_find_by_name(new_dir, new_name);
4085                 if (yaffs_is_non_empty_dir(existing_target)) {
4086                         return YAFFS_FAIL;      /* ENOTEMPTY */
4087                 } else if (existing_target && existing_target != obj) {
4088                         /* Nuke the target first, using shadowing,
4089                          * but only if it isn't the same object.
4090                          *
4091                          * Note we must disable gc here otherwise it can mess
4092                          * up the shadowing.
4093                          *
4094                          */
4095                         dev->gc_disable = 1;
4096                         yaffs_change_obj_name(obj, new_dir, new_name, force,
4097                                               existing_target->obj_id);
4098                         existing_target->is_shadowed = 1;
4099                         yaffs_unlink_obj(existing_target);
4100                         dev->gc_disable = 0;
4101                 }
4102
4103                 result = yaffs_change_obj_name(obj, new_dir, new_name, 1, 0);
4104
4105                 yaffs_update_parent(old_dir);
4106                 if (new_dir != old_dir)
4107                         yaffs_update_parent(new_dir);
4108
4109                 return result;
4110         }
4111         return YAFFS_FAIL;
4112 }
4113
4114 /*----------------------- Initialisation Scanning ---------------------- */
4115
4116 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
4117                                int backward_scanning)
4118 {
4119         struct yaffs_obj *obj;
4120
4121         if (backward_scanning) {
4122                 /* Handle YAFFS2 case (backward scanning)
4123                  * If the shadowed object exists then ignore.
4124                  */
4125                 obj = yaffs_find_by_number(dev, obj_id);
4126                 if (obj)
4127                         return;
4128         }
4129
4130         /* Let's create it (if it does not exist) assuming it is a file so that
4131          * it can do shrinking etc.
4132          * We put it in unlinked dir to be cleaned up after the scanning
4133          */
4134         obj =
4135             yaffs_find_or_create_by_number(dev, obj_id, YAFFS_OBJECT_TYPE_FILE);
4136         if (!obj)
4137                 return;
4138         obj->is_shadowed = 1;
4139         yaffs_add_obj_to_dir(dev->unlinked_dir, obj);
4140         obj->variant.file_variant.shrink_size = 0;
4141         obj->valid = 1;         /* So that we don't read any other info. */
4142 }
4143
4144 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list)
4145 {
4146         struct list_head *lh;
4147         struct list_head *save;
4148         struct yaffs_obj *hl;
4149         struct yaffs_obj *in;
4150
4151         list_for_each_safe(lh, save, hard_list) {
4152                 hl = list_entry(lh, struct yaffs_obj, hard_links);
4153                 in = yaffs_find_by_number(dev,
4154                                         hl->variant.hardlink_variant.equiv_id);
4155
4156                 if (in) {
4157                         /* Add the hardlink pointers */
4158                         hl->variant.hardlink_variant.equiv_obj = in;
4159                         list_add(&hl->hard_links, &in->hard_links);
4160                 } else {
4161                         /* Todo Need to report/handle this better.
4162                          * Got a problem... hardlink to a non-existant object
4163                          */
4164                         hl->variant.hardlink_variant.equiv_obj = NULL;
4165                         INIT_LIST_HEAD(&hl->hard_links);
4166                 }
4167         }
4168 }
4169
4170 static void yaffs_strip_deleted_objs(struct yaffs_dev *dev)
4171 {
4172         /*
4173          *  Sort out state of unlinked and deleted objects after scanning.
4174          */
4175         struct list_head *i;
4176         struct list_head *n;
4177         struct yaffs_obj *l;
4178
4179         if (dev->read_only)
4180                 return;
4181
4182         /* Soft delete all the unlinked files */
4183         list_for_each_safe(i, n,
4184                            &dev->unlinked_dir->variant.dir_variant.children) {
4185                 l = list_entry(i, struct yaffs_obj, siblings);
4186                 yaffs_del_obj(l);
4187         }
4188
4189         list_for_each_safe(i, n, &dev->del_dir->variant.dir_variant.children) {
4190                 l = list_entry(i, struct yaffs_obj, siblings);
4191                 yaffs_del_obj(l);
4192         }
4193 }
4194
4195 /*
4196  * This code iterates through all the objects making sure that they are rooted.
4197  * Any unrooted objects are re-rooted in lost+found.
4198  * An object needs to be in one of:
4199  * - Directly under deleted, unlinked
4200  * - Directly or indirectly under root.
4201  *
4202  * Note:
4203  *  This code assumes that we don't ever change the current relationships
4204  *  between directories:
4205  *   root_dir->parent == unlinked_dir->parent == del_dir->parent == NULL
4206  *   lost-n-found->parent == root_dir
4207  *
4208  * This fixes the problem where directories might have inadvertently been
4209  * deleted leaving the object "hanging" without being rooted in the
4210  * directory tree.
4211  */
4212
4213 static int yaffs_has_null_parent(struct yaffs_dev *dev, struct yaffs_obj *obj)
4214 {
4215         return (obj == dev->del_dir ||
4216                 obj == dev->unlinked_dir || obj == dev->root_dir);
4217 }
4218
4219 static void yaffs_fix_hanging_objs(struct yaffs_dev *dev)
4220 {
4221         struct yaffs_obj *obj;
4222         struct yaffs_obj *parent;
4223         int i;
4224         struct list_head *lh;
4225         struct list_head *n;
4226         int depth_limit;
4227         int hanging;
4228
4229         if (dev->read_only)
4230                 return;
4231
4232         /* Iterate through the objects in each hash entry,
4233          * looking at each object.
4234          * Make sure it is rooted.
4235          */
4236
4237         for (i = 0; i < YAFFS_NOBJECT_BUCKETS; i++) {
4238                 list_for_each_safe(lh, n, &dev->obj_bucket[i].list) {
4239                         obj = list_entry(lh, struct yaffs_obj, hash_link);
4240                         parent = obj->parent;
4241
4242                         if (yaffs_has_null_parent(dev, obj)) {
4243                                 /* These directories are not hanging */
4244                                 hanging = 0;
4245                         } else if (!parent ||
4246                                    parent->variant_type !=
4247                                    YAFFS_OBJECT_TYPE_DIRECTORY) {
4248                                 hanging = 1;
4249                         } else if (yaffs_has_null_parent(dev, parent)) {
4250                                 hanging = 0;
4251                         } else {
4252                                 /*
4253                                  * Need to follow the parent chain to
4254                                  * see if it is hanging.
4255                                  */
4256                                 hanging = 0;
4257                                 depth_limit = 100;
4258
4259                                 while (parent != dev->root_dir &&
4260                                        parent->parent &&
4261                                        parent->parent->variant_type ==
4262                                        YAFFS_OBJECT_TYPE_DIRECTORY &&
4263                                        depth_limit > 0) {
4264                                         parent = parent->parent;
4265                                         depth_limit--;
4266                                 }
4267                                 if (parent != dev->root_dir)
4268                                         hanging = 1;
4269                         }
4270                         if (hanging) {
4271                                 yaffs_trace(YAFFS_TRACE_SCAN,
4272                                         "Hanging object %d moved to lost and found",
4273                                         obj->obj_id);
4274                                 yaffs_add_obj_to_dir(dev->lost_n_found, obj);
4275                         }
4276                 }
4277         }
4278 }
4279
4280 /*
4281  * Delete directory contents for cleaning up lost and found.
4282  */
4283 static void yaffs_del_dir_contents(struct yaffs_obj *dir)
4284 {
4285         struct yaffs_obj *obj;
4286         struct list_head *lh;
4287         struct list_head *n;
4288
4289         if (dir->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY)
4290                 BUG();
4291
4292         list_for_each_safe(lh, n, &dir->variant.dir_variant.children) {
4293                 obj = list_entry(lh, struct yaffs_obj, siblings);
4294                 if (obj->variant_type == YAFFS_OBJECT_TYPE_DIRECTORY)
4295                         yaffs_del_dir_contents(obj);
4296                 yaffs_trace(YAFFS_TRACE_SCAN,
4297                         "Deleting lost_found object %d",
4298                         obj->obj_id);
4299                 yaffs_unlink_obj(obj);
4300         }
4301 }
4302
4303 static void yaffs_empty_l_n_f(struct yaffs_dev *dev)
4304 {
4305         yaffs_del_dir_contents(dev->lost_n_found);
4306 }
4307
4308
4309 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *directory,
4310                                      const YCHAR *name)
4311 {
4312         int sum;
4313         struct list_head *i;
4314         YCHAR buffer[YAFFS_MAX_NAME_LENGTH + 1];
4315         struct yaffs_obj *l;
4316
4317         if (!name)
4318                 return NULL;
4319
4320         if (!directory) {
4321                 yaffs_trace(YAFFS_TRACE_ALWAYS,
4322                         "tragedy: yaffs_find_by_name: null pointer directory"
4323                         );
4324                 BUG();
4325                 return NULL;
4326         }
4327         if (directory->variant_type != YAFFS_OBJECT_TYPE_DIRECTORY) {
4328                 yaffs_trace(YAFFS_TRACE_ALWAYS,
4329                         "tragedy: yaffs_find_by_name: non-directory"
4330                         );
4331                 BUG();
4332         }
4333
4334         sum = yaffs_calc_name_sum(name);
4335
4336         list_for_each(i, &directory->variant.dir_variant.children) {
4337                 l = list_entry(i, struct yaffs_obj, siblings);
4338
4339                 if (l->parent != directory)
4340                         BUG();
4341
4342                 yaffs_check_obj_details_loaded(l);
4343
4344                 /* Special case for lost-n-found */
4345                 if (l->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4346                         if (!strcmp(name, YAFFS_LOSTNFOUND_NAME))
4347                                 return l;
4348                 } else if (l->sum == sum || l->hdr_chunk <= 0) {
4349                         /* LostnFound chunk called Objxxx
4350                          * Do a real check
4351                          */
4352                         yaffs_get_obj_name(l, buffer,
4353                                 YAFFS_MAX_NAME_LENGTH + 1);
4354                         if (strncmp(name, buffer, YAFFS_MAX_NAME_LENGTH) == 0)
4355                                 return l;
4356                 }
4357         }
4358         return NULL;
4359 }
4360
4361 /* GetEquivalentObject dereferences any hard links to get to the
4362  * actual object.
4363  */
4364
4365 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj)
4366 {
4367         if (obj && obj->variant_type == YAFFS_OBJECT_TYPE_HARDLINK) {
4368                 obj = obj->variant.hardlink_variant.equiv_obj;
4369                 yaffs_check_obj_details_loaded(obj);
4370         }
4371         return obj;
4372 }
4373
4374 /*
4375  *  A note or two on object names.
4376  *  * If the object name is missing, we then make one up in the form objnnn
4377  *
4378  *  * ASCII names are stored in the object header's name field from byte zero
4379  *  * Unicode names are historically stored starting from byte zero.
4380  *
4381  * Then there are automatic Unicode names...
4382  * The purpose of these is to save names in a way that can be read as
4383  * ASCII or Unicode names as appropriate, thus allowing a Unicode and ASCII
4384  * system to share files.
4385  *
4386  * These automatic unicode are stored slightly differently...
4387  *  - If the name can fit in the ASCII character space then they are saved as
4388  *    ascii names as per above.
4389  *  - If the name needs Unicode then the name is saved in Unicode
4390  *    starting at oh->name[1].
4391
4392  */
4393 static void yaffs_fix_null_name(struct yaffs_obj *obj, YCHAR *name,
4394                                 int buffer_size)
4395 {
4396         /* Create an object name if we could not find one. */
4397         if (strnlen(name, YAFFS_MAX_NAME_LENGTH) == 0) {
4398                 YCHAR local_name[20];
4399                 YCHAR num_string[20];
4400                 YCHAR *x = &num_string[19];
4401                 unsigned v = obj->obj_id;
4402                 num_string[19] = 0;
4403                 while (v > 0) {
4404                         x--;
4405                         *x = '0' + (v % 10);
4406                         v /= 10;
4407                 }
4408                 /* make up a name */
4409                 strcpy(local_name, YAFFS_LOSTNFOUND_PREFIX);
4410                 strcat(local_name, x);
4411                 strncpy(name, local_name, buffer_size - 1);
4412         }
4413 }
4414
4415 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR *name, int buffer_size)
4416 {
4417         memset(name, 0, buffer_size * sizeof(YCHAR));
4418         yaffs_check_obj_details_loaded(obj);
4419         if (obj->obj_id == YAFFS_OBJECTID_LOSTNFOUND) {
4420                 strncpy(name, YAFFS_LOSTNFOUND_NAME, buffer_size - 1);
4421         } else if (obj->short_name[0]) {
4422                 strcpy(name, obj->short_name);
4423         } else if (obj->hdr_chunk > 0) {
4424                 int result;
4425                 u8 *buffer = yaffs_get_temp_buffer(obj->my_dev);
4426
4427                 struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)buffer;
4428
4429                 memset(buffer, 0, obj->my_dev->data_bytes_per_chunk);
4430
4431                 if (obj->hdr_chunk > 0) {
4432                         result = yaffs_rd_chunk_tags_nand(obj->my_dev,
4433                                                           obj->hdr_chunk,
4434                                                           buffer, NULL);
4435                 }
4436                 yaffs_load_name_from_oh(obj->my_dev, name, oh->name,
4437                                         buffer_size);
4438
4439                 yaffs_release_temp_buffer(obj->my_dev, buffer);
4440         }
4441
4442         yaffs_fix_null_name(obj, name, buffer_size);
4443
4444         return strnlen(name, YAFFS_MAX_NAME_LENGTH);
4445 }
4446
4447 int yaffs_get_obj_length(struct yaffs_obj *obj)
4448 {
4449         /* Dereference any hard linking */
4450         obj = yaffs_get_equivalent_obj(obj);
4451
4452         if (obj->variant_type == YAFFS_OBJECT_TYPE_FILE)
4453                 return obj->variant.file_variant.file_size;
4454         if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK) {
4455                 if (!obj->variant.symlink_variant.alias)
4456                         return 0;
4457                 return strnlen(obj->variant.symlink_variant.alias,
4458                                      YAFFS_MAX_ALIAS_LENGTH);
4459         } else {
4460                 /* Only a directory should drop through to here */
4461                 return obj->my_dev->data_bytes_per_chunk;
4462         }
4463 }
4464
4465 int yaffs_get_obj_link_count(struct yaffs_obj *obj)
4466 {
4467         int count = 0;
4468         struct list_head *i;
4469
4470         if (!obj->unlinked)
4471                 count++;        /* the object itself */
4472
4473         list_for_each(i, &obj->hard_links)
4474             count++;            /* add the hard links; */
4475
4476         return count;
4477 }
4478
4479 int yaffs_get_obj_inode(struct yaffs_obj *obj)
4480 {
4481         obj = yaffs_get_equivalent_obj(obj);
4482
4483         return obj->obj_id;
4484 }
4485
4486 unsigned yaffs_get_obj_type(struct yaffs_obj *obj)
4487 {
4488         obj = yaffs_get_equivalent_obj(obj);
4489
4490         switch (obj->variant_type) {
4491         case YAFFS_OBJECT_TYPE_FILE:
4492                 return DT_REG;
4493                 break;
4494         case YAFFS_OBJECT_TYPE_DIRECTORY:
4495                 return DT_DIR;
4496                 break;
4497         case YAFFS_OBJECT_TYPE_SYMLINK:
4498                 return DT_LNK;
4499                 break;
4500         case YAFFS_OBJECT_TYPE_HARDLINK:
4501                 return DT_REG;
4502                 break;
4503         case YAFFS_OBJECT_TYPE_SPECIAL:
4504                 if (S_ISFIFO(obj->yst_mode))
4505                         return DT_FIFO;
4506                 if (S_ISCHR(obj->yst_mode))
4507                         return DT_CHR;
4508                 if (S_ISBLK(obj->yst_mode))
4509                         return DT_BLK;
4510                 if (S_ISSOCK(obj->yst_mode))
4511                         return DT_SOCK;
4512                 return DT_REG;
4513                 break;
4514         default:
4515                 return DT_REG;
4516                 break;
4517         }
4518 }
4519
4520 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj)
4521 {
4522         obj = yaffs_get_equivalent_obj(obj);
4523         if (obj->variant_type == YAFFS_OBJECT_TYPE_SYMLINK)
4524                 return yaffs_clone_str(obj->variant.symlink_variant.alias);
4525         else
4526                 return yaffs_clone_str(_Y(""));
4527 }
4528
4529 /*--------------------------- Initialisation code -------------------------- */
4530
4531 static int yaffs_check_dev_fns(const struct yaffs_dev *dev)
4532 {
4533         /* Common functions, gotta have */
4534         if (!dev->param.erase_fn || !dev->param.initialise_flash_fn)
4535                 return 0;
4536
4537         /* Can use the "with tags" style interface for yaffs1 or yaffs2 */
4538         if (dev->param.write_chunk_tags_fn &&
4539             dev->param.read_chunk_tags_fn &&
4540             !dev->param.write_chunk_fn &&
4541             !dev->param.read_chunk_fn &&
4542             dev->param.bad_block_fn && dev->param.query_block_fn)
4543                 return 1;
4544
4545         /* Can use the "spare" style interface for yaffs1 */
4546         if (!dev->param.is_yaffs2 &&
4547             !dev->param.write_chunk_tags_fn &&
4548             !dev->param.read_chunk_tags_fn &&
4549             dev->param.write_chunk_fn &&
4550             dev->param.read_chunk_fn &&
4551             !dev->param.bad_block_fn && !dev->param.query_block_fn)
4552                 return 1;
4553
4554         return 0;               /* bad */
4555 }
4556
4557 static int yaffs_create_initial_dir(struct yaffs_dev *dev)
4558 {
4559         /* Initialise the unlinked, deleted, root and lost+found directories */
4560         dev->lost_n_found = dev->root_dir = NULL;
4561         dev->unlinked_dir = dev->del_dir = NULL;
4562         dev->unlinked_dir =
4563             yaffs_create_fake_dir(dev, YAFFS_OBJECTID_UNLINKED, S_IFDIR);
4564         dev->del_dir =
4565             yaffs_create_fake_dir(dev, YAFFS_OBJECTID_DELETED, S_IFDIR);
4566         dev->root_dir =
4567             yaffs_create_fake_dir(dev, YAFFS_OBJECTID_ROOT,
4568                                   YAFFS_ROOT_MODE | S_IFDIR);
4569         dev->lost_n_found =
4570             yaffs_create_fake_dir(dev, YAFFS_OBJECTID_LOSTNFOUND,
4571                                   YAFFS_LOSTNFOUND_MODE | S_IFDIR);
4572
4573         if (dev->lost_n_found && dev->root_dir && dev->unlinked_dir
4574             && dev->del_dir) {
4575                 yaffs_add_obj_to_dir(dev->root_dir, dev->lost_n_found);
4576                 return YAFFS_OK;
4577         }
4578         return YAFFS_FAIL;
4579 }
4580
4581 int yaffs_guts_initialise(struct yaffs_dev *dev)
4582 {
4583         int init_failed = 0;
4584         unsigned x;
4585         int bits;
4586
4587         yaffs_trace(YAFFS_TRACE_TRACING, "yaffs: yaffs_guts_initialise()");
4588
4589         /* Check stuff that must be set */
4590
4591         if (!dev) {
4592                 yaffs_trace(YAFFS_TRACE_ALWAYS,
4593                         "yaffs: Need a device"
4594                         );
4595                 return YAFFS_FAIL;
4596         }
4597
4598         if (dev->is_mounted) {
4599                 yaffs_trace(YAFFS_TRACE_ALWAYS, "device already mounted");
4600                 return YAFFS_FAIL;
4601         }
4602
4603         dev->internal_start_block = dev->param.start_block;
4604         dev->internal_end_block = dev->param.end_block;
4605         dev->block_offset = 0;
4606         dev->chunk_offset = 0;
4607         dev->n_free_chunks = 0;
4608
4609         dev->gc_block = 0;
4610
4611         if (dev->param.start_block == 0) {
4612                 dev->internal_start_block = dev->param.start_block + 1;
4613                 dev->internal_end_block = dev->param.end_block + 1;
4614                 dev->block_offset = 1;
4615                 dev->chunk_offset = dev->param.chunks_per_block;
4616         }
4617
4618         /* Check geometry parameters. */
4619
4620         if ((!dev->param.inband_tags && dev->param.is_yaffs2 &&
4621                 dev->param.total_bytes_per_chunk < 1024) ||
4622                 (!dev->param.is_yaffs2 &&
4623                         dev->param.total_bytes_per_chunk < 512) ||
4624                 (dev->param.inband_tags && !dev->param.is_yaffs2) ||
4625                  dev->param.chunks_per_block < 2 ||
4626                  dev->param.n_reserved_blocks < 2 ||
4627                 dev->internal_start_block <= 0 ||
4628                 dev->internal_end_block <= 0 ||
4629                 dev->internal_end_block <=
4630                 (dev->internal_start_block + dev->param.n_reserved_blocks + 2)
4631                 ) {
4632                 /* otherwise it is too small */
4633                 yaffs_trace(YAFFS_TRACE_ALWAYS,
4634                         "NAND geometry problems: chunk size %d, type is yaffs%s, inband_tags %d ",
4635                         dev->param.total_bytes_per_chunk,
4636                         dev->param.is_yaffs2 ? "2" : "",
4637                         dev->param.inband_tags);
4638                 return YAFFS_FAIL;
4639         }
4640
4641         if (yaffs_init_nand(dev) != YAFFS_OK) {
4642                 yaffs_trace(YAFFS_TRACE_ALWAYS, "InitialiseNAND failed");
4643                 return YAFFS_FAIL;
4644         }
4645
4646         /* Sort out space for inband tags, if required */
4647         if (dev->param.inband_tags)
4648                 dev->data_bytes_per_chunk =
4649                     dev->param.total_bytes_per_chunk -
4650                     sizeof(struct yaffs_packed_tags2_tags_only);
4651         else
4652                 dev->data_bytes_per_chunk = dev->param.total_bytes_per_chunk;
4653
4654         /* Got the right mix of functions? */
4655         if (!yaffs_check_dev_fns(dev)) {
4656                 /* Function missing */
4657                 yaffs_trace(YAFFS_TRACE_ALWAYS,
4658                         "device function(s) missing or wrong");
4659
4660                 return YAFFS_FAIL;
4661         }
4662
4663         /* Finished with most checks. Further checks happen later on too. */
4664
4665         dev->is_mounted = 1;
4666
4667         /* OK now calculate a few things for the device */
4668
4669         /*
4670          *  Calculate all the chunk size manipulation numbers:
4671          */
4672         x = dev->data_bytes_per_chunk;
4673         /* We always use dev->chunk_shift and dev->chunk_div */
4674         dev->chunk_shift = calc_shifts(x);
4675         x >>= dev->chunk_shift;
4676         dev->chunk_div = x;
4677         /* We only use chunk mask if chunk_div is 1 */
4678         dev->chunk_mask = (1 << dev->chunk_shift) - 1;
4679
4680         /*
4681          * Calculate chunk_grp_bits.
4682          * We need to find the next power of 2 > than internal_end_block
4683          */
4684
4685         x = dev->param.chunks_per_block * (dev->internal_end_block + 1);
4686
4687         bits = calc_shifts_ceiling(x);
4688
4689         /* Set up tnode width if wide tnodes are enabled. */
4690         if (!dev->param.wide_tnodes_disabled) {
4691                 /* bits must be even so that we end up with 32-bit words */
4692                 if (bits & 1)
4693                         bits++;
4694                 if (bits < 16)
4695                         dev->tnode_width = 16;
4696                 else
4697                         dev->tnode_width = bits;
4698         } else {
4699                 dev->tnode_width = 16;
4700         }
4701
4702         dev->tnode_mask = (1 << dev->tnode_width) - 1;
4703
4704         /* Level0 Tnodes are 16 bits or wider (if wide tnodes are enabled),
4705          * so if the bitwidth of the
4706          * chunk range we're using is greater than 16 we need
4707          * to figure out chunk shift and chunk_grp_size
4708          */
4709
4710         if (bits <= dev->tnode_width)
4711                 dev->chunk_grp_bits = 0;
4712         else
4713                 dev->chunk_grp_bits = bits - dev->tnode_width;
4714
4715         dev->tnode_size = (dev->tnode_width * YAFFS_NTNODES_LEVEL0) / 8;
4716         if (dev->tnode_size < sizeof(struct yaffs_tnode))
4717                 dev->tnode_size = sizeof(struct yaffs_tnode);
4718
4719         dev->chunk_grp_size = 1 << dev->chunk_grp_bits;
4720
4721         if (dev->param.chunks_per_block < dev->chunk_grp_size) {
4722                 /* We have a problem because the soft delete won't work if
4723                  * the chunk group size > chunks per block.
4724                  * This can be remedied by using larger "virtual blocks".
4725                  */
4726                 yaffs_trace(YAFFS_TRACE_ALWAYS, "chunk group too large");
4727
4728                 return YAFFS_FAIL;
4729         }
4730
4731         /* Finished verifying the device, continue with initialisation */
4732
4733         /* More device initialisation */
4734         dev->all_gcs = 0;
4735         dev->passive_gc_count = 0;
4736         dev->oldest_dirty_gc_count = 0;
4737         dev->bg_gcs = 0;
4738         dev->gc_block_finder = 0;
4739         dev->buffered_block = -1;
4740         dev->doing_buffered_block_rewrite = 0;
4741         dev->n_deleted_files = 0;
4742         dev->n_bg_deletions = 0;
4743         dev->n_unlinked_files = 0;
4744         dev->n_ecc_fixed = 0;
4745         dev->n_ecc_unfixed = 0;
4746         dev->n_tags_ecc_fixed = 0;
4747         dev->n_tags_ecc_unfixed = 0;
4748         dev->n_erase_failures = 0;
4749         dev->n_erased_blocks = 0;
4750         dev->gc_disable = 0;
4751         dev->has_pending_prioritised_gc = 1;
4752                 /* Assume the worst for now, will get fixed on first GC */
4753         INIT_LIST_HEAD(&dev->dirty_dirs);
4754         dev->oldest_dirty_seq = 0;
4755         dev->oldest_dirty_block = 0;
4756
4757         /* Initialise temporary buffers and caches. */
4758         if (!yaffs_init_tmp_buffers(dev))
4759                 init_failed = 1;
4760
4761         dev->cache = NULL;
4762         dev->gc_cleanup_list = NULL;
4763
4764         if (!init_failed && dev->param.n_caches > 0) {
4765                 int i;
4766                 void *buf;
4767                 int cache_bytes =
4768                     dev->param.n_caches * sizeof(struct yaffs_cache);
4769
4770                 if (dev->param.n_caches > YAFFS_MAX_SHORT_OP_CACHES)
4771                         dev->param.n_caches = YAFFS_MAX_SHORT_OP_CACHES;
4772
4773                 dev->cache = kmalloc(cache_bytes, GFP_NOFS);
4774
4775                 buf = (u8 *) dev->cache;
4776
4777                 if (dev->cache)
4778                         memset(dev->cache, 0, cache_bytes);
4779
4780                 for (i = 0; i < dev->param.n_caches && buf; i++) {
4781                         dev->cache[i].object = NULL;
4782                         dev->cache[i].last_use = 0;
4783                         dev->cache[i].dirty = 0;
4784                         dev->cache[i].data = buf =
4785                             kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
4786                 }
4787                 if (!buf)
4788                         init_failed = 1;
4789
4790                 dev->cache_last_use = 0;
4791         }
4792
4793         dev->cache_hits = 0;
4794
4795         if (!init_failed) {
4796                 dev->gc_cleanup_list =
4797                     kmalloc(dev->param.chunks_per_block * sizeof(u32),
4798                                         GFP_NOFS);
4799                 if (!dev->gc_cleanup_list)
4800                         init_failed = 1;
4801         }
4802
4803         if (dev->param.is_yaffs2)
4804                 dev->param.use_header_file_size = 1;
4805
4806         if (!init_failed && !yaffs_init_blocks(dev))
4807                 init_failed = 1;
4808
4809         yaffs_init_tnodes_and_objs(dev);
4810
4811         if (!init_failed && !yaffs_create_initial_dir(dev))
4812                 init_failed = 1;
4813
4814         if(!init_failed && dev->param.is_yaffs2 &&
4815                 !dev->param.disable_summary &&
4816                 !yaffs_summary_init(dev))
4817                 init_failed = 1;
4818
4819         if (!init_failed) {
4820                 /* Now scan the flash. */
4821                 if (dev->param.is_yaffs2) {
4822                         if (yaffs2_checkpt_restore(dev)) {
4823                                 yaffs_check_obj_details_loaded(dev->root_dir);
4824                                 yaffs_trace(YAFFS_TRACE_CHECKPOINT |
4825                                         YAFFS_TRACE_MOUNT,
4826                                         "yaffs: restored from checkpoint"
4827                                         );
4828                         } else {
4829
4830                                 /* Clean up the mess caused by an aborted
4831                                  * checkpoint load then scan backwards.
4832                                  */
4833                                 yaffs_deinit_blocks(dev);
4834
4835                                 yaffs_deinit_tnodes_and_objs(dev);
4836
4837                                 dev->n_erased_blocks = 0;
4838                                 dev->n_free_chunks = 0;
4839                                 dev->alloc_block = -1;
4840                                 dev->alloc_page = -1;
4841                                 dev->n_deleted_files = 0;
4842                                 dev->n_unlinked_files = 0;
4843                                 dev->n_bg_deletions = 0;
4844
4845                                 if (!init_failed && !yaffs_init_blocks(dev))
4846                                         init_failed = 1;
4847
4848                                 yaffs_init_tnodes_and_objs(dev);
4849
4850                                 if (!init_failed
4851                                     && !yaffs_create_initial_dir(dev))
4852                                         init_failed = 1;
4853
4854                                 if (!init_failed && !yaffs2_scan_backwards(dev))
4855                                         init_failed = 1;
4856                         }
4857                 } else if (!yaffs1_scan(dev)) {
4858                         init_failed = 1;
4859                 }
4860
4861                 yaffs_strip_deleted_objs(dev);
4862                 yaffs_fix_hanging_objs(dev);
4863                 if (dev->param.empty_lost_n_found)
4864                         yaffs_empty_l_n_f(dev);
4865         }
4866
4867         if (init_failed) {
4868                 /* Clean up the mess */
4869                 yaffs_trace(YAFFS_TRACE_TRACING,
4870                   "yaffs: yaffs_guts_initialise() aborted.");
4871
4872                 yaffs_deinitialise(dev);
4873                 return YAFFS_FAIL;
4874         }
4875
4876         /* Zero out stats */
4877         dev->n_page_reads = 0;
4878         dev->n_page_writes = 0;
4879         dev->n_erasures = 0;
4880         dev->n_gc_copies = 0;
4881         dev->n_retried_writes = 0;
4882
4883         dev->n_retired_blocks = 0;
4884
4885         yaffs_verify_free_chunks(dev);
4886         yaffs_verify_blocks(dev);
4887
4888         /* Clean up any aborted checkpoint data */
4889         if (!dev->is_checkpointed && dev->blocks_in_checkpt > 0)
4890                 yaffs2_checkpt_invalidate(dev);
4891
4892         yaffs_trace(YAFFS_TRACE_TRACING,
4893           "yaffs: yaffs_guts_initialise() done.");
4894         return YAFFS_OK;
4895 }
4896
4897 void yaffs_deinitialise(struct yaffs_dev *dev)
4898 {
4899         if (dev->is_mounted) {
4900                 int i;
4901
4902                 yaffs_deinit_blocks(dev);
4903                 yaffs_deinit_tnodes_and_objs(dev);
4904                 yaffs_summary_deinit(dev);
4905
4906                 if (dev->param.n_caches > 0 && dev->cache) {
4907
4908                         for (i = 0; i < dev->param.n_caches; i++) {
4909                                 kfree(dev->cache[i].data);
4910                                 dev->cache[i].data = NULL;
4911                         }
4912
4913                         kfree(dev->cache);
4914                         dev->cache = NULL;
4915                 }
4916
4917                 kfree(dev->gc_cleanup_list);
4918
4919                 for (i = 0; i < YAFFS_N_TEMP_BUFFERS; i++)
4920                         kfree(dev->temp_buffer[i].buffer);
4921
4922                 dev->is_mounted = 0;
4923
4924                 if (dev->param.deinitialise_flash_fn)
4925                         dev->param.deinitialise_flash_fn(dev);
4926         }
4927 }
4928
4929 int yaffs_count_free_chunks(struct yaffs_dev *dev)
4930 {
4931         int n_free = 0;
4932         int b;
4933         struct yaffs_block_info *blk;
4934
4935         blk = dev->block_info;
4936         for (b = dev->internal_start_block; b <= dev->internal_end_block; b++) {
4937                 switch (blk->block_state) {
4938                 case YAFFS_BLOCK_STATE_EMPTY:
4939                 case YAFFS_BLOCK_STATE_ALLOCATING:
4940                 case YAFFS_BLOCK_STATE_COLLECTING:
4941                 case YAFFS_BLOCK_STATE_FULL:
4942                         n_free +=
4943                             (dev->param.chunks_per_block - blk->pages_in_use +
4944                              blk->soft_del_pages);
4945                         break;
4946                 default:
4947                         break;
4948                 }
4949                 blk++;
4950         }
4951         return n_free;
4952 }
4953
4954 int yaffs_get_n_free_chunks(struct yaffs_dev *dev)
4955 {
4956         /* This is what we report to the outside world */
4957         int n_free;
4958         int n_dirty_caches;
4959         int blocks_for_checkpt;
4960         int i;
4961
4962         n_free = dev->n_free_chunks;
4963         n_free += dev->n_deleted_files;
4964
4965         /* Now count and subtract the number of dirty chunks in the cache. */
4966
4967         for (n_dirty_caches = 0, i = 0; i < dev->param.n_caches; i++) {
4968                 if (dev->cache[i].dirty)
4969                         n_dirty_caches++;
4970         }
4971
4972         n_free -= n_dirty_caches;
4973
4974         n_free -=
4975             ((dev->param.n_reserved_blocks + 1) * dev->param.chunks_per_block);
4976
4977         /* Now figure checkpoint space and report that... */
4978         blocks_for_checkpt = yaffs_calc_checkpt_blocks_required(dev);
4979
4980         n_free -= (blocks_for_checkpt * dev->param.chunks_per_block);
4981
4982         if (n_free < 0)
4983                 n_free = 0;
4984
4985         return n_free;
4986 }