direct/test-framework/yaffs_fileem2k.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 /*
  15  * This provides a YAFFS nand emulation on a file for emulating 2kB pages.
  16  * This is only intended as test code to test persistence etc.
  17  */
  18
  19 #include "yportenv.h"
  20 #include "yaffs_trace.h"
  21
  22 #include "yaffs_flashif2.h"
  23 #include "yaffs_guts.h"
  24 #include "yaffs_fileem2k.h"
  25 #include "yaffs_packedtags2.h"
  26
  27
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <fcntl.h>
  31 #include <unistd.h>
  32
  33 #if 1
  34
  35 #define SIZE_IN_MB 32
  36 /* #define SIZE_IN_MB 128 */
  37
  38 #define PAGE_DATA_SIZE (2048)
  39 #define PAGE_SPARE_SIZE  (64)
  40 #define PAGE_SIZE  (PAGE_DATA_SIZE + PAGE_SPARE_SIZE)
  41 #define PAGES_PER_BLOCK (64)
  42 #define BLOCK_DATA_SIZE (PAGE_DATA_SIZE * PAGES_PER_BLOCK)
  43 #define BLOCK_SIZE (PAGES_PER_BLOCK * (PAGE_SIZE))
  44 #define BLOCKS_PER_MB ((1024*1024)/BLOCK_DATA_SIZE)
  45 #define SIZE_IN_BLOCKS (BLOCKS_PER_MB * SIZE_IN_MB)
  46
  47 #else
  48
  49 #define SIZE_IN_MB 128
  50 #define PAGE_DATA_SIZE (512)
  51 #define SPARE_SIZE  (16)
  52 #define PAGE_SIZE  (PAGE_DATA_SIZE + SPARE_SIZE)
  53 #define PAGES_PER_BLOCK (32)
  54 #define BLOCK_DATA_SIZE (PAGE_SIZE * PAGES_PER_BLOCK)
  55 #define BLOCK_SIZE (PAGES_PER_BLOCK * (PAGE_SIZE))
  56 #define BLOCKS_PER_MB ((1024*1024)/BLOCK_DATA_SIZE)
  57 #define SIZE_IN_BLOCKS (BLOCKS_PER_MB * SIZE_IN_MB)
  58
  59 #endif
  60
  61 #define REPORT_ERROR 0
  62
  63 typedef struct
  64 {
  65         u8 data[PAGE_SIZE]; // Data + spare
  66 } yflash_Page;
  67
  68 typedef struct
  69 {
  70         yflash_Page page[PAGES_PER_BLOCK]; // The pages in the block
  71
  72 } yflash_Block;
  73
  74
  75
  76 #define MAX_HANDLES 20
  77 #define BLOCKS_PER_HANDLE (32*8)
  78
  79 typedef struct
  80 {
  81         int handle[MAX_HANDLES];
  82         int nBlocks;
  83 } yflash_Device;
  84
  85 static yflash_Device filedisk;
  86
  87 int yaffs_test_partial_write = 0;
  88
  89 extern int random_seed;
  90 extern int simulate_power_failure;
  91 static int remaining_ops;
  92 static int nops_so_far;
  93
  94 int ops_multiplier;
  95
  96
  97 static void yflash2_MaybePowerFail(unsigned int nand_chunk, int failPoint)
  98 {
  99
 100    nops_so_far++;
 101
 102
 103    remaining_ops--;
 104    if(simulate_power_failure &&
 105       remaining_ops < 1){
 106        printf("Simulated power failure after %d operations\n",nops_so_far);
 107        printf("  power failed on nand_chunk %d, at fail point %d\n",
 108                         nand_chunk, failPoint);
 109         exit(0);
 110   }
 111 }
 112
 113
 114
 115
 116
 117 static u8 localBuffer[PAGE_SIZE];
 118
 119 static char *NToName(char *buf,int n)
 120 {
 121         sprintf(buf,"emfile-2k-%d",n);
 122         return buf;
 123 }
 124
 125 static char dummyBuffer[BLOCK_SIZE];
 126
 127 static int GetBlockFileHandle(int n)
 128 {
 129         int h;
 130         int requiredSize;
 131
 132         char name[40];
 133         NToName(name,n);
 134         int fSize;
 135         int i;
 136
 137         h =  open(name, O_RDWR | O_CREAT, S_IREAD | S_IWRITE);
 138         if(h >= 0){
 139                 fSize = lseek(h,0,SEEK_END);
 140                 requiredSize = BLOCKS_PER_HANDLE * BLOCK_SIZE;
 141                 if(fSize < requiredSize){
 142                    for(i = 0; i < BLOCKS_PER_HANDLE; i++)
 143                         if(write(h,dummyBuffer,BLOCK_SIZE) != BLOCK_SIZE)
 144                                 return -1;
 145
 146                 }
 147         }
 148
 149         return h;
 150
 151 }
 152
 153 static int  CheckInit(void)
 154 {
 155         static int initialised = 0;
 156         int i;
 157
 158         int blk;
 159
 160
 161         if(initialised)
 162         {
 163                 return YAFFS_OK;
 164         }
 165
 166         initialised = 1;
 167
 168
 169         srand(random_seed);
 170         remaining_ops = (rand() % 1000) * 5;
 171         memset(dummyBuffer,0xff,sizeof(dummyBuffer));
 172
 173
 174
 175         filedisk.nBlocks = SIZE_IN_MB * BLOCKS_PER_MB;
 176
 177         for(i = 0; i <  MAX_HANDLES; i++)
 178                 filedisk.handle[i] = -1;
 179
 180         for(i = 0,blk = 0; blk < filedisk.nBlocks; blk+=BLOCKS_PER_HANDLE,i++)
 181                 filedisk.handle[i] = GetBlockFileHandle(i);
 182
 183
 184         return 1;
 185 }
 186
 187
 188 int yflash2_GetNumberOfBlocks(void)
 189 {
 190         CheckInit();
 191
 192         return filedisk.nBlocks;
 193 }
 194
 195
 196 int yaffs_check_all_ff(const u8 *ptr, int n)
 197 {
 198         while(n)
 199         {
 200                 n--;
 201                 if(*ptr!=0xFF) return 0;
 202                 ptr++;
 203         }
 204         return 1;
 205 }
 206
 207
 208 static int yflash2_WriteChunk(struct yaffs_dev *dev, int nand_chunk,
 209                                    const u8 *data, int data_len,
 210                                    const u8 *oob, int oob_len)
 211 {
 212         int retval = YAFFS_OK;
 213         int pos;
 214         int h;
 215         int nwritten;
 216
 217         (void) dev;
 218
 219         if (data && data_len) {
 220                 pos = (nand_chunk % (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE)) * PAGE_SIZE;
 221                 h = filedisk.handle[(nand_chunk / (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE))];
 222                 lseek(h,pos,SEEK_SET);
 223                 nwritten = write(h,data,data_len);
 224                 if(nwritten != data_len)
 225                         retval = YAFFS_FAIL;
 226         }
 227
 228         if (oob && oob_len) {
 229                 pos = (nand_chunk % (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE)) * PAGE_SIZE + PAGE_DATA_SIZE;
 230                 h = filedisk.handle[(nand_chunk / (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE))];
 231                 lseek(h,pos,SEEK_SET);
 232                 nwritten = write(h,oob,oob_len);
 233                 if(nwritten != oob_len)
 234                         retval = YAFFS_FAIL;
 235         }
 236
 237         yflash2_MaybePowerFail(nand_chunk,3);
 238
 239         return retval;
 240 }
 241
 242 static int yflash2_ReadChunk(struct yaffs_dev *dev, int nand_chunk,
 243                                    u8 *data, int data_len,
 244                                    u8 *oob, int oob_len,
 245                                    enum yaffs_ecc_result *ecc_result)
 246 {
 247         int retval = YAFFS_OK;
 248         int pos;
 249         int h;
 250         int nread;
 251
 252         (void) dev;
 253
 254         if (data && data_len) {
 255                 pos = (nand_chunk % (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE)) * PAGE_SIZE;
 256                 h = filedisk.handle[(nand_chunk / (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE))];
 257                 lseek(h,pos,SEEK_SET);
 258                 nread = read(h,data,data_len);
 259                 if(nread != data_len)
 260                         retval = YAFFS_FAIL;
 261         }
 262
 263         if (oob && oob_len) {
 264                 pos = (nand_chunk % (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE)) * PAGE_SIZE + PAGE_DATA_SIZE;
 265                 h = filedisk.handle[(nand_chunk / (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE))];
 266                 lseek(h,pos,SEEK_SET);
 267                 nread = read(h,oob,oob_len);
 268                 if(nread != oob_len)
 269                         retval = YAFFS_FAIL;
 270         }
 271
 272         if (ecc_result)
 273                 *ecc_result = YAFFS_ECC_RESULT_NO_ERROR;
 274
 275         return retval;
 276 }
 277
 278 static int yflash2_EraseBlock(struct yaffs_dev *dev, int block_no)
 279 {
 280         int i;
 281         int h;
 282
 283         CheckInit();
 284
 285         if(block_no < 0 || block_no >= filedisk.nBlocks)
 286         {
 287                 yaffs_trace(YAFFS_TRACE_ALWAYS,"Attempt to erase non-existant block %d",block_no);
 288                 return YAFFS_FAIL;
 289         }
 290         else
 291         {
 292
 293                 u8 pg[PAGE_SIZE];
 294                 int syz = PAGE_SIZE;
 295                 int pos;
 296
 297                 memset(pg,0xff,syz);
 298
 299
 300                 h = filedisk.handle[(block_no / ( BLOCKS_PER_HANDLE))];
 301                 lseek(h,((block_no % BLOCKS_PER_HANDLE) * dev->param.chunks_per_block) * PAGE_SIZE,SEEK_SET);
 302                 for(i = 0; i < dev->param.chunks_per_block; i++)
 303                 {
 304                         write(h,pg,PAGE_SIZE);
 305                 }
 306                 pos = lseek(h, 0,SEEK_CUR);
 307
 308                 return YAFFS_OK;
 309         }
 310 }
 311
 312 static int yflash2_MarkBad(struct yaffs_dev *dev, int block_no)
 313 {
 314         int written;
 315         int h;
 316
 317         struct yaffs_packed_tags2 pt;
 318
 319         CheckInit();
 320
 321         memset(&pt,0,sizeof(pt));
 322         h = filedisk.handle[(block_no / ( BLOCKS_PER_HANDLE))];
 323         lseek(h,((block_no % BLOCKS_PER_HANDLE) * dev->param.chunks_per_block) * PAGE_SIZE + PAGE_DATA_SIZE,SEEK_SET);
 324         written = write(h,&pt,sizeof(pt));
 325
 326         if(written != sizeof(pt))
 327                 return YAFFS_FAIL;
 328
 329         return YAFFS_OK;
 330
 331 }
 332
 333 static int yflash2_CheckBad(struct yaffs_dev *dev, int block_no)
 334 {
 335         (void) dev;
 336         (void) block_no;
 337
 338         return YAFFS_OK;
 339 }
 340
 341 static int yflash2_Initialise(struct yaffs_dev *dev)
 342 {
 343         (void) dev;
 344
 345         CheckInit();
 346
 347         return YAFFS_OK;
 348 }
 349
 350 struct yaffs_dev *yflash2_install_drv(const char *name)
 351 {
 352         struct yaffs_dev *dev = NULL;
 353         struct yaffs_param *param;
 354         struct yaffs_driver *drv;
 355
 356         dev = malloc(sizeof(*dev));
 357
 358         if(!dev)
 359                 return NULL;
 360
 361         memset(dev, 0, sizeof(*dev));
 362
 363         dev->param.name = strdup(name);
 364
 365         if(!dev->param.name) {
 366                 free(dev);
 367                 return NULL;
 368         }
 369
 370         drv = &dev->drv;
 371
 372         drv->drv_write_chunk_fn = yflash2_WriteChunk;
 373         drv->drv_read_chunk_fn = yflash2_ReadChunk;
 374         drv->drv_erase_fn = yflash2_EraseBlock;
 375         drv->drv_mark_bad_fn = yflash2_MarkBad;
 376         drv->drv_check_bad_fn = yflash2_CheckBad;
 377         drv->drv_initialise_fn = yflash2_Initialise;
 378
 379         param = &dev->param;
 380
 381         param->total_bytes_per_chunk = 2048;
 382         param->chunks_per_block = 64;
 383         param->start_block = 0;
 384         param->end_block = yflash2_GetNumberOfBlocks()-1;
 385         param->is_yaffs2 = 1;
 386         param->use_nand_ecc=1;
 387
 388         param->n_reserved_blocks = 5;
 389         param->wide_tnodes_disabled=0;
 390         param->refresh_period = 1000;
 391         param->n_caches = 10; // Use caches
 392
 393         param->enable_xattr = 1;
 394
 395         /* dev->driver_context is not used by this simulator */
 396
 397         yaffs_add_device(dev);
 398
 399         return dev;
 400 }