2 * cramfsck - check a cramfs file system
4 * Copyright (C) 2000-2002 Transmeta Corporation
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 * 1999/12/03: Linus Torvalds (cramfs tester and unarchive program)
22 * 2000/06/03: Daniel Quinlan (CRC and length checking program)
23 * 2000/06/04: Daniel Quinlan (merged programs, added options, support
24 * for special files, preserve permissions and
25 * ownership, cramfs superblock v2, bogus mode
26 * test, pathname length test, etc.)
27 * 2000/06/06: Daniel Quinlan (support for holes, pretty-printing,
29 * 2000/07/11: Daniel Quinlan (file length tests, start at offset 0 or 512,
30 * fsck-compatible exit codes)
31 * 2000/07/15: Daniel Quinlan (initial support for block devices)
32 * 2002/01/10: Daniel Quinlan (additional checks, test more return codes,
33 * use read if mmap fails, standardize messages)
48 /* We don't use our include/crc32.h, but crc32 from zlib!
50 * The zlib implemenation performs pre/post-conditioning. The util-linux
51 * imlemenation requires post-conditioning (xor) in the applications.
55 #include <sys/types.h>
63 #include "exitcodes.h"
65 #include "closestream.h"
67 #define XALLOC_EXIT_CODE FSCK_EX_ERROR
70 static int fd
; /* ROM image file descriptor */
71 static char *filename
; /* ROM image filename */
72 static struct cramfs_super super
; /* just find the cramfs superblock once */
73 static int cramfs_is_big_endian
= 0; /* source is big endian */
74 static int opt_verbose
= 0; /* 1 = verbose (-v), 2+ = very verbose (-vv) */
75 static int opt_extract
= 0; /* extract cramfs (-x) */
76 static char *extract_dir
= ""; /* optional extraction directory (-x) */
80 static uid_t euid
; /* effective UID */
82 /* (cramfs_super + start) <= start_dir < end_dir <= start_data <= end_data */
83 static unsigned long start_dir
= ~0UL; /* start of first non-root inode */
84 static unsigned long end_dir
= 0; /* end of the directory structure */
85 static unsigned long start_data
= ~0UL; /* start of the data (256 MB = max) */
86 static unsigned long end_data
= 0; /* end of the data */
89 /* Guarantee access to at least 8kB at a time */
90 #define ROMBUFFER_BITS 13
91 #define ROMBUFFERSIZE (1 << ROMBUFFER_BITS)
92 #define ROMBUFFERMASK (ROMBUFFERSIZE - 1)
93 static char read_buffer
[ROMBUFFERSIZE
* 2];
94 static unsigned long read_buffer_block
= ~0UL;
96 static z_stream stream
;
99 static void expand_fs(char *, struct cramfs_inode
*);
101 static char *outbuffer
;
103 static size_t blksize
= 0;
105 static void __attribute__((__noreturn__
)) usage(void)
109 fputs(USAGE_HEADER
, out
);
111 _(" %s [options] <file>\n"), program_invocation_short_name
);
113 fputs(USAGE_SEPARATOR
, out
);
114 fputs(_("Check and repair a compressed ROM filesystem.\n"), out
);
116 fputs(USAGE_OPTIONS
, out
);
117 fputs(_(" -a for compatibility only, ignored\n"), out
);
118 fputs(_(" -v, --verbose be more verbose\n"), out
);
119 fputs(_(" -y for compatibility only, ignored\n"), out
);
120 fputs(_(" -b, --blocksize <size> use this blocksize, defaults to page size\n"), out
);
121 fputs(_(" --extract[=<dir>] test uncompression, optionally extract into <dir>\n"), out
);
122 fputs(USAGE_SEPARATOR
, out
);
123 printf(USAGE_HELP_OPTIONS(26));
125 printf(USAGE_MAN_TAIL("fsck.cramfs(8)"));
129 static int get_superblock_endianness(uint32_t magic
)
131 if (magic
== CRAMFS_MAGIC
) {
132 cramfs_is_big_endian
= HOST_IS_BIG_ENDIAN
;
135 u32_toggle_endianness(!HOST_IS_BIG_ENDIAN
, CRAMFS_MAGIC
)) {
136 cramfs_is_big_endian
= !HOST_IS_BIG_ENDIAN
;
142 static void test_super(int *start
, size_t * length
)
146 /* find the physical size of the file or block device */
147 if (stat(filename
, &st
) < 0)
148 err(FSCK_EX_ERROR
, _("stat of %s failed"), filename
);
150 fd
= open(filename
, O_RDONLY
);
152 err(FSCK_EX_ERROR
, _("cannot open %s"), filename
);
154 if (S_ISBLK(st
.st_mode
)) {
155 unsigned long long bytes
;
156 if (blkdev_get_size(fd
, &bytes
))
158 _("ioctl failed: unable to determine device size: %s"),
161 } else if (S_ISREG(st
.st_mode
))
162 *length
= st
.st_size
;
164 errx(FSCK_EX_ERROR
, _("not a block device or file: %s"), filename
);
166 if (*length
< sizeof(struct cramfs_super
))
167 errx(FSCK_EX_UNCORRECTED
, _("file length too short"));
169 /* find superblock */
170 if (read(fd
, &super
, sizeof(super
)) != sizeof(super
))
171 err(FSCK_EX_ERROR
, _("cannot read %s"), filename
);
172 if (get_superblock_endianness(super
.magic
) != -1)
174 else if (*length
>= (PAD_SIZE
+ sizeof(super
))) {
175 if (lseek(fd
, PAD_SIZE
, SEEK_SET
) == (off_t
) -1)
176 err(FSCK_EX_ERROR
, _("seek on %s failed"), filename
);
177 if (read(fd
, &super
, sizeof(super
)) != sizeof(super
))
178 err(FSCK_EX_ERROR
, _("cannot read %s"), filename
);
179 if (get_superblock_endianness(super
.magic
) != -1)
182 errx(FSCK_EX_UNCORRECTED
, _("superblock magic not found"));
184 errx(FSCK_EX_UNCORRECTED
, _("superblock magic not found"));
187 printf(_("cramfs endianness is %s\n"),
188 cramfs_is_big_endian
? _("big") : _("little"));
190 super_toggle_endianness(cramfs_is_big_endian
, &super
);
191 if (super
.flags
& ~CRAMFS_SUPPORTED_FLAGS
)
192 errx(FSCK_EX_ERROR
, _("unsupported filesystem features"));
194 /* What are valid superblock sizes? */
195 if (super
.size
< *start
+ sizeof(struct cramfs_super
))
196 errx(FSCK_EX_UNCORRECTED
, _("superblock size (%d) too small"),
199 if (super
.flags
& CRAMFS_FLAG_FSID_VERSION_2
) {
200 if (super
.fsid
.files
== 0)
201 errx(FSCK_EX_UNCORRECTED
, _("zero file count"));
202 if (*length
< super
.size
)
203 errx(FSCK_EX_UNCORRECTED
, _("file length too short"));
204 else if (*length
> super
.size
)
205 warnx(_("file extends past end of filesystem"));
207 warnx(_("old cramfs format"));
210 static void test_crc(int start
)
215 if (!(super
.flags
& CRAMFS_FLAG_FSID_VERSION_2
)) {
216 warnx(_("unable to test CRC: old cramfs format"));
220 crc
= crc32(0L, NULL
, 0);
223 mmap(NULL
, super
.size
, PROT_READ
| PROT_WRITE
, MAP_PRIVATE
, fd
, 0);
224 if (buf
== MAP_FAILED
) {
226 mmap(NULL
, super
.size
, PROT_READ
| PROT_WRITE
,
227 MAP_PRIVATE
| MAP_ANONYMOUS
, -1, 0);
228 if (buf
!= MAP_FAILED
) {
229 if (lseek(fd
, 0, SEEK_SET
) == (off_t
) -1)
230 err(FSCK_EX_ERROR
, _("seek on %s failed"), filename
);
231 if (read(fd
, buf
, super
.size
) != (ssize_t
) super
.size
)
232 err(FSCK_EX_ERROR
, _("cannot read %s"), filename
);
235 if (buf
!= MAP_FAILED
) {
236 ((struct cramfs_super
*)((unsigned char *) buf
+ start
))->fsid
.crc
=
238 crc
= crc32(crc
, (unsigned char *) buf
+ start
, super
.size
- start
);
239 munmap(buf
, super
.size
);
245 if (lseek(fd
, start
, SEEK_SET
) == (off_t
) -1)
246 err(FSCK_EX_ERROR
, _("seek on %s failed"), filename
);
248 retval
= read(fd
, buf
, 4096);
250 err(FSCK_EX_ERROR
, _("cannot read %s"), filename
);
251 else if (retval
== 0)
254 ((struct cramfs_super
*)buf
)->fsid
.crc
=
257 if (length
> (super
.size
- start
)) {
258 crc
= crc32(crc
, buf
,
260 (super
.size
- start
)));
263 crc
= crc32(crc
, buf
, retval
);
268 if (crc
!= super
.fsid
.crc
)
269 errx(FSCK_EX_UNCORRECTED
, _("crc error"));
272 static void print_node(char type
, struct cramfs_inode
*i
, char *name
)
276 if (S_ISCHR(i
->mode
) || (S_ISBLK(i
->mode
)))
277 /* major/minor numbers can be as high as 2^12 or 4096 */
278 snprintf(info
, 10, "%4d,%4d", major(i
->size
), minor(i
->size
));
280 /* size be as high as 2^24 or 16777216 */
281 snprintf(info
, 10, "%9d", i
->size
);
283 printf("%c %04o %s %5d:%-3d %s\n",
284 type
, i
->mode
& ~S_IFMT
, info
, i
->uid
, i
->gid
,
285 !*name
&& type
== 'd' ? "/" : name
);
289 * Create a fake "blocked" access
291 static void *romfs_read(unsigned long offset
)
293 unsigned int block
= offset
>> ROMBUFFER_BITS
;
294 if (block
!= read_buffer_block
) {
297 read_buffer_block
= block
;
298 if (lseek(fd
, block
<< ROMBUFFER_BITS
, SEEK_SET
) == (off_t
) -1)
299 warn(_("seek failed"));
301 x
= read(fd
, read_buffer
, ROMBUFFERSIZE
* 2);
303 warn(_("read romfs failed"));
305 return read_buffer
+ (offset
& ROMBUFFERMASK
);
308 static struct cramfs_inode
*cramfs_iget(struct cramfs_inode
*i
)
310 struct cramfs_inode
*inode
= xmalloc(sizeof(struct cramfs_inode
));
312 inode_to_host(cramfs_is_big_endian
, i
, inode
);
316 static struct cramfs_inode
*iget(unsigned int ino
)
318 return cramfs_iget(romfs_read(ino
));
321 static void iput(struct cramfs_inode
*inode
)
327 * Return the offset of the root directory
329 static struct cramfs_inode
*read_super(void)
331 struct cramfs_inode
*root
= cramfs_iget(&super
.root
);
332 unsigned long offset
= root
->offset
<< 2;
334 if (!S_ISDIR(root
->mode
))
335 errx(FSCK_EX_UNCORRECTED
, _("root inode is not directory"));
336 if (!(super
.flags
& CRAMFS_FLAG_SHIFTED_ROOT_OFFSET
) &&
337 ((offset
!= sizeof(struct cramfs_super
)) &&
338 (offset
!= PAD_SIZE
+ sizeof(struct cramfs_super
)))) {
339 errx(FSCK_EX_UNCORRECTED
, _("bad root offset (%lu)"), offset
);
344 static int uncompress_block(void *src
, size_t len
)
348 stream
.next_in
= src
;
349 stream
.avail_in
= len
;
351 stream
.next_out
= (unsigned char *)outbuffer
;
352 stream
.avail_out
= blksize
* 2;
354 inflateReset(&stream
);
356 if (len
> blksize
* 2)
357 errx(FSCK_EX_UNCORRECTED
, _("data block too large"));
359 err
= inflate(&stream
, Z_FINISH
);
360 if (err
!= Z_STREAM_END
)
361 errx(FSCK_EX_UNCORRECTED
, _("decompression error: %s"),
363 return stream
.total_out
;
370 static void do_uncompress(char *path
, int outfd
, unsigned long offset
,
373 unsigned long curr
= offset
+ 4 * ((size
+ blksize
- 1) / blksize
);
376 unsigned long out
= blksize
;
377 unsigned long next
= u32_toggle_endianness(cramfs_is_big_endian
,
387 printf(_(" hole at %lu (%zu)\n"), curr
,
391 memset(outbuffer
, 0x00, out
);
394 printf(_(" uncompressing block at %lu to %lu (%lu)\n"),
395 curr
, next
, next
- curr
);
396 out
= uncompress_block(romfs_read(curr
), next
- curr
);
398 if (size
>= blksize
) {
400 errx(FSCK_EX_UNCORRECTED
,
401 _("non-block (%ld) bytes"), out
);
404 errx(FSCK_EX_UNCORRECTED
,
405 _("non-size (%ld vs %ld) bytes"), out
,
409 if (*extract_dir
!= '\0' && write(outfd
, outbuffer
, out
) < 0)
410 err(FSCK_EX_ERROR
, _("write failed: %s"), path
);
415 static void change_file_status(char *path
, struct cramfs_inode
*i
)
417 struct utimbuf epoch
= { 0, 0 };
420 if (lchown(path
, i
->uid
, i
->gid
) < 0)
421 err(FSCK_EX_ERROR
, _("lchown failed: %s"), path
);
422 if (S_ISLNK(i
->mode
))
424 if (((S_ISUID
| S_ISGID
) & i
->mode
) && chmod(path
, i
->mode
) < 0)
425 err(FSCK_EX_ERROR
, _("chown failed: %s"), path
);
427 if (S_ISLNK(i
->mode
))
429 if (utime(path
, &epoch
) < 0)
430 err(FSCK_EX_ERROR
, _("utime failed: %s"), path
);
433 static void do_directory(char *path
, struct cramfs_inode
*i
)
435 int pathlen
= strlen(path
);
437 unsigned long offset
= i
->offset
<< 2;
438 char *newpath
= xmalloc(pathlen
+ 256);
440 if (offset
== 0 && count
!= 0)
441 errx(FSCK_EX_UNCORRECTED
,
442 _("directory inode has zero offset and non-zero size: %s"),
445 if (offset
!= 0 && offset
< start_dir
)
448 /* TODO: Do we need to check end_dir for empty case? */
449 memcpy(newpath
, path
, pathlen
);
450 newpath
[pathlen
] = '/';
453 print_node('d', i
, path
);
455 if (*extract_dir
!= '\0') {
456 if (mkdir(path
, i
->mode
) < 0)
457 err(FSCK_EX_ERROR
, _("mkdir failed: %s"), path
);
458 change_file_status(path
, i
);
461 struct cramfs_inode
*child
= iget(offset
);
463 int newlen
= child
->namelen
<< 2;
465 size
= sizeof(struct cramfs_inode
) + newlen
;
468 offset
+= sizeof(struct cramfs_inode
);
470 memcpy(newpath
+ pathlen
, romfs_read(offset
), newlen
);
471 newpath
[pathlen
+ newlen
] = 0;
473 errx(FSCK_EX_UNCORRECTED
, _("filename length is zero"));
474 if ((pathlen
+ newlen
) - strlen(newpath
) > 3)
475 errx(FSCK_EX_UNCORRECTED
, _("bad filename length"));
476 expand_fs(newpath
, child
);
480 if (offset
<= start_dir
)
481 errx(FSCK_EX_UNCORRECTED
, _("bad inode offset"));
482 if (offset
> end_dir
)
484 iput(child
); /* free(child) */
489 static void do_file(char *path
, struct cramfs_inode
*i
)
491 unsigned long offset
= i
->offset
<< 2;
494 if (offset
== 0 && i
->size
!= 0)
495 errx(FSCK_EX_UNCORRECTED
,
496 _("file inode has zero offset and non-zero size"));
497 if (i
->size
== 0 && offset
!= 0)
498 errx(FSCK_EX_UNCORRECTED
,
499 _("file inode has zero size and non-zero offset"));
500 if (offset
!= 0 && offset
< start_data
)
503 print_node('f', i
, path
);
504 if (*extract_dir
!= '\0') {
505 outfd
= open(path
, O_WRONLY
| O_CREAT
| O_TRUNC
, i
->mode
);
507 err(FSCK_EX_ERROR
, _("cannot open %s"), path
);
510 do_uncompress(path
, outfd
, offset
, i
->size
);
511 if ( *extract_dir
!= '\0') {
512 if (close_fd(outfd
) != 0)
513 err(FSCK_EX_ERROR
, _("write failed: %s"), path
);
514 change_file_status(path
, i
);
518 static void do_symlink(char *path
, struct cramfs_inode
*i
)
520 unsigned long offset
= i
->offset
<< 2;
521 unsigned long curr
= offset
+ 4;
523 u32_toggle_endianness(cramfs_is_big_endian
,
524 *(uint32_t *) romfs_read(offset
));
528 errx(FSCK_EX_UNCORRECTED
, _("symbolic link has zero offset"));
530 errx(FSCK_EX_UNCORRECTED
, _("symbolic link has zero size"));
532 if (offset
< start_data
)
537 size
= uncompress_block(romfs_read(curr
), next
- curr
);
539 errx(FSCK_EX_UNCORRECTED
, _("size error in symlink: %s"), path
);
544 xasprintf(&str
, "%s -> %s", path
, outbuffer
);
545 print_node('l', i
, str
);
547 printf(_(" uncompressing block at %lu to %lu (%lu)\n"),
548 curr
, next
, next
- curr
);
551 if (*extract_dir
!= '\0') {
552 if (symlink(outbuffer
, path
) < 0)
553 err(FSCK_EX_ERROR
, _("symlink failed: %s"), path
);
554 change_file_status(path
, i
);
558 static void do_special_inode(char *path
, struct cramfs_inode
*i
)
564 /* no need to shift offset */
565 errx(FSCK_EX_UNCORRECTED
,
566 _("special file has non-zero offset: %s"), path
);
568 if (S_ISCHR(i
->mode
)) {
571 } else if (S_ISBLK(i
->mode
)) {
574 } else if (S_ISFIFO(i
->mode
)) {
576 errx(FSCK_EX_UNCORRECTED
, _("fifo has non-zero size: %s"),
579 } else if (S_ISSOCK(i
->mode
)) {
581 errx(FSCK_EX_UNCORRECTED
,
582 _("socket has non-zero size: %s"), path
);
585 errx(FSCK_EX_UNCORRECTED
, _("bogus mode: %s (%o)"), path
, i
->mode
);
586 return; /* not reached */
590 print_node(type
, i
, path
);
592 if (*extract_dir
!= '\0') {
593 if (mknod(path
, i
->mode
, devtype
) < 0)
594 err(FSCK_EX_ERROR
, _("mknod failed: %s"), path
);
595 change_file_status(path
, i
);
599 static void expand_fs(char *path
, struct cramfs_inode
*inode
)
601 if (S_ISDIR(inode
->mode
))
602 do_directory(path
, inode
);
603 else if (S_ISREG(inode
->mode
))
604 do_file(path
, inode
);
605 else if (S_ISLNK(inode
->mode
))
606 do_symlink(path
, inode
);
608 do_special_inode(path
, inode
);
611 static void test_fs(int start
)
613 struct cramfs_inode
*root
;
618 stream
.next_in
= NULL
;
620 inflateInit(&stream
);
621 expand_fs(extract_dir
, root
);
623 if (start_data
!= ~0UL) {
624 if (start_data
< (sizeof(struct cramfs_super
) + start
))
625 errx(FSCK_EX_UNCORRECTED
,
626 _("directory data start (%lu) < sizeof(struct cramfs_super) + start (%zu)"),
627 start_data
, sizeof(struct cramfs_super
) + start
);
628 if (end_dir
!= start_data
)
629 errx(FSCK_EX_UNCORRECTED
,
630 _("directory data end (%lu) != file data start (%lu)"),
631 end_dir
, start_data
);
633 if (super
.flags
& CRAMFS_FLAG_FSID_VERSION_2
&& end_data
> super
.size
)
634 errx(FSCK_EX_UNCORRECTED
, _("invalid file data offset"));
636 iput(root
); /* free(root) */
639 int main(int argc
, char **argv
)
641 int c
; /* for getopt */
645 static const struct option longopts
[] = {
646 {"verbose", no_argument
, NULL
, 'v'},
647 {"version", no_argument
, NULL
, 'V'},
648 {"help", no_argument
, NULL
, 'h'},
649 {"blocksize", required_argument
, NULL
, 'b'},
650 {"extract", optional_argument
, NULL
, 'x'},
654 setlocale(LC_MESSAGES
, "");
655 setlocale(LC_CTYPE
, "");
656 bindtextdomain(PACKAGE
, LOCALEDIR
);
658 atexit(close_stdout
);
660 strutils_set_exitcode(FSCK_EX_USAGE
);
662 /* command line options */
663 while ((c
= getopt_long(argc
, argv
, "ayvVhb:", longopts
, NULL
)) != EOF
)
665 case 'a': /* ignore */
672 printf(UTIL_LINUX_VERSION
);
677 extract_dir
= optarg
;
683 blksize
= strtou32_or_err(optarg
, _("invalid blocksize argument"));
686 errtryhelp(FSCK_EX_USAGE
);
689 if ((argc
- optind
) != 1){
690 warnx(_("bad usage"));
691 errtryhelp(FSCK_EX_USAGE
);
693 filename
= argv
[optind
];
695 test_super(&start
, &length
);
700 blksize
= getpagesize();
701 outbuffer
= xmalloc(blksize
* 2);
706 printf(_("%s: OK\n"), filename
);