2 -------------------------------------------------------------------------
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 *-----------------------------------------------------------------------*/
10 * some portions of this code are taken from jffs2, and as such, the
11 * following copyright notice is included.
13 * JFFS2 -- Journalling Flash File System, Version 2.
15 * Copyright (C) 2001 Red Hat, Inc.
17 * Created by David Woodhouse <dwmw2@cambridge.redhat.com>
19 * The original JFFS, from which the design for JFFS2 was derived,
20 * was designed and implemented by Axis Communications AB.
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/
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.
32 * The Original Code is JFFS2 - Journalling Flash File System, version 2
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.
45 * $Id: jffs2_1pass.c,v 1.7 2002/01/25 01:56:47 nyet Exp $
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
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
67 * Adapted by Nye Liu <nyet@zumanetworks.com> and
68 * Rex Feany <rfeany@zumanetworks.com>
69 * on Jan/2002 for U-Boot.
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 ;).
79 * Bugfixing by Kai-Uwe Bloem <kai-uwe.bloem@auerswald.de>, (C) Mar/2003
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.
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
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.
95 * The fragment sorting feature must be enabled by CONFIG_SYS_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.
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.
104 * There's a big issue left: endianess is completely ignored in this code. Duh!
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!
117 #include <linux/stat.h>
118 #include <linux/time.h>
119 #include <watchdog.h>
120 #include <jffs2/jffs2.h>
121 #include <jffs2/jffs2_1pass.h>
123 #include "jffs2_private.h"
126 #define NODE_CHUNK 1024 /* size of memory allocation chunk in b_nodes */
127 #define SPIN_BLKSIZE 18 /* spin after having scanned 1<<BLKSIZE bytes */
129 /* Debugging switches */
130 #undef DEBUG_DIRENTS /* print directory entry list after scan */
131 #undef DEBUG_FRAGMENTS /* print fragment list after scan */
132 #undef DEBUG /* enable debugging messages */
136 # define DEBUGF(fmt,args...) printf(fmt ,##args)
138 # define DEBUGF(fmt,args...)
141 /* keeps pointer to currentlu processed partition */
142 static struct part_info *current_part;
144 #if (defined(CONFIG_JFFS2_NAND) && \
145 defined(CONFIG_CMD_NAND) )
146 #if defined(CONFIG_NAND_LEGACY)
147 #include <linux/mtd/nand_legacy.h>
152 * Support for jffs2 on top of NAND-flash
154 * NAND memory isn't mapped in processor's address space,
155 * so data should be fetched from flash before
156 * being processed. This is exactly what functions declared
161 #if defined(CONFIG_NAND_LEGACY)
162 /* this one defined in nand_legacy.c */
163 int read_jffs2_nand(size_t start, size_t len,
164 size_t * retlen, u_char * buf, int nanddev);
167 #define NAND_PAGE_SIZE 512
168 #define NAND_PAGE_SHIFT 9
169 #define NAND_PAGE_MASK (~(NAND_PAGE_SIZE-1))
171 #ifndef NAND_CACHE_PAGES
172 #define NAND_CACHE_PAGES 16
174 #define NAND_CACHE_SIZE (NAND_CACHE_PAGES*NAND_PAGE_SIZE)
176 static u8* nand_cache = NULL;
177 static u32 nand_cache_off = (u32)-1;
179 static int read_nand_cached(u32 off, u32 size, u_char *buf)
181 struct mtdids *id = current_part->dev->id;
186 while (bytes_read < size) {
187 if ((off + bytes_read < nand_cache_off) ||
188 (off + bytes_read >= nand_cache_off+NAND_CACHE_SIZE)) {
189 nand_cache_off = (off + bytes_read) & NAND_PAGE_MASK;
191 /* This memory never gets freed but 'cause
192 it's a bootloader, nobody cares */
193 nand_cache = malloc(NAND_CACHE_SIZE);
195 printf("read_nand_cached: can't alloc cache size %d bytes\n",
201 #if defined(CONFIG_NAND_LEGACY)
202 if (read_jffs2_nand(nand_cache_off, NAND_CACHE_SIZE,
203 &retlen, nand_cache, id->num) < 0 ||
204 retlen != NAND_CACHE_SIZE) {
205 printf("read_nand_cached: error reading nand off %#x size %d bytes\n",
206 nand_cache_off, NAND_CACHE_SIZE);
210 retlen = NAND_CACHE_SIZE;
211 if (nand_read(&nand_info[id->num], nand_cache_off,
212 &retlen, nand_cache) != 0 ||
213 retlen != NAND_CACHE_SIZE) {
214 printf("read_nand_cached: error reading nand off %#x size %d bytes\n",
215 nand_cache_off, NAND_CACHE_SIZE);
220 cpy_bytes = nand_cache_off + NAND_CACHE_SIZE - (off + bytes_read);
221 if (cpy_bytes > size - bytes_read)
222 cpy_bytes = size - bytes_read;
223 memcpy(buf + bytes_read,
224 nand_cache + off + bytes_read - nand_cache_off,
226 bytes_read += cpy_bytes;
231 static void *get_fl_mem_nand(u32 off, u32 size, void *ext_buf)
233 u_char *buf = ext_buf ? (u_char*)ext_buf : (u_char*)malloc(size);
236 printf("get_fl_mem_nand: can't alloc %d bytes\n", size);
239 if (read_nand_cached(off, size, buf) < 0) {
248 static void *get_node_mem_nand(u32 off, void *ext_buf)
250 struct jffs2_unknown_node node;
253 if (NULL == get_fl_mem_nand(off, sizeof(node), &node))
256 if (!(ret = get_fl_mem_nand(off, node.magic ==
257 JFFS2_MAGIC_BITMASK ? node.totlen : sizeof(node),
259 printf("off = %#x magic %#x type %#x node.totlen = %d\n",
260 off, node.magic, node.nodetype, node.totlen);
265 static void put_fl_mem_nand(void *buf)
271 #if defined(CONFIG_CMD_ONENAND)
273 #include <linux/mtd/mtd.h>
274 #include <linux/mtd/onenand.h>
275 #include <onenand_uboot.h>
277 #define ONENAND_PAGE_SIZE 2048
278 #define ONENAND_PAGE_SHIFT 11
279 #define ONENAND_PAGE_MASK (~(ONENAND_PAGE_SIZE-1))
281 #ifndef ONENAND_CACHE_PAGES
282 #define ONENAND_CACHE_PAGES 4
284 #define ONENAND_CACHE_SIZE (ONENAND_CACHE_PAGES*ONENAND_PAGE_SIZE)
286 static u8* onenand_cache;
287 static u32 onenand_cache_off = (u32)-1;
289 static int read_onenand_cached(u32 off, u32 size, u_char *buf)
295 while (bytes_read < size) {
296 if ((off + bytes_read < onenand_cache_off) ||
297 (off + bytes_read >= onenand_cache_off + ONENAND_CACHE_SIZE)) {
298 onenand_cache_off = (off + bytes_read) & ONENAND_PAGE_MASK;
299 if (!onenand_cache) {
300 /* This memory never gets freed but 'cause
301 it's a bootloader, nobody cares */
302 onenand_cache = malloc(ONENAND_CACHE_SIZE);
303 if (!onenand_cache) {
304 printf("read_onenand_cached: can't alloc cache size %d bytes\n",
310 retlen = ONENAND_CACHE_SIZE;
311 if (onenand_read(&onenand_mtd, onenand_cache_off, retlen,
312 &retlen, onenand_cache) != 0 ||
313 retlen != ONENAND_CACHE_SIZE) {
314 printf("read_onenand_cached: error reading nand off %#x size %d bytes\n",
315 onenand_cache_off, ONENAND_CACHE_SIZE);
319 cpy_bytes = onenand_cache_off + ONENAND_CACHE_SIZE - (off + bytes_read);
320 if (cpy_bytes > size - bytes_read)
321 cpy_bytes = size - bytes_read;
322 memcpy(buf + bytes_read,
323 onenand_cache + off + bytes_read - onenand_cache_off,
325 bytes_read += cpy_bytes;
330 static void *get_fl_mem_onenand(u32 off, u32 size, void *ext_buf)
332 u_char *buf = ext_buf ? (u_char *)ext_buf : (u_char *)malloc(size);
335 printf("get_fl_mem_onenand: can't alloc %d bytes\n", size);
338 if (read_onenand_cached(off, size, buf) < 0) {
347 static void *get_node_mem_onenand(u32 off, void *ext_buf)
349 struct jffs2_unknown_node node;
352 if (NULL == get_fl_mem_onenand(off, sizeof(node), &node))
355 ret = get_fl_mem_onenand(off, node.magic ==
356 JFFS2_MAGIC_BITMASK ? node.totlen : sizeof(node),
359 printf("off = %#x magic %#x type %#x node.totlen = %d\n",
360 off, node.magic, node.nodetype, node.totlen);
366 static void put_fl_mem_onenand(void *buf)
373 #if defined(CONFIG_CMD_FLASH)
375 * Support for jffs2 on top of NOR-flash
377 * NOR flash memory is mapped in processor's address space,
378 * just return address.
380 static inline void *get_fl_mem_nor(u32 off, u32 size, void *ext_buf)
383 struct mtdids *id = current_part->dev->id;
385 extern flash_info_t flash_info[];
386 flash_info_t *flash = &flash_info[id->num];
388 addr += flash->start[0];
390 memcpy(ext_buf, (void *)addr, size);
396 static inline void *get_node_mem_nor(u32 off, void *ext_buf)
398 struct jffs2_unknown_node *pNode;
400 /* pNode will point directly to flash - don't provide external buffer
401 and don't care about size */
402 pNode = get_fl_mem_nor(off, 0, NULL);
403 return (void *)get_fl_mem_nor(off, pNode->magic == JFFS2_MAGIC_BITMASK ?
404 pNode->totlen : sizeof(*pNode), ext_buf);
410 * Generic jffs2 raw memory and node read routines.
413 static inline void *get_fl_mem(u32 off, u32 size, void *ext_buf)
415 struct mtdids *id = current_part->dev->id;
417 #if defined(CONFIG_CMD_FLASH)
418 if (id->type == MTD_DEV_TYPE_NOR) {
419 return get_fl_mem_nor(off, size, ext_buf);
423 #if defined(CONFIG_JFFS2_NAND) && defined(CONFIG_CMD_NAND)
424 if (id->type == MTD_DEV_TYPE_NAND)
425 return get_fl_mem_nand(off, size, ext_buf);
428 #if defined(CONFIG_CMD_ONENAND)
429 if (id->type == MTD_DEV_TYPE_ONENAND)
430 return get_fl_mem_onenand(off, size, ext_buf);
433 printf("get_fl_mem: unknown device type, using raw offset!\n");
437 static inline void *get_node_mem(u32 off, void *ext_buf)
439 struct mtdids *id = current_part->dev->id;
441 #if defined(CONFIG_CMD_FLASH)
442 if (id->type == MTD_DEV_TYPE_NOR)
443 return get_node_mem_nor(off, ext_buf);
446 #if defined(CONFIG_JFFS2_NAND) && \
447 defined(CONFIG_CMD_NAND)
448 if (id->type == MTD_DEV_TYPE_NAND)
449 return get_node_mem_nand(off, ext_buf);
452 #if defined(CONFIG_CMD_ONENAND)
453 if (id->type == MTD_DEV_TYPE_ONENAND)
454 return get_node_mem_onenand(off, ext_buf);
457 printf("get_node_mem: unknown device type, using raw offset!\n");
461 static inline void put_fl_mem(void *buf, void *ext_buf)
463 struct mtdids *id = current_part->dev->id;
465 /* If buf is the same as ext_buf, it was provided by the caller -
466 we shouldn't free it then. */
470 #if defined(CONFIG_JFFS2_NAND) && defined(CONFIG_CMD_NAND)
471 case MTD_DEV_TYPE_NAND:
472 return put_fl_mem_nand(buf);
474 #if defined(CONFIG_CMD_ONENAND)
475 case MTD_DEV_TYPE_ONENAND:
476 return put_fl_mem_onenand(buf);
481 /* Compression names */
482 static char *compr_names[] = {
490 #if defined(CONFIG_JFFS2_LZO_LZARI)
496 /* Memory management */
499 struct mem_block *next;
500 struct b_node nodes[NODE_CHUNK];
505 free_nodes(struct b_list *list)
507 while (list->listMemBase != NULL) {
508 struct mem_block *next = list->listMemBase->next;
509 free( list->listMemBase );
510 list->listMemBase = next;
514 static struct b_node *
515 add_node(struct b_list *list)
518 struct mem_block *memBase;
521 memBase = list->listMemBase;
523 index = memBase->index;
525 putLabeledWord("add_node: index = ", index);
526 putLabeledWord("add_node: memBase = ", list->listMemBase);
529 if (memBase == NULL || index >= NODE_CHUNK) {
530 /* we need more space before we continue */
531 memBase = mmalloc(sizeof(struct mem_block));
532 if (memBase == NULL) {
533 putstr("add_node: malloc failed\n");
536 memBase->next = list->listMemBase;
539 putLabeledWord("add_node: alloced a new membase at ", *memBase);
543 /* now we have room to add it. */
544 b = &memBase->nodes[index];
547 memBase->index = index;
548 list->listMemBase = memBase;
553 static struct b_node *
554 insert_node(struct b_list *list, u32 offset)
557 #ifdef CONFIG_SYS_JFFS2_SORT_FRAGMENTS
558 struct b_node *b, *prev;
561 if (!(new = add_node(list))) {
562 putstr("add_node failed!\r\n");
565 new->offset = offset;
567 #ifdef CONFIG_SYS_JFFS2_SORT_FRAGMENTS
568 if (list->listTail != NULL && list->listCompare(new, list->listTail))
569 prev = list->listTail;
570 else if (list->listLast != NULL && list->listCompare(new, list->listLast))
571 prev = list->listLast;
575 for (b = (prev ? prev->next : list->listHead);
576 b != NULL && list->listCompare(new, b);
577 prev = b, b = b->next) {
581 list->listLast = prev;
588 list->listHead = new;
592 new->next = (struct b_node *) NULL;
593 if (list->listTail != NULL) {
594 list->listTail->next = new;
595 list->listTail = new;
597 list->listTail = list->listHead = new;
604 #ifdef CONFIG_SYS_JFFS2_SORT_FRAGMENTS
605 /* Sort data entries with the latest version last, so that if there
606 * is overlapping data the latest version will be used.
608 static int compare_inodes(struct b_node *new, struct b_node *old)
610 struct jffs2_raw_inode ojNew;
611 struct jffs2_raw_inode ojOld;
612 struct jffs2_raw_inode *jNew =
613 (struct jffs2_raw_inode *)get_fl_mem(new->offset, sizeof(ojNew), &ojNew);
614 struct jffs2_raw_inode *jOld =
615 (struct jffs2_raw_inode *)get_fl_mem(old->offset, sizeof(ojOld), &ojOld);
617 return jNew->version > jOld->version;
620 /* Sort directory entries so all entries in the same directory
621 * with the same name are grouped together, with the latest version
622 * last. This makes it easy to eliminate all but the latest version
623 * by marking the previous version dead by setting the inode to 0.
625 static int compare_dirents(struct b_node *new, struct b_node *old)
627 struct jffs2_raw_dirent ojNew;
628 struct jffs2_raw_dirent ojOld;
629 struct jffs2_raw_dirent *jNew =
630 (struct jffs2_raw_dirent *)get_fl_mem(new->offset, sizeof(ojNew), &ojNew);
631 struct jffs2_raw_dirent *jOld =
632 (struct jffs2_raw_dirent *)get_fl_mem(old->offset, sizeof(ojOld), &ojOld);
635 /* ascending sort by pino */
636 if (jNew->pino != jOld->pino)
637 return jNew->pino > jOld->pino;
639 /* pino is the same, so use ascending sort by nsize, so
640 * we don't do strncmp unless we really must.
642 if (jNew->nsize != jOld->nsize)
643 return jNew->nsize > jOld->nsize;
645 /* length is also the same, so use ascending sort by name
647 cmp = strncmp((char *)jNew->name, (char *)jOld->name, jNew->nsize);
651 /* we have duplicate names in this directory, so use ascending
654 if (jNew->version > jOld->version) {
655 /* since jNew is newer, we know jOld is not valid, so
656 * mark it with inode 0 and it will not be used
667 jffs2_free_cache(struct part_info *part)
671 if (part->jffs2_priv != NULL) {
672 pL = (struct b_lists *)part->jffs2_priv;
673 free_nodes(&pL->frag);
674 free_nodes(&pL->dir);
681 jffs_init_1pass_list(struct part_info *part)
685 jffs2_free_cache(part);
687 if (NULL != (part->jffs2_priv = malloc(sizeof(struct b_lists)))) {
688 pL = (struct b_lists *)part->jffs2_priv;
690 memset(pL, 0, sizeof(*pL));
691 #ifdef CONFIG_SYS_JFFS2_SORT_FRAGMENTS
692 pL->dir.listCompare = compare_dirents;
693 pL->frag.listCompare = compare_inodes;
699 /* find the inode from the slashless name given a parent */
701 jffs2_1pass_read_inode(struct b_lists *pL, u32 inode, char *dest)
704 struct jffs2_raw_inode *jNode;
706 u32 latestVersion = 0;
712 #ifdef CONFIG_SYS_JFFS2_SORT_FRAGMENTS
713 /* Find file size before loading any data, so fragments that
714 * start past the end of file can be ignored. A fragment
715 * that is partially in the file is loaded, so extra data may
716 * be loaded up to the next 4K boundary above the file size.
717 * This shouldn't cause trouble when loading kernel images, so
718 * we will live with it.
720 for (b = pL->frag.listHead; b != NULL; b = b->next) {
721 jNode = (struct jffs2_raw_inode *) get_fl_mem(b->offset,
722 sizeof(struct jffs2_raw_inode), pL->readbuf);
723 if ((inode == jNode->ino)) {
724 /* get actual file length from the newest node */
725 if (jNode->version >= latestVersion) {
726 totalSize = jNode->isize;
727 latestVersion = jNode->version;
730 put_fl_mem(jNode, pL->readbuf);
734 for (b = pL->frag.listHead; b != NULL; b = b->next) {
735 jNode = (struct jffs2_raw_inode *) get_node_mem(b->offset,
737 if ((inode == jNode->ino)) {
739 putLabeledWord("\r\n\r\nread_inode: totlen = ", jNode->totlen);
740 putLabeledWord("read_inode: inode = ", jNode->ino);
741 putLabeledWord("read_inode: version = ", jNode->version);
742 putLabeledWord("read_inode: isize = ", jNode->isize);
743 putLabeledWord("read_inode: offset = ", jNode->offset);
744 putLabeledWord("read_inode: csize = ", jNode->csize);
745 putLabeledWord("read_inode: dsize = ", jNode->dsize);
746 putLabeledWord("read_inode: compr = ", jNode->compr);
747 putLabeledWord("read_inode: usercompr = ", jNode->usercompr);
748 putLabeledWord("read_inode: flags = ", jNode->flags);
751 #ifndef CONFIG_SYS_JFFS2_SORT_FRAGMENTS
752 /* get actual file length from the newest node */
753 if (jNode->version >= latestVersion) {
754 totalSize = jNode->isize;
755 latestVersion = jNode->version;
760 src = ((uchar *) jNode) + sizeof(struct jffs2_raw_inode);
761 /* ignore data behind latest known EOF */
762 if (jNode->offset > totalSize) {
763 put_fl_mem(jNode, pL->readbuf);
766 if (!data_crc(jNode)) {
767 put_fl_mem(jNode, pL->readbuf);
771 lDest = (uchar *) (dest + jNode->offset);
773 putLabeledWord("read_inode: src = ", src);
774 putLabeledWord("read_inode: dest = ", lDest);
776 switch (jNode->compr) {
777 case JFFS2_COMPR_NONE:
778 ret = (unsigned long) ldr_memcpy(lDest, src, jNode->dsize);
780 case JFFS2_COMPR_ZERO:
782 for (i = 0; i < jNode->dsize; i++)
785 case JFFS2_COMPR_RTIME:
787 rtime_decompress(src, lDest, jNode->csize, jNode->dsize);
789 case JFFS2_COMPR_DYNRUBIN:
790 /* this is slow but it works */
792 dynrubin_decompress(src, lDest, jNode->csize, jNode->dsize);
794 case JFFS2_COMPR_ZLIB:
795 ret = zlib_decompress(src, lDest, jNode->csize, jNode->dsize);
797 #if defined(CONFIG_JFFS2_LZO_LZARI)
798 case JFFS2_COMPR_LZO:
799 ret = lzo_decompress(src, lDest, jNode->csize, jNode->dsize);
801 case JFFS2_COMPR_LZARI:
802 ret = lzari_decompress(src, lDest, jNode->csize, jNode->dsize);
807 putLabeledWord("UNKOWN COMPRESSION METHOD = ", jNode->compr);
808 put_fl_mem(jNode, pL->readbuf);
815 putLabeledWord("read_inode: totalSize = ", totalSize);
816 putLabeledWord("read_inode: compr ret = ", ret);
820 put_fl_mem(jNode, pL->readbuf);
824 putLabeledWord("read_inode: returning = ", totalSize);
829 /* find the inode from the slashless name given a parent */
831 jffs2_1pass_find_inode(struct b_lists * pL, const char *name, u32 pino)
834 struct jffs2_raw_dirent *jDir;
840 /* name is assumed slash free */
844 /* we need to search all and return the inode with the highest version */
845 for(b = pL->dir.listHead; b; b = b->next, counter++) {
846 jDir = (struct jffs2_raw_dirent *) get_node_mem(b->offset,
848 if ((pino == jDir->pino) && (len == jDir->nsize) &&
849 (jDir->ino) && /* 0 for unlink */
850 (!strncmp((char *)jDir->name, name, len))) { /* a match */
851 if (jDir->version < version) {
852 put_fl_mem(jDir, pL->readbuf);
856 if (jDir->version == version && inode != 0) {
857 /* I'm pretty sure this isn't legal */
858 putstr(" ** ERROR ** ");
859 putnstr(jDir->name, jDir->nsize);
860 putLabeledWord(" has dup version =", version);
863 version = jDir->version;
866 putstr("\r\nfind_inode:p&l ->");
867 putnstr(jDir->name, jDir->nsize);
869 putLabeledWord("pino = ", jDir->pino);
870 putLabeledWord("nsize = ", jDir->nsize);
871 putLabeledWord("b = ", (u32) b);
872 putLabeledWord("counter = ", counter);
874 put_fl_mem(jDir, pL->readbuf);
879 char *mkmodestr(unsigned long mode, char *str)
881 static const char *l = "xwr";
885 switch (mode & S_IFMT) {
886 case S_IFDIR: str[0] = 'd'; break;
887 case S_IFBLK: str[0] = 'b'; break;
888 case S_IFCHR: str[0] = 'c'; break;
889 case S_IFIFO: str[0] = 'f'; break;
890 case S_IFLNK: str[0] = 'l'; break;
891 case S_IFSOCK: str[0] = 's'; break;
892 case S_IFREG: str[0] = '-'; break;
893 default: str[0] = '?';
896 for(i = 0; i < 9; i++) {
898 str[9-i] = (mode & mask)?c:'-';
902 if(mode & S_ISUID) str[3] = (mode & S_IXUSR)?'s':'S';
903 if(mode & S_ISGID) str[6] = (mode & S_IXGRP)?'s':'S';
904 if(mode & S_ISVTX) str[9] = (mode & S_IXOTH)?'t':'T';
909 static inline void dump_stat(struct stat *st, const char *name)
914 if (st->st_mtime == (time_t)(-1)) /* some ctimes really hate -1 */
917 ctime_r((time_t *)&st->st_mtime, s/*,64*/); /* newlib ctime doesn't have buflen */
919 if ((p = strchr(s,'\n')) != NULL) *p = '\0';
920 if ((p = strchr(s,'\r')) != NULL) *p = '\0';
923 printf("%6lo %s %8ld %s %s\n", st->st_mode, mkmodestr(st->st_mode, str),
924 st->st_size, s, name);
927 printf(" %s %8ld %s %s", mkmodestr(st->st_mode,str), st->st_size, s, name);
930 static inline u32 dump_inode(struct b_lists * pL, struct jffs2_raw_dirent *d, struct jffs2_raw_inode *i)
935 if(!d || !i) return -1;
937 strncpy(fname, (char *)d->name, d->nsize);
938 fname[d->nsize] = '\0';
940 memset(&st,0,sizeof(st));
942 st.st_mtime = i->mtime;
943 st.st_mode = i->mode;
945 st.st_size = i->isize;
947 dump_stat(&st, fname);
949 if (d->type == DT_LNK) {
950 unsigned char *src = (unsigned char *) (&i[1]);
952 putnstr(src, (int)i->dsize);
960 /* list inodes with the given pino */
962 jffs2_1pass_list_inodes(struct b_lists * pL, u32 pino)
965 struct jffs2_raw_dirent *jDir;
967 for (b = pL->dir.listHead; b; b = b->next) {
968 jDir = (struct jffs2_raw_dirent *) get_node_mem(b->offset,
970 if ((pino == jDir->pino) && (jDir->ino)) { /* ino=0 -> unlink */
972 struct jffs2_raw_inode ojNode;
973 struct jffs2_raw_inode *jNode, *i = NULL;
974 struct b_node *b2 = pL->frag.listHead;
977 jNode = (struct jffs2_raw_inode *)
978 get_fl_mem(b2->offset, sizeof(ojNode), &ojNode);
979 if (jNode->ino == jDir->ino && jNode->version >= i_version) {
980 i_version = jNode->version;
984 if (jDir->type == DT_LNK)
985 i = get_node_mem(b2->offset,
988 i = get_fl_mem(b2->offset,
995 dump_inode(pL, jDir, i);
998 put_fl_mem(jDir, pL->readbuf);
1004 jffs2_1pass_search_inode(struct b_lists * pL, const char *fname, u32 pino)
1008 char working_tmp[256];
1011 /* discard any leading slash */
1013 while (fname[i] == '/')
1015 strcpy(tmp, &fname[i]);
1017 while ((c = (char *) strchr(tmp, '/'))) /* we are still dired searching */
1019 strncpy(working_tmp, tmp, c - tmp);
1020 working_tmp[c - tmp] = '\0';
1022 putstr("search_inode: tmp = ");
1025 putstr("search_inode: wtmp = ");
1026 putstr(working_tmp);
1028 putstr("search_inode: c = ");
1032 for (i = 0; i < strlen(c) - 1; i++)
1036 putstr("search_inode: post tmp = ");
1041 if (!(pino = jffs2_1pass_find_inode(pL, working_tmp, pino))) {
1042 putstr("find_inode failed for name=");
1043 putstr(working_tmp);
1048 /* this is for the bare filename, directories have already been mapped */
1049 if (!(pino = jffs2_1pass_find_inode(pL, tmp, pino))) {
1050 putstr("find_inode failed for name=");
1060 jffs2_1pass_resolve_inode(struct b_lists * pL, u32 ino)
1064 struct jffs2_raw_dirent *jDir;
1065 struct jffs2_raw_inode *jNode;
1066 u8 jDirFoundType = 0;
1067 u32 jDirFoundIno = 0;
1068 u32 jDirFoundPino = 0;
1074 /* we need to search all and return the inode with the highest version */
1075 for(b = pL->dir.listHead; b; b = b->next) {
1076 jDir = (struct jffs2_raw_dirent *) get_node_mem(b->offset,
1078 if (ino == jDir->ino) {
1079 if (jDir->version < version) {
1080 put_fl_mem(jDir, pL->readbuf);
1084 if (jDir->version == version && jDirFoundType) {
1085 /* I'm pretty sure this isn't legal */
1086 putstr(" ** ERROR ** ");
1087 putnstr(jDir->name, jDir->nsize);
1088 putLabeledWord(" has dup version (resolve) = ",
1092 jDirFoundType = jDir->type;
1093 jDirFoundIno = jDir->ino;
1094 jDirFoundPino = jDir->pino;
1095 version = jDir->version;
1097 put_fl_mem(jDir, pL->readbuf);
1099 /* now we found the right entry again. (shoulda returned inode*) */
1100 if (jDirFoundType != DT_LNK)
1101 return jDirFoundIno;
1103 /* it's a soft link so we follow it again. */
1104 b2 = pL->frag.listHead;
1106 jNode = (struct jffs2_raw_inode *) get_node_mem(b2->offset,
1108 if (jNode->ino == jDirFoundIno) {
1109 src = (unsigned char *)jNode + sizeof(struct jffs2_raw_inode);
1112 putLabeledWord("\t\t dsize = ", jNode->dsize);
1113 putstr("\t\t target = ");
1114 putnstr(src, jNode->dsize);
1117 strncpy(tmp, (char *)src, jNode->dsize);
1118 tmp[jNode->dsize] = '\0';
1119 put_fl_mem(jNode, pL->readbuf);
1123 put_fl_mem(jNode, pL->readbuf);
1125 /* ok so the name of the new file to find is in tmp */
1126 /* if it starts with a slash it is root based else shared dirs */
1130 pino = jDirFoundPino;
1132 return jffs2_1pass_search_inode(pL, tmp, pino);
1136 jffs2_1pass_search_list_inodes(struct b_lists * pL, const char *fname, u32 pino)
1140 char working_tmp[256];
1143 /* discard any leading slash */
1145 while (fname[i] == '/')
1147 strcpy(tmp, &fname[i]);
1148 working_tmp[0] = '\0';
1149 while ((c = (char *) strchr(tmp, '/'))) /* we are still dired searching */
1151 strncpy(working_tmp, tmp, c - tmp);
1152 working_tmp[c - tmp] = '\0';
1153 for (i = 0; i < strlen(c) - 1; i++)
1156 /* only a failure if we arent looking at top level */
1157 if (!(pino = jffs2_1pass_find_inode(pL, working_tmp, pino)) &&
1159 putstr("find_inode failed for name=");
1160 putstr(working_tmp);
1166 if (tmp[0] && !(pino = jffs2_1pass_find_inode(pL, tmp, pino))) {
1167 putstr("find_inode failed for name=");
1172 /* this is for the bare filename, directories have already been mapped */
1173 if (!(pino = jffs2_1pass_list_inodes(pL, pino))) {
1174 putstr("find_inode failed for name=");
1184 jffs2_1pass_rescan_needed(struct part_info *part)
1187 struct jffs2_unknown_node onode;
1188 struct jffs2_unknown_node *node;
1189 struct b_lists *pL = (struct b_lists *)part->jffs2_priv;
1191 if (part->jffs2_priv == 0){
1192 DEBUGF ("rescan: First time in use\n");
1196 /* if we have no list, we need to rescan */
1197 if (pL->frag.listCount == 0) {
1198 DEBUGF ("rescan: fraglist zero\n");
1202 /* but suppose someone reflashed a partition at the same offset... */
1203 b = pL->dir.listHead;
1205 node = (struct jffs2_unknown_node *) get_fl_mem(b->offset,
1206 sizeof(onode), &onode);
1207 if (node->nodetype != JFFS2_NODETYPE_DIRENT) {
1208 DEBUGF ("rescan: fs changed beneath me? (%lx)\n",
1209 (unsigned long) b->offset);
1217 #ifdef DEBUG_FRAGMENTS
1219 dump_fragments(struct b_lists *pL)
1222 struct jffs2_raw_inode ojNode;
1223 struct jffs2_raw_inode *jNode;
1225 putstr("\r\n\r\n******The fragment Entries******\r\n");
1226 b = pL->frag.listHead;
1228 jNode = (struct jffs2_raw_inode *) get_fl_mem(b->offset,
1229 sizeof(ojNode), &ojNode);
1230 putLabeledWord("\r\n\tbuild_list: FLASH_OFFSET = ", b->offset);
1231 putLabeledWord("\tbuild_list: totlen = ", jNode->totlen);
1232 putLabeledWord("\tbuild_list: inode = ", jNode->ino);
1233 putLabeledWord("\tbuild_list: version = ", jNode->version);
1234 putLabeledWord("\tbuild_list: isize = ", jNode->isize);
1235 putLabeledWord("\tbuild_list: atime = ", jNode->atime);
1236 putLabeledWord("\tbuild_list: offset = ", jNode->offset);
1237 putLabeledWord("\tbuild_list: csize = ", jNode->csize);
1238 putLabeledWord("\tbuild_list: dsize = ", jNode->dsize);
1239 putLabeledWord("\tbuild_list: compr = ", jNode->compr);
1240 putLabeledWord("\tbuild_list: usercompr = ", jNode->usercompr);
1241 putLabeledWord("\tbuild_list: flags = ", jNode->flags);
1242 putLabeledWord("\tbuild_list: offset = ", b->offset); /* FIXME: ? [RS] */
1248 #ifdef DEBUG_DIRENTS
1250 dump_dirents(struct b_lists *pL)
1253 struct jffs2_raw_dirent *jDir;
1255 putstr("\r\n\r\n******The directory Entries******\r\n");
1256 b = pL->dir.listHead;
1258 jDir = (struct jffs2_raw_dirent *) get_node_mem(b->offset,
1261 putnstr(jDir->name, jDir->nsize);
1262 putLabeledWord("\r\n\tbuild_list: magic = ", jDir->magic);
1263 putLabeledWord("\tbuild_list: nodetype = ", jDir->nodetype);
1264 putLabeledWord("\tbuild_list: hdr_crc = ", jDir->hdr_crc);
1265 putLabeledWord("\tbuild_list: pino = ", jDir->pino);
1266 putLabeledWord("\tbuild_list: version = ", jDir->version);
1267 putLabeledWord("\tbuild_list: ino = ", jDir->ino);
1268 putLabeledWord("\tbuild_list: mctime = ", jDir->mctime);
1269 putLabeledWord("\tbuild_list: nsize = ", jDir->nsize);
1270 putLabeledWord("\tbuild_list: type = ", jDir->type);
1271 putLabeledWord("\tbuild_list: node_crc = ", jDir->node_crc);
1272 putLabeledWord("\tbuild_list: name_crc = ", jDir->name_crc);
1273 putLabeledWord("\tbuild_list: offset = ", b->offset); /* FIXME: ? [RS] */
1275 put_fl_mem(jDir, pL->readbuf);
1280 #define min_t(type, x, y) ({ \
1281 type __min1 = (x); \
1282 type __min2 = (y); \
1283 __min1 < __min2 ? __min1: __min2; })
1285 #define DEFAULT_EMPTY_SCAN_SIZE 4096
1287 static inline uint32_t EMPTY_SCAN_SIZE(uint32_t sector_size)
1289 if (sector_size < DEFAULT_EMPTY_SCAN_SIZE)
1292 return DEFAULT_EMPTY_SCAN_SIZE;
1296 jffs2_1pass_build_lists(struct part_info * part)
1299 struct jffs2_unknown_node *node;
1300 u32 nr_sectors = part->size/part->sector_size;
1306 u32 buf_size = DEFAULT_EMPTY_SCAN_SIZE;
1309 /* turn off the lcd. Refreshing the lcd adds 50% overhead to the */
1310 /* jffs2 list building enterprise nope. in newer versions the overhead is */
1311 /* only about 5 %. not enough to inconvenience people for. */
1314 /* if we are building a list we need to refresh the cache. */
1315 jffs_init_1pass_list(part);
1316 pL = (struct b_lists *)part->jffs2_priv;
1317 buf = malloc(buf_size);
1318 puts ("Scanning JFFS2 FS: ");
1320 /* start at the beginning of the partition */
1321 for (i = 0; i < nr_sectors; i++) {
1322 uint32_t sector_ofs = i * part->sector_size;
1323 uint32_t buf_ofs = sector_ofs;
1324 uint32_t buf_len = EMPTY_SCAN_SIZE(part->sector_size);
1325 uint32_t ofs, prevofs;
1328 get_fl_mem((u32)part->offset + buf_ofs, buf_len, buf);
1330 /* We temporarily use 'ofs' as a pointer into the buffer/jeb */
1333 /* Scan only 4KiB of 0xFF before declaring it's empty */
1334 while (ofs < EMPTY_SCAN_SIZE(part->sector_size) &&
1335 *(uint32_t *)(&buf[ofs]) == 0xFFFFFFFF)
1338 if (ofs == EMPTY_SCAN_SIZE(part->sector_size))
1345 while (ofs < sector_ofs + part->sector_size) {
1346 if (ofs == prevofs) {
1347 printf("offset %08x already seen, skip\n", ofs);
1353 if (sector_ofs + part->sector_size <
1354 ofs + sizeof(*node))
1356 if (buf_ofs + buf_len < ofs + sizeof(*node)) {
1357 buf_len = min_t(uint32_t, buf_size, sector_ofs
1358 + part->sector_size - ofs);
1359 get_fl_mem((u32)part->offset + ofs, buf_len,
1364 node = (struct jffs2_unknown_node *)&buf[ofs-buf_ofs];
1366 if (*(uint32_t *)(&buf[ofs-buf_ofs]) == 0xffffffff) {
1368 uint32_t empty_start, scan_end;
1372 scan_end = min_t(uint32_t, EMPTY_SCAN_SIZE(
1373 part->sector_size)/8,
1376 inbuf_ofs = ofs - buf_ofs;
1377 while (inbuf_ofs < scan_end) {
1378 if (*(uint32_t *)(&buf[inbuf_ofs]) !=
1387 /* See how much more there is to read in this
1390 buf_len = min_t(uint32_t, buf_size,
1392 part->sector_size - ofs);
1394 /* No more to read. Break out of main
1395 * loop without marking this range of
1396 * empty space as dirty (because it's
1402 get_fl_mem((u32)part->offset + ofs, buf_len,
1407 if (node->magic != JFFS2_MAGIC_BITMASK ||
1413 if (ofs + node->totlen >
1414 sector_ofs + part->sector_size) {
1419 /* if its a fragment add it */
1420 switch (node->nodetype) {
1421 case JFFS2_NODETYPE_INODE:
1422 if (buf_ofs + buf_len < ofs + sizeof(struct
1424 get_fl_mem((u32)part->offset + ofs,
1429 if (!inode_crc((struct jffs2_raw_inode *) node))
1432 if (insert_node(&pL->frag, (u32) part->offset +
1435 if (max_totlen < node->totlen)
1436 max_totlen = node->totlen;
1438 case JFFS2_NODETYPE_DIRENT:
1439 if (buf_ofs + buf_len < ofs + sizeof(struct
1444 get_fl_mem((u32)part->offset + ofs,
1450 if (!dirent_crc((struct jffs2_raw_dirent *)
1457 if (! (counterN%100))
1459 if (insert_node(&pL->dir, (u32) part->offset +
1462 if (max_totlen < node->totlen)
1463 max_totlen = node->totlen;
1466 case JFFS2_NODETYPE_CLEANMARKER:
1467 if (node->totlen != sizeof(struct jffs2_unknown_node))
1468 printf("OOPS Cleanmarker has bad size "
1471 sizeof(struct jffs2_unknown_node));
1473 case JFFS2_NODETYPE_PADDING:
1474 if (node->totlen < sizeof(struct jffs2_unknown_node))
1475 printf("OOPS Padding has bad size "
1478 sizeof(struct jffs2_unknown_node));
1481 printf("Unknown node type: %x len %d offset 0x%x\n",
1485 ofs += ((node->totlen + 3) & ~3);
1491 putstr("\b\b done.\r\n"); /* close off the dots */
1493 /* We don't care if malloc failed - then each read operation will
1494 * allocate its own buffer as necessary (NAND) or will read directly
1497 pL->readbuf = malloc(max_totlen);
1499 /* turn the lcd back on. */
1503 putLabeledWord("dir entries = ", pL->dir.listCount);
1504 putLabeledWord("frag entries = ", pL->frag.listCount);
1505 putLabeledWord("+4 increments = ", counter4);
1506 putLabeledWord("+file_offset increments = ", counterF);
1510 #ifdef DEBUG_DIRENTS
1514 #ifdef DEBUG_FRAGMENTS
1518 /* give visual feedback that we are done scanning the flash */
1519 led_blink(0x0, 0x0, 0x1, 0x1); /* off, forever, on 100ms, off 100ms */
1525 jffs2_1pass_fill_info(struct b_lists * pL, struct b_jffs2_info * piL)
1528 struct jffs2_raw_inode ojNode;
1529 struct jffs2_raw_inode *jNode;
1532 for (i = 0; i < JFFS2_NUM_COMPR; i++) {
1533 piL->compr_info[i].num_frags = 0;
1534 piL->compr_info[i].compr_sum = 0;
1535 piL->compr_info[i].decompr_sum = 0;
1538 b = pL->frag.listHead;
1540 jNode = (struct jffs2_raw_inode *) get_fl_mem(b->offset,
1541 sizeof(ojNode), &ojNode);
1542 if (jNode->compr < JFFS2_NUM_COMPR) {
1543 piL->compr_info[jNode->compr].num_frags++;
1544 piL->compr_info[jNode->compr].compr_sum += jNode->csize;
1545 piL->compr_info[jNode->compr].decompr_sum += jNode->dsize;
1553 static struct b_lists *
1554 jffs2_get_list(struct part_info * part, const char *who)
1556 /* copy requested part_info struct pointer to global location */
1557 current_part = part;
1559 if (jffs2_1pass_rescan_needed(part)) {
1560 if (!jffs2_1pass_build_lists(part)) {
1561 printf("%s: Failed to scan JFFSv2 file structure\n", who);
1565 return (struct b_lists *)part->jffs2_priv;
1569 /* Print directory / file contents */
1571 jffs2_1pass_ls(struct part_info * part, const char *fname)
1577 if (! (pl = jffs2_get_list(part, "ls")))
1580 if (! (inode = jffs2_1pass_search_list_inodes(pl, fname, 1))) {
1581 putstr("ls: Failed to scan jffs2 file structure\r\n");
1587 putLabeledWord("found file at inode = ", inode);
1588 putLabeledWord("read_inode returns = ", ret);
1595 /* Load a file from flash into memory. fname can be a full path */
1597 jffs2_1pass_load(char *dest, struct part_info * part, const char *fname)
1604 if (! (pl = jffs2_get_list(part, "load")))
1607 if (! (inode = jffs2_1pass_search_inode(pl, fname, 1))) {
1608 putstr("load: Failed to find inode\r\n");
1612 /* Resolve symlinks */
1613 if (! (inode = jffs2_1pass_resolve_inode(pl, inode))) {
1614 putstr("load: Failed to resolve inode structure\r\n");
1618 if ((ret = jffs2_1pass_read_inode(pl, inode, dest)) < 0) {
1619 putstr("load: Failed to read inode\r\n");
1623 DEBUGF ("load: loaded '%s' to 0x%lx (%ld bytes)\n", fname,
1624 (unsigned long) dest, ret);
1628 /* Return information about the fs on this partition */
1630 jffs2_1pass_info(struct part_info * part)
1632 struct b_jffs2_info info;
1636 if (! (pl = jffs2_get_list(part, "info")))
1639 jffs2_1pass_fill_info(pl, &info);
1640 for (i = 0; i < JFFS2_NUM_COMPR; i++) {
1641 printf ("Compression: %s\n"
1642 "\tfrag count: %d\n"
1643 "\tcompressed sum: %d\n"
1644 "\tuncompressed sum: %d\n",
1646 info.compr_info[i].num_frags,
1647 info.compr_info[i].compr_sum,
1648 info.compr_info[i].decompr_sum);