Manpage/btrfs-inspect-internal

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(Update from git, v4.2)
(Update from git, v4.3)
Line 5: Line 5:
 
==NAME==
 
==NAME==
  
btrfs-inspect-internal - resolve different btrfs items for debug purpose
+
btrfs-inspect-internal - query various internal information
  
 
==SYNOPSIS==
 
==SYNOPSIS==
Line 13: Line 13:
 
==DESCRIPTION==
 
==DESCRIPTION==
  
'''btrfs inspect-internal''' is used to resolve different items for debug purpose.
+
This command group provides an interface to query internal information. The functionality ranges from a simple UI to an ioctl or a more complex query that assembles the result from several internal structures. The latter usually requires calls to privileged ioctls.
  
 
==SUBCOMMAND==
 
==SUBCOMMAND==
  
; '''inode-resolve''' [-v] <inode> <path>
+
; '''inode-resolve''' [-v] <ino> <path>
: Resolves an &lt;inode&gt; in subvolume &lt;path&gt; to all filesystem paths. <br /><code>Options</code><br />
+
: (needs root privileges) <br /> resolve paths to all files with given inode number '''ino''' in a given subvolume at '''path''', ie. all hardlinks <br /><code>Options</code><br />
 
:; -v
 
:; -v
:: verbose mode. print count of returned paths and ioctl() return value
+
:: verbose mode, print count of returned paths and ioctl() return value
 
; '''logical-resolve''' [-Pv] [-s &lt;bufsize&gt;] &lt;logical&gt; &lt;path&gt;
 
; '''logical-resolve''' [-Pv] [-s &lt;bufsize&gt;] &lt;logical&gt; &lt;path&gt;
: Resolves a &lt;logical&gt; address in the filesystem mounted at &lt;path&gt; to all inodes. <br /> By default, each inode is then resolved to a file system path (similar to the inode-resolve subcommand). <br /><code>Options</code><br />
+
: (needs root privileges) <br /> resolve paths to all files at given '''logical''' address in the linear filesystem space <br /><code>Options</code><br />
 
:; -P
 
:; -P
 
:: skip the path resolving and print the inodes instead
 
:: skip the path resolving and print the inodes instead
 
:; -v
 
:; -v
:: verbose mode. print count of returned paths and all ioctl() return values
+
:: verbose mode, print count of returned paths and all ioctl() return values
 
:; -s &lt;bufsize&gt;
 
:; -s &lt;bufsize&gt;
:: set inode container’s size. <br /> This is used to increase inode container’s size in case it is not enough to read all the resolved results. The max value one can set is 64k.
+
:: set internal buffer for storing the file names to '''bufsize''', default is 4096, maximum 64k
 
; '''min-dev-size''' [options] &lt;path&gt;
 
; '''min-dev-size''' [options] &lt;path&gt;
: Return the minimum size the device can be shrunk to, without performing any resize operation. <br /><code>Options</code><br />
+
: (needs root privileges) <br /> return the minimum size the device can be shrunk to, without performing any resize operation, this may be useful before executing the actual resize operation <br /><code>Options</code><br />
:; --id
+
:; --id &lt;id&gt;
:: specify the device id to query, default is 1
+
:: specify the device '''id''' to query, default is 1 if this option is not used
 
; '''rootid''' &lt;path&gt;
 
; '''rootid''' &lt;path&gt;
: For a given file or directory, return the containing tree root id. For a subvolume return it’s own tree id. <br /> The result is undefined for the so-called empty subvolumes (identified by inode number 2).
+
: for a given file or directory, return the containing tree root id, for a subvolume itself return it’s own tree id (ie. subvol id) <br />'''Note:''' The result is undefined for the so-called empty subvolumes (identified by inode number 2), but such subvolume does not contain any files anyway
 
; '''subvolid-resolve''' &lt;subvolid&gt; &lt;path&gt;
 
; '''subvolid-resolve''' &lt;subvolid&gt; &lt;path&gt;
: Get file system paths for the given subvolume ID.
+
: (needs root privileges) <br /> resolve the absolute path of a the subvolume id '''subvolid'''
  
 
==EXIT STATUS==
 
==EXIT STATUS==

Revision as of 16:09, 7 November 2015

Contents

btrfs-inspect-internal(8) Manual Page

Warning: this page is automatically generated from git, all edits will be lost. Current git version.


NAME

btrfs-inspect-internal - query various internal information

SYNOPSIS

btrfs inspect-internal <subcommand> <args>

DESCRIPTION

This command group provides an interface to query internal information. The functionality ranges from a simple UI to an ioctl or a more complex query that assembles the result from several internal structures. The latter usually requires calls to privileged ioctls.

SUBCOMMAND

inode-resolve [-v] <ino> <path>
(needs root privileges)
resolve paths to all files with given inode number ino in a given subvolume at path, ie. all hardlinks
Options
-v
verbose mode, print count of returned paths and ioctl() return value
logical-resolve [-Pv] [-s <bufsize>] <logical> <path>
(needs root privileges)
resolve paths to all files at given logical address in the linear filesystem space
Options
-P
skip the path resolving and print the inodes instead
-v
verbose mode, print count of returned paths and all ioctl() return values
-s <bufsize>
set internal buffer for storing the file names to bufsize, default is 4096, maximum 64k
min-dev-size [options] <path>
(needs root privileges)
return the minimum size the device can be shrunk to, without performing any resize operation, this may be useful before executing the actual resize operation
Options
--id <id>
specify the device id to query, default is 1 if this option is not used
rootid <path>
for a given file or directory, return the containing tree root id, for a subvolume itself return it’s own tree id (ie. subvol id)
Note: The result is undefined for the so-called empty subvolumes (identified by inode number 2), but such subvolume does not contain any files anyway
subvolid-resolve <subvolid> <path>
(needs root privileges)
resolve the absolute path of a the subvolume id subvolid

EXIT STATUS

btrfs inspect-internal returns a zero exit status if it succeeds. Non zero is returned in case of failure.

AVAILABILITY

btrfs is part of btrfs-progs. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for further details.

SEE ALSO

mkfs.btrfs(8), btrfs-debug-tree(8)

Personal tools