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);
126 retval = ext2fs_namei(current_fs, root, cwd, str, &ino);
128 com_err(str, retval, 0);
135 * This routine returns 1 if the filesystem is not open, and prints an
136 * error message to that effect.
138 int check_fs_open(char *name)
141 com_err(name, 0, "Filesystem not open");
148 * This routine returns 1 if a filesystem is open, and prints an
149 * error message to that effect.
151 int check_fs_not_open(char *name)
155 "Filesystem %s is still open. Close it first.\n",
156 current_fs->device_name);
163 * This routine returns 1 if a filesystem is not opened read/write,
164 * and prints an error message to that effect.
166 int check_fs_read_write(char *name)
168 if (!(current_fs->flags & EXT2_FLAG_RW)) {
169 com_err(name, 0, "Filesystem opened read/only");
176 * This routine returns 1 if a filesystem is doesn't have its inode
177 * and block bitmaps loaded, and prints an error message to that
180 int check_fs_bitmaps(char *name)
182 if (!current_fs->block_map || !current_fs->inode_map) {
183 com_err(name, 0, "Filesystem bitmaps not loaded");
190 * This function takes a __u32 time value and converts it to a string,
193 char *time_to_string(__u32 cl)
195 static int do_gmt = -1;
196 time_t t = (time_t) cl;
200 /* The diet libc doesn't respect the TZ environemnt variable */
201 tz = ss_safe_getenv("TZ");
204 do_gmt = !strcmp(tz, "GMT") | !strcmp(tz, "GMT0");
207 return asctime((do_gmt) ? gmtime(&t) : localtime(&t));
211 * Parse a string as a time. Return ((time_t)-1) if the string
212 * doesn't appear to be a sane time.
214 time_t string_to_time(const char *arg)
220 if (strcmp(arg, "now") == 0) {
224 /* interpret it as an integer */
227 ret = strtoul(arg, &tmp, 0);
229 return ((time_t) -1);
232 memset(&ts, 0, sizeof(ts));
234 tmp = strptime(arg, "%Y%m%d%H%M%S", &ts);
238 sscanf(arg, "%4d%2d%2d%2d%2d%2d", &ts.tm_year, &ts.tm_mon,
239 &ts.tm_mday, &ts.tm_hour, &ts.tm_min, &ts.tm_sec);
242 if (ts.tm_year < 0 || ts.tm_mon < 0 || ts.tm_mon > 11 ||
243 ts.tm_mday < 0 || ts.tm_mday > 31 || ts.tm_hour > 23 ||
244 ts.tm_min > 59 || ts.tm_sec > 61)
248 ret = ts.tm_sec + ts.tm_min*60 + ts.tm_hour*3600 + ts.tm_yday*86400 +
249 (ts.tm_year-70)*31536000 + ((ts.tm_year-69)/4)*86400 -
250 ((ts.tm_year-1)/100)*86400 + ((ts.tm_year+299)/400)*86400;
255 * This function will convert a string to an unsigned long, printing
256 * an error message if it fails, and returning success or failure in err.
258 unsigned long parse_ulong(const char *str, const char *cmd,
259 const char *descr, int *err)
264 ret = strtoul(str, &tmp, 0);
270 com_err(cmd, 0, "Bad %s - %s", descr, str);
279 * This function will convert a string to an unsigned long long, printing
280 * an error message if it fails, and returning success or failure in err.
282 unsigned long long parse_ulonglong(const char *str, const char *cmd,
283 const char *descr, int *err)
286 unsigned long long ret;
288 ret = strtoull(str, &tmp, 0);
294 com_err(cmd, 0, "Bad %s - %s", descr, str);
303 * This function will convert a string to a block number. It returns
304 * 0 on success, 1 on failure. On failure, it outputs either an optionally
305 * specified error message or a default.
307 int strtoblk(const char *cmd, const char *str, const char *errmsg,
314 blk = parse_ulonglong(str, cmd, "block number", &err);
316 blk = parse_ulonglong(str, cmd, errmsg, &err);
322 * This is a common helper function used by the command processing
325 int common_args_process(int argc, char *argv[], int min_argc, int max_argc,
326 const char *cmd, const char *usage, int flags)
328 if (argc < min_argc || argc > max_argc) {
329 com_err(argv[0], 0, "Usage: %s %s", cmd, usage);
332 if (flags & CHECK_FS_NOTOPEN) {
333 if (check_fs_not_open(argv[0]))
336 if (check_fs_open(argv[0]))
339 if ((flags & CHECK_FS_RW) && check_fs_read_write(argv[0]))
341 if ((flags & CHECK_FS_BITMAPS) && check_fs_bitmaps(argv[0]))
347 * This is a helper function used by do_stat, do_freei, do_seti, and
348 * do_testi, etc. Basically, any command which takes a single
349 * argument which is a file/inode number specifier.
351 int common_inode_args_process(int argc, char *argv[],
352 ext2_ino_t *inode, int flags)
354 if (common_args_process(argc, argv, 2, 2, argv[0], "<file>", flags))
357 *inode = string_to_inode(argv[1]);
364 * This is a helper function used by do_freeb, do_setb, and do_testb
366 int common_block_args_process(int argc, char *argv[],
367 blk64_t *block, blk64_t *count)
371 if (common_args_process(argc, argv, 2, 3, argv[0],
372 "<block> [count]", CHECK_FS_BITMAPS))
375 if (strtoblk(argv[0], argv[1], NULL, block))
378 com_err(argv[0], 0, "Invalid block number 0");
383 err = strtoblk(argv[0], argv[2], "count", count);
390 int debugfs_read_inode_full(ext2_ino_t ino, struct ext2_inode * inode,
391 const char *cmd, int bufsize)
395 retval = ext2fs_read_inode_full(current_fs, ino, inode, bufsize);
397 com_err(cmd, retval, "while reading inode %u", ino);
403 int debugfs_read_inode(ext2_ino_t ino, struct ext2_inode * inode,
408 retval = ext2fs_read_inode(current_fs, ino, inode);
410 com_err(cmd, retval, "while reading inode %u", ino);
416 int debugfs_write_inode_full(ext2_ino_t ino,
417 struct ext2_inode *inode,
423 retval = ext2fs_write_inode_full(current_fs, ino,
426 com_err(cmd, retval, "while writing inode %u", ino);
432 int debugfs_write_inode(ext2_ino_t ino, struct ext2_inode * inode,
437 retval = ext2fs_write_inode(current_fs, ino, inode);
439 com_err(cmd, retval, "while writing inode %u", ino);
445 int debugfs_write_new_inode(ext2_ino_t ino, struct ext2_inode * inode,
450 retval = ext2fs_write_new_inode(current_fs, ino, inode);
452 com_err(cmd, retval, "while creating inode %u", ino);
459 * Given a mode, return the ext2 file type
461 int ext2_file_type(unsigned int mode)
463 if (LINUX_S_ISREG(mode))
464 return EXT2_FT_REG_FILE;
466 if (LINUX_S_ISDIR(mode))
469 if (LINUX_S_ISCHR(mode))
470 return EXT2_FT_CHRDEV;
472 if (LINUX_S_ISBLK(mode))
473 return EXT2_FT_BLKDEV;
475 if (LINUX_S_ISLNK(mode))
476 return EXT2_FT_SYMLINK;
478 if (LINUX_S_ISFIFO(mode))
481 if (LINUX_S_ISSOCK(mode))