debugfs/debugfs.8.in

   1 .\" -*- nroff -*-
   2 .\" Copyright 1993, 1994, 1995 by Theodore Ts'o.  All Rights Reserved.
   3 .\" This file may be copied under the terms of the GNU Public License.
   4 .\"
   5 .TH DEBUGFS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   6 .SH NAME
   7 debugfs \- ext2/ext3/ext4 file system debugger
   8 .SH SYNOPSIS
   9 .B debugfs
  10 [
  11 .B \-DVwci
  12 ]
  13 [
  14 .B \-b
  15 blocksize
  16 ]
  17 [
  18 .B \-s
  19 superblock
  20 ]
  21 [
  22 .B \-f
  23 cmd_file
  24 ]
  25 [
  26 .B \-R
  27 request
  28 ]
  29 [
  30 .B \-d
  31 data_source_device
  32 ]
  33 [
  34 device
  35 ]
  36 .SH DESCRIPTION
  37 The
  38 .B debugfs
  39 program is an interactive file system debugger. It can be used to
  40 examine and change the state of an ext2, ext3, or ext4 file system.
  41 .br
  42 .I device
  43 is the special file corresponding to the device containing the
  44 file system (e.g /dev/hdXX).
  45 .SH OPTIONS
  46 .TP
  47 .I \-w
  48 Specifies that the file system should be opened in read-write mode.
  49 Without this option, the file system is opened in read-only mode.
  50 .TP
  51 .I \-c
  52 Specifies that the file system should be opened in catastrophic mode, in
  53 which the inode and group bitmaps are not read initially.  This can be
  54 useful for filesystems with significant corruption, but because of this,
  55 catastrophic mode forces the filesystem to be opened read-only.
  56 .TP
  57 .I \-i
  58 Specifies that
  59 .I device
  60 represents an ext2 image file created by the
  61 .B e2image
  62 program.  Since the ext2 image file only contains the superblock, block
  63 group descriptor, block and inode allocation bitmaps, and
  64 the inode table, many
  65 .B debugfs
  66 commands will not function properly.
  67 .B Warning:
  68 no safety checks are in place, and
  69 .B debugfs
  70 may fail in interesting ways if commands such as
  71 .IR ls ", " dump ", "
  72 etc. are tried without specifying the
  73 .I data_source_device
  74 using the
  75 .I \-d
  76 option.
  77 .B debugfs
  78 is a debugging tool.  It has rough edges!
  79 .TP
  80 .I -d data_source_device
  81 Used with the
  82 .I \-i
  83 option, specifies that
  84 .I data_source_device
  85 should be used when reading blocks not found in the ext2 image file.
  86 This includes data, directory, and indirect blocks.
  87 .TP
  88 .I -b blocksize
  89 Forces the use of the given block size for the file system, rather than
  90 detecting the correct block size as normal.
  91 .TP
  92 .I -s superblock
  93 Causes the file system superblock to be read from the given block
  94 number, instead of using the primary superblock (located at an offset of
  95 1024 bytes from the beginning of the filesystem).  If you specify the
  96 .I -s
  97 option, you must also provide the blocksize of the filesystem via the
  98 .I -b
  99 option.
 100 .TP
 101 .I -f cmd_file
 102 Causes
 103 .B debugfs
 104 to read in commands from
 105 .IR cmd_file ,
 106 and execute them.  When
 107 .B debugfs
 108 is finished executing those commands, it will exit.
 109 .TP
 110 .I -D
 111 Causes
 112 .B debugfs
 113 to open the device using Direct I/O, bypassing the buffer cache.  Note
 114 that some Linux devices, notably device mapper as of this writing, do
 115 not support Direct I/O.
 116 .TP
 117 .I -R request
 118 Causes
 119 .B debugfs
 120 to execute the single command
 121 .IR request ,
 122 and then exit.
 123 .TP
 124 .I -V
 125 print the version number of
 126 .B debugfs
 127 and exit.
 128 .SH SPECIFYING FILES
 129 Many
 130 .B debugfs
 131 commands take a
 132 .I filespec
 133 as an argument to specify an inode (as opposed to a pathname)
 134 in the filesystem which is currently opened by
 135 .BR debugfs .
 136 The
 137 .I filespec
 138 argument may be specified in two forms.  The first form is an inode
 139 number surrounded by angle brackets, e.g.,
 140 .IR <2> .
 141 The second form is a pathname; if the pathname is prefixed by a forward slash
 142 ('/'), then it is interpreted relative to the root of the filesystem
 143 which is currently opened by
 144 .BR debugfs .
 145 If not, the pathname is
 146 interpreted relative to the current working directory as maintained by
 147 .BR debugfs .
 148 This may be modified by using the
 149 .B debugfs
 150 command
 151 .IR cd .
 152 .\"
 153 .\"
 154 .\"
 155 .SH COMMANDS
 156 This is a list of the commands which
 157 .B debugfs
 158 supports.
 159 .TP
 160 .BI blocks " filespace"
 161 Print the blocks used by the inode
 162 .I filespec
 163 to stdout.
 164 .TP
 165 .BI bmap " filespec logical_block"
 166 Print the physical block number corresponding to the logical block number
 167 .I logical_block
 168 in the inode
 169 .IR filespec .
 170 .TP
 171 .BI block_dump " [-f filespec] block_num"
 172 Dump the filesystem block given by
 173 .I block_num
 174 in hex and ASCII format to the console.  If the
 175 .I -f
 176 option is specified, the block number is relative to the start of the given
 177 .BR filespec .
 178 .TP
 179 .BI cat " filespec"
 180 Dump the contents of the inode
 181 .I filespec
 182 to stdout.
 183 .TP
 184 .BI cd " filespec"
 185 Change the current working directory to
 186 .IR filespec .
 187 .TP
 188 .BI chroot " filespec"
 189 Change the root directory to be the directory
 190 .IR filespec .
 191 .TP
 192 .BI close " [-a]"
 193 Close the currently open file system.  If the
 194 .I -a
 195 option is specified, write out any changes to the superblock and block
 196 group descriptors to all of the backup superblocks, not just to the
 197 master superblock.
 198 .TP
 199 .BI clri " filespec"
 200 Clear the contents of the inode
 201 .IR filespec .
 202 .TP
 203 .BI dirsearch " filespec filename"
 204 Search the directory
 205 .I filespec
 206 for
 207 .IR filename .
 208 .TP
 209 .B dirty
 210 Mark the filesystem as dirty, so that the superblocks will be written on exit.
 211 .TP
 212 .BI dump " [-p] filespec out_file"
 213 Dump the contents of the inode
 214 .I filespec
 215 to the output file
 216 .IR out_file .
 217 If the
 218 .I -p
 219 option is given set the owner, group and permissions information on
 220 .I out_file
 221 to match
 222 .IR filespec .
 223 .TP
 224 .BI dump_mmp " [mmp_block]"
 225 Display the multiple-mount protection (mmp) field values.  If
 226 .I mmp_block
 227 is specified then verify and dump the MMP values from the given block
 228 number, otherwise use the
 229 .B s_mmp_block
 230 field in the superblock to locate and use the existing MMP block.
 231 .TP
 232 .BI dx_hash " [-h hash_alg] [-s hash_seed] filename"
 233 Calculate the directory hash of
 234 .IR filename .
 235 The hash algorithm specified with
 236 .I -h
 237 may be
 238 .BR legacy , " half_md4" ", or " tea .
 239 The hash seed specified with
 240 .I -s
 241 must be in UUID format.
 242 .TP
 243 .BI dump_extents " [-n] [-l] filespec"
 244 Dump the the extent tree of the inode
 245 .IR filespec .
 246 The
 247 .I -n
 248 flag will cause
 249 .B dump_extents
 250 to only display the interior nodes in the extent tree.   The
 251 .I -l
 252 flag will cause
 253 .B dump_extents
 254 to only display the leaf nodes in the extent tree.
 255 .IP
 256 (Please note that the length and range of blocks for the last extent in
 257 an interior node is an estimate by the extents library functions, and is
 258 not stored in filesystem data structures.   Hence, the values displayed
 259 may not necessarily by accurate and does not indicate a problem or
 260 corruption in the file system.)
 261 .TP
 262 .BI expand_dir " filespec"
 263 Expand the directory
 264 .IR filespec .
 265 .TP
 266 .BI feature " [fs_feature] [-fs_feature] ..."
 267 Set or clear various filesystem features in the superblock.  After setting
 268 or clearing any filesystem features that were requested, print the current
 269 state of the filesystem feature set.
 270 .TP
 271 .BI filefrag " [-dvr] filespec"
 272 Print the number of contiguous extents in
 273 .IR filespec .
 274 If
 275 .I filespec
 276 is a directory and the
 277 .I -d
 278 option is not specified,
 279 .I filefrag
 280 will print the number of contiguous extents for each file in
 281 the directory.  The
 282 .I -v
 283 option will cause
 284 .I filefrag
 285 print a tabular listing of the contiguous extents in the
 286 file.  The
 287 .I -r
 288 option will cause
 289 .I filefrag
 290 to do a recursive listing of the directory.
 291 .TP
 292 .BI find_free_block " [count [goal]]"
 293 Find the first
 294 .I count
 295 free blocks, starting from
 296 .I goal
 297 and allocate it.  Also available as
 298 .BR ffb .
 299 .TP
 300 .BI find_free_inode " [dir [mode]]"
 301 Find a free inode and allocate it.  If present,
 302 .I dir
 303 specifies the inode number of the directory
 304 which the inode is to be located.  The second
 305 optional argument
 306 .I mode
 307 specifies the permissions of the new inode.  (If the directory bit is set
 308 on the mode, the allocation routine will function differently.)  Also
 309 available as
 310 .BR ffi .
 311 .TP
 312 .BI freeb " block [count]"
 313 Mark the block number
 314 .I block
 315 as not allocated.
 316 If the optional argument
 317 .I count
 318 is present, then
 319 .I count
 320 blocks starting at block number
 321 .I block
 322 will be marked as not allocated.
 323 .TP
 324 .BI freefrag " [-c chunk_kb]"
 325 Report free space fragmentation on the currently open file system.
 326 If the
 327 .I \-c
 328 option is specified then the filefrag command will print how many free
 329 chunks of size
 330 .I chunk_kb
 331 can be found in the file system.  The chunk size must be a power of two
 332 and be larger than the file system block size.
 333 .TP
 334 .BI freei " filespec [num]"
 335 Free the inode specified by
 336 .IR filespec .
 337 If
 338 .I num
 339 is specified, also clear num-1 inodes after the specified inode.
 340 .TP
 341 .B help
 342 Print a list of commands understood by
 343 .BR debugfs .
 344 .TP
 345 .BI htree_dump " filespec"
 346 Dump the hash-indexed directory
 347 .IR filespec ,
 348 showing its tree structure.
 349 .TP
 350 .BI icheck " block ..."
 351 Print a listing of the inodes which use the one or more blocks specified
 352 on the command line.
 353 .TP
 354 .BI inode_dump " filespec"
 355 Print the contents of the inode data structure in hex and ASCII format.
 356 .TP
 357 .BI imap " filespec"
 358 Print the location of the inode data structure (in the inode table)
 359 of the inode
 360 .IR filespec .
 361 .TP
 362 .BI init_filesys " device blocksize"
 363 Create an ext2 file system on
 364 .I device
 365 with device size
 366 .IR blocksize .
 367 Note that this does not fully initialize all of the data structures;
 368 to do this, use the
 369 .BR mke2fs (8)
 370 program.  This is just a call to the low-level library, which sets up
 371 the superblock and block descriptors.
 372 .TP
 373 .BI kill_file " filespec"
 374 Deallocate the inode
 375 .I filespec
 376 and its blocks.  Note that this does not remove any directory
 377 entries (if any) to this inode.  See the
 378 .BR rm (1)
 379 command if you wish to unlink a file.
 380 .TP
 381 .BI lcd " directory"
 382 Change the current working directory of the
 383 .B debugfs
 384 process to
 385 .I directory
 386 on the native filesystem.
 387 .TP
 388 .BI ln " filespec dest_file"
 389 Create a link named
 390 .I dest_file
 391 which is a hard link to
 392 .IR filespec .
 393 Note this does not adjust the inode reference counts.
 394 .TP
 395 .BI logdump " [-acs] [-b block] [-i filespec] [-f journal_file] [output_file]"
 396 Dump the contents of the ext3 journal.  By default, dump the journal inode as
 397 specified in the superblock.  However, this can be overridden with the
 398 .I \-i
 399 option, which dumps the journal from the internal inode given by
 400 .IR filespec .
 401 A regular file containing journal data can be specified using the
 402 .I \-f
 403 option.  Finally, the
 404 .I \-s
 405 option utilizes the backup information in the superblock to locate the
 406 journal.
 407 .IP
 408 The
 409 .I \-a
 410 option causes the
 411 .B logdump
 412 program to print the contents of all of the descriptor blocks.
 413 The
 414 .I \-b
 415 option causes
 416 .B logdump
 417 to print all journal records that are refer to the specified block.
 418 The
 419 .I \-c
 420 option will print out the contents of all of the data blocks selected by
 421 the
 422 .I \-a
 423 and
 424 .I \-b
 425 options.
 426 .TP
 427 .BI ls " [-d] [-l] [-p] filespec"
 428 Print a listing of the files in the directory
 429 .IR filespec .
 430 The
 431 .I \-d
 432 flag will list deleted entries in the directory.
 433 The
 434 .I \-l
 435 flag will list files using a more verbose format.
 436 The
 437 .I \-p
 438 flag will list the files in a format which is more easily parsable by
 439 scripts, as well as making it more clear when there are spaces or other
 440 non-printing characters at the end of filenames.
 441 .TP
 442 .BI list_deleted_inodes " [limit]"
 443 List deleted inodes, optionally limited to those deleted within
 444 .I limit
 445 seconds ago.  Also available as
 446 .BR lsdel .
 447 .IP
 448 This command was useful for recovering from accidental file deletions
 449 for ext2 file systems.  Unfortunately, it is not useful for this purpose
 450 if the files were deleted using ext3 or ext4, since the inode's
 451 data blocks are no longer available after the inode is released.
 452 .TP
 453 .BI modify_inode " filespec"
 454 Modify the contents of the inode structure in the inode
 455 .IR filespec .
 456 Also available as
 457 .BR mi .
 458 .TP
 459 .BI mkdir " filespec"
 460 Make a directory.
 461 .TP
 462 .BI mknod " filespec [p|[[c|b] major minor]]"
 463 Create a special device file (a named pipe, character or block device).
 464 If a character or block device is to be made, the
 465 .I major
 466 and
 467 .I minor
 468 device numbers must be specified.
 469 .TP
 470 .BI ncheck " [-c] inode_num ..."
 471 Take the requested list of inode numbers, and print a listing of pathnames
 472 to those inodes.  The
 473 .I -c
 474 flag will enable checking the file type information in the directory
 475 entry to make sure it matches the inode's type.
 476 .TP
 477 .BI open " [-weficD] [-b blocksize] [-s superblock] device"
 478 Open a filesystem for editing.  The
 479 .I -f
 480 flag forces the filesystem to be opened even if there are some unknown
 481 or incompatible filesystem features which would normally
 482 prevent the filesystem from being opened.  The
 483 .I -e
 484 flag causes the filesystem to be opened in exclusive mode.  The
 485 .IR -b ", " -c ", " -i ", " -s ", " -w ", and " -D
 486 options behave the same as the command-line options to
 487 .BR debugfs .
 488 .TP
 489 .BI punch " filespec start_blk [end_blk]"
 490 Delete the blocks in the inode ranging from
 491 .I start_blk
 492 to
 493 .IR end_blk .
 494 If
 495 .I end_blk
 496 is omitted then this command will function as a truncate command; that
 497 is, all of the blocks starting at
 498 .I start_blk
 499 through to the end of the file will be deallocated.
 500 .TP
 501 .BI symlink " filespec target"
 502 Make a symbolic link.
 503 .TP
 504 .B pwd
 505 Print the current working directory.
 506 .TP
 507 .B quit
 508 Quit
 509 .B debugfs
 510 .TP
 511 .BI rdump " directory[...] destination"
 512 Recursively dump
 513 .IR directory ,
 514 or multiple
 515 .IR directories ,
 516 and all its contents (including regular files, symbolic links, and other
 517 directories) into the named
 518 .IR destination ,
 519 which should be an existing directory on the native filesystem.
 520 .TP
 521 .BI rm " pathname"
 522 Unlink
 523 .IR pathname .
 524 If this causes the inode pointed to by
 525 .I pathname
 526 to have no other references, deallocate the file.  This command functions
 527 as the unlink() system call.
 528 .I
 529 .TP
 530 .BI rmdir " filespec"
 531 Remove the directory
 532 .IR filespec .
 533 .TP
 534 .BI setb " block [count]"
 535 Mark the block number
 536 .I block
 537 as allocated.
 538 If the optional argument
 539 .I count
 540 is present, then
 541 .I count
 542 blocks starting at block number
 543 .I block
 544 will be marked as allocated.
 545 .TP
 546 .BI set_block_group " bgnum field value"
 547 Modify the block group descriptor specified by
 548 .I bgnum
 549 so that the block group descriptor field
 550 .I field
 551 has value
 552 .IR value .
 553 Also available as
 554 .BR set_bg .
 555 .TP
 556 .BI seti " filespec [num]"
 557 Mark inode
 558 .I filespec
 559 as in use in the inode bitmap.  If
 560 .I num
 561 is specified, also set num-1 inodes after the specified inode.
 562 .TP
 563 .BI set_inode_field " filespec field value"
 564 Modify the inode specified by
 565 .I filespec
 566 so that the inode field
 567 .I field
 568 has value
 569 .I value.
 570 The list of valid inode fields which can be set via this command
 571 can be displayed by using the command:
 572 .B set_inode_field -l
 573 Also available as
 574 .BR sif .
 575 .TP
 576 .BI set_mmp_value " field value"
 577 Modify the multiple-mount protection (MMP) data so that the MMP field
 578 .I field
 579 has value
 580 .I value.
 581 The list of valid MMP fields which can be set via this command
 582 can be displayed by using the command:
 583 .B set_mmp_value -l
 584 Also available as
 585 .BR smmp .
 586 .TP
 587 .BI set_super_value " field value"
 588 Set the superblock field
 589 .I field
 590 to
 591 .I value.
 592 The list of valid superblock fields which can be set via this command
 593 can be displayed by using the command:
 594 .B set_super_value -l
 595 Also available as
 596 .BR ssv .
 597 .TP
 598 .BI show_super_stats " [-h]"
 599 List the contents of the super block and the block group descriptors.  If the
 600 .I -h
 601 flag is given, only print out the superblock contents. Also available as
 602 .BR stats .
 603 .TP
 604 .BI stat " filespec"
 605 Display the contents of the inode structure of the inode
 606 .IR filespec .
 607 .TP
 608 .BI testb " block [count]"
 609 Test if the block number
 610 .I block
 611 is marked as allocated in the block bitmap.
 612 If the optional argument
 613 .I count
 614 is present, then
 615 .I count
 616 blocks starting at block number
 617 .I block
 618 will be tested.
 619 .TP
 620 .BI testi " filespec"
 621 Test if the inode
 622 .I filespec
 623 is marked as allocated in the inode bitmap.
 624 .TP
 625 .BI undel " <inode_number> [pathname]"
 626 Undelete the specified inode number (which must be surrounded by angle
 627 brackets) so that it and its blocks are marked in use, and optionally
 628 link the recovered inode to the specified pathname.  The
 629 .B e2fsck
 630 command should always be run after using the
 631 .B undel
 632 command to recover deleted files.
 633 .IP
 634 Note that if you are recovering a large number of deleted files, linking
 635 the inode to a directory may require the directory to be expanded, which
 636 could allocate a block that had been used by one of the
 637 yet-to-be-undeleted files.  So it is safer to undelete all of the
 638 inodes without specifying a destination pathname, and then in a separate
 639 pass, use the debugfs
 640 .B link
 641 command to link the inode to the destination pathname, or use
 642 .B e2fsck
 643 to check the filesystem and link all of the recovered inodes to the
 644 lost+found directory.
 645 .TP
 646 .BI unlink " pathname"
 647 Remove the link specified by
 648 .I pathname
 649 to an inode.  Note this does not adjust the inode reference counts.
 650 .TP
 651 .BI write " source_file out_file"
 652 Copy the contents of
 653 .I source_file
 654 into a newly-created file in the filesystem named
 655 .IR out_file .
 656 .TP
 657 .BI zap_block " [-f filespec] [-o offset] [-l length] [-p pattern] block_num"
 658 .TP
 659 Overwrite the block specified by
 660 .I block_num
 661 with zero (NUL) bytes, or if
 662 .I -p
 663 is given use the byte specified by
 664 .IR pattern .
 665 If
 666 .I -f
 667 is given then
 668 .I block_num
 669 is relative to the start of the file given by
 670 .IR filespec .
 671 The
 672 .I -o
 673 and
 674 .I -l
 675 options limit the range of bytes to zap to the specified
 676 .I offset
 677 and
 678 .I length
 679 relative to the start of the block.
 680 .TP
 681 .BI zap_block " [-f filespec] [-b bit] block_num"
 682 Bit-flip portions of the physical
 683 .IR block_num .
 684 If
 685 .I -f
 686 is given, then
 687 .I block_num
 688 is a logical block relative to the start of
 689 .IR filespec .
 690 .SH ENVIRONMENT VARIABLES
 691 .TP
 692 .B DEBUGFS_PAGER, PAGER
 693 The
 694 .B debugfs
 695 program always pipes the output of the some commands through a
 696 pager program.  These commands include:
 697 .IR show_super_stats " (" stats ),
 698 .IR list_directory " (" ls ),
 699 .IR show_inode_info " (" stat ),
 700 .IR list_deleted_inodes " (" lsdel ),
 701 and
 702 .IR htree_dump .
 703 The specific pager can explicitly specified by the
 704 .B DEBUGFS_PAGER
 705 environment variable, and if it is not set, by the
 706 .B PAGER
 707 environment variable.
 708 .IP
 709 Note that since a pager is always used, the
 710 .BR less (1)
 711 pager is not particularly appropriate, since it clears the screen before
 712 displaying the output of the command and clears the output the screen
 713 when the pager is exited.  Many users prefer to use the
 714 .BR less (1)
 715 pager for most purposes, which is why the
 716 .B DEBUGFS_PAGER
 717 environment variable is available to override the more general
 718 .B PAGER
 719 environment variable.
 720 .SH AUTHOR
 721 .B debugfs
 722 was written by Theodore Ts'o <tytso@mit.edu>.
 723 .SH SEE ALSO
 724 .BR dumpe2fs (8),
 725 .BR tune2fs (8),
 726 .BR e2fsck (8),
 727 .BR mke2fs (8),
 728 .BR ext4 (5)