1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
|
/*
* util.c --- utilities for the debugfs program
*
* Copyright (C) 1993, 1994 Theodore Ts'o. This file may be
* redistributed under the terms of the GNU Public License.
*
*/
#define _XOPEN_SOURCE 600 /* needed for strptime */
#include "config.h"
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <ctype.h>
#include <string.h>
#include <time.h>
#include <signal.h>
#ifdef HAVE_GETOPT_H
#include <getopt.h>
#else
extern int optind;
extern char *optarg;
#endif
#ifdef HAVE_OPTRESET
extern int optreset; /* defined by BSD, but not others */
#endif
#include "ss/ss.h"
#include "debugfs.h"
/*
* This function resets the libc getopt() function, which keeps
* internal state. Bad design! Stupid libc API designers! No
* biscuit!
*
* BSD-derived getopt() functions require that optind be reset to 1 in
* order to reset getopt() state. This used to be generally accepted
* way of resetting getopt(). However, glibc's getopt()
* has additional getopt() state beyond optind, and requires that
* optind be set zero to reset its state. So the unfortunate state of
* affairs is that BSD-derived versions of getopt() misbehave if
* optind is set to 0 in order to reset getopt(), and glibc's getopt()
* will core dump if optind is set 1 in order to reset getopt().
*
* More modern versions of BSD require that optreset be set to 1 in
* order to reset getopt(). Sigh. Standards, anyone?
*
* We hide the hair here.
*/
void reset_getopt(void)
{
#if defined(__GLIBC__) || defined(__linux__)
optind = 0;
#else
optind = 1;
#endif
#ifdef HAVE_OPTRESET
optreset = 1; /* Makes BSD getopt happy */
#endif
}
static const char *pager_search_list[] = { "pager", "more", "less", 0 };
static const char *pager_dir_list[] = { "/usr/bin", "/bin", 0 };
static const char *find_pager(char *buf)
{
const char **i, **j;
for (i = pager_search_list; *i; i++) {
for (j = pager_dir_list; *j; j++) {
sprintf(buf, "%s/%s", *j, *i);
if (access(buf, X_OK) == 0)
return(buf);
}
}
return 0;
}
FILE *open_pager(void)
{
FILE *outfile = 0;
const char *pager = ss_safe_getenv("DEBUGFS_PAGER");
char buf[80];
signal(SIGPIPE, SIG_IGN);
if (!isatty(1))
return stdout;
if (!pager)
pager = ss_safe_getenv("PAGER");
if (!pager)
pager = find_pager(buf);
if (!pager ||
(strcmp(pager, "__none__") == 0) ||
((outfile = popen(pager, "w")) == 0))
return stdout;
return outfile;
}
void close_pager(FILE *stream)
{
if (stream && stream != stdout) pclose(stream);
}
/*
* This routine is used whenever a command needs to turn a string into
* an inode.
*/
ext2_ino_t string_to_inode(char *str)
{
ext2_ino_t ino;
int len = strlen(str);
char *end;
int retval;
/*
* If the string is of the form <ino>, then treat it as an
* inode number.
*/
if ((len > 2) && (str[0] == '<') && (str[len-1] == '>')) {
ino = strtoul(str+1, &end, 0);
if (*end=='>' && (ino <= current_fs->super->s_inodes_count))
return ino;
}
retval = ext2fs_namei(current_fs, root, cwd, str, &ino);
if (retval) {
com_err(str, retval, 0);
return 0;
}
if (ino > current_fs->super->s_inodes_count) {
com_err(str, 0, "resolves to an illegal inode number: %u\n",
ino);
return 0;
}
return ino;
}
/*
* This routine returns 1 if the filesystem is not open, and prints an
* error message to that effect.
*/
int check_fs_open(char *name)
{
if (!current_fs) {
com_err(name, 0, "Filesystem not open");
return 1;
}
return 0;
}
/*
* This routine returns 1 if a filesystem is open, and prints an
* error message to that effect.
*/
int check_fs_not_open(char *name)
{
if (current_fs) {
com_err(name, 0,
"Filesystem %s is still open. Close it first.\n",
current_fs->device_name);
return 1;
}
return 0;
}
/*
* This routine returns 1 if a filesystem is not opened read/write,
* and prints an error message to that effect.
*/
int check_fs_read_write(char *name)
{
if (!(current_fs->flags & EXT2_FLAG_RW)) {
com_err(name, 0, "Filesystem opened read/only");
return 1;
}
return 0;
}
/*
* This routine returns 1 if a filesystem is doesn't have its inode
* and block bitmaps loaded, and prints an error message to that
* effect.
*/
int check_fs_bitmaps(char *name)
{
if (!current_fs->block_map || !current_fs->inode_map) {
com_err(name, 0, "Filesystem bitmaps not loaded");
return 1;
}
return 0;
}
/*
* This function takes a __s64 time value and converts it to a string,
* using ctime
*/
char *time_to_string(__s64 cl)
{
static int do_gmt = -1;
time_t t = (time_t) cl;
const char *tz;
if (do_gmt == -1) {
/* The diet libc doesn't respect the TZ environment variable */
tz = ss_safe_getenv("TZ");
if (!tz)
tz = "";
do_gmt = !strcmp(tz, "GMT") || !strcmp(tz, "GMT0");
}
return asctime((do_gmt) ? gmtime(&t) : localtime(&t));
}
/*
* Parse a string as a time. Return ((time_t)-1) if the string
* doesn't appear to be a sane time.
*/
extern __s64 string_to_time(const char *arg)
{
struct tm ts;
__s64 ret;
char *tmp;
if (strcmp(arg, "now") == 0) {
return time(0);
}
if (arg[0] == '@') {
/* interpret it as an integer */
arg++;
fallback:
ret = strtoll(arg, &tmp, 0);
if (*tmp)
return -1;
return ret;
}
memset(&ts, 0, sizeof(ts));
#ifdef HAVE_STRPTIME
tmp = strptime(arg, "%Y%m%d%H%M%S", &ts);
if (tmp == NULL)
tmp = strptime(arg, "%Y%m%d%H%M", &ts);
if (tmp == NULL)
tmp = strptime(arg, "%Y%m%d", &ts);
if (tmp == NULL)
goto fallback;
#else
sscanf(arg, "%4d%2d%2d%2d%2d%2d", &ts.tm_year, &ts.tm_mon,
&ts.tm_mday, &ts.tm_hour, &ts.tm_min, &ts.tm_sec);
ts.tm_year -= 1900;
ts.tm_mon -= 1;
if (ts.tm_year < 0 || ts.tm_mon < 0 || ts.tm_mon > 11 ||
ts.tm_mday <= 0 || ts.tm_mday > 31 || ts.tm_hour > 23 ||
ts.tm_min > 59 || ts.tm_sec > 61)
goto fallback;
#endif
ts.tm_isdst = -1;
/* strptime() may only update the specified fields, which does not
* necessarily include ts.tm_yday (%j). Calculate this if unset:
*
* Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
* 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
*
* Start with 31 days per month. Even months have only 30 days, but
* reverse in August, subtract one day for those months. February has
* only 28 days, not 30, subtract two days. Add day of month, minus
* one, since day is not finished yet. Leap years handled afterward. */
if (ts.tm_yday == 0)
ts.tm_yday = (ts.tm_mon * 31) -
((ts.tm_mon - (ts.tm_mon > 7)) / 2) -
2 * (ts.tm_mon > 1) + ts.tm_mday - 1;
ret = ts.tm_sec + ts.tm_min*60 + ts.tm_hour*3600 + ts.tm_yday*86400 +
((__s64) ts.tm_year-70)*31536000 +
(((__s64) ts.tm_year-69)/4)*86400 -
(((__s64) ts.tm_year-1)/100)*86400 +
(((__s64) ts.tm_year+299)/400)*86400;
return ret;
}
/*
* This function will convert a string to an unsigned long, printing
* an error message if it fails, and returning success or failure in err.
*/
unsigned long parse_ulong(const char *str, const char *cmd,
const char *descr, int *err)
{
char *tmp;
unsigned long ret;
ret = strtoul(str, &tmp, 0);
if (*tmp == 0) {
if (err)
*err = 0;
return ret;
}
com_err(cmd, 0, "Bad %s - %s", descr, str);
if (err)
*err = 1;
else
exit(1);
return 0;
}
/*
* This function will convert a string to an unsigned long long, printing
* an error message if it fails, and returning success or failure in err.
*/
unsigned long long parse_ulonglong(const char *str, const char *cmd,
const char *descr, int *err)
{
char *tmp;
unsigned long long ret;
ret = strtoull(str, &tmp, 0);
if (*tmp == 0) {
if (err)
*err = 0;
return ret;
}
com_err(cmd, 0, "Bad %s - %s", descr, str);
if (err)
*err = 1;
else
exit(1);
return 0;
}
/*
* This function will convert a string to a block number. It returns
* 0 on success, 1 on failure. On failure, it outputs either an optionally
* specified error message or a default.
*/
int strtoblk(const char *cmd, const char *str, const char *errmsg,
blk64_t *ret)
{
blk64_t blk;
int err;
if (errmsg == NULL)
blk = parse_ulonglong(str, cmd, "block number", &err);
else
blk = parse_ulonglong(str, cmd, errmsg, &err);
*ret = blk;
return err;
}
/*
* This is a common helper function used by the command processing
* routines
*/
int common_args_process(int argc, ss_argv_t argv, int min_argc, int max_argc,
const char *cmd, const char *usage, int flags)
{
if (argc < min_argc || argc > max_argc) {
com_err(argv[0], 0, "Usage: %s %s", cmd, usage);
return 1;
}
if (flags & CHECK_FS_NOTOPEN) {
if (check_fs_not_open(argv[0]))
return 1;
} else {
if (check_fs_open(argv[0]))
return 1;
}
if ((flags & CHECK_FS_RW) && check_fs_read_write(argv[0]))
return 1;
if ((flags & CHECK_FS_BITMAPS) && check_fs_bitmaps(argv[0]))
return 1;
return 0;
}
/*
* This is a helper function used by do_stat, do_freei, do_seti, and
* do_testi, etc. Basically, any command which takes a single
* argument which is a file/inode number specifier.
*/
int common_inode_args_process(int argc, ss_argv_t argv,
ext2_ino_t *inode, int flags)
{
if (common_args_process(argc, argv, 2, 2, argv[0], "<file>", flags))
return 1;
*inode = string_to_inode(argv[1]);
if (!*inode)
return 1;
return 0;
}
/*
* This is a helper function used by do_freeb, do_setb, and do_testb
*/
int common_block_args_process(int argc, ss_argv_t argv,
blk64_t *block, blk64_t *count)
{
int err;
if (common_args_process(argc, argv, 2, 3, argv[0],
"<block> [count]", CHECK_FS_BITMAPS))
return 1;
if (strtoblk(argv[0], argv[1], NULL, block))
return 1;
if (*block == 0) {
com_err(argv[0], 0, "Invalid block number 0");
return 1;
}
if (argc > 2) {
err = strtoblk(argv[0], argv[2], "count", count);
if (err)
return 1;
}
return 0;
}
int debugfs_read_inode2(ext2_ino_t ino, struct ext2_inode * inode,
const char *cmd, int bufsize, int flags)
{
int retval;
retval = ext2fs_read_inode2(current_fs, ino, inode, bufsize, flags);
if (retval) {
com_err(cmd, retval, "while reading inode %u", ino);
return 1;
}
return 0;
}
int debugfs_read_inode(ext2_ino_t ino, struct ext2_inode * inode,
const char *cmd)
{
int retval;
retval = ext2fs_read_inode(current_fs, ino, inode);
if (retval) {
com_err(cmd, retval, "while reading inode %u", ino);
return 1;
}
return 0;
}
int debugfs_write_inode2(ext2_ino_t ino,
struct ext2_inode *inode,
const char *cmd,
int bufsize, int flags)
{
int retval;
retval = ext2fs_write_inode2(current_fs, ino, inode, bufsize, flags);
if (retval) {
com_err(cmd, retval, "while writing inode %u", ino);
return 1;
}
return 0;
}
int debugfs_write_inode(ext2_ino_t ino, struct ext2_inode * inode,
const char *cmd)
{
int retval;
retval = ext2fs_write_inode(current_fs, ino, inode);
if (retval) {
com_err(cmd, retval, "while writing inode %u", ino);
return 1;
}
return 0;
}
int debugfs_write_new_inode(ext2_ino_t ino, struct ext2_inode * inode,
const char *cmd)
{
int retval;
retval = ext2fs_write_new_inode(current_fs, ino, inode);
if (retval) {
com_err(cmd, retval, "while creating inode %u", ino);
return 1;
}
return 0;
}
/*
* Given a mode, return the ext2 file type
*/
int ext2_file_type(unsigned int mode)
{
if (LINUX_S_ISREG(mode))
return EXT2_FT_REG_FILE;
if (LINUX_S_ISDIR(mode))
return EXT2_FT_DIR;
if (LINUX_S_ISCHR(mode))
return EXT2_FT_CHRDEV;
if (LINUX_S_ISBLK(mode))
return EXT2_FT_BLKDEV;
if (LINUX_S_ISLNK(mode))
return EXT2_FT_SYMLINK;
if (LINUX_S_ISFIFO(mode))
return EXT2_FT_FIFO;
if (LINUX_S_ISSOCK(mode))
return EXT2_FT_SOCK;
return 0;
}
errcode_t read_list(char *str, blk64_t **list, size_t *len)
{
blk64_t *lst = *list;
size_t ln = *len;
char *tok, *p = str;
errcode_t retval = 0;
while ((tok = strtok(p, ","))) {
blk64_t *l;
blk64_t x, y;
char *e;
errno = 0;
y = x = strtoull(tok, &e, 0);
if (errno) {
retval = errno;
break;
}
if (*e == '-') {
y = strtoull(e + 1, NULL, 0);
if (errno) {
retval = errno;
break;
}
} else if (*e != 0) {
retval = EINVAL;
break;
}
if (y < x) {
retval = EINVAL;
break;
}
l = realloc(lst, sizeof(blk64_t) * (ln + y - x + 1));
if (l == NULL) {
retval = ENOMEM;
break;
}
lst = l;
for (; x <= y; x++)
lst[ln++] = x;
p = NULL;
}
*list = lst;
*len = ln;
return retval;
}
void do_byte_hexdump(FILE *fp, unsigned char *buf, size_t bufsize)
{
size_t i, j, max;
int suppress = -1;
for (i = 0; i < bufsize; i += 16) {
max = (bufsize - i > 16) ? 16 : bufsize - i;
if (suppress < 0) {
if (i && memcmp(buf + i, buf + i - max, max) == 0) {
suppress = i;
fprintf(fp, "*\n");
continue;
}
} else {
if (memcmp(buf + i, buf + suppress, max) == 0)
continue;
suppress = -1;
}
fprintf(fp, "%04o ", (unsigned int)i);
for (j = 0; j < 16; j++) {
if (j < max)
fprintf(fp, "%02x", buf[i+j]);
else
fprintf(fp, " ");
if ((j % 2) == 1)
fprintf(fp, " ");
}
fprintf(fp, " ");
for (j = 0; j < max; j++)
fprintf(fp, "%c", isprint(buf[i+j]) ? buf[i+j] : '.');
fprintf(fp, "\n");
}
fprintf(fp, "\n");
}
|