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.
5 .TH DEBUGFS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
7 debugfs \- ext2/ext3/ext4 file system debugger
43 program is an interactive file system debugger. It can be used to
44 examine and change the state of an ext2, ext3, or ext4 file system.
47 is a block device (e.g., /dev/sdXX) or a file containing the file system.
51 Specifies that the file system should be opened in read-write mode.
52 Without this option, the file system is opened in read-only mode.
55 Disables metadata checksum verification. This should only be used if
56 you believe the metadata to be correct despite the complaints of
60 Specifies that the file system should be opened in catastrophic mode, in
61 which the inode and group bitmaps are not read initially. This can be
62 useful for filesystems with significant corruption, but because of this,
63 catastrophic mode forces the filesystem to be opened read-only.
68 represents an ext2 image file created by the
70 program. Since the ext2 image file only contains the superblock, block
71 group descriptor, block and inode allocation bitmaps, and
74 commands will not function properly.
76 no safety checks are in place, and
78 may fail in interesting ways if commands such as
80 etc. are tried without specifying the
86 is a debugging tool. It has rough edges!
88 .I -d data_source_device
91 option, specifies that
93 should be used when reading blocks not found in the ext2 image file.
94 This includes data, directory, and indirect blocks.
97 Forces the use of the given block size (in bytes) for the file system,
98 rather than detecting the correct block size automatically. (This
99 option is rarely needed; it is used primarily when the file system is
100 extremely badly damaged/corrupted.)
103 Causes the file system superblock to be read from the given block
104 number, instead of using the primary superblock (located at an offset of
105 1024 bytes from the beginning of the filesystem). If you specify the
107 option, you must also provide the blocksize of the filesystem via the
110 option is rarely needed; it is used primarily when the file system is
111 extremely badly damaged/corrupted.)
116 to read in commands from
118 and execute them. When
120 is finished executing those commands, it will exit.
125 to open the device using Direct I/O, bypassing the buffer cache. Note
126 that some Linux devices, notably device mapper as of this writing, do
127 not support Direct I/O.
132 to execute the single command
137 print the version number of
142 Before overwriting a file system block, write the old contents of the block to
143 an undo file. This undo file can be used with e2undo(8) to restore the old
144 contents of the file system should something go wrong. If the empty string is
145 passed as the undo_file argument, the undo file will be written to a file named
146 resize2fs-\fIdevice\fR.e2undo in the directory specified via the
147 \fIE2FSPROGS_UNDO_DIR\fR environment variable.
149 WARNING: The undo file cannot be used to recover from a power or system crash.
155 as an argument to specify an inode (as opposed to a pathname)
156 in the filesystem which is currently opened by
160 argument may be specified in two forms. The first form is an inode
161 number surrounded by angle brackets, e.g.,
163 The second form is a pathname; if the pathname is prefixed by a forward slash
164 ('/'), then it is interpreted relative to the root of the filesystem
165 which is currently opened by
167 If not, the pathname is
168 interpreted relative to the current working directory as maintained by
170 This may be modified by using the
178 This is a list of the commands which
182 .BI blocks " filespace"
183 Print the blocks used by the inode
187 .BI bmap " [ -a ] filespec logical_block [physical_block]"
188 Print or set the physical block number corresponding to the logical block number
194 flag is specified, try to allocate a block if necessary.
196 .BI block_dump " [-f filespec] block_num"
197 Dump the filesystem block given by
199 in hex and ASCII format to the console. If the
201 option is specified, the block number is relative to the start of the given
205 Dump the contents of the inode
210 Change the current working directory to
213 .BI chroot " filespec"
214 Change the root directory to be the directory
218 Close the currently open file system. If the
220 option is specified, write out any changes to the superblock and block
221 group descriptors to all of the backup superblocks, not just to the
225 Clear the contents of the inode
228 .BI dirsearch " filespec filename"
235 Mark the filesystem as dirty, so that the superblocks will be written on exit.
237 .BI dump " [-p] filespec out_file"
238 Dump the contents of the inode
244 option is given set the owner, group and permissions information on
249 .BI dump_mmp " [mmp_block]"
250 Display the multiple-mount protection (mmp) field values. If
252 is specified then verify and dump the MMP values from the given block
253 number, otherwise use the
255 field in the superblock to locate and use the existing MMP block.
257 .BI dx_hash " [-h hash_alg] [-s hash_seed] filename"
258 Calculate the directory hash of
260 The hash algorithm specified with
263 .BR legacy , " half_md4" ", or " tea .
264 The hash seed specified with
266 must be in UUID format.
268 .BI dump_extents " [-n] [-l] filespec"
269 Dump the the extent tree of the inode
275 to only display the interior nodes in the extent tree. The
279 to only display the leaf nodes in the extent tree.
281 (Please note that the length and range of blocks for the last extent in
282 an interior node is an estimate by the extents library functions, and is
283 not stored in filesystem data structures. Hence, the values displayed
284 may not necessarily by accurate and does not indicate a problem or
285 corruption in the file system.)
287 .BI ea_get " [-f outfile] filespec attr_name"
288 Retrieve the value of the extended attribute
292 and write it either to stdout or to \fIoutfile\fR.
294 .BI ea_list " filespec
295 List the extended attributes associated with the file
299 .BI ea_set " [-f infile] filespec attr_name attr_value
300 Set the value of the extended attribute
306 or read it from \fIinfile\fR.
308 .BI ea_rm " filespec attr_names...
309 Remove the extended attribute
311 from the file \fIfilespec\fR.
313 .BI expand_dir " filespec"
317 .BI fallocate " filespec start_block [end_block]
318 Allocate and map uninitialized blocks into \fIfilespec\fR between
319 logical block \fIstart_block\fR and \fIend_block\fR, inclusive. If
320 \fIend_block\fR is not supplied, this function maps until it runs out
321 of free disk blocks or the maximum file size is reached. Existing
322 mappings are left alone.
324 .BI feature " [fs_feature] [-fs_feature] ..."
325 Set or clear various filesystem features in the superblock. After setting
326 or clearing any filesystem features that were requested, print the current
327 state of the filesystem feature set.
329 .BI filefrag " [-dvr] filespec"
330 Print the number of contiguous extents in
334 is a directory and the
336 option is not specified,
338 will print the number of contiguous extents for each file in
343 print a tabular listing of the contiguous extents in the
348 to do a recursive listing of the directory.
350 .BI find_free_block " [count [goal]]"
353 free blocks, starting from
355 and allocate it. Also available as
358 .BI find_free_inode " [dir [mode]]"
359 Find a free inode and allocate it. If present,
361 specifies the inode number of the directory
362 which the inode is to be located. The second
365 specifies the permissions of the new inode. (If the directory bit is set
366 on the mode, the allocation routine will function differently.) Also
370 .BI freeb " block [count]"
371 Mark the block number
374 If the optional argument
378 blocks starting at block number
380 will be marked as not allocated.
382 .BI freefrag " [-c chunk_kb]"
383 Report free space fragmentation on the currently open file system.
386 option is specified then the filefrag command will print how many free
389 can be found in the file system. The chunk size must be a power of two
390 and be larger than the file system block size.
392 .BI freei " filespec [num]"
393 Free the inode specified by
397 is specified, also clear num-1 inodes after the specified inode.
400 Print a list of commands understood by
403 .BI htree_dump " filespec"
404 Dump the hash-indexed directory
406 showing its tree structure.
408 .BI icheck " block ..."
409 Print a listing of the inodes which use the one or more blocks specified
412 .BI inode_dump " filespec"
413 Print the contents of the inode data structure in hex and ASCII format.
416 Print the location of the inode data structure (in the inode table)
420 .BI init_filesys " device blocksize"
421 Create an ext2 file system on
425 Note that this does not fully initialize all of the data structures;
428 program. This is just a call to the low-level library, which sets up
429 the superblock and block descriptors.
432 Close the open journal.
434 .BI journal_open " [-c] [-v ver] [-j ext_jnl]
435 Opens the journal for reading and writing. Journal checksumming can
436 be enabled by supplying \fI-c\fR; checksum formats 2 and 3 can be
437 selected with the \fI-v\fR option. An external journal can be loaded
441 Replay all transactions in the open journal.
443 .BI journal_write " [-b blocks] [-r revoke] [-c] file
444 Write a transaction to the open journal. The list of blocks to write
445 should be supplied as a comma-separated list in \fIblocks\fR; the
446 blocks themselves should be readable from \fIfile\fR. A list of
447 blocks to revoke can be supplied as a comma-separated list in
448 \fIrevoke\fR. By default, a commit record is written at the end; the
449 \fI-c\fR switch writes an uncommitted transaction.
451 .BI kill_file " filespec"
454 and its blocks. Note that this does not remove any directory
455 entries (if any) to this inode. See the
457 command if you wish to unlink a file.
460 Change the current working directory of the
464 on the native filesystem.
466 .BI ln " filespec dest_file"
469 which is a hard link to
471 Note this does not adjust the inode reference counts.
473 .BI logdump " [-acsO] [-b block] [-i filespec] [-f journal_file] [output_file]"
474 Dump the contents of the ext3 journal. By default, dump the journal inode as
475 specified in the superblock. However, this can be overridden with the
477 option, which dumps the journal from the internal inode given by
479 A regular file containing journal data can be specified using the
483 option utilizes the backup information in the superblock to locate the
490 program to print the contents of all of the descriptor blocks.
495 to print all journal records that are refer to the specified block.
498 option will print out the contents of all of the data blocks selected by
507 option causes logdump to display old (checkpointed) journal entries.
508 This can be used to try to track down journal problems even after the
509 journal has been replayed.
511 .BI ls " [-l] [-c] [-d] [-p] [-r] filespec"
512 Print a listing of the files in the directory
516 flag causes directory block checksums (if present) to be displayed.
519 flag will list deleted entries in the directory.
522 flag will list files using a more verbose format.
525 flag will list the files in a format which is more easily parsable by
526 scripts, as well as making it more clear when there are spaces or other
527 non-printing characters at the end of filenames.
530 flag will force the printing of the filename, even if it is encrypted.
532 .BI list_deleted_inodes " [limit]"
533 List deleted inodes, optionally limited to those deleted within
535 seconds ago. Also available as
538 This command was useful for recovering from accidental file deletions
539 for ext2 file systems. Unfortunately, it is not useful for this purpose
540 if the files were deleted using ext3 or ext4, since the inode's
541 data blocks are no longer available after the inode is released.
543 .BI modify_inode " filespec"
544 Modify the contents of the inode structure in the inode
549 .BI mkdir " filespec"
552 .BI mknod " filespec [p|[[c|b] major minor]]"
553 Create a special device file (a named pipe, character or block device).
554 If a character or block device is to be made, the
558 device numbers must be specified.
560 .BI ncheck " [-c] inode_num ..."
561 Take the requested list of inode numbers, and print a listing of pathnames
564 flag will enable checking the file type information in the directory
565 entry to make sure it matches the inode's type.
567 .BI open " [-weficD] [-b blocksize] [-s superblock] [-z undo_file] device"
568 Open a filesystem for editing. The
570 flag forces the filesystem to be opened even if there are some unknown
571 or incompatible filesystem features which would normally
572 prevent the filesystem from being opened. The
574 flag causes the filesystem to be opened in exclusive mode. The
575 .IR -b ", " -c ", " -i ", " -s ", " -w ", and " -D
576 options behave the same as the command-line options to
579 .BI punch " filespec start_blk [end_blk]"
580 Delete the blocks in the inode ranging from
586 is omitted then this command will function as a truncate command; that
587 is, all of the blocks starting at
589 through to the end of the file will be deallocated.
591 .BI symlink " filespec target"
592 Make a symbolic link.
595 Print the current working directory.
601 .BI rdump " directory[...] destination"
606 and all its contents (including regular files, symbolic links, and other
607 directories) into the named
609 which should be an existing directory on the native filesystem.
614 If this causes the inode pointed to by
616 to have no other references, deallocate the file. This command functions
617 as the unlink() system call.
620 .BI rmdir " filespec"
624 .BI setb " block [count]"
625 Mark the block number
628 If the optional argument
632 blocks starting at block number
634 will be marked as allocated.
636 .BI set_block_group " bgnum field value"
637 Modify the block group descriptor specified by
639 so that the block group descriptor field
646 .BI seti " filespec [num]"
649 as in use in the inode bitmap. If
651 is specified, also set num-1 inodes after the specified inode.
653 .BI set_inode_field " filespec field value"
654 Modify the inode specified by
656 so that the inode field
660 The list of valid inode fields which can be set via this command
661 can be displayed by using the command:
662 .B set_inode_field -l
666 .BI set_mmp_value " field value"
667 Modify the multiple-mount protection (MMP) data so that the MMP field
671 The list of valid MMP fields which can be set via this command
672 can be displayed by using the command:
677 .BI set_super_value " field value"
678 Set the superblock field
682 The list of valid superblock fields which can be set via this command
683 can be displayed by using the command:
684 .B set_super_value -l
688 .BI show_super_stats " [-h]"
689 List the contents of the super block and the block group descriptors. If the
691 flag is given, only print out the superblock contents. Also available as
695 Display the contents of the inode structure of the inode
698 .BI testb " block [count]"
699 Test if the block number
701 is marked as allocated in the block bitmap.
702 If the optional argument
706 blocks starting at block number
710 .BI testi " filespec"
713 is marked as allocated in the inode bitmap.
715 .BI undel " <inode_number> [pathname]"
716 Undelete the specified inode number (which must be surrounded by angle
717 brackets) so that it and its blocks are marked in use, and optionally
718 link the recovered inode to the specified pathname. The
720 command should always be run after using the
722 command to recover deleted files.
724 Note that if you are recovering a large number of deleted files, linking
725 the inode to a directory may require the directory to be expanded, which
726 could allocate a block that had been used by one of the
727 yet-to-be-undeleted files. So it is safer to undelete all of the
728 inodes without specifying a destination pathname, and then in a separate
729 pass, use the debugfs
731 command to link the inode to the destination pathname, or use
733 to check the filesystem and link all of the recovered inodes to the
734 lost+found directory.
736 .BI unlink " pathname"
737 Remove the link specified by
739 to an inode. Note this does not adjust the inode reference counts.
741 .BI write " source_file out_file"
744 into a newly-created file in the filesystem named
747 .BI zap_block " [-f filespec] [-o offset] [-l length] [-p pattern] block_num"
748 Overwrite the block specified by
750 with zero (NUL) bytes, or if
752 is given use the byte specified by
758 is relative to the start of the file given by
764 options limit the range of bytes to zap to the specified
768 relative to the start of the block.
770 .BI zap_block " [-f filespec] [-b bit] block_num"
771 Bit-flip portions of the physical
777 is a logical block relative to the start of
779 .SH ENVIRONMENT VARIABLES
781 .B DEBUGFS_PAGER, PAGER
784 program always pipes the output of the some commands through a
785 pager program. These commands include:
786 .IR show_super_stats " (" stats ),
787 .IR list_directory " (" ls ),
788 .IR show_inode_info " (" stat ),
789 .IR list_deleted_inodes " (" lsdel ),
792 The specific pager can explicitly specified by the
794 environment variable, and if it is not set, by the
796 environment variable.
798 Note that since a pager is always used, the
800 pager is not particularly appropriate, since it clears the screen before
801 displaying the output of the command and clears the output the screen
802 when the pager is exited. Many users prefer to use the
804 pager for most purposes, which is why the
806 environment variable is available to override the more general
808 environment variable.
811 was written by Theodore Ts'o <tytso@mit.edu>.