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
20 #include <sys/utsname.h>
26 #define read_a_char() getch()
43 extern e2fsck_t e2fsck_global_ctx; /* Try your very best not to use this! */
48 #include <sys/resource.h>
50 void fatal_error(e2fsck_t ctx, const char *msg)
52 ext2_filsys fs = ctx->fs;
53 int exit_value = FSCK_ERROR;
56 fprintf (stderr, "e2fsck: %s\n", msg);
59 if (fs->io && fs->super) {
60 ext2fs_mmp_stop(ctx->fs);
61 if (ctx->fs->io->magic == EXT2_ET_MAGIC_IO_CHANNEL)
62 io_channel_flush(ctx->fs->io);
64 log_err(ctx, "e2fsck: io manager magic bad!\n");
66 if (ext2fs_test_changed(fs)) {
67 exit_value |= FSCK_NONDESTRUCT;
68 log_out(ctx, _("\n%s: ***** FILE SYSTEM WAS MODIFIED *****\n"),
70 if (ctx->mount_flags & EXT2_MF_ISROOT)
71 exit_value |= FSCK_REBOOT;
73 if (!ext2fs_test_valid(fs)) {
74 log_out(ctx, _("\n%s: ********** WARNING: Filesystem still has "
75 "errors **********\n\n"), ctx->device_name);
76 exit_value |= FSCK_UNCORRECTED;
77 exit_value &= ~FSCK_NONDESTRUCT;
80 ctx->flags |= E2F_FLAG_ABORT;
81 if (ctx->flags & E2F_FLAG_SETJMP_OK)
82 longjmp(ctx->abort_loc, 1);
84 fprintf(ctx->logf, "Exit status: %d\n", exit_value);
89 static void thread_log_out(struct e2fsck_thread *tinfo)
91 printf("[Thread %d] %s", tinfo->et_thread_index,
93 tinfo->et_log_length = 0;
94 tinfo->et_log_buf[0] = '\0';
98 void log_out(e2fsck_t ctx, const char *fmt, ...)
101 struct e2fsck_thread *tinfo;
105 int fmt_length = strlen(fmt);
108 if ((ctx->options & E2F_OPT_MULTITHREAD) && ctx->global_ctx) {
109 tinfo = &ctx->thread_info;
110 buf_size = sizeof(tinfo->et_log_buf);
111 left_size = buf_size - tinfo->et_log_length;
114 msg_size = vsnprintf(tinfo->et_log_buf + tinfo->et_log_length,
115 left_size, fmt, pvar);
118 if (msg_size >= left_size) {
119 tinfo->et_log_buf[tinfo->et_log_length] = '\0';
121 assert(msg_size < buf_size);
122 if (msg_size < buf_size) {
123 thread_log_out(tinfo);
126 msg_size = vsnprintf(tinfo->et_log_buf, buf_size,
130 tinfo->et_log_length += msg_size;
131 tinfo->et_log_buf[tinfo->et_log_length] = '\0';
134 tinfo->et_log_length += msg_size;
135 tinfo->et_log_buf[tinfo->et_log_length] = '\0';
138 if (tinfo->et_log_length > 0 &&
139 tinfo->et_log_buf[tinfo->et_log_length - 1] == '\n')
140 thread_log_out(tinfo);
151 vfprintf(ctx->logf, fmt, pvar);
156 void log_err(e2fsck_t ctx, const char *fmt, ...)
161 vfprintf(stderr, fmt, pvar);
165 vfprintf(ctx->logf, fmt, pvar);
170 void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned long size,
171 const char *description)
176 #ifdef DEBUG_ALLOCATE_MEMORY
177 printf("Allocating %lu bytes for %s...\n", size, description);
179 if (ext2fs_get_memzero(size, &ret)) {
180 sprintf(buf, "Can't allocate %lu bytes for %s\n",
182 fatal_error(ctx, buf);
188 char *string_copy(e2fsck_t ctx EXT2FS_ATTR((unused)),
189 const char *str, size_t len)
199 strncpy(ret, str, len);
207 * Incredibly, libc5 doesn't appear to have strnlen. So we have to
210 int e2fsck_strnlen(const char * s, int count)
214 while (count-- && *cp)
221 static int read_a_char(void)
228 if (e2fsck_global_ctx &&
229 (e2fsck_global_ctx->flags & E2F_FLAG_CANCEL)) {
242 int ask_yn(e2fsck_t ctx, const char * string, int def)
246 const char *short_yes = _("yY");
247 const char *short_no = _("nN");
248 const char *short_yesall = _("aA");
249 const char *english_yes = "yY";
250 const char *english_no = "nN";
251 const char *english_yesall = "aA";
252 const char *yesall_prompt = _(" ('a' enables 'yes' to all) ");
253 const char *extra_prompt = "";
254 static int yes_answers;
256 #ifdef HAVE_TERMIOS_H
257 struct termios termios, tmp;
259 if (tcgetattr (0, &termios) < 0)
260 memset(&termios, 0, sizeof(termios));
262 tmp.c_lflag &= ~(ICANON | ECHO);
265 tcsetattr (0, TCSANOW, &tmp);
269 defstr = _(_("<y>"));
271 defstr = _(_("<n>"));
273 defstr = _(" (y/n)");
275 * If the user presses 'y' more than 8 (but less than 12) times in
276 * succession without pressing anything else, display a hint about
279 if (yes_answers > 12)
281 else if (yes_answers > 8)
282 extra_prompt = yesall_prompt;
283 log_out(ctx, "%s%s%s? ", string, extra_prompt, defstr);
286 if ((c = read_a_char()) == EOF)
289 #ifdef HAVE_TERMIOS_H
290 tcsetattr (0, TCSANOW, &termios);
292 if (ctx->flags & E2F_FLAG_SETJMP_OK) {
294 longjmp(e2fsck_global_ctx->abort_loc, 1);
296 log_out(ctx, "%s", _("cancelled!\n"));
300 if (strchr(short_yes, (char) c)) {
303 if (yes_answers >= 0)
306 } else if (strchr(short_no, (char) c)) {
311 } else if (strchr(short_yesall, (char)c)) {
315 ctx->options |= E2F_OPT_YES;
317 } else if (strchr(english_yes, (char) c)) {
319 } else if (strchr(english_no, (char) c)) {
321 } else if (strchr(english_yesall, (char) c)) {
323 } else if ((c == 27 || c == ' ' || c == '\n') && (def != -1)) {
329 log_out(ctx, "%s", _("yes to all\n"));
331 log_out(ctx, "%s", _("yes\n"));
333 log_out(ctx, "%s", _("no\n"));
334 #ifdef HAVE_TERMIOS_H
335 tcsetattr (0, TCSANOW, &termios);
340 int ask (e2fsck_t ctx, const char * string, int def)
342 if (ctx->options & E2F_OPT_NO) {
343 log_out(ctx, _("%s? no\n\n"), string);
346 if (ctx->options & E2F_OPT_YES) {
347 log_out(ctx, _("%s? yes\n\n"), string);
350 if (ctx->options & E2F_OPT_PREEN) {
351 log_out(ctx, "%s? %s\n\n", string, def ? _("yes") : _("no"));
354 return ask_yn(ctx, string, def);
357 void e2fsck_read_bitmaps(e2fsck_t ctx)
359 ext2_filsys fs = ctx->fs;
362 unsigned int save_type;
365 if (ctx->invalid_bitmaps) {
366 com_err(ctx->program_name, 0,
367 _("e2fsck_read_bitmaps: illegal bitmap block(s) for %s"),
372 old_op = ehandler_operation(_("reading inode and block bitmaps"));
373 e2fsck_set_bitmap_type(fs, EXT2FS_BMAP64_RBTREE, "fs_bitmaps",
375 flags = ctx->fs->flags;
376 ctx->fs->flags |= EXT2_FLAG_IGNORE_CSUM_ERRORS;
377 retval = ext2fs_read_bitmaps(fs);
378 ctx->fs->flags = (flags & EXT2_FLAG_IGNORE_CSUM_ERRORS) |
379 (ctx->fs->flags & ~EXT2_FLAG_IGNORE_CSUM_ERRORS);
380 fs->default_bitmap_type = save_type;
381 ehandler_operation(old_op);
383 com_err(ctx->program_name, retval,
384 _("while retrying to read bitmaps for %s"),
390 void e2fsck_write_bitmaps(e2fsck_t ctx)
392 ext2_filsys fs = ctx->fs;
396 old_op = ehandler_operation(_("writing block and inode bitmaps"));
397 retval = ext2fs_write_bitmaps(fs);
398 ehandler_operation(old_op);
400 com_err(ctx->program_name, retval,
401 _("while rewriting block and inode bitmaps for %s"),
407 void preenhalt(e2fsck_t ctx)
409 ext2_filsys fs = ctx->fs;
411 if (!(ctx->options & E2F_OPT_PREEN))
413 log_err(ctx, _("\n\n%s: UNEXPECTED INCONSISTENCY; "
414 "RUN fsck MANUALLY.\n\t(i.e., without -a or -p options)\n"),
416 ctx->flags |= E2F_FLAG_EXITING;
418 fs->super->s_state |= EXT2_ERROR_FS;
419 ext2fs_mark_super_dirty(fs);
420 ext2fs_close_free(&fs);
422 exit(FSCK_UNCORRECTED);
425 #ifdef RESOURCE_TRACK
426 void init_resource_track(struct resource_track *track, io_channel channel)
428 #ifdef HAVE_GETRUSAGE
431 io_stats io_start = 0;
433 track->brk_start = sbrk(0);
434 gettimeofday(&track->time_start, 0);
435 #ifdef HAVE_GETRUSAGE
437 memset(&r, 0, sizeof(struct rusage));
439 getrusage(RUSAGE_SELF, &r);
440 track->user_start = r.ru_utime;
441 track->system_start = r.ru_stime;
443 track->user_start.tv_sec = track->user_start.tv_usec = 0;
444 track->system_start.tv_sec = track->system_start.tv_usec = 0;
446 track->bytes_read = 0;
447 track->bytes_written = 0;
448 if (channel && channel->manager && channel->manager->get_stats)
449 channel->manager->get_stats(channel, &io_start);
451 track->bytes_read = io_start->bytes_read;
452 track->bytes_written = io_start->bytes_written;
457 #define _INLINE_ __inline__
462 static _INLINE_ float timeval_subtract(struct timeval *tv1,
465 return ((tv1->tv_sec - tv2->tv_sec) +
466 ((float) (tv1->tv_usec - tv2->tv_usec)) / 1000000);
469 void print_resource_track(e2fsck_t ctx, const char *desc,
470 struct resource_track *track, io_channel channel)
472 #ifdef HAVE_GETRUSAGE
475 struct timeval time_end;
477 if ((desc && !(ctx->options & E2F_OPT_TIME2)) ||
478 (!desc && !(ctx->options & E2F_OPT_TIME)))
481 e2fsck_clear_progbar(ctx);
482 gettimeofday(&time_end, 0);
485 log_out(ctx, "%s: ", desc);
487 #define kbytes(x) (((unsigned long long)(x) + 1023) / 1024)
489 /* don't use mallinfo() if over 2GB used, since it returns "int" */
490 if ((char *)sbrk(0) - (char *)track->brk_start < 2LL << 30) {
491 struct mallinfo malloc_info = mallinfo();
493 log_out(ctx, _("Memory used: %lluk/%lluk (%lluk/%lluk), "),
494 kbytes(malloc_info.arena), kbytes(malloc_info.hblkhd),
495 kbytes(malloc_info.uordblks),
496 kbytes(malloc_info.fordblks));
499 log_out(ctx, _("Memory used: %lluk, "),
500 kbytes(((char *)sbrk(0)) - ((char *)track->brk_start)));
502 #ifdef HAVE_GETRUSAGE
503 getrusage(RUSAGE_SELF, &r);
505 log_out(ctx, _("time: %5.2f/%5.2f/%5.2f\n"),
506 timeval_subtract(&time_end, &track->time_start),
507 timeval_subtract(&r.ru_utime, &track->user_start),
508 timeval_subtract(&r.ru_stime, &track->system_start));
510 log_out(ctx, _("elapsed time: %6.3f\n"),
511 timeval_subtract(&time_end, &track->time_start));
513 #define mbytes(x) (((x) + 1048575) / 1048576)
514 if (channel && channel->manager && channel->manager->get_stats) {
516 unsigned long long bytes_read = 0;
517 unsigned long long bytes_written = 0;
520 log_out(ctx, "%s: ", desc);
522 channel->manager->get_stats(channel, &delta);
524 bytes_read = delta->bytes_read - track->bytes_read;
525 bytes_written = delta->bytes_written -
526 track->bytes_written;
528 log_out(ctx, "I/O read: %lluMB, write: %lluMB, "
530 mbytes(bytes_read), mbytes(bytes_written),
531 (double)mbytes(bytes_read + bytes_written) /
532 timeval_subtract(&time_end, &track->time_start));
535 #endif /* RESOURCE_TRACK */
537 void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
538 struct ext2_inode * inode, const char *proc)
542 retval = ext2fs_read_inode(ctx->fs, ino, inode);
544 com_err("ext2fs_read_inode", retval,
545 _("while reading inode %lu in %s"), ino, proc);
550 void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
551 struct ext2_inode *inode, int bufsize,
556 retval = ext2fs_read_inode_full(ctx->fs, ino, inode, bufsize);
558 com_err("ext2fs_read_inode_full", retval,
559 _("while reading inode %lu in %s"), ino, proc);
564 void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
565 struct ext2_inode * inode, int bufsize,
570 retval = ext2fs_write_inode_full(ctx->fs, ino, inode, bufsize);
572 com_err("ext2fs_write_inode", retval,
573 _("while writing inode %lu in %s"), ino, proc);
578 void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
579 struct ext2_inode * inode, const char *proc)
583 retval = ext2fs_write_inode(ctx->fs, ino, inode);
585 com_err("ext2fs_write_inode", retval,
586 _("while writing inode %lu in %s"), ino, proc);
592 void mtrace_print(char *mesg)
594 FILE *malloc_get_mallstream();
595 FILE *f = malloc_get_mallstream();
598 fprintf(f, "============= %s\n", mesg);
602 blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs, const char *name,
605 struct ext2_super_block *sb;
606 io_channel io = NULL;
609 blk64_t superblock, ret_sb = 8193;
611 if (fs && fs->super) {
612 ret_sb = (fs->super->s_blocks_per_group +
613 fs->super->s_first_data_block);
615 ctx->superblock = ret_sb;
616 ctx->blocksize = fs->blocksize;
622 if (ctx->blocksize) {
623 ret_sb = ctx->blocksize * 8;
624 if (ctx->blocksize == 1024)
626 ctx->superblock = ret_sb;
629 ctx->superblock = ret_sb;
630 ctx->blocksize = 1024;
633 if (!name || !manager)
636 if (manager->open(name, 0, &io) != 0)
639 if (ext2fs_get_mem(SUPERBLOCK_SIZE, &buf))
641 sb = (struct ext2_super_block *) buf;
643 for (blocksize = EXT2_MIN_BLOCK_SIZE;
644 blocksize <= EXT2_MAX_BLOCK_SIZE ; blocksize *= 2) {
645 superblock = blocksize*8;
646 if (blocksize == 1024)
648 io_channel_set_blksize(io, blocksize);
649 if (io_channel_read_blk64(io, superblock,
650 -SUPERBLOCK_SIZE, buf))
652 #ifdef WORDS_BIGENDIAN
653 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
654 ext2fs_swap_super(sb);
656 if ((sb->s_magic == EXT2_SUPER_MAGIC) &&
657 (EXT2_BLOCK_SIZE(sb) == blocksize)) {
660 ctx->superblock = superblock;
661 ctx->blocksize = blocksize;
669 io_channel_close(io);
671 ext2fs_free_mem(&buf);
676 * Given a mode, return the ext2 file type
678 int ext2_file_type(unsigned int mode)
680 if (LINUX_S_ISREG(mode))
681 return EXT2_FT_REG_FILE;
683 if (LINUX_S_ISDIR(mode))
686 if (LINUX_S_ISCHR(mode))
687 return EXT2_FT_CHRDEV;
689 if (LINUX_S_ISBLK(mode))
690 return EXT2_FT_BLKDEV;
692 if (LINUX_S_ISLNK(mode))
693 return EXT2_FT_SYMLINK;
695 if (LINUX_S_ISFIFO(mode))
698 if (LINUX_S_ISSOCK(mode))
705 * Check to see if a filesystem is in /proc/filesystems.
706 * Returns 1 if found, 0 if not
708 int fs_proc_check(const char *fs_name)
711 char buf[80], *cp, *t;
713 f = fopen("/proc/filesystems", "r");
717 if (!fgets(buf, sizeof(buf), f))
721 while (*cp && !isspace(*cp))
724 while (*cp && isspace(*cp))
726 if ((t = strchr(cp, '\n')) != NULL)
728 if ((t = strchr(cp, '\t')) != NULL)
730 if ((t = strchr(cp, ' ')) != NULL)
732 if (!strcmp(fs_name, cp)) {
742 * Check to see if a filesystem is available as a module
743 * Returns 1 if found, 0 if not
745 int check_for_modules(const char *fs_name)
750 char buf[1024], *cp, *t;
755 snprintf(buf, sizeof(buf), "/lib/modules/%s/modules.dep", uts.release);
761 if (!fgets(buf, sizeof(buf), f))
763 if ((cp = strchr(buf, ':')) != NULL)
767 if ((cp = strrchr(buf, '/')) != NULL)
774 if (!strcmp(t, ".ko"))
777 if (!strcmp(cp, fs_name)) {
783 #endif /* __linux__ */
788 * Helper function that does the right thing if write returns a
789 * partial write, or an EAGAIN/EINTR error.
791 int write_all(int fd, char *buf, size_t count)
797 ret = write(fd, buf, count);
799 if ((errno == EAGAIN) || (errno == EINTR))
810 void dump_mmp_msg(struct mmp_struct *mmp, const char *fmt, ...)
815 printf("MMP check failed: ");
821 time_t t = mmp->mmp_time;
823 printf("MMP_block:\n");
824 printf(" mmp_magic: 0x%x\n", mmp->mmp_magic);
825 printf(" mmp_check_interval: %d\n",
826 mmp->mmp_check_interval);
827 printf(" mmp_sequence: %08x\n", mmp->mmp_seq);
828 printf(" mmp_update_date: %s", ctime(&t));
829 printf(" mmp_update_time: %lld\n",
830 (long long) mmp->mmp_time);
831 printf(" mmp_node_name: %.*s\n",
832 EXT2_LEN_STR(mmp->mmp_nodename));
833 printf(" mmp_device_name: %.*s\n",
834 EXT2_LEN_STR(mmp->mmp_bdevname));
838 errcode_t e2fsck_mmp_update(ext2_filsys fs)
842 retval = ext2fs_mmp_update(fs);
843 if (retval == EXT2_ET_MMP_CHANGE_ABORT)
844 dump_mmp_msg(fs->mmp_cmp,
845 _("UNEXPECTED INCONSISTENCY: the filesystem is "
846 "being modified while fsck is running.\n"));
851 void e2fsck_set_bitmap_type(ext2_filsys fs, unsigned int default_type,
852 const char *profile_name, unsigned int *old_type)
855 e2fsck_t ctx = (e2fsck_t) fs->priv_data;
858 *old_type = fs->default_bitmap_type;
859 profile_get_uint(ctx->profile, "bitmaps", profile_name, 0,
860 default_type, &type);
861 profile_get_uint(ctx->profile, "bitmaps", "all", 0, type, &type);
862 fs->default_bitmap_type = type ? type : default_type;
865 errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs, const char *descr,
868 ext2fs_inode_bitmap *ret)
871 unsigned int save_type;
873 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
874 retval = ext2fs_allocate_inode_bitmap(fs, descr, ret);
875 fs->default_bitmap_type = save_type;
879 errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs, const char *descr,
882 ext2fs_block_bitmap *ret)
885 unsigned int save_type;
887 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
888 retval = ext2fs_allocate_block_bitmap(fs, descr, ret);
889 fs->default_bitmap_type = save_type;
893 errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs, const char *descr,
896 ext2fs_block_bitmap *ret)
899 unsigned int save_type;
901 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
902 retval = ext2fs_allocate_subcluster_bitmap(fs, descr, ret);
903 fs->default_bitmap_type = save_type;
907 /* Return memory size in bytes */
908 unsigned long long get_memory_size(void)
910 #if defined(_SC_PHYS_PAGES)
911 # if defined(_SC_PAGESIZE)
912 return (unsigned long long)sysconf(_SC_PHYS_PAGES) *
913 (unsigned long long)sysconf(_SC_PAGESIZE);
914 # elif defined(_SC_PAGE_SIZE)
915 return (unsigned long long)sysconf(_SC_PHYS_PAGES) *
916 (unsigned long long)sysconf(_SC_PAGE_SIZE);
918 #elif defined(CTL_HW)
919 # if (defined(HW_MEMSIZE) || defined(HW_PHYSMEM64))
920 # define CTL_HW_INT64
921 # elif (defined(HW_PHYSMEM) || defined(HW_REALMEM))
927 # if defined(HW_MEMSIZE)
929 # elif defined(HW_PHYSMEM64)
930 mib[1] = HW_PHYSMEM64;
931 # elif defined(HW_REALMEM)
933 # elif defined(HW_PYSMEM)
936 # if defined(CTL_HW_INT64)
937 unsigned long long size = 0;
938 # elif defined(CTL_HW_UINT)
939 unsigned int size = 0;
943 # warning "Don't know how to detect memory on your platform?"