2 * e2image.c --- Program which writes an image file backing up
3 * critical metadata for the filesystem.
5 * Copyright 2000, 2001 by Theodore Ts'o.
8 * This file may be redistributed under the terms of the GNU Public
13 #define _LARGEFILE_SOURCE
14 #define _LARGEFILE64_SOURCE
33 #include <sys/types.h>
35 #include "ext2fs/ext2_fs.h"
36 #include "ext2fs/ext2fs.h"
37 #include "et/com_err.h"
38 #include "uuid/uuid.h"
40 #include "ext2fs/e2image.h"
42 #include "../version.h"
43 #include "nls-enable.h"
45 const char * program_name = "e2image";
46 char * device_name = NULL;
48 static void usage(void)
50 fprintf(stderr, _("Usage: %s [-r] device file\n"), program_name);
54 static void write_header(int fd, struct ext2_image_hdr *hdr, int blocksize)
59 header_buf = malloc(blocksize);
61 fprintf(stderr, _("Couldn't allocate header buffer\n"));
65 if (lseek(fd, 0, SEEK_SET) < 0) {
66 perror("lseek while writing header");
69 memset(header_buf, 0, blocksize);
72 memcpy(header_buf, hdr, sizeof(struct ext2_image_hdr));
74 actual = write(fd, header_buf, blocksize);
76 perror("write header");
79 if (actual != blocksize) {
80 fprintf(stderr, _("short write (only %d bytes) for"
81 "writing image header"), actual);
87 static void write_image_file(ext2_filsys fs, int fd)
89 struct ext2_image_hdr hdr;
93 write_header(fd, NULL, fs->blocksize);
94 memset(&hdr, 0, sizeof(struct ext2_image_hdr));
96 hdr.offset_super = lseek(fd, 0, SEEK_CUR);
97 retval = ext2fs_image_super_write(fs, fd, 0);
99 com_err(program_name, retval, _("while writing superblock"));
103 hdr.offset_inode = lseek(fd, 0, SEEK_CUR);
104 retval = ext2fs_image_inode_write(fs, fd,
105 (fd != 1) ? IMAGER_FLAG_SPARSEWRITE : 0);
107 com_err(program_name, retval, _("while writing inode table"));
111 hdr.offset_blockmap = lseek(fd, 0, SEEK_CUR);
112 retval = ext2fs_image_bitmap_write(fs, fd, 0);
114 com_err(program_name, retval, _("while writing block bitmap"));
118 hdr.offset_inodemap = lseek(fd, 0, SEEK_CUR);
119 retval = ext2fs_image_bitmap_write(fs, fd, IMAGER_FLAG_INODEMAP);
121 com_err(program_name, retval, _("while writing inode bitmap"));
125 hdr.magic_number = EXT2_ET_MAGIC_E2IMAGE;
126 strcpy(hdr.magic_descriptor, "Ext2 Image 1.0");
127 gethostname(hdr.fs_hostname, sizeof(hdr.fs_hostname));
128 strncat(hdr.fs_device_name, device_name, sizeof(hdr.fs_device_name));
129 hdr.fs_device_name[sizeof(hdr.fs_device_name) - 1] = 0;
130 hdr.fs_blocksize = fs->blocksize;
132 if (stat(device_name, &st) == 0)
133 hdr.fs_device = st.st_rdev;
135 if (fstat(fd, &st) == 0) {
136 hdr.image_device = st.st_dev;
137 hdr.image_inode = st.st_ino;
139 memcpy(hdr.fs_uuid, fs->super->s_uuid, sizeof(hdr.fs_uuid));
141 hdr.image_time = time(0);
142 write_header(fd, &hdr, fs->blocksize);
146 * These set of functions are used to write a RAW image file.
148 ext2fs_block_bitmap meta_block_map;
150 struct process_block_struct {
155 * These subroutines short circuits ext2fs_get_blocks and
156 * ext2fs_check_directory; we use them since we already have the inode
157 * structure, so there's no point in letting the ext2fs library read
160 static ino_t stashed_ino = 0;
161 static struct ext2_inode *stashed_inode;
163 static errcode_t meta_get_blocks(ext2_filsys fs, ext2_ino_t ino,
168 if ((ino != stashed_ino) || !stashed_inode)
169 return EXT2_ET_CALLBACK_NOTHANDLED;
171 for (i=0; i < EXT2_N_BLOCKS; i++)
172 blocks[i] = stashed_inode->i_block[i];
176 static errcode_t meta_read_inode(ext2_filsys fs, ext2_ino_t ino,
177 struct ext2_inode *inode)
179 if ((ino != stashed_ino) || !stashed_inode)
180 return EXT2_ET_CALLBACK_NOTHANDLED;
181 *inode = *stashed_inode;
185 static int process_dir_block(ext2_filsys fs, blk_t *block_nr,
186 e2_blkcnt_t blockcnt, blk_t ref_block,
187 int ref_offset, void *priv_data)
189 ext2fs_mark_block_bitmap(meta_block_map, *block_nr);
193 static int process_file_block(ext2_filsys fs, blk_t *block_nr,
194 e2_blkcnt_t blockcnt, blk_t ref_block,
195 int ref_offset, void *priv_data)
198 ext2fs_mark_block_bitmap(meta_block_map, *block_nr);
203 static void mark_table_blocks(ext2_filsys fs)
208 block = fs->super->s_first_data_block;
210 * Mark primary superblock
212 ext2fs_mark_block_bitmap(meta_block_map, block);
215 * Mark the primary superblock descriptors
217 for (j = 0; j < fs->desc_blocks; j++) {
218 ext2fs_mark_block_bitmap(meta_block_map,
222 for (i = 0; i < fs->group_desc_count; i++) {
224 * Mark the blocks used for the inode table
226 if (fs->group_desc[i].bg_inode_table) {
227 for (j = 0, b = fs->group_desc[i].bg_inode_table;
228 j < fs->inode_blocks_per_group;
230 ext2fs_mark_block_bitmap(meta_block_map, b);
234 * Mark block used for the block bitmap
236 if (fs->group_desc[i].bg_block_bitmap) {
237 ext2fs_mark_block_bitmap(meta_block_map,
238 fs->group_desc[i].bg_block_bitmap);
242 * Mark block used for the inode bitmap
244 if (fs->group_desc[i].bg_inode_bitmap) {
245 ext2fs_mark_block_bitmap(meta_block_map,
246 fs->group_desc[i].bg_inode_bitmap);
248 block += fs->super->s_blocks_per_group;
253 * This function returns 1 if the specified block is all zeros
255 static int check_zero_block(char *buf, int blocksize)
258 int left = blocksize;
268 static void write_block(int fd, char *buf, int sparse_offset,
269 int blocksize, blk_t block)
276 if (lseek64(fd, sparse_offset, SEEK_CUR) < 0)
279 if (lseek(fd, sparse_offset, SEEK_CUR) < 0)
284 count = write(fd, buf, blocksize);
285 if (count != blocksize) {
290 com_err(program_name, err, "error writing block %d",
296 static output_meta_data_blocks(ext2_filsys fs, int fd)
300 char buf[8192], zero_buf[8192];
303 memset(zero_buf, 0, sizeof(zero_buf));
304 for (blk = 0; blk < fs->super->s_blocks_count; blk++) {
305 if ((blk >= fs->super->s_first_data_block) &&
306 ext2fs_test_block_bitmap(meta_block_map, blk)) {
307 retval = io_channel_read_blk(fs->io, blk, 1, buf);
309 com_err(program_name, retval,
310 "error reading block %d", blk);
312 if ((fd != 1) && check_zero_block(buf, fs->blocksize))
314 write_block(fd, buf, sparse, fs->blocksize, blk);
319 write_block(fd, zero_buf, 0,
323 sparse += fs->blocksize;
324 if (sparse >= 1024*1024) {
325 write_block(fd, 0, sparse, 0, 0);
330 write_block(fd, zero_buf, sparse, 1, -1);
333 static void write_raw_image_file(ext2_filsys fs, int fd)
335 struct process_block_struct pb;
336 struct ext2_inode inode;
337 ext2_inode_scan scan;
342 retval = ext2fs_allocate_block_bitmap(fs, "in-use block map",
345 com_err(program_name, retval, "while allocating block bitmap");
349 mark_table_blocks(fs);
351 retval = ext2fs_open_inode_scan(fs, 0, &scan);
353 com_err(program_name, retval, _("while opening inode scan"));
357 block_buf = malloc(fs->blocksize * 3);
359 com_err(program_name, 0, "Can't allocate block buffer");
363 stashed_inode = &inode;
365 retval = ext2fs_get_next_inode(scan, &ino, &inode);
367 com_err(program_name, retval,
368 _("while getting next inode"));
373 if (!inode.i_links_count ||
374 !ext2fs_inode_has_valid_blocks(&inode))
378 if (LINUX_S_ISDIR(inode.i_mode) ||
379 ino == fs->super->s_journal_inum) {
380 retval = ext2fs_block_iterate2(fs, ino, 0,
381 block_buf, process_dir_block, &pb);
383 com_err(program_name, retval,
384 "while iterating over inode %d",
389 if (inode.i_block[EXT2_IND_BLOCK] ||
390 inode.i_block[EXT2_DIND_BLOCK] ||
391 inode.i_block[EXT2_TIND_BLOCK]) {
392 retval = ext2fs_block_iterate2(fs,
394 process_file_block, &pb);
396 com_err(program_name, retval,
397 "while iterating over %d", ino);
401 if (inode.i_file_acl) {
402 ext2fs_mark_block_bitmap(meta_block_map,
408 output_meta_data_blocks(fs, fd);
411 int main (int argc, char ** argv)
422 setlocale(LC_MESSAGES, "");
423 bindtextdomain(NLS_CAT_NAME, LOCALEDIR);
424 textdomain(NLS_CAT_NAME);
426 fprintf (stderr, "e2image %s (%s)\n", E2FSPROGS_VERSION,
429 program_name = *argv;
430 initialize_ext2_error_table();
431 while ((c = getopt (argc, argv, "r")) != EOF)
439 if (optind != argc - 2 )
441 device_name = argv[optind];
442 outfn = argv[optind+1];
443 retval = ext2fs_open (device_name, open_flag, 0, 0,
444 unix_io_manager, &fs);
446 com_err (program_name, retval, _("while trying to open %s"),
448 printf(_("Couldn't find valid filesystem superblock.\n"));
452 if (strcmp(outfn, "-") == 0)
456 fd = open64(outfn, O_CREAT|O_TRUNC|O_WRONLY, 0600);
458 fd = open(outfn, O_CREAT|O_TRUNC|O_WRONLY, 0600);
461 com_err(program_name, errno,
462 _("while trying to open %s"), argv[optind+1]);
468 write_raw_image_file(fs, fd);
470 write_image_file(fs, fd);