1dd875c76Swdenk /*
2dd875c76Swdenk * cramfs.c
3dd875c76Swdenk *
4dd875c76Swdenk * Copyright (C) 1999 Linus Torvalds
5dd875c76Swdenk *
6dd875c76Swdenk * Copyright (C) 2000-2002 Transmeta Corporation
7dd875c76Swdenk *
8dd875c76Swdenk * Copyright (C) 2003 Kai-Uwe Bloem,
9dd875c76Swdenk * Auerswald GmbH & Co KG, <linux-development@auerswald.de>
10dd875c76Swdenk * - adapted from the www.tuxbox.org u-boot tree, added "ls" command
11dd875c76Swdenk *
12dd875c76Swdenk * This program is free software; you can redistribute it and/or modify
13dd875c76Swdenk * it under the terms of the GNU General Public License (Version 2) as
14dd875c76Swdenk * published by the Free Software Foundation.
15dd875c76Swdenk *
16dd875c76Swdenk * Compressed ROM filesystem for Linux.
17dd875c76Swdenk *
18dd875c76Swdenk * TODO:
19dd875c76Swdenk * add support for resolving symbolic links
20dd875c76Swdenk */
21dd875c76Swdenk
22dd875c76Swdenk /*
23dd875c76Swdenk * These are the VFS interfaces to the compressed ROM filesystem.
24dd875c76Swdenk * The actual compression is based on zlib, see the other files.
25dd875c76Swdenk */
26dd875c76Swdenk
27dd875c76Swdenk #include <common.h>
28dd875c76Swdenk #include <malloc.h>
29dd875c76Swdenk #include <asm/byteorder.h>
30dd875c76Swdenk #include <linux/stat.h>
31180d3f74Swdenk #include <jffs2/jffs2.h>
32dd875c76Swdenk #include <jffs2/load_kernel.h>
33180d3f74Swdenk #include <cramfs/cramfs_fs.h>
34dd875c76Swdenk
35dd875c76Swdenk /* These two macros may change in future, to provide better st_ino
36dd875c76Swdenk semantics. */
37dd875c76Swdenk #define CRAMINO(x) (CRAMFS_GET_OFFSET(x) ? CRAMFS_GET_OFFSET(x)<<2 : 1)
38dd875c76Swdenk #define OFFSET(x) ((x)->i_ino)
39dd875c76Swdenk
40dd875c76Swdenk struct cramfs_super super;
41dd875c76Swdenk
42700a0c64SWolfgang Denk /* CPU address space offset calculation macro, struct part_info offset is
43700a0c64SWolfgang Denk * device address space offset, so we need to shift it by a device start address. */
44e856bdcfSMasahiro Yamada #if defined(CONFIG_MTD_NOR_FLASH)
45e6f2e902SMarian Balakowicz extern flash_info_t flash_info[];
4606503f16SScott Wood #define PART_OFFSET(x) ((ulong)x->offset + \
4706503f16SScott Wood flash_info[x->dev->id->num].start[0])
4862a813bcSHeiko Schocher #else
4906503f16SScott Wood #define PART_OFFSET(x) ((ulong)x->offset)
5062a813bcSHeiko Schocher #endif
51700a0c64SWolfgang Denk
52*d39a0d2cSTyler Hall static int cramfs_uncompress (unsigned long begin, unsigned long offset,
53*d39a0d2cSTyler Hall unsigned long loadoffset);
54*d39a0d2cSTyler Hall
cramfs_read_super(struct part_info * info)55dd875c76Swdenk static int cramfs_read_super (struct part_info *info)
56dd875c76Swdenk {
57dd875c76Swdenk unsigned long root_offset;
58dd875c76Swdenk
59dd875c76Swdenk /* Read the first block and get the superblock from it */
60700a0c64SWolfgang Denk memcpy (&super, (void *) PART_OFFSET(info), sizeof (super));
61dd875c76Swdenk
62dd875c76Swdenk /* Do sanity checks on the superblock */
63dd875c76Swdenk if (super.magic != CRAMFS_32 (CRAMFS_MAGIC)) {
64dd875c76Swdenk /* check at 512 byte offset */
65700a0c64SWolfgang Denk memcpy (&super, (void *) PART_OFFSET(info) + 512, sizeof (super));
66dd875c76Swdenk if (super.magic != CRAMFS_32 (CRAMFS_MAGIC)) {
67dd875c76Swdenk printf ("cramfs: wrong magic\n");
68dd875c76Swdenk return -1;
69dd875c76Swdenk }
70dd875c76Swdenk }
71dd875c76Swdenk
72dd875c76Swdenk /* flags is reused several times, so swab it once */
73dd875c76Swdenk super.flags = CRAMFS_32 (super.flags);
74dd875c76Swdenk super.size = CRAMFS_32 (super.size);
75dd875c76Swdenk
76dd875c76Swdenk /* get feature flags first */
77dd875c76Swdenk if (super.flags & ~CRAMFS_SUPPORTED_FLAGS) {
78dd875c76Swdenk printf ("cramfs: unsupported filesystem features\n");
79dd875c76Swdenk return -1;
80dd875c76Swdenk }
81dd875c76Swdenk
82dd875c76Swdenk /* Check that the root inode is in a sane state */
83dd875c76Swdenk if (!S_ISDIR (CRAMFS_16 (super.root.mode))) {
84dd875c76Swdenk printf ("cramfs: root is not a directory\n");
85dd875c76Swdenk return -1;
86dd875c76Swdenk }
87dd875c76Swdenk root_offset = CRAMFS_GET_OFFSET (&(super.root)) << 2;
88dd875c76Swdenk if (root_offset == 0) {
89dd875c76Swdenk printf ("cramfs: empty filesystem");
90dd875c76Swdenk } else if (!(super.flags & CRAMFS_FLAG_SHIFTED_ROOT_OFFSET) &&
91dd875c76Swdenk ((root_offset != sizeof (struct cramfs_super)) &&
92dd875c76Swdenk (root_offset != 512 + sizeof (struct cramfs_super)))) {
93dd875c76Swdenk printf ("cramfs: bad root offset %lu\n", root_offset);
94dd875c76Swdenk return -1;
95dd875c76Swdenk }
96dd875c76Swdenk
97dd875c76Swdenk return 0;
98dd875c76Swdenk }
99dd875c76Swdenk
100*d39a0d2cSTyler Hall /* Unpack to an allocated buffer, trusting in the inode's size field. */
cramfs_uncompress_link(unsigned long begin,unsigned long offset)101*d39a0d2cSTyler Hall static char *cramfs_uncompress_link (unsigned long begin, unsigned long offset)
102*d39a0d2cSTyler Hall {
103*d39a0d2cSTyler Hall struct cramfs_inode *inode = (struct cramfs_inode *)(begin + offset);
104*d39a0d2cSTyler Hall unsigned long size = CRAMFS_24 (inode->size);
105*d39a0d2cSTyler Hall char *link = malloc (size + 1);
106*d39a0d2cSTyler Hall
107*d39a0d2cSTyler Hall if (!link || cramfs_uncompress (begin, offset, (unsigned long)link) != size) {
108*d39a0d2cSTyler Hall free (link);
109*d39a0d2cSTyler Hall link = NULL;
110*d39a0d2cSTyler Hall } else {
111*d39a0d2cSTyler Hall link[size] = '\0';
112*d39a0d2cSTyler Hall }
113*d39a0d2cSTyler Hall return link;
114*d39a0d2cSTyler Hall }
115*d39a0d2cSTyler Hall
cramfs_resolve(unsigned long begin,unsigned long offset,unsigned long size,int raw,char * filename)116700a0c64SWolfgang Denk static unsigned long cramfs_resolve (unsigned long begin, unsigned long offset,
117dd875c76Swdenk unsigned long size, int raw,
118dd875c76Swdenk char *filename)
119dd875c76Swdenk {
120dd875c76Swdenk unsigned long inodeoffset = 0, nextoffset;
121dd875c76Swdenk
122dd875c76Swdenk while (inodeoffset < size) {
123dd875c76Swdenk struct cramfs_inode *inode;
124dd875c76Swdenk char *name;
125dd875c76Swdenk int namelen;
126dd875c76Swdenk
127dd875c76Swdenk inode = (struct cramfs_inode *) (begin + offset +
128dd875c76Swdenk inodeoffset);
129dd875c76Swdenk
130dd875c76Swdenk /*
131dd875c76Swdenk * Namelengths on disk are shifted by two
132dd875c76Swdenk * and the name padded out to 4-byte boundaries
133dd875c76Swdenk * with zeroes.
134dd875c76Swdenk */
135dd875c76Swdenk namelen = CRAMFS_GET_NAMELEN (inode) << 2;
136dd875c76Swdenk name = (char *) inode + sizeof (struct cramfs_inode);
137dd875c76Swdenk
138dd875c76Swdenk nextoffset =
139dd875c76Swdenk inodeoffset + sizeof (struct cramfs_inode) + namelen;
140dd875c76Swdenk
141dd875c76Swdenk for (;;) {
142dd875c76Swdenk if (!namelen)
143dd875c76Swdenk return -1;
144dd875c76Swdenk if (name[namelen - 1])
145dd875c76Swdenk break;
146dd875c76Swdenk namelen--;
147dd875c76Swdenk }
148dd875c76Swdenk
149457dd025SHolger Brunck if (!strncmp(filename, name, namelen) &&
150457dd025SHolger Brunck (namelen == strlen(filename))) {
151dd875c76Swdenk char *p = strtok (NULL, "/");
152dd875c76Swdenk
153dd875c76Swdenk if (raw && (p == NULL || *p == '\0'))
154dd875c76Swdenk return offset + inodeoffset;
155dd875c76Swdenk
156dd875c76Swdenk if (S_ISDIR (CRAMFS_16 (inode->mode))) {
157dd875c76Swdenk return cramfs_resolve (begin,
158dd875c76Swdenk CRAMFS_GET_OFFSET
159dd875c76Swdenk (inode) << 2,
160dd875c76Swdenk CRAMFS_24 (inode->
161dd875c76Swdenk size), raw,
162dd875c76Swdenk p);
163dd875c76Swdenk } else if (S_ISREG (CRAMFS_16 (inode->mode))) {
164dd875c76Swdenk return offset + inodeoffset;
165*d39a0d2cSTyler Hall } else if (S_ISLNK (CRAMFS_16 (inode->mode))) {
166*d39a0d2cSTyler Hall unsigned long ret;
167*d39a0d2cSTyler Hall char *link;
168*d39a0d2cSTyler Hall if (p && strlen(p)) {
169*d39a0d2cSTyler Hall printf ("unsupported symlink to \
170*d39a0d2cSTyler Hall non-terminal path\n");
171*d39a0d2cSTyler Hall return 0;
172*d39a0d2cSTyler Hall }
173*d39a0d2cSTyler Hall link = cramfs_uncompress_link (begin,
174*d39a0d2cSTyler Hall offset + inodeoffset);
175*d39a0d2cSTyler Hall if (!link) {
176*d39a0d2cSTyler Hall printf ("%*.*s: Error reading link\n",
177*d39a0d2cSTyler Hall namelen, namelen, name);
178*d39a0d2cSTyler Hall return 0;
179*d39a0d2cSTyler Hall } else if (link[0] == '/') {
180*d39a0d2cSTyler Hall printf ("unsupported symlink to \
181*d39a0d2cSTyler Hall absolute path\n");
182*d39a0d2cSTyler Hall free (link);
183*d39a0d2cSTyler Hall return 0;
184*d39a0d2cSTyler Hall }
185*d39a0d2cSTyler Hall ret = cramfs_resolve (begin,
186*d39a0d2cSTyler Hall offset,
187*d39a0d2cSTyler Hall size,
188*d39a0d2cSTyler Hall raw,
189*d39a0d2cSTyler Hall strtok(link, "/"));
190*d39a0d2cSTyler Hall free (link);
191*d39a0d2cSTyler Hall return ret;
192dd875c76Swdenk } else {
193dd875c76Swdenk printf ("%*.*s: unsupported file type (%x)\n",
194dd875c76Swdenk namelen, namelen, name,
195dd875c76Swdenk CRAMFS_16 (inode->mode));
196dd875c76Swdenk return 0;
197dd875c76Swdenk }
198dd875c76Swdenk }
199dd875c76Swdenk
200dd875c76Swdenk inodeoffset = nextoffset;
201dd875c76Swdenk }
202dd875c76Swdenk
203dd875c76Swdenk printf ("can't find corresponding entry\n");
204dd875c76Swdenk return 0;
205dd875c76Swdenk }
206dd875c76Swdenk
cramfs_uncompress(unsigned long begin,unsigned long offset,unsigned long loadoffset)207700a0c64SWolfgang Denk static int cramfs_uncompress (unsigned long begin, unsigned long offset,
208dd875c76Swdenk unsigned long loadoffset)
209dd875c76Swdenk {
210dd875c76Swdenk struct cramfs_inode *inode = (struct cramfs_inode *) (begin + offset);
211a6ea791cSTyler Hall u32 *block_ptrs = (u32 *)
212dd875c76Swdenk (begin + (CRAMFS_GET_OFFSET (inode) << 2));
213dd875c76Swdenk unsigned long curr_block = (CRAMFS_GET_OFFSET (inode) +
214dd875c76Swdenk (((CRAMFS_24 (inode->size)) +
215dd875c76Swdenk 4095) >> 12)) << 2;
216dd875c76Swdenk int size, total_size = 0;
217dd875c76Swdenk int i;
218dd875c76Swdenk
219dd875c76Swdenk cramfs_uncompress_init ();
220dd875c76Swdenk
221dd875c76Swdenk for (i = 0; i < ((CRAMFS_24 (inode->size) + 4095) >> 12); i++) {
222dd875c76Swdenk size = cramfs_uncompress_block ((void *) loadoffset,
223dd875c76Swdenk (void *) (begin + curr_block),
224dd875c76Swdenk (CRAMFS_32 (block_ptrs[i]) -
225dd875c76Swdenk curr_block));
226dd875c76Swdenk if (size < 0)
227dd875c76Swdenk return size;
228dd875c76Swdenk loadoffset += size;
229dd875c76Swdenk total_size += size;
230dd875c76Swdenk curr_block = CRAMFS_32 (block_ptrs[i]);
231dd875c76Swdenk }
232dd875c76Swdenk
233dd875c76Swdenk cramfs_uncompress_exit ();
234dd875c76Swdenk return total_size;
235dd875c76Swdenk }
236dd875c76Swdenk
cramfs_load(char * loadoffset,struct part_info * info,char * filename)237dd875c76Swdenk int cramfs_load (char *loadoffset, struct part_info *info, char *filename)
238dd875c76Swdenk {
239dd875c76Swdenk unsigned long offset;
240dd875c76Swdenk
241dd875c76Swdenk if (cramfs_read_super (info))
242dd875c76Swdenk return -1;
243dd875c76Swdenk
244700a0c64SWolfgang Denk offset = cramfs_resolve (PART_OFFSET(info),
245dd875c76Swdenk CRAMFS_GET_OFFSET (&(super.root)) << 2,
246dd875c76Swdenk CRAMFS_24 (super.root.size), 0,
247dd875c76Swdenk strtok (filename, "/"));
248dd875c76Swdenk
249dd875c76Swdenk if (offset <= 0)
250dd875c76Swdenk return offset;
251dd875c76Swdenk
252700a0c64SWolfgang Denk return cramfs_uncompress (PART_OFFSET(info), offset,
253dd875c76Swdenk (unsigned long) loadoffset);
254dd875c76Swdenk }
255dd875c76Swdenk
cramfs_list_inode(struct part_info * info,unsigned long offset)256dd875c76Swdenk static int cramfs_list_inode (struct part_info *info, unsigned long offset)
257dd875c76Swdenk {
258dd875c76Swdenk struct cramfs_inode *inode = (struct cramfs_inode *)
259700a0c64SWolfgang Denk (PART_OFFSET(info) + offset);
260dd875c76Swdenk char *name, str[20];
261dd875c76Swdenk int namelen, nextoff;
262dd875c76Swdenk
263dd875c76Swdenk /*
264dd875c76Swdenk * Namelengths on disk are shifted by two
265dd875c76Swdenk * and the name padded out to 4-byte boundaries
266dd875c76Swdenk * with zeroes.
267dd875c76Swdenk */
268dd875c76Swdenk namelen = CRAMFS_GET_NAMELEN (inode) << 2;
269dd875c76Swdenk name = (char *) inode + sizeof (struct cramfs_inode);
270dd875c76Swdenk nextoff = namelen;
271dd875c76Swdenk
272dd875c76Swdenk for (;;) {
273dd875c76Swdenk if (!namelen)
274dd875c76Swdenk return namelen;
275dd875c76Swdenk if (name[namelen - 1])
276dd875c76Swdenk break;
277dd875c76Swdenk namelen--;
278dd875c76Swdenk }
279dd875c76Swdenk
280dd875c76Swdenk printf (" %s %8d %*.*s", mkmodestr (CRAMFS_16 (inode->mode), str),
281dd875c76Swdenk CRAMFS_24 (inode->size), namelen, namelen, name);
282dd875c76Swdenk
283dd875c76Swdenk if ((CRAMFS_16 (inode->mode) & S_IFMT) == S_IFLNK) {
284*d39a0d2cSTyler Hall char *link = cramfs_uncompress_link (PART_OFFSET(info), offset);
285*d39a0d2cSTyler Hall if (link)
286*d39a0d2cSTyler Hall printf (" -> %s\n", link);
287dd875c76Swdenk else
288dd875c76Swdenk printf (" [Error reading link]\n");
289dd875c76Swdenk free (link);
290dd875c76Swdenk } else
291dd875c76Swdenk printf ("\n");
292dd875c76Swdenk
293dd875c76Swdenk return nextoff;
294dd875c76Swdenk }
295dd875c76Swdenk
cramfs_ls(struct part_info * info,char * filename)296dd875c76Swdenk int cramfs_ls (struct part_info *info, char *filename)
297dd875c76Swdenk {
298dd875c76Swdenk struct cramfs_inode *inode;
299dd875c76Swdenk unsigned long inodeoffset = 0, nextoffset;
300dd875c76Swdenk unsigned long offset, size;
301dd875c76Swdenk
302dd875c76Swdenk if (cramfs_read_super (info))
303dd875c76Swdenk return -1;
304dd875c76Swdenk
305dd875c76Swdenk if (strlen (filename) == 0 || !strcmp (filename, "/")) {
306dd875c76Swdenk /* Root directory. Use root inode in super block */
307dd875c76Swdenk offset = CRAMFS_GET_OFFSET (&(super.root)) << 2;
308dd875c76Swdenk size = CRAMFS_24 (super.root.size);
309dd875c76Swdenk } else {
310dd875c76Swdenk /* Resolve the path */
311700a0c64SWolfgang Denk offset = cramfs_resolve (PART_OFFSET(info),
312dd875c76Swdenk CRAMFS_GET_OFFSET (&(super.root)) <<
313dd875c76Swdenk 2, CRAMFS_24 (super.root.size), 1,
314dd875c76Swdenk strtok (filename, "/"));
315dd875c76Swdenk
316dd875c76Swdenk if (offset <= 0)
317dd875c76Swdenk return offset;
318dd875c76Swdenk
319dd875c76Swdenk /* Resolving was successful. Examine the inode */
320700a0c64SWolfgang Denk inode = (struct cramfs_inode *) (PART_OFFSET(info) + offset);
321dd875c76Swdenk if (!S_ISDIR (CRAMFS_16 (inode->mode))) {
322dd875c76Swdenk /* It's not a directory - list it, and that's that */
323dd875c76Swdenk return (cramfs_list_inode (info, offset) > 0);
324dd875c76Swdenk }
325dd875c76Swdenk
326dd875c76Swdenk /* It's a directory. List files within */
327dd875c76Swdenk offset = CRAMFS_GET_OFFSET (inode) << 2;
328dd875c76Swdenk size = CRAMFS_24 (inode->size);
329dd875c76Swdenk }
330dd875c76Swdenk
331dd875c76Swdenk /* List the given directory */
332dd875c76Swdenk while (inodeoffset < size) {
333700a0c64SWolfgang Denk inode = (struct cramfs_inode *) (PART_OFFSET(info) + offset +
334dd875c76Swdenk inodeoffset);
335dd875c76Swdenk
336dd875c76Swdenk nextoffset = cramfs_list_inode (info, offset + inodeoffset);
337dd875c76Swdenk if (nextoffset == 0)
338dd875c76Swdenk break;
339dd875c76Swdenk inodeoffset += sizeof (struct cramfs_inode) + nextoffset;
340dd875c76Swdenk }
341dd875c76Swdenk
342dd875c76Swdenk return 1;
343dd875c76Swdenk }
344dd875c76Swdenk
cramfs_info(struct part_info * info)345dd875c76Swdenk int cramfs_info (struct part_info *info)
346dd875c76Swdenk {
347dd875c76Swdenk if (cramfs_read_super (info))
348dd875c76Swdenk return 0;
349dd875c76Swdenk
350dd875c76Swdenk printf ("size: 0x%x (%u)\n", super.size, super.size);
351dd875c76Swdenk
352dd875c76Swdenk if (super.flags != 0) {
353dd875c76Swdenk printf ("flags:\n");
354dd875c76Swdenk if (super.flags & CRAMFS_FLAG_FSID_VERSION_2)
355dd875c76Swdenk printf ("\tFSID version 2\n");
356dd875c76Swdenk if (super.flags & CRAMFS_FLAG_SORTED_DIRS)
357dd875c76Swdenk printf ("\tsorted dirs\n");
358dd875c76Swdenk if (super.flags & CRAMFS_FLAG_HOLES)
359dd875c76Swdenk printf ("\tholes\n");
360dd875c76Swdenk if (super.flags & CRAMFS_FLAG_SHIFTED_ROOT_OFFSET)
361dd875c76Swdenk printf ("\tshifted root offset\n");
362dd875c76Swdenk }
363dd875c76Swdenk
364dd875c76Swdenk printf ("fsid:\n\tcrc: 0x%x\n\tedition: 0x%x\n",
365dd875c76Swdenk super.fsid.crc, super.fsid.edition);
366dd875c76Swdenk printf ("name: %16s\n", super.name);
367dd875c76Swdenk
368dd875c76Swdenk return 1;
369dd875c76Swdenk }
370dd875c76Swdenk
cramfs_check(struct part_info * info)371dd875c76Swdenk int cramfs_check (struct part_info *info)
372dd875c76Swdenk {
373700a0c64SWolfgang Denk struct cramfs_super *sb;
374dd875c76Swdenk
375700a0c64SWolfgang Denk if (info->dev->id->type != MTD_DEV_TYPE_NOR)
376700a0c64SWolfgang Denk return 0;
377700a0c64SWolfgang Denk
378700a0c64SWolfgang Denk sb = (struct cramfs_super *) PART_OFFSET(info);
379dd875c76Swdenk if (sb->magic != CRAMFS_32 (CRAMFS_MAGIC)) {
380dd875c76Swdenk /* check at 512 byte offset */
381700a0c64SWolfgang Denk sb = (struct cramfs_super *) (PART_OFFSET(info) + 512);
382700a0c64SWolfgang Denk if (sb->magic != CRAMFS_32 (CRAMFS_MAGIC))
383dd875c76Swdenk return 0;
384dd875c76Swdenk }
385dd875c76Swdenk return 1;
386dd875c76Swdenk }
387