2 * util.c --- miscellaneous utilities
4 * Copyright (C) 1993, 1994, 1995, 1996, 1997 Theodore Ts'o.
7 * This file may be redistributed under the terms of the GNU Public
19 #include <sys/utsname.h>
25 #define read_a_char() getch()
42 extern e2fsck_t e2fsck_global_ctx; /* Try your very best not to use this! */
47 #include <sys/resource.h>
49 void fatal_error(e2fsck_t ctx, const char *msg)
51 ext2_filsys fs = ctx->fs;
52 int exit_value = FSCK_ERROR;
55 fprintf (stderr, "e2fsck: %s\n", msg);
58 if (fs->io && fs->super) {
59 ext2fs_mmp_stop(ctx->fs);
60 if (ctx->fs->io->magic == EXT2_ET_MAGIC_IO_CHANNEL)
61 io_channel_flush(ctx->fs->io);
63 log_err(ctx, "e2fsck: io manager magic bad!\n");
65 if (ext2fs_test_changed(fs)) {
66 exit_value |= FSCK_NONDESTRUCT;
67 log_out(ctx, _("\n%s: ***** FILE SYSTEM WAS MODIFIED *****\n"),
69 if (ctx->mount_flags & EXT2_MF_ISROOT)
70 exit_value |= FSCK_REBOOT;
72 if (!ext2fs_test_valid(fs)) {
73 log_out(ctx, _("\n%s: ********** WARNING: Filesystem still has "
74 "errors **********\n\n"), ctx->device_name);
75 exit_value |= FSCK_UNCORRECTED;
76 exit_value &= ~FSCK_NONDESTRUCT;
79 ctx->flags |= E2F_FLAG_ABORT;
80 if (ctx->flags & E2F_FLAG_SETJMP_OK)
81 longjmp(ctx->abort_loc, 1);
85 void log_out(e2fsck_t ctx, const char *fmt, ...)
94 vfprintf(ctx->logf, fmt, pvar);
99 void log_err(e2fsck_t ctx, const char *fmt, ...)
104 vfprintf(stderr, fmt, pvar);
108 vfprintf(ctx->logf, fmt, pvar);
113 void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
114 const char *description)
119 #ifdef DEBUG_ALLOCATE_MEMORY
120 printf("Allocating %u bytes for %s...\n", size, description);
124 sprintf(buf, "Can't allocate %u bytes for %s\n",
126 fatal_error(ctx, buf);
128 memset(ret, 0, size);
132 char *string_copy(e2fsck_t ctx EXT2FS_ATTR((unused)),
133 const char *str, int len)
143 strncpy(ret, str, len);
151 * Incredibly, libc5 doesn't appear to have strnlen. So we have to
154 int e2fsck_strnlen(const char * s, int count)
158 while (count-- && *cp)
165 static int read_a_char(void)
172 if (e2fsck_global_ctx &&
173 (e2fsck_global_ctx->flags & E2F_FLAG_CANCEL)) {
186 int ask_yn(e2fsck_t ctx, const char * string, int def)
190 const char *short_yes = _("yY");
191 const char *short_no = _("nN");
193 #ifdef HAVE_TERMIOS_H
194 struct termios termios, tmp;
196 tcgetattr (0, &termios);
198 tmp.c_lflag &= ~(ICANON | ECHO);
201 tcsetattr (0, TCSANOW, &tmp);
205 defstr = _(_("<y>"));
207 defstr = _(_("<n>"));
209 defstr = _(" (y/n)");
210 log_out(ctx, "%s%s? ", string, defstr);
213 if ((c = read_a_char()) == EOF)
216 #ifdef HAVE_TERMIOS_H
217 tcsetattr (0, TCSANOW, &termios);
219 if (ctx->flags & E2F_FLAG_SETJMP_OK) {
221 longjmp(e2fsck_global_ctx->abort_loc, 1);
223 log_out(ctx, "%s", _("cancelled!\n"));
226 if (strchr(short_yes, (char) c)) {
230 else if (strchr(short_no, (char) c)) {
234 else if ((c == 27 || c == ' ' || c == '\n') && (def != -1))
238 log_out(ctx, "%s", _("yes\n"));
240 log_out(ctx, "%s", _("no\n"));
241 #ifdef HAVE_TERMIOS_H
242 tcsetattr (0, TCSANOW, &termios);
247 int ask (e2fsck_t ctx, const char * string, int def)
249 if (ctx->options & E2F_OPT_NO) {
250 log_out(ctx, _("%s? no\n\n"), string);
253 if (ctx->options & E2F_OPT_YES) {
254 log_out(ctx, _("%s? yes\n\n"), string);
257 if (ctx->options & E2F_OPT_PREEN) {
258 log_out(ctx, "%s? %s\n\n", string, def ? _("yes") : _("no"));
261 return ask_yn(ctx, string, def);
264 void e2fsck_read_bitmaps(e2fsck_t ctx)
266 ext2_filsys fs = ctx->fs;
269 unsigned int save_type;
272 if (ctx->invalid_bitmaps) {
273 com_err(ctx->program_name, 0,
274 _("e2fsck_read_bitmaps: illegal bitmap block(s) for %s"),
279 old_op = ehandler_operation(_("reading inode and block bitmaps"));
280 e2fsck_set_bitmap_type(fs, EXT2FS_BMAP64_RBTREE, "fs_bitmaps",
282 flags = ctx->fs->flags;
283 ctx->fs->flags |= EXT2_FLAG_IGNORE_CSUM_ERRORS;
284 retval = ext2fs_read_bitmaps(fs);
285 ctx->fs->flags = (flags & EXT2_FLAG_IGNORE_CSUM_ERRORS) |
286 (ctx->fs->flags & ~EXT2_FLAG_IGNORE_CSUM_ERRORS);
287 fs->default_bitmap_type = save_type;
288 ehandler_operation(old_op);
290 com_err(ctx->program_name, retval,
291 _("while retrying to read bitmaps for %s"),
297 void e2fsck_write_bitmaps(e2fsck_t ctx)
299 ext2_filsys fs = ctx->fs;
303 old_op = ehandler_operation(_("writing block and inode bitmaps"));
304 retval = ext2fs_write_bitmaps(fs);
305 ehandler_operation(old_op);
307 com_err(ctx->program_name, retval,
308 _("while rewriting block and inode bitmaps for %s"),
314 void preenhalt(e2fsck_t ctx)
316 ext2_filsys fs = ctx->fs;
318 if (!(ctx->options & E2F_OPT_PREEN))
320 log_err(ctx, _("\n\n%s: UNEXPECTED INCONSISTENCY; "
321 "RUN fsck MANUALLY.\n\t(i.e., without -a or -p options)\n"),
323 ctx->flags |= E2F_FLAG_EXITING;
325 fs->super->s_state |= EXT2_ERROR_FS;
326 ext2fs_mark_super_dirty(fs);
327 ext2fs_close_free(&fs);
329 exit(FSCK_UNCORRECTED);
332 #ifdef RESOURCE_TRACK
333 void init_resource_track(struct resource_track *track, io_channel channel)
335 #ifdef HAVE_GETRUSAGE
338 io_stats io_start = 0;
340 track->brk_start = sbrk(0);
341 gettimeofday(&track->time_start, 0);
342 #ifdef HAVE_GETRUSAGE
344 memset(&r, 0, sizeof(struct rusage));
346 getrusage(RUSAGE_SELF, &r);
347 track->user_start = r.ru_utime;
348 track->system_start = r.ru_stime;
350 track->user_start.tv_sec = track->user_start.tv_usec = 0;
351 track->system_start.tv_sec = track->system_start.tv_usec = 0;
353 track->bytes_read = 0;
354 track->bytes_written = 0;
355 if (channel && channel->manager && channel->manager->get_stats)
356 channel->manager->get_stats(channel, &io_start);
358 track->bytes_read = io_start->bytes_read;
359 track->bytes_written = io_start->bytes_written;
364 #define _INLINE_ __inline__
369 static _INLINE_ float timeval_subtract(struct timeval *tv1,
372 return ((tv1->tv_sec - tv2->tv_sec) +
373 ((float) (tv1->tv_usec - tv2->tv_usec)) / 1000000);
376 void print_resource_track(e2fsck_t ctx, const char *desc,
377 struct resource_track *track, io_channel channel)
379 #ifdef HAVE_GETRUSAGE
383 struct mallinfo malloc_info;
385 struct timeval time_end;
387 if ((desc && !(ctx->options & E2F_OPT_TIME2)) ||
388 (!desc && !(ctx->options & E2F_OPT_TIME)))
391 e2fsck_clear_progbar(ctx);
392 gettimeofday(&time_end, 0);
395 log_out(ctx, "%s: ", desc);
398 #define kbytes(x) (((unsigned long)(x) + 1023) / 1024)
400 malloc_info = mallinfo();
401 log_out(ctx, _("Memory used: %luk/%luk (%luk/%luk), "),
402 kbytes(malloc_info.arena), kbytes(malloc_info.hblkhd),
403 kbytes(malloc_info.uordblks), kbytes(malloc_info.fordblks));
405 log_out(ctx, _("Memory used: %lu, "),
406 (unsigned long) (((char *) sbrk(0)) -
407 ((char *) track->brk_start)));
409 #ifdef HAVE_GETRUSAGE
410 getrusage(RUSAGE_SELF, &r);
412 log_out(ctx, _("time: %5.2f/%5.2f/%5.2f\n"),
413 timeval_subtract(&time_end, &track->time_start),
414 timeval_subtract(&r.ru_utime, &track->user_start),
415 timeval_subtract(&r.ru_stime, &track->system_start));
417 log_out(ctx, _("elapsed time: %6.3f\n"),
418 timeval_subtract(&time_end, &track->time_start));
420 #define mbytes(x) (((x) + 1048575) / 1048576)
421 if (channel && channel->manager && channel->manager->get_stats) {
423 unsigned long long bytes_read = 0;
424 unsigned long long bytes_written = 0;
427 log_out(ctx, "%s: ", desc);
429 channel->manager->get_stats(channel, &delta);
431 bytes_read = delta->bytes_read - track->bytes_read;
432 bytes_written = delta->bytes_written -
433 track->bytes_written;
435 log_out(ctx, "I/O read: %lluMB, write: %lluMB, "
437 mbytes(bytes_read), mbytes(bytes_written),
438 (double)mbytes(bytes_read + bytes_written) /
439 timeval_subtract(&time_end, &track->time_start));
442 #endif /* RESOURCE_TRACK */
444 void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
445 struct ext2_inode * inode, const char *proc)
449 retval = ext2fs_read_inode(ctx->fs, ino, inode);
451 com_err("ext2fs_read_inode", retval,
452 _("while reading inode %lu in %s"), ino, proc);
457 void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
458 struct ext2_inode *inode, int bufsize,
463 retval = ext2fs_read_inode_full(ctx->fs, ino, inode, bufsize);
465 com_err("ext2fs_read_inode_full", retval,
466 _("while reading inode %lu in %s"), ino, proc);
471 void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
472 struct ext2_inode * inode, int bufsize,
477 retval = ext2fs_write_inode_full(ctx->fs, ino, inode, bufsize);
479 com_err("ext2fs_write_inode", retval,
480 _("while writing inode %lu in %s"), ino, proc);
485 void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
486 struct ext2_inode * inode, const char *proc)
490 retval = ext2fs_write_inode(ctx->fs, ino, inode);
492 com_err("ext2fs_write_inode", retval,
493 _("while writing inode %lu in %s"), ino, proc);
499 void mtrace_print(char *mesg)
501 FILE *malloc_get_mallstream();
502 FILE *f = malloc_get_mallstream();
505 fprintf(f, "============= %s\n", mesg);
509 blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs, const char *name,
512 struct ext2_super_block *sb;
513 io_channel io = NULL;
516 blk64_t superblock, ret_sb = 8193;
518 if (fs && fs->super) {
519 ret_sb = (fs->super->s_blocks_per_group +
520 fs->super->s_first_data_block);
522 ctx->superblock = ret_sb;
523 ctx->blocksize = fs->blocksize;
529 if (ctx->blocksize) {
530 ret_sb = ctx->blocksize * 8;
531 if (ctx->blocksize == 1024)
533 ctx->superblock = ret_sb;
536 ctx->superblock = ret_sb;
537 ctx->blocksize = 1024;
540 if (!name || !manager)
543 if (manager->open(name, 0, &io) != 0)
546 if (ext2fs_get_mem(SUPERBLOCK_SIZE, &buf))
548 sb = (struct ext2_super_block *) buf;
550 for (blocksize = EXT2_MIN_BLOCK_SIZE;
551 blocksize <= EXT2_MAX_BLOCK_SIZE ; blocksize *= 2) {
552 superblock = blocksize*8;
553 if (blocksize == 1024)
555 io_channel_set_blksize(io, blocksize);
556 if (io_channel_read_blk64(io, superblock,
557 -SUPERBLOCK_SIZE, buf))
559 #ifdef WORDS_BIGENDIAN
560 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
561 ext2fs_swap_super(sb);
563 if ((sb->s_magic == EXT2_SUPER_MAGIC) &&
564 (EXT2_BLOCK_SIZE(sb) == blocksize)) {
567 ctx->superblock = superblock;
568 ctx->blocksize = blocksize;
576 io_channel_close(io);
578 ext2fs_free_mem(&buf);
583 * Given a mode, return the ext2 file type
585 int ext2_file_type(unsigned int mode)
587 if (LINUX_S_ISREG(mode))
588 return EXT2_FT_REG_FILE;
590 if (LINUX_S_ISDIR(mode))
593 if (LINUX_S_ISCHR(mode))
594 return EXT2_FT_CHRDEV;
596 if (LINUX_S_ISBLK(mode))
597 return EXT2_FT_BLKDEV;
599 if (LINUX_S_ISLNK(mode))
600 return EXT2_FT_SYMLINK;
602 if (LINUX_S_ISFIFO(mode))
605 if (LINUX_S_ISSOCK(mode))
611 #define STRIDE_LENGTH 8
613 * Helper function which zeros out _num_ blocks starting at _blk_. In
614 * case of an error, the details of the error is returned via _ret_blk_
615 * and _ret_count_ if they are non-NULL pointers. Returns 0 on
616 * success, and an error code on an error.
618 * As a special case, if the first argument is NULL, then it will
619 * attempt to free the static zeroizing buffer. (This is to keep
620 * programs that check for memory leaks happy.)
622 errcode_t e2fsck_zero_blocks(ext2_filsys fs, blk_t blk, int num,
623 blk_t *ret_blk, int *ret_count)
629 /* If fs is null, clean up the static buffer and return */
637 /* Allocate the zeroizing buffer if necessary */
639 buf = malloc(fs->blocksize * STRIDE_LENGTH);
641 com_err("malloc", ENOMEM, "%s",
642 _("while allocating zeroizing buffer"));
645 memset(buf, 0, fs->blocksize * STRIDE_LENGTH);
647 /* OK, do the write loop */
648 for (j = 0; j < num; j += STRIDE_LENGTH, blk += STRIDE_LENGTH) {
650 if (count > STRIDE_LENGTH)
651 count = STRIDE_LENGTH;
652 retval = io_channel_write_blk64(fs->io, blk, count, buf);
665 * Check to see if a filesystem is in /proc/filesystems.
666 * Returns 1 if found, 0 if not
668 int fs_proc_check(const char *fs_name)
671 char buf[80], *cp, *t;
673 f = fopen("/proc/filesystems", "r");
677 if (!fgets(buf, sizeof(buf), f))
681 while (*cp && !isspace(*cp))
684 while (*cp && isspace(*cp))
686 if ((t = strchr(cp, '\n')) != NULL)
688 if ((t = strchr(cp, '\t')) != NULL)
690 if ((t = strchr(cp, ' ')) != NULL)
692 if (!strcmp(fs_name, cp)) {
702 * Check to see if a filesystem is available as a module
703 * Returns 1 if found, 0 if not
705 int check_for_modules(const char *fs_name)
710 char buf[1024], *cp, *t;
715 snprintf(buf, sizeof(buf), "/lib/modules/%s/modules.dep", uts.release);
721 if (!fgets(buf, sizeof(buf), f))
723 if ((cp = strchr(buf, ':')) != NULL)
727 if ((cp = strrchr(buf, '/')) != NULL)
734 if (!strcmp(t, ".ko"))
737 if (!strcmp(cp, fs_name)) {
743 #endif /* __linux__ */
748 * Helper function that does the right thing if write returns a
749 * partial write, or an EGAIN/EINTR error.
751 int write_all(int fd, char *buf, size_t count)
757 ret = write(fd, buf, count);
759 if ((errno == EAGAIN) || (errno == EINTR))
770 void dump_mmp_msg(struct mmp_struct *mmp, const char *msg)
774 printf("MMP check failed: %s\n", msg);
776 time_t t = mmp->mmp_time;
778 printf("MMP error info: last update: %s node: %s device: %s\n",
779 ctime(&t), mmp->mmp_nodename, mmp->mmp_bdevname);
783 errcode_t e2fsck_mmp_update(ext2_filsys fs)
787 retval = ext2fs_mmp_update(fs);
788 if (retval == EXT2_ET_MMP_CHANGE_ABORT)
789 dump_mmp_msg(fs->mmp_cmp,
790 _("UNEXPECTED INCONSISTENCY: the filesystem is "
791 "being modified while fsck is running.\n"));
796 void e2fsck_set_bitmap_type(ext2_filsys fs, unsigned int default_type,
797 const char *profile_name, unsigned int *old_type)
800 e2fsck_t ctx = (e2fsck_t) fs->priv_data;
803 *old_type = fs->default_bitmap_type;
804 profile_get_uint(ctx->profile, "bitmaps", profile_name, 0,
805 default_type, &type);
806 profile_get_uint(ctx->profile, "bitmaps", "all", 0, type, &type);
807 fs->default_bitmap_type = type ? type : default_type;
810 errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs, const char *descr,
813 ext2fs_inode_bitmap *ret)
816 unsigned int save_type;
818 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
819 retval = ext2fs_allocate_inode_bitmap(fs, descr, ret);
820 fs->default_bitmap_type = save_type;
824 errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs, const char *descr,
827 ext2fs_block_bitmap *ret)
830 unsigned int save_type;
832 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
833 retval = ext2fs_allocate_block_bitmap(fs, descr, ret);
834 fs->default_bitmap_type = save_type;
838 errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs, const char *descr,
841 ext2fs_block_bitmap *ret)
844 unsigned int save_type;
846 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
847 retval = ext2fs_allocate_subcluster_bitmap(fs, descr, ret);
848 fs->default_bitmap_type = save_type;