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
;
271 if (ctx
->invalid_bitmaps
) {
272 com_err(ctx
->program_name
, 0,
273 _("e2fsck_read_bitmaps: illegal bitmap block(s) for %s"),
278 old_op
= ehandler_operation(_("reading inode and block bitmaps"));
279 e2fsck_set_bitmap_type(fs
, EXT2FS_BMAP64_RBTREE
, "fs_bitmaps",
281 retval
= ext2fs_read_bitmaps(fs
);
282 fs
->default_bitmap_type
= save_type
;
283 ehandler_operation(old_op
);
285 com_err(ctx
->program_name
, retval
,
286 _("while retrying to read bitmaps for %s"),
292 void e2fsck_write_bitmaps(e2fsck_t ctx
)
294 ext2_filsys fs
= ctx
->fs
;
298 old_op
= ehandler_operation(_("writing block and inode bitmaps"));
299 retval
= ext2fs_write_bitmaps(fs
);
300 ehandler_operation(old_op
);
302 com_err(ctx
->program_name
, retval
,
303 _("while rewriting block and inode bitmaps for %s"),
309 void preenhalt(e2fsck_t ctx
)
311 ext2_filsys fs
= ctx
->fs
;
313 if (!(ctx
->options
& E2F_OPT_PREEN
))
315 log_err(ctx
, _("\n\n%s: UNEXPECTED INCONSISTENCY; "
316 "RUN fsck MANUALLY.\n\t(i.e., without -a or -p options)\n"),
318 ctx
->flags
|= E2F_FLAG_EXITING
;
320 fs
->super
->s_state
|= EXT2_ERROR_FS
;
321 ext2fs_mark_super_dirty(fs
);
324 exit(FSCK_UNCORRECTED
);
327 #ifdef RESOURCE_TRACK
328 void init_resource_track(struct resource_track
*track
, io_channel channel
)
330 #ifdef HAVE_GETRUSAGE
333 io_stats io_start
= 0;
335 track
->brk_start
= sbrk(0);
336 gettimeofday(&track
->time_start
, 0);
337 #ifdef HAVE_GETRUSAGE
339 memset(&r
, 0, sizeof(struct rusage
));
341 getrusage(RUSAGE_SELF
, &r
);
342 track
->user_start
= r
.ru_utime
;
343 track
->system_start
= r
.ru_stime
;
345 track
->user_start
.tv_sec
= track
->user_start
.tv_usec
= 0;
346 track
->system_start
.tv_sec
= track
->system_start
.tv_usec
= 0;
348 track
->bytes_read
= 0;
349 track
->bytes_written
= 0;
350 if (channel
&& channel
->manager
&& channel
->manager
->get_stats
)
351 channel
->manager
->get_stats(channel
, &io_start
);
353 track
->bytes_read
= io_start
->bytes_read
;
354 track
->bytes_written
= io_start
->bytes_written
;
359 #define _INLINE_ __inline__
364 static _INLINE_
float timeval_subtract(struct timeval
*tv1
,
367 return ((tv1
->tv_sec
- tv2
->tv_sec
) +
368 ((float) (tv1
->tv_usec
- tv2
->tv_usec
)) / 1000000);
371 void print_resource_track(e2fsck_t ctx
, const char *desc
,
372 struct resource_track
*track
, io_channel channel
)
374 #ifdef HAVE_GETRUSAGE
378 struct mallinfo malloc_info
;
380 struct timeval time_end
;
382 if ((desc
&& !(ctx
->options
& E2F_OPT_TIME2
)) ||
383 (!desc
&& !(ctx
->options
& E2F_OPT_TIME
)))
386 e2fsck_clear_progbar(ctx
);
387 gettimeofday(&time_end
, 0);
390 log_out(ctx
, "%s: ", desc
);
393 #define kbytes(x) (((unsigned long)(x) + 1023) / 1024)
395 malloc_info
= mallinfo();
396 log_out(ctx
, _("Memory used: %luk/%luk (%luk/%luk), "),
397 kbytes(malloc_info
.arena
), kbytes(malloc_info
.hblkhd
),
398 kbytes(malloc_info
.uordblks
), kbytes(malloc_info
.fordblks
));
400 log_out(ctx
, _("Memory used: %lu, "),
401 (unsigned long) (((char *) sbrk(0)) -
402 ((char *) track
->brk_start
)));
404 #ifdef HAVE_GETRUSAGE
405 getrusage(RUSAGE_SELF
, &r
);
407 log_out(ctx
, _("time: %5.2f/%5.2f/%5.2f\n"),
408 timeval_subtract(&time_end
, &track
->time_start
),
409 timeval_subtract(&r
.ru_utime
, &track
->user_start
),
410 timeval_subtract(&r
.ru_stime
, &track
->system_start
));
412 log_out(ctx
, _("elapsed time: %6.3f\n"),
413 timeval_subtract(&time_end
, &track
->time_start
));
415 #define mbytes(x) (((x) + 1048575) / 1048576)
416 if (channel
&& channel
->manager
&& channel
->manager
->get_stats
) {
418 unsigned long long bytes_read
= 0;
419 unsigned long long bytes_written
= 0;
422 log_out(ctx
, "%s: ", desc
);
424 channel
->manager
->get_stats(channel
, &delta
);
426 bytes_read
= delta
->bytes_read
- track
->bytes_read
;
427 bytes_written
= delta
->bytes_written
-
428 track
->bytes_written
;
430 log_out(ctx
, "I/O read: %lluMB, write: %lluMB, "
432 mbytes(bytes_read
), mbytes(bytes_written
),
433 (double)mbytes(bytes_read
+ bytes_written
) /
434 timeval_subtract(&time_end
, &track
->time_start
));
437 #endif /* RESOURCE_TRACK */
439 void e2fsck_read_inode(e2fsck_t ctx
, unsigned long ino
,
440 struct ext2_inode
* inode
, const char *proc
)
444 retval
= ext2fs_read_inode(ctx
->fs
, ino
, inode
);
446 com_err("ext2fs_read_inode", retval
,
447 _("while reading inode %lu in %s"), ino
, proc
);
452 void e2fsck_read_inode_full(e2fsck_t ctx
, unsigned long ino
,
453 struct ext2_inode
*inode
, int bufsize
,
458 retval
= ext2fs_read_inode_full(ctx
->fs
, ino
, inode
, bufsize
);
460 com_err("ext2fs_read_inode_full", retval
,
461 _("while reading inode %lu in %s"), ino
, proc
);
466 extern void e2fsck_write_inode_full(e2fsck_t ctx
, unsigned long ino
,
467 struct ext2_inode
* inode
, int bufsize
,
472 retval
= ext2fs_write_inode_full(ctx
->fs
, ino
, inode
, bufsize
);
474 com_err("ext2fs_write_inode", retval
,
475 _("while writing inode %lu in %s"), ino
, proc
);
480 extern void e2fsck_write_inode(e2fsck_t ctx
, unsigned long ino
,
481 struct ext2_inode
* inode
, const char *proc
)
485 retval
= ext2fs_write_inode(ctx
->fs
, ino
, inode
);
487 com_err("ext2fs_write_inode", retval
,
488 _("while writing inode %lu in %s"), ino
, proc
);
494 void mtrace_print(char *mesg
)
496 FILE *malloc_get_mallstream();
497 FILE *f
= malloc_get_mallstream();
500 fprintf(f
, "============= %s\n", mesg
);
504 blk64_t
get_backup_sb(e2fsck_t ctx
, ext2_filsys fs
, const char *name
,
507 struct ext2_super_block
*sb
;
508 io_channel io
= NULL
;
511 blk64_t superblock
, ret_sb
= 8193;
513 if (fs
&& fs
->super
) {
514 ret_sb
= (fs
->super
->s_blocks_per_group
+
515 fs
->super
->s_first_data_block
);
517 ctx
->superblock
= ret_sb
;
518 ctx
->blocksize
= fs
->blocksize
;
524 if (ctx
->blocksize
) {
525 ret_sb
= ctx
->blocksize
* 8;
526 if (ctx
->blocksize
== 1024)
528 ctx
->superblock
= ret_sb
;
531 ctx
->superblock
= ret_sb
;
532 ctx
->blocksize
= 1024;
535 if (!name
|| !manager
)
538 if (manager
->open(name
, 0, &io
) != 0)
541 if (ext2fs_get_mem(SUPERBLOCK_SIZE
, &buf
))
543 sb
= (struct ext2_super_block
*) buf
;
545 for (blocksize
= EXT2_MIN_BLOCK_SIZE
;
546 blocksize
<= EXT2_MAX_BLOCK_SIZE
; blocksize
*= 2) {
547 superblock
= blocksize
*8;
548 if (blocksize
== 1024)
550 io_channel_set_blksize(io
, blocksize
);
551 if (io_channel_read_blk64(io
, superblock
,
552 -SUPERBLOCK_SIZE
, buf
))
554 #ifdef WORDS_BIGENDIAN
555 if (sb
->s_magic
== ext2fs_swab16(EXT2_SUPER_MAGIC
))
556 ext2fs_swap_super(sb
);
558 if ((sb
->s_magic
== EXT2_SUPER_MAGIC
) &&
559 (EXT2_BLOCK_SIZE(sb
) == blocksize
)) {
562 ctx
->superblock
= superblock
;
563 ctx
->blocksize
= blocksize
;
571 io_channel_close(io
);
573 ext2fs_free_mem(&buf
);
578 * Given a mode, return the ext2 file type
580 int ext2_file_type(unsigned int mode
)
582 if (LINUX_S_ISREG(mode
))
583 return EXT2_FT_REG_FILE
;
585 if (LINUX_S_ISDIR(mode
))
588 if (LINUX_S_ISCHR(mode
))
589 return EXT2_FT_CHRDEV
;
591 if (LINUX_S_ISBLK(mode
))
592 return EXT2_FT_BLKDEV
;
594 if (LINUX_S_ISLNK(mode
))
595 return EXT2_FT_SYMLINK
;
597 if (LINUX_S_ISFIFO(mode
))
600 if (LINUX_S_ISSOCK(mode
))
606 #define STRIDE_LENGTH 8
608 * Helper function which zeros out _num_ blocks starting at _blk_. In
609 * case of an error, the details of the error is returned via _ret_blk_
610 * and _ret_count_ if they are non-NULL pointers. Returns 0 on
611 * success, and an error code on an error.
613 * As a special case, if the first argument is NULL, then it will
614 * attempt to free the static zeroizing buffer. (This is to keep
615 * programs that check for memory leaks happy.)
617 errcode_t
e2fsck_zero_blocks(ext2_filsys fs
, blk_t blk
, int num
,
618 blk_t
*ret_blk
, int *ret_count
)
624 /* If fs is null, clean up the static buffer and return */
632 /* Allocate the zeroizing buffer if necessary */
634 buf
= malloc(fs
->blocksize
* STRIDE_LENGTH
);
636 com_err("malloc", ENOMEM
, "%s",
637 _("while allocating zeroizing buffer"));
640 memset(buf
, 0, fs
->blocksize
* STRIDE_LENGTH
);
642 /* OK, do the write loop */
643 for (j
= 0; j
< num
; j
+= STRIDE_LENGTH
, blk
+= STRIDE_LENGTH
) {
645 if (count
> STRIDE_LENGTH
)
646 count
= STRIDE_LENGTH
;
647 retval
= io_channel_write_blk64(fs
->io
, blk
, count
, buf
);
660 * Check to see if a filesystem is in /proc/filesystems.
661 * Returns 1 if found, 0 if not
663 int fs_proc_check(const char *fs_name
)
666 char buf
[80], *cp
, *t
;
668 f
= fopen("/proc/filesystems", "r");
672 if (!fgets(buf
, sizeof(buf
), f
))
676 while (*cp
&& !isspace(*cp
))
679 while (*cp
&& isspace(*cp
))
681 if ((t
= strchr(cp
, '\n')) != NULL
)
683 if ((t
= strchr(cp
, '\t')) != NULL
)
685 if ((t
= strchr(cp
, ' ')) != NULL
)
687 if (!strcmp(fs_name
, cp
)) {
697 * Check to see if a filesystem is available as a module
698 * Returns 1 if found, 0 if not
700 int check_for_modules(const char *fs_name
)
705 char buf
[1024], *cp
, *t
;
710 snprintf(buf
, sizeof(buf
), "/lib/modules/%s/modules.dep", uts
.release
);
716 if (!fgets(buf
, sizeof(buf
), f
))
718 if ((cp
= strchr(buf
, ':')) != NULL
)
722 if ((cp
= strrchr(buf
, '/')) != NULL
)
729 if (!strcmp(t
, ".ko"))
732 if (!strcmp(cp
, fs_name
)) {
738 #endif /* __linux__ */
743 * Helper function that does the right thing if write returns a
744 * partial write, or an EGAIN/EINTR error.
746 int write_all(int fd
, char *buf
, size_t count
)
752 ret
= write(fd
, buf
, count
);
754 if ((errno
== EAGAIN
) || (errno
== EINTR
))
765 void dump_mmp_msg(struct mmp_struct
*mmp
, const char *msg
)
769 printf("MMP check failed: %s\n", msg
);
771 time_t t
= mmp
->mmp_time
;
773 printf("MMP error info: last update: %s node: %s device: %s\n",
774 ctime(&t
), mmp
->mmp_nodename
, mmp
->mmp_bdevname
);
778 errcode_t
e2fsck_mmp_update(ext2_filsys fs
)
782 retval
= ext2fs_mmp_update(fs
);
783 if (retval
== EXT2_ET_MMP_CHANGE_ABORT
)
784 dump_mmp_msg(fs
->mmp_cmp
,
785 _("UNEXPECTED INCONSISTENCY: the filesystem is "
786 "being modified while fsck is running.\n"));
791 void e2fsck_set_bitmap_type(ext2_filsys fs
, unsigned int default_type
,
792 const char *profile_name
, unsigned int *old_type
)
797 *old_type
= fs
->default_bitmap_type
;
798 profile_get_uint(e2fsck_global_ctx
->profile
, "bitmaps",
799 profile_name
, 0, default_type
, &type
);
800 profile_get_uint(e2fsck_global_ctx
->profile
, "bitmaps",
801 "all", 0, type
, &type
);
802 fs
->default_bitmap_type
= type
? type
: default_type
;
805 errcode_t
e2fsck_allocate_inode_bitmap(ext2_filsys fs
, const char *descr
,
808 ext2fs_inode_bitmap
*ret
)
811 unsigned int save_type
;
813 e2fsck_set_bitmap_type(fs
, deftype
, name
, &save_type
);
814 retval
= ext2fs_allocate_inode_bitmap(fs
, descr
, ret
);
815 fs
->default_bitmap_type
= save_type
;
819 errcode_t
e2fsck_allocate_block_bitmap(ext2_filsys fs
, const char *descr
,
822 ext2fs_block_bitmap
*ret
)
825 unsigned int save_type
;
827 e2fsck_set_bitmap_type(fs
, deftype
, name
, &save_type
);
828 retval
= ext2fs_allocate_block_bitmap(fs
, descr
, ret
);
829 fs
->default_bitmap_type
= save_type
;
833 errcode_t
e2fsck_allocate_subcluster_bitmap(ext2_filsys fs
, const char *descr
,
836 ext2fs_block_bitmap
*ret
)
839 unsigned int save_type
;
841 e2fsck_set_bitmap_type(fs
, deftype
, name
, &save_type
);
842 retval
= ext2fs_allocate_subcluster_bitmap(fs
, descr
, ret
);
843 fs
->default_bitmap_type
= save_type
;