2 * util.c --- utilities for the debugfs program
4 * Copyright (C) 1993, 1994 Theodore Ts'o. This file may be
5 * redistributed under the terms of the GNU Public License.
9 #define _XOPEN_SOURCE 600 /* needed for strptime */
26 extern int optreset; /* defined by BSD, but not others */
33 * This function resets the libc getopt() function, which keeps
34 * internal state. Bad design! Stupid libc API designers! No
37 * BSD-derived getopt() functions require that optind be reset to 1 in
38 * order to reset getopt() state. This used to be generally accepted
39 * way of resetting getopt(). However, glibc's getopt()
40 * has additional getopt() state beyond optind, and requires that
41 * optind be set zero to reset its state. So the unfortunate state of
42 * affairs is that BSD-derived versions of getopt() misbehave if
43 * optind is set to 0 in order to reset getopt(), and glibc's getopt()
44 * will core dump if optind is set 1 in order to reset getopt().
46 * More modern versions of BSD require that optreset be set to 1 in
47 * order to reset getopt(). Sigh. Standards, anyone?
49 * We hide the hair here.
51 void reset_getopt(void)
53 #if defined(__GLIBC__) || defined(__linux__)
59 optreset = 1; /* Makes BSD getopt happy */
63 static const char *pager_search_list[] = { "pager", "more", "less", 0 };
64 static const char *pager_dir_list[] = { "/usr/bin", "/bin", 0 };
66 static const char *find_pager(char *buf)
70 for (i = pager_search_list; *i; i++) {
71 for (j = pager_dir_list; *j; j++) {
72 sprintf(buf, "%s/%s", *j, *i);
73 if (access(buf, X_OK) == 0)
80 FILE *open_pager(void)
83 const char *pager = ss_safe_getenv("DEBUGFS_PAGER");
86 signal(SIGPIPE, SIG_IGN);
90 pager = ss_safe_getenv("PAGER");
92 pager = find_pager(buf);
94 (strcmp(pager, "__none__") == 0) ||
95 ((outfile = popen(pager, "w")) == 0))
100 void close_pager(FILE *stream)
102 if (stream && stream != stdout) pclose(stream);
106 * This routine is used whenever a command needs to turn a string into
109 ext2_ino_t string_to_inode(char *str)
112 int len = strlen(str);
117 * If the string is of the form <ino>, then treat it as an
120 if ((len > 2) && (str[0] == '<') && (str[len-1] == '>')) {
121 ino = strtoul(str+1, &end, 0);
122 if (*end=='>' && (ino <= current_fs->super->s_inodes_count))
126 retval = ext2fs_namei(current_fs, root, cwd, str, &ino);
128 com_err(str, retval, 0);
131 if (ino > current_fs->super->s_inodes_count) {
132 com_err(str, 0, "resolves to an illegal inode number: %u\n",
140 * This routine returns 1 if the filesystem is not open, and prints an
141 * error message to that effect.
143 int check_fs_open(char *name)
146 com_err(name, 0, "Filesystem not open");
153 * This routine returns 1 if a filesystem is open, and prints an
154 * error message to that effect.
156 int check_fs_not_open(char *name)
160 "Filesystem %s is still open. Close it first.\n",
161 current_fs->device_name);
168 * This routine returns 1 if a filesystem is not opened read/write,
169 * and prints an error message to that effect.
171 int check_fs_read_write(char *name)
173 if (!(current_fs->flags & EXT2_FLAG_RW)) {
174 com_err(name, 0, "Filesystem opened read/only");
181 * This routine returns 1 if a filesystem is doesn't have its inode
182 * and block bitmaps loaded, and prints an error message to that
185 int check_fs_bitmaps(char *name)
187 if (!current_fs->block_map || !current_fs->inode_map) {
188 com_err(name, 0, "Filesystem bitmaps not loaded");
195 * This function takes a __s64 time value and converts it to a string,
198 char *time_to_string(__s64 cl)
200 static int do_gmt = -1;
201 time_t t = (time_t) cl;
205 /* The diet libc doesn't respect the TZ environment variable */
206 tz = ss_safe_getenv("TZ");
209 do_gmt = !strcmp(tz, "GMT") || !strcmp(tz, "GMT0");
212 return asctime((do_gmt) ? gmtime(&t) : localtime(&t));
216 * Parse a string as a time. Return ((time_t)-1) if the string
217 * doesn't appear to be a sane time.
219 extern __s64 string_to_time(const char *arg)
225 if (strcmp(arg, "now") == 0) {
229 /* interpret it as an integer */
232 ret = strtoll(arg, &tmp, 0);
237 memset(&ts, 0, sizeof(ts));
239 tmp = strptime(arg, "%Y%m%d%H%M%S", &ts);
241 tmp = strptime(arg, "%Y%m%d%H%M", &ts);
243 tmp = strptime(arg, "%Y%m%d", &ts);
247 sscanf(arg, "%4d%2d%2d%2d%2d%2d", &ts.tm_year, &ts.tm_mon,
248 &ts.tm_mday, &ts.tm_hour, &ts.tm_min, &ts.tm_sec);
251 if (ts.tm_year < 0 || ts.tm_mon < 0 || ts.tm_mon > 11 ||
252 ts.tm_mday <= 0 || ts.tm_mday > 31 || ts.tm_hour > 23 ||
253 ts.tm_min > 59 || ts.tm_sec > 61)
257 /* strptime() may only update the specified fields, which does not
258 * necessarily include ts.tm_yday (%j). Calculate this if unset:
260 * Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
261 * 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
263 * Start with 31 days per month. Even months have only 30 days, but
264 * reverse in August, subtract one day for those months. February has
265 * only 28 days, not 30, subtract two days. Add day of month, minus
266 * one, since day is not finished yet. Leap years handled afterward. */
268 ts.tm_yday = (ts.tm_mon * 31) -
269 ((ts.tm_mon - (ts.tm_mon > 7)) / 2) -
270 2 * (ts.tm_mon > 1) + ts.tm_mday - 1;
271 ret = ts.tm_sec + ts.tm_min*60 + ts.tm_hour*3600 + ts.tm_yday*86400 +
272 ((__s64) ts.tm_year-70)*31536000 +
273 (((__s64) ts.tm_year-69)/4)*86400 -
274 (((__s64) ts.tm_year-1)/100)*86400 +
275 (((__s64) ts.tm_year+299)/400)*86400;
280 * This function will convert a string to an unsigned long, printing
281 * an error message if it fails, and returning success or failure in err.
283 unsigned long parse_ulong(const char *str, const char *cmd,
284 const char *descr, int *err)
289 ret = strtoul(str, &tmp, 0);
295 com_err(cmd, 0, "Bad %s - %s", descr, str);
304 * This function will convert a string to an unsigned long long, printing
305 * an error message if it fails, and returning success or failure in err.
307 unsigned long long parse_ulonglong(const char *str, const char *cmd,
308 const char *descr, int *err)
311 unsigned long long ret;
313 ret = strtoull(str, &tmp, 0);
319 com_err(cmd, 0, "Bad %s - %s", descr, str);
328 * This function will convert a string to a block number. It returns
329 * 0 on success, 1 on failure. On failure, it outputs either an optionally
330 * specified error message or a default.
332 int strtoblk(const char *cmd, const char *str, const char *errmsg,
339 blk = parse_ulonglong(str, cmd, "block number", &err);
341 blk = parse_ulonglong(str, cmd, errmsg, &err);
347 * This is a common helper function used by the command processing
350 int common_args_process(int argc, char *argv[], int min_argc, int max_argc,
351 const char *cmd, const char *usage, int flags)
353 if (argc < min_argc || argc > max_argc) {
354 com_err(argv[0], 0, "Usage: %s %s", cmd, usage);
357 if (flags & CHECK_FS_NOTOPEN) {
358 if (check_fs_not_open(argv[0]))
361 if (check_fs_open(argv[0]))
364 if ((flags & CHECK_FS_RW) && check_fs_read_write(argv[0]))
366 if ((flags & CHECK_FS_BITMAPS) && check_fs_bitmaps(argv[0]))
372 * This is a helper function used by do_stat, do_freei, do_seti, and
373 * do_testi, etc. Basically, any command which takes a single
374 * argument which is a file/inode number specifier.
376 int common_inode_args_process(int argc, char *argv[],
377 ext2_ino_t *inode, int flags)
379 if (common_args_process(argc, argv, 2, 2, argv[0], "<file>", flags))
382 *inode = string_to_inode(argv[1]);
389 * This is a helper function used by do_freeb, do_setb, and do_testb
391 int common_block_args_process(int argc, char *argv[],
392 blk64_t *block, blk64_t *count)
396 if (common_args_process(argc, argv, 2, 3, argv[0],
397 "<block> [count]", CHECK_FS_BITMAPS))
400 if (strtoblk(argv[0], argv[1], NULL, block))
403 com_err(argv[0], 0, "Invalid block number 0");
408 err = strtoblk(argv[0], argv[2], "count", count);
415 int debugfs_read_inode2(ext2_ino_t ino, struct ext2_inode * inode,
416 const char *cmd, int bufsize, int flags)
420 retval = ext2fs_read_inode2(current_fs, ino, inode, bufsize, flags);
422 com_err(cmd, retval, "while reading inode %u", ino);
428 int debugfs_read_inode(ext2_ino_t ino, struct ext2_inode * inode,
433 retval = ext2fs_read_inode(current_fs, ino, inode);
435 com_err(cmd, retval, "while reading inode %u", ino);
441 int debugfs_write_inode2(ext2_ino_t ino,
442 struct ext2_inode *inode,
444 int bufsize, int flags)
448 retval = ext2fs_write_inode2(current_fs, ino, inode, bufsize, flags);
450 com_err(cmd, retval, "while writing inode %u", ino);
456 int debugfs_write_inode(ext2_ino_t ino, struct ext2_inode * inode,
461 retval = ext2fs_write_inode(current_fs, ino, inode);
463 com_err(cmd, retval, "while writing inode %u", ino);
469 int debugfs_write_new_inode(ext2_ino_t ino, struct ext2_inode * inode,
474 retval = ext2fs_write_new_inode(current_fs, ino, inode);
476 com_err(cmd, retval, "while creating inode %u", ino);
483 * Given a mode, return the ext2 file type
485 int ext2_file_type(unsigned int mode)
487 if (LINUX_S_ISREG(mode))
488 return EXT2_FT_REG_FILE;
490 if (LINUX_S_ISDIR(mode))
493 if (LINUX_S_ISCHR(mode))
494 return EXT2_FT_CHRDEV;
496 if (LINUX_S_ISBLK(mode))
497 return EXT2_FT_BLKDEV;
499 if (LINUX_S_ISLNK(mode))
500 return EXT2_FT_SYMLINK;
502 if (LINUX_S_ISFIFO(mode))
505 if (LINUX_S_ISSOCK(mode))
511 errcode_t read_list(char *str, blk64_t **list, size_t *len)
513 blk64_t *lst = *list;
516 errcode_t retval = 0;
518 while ((tok = strtok(p, ","))) {
524 y = x = strtoull(tok, &e, 0);
530 y = strtoull(e + 1, NULL, 0);
535 } else if (*e != 0) {
543 l = realloc(lst, sizeof(blk64_t) * (ln + y - x + 1));
559 void do_byte_hexdump(FILE *fp, unsigned char *buf, size_t bufsize)
564 for (i = 0; i < bufsize; i += 16) {
565 max = (bufsize - i > 16) ? 16 : bufsize - i;
567 if (i && memcmp(buf + i, buf + i - max, max) == 0) {
573 if (memcmp(buf + i, buf + suppress, max) == 0)
577 fprintf(fp, "%04o ", (unsigned int)i);
578 for (j = 0; j < 16; j++) {
580 fprintf(fp, "%02x", buf[i+j]);
587 for (j = 0; j < max; j++)
588 fprintf(fp, "%c", isprint(buf[i+j]) ? buf[i+j] : '.');