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);
83 fprintf(ctx->logf, "Exit status: %d\n", exit_value);
87 void log_out(e2fsck_t ctx, const char *fmt, ...)
96 vfprintf(ctx->logf, fmt, pvar);
101 void log_err(e2fsck_t ctx, const char *fmt, ...)
106 vfprintf(stderr, fmt, pvar);
110 vfprintf(ctx->logf, fmt, pvar);
115 void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned long size,
116 const char *description)
121 #ifdef DEBUG_ALLOCATE_MEMORY
122 printf("Allocating %lu bytes for %s...\n", size, description);
124 if (ext2fs_get_memzero(size, &ret)) {
125 sprintf(buf, "Can't allocate %lu bytes for %s\n",
127 fatal_error(ctx, buf);
133 char *string_copy(e2fsck_t ctx EXT2FS_ATTR((unused)),
134 const char *str, size_t len)
144 strncpy(ret, str, len);
152 * Incredibly, libc5 doesn't appear to have strnlen. So we have to
155 int e2fsck_strnlen(const char * s, int count)
159 while (count-- && *cp)
166 static int read_a_char(void)
173 if (e2fsck_global_ctx &&
174 (e2fsck_global_ctx->flags & E2F_FLAG_CANCEL)) {
187 int ask_yn(e2fsck_t ctx, const char * string, int def)
191 const char *short_yes = _("yY");
192 const char *short_no = _("nN");
193 const char *short_yesall = _("aA");
194 const char *english_yes = "yY";
195 const char *english_no = "nN";
196 const char *english_yesall = "aA";
197 const char *yesall_prompt = _(" ('a' enables 'yes' to all) ");
198 const char *extra_prompt = "";
199 static int yes_answers;
201 #ifdef HAVE_TERMIOS_H
202 struct termios termios, tmp;
204 if (tcgetattr (0, &termios) < 0)
205 memset(&termios, 0, sizeof(termios));
207 tmp.c_lflag &= ~(ICANON | ECHO);
210 tcsetattr (0, TCSANOW, &tmp);
214 defstr = _(_("<y>"));
216 defstr = _(_("<n>"));
218 defstr = _(" (y/n)");
220 * If the user presses 'y' more than 8 (but less than 12) times in
221 * succession without pressing anything else, display a hint about
224 if (yes_answers > 12)
226 else if (yes_answers > 8)
227 extra_prompt = yesall_prompt;
228 log_out(ctx, "%s%s%s? ", string, extra_prompt, defstr);
231 if ((c = read_a_char()) == EOF)
234 #ifdef HAVE_TERMIOS_H
235 tcsetattr (0, TCSANOW, &termios);
237 if (ctx->flags & E2F_FLAG_SETJMP_OK) {
239 longjmp(e2fsck_global_ctx->abort_loc, 1);
241 log_out(ctx, "%s", _("cancelled!\n"));
245 if (strchr(short_yes, (char) c)) {
248 if (yes_answers >= 0)
251 } else if (strchr(short_no, (char) c)) {
256 } else if (strchr(short_yesall, (char)c)) {
260 ctx->options |= E2F_OPT_YES;
262 } else if (strchr(english_yes, (char) c)) {
264 } else if (strchr(english_no, (char) c)) {
266 } else if (strchr(english_yesall, (char) c)) {
268 } else if ((c == 27 || c == ' ' || c == '\n') && (def != -1)) {
274 log_out(ctx, "%s", _("yes to all\n"));
276 log_out(ctx, "%s", _("yes\n"));
278 log_out(ctx, "%s", _("no\n"));
279 #ifdef HAVE_TERMIOS_H
280 tcsetattr (0, TCSANOW, &termios);
285 int ask (e2fsck_t ctx, const char * string, int def)
287 if (ctx->options & E2F_OPT_NO) {
288 log_out(ctx, _("%s? no\n\n"), string);
291 if (ctx->options & E2F_OPT_YES) {
292 log_out(ctx, _("%s? yes\n\n"), string);
295 if (ctx->options & E2F_OPT_PREEN) {
296 log_out(ctx, "%s? %s\n\n", string, def ? _("yes") : _("no"));
299 return ask_yn(ctx, string, def);
302 void e2fsck_read_bitmaps(e2fsck_t ctx)
304 ext2_filsys fs = ctx->fs;
307 unsigned int save_type;
310 if (ctx->invalid_bitmaps) {
311 com_err(ctx->program_name, 0,
312 _("e2fsck_read_bitmaps: illegal bitmap block(s) for %s"),
317 old_op = ehandler_operation(_("reading inode and block bitmaps"));
318 e2fsck_set_bitmap_type(fs, EXT2FS_BMAP64_RBTREE, "fs_bitmaps",
320 flags = ctx->fs->flags;
321 ctx->fs->flags |= EXT2_FLAG_IGNORE_CSUM_ERRORS;
322 retval = ext2fs_read_bitmaps(fs);
323 ctx->fs->flags = (flags & EXT2_FLAG_IGNORE_CSUM_ERRORS) |
324 (ctx->fs->flags & ~EXT2_FLAG_IGNORE_CSUM_ERRORS);
325 fs->default_bitmap_type = save_type;
326 ehandler_operation(old_op);
328 com_err(ctx->program_name, retval,
329 _("while retrying to read bitmaps for %s"),
335 void e2fsck_write_bitmaps(e2fsck_t ctx)
337 ext2_filsys fs = ctx->fs;
341 old_op = ehandler_operation(_("writing block and inode bitmaps"));
342 retval = ext2fs_write_bitmaps(fs);
343 ehandler_operation(old_op);
345 com_err(ctx->program_name, retval,
346 _("while rewriting block and inode bitmaps for %s"),
352 void preenhalt(e2fsck_t ctx)
354 ext2_filsys fs = ctx->fs;
356 if (!(ctx->options & E2F_OPT_PREEN))
358 log_err(ctx, _("\n\n%s: UNEXPECTED INCONSISTENCY; "
359 "RUN fsck MANUALLY.\n\t(i.e., without -a or -p options)\n"),
361 ctx->flags |= E2F_FLAG_EXITING;
363 fs->super->s_state |= EXT2_ERROR_FS;
364 ext2fs_mark_super_dirty(fs);
365 ext2fs_close_free(&fs);
367 exit(FSCK_UNCORRECTED);
370 #ifdef RESOURCE_TRACK
371 void init_resource_track(struct resource_track *track, io_channel channel)
373 #ifdef HAVE_GETRUSAGE
376 io_stats io_start = 0;
378 track->brk_start = sbrk(0);
379 gettimeofday(&track->time_start, 0);
380 #ifdef HAVE_GETRUSAGE
382 memset(&r, 0, sizeof(struct rusage));
384 getrusage(RUSAGE_SELF, &r);
385 track->user_start = r.ru_utime;
386 track->system_start = r.ru_stime;
388 track->user_start.tv_sec = track->user_start.tv_usec = 0;
389 track->system_start.tv_sec = track->system_start.tv_usec = 0;
391 track->bytes_read = 0;
392 track->bytes_written = 0;
393 if (channel && channel->manager && channel->manager->get_stats)
394 channel->manager->get_stats(channel, &io_start);
396 track->bytes_read = io_start->bytes_read;
397 track->bytes_written = io_start->bytes_written;
402 #define _INLINE_ __inline__
407 static _INLINE_ float timeval_subtract(struct timeval *tv1,
410 return ((tv1->tv_sec - tv2->tv_sec) +
411 ((float) (tv1->tv_usec - tv2->tv_usec)) / 1000000);
414 void print_resource_track(e2fsck_t ctx, const char *desc,
415 struct resource_track *track, io_channel channel)
417 #ifdef HAVE_GETRUSAGE
420 struct timeval time_end;
422 if ((desc && !(ctx->options & E2F_OPT_TIME2)) ||
423 (!desc && !(ctx->options & E2F_OPT_TIME)))
426 e2fsck_clear_progbar(ctx);
427 gettimeofday(&time_end, 0);
430 log_out(ctx, "%s: ", desc);
432 #define kbytes(x) (((unsigned long long)(x) + 1023) / 1024)
433 #ifdef HAVE_MALLINFO2
435 struct mallinfo2 malloc_info = mallinfo2();
437 log_out(ctx, _("Memory used: %lluk/%lluk (%lluk/%lluk), "),
438 kbytes(malloc_info.arena), kbytes(malloc_info.hblkhd),
439 kbytes(malloc_info.uordblks),
440 kbytes(malloc_info.fordblks));
442 #elif defined HAVE_MALLINFO
443 /* don't use mallinfo() if over 2GB used, since it returns "int" */
444 if ((unsigned long)((char *)sbrk(0) - (char *)track->brk_start) <
446 struct mallinfo malloc_info = mallinfo();
448 log_out(ctx, _("Memory used: %lluk/%lluk (%lluk/%lluk), "),
449 kbytes(malloc_info.arena), kbytes(malloc_info.hblkhd),
450 kbytes(malloc_info.uordblks),
451 kbytes(malloc_info.fordblks));
454 log_out(ctx, _("Memory used: %lluk, "),
455 kbytes(((char *)sbrk(0)) - ((char *)track->brk_start)));
457 #ifdef HAVE_GETRUSAGE
458 getrusage(RUSAGE_SELF, &r);
460 log_out(ctx, _("time: %5.2f/%5.2f/%5.2f\n"),
461 timeval_subtract(&time_end, &track->time_start),
462 timeval_subtract(&r.ru_utime, &track->user_start),
463 timeval_subtract(&r.ru_stime, &track->system_start));
465 log_out(ctx, _("elapsed time: %6.3f\n"),
466 timeval_subtract(&time_end, &track->time_start));
468 #define mbytes(x) (((x) + 1048575) / 1048576)
469 if (channel && channel->manager && channel->manager->get_stats) {
471 unsigned long long bytes_read = 0;
472 unsigned long long bytes_written = 0;
475 log_out(ctx, "%s: ", desc);
477 channel->manager->get_stats(channel, &delta);
479 bytes_read = delta->bytes_read - track->bytes_read;
480 bytes_written = delta->bytes_written -
481 track->bytes_written;
483 log_out(ctx, "I/O read: %lluMB, write: %lluMB, "
485 mbytes(bytes_read), mbytes(bytes_written),
486 (double)mbytes(bytes_read + bytes_written) /
487 timeval_subtract(&time_end, &track->time_start));
490 #endif /* RESOURCE_TRACK */
492 void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
493 struct ext2_inode * inode, const char *proc)
497 retval = ext2fs_read_inode(ctx->fs, ino, inode);
499 com_err("ext2fs_read_inode", retval,
500 _("while reading inode %lu in %s"), ino, proc);
505 void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
506 struct ext2_inode *inode, int bufsize,
511 retval = ext2fs_read_inode_full(ctx->fs, ino, inode, bufsize);
513 com_err("ext2fs_read_inode_full", retval,
514 _("while reading inode %lu in %s"), ino, proc);
519 void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
520 struct ext2_inode * inode, int bufsize,
525 retval = ext2fs_write_inode_full(ctx->fs, ino, inode, bufsize);
527 com_err("ext2fs_write_inode", retval,
528 _("while writing inode %lu in %s"), ino, proc);
533 void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
534 struct ext2_inode * inode, const char *proc)
538 retval = ext2fs_write_inode(ctx->fs, ino, inode);
540 com_err("ext2fs_write_inode", retval,
541 _("while writing inode %lu in %s"), ino, proc);
547 void mtrace_print(char *mesg)
549 FILE *malloc_get_mallstream();
550 FILE *f = malloc_get_mallstream();
553 fprintf(f, "============= %s\n", mesg);
557 blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs, const char *name,
560 struct ext2_super_block *sb;
561 io_channel io = NULL;
563 int blocksize = EXT2_MIN_BLOCK_SIZE;
564 int blocksize_known = 0;
566 blk64_t ret_sb = 8193;
568 if (fs && fs->super) {
569 blocksize = fs->blocksize;
571 bpg = fs->super->s_blocks_per_group;
574 if (ctx && ctx->blocksize) {
575 blocksize = ctx->blocksize;
579 if (!name || !manager)
582 if (manager->open(name, 0, &io) != 0)
585 if (ext2fs_get_mem(SUPERBLOCK_SIZE, &buf))
587 sb = (struct ext2_super_block *) buf;
589 for (; blocksize <= EXT2_MAX_BLOCK_SIZE; blocksize *= 2) {
590 dgrp_t grp, three = 1, five = 5, seven = 7;
592 blk_t this_bpg = bpg ? bpg : blocksize * 8;
595 if (fs && fs->super) {
596 num_blocks = ext2fs_blocks_count(fs->super);
597 } else if (ctx && ext2fs_get_device_size2(ctx->filesystem_name,
600 limit = num_blocks / this_bpg;
602 /* If we can't figure out the device size,
603 * arbitrarily set a limit which is enough for
604 * 8 block groups or so...
609 io_channel_set_blksize(io, blocksize);
611 while ((grp = ext2fs_list_backups(NULL, &three,
612 &five, &seven)) <= limit) {
613 blk64_t superblock = (blk64_t)grp * this_bpg;
615 if (blocksize == 1024)
617 if (io_channel_read_blk64(io, superblock,
618 -SUPERBLOCK_SIZE, buf))
620 #ifdef WORDS_BIGENDIAN
621 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
622 ext2fs_swap_super(sb);
624 if ((sb->s_magic == EXT2_SUPER_MAGIC) &&
625 (EXT2_BLOCK_SIZE(sb) == blocksize)) {
628 ctx->superblock = superblock;
629 ctx->blocksize = blocksize;
641 io_channel_close(io);
643 ext2fs_free_mem(&buf);
648 * Given a mode, return the ext2 file type
650 int ext2_file_type(unsigned int mode)
652 if (LINUX_S_ISREG(mode))
653 return EXT2_FT_REG_FILE;
655 if (LINUX_S_ISDIR(mode))
658 if (LINUX_S_ISCHR(mode))
659 return EXT2_FT_CHRDEV;
661 if (LINUX_S_ISBLK(mode))
662 return EXT2_FT_BLKDEV;
664 if (LINUX_S_ISLNK(mode))
665 return EXT2_FT_SYMLINK;
667 if (LINUX_S_ISFIFO(mode))
670 if (LINUX_S_ISSOCK(mode))
677 * Check to see if a filesystem is in /proc/filesystems.
678 * Returns 1 if found, 0 if not
680 int fs_proc_check(const char *fs_name)
683 char buf[80], *cp, *t;
685 f = fopen("/proc/filesystems", "r");
689 if (!fgets(buf, sizeof(buf), f))
693 while (*cp && !isspace(*cp))
696 while (*cp && isspace(*cp))
698 if ((t = strchr(cp, '\n')) != NULL)
700 if ((t = strchr(cp, '\t')) != NULL)
702 if ((t = strchr(cp, ' ')) != NULL)
704 if (!strcmp(fs_name, cp)) {
714 * Check to see if a filesystem is available as a module
715 * Returns 1 if found, 0 if not
717 int check_for_modules(const char *fs_name)
722 char buf[1024], *cp, *t;
727 snprintf(buf, sizeof(buf), "/lib/modules/%s/modules.dep", uts.release);
733 if (!fgets(buf, sizeof(buf), f))
735 if ((cp = strchr(buf, ':')) != NULL)
739 if ((cp = strrchr(buf, '/')) != NULL)
746 if (!strcmp(t, ".ko"))
749 if (!strcmp(cp, fs_name)) {
755 #endif /* __linux__ */
760 * Helper function that does the right thing if write returns a
761 * partial write, or an EAGAIN/EINTR error.
763 int write_all(int fd, char *buf, size_t count)
769 ret = write(fd, buf, count);
771 if ((errno == EAGAIN) || (errno == EINTR))
782 void dump_mmp_msg(struct mmp_struct *mmp, const char *fmt, ...)
787 printf("MMP check failed: ");
793 time_t t = mmp->mmp_time;
795 printf("MMP_block:\n");
796 printf(" mmp_magic: 0x%x\n", mmp->mmp_magic);
797 printf(" mmp_check_interval: %d\n",
798 mmp->mmp_check_interval);
799 printf(" mmp_sequence: %08x\n", mmp->mmp_seq);
800 printf(" mmp_update_date: %s", ctime(&t));
801 printf(" mmp_update_time: %lld\n",
802 (long long) mmp->mmp_time);
803 printf(" mmp_node_name: %.*s\n",
804 EXT2_LEN_STR(mmp->mmp_nodename));
805 printf(" mmp_device_name: %.*s\n",
806 EXT2_LEN_STR(mmp->mmp_bdevname));
810 errcode_t e2fsck_mmp_update(ext2_filsys fs)
814 retval = ext2fs_mmp_update(fs);
815 if (retval == EXT2_ET_MMP_CHANGE_ABORT)
816 dump_mmp_msg(fs->mmp_cmp,
817 _("UNEXPECTED INCONSISTENCY: the filesystem is "
818 "being modified while fsck is running.\n"));
823 void e2fsck_set_bitmap_type(ext2_filsys fs, unsigned int default_type,
824 const char *profile_name, unsigned int *old_type)
827 e2fsck_t ctx = (e2fsck_t) fs->priv_data;
830 *old_type = fs->default_bitmap_type;
831 profile_get_uint(ctx->profile, "bitmaps", profile_name, 0,
832 default_type, &type);
833 profile_get_uint(ctx->profile, "bitmaps", "all", 0, type, &type);
834 fs->default_bitmap_type = type ? type : default_type;
837 errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs, const char *descr,
840 ext2fs_inode_bitmap *ret)
843 unsigned int save_type;
845 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
846 retval = ext2fs_allocate_inode_bitmap(fs, descr, ret);
847 fs->default_bitmap_type = save_type;
851 errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs, const char *descr,
854 ext2fs_block_bitmap *ret)
857 unsigned int save_type;
859 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
860 retval = ext2fs_allocate_block_bitmap(fs, descr, ret);
861 fs->default_bitmap_type = save_type;
865 errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs, const char *descr,
868 ext2fs_block_bitmap *ret)
871 unsigned int save_type;
873 e2fsck_set_bitmap_type(fs, deftype, name, &save_type);
874 retval = ext2fs_allocate_subcluster_bitmap(fs, descr, ret);
875 fs->default_bitmap_type = save_type;
879 /* Return memory size in bytes */
880 unsigned long long get_memory_size(void)
882 #if defined(_SC_PHYS_PAGES)
883 # if defined(_SC_PAGESIZE)
884 return (unsigned long long)sysconf(_SC_PHYS_PAGES) *
885 (unsigned long long)sysconf(_SC_PAGESIZE);
886 # elif defined(_SC_PAGE_SIZE)
887 return (unsigned long long)sysconf(_SC_PHYS_PAGES) *
888 (unsigned long long)sysconf(_SC_PAGE_SIZE);
890 #elif defined(CTL_HW)
891 # if (defined(HW_MEMSIZE) || defined(HW_PHYSMEM64))
892 # define CTL_HW_INT64
893 # elif (defined(HW_PHYSMEM) || defined(HW_REALMEM))
899 # if defined(HW_MEMSIZE)
901 # elif defined(HW_PHYSMEM64)
902 mib[1] = HW_PHYSMEM64;
903 # elif defined(HW_REALMEM)
905 # elif defined(HW_PYSMEM)
908 # if defined(CTL_HW_INT64)
909 unsigned long long size = 0;
910 # elif defined(CTL_HW_UINT)
911 unsigned int size = 0;
915 # warning "Don't know how to detect memory on your platform?"