Home | History | Annotate | Download | only in misc
      1 /*
      2  * findsuper --- quick hacked up program to find ext2 superblocks.
      3  *
      4  * This is a hack, and really shouldn't be installed anywhere.  If you
      5  * need a program which does this sort of functionality, please try
      6  * using gpart program.
      7  *
      8  * Portions Copyright 1998-2000, Theodore Ts'o.
      9  *
     10  * Well, here's my linux version of findsuper.
     11  * I'm sure you coulda done it faster.  :)
     12  * IMHO there isn't as much interesting data to print in the
     13  * linux superblock as there is in the SunOS superblock--disk geometry is
     14  * not there...and linux seems to update the dates in all the superblocks.
     15  * SunOS doesn't ever touch the backup superblocks after the fs is created,
     16  * as far as I can tell, so the date is more interesting IMHO and certainly
     17  * marks which superblocks are backup ones.
     18  *
     19  * I wanted to add msdos support, but I couldn't make heads or tails
     20  * of the kernel include files to find anything I could look for in msdos.
     21  *
     22  * Reading every block of a Sun partition is fairly quick.  Doing the
     23  * same under linux (slower hardware I suppose) just isn't the same.
     24  * It might be more useful to default to reading the first (second?) block
     25  * on each cyl; however, if the disk geometry is wrong, this is useless.
     26  * But ya could still get the cyl size to print the numbers as cyls instead
     27  * of blocks...
     28  *
     29  * run this as (for example)
     30  *   findsuper /dev/hda
     31  *   findsuper /dev/hda 437760 1024   (my disk has cyls of 855*512)
     32  *
     33  * I suppose the next step is to figgure out a way to determine if
     34  * the block found is the first superblock somehow, and if so, build
     35  * a partition table from the superblocks found... but this is still
     36  * useful as is.
     37  *
     38  *		Steve
     39  * ssd (at) nevets.oau.org
     40  * ssd (at) mae.engr.ucf.edu
     41  *
     42  * Additional notes by Andreas Dilger <adilger (at) turbolinux.com>:
     43  * - fixed to support > 2G devices by using lseek64
     44  * - add reliability checking for the superblock to avoid random garbage
     45  * - add adaptive progress meter
     46  *
     47  * It _should_ also handle signals and tell you the ending block, so
     48  * that you can resume at a later time, but it doesn't yet...
     49  *
     50  * Note that gpart does not appear to find all superblocks that aren't aligned
     51  * with the start of a possible partition, so it is not useful in systems
     52  * with LVM or similar setups which don't use fat partition alignment.
     53  *
     54  * %Begin-Header%
     55  * This file may be redistributed under the terms of the GNU Public
     56  * License.
     57  * %End-Header%
     58  */
     59 
     60 /*
     61  * Documentation addendum added by Andreas dwguest (at) win.tue.nl/aeb (at) cwi.nl
     62  *
     63  * The program findsuper is a utility that scans a disk and finds
     64  * copies of ext2 superblocks (by checking for the ext2 signature).
     65  *
     66  * For each superblock found, it prints the offset in bytes, the
     67  * offset in 1024-byte blocks, the size of the ext2 partition in fs
     68  * blocks, the filesystem blocksize (in bytes), the block group number
     69  * (always 0 for older ext2 systems), and a timestamp (s_mtime).
     70  *
     71  * This program can be used to retrieve partitions that have been
     72  * lost.  The superblock for block group 0 is found 1 block (2
     73  * sectors) after the partition start.
     74  *
     75  * For new systems that have a block group number in the superblock it
     76  * is immediately clear which superblock is the first of a partition.
     77  * For old systems where no group numbers are given, the first
     78  * superblock can be recognised by the timestamp: all superblock
     79  * copies have the creation time in s_mtime, except the first, which
     80  * has the last time e2fsck or tune2fs wrote to the filesystem.
     81  *
     82  */
     83 
     84 #define _FILE_OFFSET_BITS 64
     85 
     86 #include <stdio.h>
     87 #include <stdlib.h>
     88 #include <string.h>
     89 #include <unistd.h>
     90 #include <errno.h>
     91 #include <fcntl.h>
     92 #include <time.h>
     93 
     94 #include "ext2fs/ext2_fs.h"
     95 #include "nls-enable.h"
     96 
     97 #undef DEBUG
     98 
     99 #ifdef DEBUG
    100 #define WHY(fmt, arg...) { printf("\r%Ld: " fmt, sk, ##arg) ; continue; }
    101 #else
    102 #define WHY(fmt, arg...) { continue; }
    103 #endif
    104 
    105 static void usage(void)
    106 {
    107 	fprintf(stderr,
    108 		_("Usage:  findsuper device [skipbytes [startkb]]\n"));
    109 	exit(1);
    110 }
    111 
    112 
    113 int main(int argc, char *argv[])
    114 {
    115 	int skiprate=512;		/* one sector */
    116 	loff_t sk=0, skl=0;
    117 	int fd;
    118 	char *s;
    119 	time_t tm, last = time(0);
    120 	loff_t interval = 1024 * 1024;
    121 	int c, print_jnl_copies = 0;
    122 	const char * device_name;
    123 	struct ext2_super_block ext2;
    124 	/* interesting fields: EXT2_SUPER_MAGIC
    125 	 *      s_blocks_count s_log_block_size s_mtime s_magic s_lastcheck */
    126 
    127 #ifdef ENABLE_NLS
    128 	setlocale(LC_MESSAGES, "");
    129 	setlocale(LC_CTYPE, "");
    130 	bindtextdomain(NLS_CAT_NAME, LOCALEDIR);
    131 	textdomain(NLS_CAT_NAME);
    132 #endif
    133 
    134 	while ((c = getopt (argc, argv, "j")) != EOF) {
    135 		switch (c) {
    136 		case 'j':
    137 			print_jnl_copies++;
    138 			break;
    139 		default:
    140 			usage();
    141 		}
    142 	}
    143 
    144 	if (optind == argc)
    145 		usage();
    146 
    147 	device_name = argv[optind++];
    148 
    149 	if (optind < argc) {
    150 		skiprate = strtol(argv[optind], &s, 0);
    151 		if (s == argv[optind]) {
    152 			fprintf(stderr,_("skipbytes should be a number, not %s\n"), s);
    153 			exit(1);
    154 		}
    155 		optind++;
    156 	}
    157 	if (skiprate & 0x1ff) {
    158 		fprintf(stderr,
    159 			_("skipbytes must be a multiple of the sector size\n"));
    160 		exit(2);
    161 	}
    162 	if (optind < argc) {
    163 		sk = skl = strtoll(argv[optind], &s, 0) << 10;
    164 		if (s == argv[optind]) {
    165 			fprintf(stderr,
    166 				_("startkb should be a number, not %s\n"), s);
    167 			exit(1);
    168 		}
    169 		optind++;
    170 	}
    171 	if (sk < 0) {
    172 		fprintf(stderr, _("startkb should be positive, not %Lu\n"), sk);
    173 		exit(1);
    174 	}
    175 
    176 	fd = open(device_name, O_RDONLY);
    177 	if (fd < 0) {
    178 		perror(device_name);
    179 		exit(1);
    180 	}
    181 
    182 	/* Now, go looking for the superblock! */
    183 	printf(_("starting at %Lu, with %u byte increments\n"), sk, skiprate);
    184 	if (print_jnl_copies)
    185 		printf(_("[*] probably superblock written in the ext3 "
    186 			 "journal superblock,\n\tso start/end/grp wrong\n"));
    187 	printf(_("byte_offset  byte_start     byte_end  fs_blocks blksz  grp  last_mount_time           sb_uuid label\n"));
    188 	for (; lseek64(fd, sk, SEEK_SET) != -1 &&
    189 	       read(fd, &ext2, 512) == 512; sk += skiprate) {
    190 		static unsigned char last_uuid[16] = "blah";
    191 		unsigned long long bsize, grpsize;
    192 		int jnl_copy, sb_offset;
    193 
    194 		if (sk && !(sk & (interval - 1))) {
    195 			time_t now, diff;
    196 
    197 			now = time(0);
    198 			diff = now - last;
    199 
    200 			if (diff > 0) {
    201 				s = ctime(&now);
    202 				s[24] = 0;
    203 				printf("\r%11Lu: %8LukB/s @ %s", sk,
    204 				       (((sk - skl)) / diff) >> 10, s);
    205 				fflush(stdout);
    206 			}
    207 			if (diff < 5)
    208 				interval <<= 1;
    209 			else if (diff > 20)
    210 				interval >>= 1;
    211 			last = now;
    212 			skl = sk;
    213 		}
    214 		if (ext2.s_magic != EXT2_SUPER_MAGIC)
    215 			continue;
    216 		if (ext2.s_log_block_size > 6)
    217 			WHY("log block size > 6 (%u)\n", ext2.s_log_block_size);
    218 		if (ext2.s_r_blocks_count > ext2.s_blocks_count)
    219 			WHY("r_blocks_count > blocks_count (%u > %u)\n",
    220 			    ext2.s_r_blocks_count, ext2.s_blocks_count);
    221 		if (ext2.s_free_blocks_count > ext2.s_blocks_count)
    222 			WHY("free_blocks_count > blocks_count\n (%u > %u)\n",
    223 			    ext2.s_free_blocks_count, ext2.s_blocks_count);
    224 		if (ext2.s_free_inodes_count > ext2.s_inodes_count)
    225 			WHY("free_inodes_count > inodes_count (%u > %u)\n",
    226 			    ext2.s_free_inodes_count, ext2.s_inodes_count);
    227 
    228 		tm = ext2.s_mtime;
    229 		s = ctime(&tm);
    230 		s[24] = 0;
    231 		bsize = 1 << (ext2.s_log_block_size + 10);
    232 		grpsize = bsize * ext2.s_blocks_per_group;
    233 		if (memcmp(ext2.s_uuid, last_uuid, sizeof(last_uuid)) == 0 &&
    234 		    ext2.s_rev_level > 0 && ext2.s_block_group_nr == 0) {
    235 			jnl_copy = 1;
    236 		} else {
    237 			jnl_copy = 0;
    238 			memcpy(last_uuid, ext2.s_uuid, sizeof(last_uuid));
    239 		}
    240 		if (ext2.s_block_group_nr == 0 || bsize == 1024)
    241 			sb_offset = 1024;
    242 		else
    243 			sb_offset = 0;
    244 		if (jnl_copy && !print_jnl_copies)
    245 			continue;
    246 		printf("\r%11Lu %11Lu%s %11Lu%s %9u %5Lu %4u%s %s %02x%02x%02x%02x %s\n",
    247 		       sk, sk - ext2.s_block_group_nr * grpsize - sb_offset,
    248 		       jnl_copy ? "*":" ",
    249 		       sk + ext2.s_blocks_count * bsize -
    250 		            ext2.s_block_group_nr * grpsize - sb_offset,
    251 		       jnl_copy ? "*" : " ", ext2.s_blocks_count, bsize,
    252 		       ext2.s_block_group_nr, jnl_copy ? "*" : " ", s,
    253 		       ext2.s_uuid[0], ext2.s_uuid[1],
    254 		       ext2.s_uuid[2], ext2.s_uuid[3], ext2.s_volume_name);
    255 	}
    256 	printf(_("\n%11Lu: finished with errno %d\n"), sk, errno);
    257 	close(fd);
    258 
    259 	return errno;
    260 }
    261