utils/mkyaffsimage.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  * Nick Bane modifications flagged NCB
   9  * Endian handling patches by James Ng
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  */
  15
  16 /*
  17  * makeyaffsimage.c
  18  *
  19  * Makes a YAFFS file system image that can be used to load up a file system.
  20  */
  21
  22 #include <stdlib.h>
  23 #include <stdio.h>
  24 #include <fcntl.h>
  25 #include <sys/types.h>
  26 #include <sys/stat.h>
  27 #include <dirent.h>
  28 #include <string.h>
  29 #include <unistd.h>
  30 #include "yaffs_ecc.h"
  31 #include "yaffs_guts.h"
  32
  33
  34 #define MAX_OBJECTS 10000
  35
  36 const char * mkyaffsimage_c_version = "$Id: mkyaffsimage.c,v 1.7 2003/07/16 03:00:48 charles Exp $";
  37
  38
  39 typedef struct
  40 {
  41         dev_t dev;
  42         ino_t ino;
  43         int   obj;
  44 } objItem;
  45
  46
  47 static objItem obj_list[MAX_OBJECTS];
  48 static int n_obj = 0;
  49 static int obj_id = YAFFS_NOBJECT_BUCKETS + 1;
  50
  51 static int n_obj, nDirectories, nPages;
  52
  53 static int outFile;
  54
  55 static int error;
  56
  57 static int convert_endian = 0;
  58
  59 static int obj_compare(const void *a, const void * b)
  60 {
  61   objItem *oa, *ob;
  62
  63   oa = (objItem *)a;
  64   ob = (objItem *)b;
  65
  66   if(oa->dev < ob->dev) return -1;
  67   if(oa->dev > ob->dev) return 1;
  68   if(oa->ino < ob->ino) return -1;
  69   if(oa->ino > ob->ino) return 1;
  70
  71   return 0;
  72 }
  73
  74
  75 static void add_obj_to_list(dev_t dev, ino_t ino, int obj)
  76 {
  77         if(n_obj < MAX_OBJECTS)
  78         {
  79                 obj_list[n_obj].dev = dev;
  80                 obj_list[n_obj].ino = ino;
  81                 obj_list[n_obj].obj = obj;
  82                 n_obj++;
  83                 qsort(obj_list,n_obj,sizeof(objItem),obj_compare);
  84
  85         }
  86         else
  87         {
  88                 // oops! not enough space in the object array
  89                 fprintf(stderr,"Not enough space in object array\n");
  90                 exit(2);
  91         }
  92 }
  93
  94
  95 static int find_obj_in_list(dev_t dev, ino_t ino)
  96 {
  97         objItem *i = NULL;
  98         objItem test;
  99
 100         test.dev = dev;
 101         test.ino = ino;
 102
 103         if(n_obj > 0)
 104         {
 105                 i = bsearch(&test,obj_list,n_obj,sizeof(objItem),obj_compare);
 106         }
 107
 108         if(i)
 109         {
 110                 return i->obj;
 111         }
 112         return -1;
 113 }
 114
 115 // NCB added 10/9/2002
 116 static u16 yaffs_calc_name_sum(const char *name)
 117 {
 118         u16 sum = 0;
 119         u16 i = 1;
 120
 121         u8 *bname = (u8 *)name;
 122
 123         while (*bname)
 124         {
 125                 sum += (*bname) * i;
 126                 i++;
 127                 bname++;
 128         }
 129         return sum;
 130 }
 131
 132
 133 static void yaffs_calc_ecc(const u8 *data, struct yaffs_spare *spare)
 134 {
 135         yaffs_ecc_cacl(data , spare->ecc1);
 136         yaffs_ecc_cacl(&data[256] , spare->ecc2);
 137 }
 138
 139 static void yaffs_calc_tags_ecc(struct yaffs_tags *tags)
 140 {
 141         // Todo don't do anything yet. Need to calculate ecc
 142         unsigned char *b = ((union yaffs_tags_union *)tags)->as_bytes;
 143         unsigned  i,j;
 144         unsigned  ecc = 0;
 145         unsigned bit = 0;
 146
 147     // Clear ECC fields
 148     if (!convert_endian)
 149     {
 150             tags->ecc = 0;
 151     }
 152     else
 153     {
 154         // Because we're in "munged tag" mode, we have to clear it manually
 155         b[6] &= 0xC0;
 156         b[7] &= 0x03;
 157     }
 158
 159         for(i = 0; i < 8; i++)
 160         {
 161 // NCB modified 20-9-02         for(j = 1; j &0x7f; j<<=1)
 162                 for(j = 1; j &0xff; j<<=1)
 163                 {
 164                         bit++;
 165                         if(b[i] & j)
 166                         {
 167                                 ecc ^= bit;
 168                         }
 169                 }
 170         }
 171
 172         // Write out ECC
 173     if (!convert_endian)
 174     {
 175         tags->ecc = ecc;
 176     }
 177     else
 178     {
 179             // We have to munge the ECC again.
 180             b[6] |= ((ecc >> 6) & 0x3F);
 181         b[7] |= ((ecc & 0x3F) << 2);
 182     }
 183 }
 184 static void yaffs_load_tags_to_spare(struct yaffs_spare *sparePtr, struct yaffs_tags *tagsPtr)
 185 {
 186         union yaffs_tags_union *tu = (union yaffs_tags_union *)tagsPtr;
 187
 188         //yaffs_calc_tags_ecc(tagsPtr);
 189
 190         sparePtr->tb0 = tu->as_bytes[0];
 191         sparePtr->tb1 = tu->as_bytes[1];
 192         sparePtr->tb2 = tu->as_bytes[2];
 193         sparePtr->tb3 = tu->as_bytes[3];
 194         sparePtr->tb4 = tu->as_bytes[4];
 195         sparePtr->tb5 = tu->as_bytes[5];
 196         sparePtr->tb6 = tu->as_bytes[6];
 197         sparePtr->tb7 = tu->as_bytes[7];
 198 }
 199
 200 /* This little function converts a little endian tag to a big endian tag.
 201  * NOTE: The tag is not usable after this other than calculating the CRC
 202  * with.
 203  */
 204 static void little_to_big_endian(struct yaffs_tags *tagsPtr)
 205 {
 206     union yaffs_tags_union * tags = (union yaffs_tags_union* )tagsPtr; // Work in bytes.
 207     union yaffs_tags_union   temp;
 208
 209     memset(&temp, 0, sizeof(temp));
 210     // Ick, I hate magic numbers.
 211     temp.as_bytes[0] = ((tags->as_bytes[2] & 0x0F) << 4) | ((tags->as_bytes[1] & 0xF0) >> 4);
 212     temp.as_bytes[1] = ((tags->as_bytes[1] & 0x0F) << 4) | ((tags->as_bytes[0] & 0xF0) >> 4);
 213     temp.as_bytes[2] = ((tags->as_bytes[0] & 0x0F) << 4) | ((tags->as_bytes[2] & 0x30) >> 2) | ((tags->as_bytes[3] & 0xC0) >> 6);
 214     temp.as_bytes[3] = ((tags->as_bytes[3] & 0x3F) << 2) | ((tags->as_bytes[2] & 0xC0) >> 6);
 215     temp.as_bytes[4] = ((tags->as_bytes[6] & 0x03) << 6) | ((tags->as_bytes[5] & 0xFC) >> 2);
 216     temp.as_bytes[5] = ((tags->as_bytes[5] & 0x03) << 6) | ((tags->as_bytes[4] & 0xFC) >> 2);
 217     temp.as_bytes[6] = ((tags->as_bytes[4] & 0x03) << 6) | (tags->as_bytes[7] & 0x3F);
 218     temp.as_bytes[7] = (tags->as_bytes[6] & 0xFC) | ((tags->as_bytes[7] & 0xC0) >> 6);
 219
 220     // Now copy it back.
 221     tags->as_bytes[0] = temp.as_bytes[0];
 222     tags->as_bytes[1] = temp.as_bytes[1];
 223     tags->as_bytes[2] = temp.as_bytes[2];
 224     tags->as_bytes[3] = temp.as_bytes[3];
 225     tags->as_bytes[4] = temp.as_bytes[4];
 226     tags->as_bytes[5] = temp.as_bytes[5];
 227     tags->as_bytes[6] = temp.as_bytes[6];
 228     tags->as_bytes[7] = temp.as_bytes[7];
 229 }
 230
 231 static int write_chunk(u8 *data, u32 obj_id, u32 chunk_id, u32 n_bytes)
 232 {
 233         struct yaffs_tags t;
 234         struct yaffs_spare s;
 235
 236         error = write(outFile,data,512);
 237         if(error < 0) return error;
 238
 239         memset(&t,0xff,sizeof (struct yaffs_tags));
 240         memset(&s,0xff,sizeof (struct yaffs_spare));
 241
 242         t.chunk_id = chunk_id;
 243         t.serial_number = 0;
 244         t.n_bytes_lsb = n_bytes;
 245         t.obj_id = obj_id;
 246
 247     if (convert_endian)
 248     {
 249         little_to_big_endian(&t);
 250     }
 251
 252         yaffs_calc_tags_ecc(&t);
 253         yaffs_load_tags_to_spare(&s,&t);
 254         yaffs_calc_ecc(data,&s);
 255
 256         nPages++;
 257
 258         return write(outFile,&s,sizeof(struct yaffs_spare));
 259
 260 }
 261
 262 #define SWAP32(x)   ((((x) & 0x000000FF) << 24) | \
 263                      (((x) & 0x0000FF00) << 8 ) | \
 264                      (((x) & 0x00FF0000) >> 8 ) | \
 265                      (((x) & 0xFF000000) >> 24))
 266
 267 #define SWAP16(x)   ((((x) & 0x00FF) << 8) | \
 268                      (((x) & 0xFF00) >> 8))
 269
 270 // This one is easier, since the types are more standard. No funky shifts here.
 271 static void object_header_little_to_big_endian(struct yaffs_obj_hdr* oh)
 272 {
 273     oh->type = SWAP32(oh->type); // GCC makes enums 32 bits.
 274     oh->parent_obj_id = SWAP32(oh->parent_obj_id); // int
 275     oh->sum_no_longer_used = SWAP16(oh->sum_no_longer_used); // u16 - Not used, but done for completeness.
 276     // name = skip. Char array. Not swapped.
 277     oh->yst_mode = SWAP32(oh->yst_mode);
 278
 279     // Regular POSIX.
 280     oh->yst_uid = SWAP32(oh->yst_uid);
 281     oh->yst_gid = SWAP32(oh->yst_gid);
 282     oh->yst_atime = SWAP32(oh->yst_atime);
 283     oh->yst_mtime = SWAP32(oh->yst_mtime);
 284     oh->yst_ctime = SWAP32(oh->yst_ctime);
 285
 286     oh->file_size = SWAP32(oh->file_size); // Aiee. An int... signed, at that!
 287     oh->equiv_id = SWAP32(oh->equiv_id);
 288     // alias  - char array.
 289     oh->yst_rdev = SWAP32(oh->yst_rdev);
 290
 291     oh->win_ctime[0] = SWAP32(oh->win_ctime[0]);
 292     oh->win_ctime[1] = SWAP32(oh->win_ctime[1]);
 293     oh->win_atime[0] = SWAP32(oh->win_atime[0]);
 294     oh->win_atime[1] = SWAP32(oh->win_atime[1]);
 295     oh->win_mtime[0] = SWAP32(oh->win_mtime[0]);
 296     oh->win_mtime[1] = SWAP32(oh->win_mtime[1]);
 297
 298     oh->reserved[0] = SWAP32(oh->reserved[0]);
 299     oh->reserved[1] = SWAP32(oh->reserved[1]);
 300
 301     oh->inband_shadowed_obj_id = SWAP32(oh->inband_shadowed_obj_id);
 302     oh->inband_is_shrink = SWAP32(oh->inband_is_shrink);
 303     oh->shadows_obj = SWAP32(oh->shadows_obj);
 304     oh->is_shrink = SWAP32(oh->is_shrink);
 305 }
 306
 307 static int write_object_header(int obj_id, enum yaffs_obj_type t, struct stat *s, int parent, const char *name, int equivalentObj, const char * alias)
 308 {
 309         u8 bytes[512];
 310
 311
 312         struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)bytes;
 313
 314         memset(bytes,0xff,512);
 315
 316         oh->type = t;
 317
 318         oh->parent_obj_id = parent;
 319
 320         strncpy(oh->name,name,YAFFS_MAX_NAME_LENGTH);
 321
 322
 323         if(t != YAFFS_OBJECT_TYPE_HARDLINK)
 324         {
 325                 oh->yst_mode = s->st_mode;
 326                 oh->yst_uid = s->st_uid;
 327 // NCB 12/9/02          oh->yst_gid = s->yst_uid;
 328                 oh->yst_gid = s->st_gid;
 329                 oh->yst_atime = s->st_atime;
 330                 oh->yst_mtime = s->st_mtime;
 331                 oh->yst_ctime = s->st_ctime;
 332                 oh->yst_rdev  = s->st_rdev;
 333         }
 334
 335         if(t == YAFFS_OBJECT_TYPE_FILE)
 336         {
 337                 oh->file_size = s->st_size;
 338         }
 339
 340         if(t == YAFFS_OBJECT_TYPE_HARDLINK)
 341         {
 342                 oh->equiv_id = equivalentObj;
 343         }
 344
 345         if(t == YAFFS_OBJECT_TYPE_SYMLINK)
 346         {
 347                 strncpy(oh->alias,alias,YAFFS_MAX_ALIAS_LENGTH);
 348         }
 349
 350     if (convert_endian)
 351     {
 352         object_header_little_to_big_endian(oh);
 353     }
 354
 355         return write_chunk(bytes,obj_id,0,0xffff);
 356
 357 }
 358
 359
 360 static int process_directory(int parent, const char *path)
 361 {
 362
 363         DIR *dir;
 364         struct dirent *entry;
 365
 366         nDirectories++;
 367
 368         dir = opendir(path);
 369
 370         if(dir)
 371         {
 372                 while((entry = readdir(dir)) != NULL)
 373                 {
 374
 375                         /* Ignore . and .. */
 376                         if(strcmp(entry->d_name,".") &&
 377                            strcmp(entry->d_name,".."))
 378                         {
 379                                 char full_name[500];
 380                                 struct stat stats;
 381                                 int equivalentObj;
 382                                 int newObj;
 383
 384                                 sprintf(full_name,"%s/%s",path,entry->d_name);
 385
 386                                 lstat(full_name,&stats);
 387
 388                                 if(S_ISLNK(stats.st_mode) ||
 389                                     S_ISREG(stats.st_mode) ||
 390                                     S_ISDIR(stats.st_mode) ||
 391                                     S_ISFIFO(stats.st_mode) ||
 392                                     S_ISBLK(stats.st_mode) ||
 393                                     S_ISCHR(stats.st_mode) ||
 394                                     S_ISSOCK(stats.st_mode))
 395                                 {
 396
 397                                         newObj = obj_id++;
 398                                         n_obj++;
 399
 400                                         printf("Object %d, %s is a ",newObj,full_name);
 401
 402                                         /* We're going to create an object for it */
 403                                         if((equivalentObj = find_obj_in_list(stats.st_dev, stats.st_ino)) > 0)
 404                                         {
 405                                                 /* we need to make a hard link */
 406                                                 printf("hard link to object %d\n",equivalentObj);
 407                                                 error =  write_object_header(newObj, YAFFS_OBJECT_TYPE_HARDLINK, &stats, parent, entry->d_name, equivalentObj, NULL);
 408                                         }
 409                                         else
 410                                         {
 411
 412                                                 add_obj_to_list(stats.st_dev,stats.st_ino,newObj);
 413
 414                                                 if(S_ISLNK(stats.st_mode))
 415                                                 {
 416
 417                                                         char symname[500];
 418
 419                                                         memset(symname,0, sizeof(symname));
 420
 421                                                         readlink(full_name,symname,sizeof(symname) -1);
 422
 423                                                         printf("symlink to \"%s\"\n",symname);
 424                                                         error =  write_object_header(newObj, YAFFS_OBJECT_TYPE_SYMLINK, &stats, parent, entry->d_name, -1, symname);
 425
 426                                                 }
 427                                                 else if(S_ISREG(stats.st_mode))
 428                                                 {
 429                                                         printf("file, ");
 430                                                         error =  write_object_header(newObj, YAFFS_OBJECT_TYPE_FILE, &stats, parent, entry->d_name, -1, NULL);
 431
 432                                                         if(error >= 0)
 433                                                         {
 434                                                                 int h;
 435                                                                 u8 bytes[512];
 436                                                                 int n_bytes;
 437                                                                 int chunk = 0;
 438
 439                                                                 h = open(full_name,O_RDONLY);
 440                                                                 if(h >= 0)
 441                                                                 {
 442                                                                         memset(bytes,0xff,512);
 443                                                                         while((n_bytes = read(h,bytes,512)) > 0)
 444                                                                         {
 445                                                                                 chunk++;
 446                                                                                 write_chunk(bytes,newObj,chunk,n_bytes);
 447                                                                                 memset(bytes,0xff,512);
 448                                                                         }
 449                                                                         if(n_bytes < 0)
 450                                                                            error = n_bytes;
 451
 452                                                                         printf("%d data chunks written\n",chunk);
 453                                                                 }
 454                                                                 else
 455                                                                 {
 456                                                                         perror("Error opening file");
 457                                                                 }
 458                                                                 close(h);
 459
 460                                                         }
 461
 462                                                 }
 463                                                 else if(S_ISSOCK(stats.st_mode))
 464                                                 {
 465                                                         printf("socket\n");
 466                                                         error =  write_object_header(newObj, YAFFS_OBJECT_TYPE_SPECIAL, &stats, parent, entry->d_name, -1, NULL);
 467                                                 }
 468                                                 else if(S_ISFIFO(stats.st_mode))
 469                                                 {
 470                                                         printf("fifo\n");
 471                                                         error =  write_object_header(newObj, YAFFS_OBJECT_TYPE_SPECIAL, &stats, parent, entry->d_name, -1, NULL);
 472                                                 }
 473                                                 else if(S_ISCHR(stats.st_mode))
 474                                                 {
 475                                                         printf("character device\n");
 476                                                         error =  write_object_header(newObj, YAFFS_OBJECT_TYPE_SPECIAL, &stats, parent, entry->d_name, -1, NULL);
 477                                                 }
 478                                                 else if(S_ISBLK(stats.st_mode))
 479                                                 {
 480                                                         printf("block device\n");
 481                                                         error =  write_object_header(newObj, YAFFS_OBJECT_TYPE_SPECIAL, &stats, parent, entry->d_name, -1, NULL);
 482                                                 }
 483                                                 else if(S_ISDIR(stats.st_mode))
 484                                                 {
 485                                                         printf("directory\n");
 486                                                         error =  write_object_header(newObj, YAFFS_OBJECT_TYPE_DIRECTORY, &stats, parent, entry->d_name, -1, NULL);
 487 // NCB modified 10/9/2001                               process_directory(1,full_name);
 488                                                         process_directory(newObj,full_name);
 489                                                 }
 490                                         }
 491                                 }
 492                                 else
 493                                 {
 494                                         printf(" we don't handle this type\n");
 495                                 }
 496                         }
 497                 }
 498         }
 499
 500         return 0;
 501
 502 }
 503
 504
 505 int main(int argc, char *argv[])
 506 {
 507         struct stat stats;
 508
 509         printf("mkyaffsimage: image building tool for YAFFS built "__DATE__"\n");
 510
 511         if(argc < 3)
 512         {
 513                 printf("usage: mkyaffsimage dir image_file [convert]\n");
 514                 printf("           dir        the directory tree to be converted\n");
 515                 printf("           image_file the output file to hold the image\n");
 516         printf("           'convert'  produce a big-endian image from a little-endian machine\n");
 517                 exit(1);
 518         }
 519
 520     if ((argc == 4) && (!strncmp(argv[3], "convert", strlen("convert"))))
 521     {
 522         convert_endian = 1;
 523     }
 524
 525         if(stat(argv[1],&stats) < 0)
 526         {
 527                 printf("Could not stat %s\n",argv[1]);
 528                 exit(1);
 529         }
 530
 531         if(!S_ISDIR(stats.st_mode))
 532         {
 533                 printf(" %s is not a directory\n",argv[1]);
 534                 exit(1);
 535         }
 536
 537         outFile = open(argv[2],O_CREAT | O_TRUNC | O_WRONLY, S_IREAD | S_IWRITE);
 538
 539
 540         if(outFile < 0)
 541         {
 542                 printf("Could not open output file %s\n",argv[2]);
 543                 exit(1);
 544         }
 545
 546         printf("Processing directory %s into image file %s\n",argv[1],argv[2]);
 547         error =  write_object_header(1, YAFFS_OBJECT_TYPE_DIRECTORY, &stats, 1,"", -1, NULL);
 548         if(error)
 549         error = process_directory(YAFFS_OBJECTID_ROOT,argv[1]);
 550
 551         close(outFile);
 552
 553         if(error < 0)
 554         {
 555                 perror("operation incomplete");
 556                 exit(1);
 557         }
 558         else
 559         {
 560                 printf("Operation complete.\n"
 561                        "%d objects in %d directories\n"
 562                        "%d NAND pages\n",n_obj, nDirectories, nPages);
 563         }
 564
 565         close(outFile);
 566
 567         exit(0);
 568 }
 569