Write object headers with stored file extents
[yaffs2.git] / yaffs_checkptrw.c
index 711df13e5cd36ef18523f8eacec75b3d23ee1cb8..16ee1e0695c6b468941f4fcd0c6b983324e6d7db 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
  *
- * Copyright (C) 2002-2010 Aleph One Ltd.
+ * Copyright (C) 2002-2011 Aleph One Ltd.
  *   for Toby Churchill Ltd and Brightstar Engineering
  *
  * Created by Charles Manning <charles@aleph1.co.uk>
 #include "yaffs_checkptrw.h"
 #include "yaffs_getblockinfo.h"
 
+struct yaffs_checkpt_chunk_hdr {
+       int version;
+       int seq;
+       u32 sum;
+       u32 xor;
+} ;
+
+
+static int apply_chunk_offset(struct yaffs_dev *dev, int chunk)
+{
+       return chunk - dev->chunk_offset;
+}
+
+static int apply_block_offset(struct yaffs_dev *dev, int block)
+{
+       return block - dev->block_offset;
+}
+
+static void yaffs2_checkpt_init_chunk_hdr(struct yaffs_dev *dev)
+{
+       struct yaffs_checkpt_chunk_hdr hdr;
+
+       hdr.version = YAFFS_CHECKPOINT_VERSION;
+       hdr.seq = dev->checkpt_page_seq;
+       hdr.sum = dev->checkpt_sum;
+       hdr.xor = dev->checkpt_xor;
+
+       dev->checkpt_byte_offs = sizeof(hdr);
+
+       memcpy(dev->checkpt_buffer, &hdr, sizeof(hdr));
+}
+
+static int yaffs2_checkpt_check_chunk_hdr(struct yaffs_dev *dev)
+{
+       struct yaffs_checkpt_chunk_hdr hdr;
+
+       memcpy(&hdr, dev->checkpt_buffer, sizeof(hdr));
+
+       dev->checkpt_byte_offs = sizeof(hdr);
+
+       return hdr.version == YAFFS_CHECKPOINT_VERSION &&
+               hdr.seq == dev->checkpt_page_seq &&
+               hdr.sum == dev->checkpt_sum &&
+               hdr.xor == dev->checkpt_xor;
+}
+
 static int yaffs2_checkpt_space_ok(struct yaffs_dev *dev)
 {
        int blocks_avail = dev->n_erased_blocks - dev->param.n_reserved_blocks;
@@ -28,7 +74,7 @@ static int yaffs_checkpt_erase(struct yaffs_dev *dev)
 {
        int i;
 
-       if (!dev->param.erase_fn)
+       if (!dev->drv.drv_erase_fn)
                return 0;
        yaffs_trace(YAFFS_TRACE_CHECKPOINT,
                "checking blocks %d to %d",
@@ -36,21 +82,23 @@ static int yaffs_checkpt_erase(struct yaffs_dev *dev)
 
        for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
                struct yaffs_block_info *bi = yaffs_get_block_info(dev, i);
+               int offset_i = apply_block_offset(dev, i);
+               int result;
+
                if (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT) {
                        yaffs_trace(YAFFS_TRACE_CHECKPOINT,
                        "erasing checkpt block %d", i);
 
                        dev->n_erasures++;
 
-                       if (dev->param.
-                           erase_fn(dev,
-                                    i - dev->block_offset /* realign */)) {
+                       result = dev->drv.drv_erase_fn(dev, offset_i);
+                       if(result) {
                                bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
                                dev->n_erased_blocks++;
                                dev->n_free_chunks +=
                                    dev->param.chunks_per_block;
                        } else {
-                               dev->param.bad_block_fn(dev, i);
+                               dev->drv.drv_mark_bad_fn(dev, offset_i);
                                bi->block_state = YAFFS_BLOCK_STATE_DEAD;
                        }
                }
@@ -77,8 +125,9 @@ static void yaffs2_checkpt_find_erased_block(struct yaffs_dev *dev)
 
                for (i = dev->checkpt_next_block; i <= dev->internal_end_block;
                     i++) {
-                       struct yaffs_block_info *bi =
-                           yaffs_get_block_info(dev, i);
+                       struct yaffs_block_info *bi;
+
+                       bi = yaffs_get_block_info(dev, i);
                        if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
                                dev->checkpt_next_block = i + 1;
                                dev->checkpt_cur_block = i;
@@ -107,26 +156,35 @@ static void yaffs2_checkpt_find_block(struct yaffs_dev *dev)
                for (i = dev->checkpt_next_block; i <= dev->internal_end_block;
                     i++) {
                        int chunk = i * dev->param.chunks_per_block;
-                       int realigned_chunk = chunk - dev->chunk_offset;
+                       enum yaffs_block_state state;
+                       u32 seq;
 
-                       dev->param.read_chunk_tags_fn(dev, realigned_chunk,
-                                                     NULL, &tags);
+                       dev->tagger.read_chunk_tags_fn(dev,
+                                       apply_chunk_offset(dev, chunk),
+                                       NULL, &tags);
                        yaffs_trace(YAFFS_TRACE_CHECKPOINT,
-                               "find next checkpt block: search: block %d oid %d seq %d eccr %d",
-                               i, tags.obj_id, tags.seq_number,
+                               "find next checkpt block: search: block %d state %d oid %d seq %d eccr %d",
+                               i, (int) state,
+                               tags.obj_id, tags.seq_number,
                                tags.ecc_result);
 
-                       if (tags.seq_number == YAFFS_SEQUENCE_CHECKPOINT_DATA) {
-                               /* Right kind of block */
-                               dev->checkpt_next_block = tags.obj_id;
-                               dev->checkpt_cur_block = i;
-                               dev->checkpt_block_list[dev->
-                                                       blocks_in_checkpt] = i;
-                               dev->blocks_in_checkpt++;
-                               yaffs_trace(YAFFS_TRACE_CHECKPOINT,
-                                       "found checkpt block %d", i);
-                               return;
-                       }
+                       if (tags.seq_number != YAFFS_SEQUENCE_CHECKPOINT_DATA)
+                               continue;
+
+                       dev->tagger.query_block_fn(dev,
+                                               apply_block_offset(dev, i),
+                                               &state, &seq);
+                       if (state == YAFFS_BLOCK_STATE_DEAD)
+                               continue;
+
+                       /* Right kind of block */
+                       dev->checkpt_next_block = tags.obj_id;
+                       dev->checkpt_cur_block = i;
+                       dev->checkpt_block_list[dev->blocks_in_checkpt] = i;
+                       dev->blocks_in_checkpt++;
+                       yaffs_trace(YAFFS_TRACE_CHECKPOINT,
+                               "found checkpt block %d", i);
+                       return;
                }
 
        yaffs_trace(YAFFS_TRACE_CHECKPOINT, "found no more checkpt blocks");
@@ -137,12 +195,15 @@ static void yaffs2_checkpt_find_block(struct yaffs_dev *dev)
 
 int yaffs2_checkpt_open(struct yaffs_dev *dev, int writing)
 {
+       int i;
+
        dev->checkpt_open_write = writing;
 
        /* Got the functions we need? */
-       if (!dev->param.write_chunk_tags_fn ||
-           !dev->param.read_chunk_tags_fn ||
-           !dev->param.erase_fn || !dev->param.bad_block_fn)
+       if (!dev->tagger.write_chunk_tags_fn ||
+           !dev->tagger.read_chunk_tags_fn ||
+           !dev->drv.drv_erase_fn ||
+           !dev->drv.drv_mark_bad_fn)
                return 0;
 
        if (writing && !yaffs2_checkpt_space_ok(dev))
@@ -162,29 +223,29 @@ int yaffs2_checkpt_open(struct yaffs_dev *dev, int writing)
        dev->checkpt_cur_chunk = -1;
        dev->checkpt_next_block = dev->internal_start_block;
 
-       /* Erase all the blocks in the checkpoint area */
        if (writing) {
                memset(dev->checkpt_buffer, 0, dev->data_bytes_per_chunk);
-               dev->checkpt_byte_offs = 0;
+               yaffs2_checkpt_init_chunk_hdr(dev);
                return yaffs_checkpt_erase(dev);
-       } else {
-               int i;
-               /* Set to a value that will kick off a read */
-               dev->checkpt_byte_offs = dev->data_bytes_per_chunk;
-               /* A checkpoint block list of 1 checkpoint block per 16 block is
-                * (hopefully) going to be way more than we need */
-               dev->blocks_in_checkpt = 0;
-               dev->checkpt_max_blocks =
-                   (dev->internal_end_block - dev->internal_start_block) / 16 +
-                   2;
+       }
+
+       /* Opening for a read */
+       /* Set to a value that will kick off a read */
+       dev->checkpt_byte_offs = dev->data_bytes_per_chunk;
+       /* A checkpoint block list of 1 checkpoint block per 16 block is
+        * (hopefully) going to be way more than we need */
+       dev->blocks_in_checkpt = 0;
+       dev->checkpt_max_blocks =
+           (dev->internal_end_block - dev->internal_start_block) / 16 + 2;
+       if (!dev->checkpt_block_list)
                dev->checkpt_block_list =
-                   kmalloc(sizeof(int) * dev->checkpt_max_blocks, GFP_NOFS);
-               if (!dev->checkpt_block_list)
-                       return 0;
+                     kmalloc(sizeof(int) * dev->checkpt_max_blocks, GFP_NOFS);
 
-               for (i = 0; i < dev->checkpt_max_blocks; i++)
-                       dev->checkpt_block_list[i] = -1;
-       }
+       if (!dev->checkpt_block_list)
+               return 0;
+
+       for (i = 0; i < dev->checkpt_max_blocks; i++)
+               dev->checkpt_block_list[i] = -1;
 
        return 1;
 }
@@ -193,7 +254,7 @@ int yaffs2_get_checkpt_sum(struct yaffs_dev *dev, u32 * sum)
 {
        u32 composite_sum;
 
-       composite_sum = (dev->checkpt_sum << 8) | (dev->checkpt_xor & 0xFF);
+       composite_sum = (dev->checkpt_sum << 8) | (dev->checkpt_xor & 0xff);
        *sum = composite_sum;
        return 1;
 }
@@ -201,7 +262,7 @@ int yaffs2_get_checkpt_sum(struct yaffs_dev *dev, u32 * sum)
 static int yaffs2_checkpt_flush_buffer(struct yaffs_dev *dev)
 {
        int chunk;
-       int realigned_chunk;
+       int offset_chunk;
        struct yaffs_ext_tags tags;
 
        if (dev->checkpt_cur_block < 0) {
@@ -235,13 +296,12 @@ static int yaffs2_checkpt_flush_buffer(struct yaffs_dev *dev)
                chunk, dev->checkpt_cur_block, dev->checkpt_cur_chunk,
                tags.obj_id, tags.chunk_id);
 
-       realigned_chunk = chunk - dev->chunk_offset;
+       offset_chunk = apply_chunk_offset(dev, chunk);
 
        dev->n_page_writes++;
 
-       dev->param.write_chunk_tags_fn(dev, realigned_chunk,
+       dev->tagger.write_chunk_tags_fn(dev, offset_chunk,
                                       dev->checkpt_buffer, &tags);
-       dev->checkpt_byte_offs = 0;
        dev->checkpt_page_seq++;
        dev->checkpt_cur_chunk++;
        if (dev->checkpt_cur_chunk >= dev->param.chunks_per_block) {
@@ -250,6 +310,9 @@ static int yaffs2_checkpt_flush_buffer(struct yaffs_dev *dev)
        }
        memset(dev->checkpt_buffer, 0, dev->data_bytes_per_chunk);
 
+       yaffs2_checkpt_init_chunk_hdr(dev);
+
+
        return 1;
 }
 
@@ -286,10 +349,9 @@ int yaffs2_checkpt_wr(struct yaffs_dev *dev, const void *data, int n_bytes)
 int yaffs2_checkpt_rd(struct yaffs_dev *dev, void *data, int n_bytes)
 {
        int i = 0;
-       int ok = 1;
        struct yaffs_ext_tags tags;
        int chunk;
-       int realigned_chunk;
+       int offset_chunk;
        u8 *data_bytes = (u8 *) data;
 
        if (!dev->checkpt_buffer)
@@ -298,7 +360,7 @@ int yaffs2_checkpt_rd(struct yaffs_dev *dev, void *data, int n_bytes)
        if (dev->checkpt_open_write)
                return -1;
 
-       while (i < n_bytes && ok) {
+       while (i < n_bytes) {
 
                if (dev->checkpt_byte_offs < 0 ||
                    dev->checkpt_byte_offs >= dev->data_bytes_per_chunk) {
@@ -308,91 +370,88 @@ int yaffs2_checkpt_rd(struct yaffs_dev *dev, void *data, int n_bytes)
                                dev->checkpt_cur_chunk = 0;
                        }
 
+                       /* Bail out if we can't find a checpoint block */
                        if (dev->checkpt_cur_block < 0)
-                               ok = 0;
-                       else {
-                               chunk = dev->checkpt_cur_block *
-                                   dev->param.chunks_per_block +
-                                   dev->checkpt_cur_chunk;
-
-                               realigned_chunk = chunk - dev->chunk_offset;
-
-                               dev->n_page_reads++;
-
-                               /* read in the next chunk */
-                               dev->param.read_chunk_tags_fn(dev,
-                                                       realigned_chunk,
-                                                       dev->checkpt_buffer,
-                                                       &tags);
-
-                               if (tags.chunk_id != (dev->checkpt_page_seq + 1)
-                                   || tags.ecc_result > YAFFS_ECC_RESULT_FIXED
-                                   || tags.seq_number !=
-                                   YAFFS_SEQUENCE_CHECKPOINT_DATA)
-                                       ok = 0;
-
-                               dev->checkpt_byte_offs = 0;
-                               dev->checkpt_page_seq++;
-                               dev->checkpt_cur_chunk++;
-
-                               if (dev->checkpt_cur_chunk >=
-                                   dev->param.chunks_per_block)
-                                       dev->checkpt_cur_block = -1;
-                       }
-               }
+                               break;
+
+                       chunk = dev->checkpt_cur_block *
+                           dev->param.chunks_per_block +
+                           dev->checkpt_cur_chunk;
+
+                       offset_chunk = apply_chunk_offset(dev, chunk);
+                       dev->n_page_reads++;
+
+                       /* Read in the next chunk */
+                       dev->tagger.read_chunk_tags_fn(dev,
+                                               offset_chunk,
+                                               dev->checkpt_buffer,
+                                               &tags);
+
+                       /* Bail out if the chunk is corrupted. */
+                       if (tags.chunk_id != (dev->checkpt_page_seq + 1) ||
+                           tags.ecc_result > YAFFS_ECC_RESULT_FIXED ||
+                           tags.seq_number != YAFFS_SEQUENCE_CHECKPOINT_DATA)
+                               break;
+
+                       /* Bail out if it is not a checkpoint chunk. */
+                       if(!yaffs2_checkpt_check_chunk_hdr(dev))
+                               break;
+
+                       dev->checkpt_page_seq++;
+                       dev->checkpt_cur_chunk++;
+
+                       if (dev->checkpt_cur_chunk >=
+                                       dev->param.chunks_per_block)
+                               dev->checkpt_cur_block = -1;
 
-               if (ok) {
-                       *data_bytes =
-                           dev->checkpt_buffer[dev->checkpt_byte_offs];
-                       dev->checkpt_sum += *data_bytes;
-                       dev->checkpt_xor ^= *data_bytes;
-                       dev->checkpt_byte_offs++;
-                       i++;
-                       data_bytes++;
-                       dev->checkpt_byte_count++;
                }
+
+               *data_bytes = dev->checkpt_buffer[dev->checkpt_byte_offs];
+               dev->checkpt_sum += *data_bytes;
+               dev->checkpt_xor ^= *data_bytes;
+               dev->checkpt_byte_offs++;
+               i++;
+               data_bytes++;
+               dev->checkpt_byte_count++;
        }
 
-       return i;
+       return i; /* Number of bytes read */
 }
 
 int yaffs_checkpt_close(struct yaffs_dev *dev)
 {
+       int i;
+
        if (dev->checkpt_open_write) {
-               if (dev->checkpt_byte_offs != 0)
+               if (dev->checkpt_byte_offs !=
+                       sizeof(sizeof(struct yaffs_checkpt_chunk_hdr)))
                        yaffs2_checkpt_flush_buffer(dev);
        } else if (dev->checkpt_block_list) {
-               int i;
                for (i = 0;
-                    i < dev->blocks_in_checkpt
-                    && dev->checkpt_block_list[i] >= 0; i++) {
+                    i < dev->blocks_in_checkpt &&
+                    dev->checkpt_block_list[i] >= 0; i++) {
                        int blk = dev->checkpt_block_list[i];
                        struct yaffs_block_info *bi = NULL;
-                       if (dev->internal_start_block <= blk
-                           && blk <= dev->internal_end_block)
+
+                       if (dev->internal_start_block <= blk &&
+                           blk <= dev->internal_end_block)
                                bi = yaffs_get_block_info(dev, blk);
                        if (bi && bi->block_state == YAFFS_BLOCK_STATE_EMPTY)
                                bi->block_state = YAFFS_BLOCK_STATE_CHECKPOINT;
                }
-               kfree(dev->checkpt_block_list);
-               dev->checkpt_block_list = NULL;
        }
 
        dev->n_free_chunks -=
-           dev->blocks_in_checkpt * dev->param.chunks_per_block;
+               dev->blocks_in_checkpt * dev->param.chunks_per_block;
        dev->n_erased_blocks -= dev->blocks_in_checkpt;
 
        yaffs_trace(YAFFS_TRACE_CHECKPOINT, "checkpoint byte count %d",
                dev->checkpt_byte_count);
 
-       if (dev->checkpt_buffer) {
-               /* free the buffer */
-               kfree(dev->checkpt_buffer);
-               dev->checkpt_buffer = NULL;
+       if (dev->checkpt_buffer)
                return 1;
-       } else {
+       else
                return 0;
-       }
 }
 
 int yaffs2_checkpt_invalidate_stream(struct yaffs_dev *dev)