yaffsfs.c: Fix NULL dereference in yaffs_unmount2_reldev()
[yaffs2.git] / utils / mkyaffs2image.c
index ac658b1da26d7a81ec4ce0c14219b1cc99407260..92f3f61b5e370178ce8a84e05c096be32ac213e4 100644 (file)
@@ -1,11 +1,10 @@
 /*
  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
  *
- * Copyright (C) 2002-2007 Aleph One Ltd.
- *   for Toby Churchill Ltd and Brightstar Engineering
+ * Copyright (C) 2002-2018 Aleph One Ltd.
  *
  * Created by Charles Manning <charles@aleph1.co.uk>
- * Nick Bane modifications flagged NCB
+ * Nick Bane modifications flagged NCBw
  * Endian handling patches by James Ng.
  * mkyaffs2image hacks by NCB
  *
  */
 
 /*
- * makeyaffs2image.c 
+ * makeyaffs2image.c
  *
  * Makes a YAFFS2 file system image that can be used to load up a file system.
  * Uses default Linux MTD layout - search for "NAND LAYOUT" to change.
  */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <fcntl.h>
@@ -33,8 +32,8 @@
 #include <assert.h>
 #include "yaffs_ecc.h"
 #include "yaffs_guts.h"
+#include "yaffs_endian.h"
 
-#include "yaffs_tagsvalidity.h"
 #include "yaffs_packedtags2.h"
 
 unsigned yaffs_trace_mask=0;
@@ -46,7 +45,6 @@ unsigned yaffs_trace_mask=0;
 #define spareSize 64
 #define pagesPerBlock 64
 
-const char * mkyaffsimage_c_version = "$Id: mkyaffs2image.c,v 1.5 2010-01-11 21:43:18 charles Exp $";
 
 
 typedef struct
@@ -56,12 +54,13 @@ typedef struct
        int   obj;
 } objItem;
 
+struct yaffs_dev dummy_dev = {.swap_endian = 0};
+
 
 static objItem obj_list[MAX_OBJECTS];
-static int n_obj = 0;
 static int obj_id = YAFFS_NOBJECT_BUCKETS + 1;
 
-static int nObjects, nDirectories, nPages;
+static int n_obj, nDirectories, nPages;
 
 static int outFile;
 
@@ -70,6 +69,20 @@ static int savedErrno;
 
 static int convert_endian = 0;
 
+/* Provide our own endian swap that does nothing. */
+void yaffs_do_endian_packed_tags2(struct yaffs_dev *dev,
+                               struct yaffs_packed_tags2_tags_only *ptt)
+{
+#if 0
+       if (!dev->swap_endian)
+               return;
+       ptt->seq_number = swap_u32(ptt->seq_number);
+       ptt->obj_id = swap_u32(ptt->obj_id);
+       ptt->chunk_id = swap_u32(ptt->chunk_id);
+       ptt->n_bytes = swap_u32(ptt->n_bytes);
+#endif
+}
+
 static void fatal(const char *fn)
 {
        perror(fn);
@@ -88,15 +101,15 @@ static int warn(const char *fn)
 static int obj_compare(const void *a, const void * b)
 {
   objItem *oa, *ob;
-  
+
   oa = (objItem *)a;
   ob = (objItem *)b;
-  
+
   if(oa->dev < ob->dev) return -1;
   if(oa->dev > ob->dev) return 1;
   if(oa->ino < ob->ino) return -1;
   if(oa->ino > ob->ino) return 1;
-  
+
   return 0;
 }
 
@@ -110,7 +123,7 @@ static void add_obj_to_list(dev_t dev, ino_t ino, int obj)
                obj_list[n_obj].obj = obj;
                n_obj++;
                qsort(obj_list,n_obj,sizeof(objItem),obj_compare);
-               
+
        }
        else
        {
@@ -128,7 +141,7 @@ static int find_obj_in_list(dev_t dev, ino_t ino)
 
        test.dev = dev;
        test.ino = ino;
-       
+
        if(n_obj > 0)
        {
                i = bsearch(&test,obj_list,n_obj,sizeof(objItem),obj_compare);
@@ -145,63 +158,63 @@ static int find_obj_in_list(dev_t dev, ino_t ino)
  * NOTE: The tag is not usable after this other than calculating the CRC
  * with.
  */
-static void little_to_big_endian(yaffs_Tags *tagsPtr)
+static void little_to_big_endian(struct yaffs_ext_tags *tagsPtr)
 {
 #if 0 // FIXME NCB
-    yaffs_tags_union_t * tags = (yaffs_tags_union_t* )tagsPtr; // Work in bytes.
-    yaffs_tags_union_t   temp;
+    union yaffs_tags_union * tags = (union yaffs_tags_union* )tagsPtr; // Work in bytes.
+    union yaffs_tags_union   temp;
 
     memset(&temp, 0, sizeof(temp));
     // Ick, I hate magic numbers.
-    temp.asBytes[0] = ((tags->asBytes[2] & 0x0F) << 4) | ((tags->asBytes[1] & 0xF0) >> 4);
-    temp.asBytes[1] = ((tags->asBytes[1] & 0x0F) << 4) | ((tags->asBytes[0] & 0xF0) >> 4);
-    temp.asBytes[2] = ((tags->asBytes[0] & 0x0F) << 4) | ((tags->asBytes[2] & 0x30) >> 2) | ((tags->asBytes[3] & 0xC0) >> 6);
-    temp.asBytes[3] = ((tags->asBytes[3] & 0x3F) << 2) | ((tags->asBytes[2] & 0xC0) >> 6);
-    temp.asBytes[4] = ((tags->asBytes[6] & 0x03) << 6) | ((tags->asBytes[5] & 0xFC) >> 2);
-    temp.asBytes[5] = ((tags->asBytes[5] & 0x03) << 6) | ((tags->asBytes[4] & 0xFC) >> 2);
-    temp.asBytes[6] = ((tags->asBytes[4] & 0x03) << 6) | (tags->asBytes[7] & 0x3F);
-    temp.asBytes[7] = (tags->asBytes[6] & 0xFC) | ((tags->asBytes[7] & 0xC0) >> 6);
+    temp.as_bytes[0] = ((tags->as_bytes[2] & 0x0F) << 4) | ((tags->as_bytes[1] & 0xF0) >> 4);
+    temp.as_bytes[1] = ((tags->as_bytes[1] & 0x0F) << 4) | ((tags->as_bytes[0] & 0xF0) >> 4);
+    temp.as_bytes[2] = ((tags->as_bytes[0] & 0x0F) << 4) | ((tags->as_bytes[2] & 0x30) >> 2) | ((tags->as_bytes[3] & 0xC0) >> 6);
+    temp.as_bytes[3] = ((tags->as_bytes[3] & 0x3F) << 2) | ((tags->as_bytes[2] & 0xC0) >> 6);
+    temp.as_bytes[4] = ((tags->as_bytes[6] & 0x03) << 6) | ((tags->as_bytes[5] & 0xFC) >> 2);
+    temp.as_bytes[5] = ((tags->as_bytes[5] & 0x03) << 6) | ((tags->as_bytes[4] & 0xFC) >> 2);
+    temp.as_bytes[6] = ((tags->as_bytes[4] & 0x03) << 6) | (tags->as_bytes[7] & 0x3F);
+    temp.as_bytes[7] = (tags->as_bytes[6] & 0xFC) | ((tags->as_bytes[7] & 0xC0) >> 6);
 
     // Now copy it back.
-    tags->asBytes[0] = temp.asBytes[0];
-    tags->asBytes[1] = temp.asBytes[1];
-    tags->asBytes[2] = temp.asBytes[2];
-    tags->asBytes[3] = temp.asBytes[3];
-    tags->asBytes[4] = temp.asBytes[4];
-    tags->asBytes[5] = temp.asBytes[5];
-    tags->asBytes[6] = temp.asBytes[6];
-    tags->asBytes[7] = temp.asBytes[7];
+    tags->as_bytes[0] = temp.as_bytes[0];
+    tags->as_bytes[1] = temp.as_bytes[1];
+    tags->as_bytes[2] = temp.as_bytes[2];
+    tags->as_bytes[3] = temp.as_bytes[3];
+    tags->as_bytes[4] = temp.as_bytes[4];
+    tags->as_bytes[5] = temp.as_bytes[5];
+    tags->as_bytes[6] = temp.as_bytes[6];
+    tags->as_bytes[7] = temp.as_bytes[7];
 #endif
 }
 
-static void shuffle_oob(char *spareData, yaffs_PackedTags2 *pt)
+static void shuffle_oob(char *spareData, struct yaffs_packed_tags2 *pt)
 {
        assert(sizeof(*pt) <= spareSize);
        // NAND LAYOUT: For non-trivial OOB orderings, here would be a good place to shuffle.
        memcpy(spareData, pt, sizeof(*pt));
 }
 
-static int write_chunk(__u8 *data, __u32 objId, __u32 chunkId, __u32 nBytes)
+static int write_chunk(u8 *data, u32 id, u32 chunk_id, u32 n_bytes)
 {
-       yaffs_ExtendedTags t;
-       yaffs_PackedTags2 pt;
+       struct yaffs_ext_tags t;
+       struct yaffs_packed_tags2 pt;
        char spareData[spareSize];
 
        if (write(outFile,data,chunkSize) != chunkSize)
                fatal("write");
 
-       yaffs_init_tags(&t);
-       
-       t.chunkId = chunkId;
-//     t.serialNumber = 0;
-       t.serialNumber = 1;     // **CHECK**
-       t.byteCount = nBytes;
-       t.objectId = objId;
-       
-       t.sequenceNumber = YAFFS_LOWEST_SEQUENCE_NUMBER;
+       memset(&t, 0, sizeof(t));
+
+       t.chunk_id = chunk_id;
+//     t.serial_number = 0;
+       t.serial_number = 1;    // **CHECK**
+       t.n_bytes = n_bytes;
+       t.obj_id = id;
+
+       t.seq_number = YAFFS_LOWEST_SEQUENCE_NUMBER;
 
 // added NCB **CHECK**
-       t.chunkUsed = 1;
+       t.chunk_used = 1;
 
        if (convert_endian)
        {
@@ -211,7 +224,7 @@ static int write_chunk(__u8 *data, __u32 objId, __u32 chunkId, __u32 nBytes)
        nPages++;
 
        memset(&pt, 0, sizeof(pt));
-       yaffs_PackTags2(&pt,&t,1);
+       yaffs_pack_tags2(&dummy_dev, &pt,&t,1);
 
        memset(spareData, 0xff, sizeof(spareData));
        shuffle_oob(spareData, &pt);
@@ -228,69 +241,60 @@ static int write_chunk(__u8 *data, __u32 objId, __u32 chunkId, __u32 nBytes)
 
 #define SWAP16(x)   ((((x) & 0x00FF) << 8) | \
                      (((x) & 0xFF00) >> 8))
-        
+
 // This one is easier, since the types are more standard. No funky shifts here.
-static void object_header_little_to_big_endian(yaffs_ObjectHeader* oh)
+static void object_header_little_to_big_endian(struct yaffs_obj_hdr* oh)
 {
-    int i;    
     oh->type = SWAP32(oh->type); // GCC makes enums 32 bits.
-    oh->parentObjectId = SWAP32(oh->parentObjectId); // int
-    oh->sum__NoLongerUsed = SWAP16(oh->sum__NoLongerUsed); // __u16 - Not used, but done for completeness.
+    oh->parent_obj_id = SWAP32(oh->parent_obj_id); // int
+    oh->sum_no_longer_used = SWAP16(oh->sum_no_longer_used); // u16 - Not used, but done for completeness.
     // name = skip. Char array. Not swapped.
     oh->yst_mode = SWAP32(oh->yst_mode);
-#ifdef CONFIG_YAFFS_WINCE // WinCE doesn't implement this, but we need to just in case. 
-    // In fact, WinCE would be *THE* place where this would be an issue.
-    // Why? WINCE is little-endian only.
 
-    {
-        int n = sizeof(oh->notForWinCE)/sizeof(oh->notForWinCE[0]);
-        for(i = 0; i < n; i++)
-            oh->notForWinCE[i] = SWAP32(oh->notForWinCE[i]);
-    }
-#else
     // Regular POSIX.
     oh->yst_uid = SWAP32(oh->yst_uid);
     oh->yst_gid = SWAP32(oh->yst_gid);
     oh->yst_atime = SWAP32(oh->yst_atime);
     oh->yst_mtime = SWAP32(oh->yst_mtime);
     oh->yst_ctime = SWAP32(oh->yst_ctime);
-#endif
 
-    oh->fileSize = SWAP32(oh->fileSize); // Aiee. An int... signed, at that!
-    oh->equivalentObjectId = SWAP32(oh->equivalentObjectId);
+    oh->file_size_low = SWAP32(oh->file_size_low); // Aiee. An int... signed, at that!
+    oh->file_size_high = SWAP32(oh->file_size_high); // Aiee. An int... signed, at that!
+    oh->equiv_id = SWAP32(oh->equiv_id);
     // alias  - char array.
     oh->yst_rdev = SWAP32(oh->yst_rdev);
 
-#ifdef CONFIG_YAFFS_WINCE
     oh->win_ctime[0] = SWAP32(oh->win_ctime[0]);
     oh->win_ctime[1] = SWAP32(oh->win_ctime[1]);
     oh->win_atime[0] = SWAP32(oh->win_atime[0]);
     oh->win_atime[1] = SWAP32(oh->win_atime[1]);
     oh->win_mtime[0] = SWAP32(oh->win_mtime[0]);
     oh->win_mtime[1] = SWAP32(oh->win_mtime[1]);
-#else
 
-    {
-        int n = sizeof(oh->roomToGrow)/sizeof(oh->roomToGrow[0]);
-        for(i=0; i < n; i++)
-            oh->roomToGrow[i] = SWAP32(oh->roomToGrow[i]);
-    }
+    oh->reserved[0] = SWAP32(oh->reserved[0]);
+#if 0
+    oh->reserved[1] = SWAP32(oh->reserved[1]);
 #endif
+    oh->inband_shadowed_obj_id = SWAP32(oh->inband_shadowed_obj_id);
+    oh->inband_is_shrink = SWAP32(oh->inband_is_shrink);
+    oh->shadows_obj = SWAP32(oh->shadows_obj);
+    oh->is_shrink = SWAP32(oh->is_shrink);
 }
 
-static int write_object_header(int objId, yaffs_ObjectType t, struct stat *s, int parent, const char *name, int equivalentObj, const char * alias)
+
+static int write_object_header(int id, enum yaffs_obj_type t, struct stat *s, int parent, const char *name, int equivalentObj, const char * alias)
 {
-       __u8 bytes[chunkSize];
-       
-       
-       yaffs_ObjectHeader *oh = (yaffs_ObjectHeader *)bytes;
-       
+       u8 bytes[chunkSize];
+
+
+       struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)bytes;
+
        memset(bytes,0xff,sizeof(bytes));
-       
+
        oh->type = t;
 
-       oh->parentObjectId = parent;
-       
+       oh->parent_obj_id = parent;
+
        if (strlen(name)+1 > sizeof(oh->name))
        {
                errno = ENAMETOOLONG;
@@ -298,8 +302,8 @@ static int write_object_header(int objId, yaffs_ObjectType t, struct stat *s, in
        }
        memset(oh->name,0,sizeof(oh->name));
        strcpy(oh->name,name);
-       
-       
+
+
        if(t != YAFFS_OBJECT_TYPE_HARDLINK)
        {
                oh->yst_mode = s->st_mode;
@@ -311,17 +315,18 @@ static int write_object_header(int objId, yaffs_ObjectType t, struct stat *s, in
                oh->yst_ctime = s->st_ctime;
                oh->yst_rdev  = s->st_rdev;
        }
-       
+
        if(t == YAFFS_OBJECT_TYPE_FILE)
        {
-               oh->fileSize = s->st_size;
+               oh->file_size_low = s->st_size;
+               oh->file_size_high = (s->st_size >> 32);
        }
-       
+
        if(t == YAFFS_OBJECT_TYPE_HARDLINK)
        {
-               oh->equivalentObjectId = equivalentObj;
+               oh->equiv_id = equivalentObj;
        }
-       
+
        if(t == YAFFS_OBJECT_TYPE_SYMLINK)
        {
                if (strlen(alias)+1 > sizeof(oh->alias))
@@ -337,14 +342,14 @@ static int write_object_header(int objId, yaffs_ObjectType t, struct stat *s, in
        {
                object_header_little_to_big_endian(oh);
        }
-       
-       return write_chunk(bytes,objId,0,0xffff);
-       
+
+       return write_chunk(bytes,id,0,0xffff);
+
 }
 
-static void pad_image()
+static void pad_image(void)
 {
-       __u8 data[chunkSize + spareSize];
+       u8 data[chunkSize + spareSize];
        int padPages = (nPages % pagesPerBlock);
 
        if (padPages)
@@ -365,7 +370,7 @@ static int process_directory(int parent, const char *path)
        struct dirent *entry;
 
        nDirectories++;
-       
+
        dir = opendir(path);
        if(!dir)
        {
@@ -375,7 +380,7 @@ static int process_directory(int parent, const char *path)
        {
                while((entry = readdir(dir)) != NULL)
                {
-               
+
                        /* Ignore . and .. */
                        if(strcmp(entry->d_name,".") &&
                           strcmp(entry->d_name,".."))
@@ -384,19 +389,19 @@ static int process_directory(int parent, const char *path)
                                struct stat stats;
                                int equivalentObj;
                                int newObj;
-                               
+
                                if (snprintf(full_name,sizeof(full_name),"%s/%s",path,entry->d_name) >= (int)sizeof(full_name))
                                {
                                        error = -1;
                                        continue;
                                }
-                               
+
                                if (lstat(full_name,&stats) < 0)
                                {
                                        warn("lstat");
                                        continue;
                                }
-                               
+
                                if(S_ISLNK(stats.st_mode) ||
                                    S_ISREG(stats.st_mode) ||
                                    S_ISDIR(stats.st_mode) ||
@@ -405,12 +410,12 @@ static int process_directory(int parent, const char *path)
                                    S_ISCHR(stats.st_mode) ||
                                    S_ISSOCK(stats.st_mode))
                                {
-                               
+
                                        newObj = obj_id++;
-                                       nObjects++;
-                                       
+                                       n_obj++;
+
                                        printf("Object %d, %s is a ",newObj,full_name);
-                                       
+
                                        /* We're going to create an object for it */
                                        if((equivalentObj = find_obj_in_list(stats.st_dev, stats.st_ino)) > 0)
                                        {
@@ -418,18 +423,18 @@ static int process_directory(int parent, const char *path)
                                                printf("hard link to object %d\n",equivalentObj);
                                                write_object_header(newObj, YAFFS_OBJECT_TYPE_HARDLINK, &stats, parent, entry->d_name, equivalentObj, NULL);
                                        }
-                                       else 
+                                       else
                                        {
-                                               
+
                                                add_obj_to_list(stats.st_dev,stats.st_ino,newObj);
-                                               
+
                                                if(S_ISLNK(stats.st_mode))
                                                {
-                                       
+
                                                        char symname[500];
-                                               
+
                                                        memset(symname,0, sizeof(symname));
-                                       
+
                                                        if (readlink(full_name,symname,sizeof(symname) -1) < 0)
                                                        {
                                                                warn("readlink");
@@ -446,23 +451,23 @@ static int process_directory(int parent, const char *path)
                                                        if(write_object_header(newObj, YAFFS_OBJECT_TYPE_FILE, &stats, parent, entry->d_name, -1, NULL) == 0)
                                                        {
                                                                int h;
-                                                               __u8 bytes[chunkSize];
-                                                               int nBytes;
+                                                               u8 bytes[chunkSize];
+                                                               int n_bytes;
                                                                int chunk = 0;
-                                                               
+
                                                                h = open(full_name,O_RDONLY);
                                                                if(h >= 0)
                                                                {
                                                                        memset(bytes,0xff,sizeof(bytes));
-                                                                       while((nBytes = read(h,bytes,sizeof(bytes))) > 0)
+                                                                       while((n_bytes = read(h,bytes,sizeof(bytes))) > 0)
                                                                        {
                                                                                chunk++;
-                                                                               write_chunk(bytes,newObj,chunk,nBytes);
+                                                                               write_chunk(bytes,newObj,chunk,n_bytes);
                                                                                memset(bytes,0xff,sizeof(bytes));
                                                                        }
-                                                                       if(nBytes < 0) 
+                                                                       if(n_bytes < 0)
                                                                           warn("read");
-                                                                          
+
                                                                        printf("%d data chunks written\n",chunk);
                                                                        close(h);
                                                                }
@@ -470,9 +475,9 @@ static int process_directory(int parent, const char *path)
                                                                {
                                                                        warn("open");
                                                                }
-                                                               
-                                                       }                                                       
-                                                                                                               
+
+                                                       }
+
                                                }
                                                else if(S_ISSOCK(stats.st_mode))
                                                {
@@ -512,7 +517,7 @@ static int process_directory(int parent, const char *path)
                }
                closedir(dir);
        }
-       
+
        return 0;
 
 }
@@ -521,9 +526,9 @@ static int process_directory(int parent, const char *path)
 int main(int argc, char *argv[])
 {
        struct stat stats;
-       
+
        printf("mkyaffs2image: image building tool for YAFFS2 built "__DATE__"\n");
-       
+
        if(argc < 3)
        {
                printf("usage: mkyaffs2image dir image_file [convert]\n");
@@ -537,35 +542,35 @@ int main(int argc, char *argv[])
     {
         convert_endian = 1;
     }
-    
+
        if(stat(argv[1],&stats) < 0)
        {
                printf("Could not stat %s\n",argv[1]);
                exit(1);
        }
-       
+
        if(!S_ISDIR(stats.st_mode))
        {
                printf(" %s is not a directory\n",argv[1]);
                exit(1);
        }
-       
+
        outFile = open(argv[2],O_CREAT | O_TRUNC | O_WRONLY, S_IREAD | S_IWRITE);
-       
-       
+
+
        if(outFile < 0)
        {
                printf("Could not open output file %s\n",argv[2]);
                exit(1);
        }
-       
+
        printf("Processing directory %s into image file %s\n",argv[1],argv[2]);
        process_directory(YAFFS_OBJECTID_ROOT,argv[1]);
-       
+
        pad_image();
 
        close(outFile);
-       
+
        if(error)
        {
                errno = savedErrno;
@@ -575,9 +580,9 @@ int main(int argc, char *argv[])
        {
                printf("Operation complete.\n"
                       "%d objects in %d directories\n"
-                      "%d NAND pages\n",nObjects, nDirectories, nPages);
+                      "%d NAND pages\n",n_obj, nDirectories, nPages);
        }
-       
+
        exit(error);
-}      
+}