Patch by Klaus Heydeck, 12 May 2004:
[platform/kernel/u-boot.git] / fs / jffs2 / jffs2_1pass.c
1 /*
2 -------------------------------------------------------------------------
3  * Filename:      jffs2.c
4  * Version:       $Id: jffs2_1pass.c,v 1.7 2002/01/25 01:56:47 nyet Exp $
5  * Copyright:     Copyright (C) 2001, Russ Dill
6  * Author:        Russ Dill <Russ.Dill@asu.edu>
7  * Description:   Module to load kernel from jffs2
8  *-----------------------------------------------------------------------*/
9 /*
10  * some portions of this code are taken from jffs2, and as such, the
11  * following copyright notice is included.
12  *
13  * JFFS2 -- Journalling Flash File System, Version 2.
14  *
15  * Copyright (C) 2001 Red Hat, Inc.
16  *
17  * Created by David Woodhouse <dwmw2@cambridge.redhat.com>
18  *
19  * The original JFFS, from which the design for JFFS2 was derived,
20  * was designed and implemented by Axis Communications AB.
21  *
22  * The contents of this file are subject to the Red Hat eCos Public
23  * License Version 1.1 (the "Licence"); you may not use this file
24  * except in compliance with the Licence.  You may obtain a copy of
25  * the Licence at http://www.redhat.com/
26  *
27  * Software distributed under the Licence is distributed on an "AS IS"
28  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
29  * See the Licence for the specific language governing rights and
30  * limitations under the Licence.
31  *
32  * The Original Code is JFFS2 - Journalling Flash File System, version 2
33  *
34  * Alternatively, the contents of this file may be used under the
35  * terms of the GNU General Public License version 2 (the "GPL"), in
36  * which case the provisions of the GPL are applicable instead of the
37  * above.  If you wish to allow the use of your version of this file
38  * only under the terms of the GPL and not to allow others to use your
39  * version of this file under the RHEPL, indicate your decision by
40  * deleting the provisions above and replace them with the notice and
41  * other provisions required by the GPL.  If you do not delete the
42  * provisions above, a recipient may use your version of this file
43  * under either the RHEPL or the GPL.
44  *
45  * $Id: jffs2_1pass.c,v 1.7 2002/01/25 01:56:47 nyet Exp $
46  *
47  */
48
49 /* Ok, so anyone who knows the jffs2 code will probably want to get a papar
50  * bag to throw up into before reading this code. I looked through the jffs2
51  * code, the caching scheme is very elegant. I tried to keep the version
52  * for a bootloader as small and simple as possible. Instead of worring about
53  * unneccesary data copies, node scans, etc, I just optimized for the known
54  * common case, a kernel, which looks like:
55  *      (1) most pages are 4096 bytes
56  *      (2) version numbers are somewhat sorted in acsending order
57  *      (3) multiple compressed blocks making up one page is uncommon
58  *
59  * So I create a linked list of decending version numbers (insertions at the
60  * head), and then for each page, walk down the list, until a matching page
61  * with 4096 bytes is found, and then decompress the watching pages in
62  * reverse order.
63  *
64  */
65
66 /*
67  * Adapted by Nye Liu <nyet@zumanetworks.com> and
68  * Rex Feany <rfeany@zumanetworks.com>
69  * on Jan/2002 for U-Boot.
70  *
71  * Clipped out all the non-1pass functions, cleaned up warnings,
72  * wrappers, etc. No major changes to the code.
73  * Please, he really means it when he said have a paper bag
74  * handy. We needed it ;).
75  *
76  */
77
78 /*
79  * Bugfixing by Kai-Uwe Bloem <kai-uwe.bloem@auerswald.de>, (C) Mar/2003
80  *
81  * - overhaul of the memory management. Removed much of the "paper-bagging"
82  *   in that part of the code, fixed several bugs, now frees memory when
83  *   partition is changed.
84  *   It's still ugly :-(
85  * - fixed a bug in jffs2_1pass_read_inode where the file length calculation
86  *   was incorrect. Removed a bit of the paper-bagging as well.
87  * - removed double crc calculation for fragment headers in jffs2_private.h
88  *   for speedup.
89  * - scan_empty rewritten in a more "standard" manner (non-paperbag, that is).
90  * - spinning wheel now spins depending on how much memory has been scanned
91  * - lots of small changes all over the place to "improve" readability.
92  * - implemented fragment sorting to ensure that the newest data is copied
93  *   if there are multiple copies of fragments for a certain file offset.
94  *
95  * The fragment sorting feature must be enabled by CFG_JFFS2_SORT_FRAGMENTS.
96  * Sorting is done while adding fragments to the lists, which is more or less a
97  * bubble sort. This takes a lot of time, and is most probably not an issue if
98  * the boot filesystem is always mounted readonly.
99  *
100  * You should define it if the boot filesystem is mounted writable, and updates
101  * to the boot files are done by copying files to that filesystem.
102  *
103  *
104  * There's a big issue left: endianess is completely ignored in this code. Duh!
105  *
106  *
107  * You still should have paper bags at hand :-(. The code lacks more or less
108  * any comment, and is still arcane and difficult to read in places. As this
109  * might be incompatible with any new code from the jffs2 maintainers anyway,
110  * it should probably be dumped and replaced by something like jffs2reader!
111  */
112
113
114 #include <common.h>
115 #include <config.h>
116 #include <malloc.h>
117 #include <linux/stat.h>
118 #include <linux/time.h>
119
120 #if (CONFIG_COMMANDS & CFG_CMD_JFFS2)
121
122 #include <jffs2/jffs2.h>
123 #include <jffs2/jffs2_1pass.h>
124
125 #include "jffs2_private.h"
126
127
128 #define NODE_CHUNK      1024    /* size of memory allocation chunk in b_nodes */
129 #define SPIN_BLKSIZE    18      /* spin after having scanned 1<<BLKSIZE bytes */
130
131 /* Debugging switches */
132 #undef  DEBUG_DIRENTS           /* print directory entry list after scan */
133 #undef  DEBUG_FRAGMENTS         /* print fragment list after scan */
134 #undef  DEBUG                           /* enable debugging messages */
135
136
137 #ifdef  DEBUG
138 # define DEBUGF(fmt,args...)    printf(fmt ,##args)
139 #else
140 # define DEBUGF(fmt,args...)
141 #endif
142
143 #if defined(CONFIG_JFFS2_NAND) && (CONFIG_COMMANDS & CFG_CMD_NAND)
144
145 /*
146  * Support for jffs2 on top of NAND-flash
147  *
148  * NAND memory isn't mapped in processor's address space,
149  * so data should be fetched from flash before
150  * being processed. This is exactly what functions declared
151  * here do.
152  *
153  */
154
155 /* this one defined in cmd_nand.c */
156 int read_jffs2_nand(size_t start, size_t len,
157                     size_t * retlen, u_char * buf, int nanddev);
158
159 #define NAND_PAGE_SIZE 512
160 #define NAND_PAGE_SHIFT 9
161 #define NAND_PAGE_MASK (~(NAND_PAGE_SIZE-1))
162
163 #ifndef NAND_CACHE_PAGES
164 #define NAND_CACHE_PAGES 16
165 #endif
166 #define NAND_CACHE_SIZE (NAND_CACHE_PAGES*NAND_PAGE_SIZE)
167
168 static u8* nand_cache = NULL;
169 static u32 nand_cache_off = (u32)-1;
170 static int nanddev = 0; /* nand device of current partition */
171
172 static int read_nand_cached(u32 off, u32 size, u_char *buf)
173 {
174         u32 bytes_read = 0;
175         size_t retlen;
176         int cpy_bytes;
177
178         while (bytes_read < size) {
179                 if ((off + bytes_read < nand_cache_off) ||
180                     (off + bytes_read >= nand_cache_off+NAND_CACHE_SIZE)) {
181                         nand_cache_off = (off + bytes_read) & NAND_PAGE_MASK;
182                         if (!nand_cache) {
183                                 /* This memory never gets freed but 'cause
184                                    it's a bootloader, nobody cares */
185                                 nand_cache = malloc(NAND_CACHE_SIZE);
186                                 if (!nand_cache) {
187                                         printf("read_nand_cached: can't alloc cache size %d bytes\n",
188                                                NAND_CACHE_SIZE);
189                                         return -1;
190                                 }
191                         }
192                         if (read_jffs2_nand(nand_cache_off, NAND_CACHE_SIZE,
193                                             &retlen, nand_cache, nanddev) < 0 ||
194                             retlen != NAND_CACHE_SIZE) {
195                                 printf("read_nand_cached: error reading nand off %#x size %d bytes\n",
196                                        nand_cache_off, NAND_CACHE_SIZE);
197                                 return -1;
198                         }
199                 }
200                 cpy_bytes = nand_cache_off + NAND_CACHE_SIZE - (off + bytes_read);
201                 if (cpy_bytes > size - bytes_read)
202                         cpy_bytes = size - bytes_read;
203                 memcpy(buf + bytes_read,
204                        nand_cache + off + bytes_read - nand_cache_off,
205                        cpy_bytes);
206                 bytes_read += cpy_bytes;
207         }
208         return bytes_read;
209 }
210
211 static void *get_fl_mem(u32 off, u32 size, void *ext_buf)
212 {
213         u_char *buf = ext_buf ? (u_char*)ext_buf : (u_char*)malloc(size);
214
215         if (NULL == buf) {
216                 printf("get_fl_mem: can't alloc %d bytes\n", size);
217                 return NULL;
218         }
219         if (read_nand_cached(off, size, buf) < 0) {
220                 if (!ext_buf)
221                         free(buf);
222                 return NULL;
223         }
224
225         return buf;
226 }
227
228 static void *get_node_mem(u32 off)
229 {
230         struct jffs2_unknown_node node;
231         void *ret = NULL;
232
233         if (NULL == get_fl_mem(off, sizeof(node), &node))
234                 return NULL;
235
236         if (!(ret = get_fl_mem(off, node.magic ==
237                                JFFS2_MAGIC_BITMASK ? node.totlen : sizeof(node),
238                                NULL))) {
239                 printf("off = %#x magic %#x type %#x node.totlen = %d\n",
240                        off, node.magic, node.nodetype, node.totlen);
241         }
242         return ret;
243 }
244
245 static void put_fl_mem(void *buf)
246 {
247         free(buf);
248 }
249
250 #else /* defined(CONFIG_JFFS2_NAND) && (CONFIG_COMMANDS & CFG_CMD_NAND) */
251
252 static inline void *get_fl_mem(u32 off, u32 size, void *ext_buf)
253 {
254         return (void*)off;
255 }
256
257 static inline void *get_node_mem(u32 off)
258 {
259         return (void*)off;
260 }
261
262 static inline void put_fl_mem(void *buf)
263 {
264 }
265
266 #endif /* defined(CONFIG_JFFS2_NAND) && (CONFIG_COMMANDS & CFG_CMD_NAND) */
267
268
269 /* Compression names */
270 static char *compr_names[] = {
271         "NONE",
272         "ZERO",
273         "RTIME",
274         "RUBINMIPS",
275         "COPY",
276         "DYNRUBIN",
277         "ZLIB"
278 };
279
280 /* Spinning wheel */
281 static char spinner[] = { '|', '/', '-', '\\' };
282
283 /* Memory management */
284 struct mem_block {
285         u32     index;
286         struct mem_block *next;
287         struct b_node nodes[NODE_CHUNK];
288 };
289
290
291 static void
292 free_nodes(struct b_list *list)
293 {
294         while (list->listMemBase != NULL) {
295                 struct mem_block *next = list->listMemBase->next;
296                 free( list->listMemBase );
297                 list->listMemBase = next;
298         }
299 }
300
301 static struct b_node *
302 add_node(struct b_list *list)
303 {
304         u32 index = 0;
305         struct mem_block *memBase;
306         struct b_node *b;
307
308         memBase = list->listMemBase;
309         if (memBase != NULL)
310                 index = memBase->index;
311 #if 0
312         putLabeledWord("add_node: index = ", index);
313         putLabeledWord("add_node: memBase = ", list->listMemBase);
314 #endif
315
316         if (memBase == NULL || index >= NODE_CHUNK) {
317                 /* we need more space before we continue */
318                 memBase = mmalloc(sizeof(struct mem_block));
319                 if (memBase == NULL) {
320                         putstr("add_node: malloc failed\n");
321                         return NULL;
322                 }
323                 memBase->next = list->listMemBase;
324                 index = 0;
325 #if 0
326                 putLabeledWord("add_node: alloced a new membase at ", *memBase);
327 #endif
328
329         }
330         /* now we have room to add it. */
331         b = &memBase->nodes[index];
332         index ++;
333
334         memBase->index = index;
335         list->listMemBase = memBase;
336         list->listCount++;
337         return b;
338 }
339
340 static struct b_node *
341 insert_node(struct b_list *list, u32 offset)
342 {
343         struct b_node *new;
344 #ifdef CFG_JFFS2_SORT_FRAGMENTS
345         struct b_node *b, *prev;
346 #endif
347
348         if (!(new = add_node(list))) {
349                 putstr("add_node failed!\r\n");
350                 return NULL;
351         }
352         new->offset = offset;
353
354 #ifdef CFG_JFFS2_SORT_FRAGMENTS
355         if (list->listTail != NULL && list->listCompare(new, list->listTail))
356                 prev = list->listTail;
357         else if (list->listLast != NULL && list->listCompare(new, list->listLast))
358                 prev = list->listLast;
359         else
360                 prev = NULL;
361
362         for (b = (prev ? prev->next : list->listHead);
363              b != NULL && list->listCompare(new, b);
364              prev = b, b = b->next) {
365                 list->listLoops++;
366         }
367         if (b != NULL)
368                 list->listLast = prev;
369
370         if (b != NULL) {
371                 new->next = b;
372                 if (prev != NULL)
373                         prev->next = new;
374                 else
375                         list->listHead = new;
376         } else
377 #endif
378         {
379                 new->next = (struct b_node *) NULL;
380                 if (list->listTail != NULL) {
381                         list->listTail->next = new;
382                         list->listTail = new;
383                 } else {
384                         list->listTail = list->listHead = new;
385                 }
386         }
387
388         return new;
389 }
390
391 #ifdef CFG_JFFS2_SORT_FRAGMENTS
392 /* Sort data entries with the latest version last, so that if there
393  * is overlapping data the latest version will be used.
394  */
395 static int compare_inodes(struct b_node *new, struct b_node *old)
396 {
397         struct jffs2_raw_inode ojNew;
398         struct jffs2_raw_inode ojOld;
399         struct jffs2_raw_inode *jNew =
400                 (struct jffs2_raw_inode *)get_fl_mem(new->offset, sizeof(ojNew), &ojNew);
401         struct jffs2_raw_inode *jOld =
402                 (struct jffs2_raw_inode *)get_fl_mem(old->offset, sizeof(ojOld), &ojOld);
403
404         return jNew->version > jOld->version;
405 }
406
407 /* Sort directory entries so all entries in the same directory
408  * with the same name are grouped together, with the latest version
409  * last. This makes it easy to eliminate all but the latest version
410  * by marking the previous version dead by setting the inode to 0.
411  */
412 static int compare_dirents(struct b_node *new, struct b_node *old)
413 {
414         struct jffs2_raw_dirent ojNew;
415         struct jffs2_raw_dirent ojOld;
416         struct jffs2_raw_dirent *jNew =
417                 (struct jffs2_raw_dirent *)get_fl_mem(new->offset, sizeof(ojNew), &ojNew);
418         struct jffs2_raw_dirent *jOld =
419                 (struct jffs2_raw_dirent *)get_fl_mem(old->offset, sizeof(ojOld), &ojOld);
420         int cmp;
421
422         /* ascending sort by pino */
423         if (jNew->pino != jOld->pino)
424                 return jNew->pino > jOld->pino;
425
426         /* pino is the same, so use ascending sort by nsize, so
427          * we don't do strncmp unless we really must.
428          */
429         if (jNew->nsize != jOld->nsize)
430                 return jNew->nsize > jOld->nsize;
431
432         /* length is also the same, so use ascending sort by name
433          */
434         cmp = strncmp(jNew->name, jOld->name, jNew->nsize);
435         if (cmp != 0)
436                 return cmp > 0;
437
438         /* we have duplicate names in this directory, so use ascending
439          * sort by version
440          */
441         if (jNew->version > jOld->version) {
442                 /* since jNew is newer, we know jOld is not valid, so
443                  * mark it with inode 0 and it will not be used
444                  */
445                 jOld->ino = 0;
446                 return 1;
447         }
448
449         return 0;
450 }
451 #endif
452
453 static u32
454 jffs2_scan_empty(u32 start_offset, struct part_info *part)
455 {
456         char *max = part->offset + part->size - sizeof(struct jffs2_raw_inode);
457         char *offset = part->offset + start_offset;
458         u32 off;
459
460         while (offset < max &&
461                *(u32*)get_fl_mem((u32)offset, sizeof(u32), &off) == 0xFFFFFFFF) {
462                 offset += sizeof(u32);
463                 /* return if spinning is due */
464                 if (((u32)offset & ((1 << SPIN_BLKSIZE)-1)) == 0) break;
465         }
466
467         return offset - part->offset;
468 }
469
470 static u32
471 jffs_init_1pass_list(struct part_info *part)
472 {
473         struct b_lists *pL;
474
475         if (part->jffs2_priv != NULL) {
476                 pL = (struct b_lists *)part->jffs2_priv;
477                 free_nodes(&pL->frag);
478                 free_nodes(&pL->dir);
479                 free(pL);
480         }
481         if (NULL != (part->jffs2_priv = malloc(sizeof(struct b_lists)))) {
482                 pL = (struct b_lists *)part->jffs2_priv;
483
484                 memset(pL, 0, sizeof(*pL));
485 #ifdef CFG_JFFS2_SORT_FRAGMENTS
486                 pL->dir.listCompare = compare_dirents;
487                 pL->frag.listCompare = compare_inodes;
488 #endif
489         }
490         return 0;
491 }
492
493 /* find the inode from the slashless name given a parent */
494 static long
495 jffs2_1pass_read_inode(struct b_lists *pL, u32 inode, char *dest)
496 {
497         struct b_node *b;
498         struct jffs2_raw_inode *jNode;
499         u32 totalSize = 0;
500         u32 latestVersion = 0;
501         char *lDest;
502         char *src;
503         long ret;
504         int i;
505         u32 counter = 0;
506 #ifdef CFG_JFFS2_SORT_FRAGMENTS
507         /* Find file size before loading any data, so fragments that
508          * start past the end of file can be ignored. A fragment
509          * that is partially in the file is loaded, so extra data may
510          * be loaded up to the next 4K boundary above the file size.
511          * This shouldn't cause trouble when loading kernel images, so
512          * we will live with it.
513          */
514         for (b = pL->frag.listHead; b != NULL; b = b->next) {
515                 jNode = (struct jffs2_raw_inode *) get_fl_mem(b->offset,
516                         sizeof(struct jffs2_raw_inode), NULL);
517                 if ((inode == jNode->ino)) {
518                         /* get actual file length from the newest node */
519                         if (jNode->version >= latestVersion) {
520                                 totalSize = jNode->isize;
521                                 latestVersion = jNode->version;
522                         }
523                 }
524                 put_fl_mem(jNode);
525         }
526 #endif
527
528         for (b = pL->frag.listHead; b != NULL; b = b->next) {
529                 jNode = (struct jffs2_raw_inode *) get_node_mem(b->offset);
530                 if ((inode == jNode->ino)) {
531 #if 0
532                         putLabeledWord("\r\n\r\nread_inode: totlen = ", jNode->totlen);
533                         putLabeledWord("read_inode: inode = ", jNode->ino);
534                         putLabeledWord("read_inode: version = ", jNode->version);
535                         putLabeledWord("read_inode: isize = ", jNode->isize);
536                         putLabeledWord("read_inode: offset = ", jNode->offset);
537                         putLabeledWord("read_inode: csize = ", jNode->csize);
538                         putLabeledWord("read_inode: dsize = ", jNode->dsize);
539                         putLabeledWord("read_inode: compr = ", jNode->compr);
540                         putLabeledWord("read_inode: usercompr = ", jNode->usercompr);
541                         putLabeledWord("read_inode: flags = ", jNode->flags);
542 #endif
543
544 #ifndef CFG_JFFS2_SORT_FRAGMENTS
545                         /* get actual file length from the newest node */
546                         if (jNode->version >= latestVersion) {
547                                 totalSize = jNode->isize;
548                                 latestVersion = jNode->version;
549                         }
550 #endif
551
552                         if(dest) {
553                                 src = ((char *) jNode) + sizeof(struct jffs2_raw_inode);
554                                 /* ignore data behind latest known EOF */
555                                 if (jNode->offset > totalSize) {
556                                         put_fl_mem(jNode);
557                                         continue;
558                                 }
559
560                                 lDest = (char *) (dest + jNode->offset);
561 #if 0
562                                 putLabeledWord("read_inode: src = ", src);
563                                 putLabeledWord("read_inode: dest = ", lDest);
564 #endif
565                                 switch (jNode->compr) {
566                                 case JFFS2_COMPR_NONE:
567                                         ret = (unsigned long) ldr_memcpy(lDest, src, jNode->dsize);
568                                         break;
569                                 case JFFS2_COMPR_ZERO:
570                                         ret = 0;
571                                         for (i = 0; i < jNode->dsize; i++)
572                                                 *(lDest++) = 0;
573                                         break;
574                                 case JFFS2_COMPR_RTIME:
575                                         ret = 0;
576                                         rtime_decompress(src, lDest, jNode->csize, jNode->dsize);
577                                         break;
578                                 case JFFS2_COMPR_DYNRUBIN:
579                                         /* this is slow but it works */
580                                         ret = 0;
581                                         dynrubin_decompress(src, lDest, jNode->csize, jNode->dsize);
582                                         break;
583                                 case JFFS2_COMPR_ZLIB:
584                                         ret = zlib_decompress(src, lDest, jNode->csize, jNode->dsize);
585                                         break;
586                                 default:
587                                         /* unknown */
588                                         putLabeledWord("UNKOWN COMPRESSION METHOD = ", jNode->compr);
589                                         put_fl_mem(jNode);
590                                         return -1;
591                                         break;
592                                 }
593                         }
594
595 #if 0
596                         putLabeledWord("read_inode: totalSize = ", totalSize);
597                         putLabeledWord("read_inode: compr ret = ", ret);
598 #endif
599                 }
600                 counter++;
601                 put_fl_mem(jNode);
602         }
603
604 #if 0
605         putLabeledWord("read_inode: returning = ", totalSize);
606 #endif
607         return totalSize;
608 }
609
610 /* find the inode from the slashless name given a parent */
611 static u32
612 jffs2_1pass_find_inode(struct b_lists * pL, const char *name, u32 pino)
613 {
614         struct b_node *b;
615         struct jffs2_raw_dirent *jDir;
616         int len;
617         u32 counter;
618         u32 version = 0;
619         u32 inode = 0;
620
621         /* name is assumed slash free */
622         len = strlen(name);
623
624         counter = 0;
625         /* we need to search all and return the inode with the highest version */
626         for(b = pL->dir.listHead; b; b = b->next, counter++) {
627                 jDir = (struct jffs2_raw_dirent *) get_node_mem(b->offset);
628                 if ((pino == jDir->pino) && (len == jDir->nsize) &&
629                     (jDir->ino) &&      /* 0 for unlink */
630                     (!strncmp(jDir->name, name, len))) {        /* a match */
631                         if (jDir->version < version) {
632                                 put_fl_mem(jDir);
633                                 continue;
634                         }
635
636                         if (jDir->version == version && inode != 0) {
637                                 /* I'm pretty sure this isn't legal */
638                                 putstr(" ** ERROR ** ");
639                                 putnstr(jDir->name, jDir->nsize);
640                                 putLabeledWord(" has dup version =", version);
641                         }
642                         inode = jDir->ino;
643                         version = jDir->version;
644                 }
645 #if 0
646                 putstr("\r\nfind_inode:p&l ->");
647                 putnstr(jDir->name, jDir->nsize);
648                 putstr("\r\n");
649                 putLabeledWord("pino = ", jDir->pino);
650                 putLabeledWord("nsize = ", jDir->nsize);
651                 putLabeledWord("b = ", (u32) b);
652                 putLabeledWord("counter = ", counter);
653 #endif
654                 put_fl_mem(jDir);
655         }
656         return inode;
657 }
658
659 char *mkmodestr(unsigned long mode, char *str)
660 {
661         static const char *l = "xwr";
662         int mask = 1, i;
663         char c;
664
665         switch (mode & S_IFMT) {
666                 case S_IFDIR:    str[0] = 'd'; break;
667                 case S_IFBLK:    str[0] = 'b'; break;
668                 case S_IFCHR:    str[0] = 'c'; break;
669                 case S_IFIFO:    str[0] = 'f'; break;
670                 case S_IFLNK:    str[0] = 'l'; break;
671                 case S_IFSOCK:   str[0] = 's'; break;
672                 case S_IFREG:    str[0] = '-'; break;
673                 default:         str[0] = '?';
674         }
675
676         for(i = 0; i < 9; i++) {
677                 c = l[i%3];
678                 str[9-i] = (mode & mask)?c:'-';
679                 mask = mask<<1;
680         }
681
682         if(mode & S_ISUID) str[3] = (mode & S_IXUSR)?'s':'S';
683         if(mode & S_ISGID) str[6] = (mode & S_IXGRP)?'s':'S';
684         if(mode & S_ISVTX) str[9] = (mode & S_IXOTH)?'t':'T';
685         str[10] = '\0';
686         return str;
687 }
688
689 static inline void dump_stat(struct stat *st, const char *name)
690 {
691         char str[20];
692         char s[64], *p;
693
694         if (st->st_mtime == (time_t)(-1)) /* some ctimes really hate -1 */
695                 st->st_mtime = 1;
696
697         ctime_r(&st->st_mtime, s/*,64*/); /* newlib ctime doesn't have buflen */
698
699         if ((p = strchr(s,'\n')) != NULL) *p = '\0';
700         if ((p = strchr(s,'\r')) != NULL) *p = '\0';
701
702 /*
703         printf("%6lo %s %8ld %s %s\n", st->st_mode, mkmodestr(st->st_mode, str),
704                 st->st_size, s, name);
705 */
706
707         printf(" %s %8ld %s %s", mkmodestr(st->st_mode,str), st->st_size, s, name);
708 }
709
710 static inline u32 dump_inode(struct b_lists * pL, struct jffs2_raw_dirent *d, struct jffs2_raw_inode *i)
711 {
712         char fname[256];
713         struct stat st;
714
715         if(!d || !i) return -1;
716
717         strncpy(fname, d->name, d->nsize);
718         fname[d->nsize] = '\0';
719
720         memset(&st,0,sizeof(st));
721
722         st.st_mtime = i->mtime;
723         st.st_mode = i->mode;
724         st.st_ino = i->ino;
725
726         /* neither dsize nor isize help us.. do it the long way */
727         st.st_size = jffs2_1pass_read_inode(pL, i->ino, NULL);
728
729         dump_stat(&st, fname);
730
731         if (d->type == DT_LNK) {
732                 unsigned char *src = (unsigned char *) (&i[1]);
733                 putstr(" -> ");
734                 putnstr(src, (int)i->dsize);
735         }
736
737         putstr("\r\n");
738
739         return 0;
740 }
741
742 /* list inodes with the given pino */
743 static u32
744 jffs2_1pass_list_inodes(struct b_lists * pL, u32 pino)
745 {
746         struct b_node *b;
747         struct jffs2_raw_dirent *jDir;
748
749         for (b = pL->dir.listHead; b; b = b->next) {
750                 jDir = (struct jffs2_raw_dirent *) get_node_mem(b->offset);
751                 if ((pino == jDir->pino) && (jDir->ino)) { /* ino=0 -> unlink */
752                         u32 i_version = 0;
753                         struct jffs2_raw_inode ojNode;
754                         struct jffs2_raw_inode *jNode, *i = NULL;
755                         struct b_node *b2 = pL->frag.listHead;
756
757                         while (b2) {
758                                 jNode = (struct jffs2_raw_inode *)
759                                         get_fl_mem(b2->offset, sizeof(ojNode), &ojNode);
760                                 if (jNode->ino == jDir->ino && jNode->version >= i_version) {
761                                         if (i)
762                                                 put_fl_mem(i);
763                                         i = get_fl_mem(b2->offset, sizeof(*i), NULL);
764                                 }
765                                 b2 = b2->next;
766                         }
767
768                         dump_inode(pL, jDir, i);
769                         put_fl_mem(i);
770                 }
771                 put_fl_mem(jDir);
772         }
773         return pino;
774 }
775
776 static u32
777 jffs2_1pass_search_inode(struct b_lists * pL, const char *fname, u32 pino)
778 {
779         int i;
780         char tmp[256];
781         char working_tmp[256];
782         char *c;
783
784         /* discard any leading slash */
785         i = 0;
786         while (fname[i] == '/')
787                 i++;
788         strcpy(tmp, &fname[i]);
789
790         while ((c = (char *) strchr(tmp, '/'))) /* we are still dired searching */
791         {
792                 strncpy(working_tmp, tmp, c - tmp);
793                 working_tmp[c - tmp] = '\0';
794 #if 0
795                 putstr("search_inode: tmp = ");
796                 putstr(tmp);
797                 putstr("\r\n");
798                 putstr("search_inode: wtmp = ");
799                 putstr(working_tmp);
800                 putstr("\r\n");
801                 putstr("search_inode: c = ");
802                 putstr(c);
803                 putstr("\r\n");
804 #endif
805                 for (i = 0; i < strlen(c) - 1; i++)
806                         tmp[i] = c[i + 1];
807                 tmp[i] = '\0';
808 #if 0
809                 putstr("search_inode: post tmp = ");
810                 putstr(tmp);
811                 putstr("\r\n");
812 #endif
813
814                 if (!(pino = jffs2_1pass_find_inode(pL, working_tmp, pino))) {
815                         putstr("find_inode failed for name=");
816                         putstr(working_tmp);
817                         putstr("\r\n");
818                         return 0;
819                 }
820         }
821         /* this is for the bare filename, directories have already been mapped */
822         if (!(pino = jffs2_1pass_find_inode(pL, tmp, pino))) {
823                 putstr("find_inode failed for name=");
824                 putstr(tmp);
825                 putstr("\r\n");
826                 return 0;
827         }
828         return pino;
829
830 }
831
832 static u32
833 jffs2_1pass_resolve_inode(struct b_lists * pL, u32 ino)
834 {
835         struct b_node *b;
836         struct b_node *b2;
837         struct jffs2_raw_dirent *jDir;
838         struct jffs2_raw_inode *jNode;
839         u8 jDirFoundType = 0;
840         u32 jDirFoundIno = 0;
841         u32 jDirFoundPino = 0;
842         char tmp[256];
843         u32 version = 0;
844         u32 pino;
845         unsigned char *src;
846
847         /* we need to search all and return the inode with the highest version */
848         for(b = pL->dir.listHead; b; b = b->next) {
849                 jDir = (struct jffs2_raw_dirent *) get_node_mem(b->offset);
850                 if (ino == jDir->ino) {
851                         if (jDir->version < version) {
852                                 put_fl_mem(jDir);
853                                 continue;
854                         }
855
856                         if (jDir->version == version && jDirFoundType) {
857                                 /* I'm pretty sure this isn't legal */
858                                 putstr(" ** ERROR ** ");
859                                 putnstr(jDir->name, jDir->nsize);
860                                 putLabeledWord(" has dup version (resolve) = ",
861                                         version);
862                         }
863
864                         jDirFoundType = jDir->type;
865                         jDirFoundIno = jDir->ino;
866                         jDirFoundPino = jDir->pino;
867                         version = jDir->version;
868                 }
869                 put_fl_mem(jDir);
870         }
871         /* now we found the right entry again. (shoulda returned inode*) */
872         if (jDirFoundType != DT_LNK)
873                 return jDirFoundIno;
874
875         /* it's a soft link so we follow it again. */
876         b2 = pL->frag.listHead;
877         while (b2) {
878                 jNode = (struct jffs2_raw_inode *) get_node_mem(b2->offset);
879                 if (jNode->ino == jDirFoundIno) {
880                         src = (unsigned char *)jNode + sizeof(struct jffs2_raw_inode);
881
882 #if 0
883                         putLabeledWord("\t\t dsize = ", jNode->dsize);
884                         putstr("\t\t target = ");
885                         putnstr(src, jNode->dsize);
886                         putstr("\r\n");
887 #endif
888                         strncpy(tmp, src, jNode->dsize);
889                         tmp[jNode->dsize] = '\0';
890                         put_fl_mem(jNode);
891                         break;
892                 }
893                 b2 = b2->next;
894                 put_fl_mem(jNode);
895         }
896         /* ok so the name of the new file to find is in tmp */
897         /* if it starts with a slash it is root based else shared dirs */
898         if (tmp[0] == '/')
899                 pino = 1;
900         else
901                 pino = jDirFoundPino;
902
903         return jffs2_1pass_search_inode(pL, tmp, pino);
904 }
905
906 static u32
907 jffs2_1pass_search_list_inodes(struct b_lists * pL, const char *fname, u32 pino)
908 {
909         int i;
910         char tmp[256];
911         char working_tmp[256];
912         char *c;
913
914         /* discard any leading slash */
915         i = 0;
916         while (fname[i] == '/')
917                 i++;
918         strcpy(tmp, &fname[i]);
919         working_tmp[0] = '\0';
920         while ((c = (char *) strchr(tmp, '/'))) /* we are still dired searching */
921         {
922                 strncpy(working_tmp, tmp, c - tmp);
923                 working_tmp[c - tmp] = '\0';
924                 for (i = 0; i < strlen(c) - 1; i++)
925                         tmp[i] = c[i + 1];
926                 tmp[i] = '\0';
927                 /* only a failure if we arent looking at top level */
928                 if (!(pino = jffs2_1pass_find_inode(pL, working_tmp, pino)) &&
929                     (working_tmp[0])) {
930                         putstr("find_inode failed for name=");
931                         putstr(working_tmp);
932                         putstr("\r\n");
933                         return 0;
934                 }
935         }
936
937         if (tmp[0] && !(pino = jffs2_1pass_find_inode(pL, tmp, pino))) {
938                 putstr("find_inode failed for name=");
939                 putstr(tmp);
940                 putstr("\r\n");
941                 return 0;
942         }
943         /* this is for the bare filename, directories have already been mapped */
944         if (!(pino = jffs2_1pass_list_inodes(pL, pino))) {
945                 putstr("find_inode failed for name=");
946                 putstr(tmp);
947                 putstr("\r\n");
948                 return 0;
949         }
950         return pino;
951
952 }
953
954 unsigned char
955 jffs2_1pass_rescan_needed(struct part_info *part)
956 {
957         struct b_node *b;
958         struct jffs2_unknown_node onode;
959         struct jffs2_unknown_node *node;
960         struct b_lists *pL = (struct b_lists *)part->jffs2_priv;
961
962         if (part->jffs2_priv == 0){
963                 DEBUGF ("rescan: First time in use\n");
964                 return 1;
965         }
966         /* if we have no list, we need to rescan */
967         if (pL->frag.listCount == 0) {
968                 DEBUGF ("rescan: fraglist zero\n");
969                 return 1;
970         }
971
972         /* or if we are scanning a new partition */
973         if (pL->partOffset != part->offset) {
974                 DEBUGF ("rescan: different partition\n");
975                 return 1;
976         }
977
978 #if defined(CONFIG_JFFS2_NAND) && (CONFIG_COMMANDS & CFG_CMD_NAND)
979         if (nanddev != (int)part->usr_priv - 1) {
980                 DEBUGF ("rescan: nand device changed\n");
981                 return -1;
982         }
983 #endif /* defined(CONFIG_JFFS2_NAND) && (CONFIG_COMMANDS & CFG_CMD_NAND) */
984
985         /* but suppose someone reflashed a partition at the same offset... */
986         b = pL->dir.listHead;
987         while (b) {
988                 node = (struct jffs2_unknown_node *) get_fl_mem(b->offset,
989                         sizeof(onode), &onode);
990                 if (node->nodetype != JFFS2_NODETYPE_DIRENT) {
991                         DEBUGF ("rescan: fs changed beneath me? (%lx)\n",
992                                         (unsigned long) b->offset);
993                         return 1;
994                 }
995                 b = b->next;
996         }
997         return 0;
998 }
999
1000 #ifdef DEBUG_FRAGMENTS
1001 static void
1002 dump_fragments(struct b_lists *pL)
1003 {
1004         struct b_node *b;
1005         struct jffs2_raw_inode ojNode;
1006         struct jffs2_raw_inode *jNode;
1007
1008         putstr("\r\n\r\n******The fragment Entries******\r\n");
1009         b = pL->frag.listHead;
1010         while (b) {
1011                 jNode = (struct jffs2_raw_inode *) get_fl_mem(b->offset,
1012                         sizeof(ojNode), &ojNode);
1013                 putLabeledWord("\r\n\tbuild_list: FLASH_OFFSET = ", b->offset);
1014                 putLabeledWord("\tbuild_list: totlen = ", jNode->totlen);
1015                 putLabeledWord("\tbuild_list: inode = ", jNode->ino);
1016                 putLabeledWord("\tbuild_list: version = ", jNode->version);
1017                 putLabeledWord("\tbuild_list: isize = ", jNode->isize);
1018                 putLabeledWord("\tbuild_list: atime = ", jNode->atime);
1019                 putLabeledWord("\tbuild_list: offset = ", jNode->offset);
1020                 putLabeledWord("\tbuild_list: csize = ", jNode->csize);
1021                 putLabeledWord("\tbuild_list: dsize = ", jNode->dsize);
1022                 putLabeledWord("\tbuild_list: compr = ", jNode->compr);
1023                 putLabeledWord("\tbuild_list: usercompr = ", jNode->usercompr);
1024                 putLabeledWord("\tbuild_list: flags = ", jNode->flags);
1025                 putLabeledWord("\tbuild_list: offset = ", b->offset);   /* FIXME: ? [RS] */
1026                 b = b->next;
1027         }
1028 }
1029 #endif
1030
1031 #ifdef DEBUG_DIRENTS
1032 static void
1033 dump_dirents(struct b_lists *pL)
1034 {
1035         struct b_node *b;
1036         struct jffs2_raw_dirent *jDir;
1037
1038         putstr("\r\n\r\n******The directory Entries******\r\n");
1039         b = pL->dir.listHead;
1040         while (b) {
1041                 jDir = (struct jffs2_raw_dirent *) get_node_mem(b->offset);
1042                 putstr("\r\n");
1043                 putnstr(jDir->name, jDir->nsize);
1044                 putLabeledWord("\r\n\tbuild_list: magic = ", jDir->magic);
1045                 putLabeledWord("\tbuild_list: nodetype = ", jDir->nodetype);
1046                 putLabeledWord("\tbuild_list: hdr_crc = ", jDir->hdr_crc);
1047                 putLabeledWord("\tbuild_list: pino = ", jDir->pino);
1048                 putLabeledWord("\tbuild_list: version = ", jDir->version);
1049                 putLabeledWord("\tbuild_list: ino = ", jDir->ino);
1050                 putLabeledWord("\tbuild_list: mctime = ", jDir->mctime);
1051                 putLabeledWord("\tbuild_list: nsize = ", jDir->nsize);
1052                 putLabeledWord("\tbuild_list: type = ", jDir->type);
1053                 putLabeledWord("\tbuild_list: node_crc = ", jDir->node_crc);
1054                 putLabeledWord("\tbuild_list: name_crc = ", jDir->name_crc);
1055                 putLabeledWord("\tbuild_list: offset = ", b->offset);   /* FIXME: ? [RS] */
1056                 b = b->next;
1057                 put_fl_mem(jDir);
1058         }
1059 }
1060 #endif
1061
1062 static u32
1063 jffs2_1pass_build_lists(struct part_info * part)
1064 {
1065         struct b_lists *pL;
1066         struct jffs2_unknown_node *node;
1067         u32 offset, oldoffset = 0;
1068         u32 max = part->size - sizeof(struct jffs2_raw_inode);
1069         u32 counter = 0;
1070         u32 counter4 = 0;
1071         u32 counterF = 0;
1072         u32 counterN = 0;
1073
1074 #if defined(CONFIG_JFFS2_NAND) && (CONFIG_COMMANDS & CFG_CMD_NAND)
1075         nanddev = (int)part->usr_priv - 1;
1076 #endif /* defined(CONFIG_JFFS2_NAND) && (CONFIG_COMMANDS & CFG_CMD_NAND) */
1077
1078         /* turn off the lcd.  Refreshing the lcd adds 50% overhead to the */
1079         /* jffs2 list building enterprise nope.  in newer versions the overhead is */
1080         /* only about 5 %.  not enough to inconvenience people for. */
1081         /* lcd_off(); */
1082
1083         /* if we are building a list we need to refresh the cache. */
1084         jffs_init_1pass_list(part);
1085         pL = (struct b_lists *)part->jffs2_priv;
1086         pL->partOffset = part->offset;
1087         offset = 0;
1088         puts ("Scanning JFFS2 FS:   ");
1089
1090         /* start at the beginning of the partition */
1091         while (offset < max) {
1092                 if ((oldoffset >> SPIN_BLKSIZE) != (offset >> SPIN_BLKSIZE)) {
1093                         printf("\b\b%c ", spinner[counter++ % sizeof(spinner)]);
1094                         oldoffset = offset;
1095                 }
1096
1097                 node = (struct jffs2_unknown_node *) get_node_mem((u32)part->offset + offset);
1098                 if (node->magic == JFFS2_MAGIC_BITMASK && hdr_crc(node)) {
1099                         /* if its a fragment add it */
1100                         if (node->nodetype == JFFS2_NODETYPE_INODE &&
1101                                     inode_crc((struct jffs2_raw_inode *) node)) {
1102                                 if (insert_node(&pL->frag, (u32) part->offset +
1103                                                 offset) == NULL) {
1104                                         put_fl_mem(node);
1105                                         return 0;
1106                                 }
1107                         } else if (node->nodetype == JFFS2_NODETYPE_DIRENT &&
1108                                    dirent_crc((struct jffs2_raw_dirent *) node)  &&
1109                                    dirent_name_crc((struct jffs2_raw_dirent *) node)) {
1110                                 if (! (counterN%100))
1111                                         puts ("\b\b.  ");
1112                                 if (insert_node(&pL->dir, (u32) part->offset +
1113                                                 offset) == NULL) {
1114                                         put_fl_mem(node);
1115                                         return 0;
1116                                 }
1117                                 counterN++;
1118                         } else if (node->nodetype == JFFS2_NODETYPE_CLEANMARKER) {
1119                                 if (node->totlen != sizeof(struct jffs2_unknown_node))
1120                                         printf("OOPS Cleanmarker has bad size "
1121                                                 "%d != %d\n", node->totlen,
1122                                                 sizeof(struct jffs2_unknown_node));
1123                         } else if (node->nodetype == JFFS2_NODETYPE_PADDING) {
1124                                 if (node->totlen < sizeof(struct jffs2_unknown_node))
1125                                         printf("OOPS Padding has bad size "
1126                                                 "%d < %d\n", node->totlen,
1127                                                 sizeof(struct jffs2_unknown_node));
1128                         } else {
1129                                 printf("Unknown node type: %x len %d "
1130                                         "offset 0x%x\n", node->nodetype,
1131                                         node->totlen, offset);
1132                         }
1133                         offset += ((node->totlen + 3) & ~3);
1134                         counterF++;
1135                 } else if (node->magic == JFFS2_EMPTY_BITMASK &&
1136                            node->nodetype == JFFS2_EMPTY_BITMASK) {
1137                         offset = jffs2_scan_empty(offset, part);
1138                 } else {        /* if we know nothing, we just step and look. */
1139                         offset += 4;
1140                         counter4++;
1141                 }
1142 /*             printf("unknown node magic %4.4x %4.4x @ %lx\n", node->magic, node->nodetype, (unsigned long)node); */
1143                 put_fl_mem(node);
1144         }
1145
1146         putstr("\b\b done.\r\n");               /* close off the dots */
1147         /* turn the lcd back on. */
1148         /* splash(); */
1149
1150 #if 0
1151         putLabeledWord("dir entries = ", pL->dir.listCount);
1152         putLabeledWord("frag entries = ", pL->frag.listCount);
1153         putLabeledWord("+4 increments = ", counter4);
1154         putLabeledWord("+file_offset increments = ", counterF);
1155
1156 #endif
1157
1158 #ifdef DEBUG_DIRENTS
1159         dump_dirents(pL);
1160 #endif
1161
1162 #ifdef DEBUG_FRAGMENTS
1163         dump_fragments(pL);
1164 #endif
1165
1166         /* give visual feedback that we are done scanning the flash */
1167         led_blink(0x0, 0x0, 0x1, 0x1);  /* off, forever, on 100ms, off 100ms */
1168         return 1;
1169 }
1170
1171
1172 static u32
1173 jffs2_1pass_fill_info(struct b_lists * pL, struct b_jffs2_info * piL)
1174 {
1175         struct b_node *b;
1176         struct jffs2_raw_inode ojNode;
1177         struct jffs2_raw_inode *jNode;
1178         int i;
1179
1180         for (i = 0; i < JFFS2_NUM_COMPR; i++) {
1181                 piL->compr_info[i].num_frags = 0;
1182                 piL->compr_info[i].compr_sum = 0;
1183                 piL->compr_info[i].decompr_sum = 0;
1184         }
1185
1186         b = pL->frag.listHead;
1187         while (b) {
1188                 jNode = (struct jffs2_raw_inode *) get_fl_mem(b->offset,
1189                         sizeof(ojNode), &ojNode);
1190                 if (jNode->compr < JFFS2_NUM_COMPR) {
1191                         piL->compr_info[jNode->compr].num_frags++;
1192                         piL->compr_info[jNode->compr].compr_sum += jNode->csize;
1193                         piL->compr_info[jNode->compr].decompr_sum += jNode->dsize;
1194                 }
1195                 b = b->next;
1196         }
1197         return 0;
1198 }
1199
1200
1201 static struct b_lists *
1202 jffs2_get_list(struct part_info * part, const char *who)
1203 {
1204         if (jffs2_1pass_rescan_needed(part)) {
1205                 if (!jffs2_1pass_build_lists(part)) {
1206                         printf("%s: Failed to scan JFFSv2 file structure\n", who);
1207                         return NULL;
1208                 }
1209         }
1210         return (struct b_lists *)part->jffs2_priv;
1211 }
1212
1213
1214 /* Print directory / file contents */
1215 u32
1216 jffs2_1pass_ls(struct part_info * part, const char *fname)
1217 {
1218         struct b_lists *pl;
1219         long ret = 0;
1220         u32 inode;
1221
1222         if (! (pl = jffs2_get_list(part, "ls")))
1223                 return 0;
1224
1225         if (! (inode = jffs2_1pass_search_list_inodes(pl, fname, 1))) {
1226                 putstr("ls: Failed to scan jffs2 file structure\r\n");
1227                 return 0;
1228         }
1229
1230
1231 #if 0
1232         putLabeledWord("found file at inode = ", inode);
1233         putLabeledWord("read_inode returns = ", ret);
1234 #endif
1235
1236         return ret;
1237 }
1238
1239
1240 /* Load a file from flash into memory. fname can be a full path */
1241 u32
1242 jffs2_1pass_load(char *dest, struct part_info * part, const char *fname)
1243 {
1244
1245         struct b_lists *pl;
1246         long ret = 0;
1247         u32 inode;
1248
1249         if (! (pl  = jffs2_get_list(part, "load")))
1250                 return 0;
1251
1252         if (! (inode = jffs2_1pass_search_inode(pl, fname, 1))) {
1253                 putstr("load: Failed to find inode\r\n");
1254                 return 0;
1255         }
1256
1257         /* Resolve symlinks */
1258         if (! (inode = jffs2_1pass_resolve_inode(pl, inode))) {
1259                 putstr("load: Failed to resolve inode structure\r\n");
1260                 return 0;
1261         }
1262
1263         if ((ret = jffs2_1pass_read_inode(pl, inode, dest)) < 0) {
1264                 putstr("load: Failed to read inode\r\n");
1265                 return 0;
1266         }
1267
1268         DEBUGF ("load: loaded '%s' to 0x%lx (%ld bytes)\n", fname,
1269                                 (unsigned long) dest, ret);
1270         return ret;
1271 }
1272
1273 /* Return information about the fs on this partition */
1274 u32
1275 jffs2_1pass_info(struct part_info * part)
1276 {
1277         struct b_jffs2_info info;
1278         struct b_lists *pl;
1279         int i;
1280
1281         if (! (pl  = jffs2_get_list(part, "info")))
1282                 return 0;
1283
1284         jffs2_1pass_fill_info(pl, &info);
1285         for (i = 0; i < JFFS2_NUM_COMPR; i++) {
1286                 printf ("Compression: %s\n"
1287                         "\tfrag count: %d\n"
1288                         "\tcompressed sum: %d\n"
1289                         "\tuncompressed sum: %d\n",
1290                         compr_names[i],
1291                         info.compr_info[i].num_frags,
1292                         info.compr_info[i].compr_sum,
1293                         info.compr_info[i].decompr_sum);
1294         }
1295         return 1;
1296 }
1297
1298 #endif /* CFG_CMD_JFFS2 */