cddl/contrib/opensolaris/cmd/zdb/zdb.8

   1 '\" te
   2 .\" Copyright (c) 2012, Martin Matuska <mm@FreeBSD.org>.
   3 .\" All Rights Reserved.
   4 .\"
   5 .\" This file and its contents are supplied under the terms of the
   6 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   7 .\" You may only use this file in accordance with the terms of version
   8 .\" 1.0 of the CDDL.
   9 .\"
  10 .\" A full copy of the text of the CDDL should have accompanied this
  11 .\" source.  A copy of the CDDL is also available via the Internet at
  12 .\" http://www.illumos.org/license/CDDL.
  13 .\"
  14 .\"
  15 .\" Copyright 2012, Richard Lowe.
  16 .\" Copyright (c) 2012, Marcelo Araujo <araujo@FreeBSD.org>.
  17 .\" Copyright (c) 2012 by Delphix. All rights reserved.
  18 .\" All Rights Reserved.
  19 .\"
  20 .\" $FreeBSD$
  21 .\"
  22 .Dd December 31, 2013
  23 .Dt ZDB 8
  24 .Os
  25 .Sh NAME
  26 .Nm zdb
  27 .Nd Display zpool debugging and consistency information
  28 .Sh SYNOPSIS
  29 .Nm
  30 .Op Fl CumdibcsDvhLXFPA
  31 .Op Fl e Op Fl p Ar path...
  32 .Op Fl t Ar txg
  33 .Op Fl U Ar cache
  34 .Op Fl M Ar inflight I/Os
  35 .Ar poolname
  36 .Op Ar object ...
  37 .Nm
  38 .Op Fl divPA
  39 .Op Fl e Op Fl p Ar path...
  40 .Op Fl U Ar cache
  41 .Ar dataset
  42 .Op Ar object ...
  43 .Nm
  44 .Fl m Op Fl LXFPA
  45 .Op Fl t Ar txg
  46 .Op Fl e Op Fl p Ar path...
  47 .Op Fl U Ar cache
  48 .Ar poolname
  49 .Nm
  50 .Fl R Op Fl A
  51 .Op Fl e Op Fl p Ar path...
  52 .Op Fl U Ar cache
  53 .Ar poolname
  54 .Ar poolname
  55 .Ar vdev Ns : Ns Ar offset Ns : Ns Ar size Ns Op Ns : Ns Ar flags
  56 .Nm
  57 .Fl S
  58 .Op Fl AP
  59 .Op Fl e Op Fl p Ar path...
  60 .Op Fl U Ar cache
  61 .Ar poolname
  62 .Ar poolname
  63 .Nm
  64 .Fl l
  65 .Op Fl uA
  66 .Ar device
  67 .Nm
  68 .Fl C
  69 .Op Fl A
  70 .Op Fl U Ar cache
  71 .Sh DESCRIPTION
  72 The
  73 .Nm
  74 utility displays information about a ZFS pool useful for debugging and
  75 performs some amount of consistency checking.
  76 It is a not a general purpose tool and options (and facilities) may change.
  77 This is neither a
  78 .Xr fsck 8
  79 nor a
  80 .Xr fsdb 8
  81 utility.
  82 .Pp
  83 The output of this command in general reflects the on-disk structure of a ZFS
  84 pool, and is inherently unstable.
  85 The precise output of most invocations is not documented, a knowledge of ZFS
  86 internals is assumed.
  87 .Pp
  88 When operating on an imported and active pool it is possible, though unlikely,
  89 that zdb may interpret inconsistent pool data and behave erratically.
  90 .Sh OPTIONS
  91 Display options:
  92 .Bl -tag -width indent
  93 .It Fl b
  94 Display statistics regarding the number, size (logical, physical and
  95 allocated) and deduplication of blocks.
  96 .It Fl c
  97 Verify the checksum of all metadata blocks while printing block statistics
  98 (see
  99 .Fl b Ns ).
 100 .Pp
 101 If specified multiple times, verify the checksums of all blocks.
 102 .It Fl C
 103 Display information about the configuration. If specified with no other
 104 options, instead display information about the cache file
 105 .Po Pa /etc/zfs/zpool.cache Pc .
 106 To specify the cache file to display, see
 107 .Fl U
 108 .Pp
 109 If specified multiple times, and a pool name is also specified display both
 110 the cached configuration and the on-disk configuration.
 111 If specified multiple times with
 112 .Fl e
 113 also display the configuration that would be used were the pool to be
 114 imported.
 115 .It Fl d
 116 Display information about datasets. Specified once, displays basic dataset
 117 information: ID, create transaction, size, and object count.
 118 .Pp
 119 If specified multiple times provides greater and greater verbosity.
 120 .Pp
 121 If object IDs are specified, display information about those specific objects only.
 122 .It Fl D
 123 Display deduplication statistics, including the deduplication ratio (dedup),
 124 compression ratio (compress), inflation due to the zfs copies property
 125 (copies), and an overall effective ratio (dedup * compress / copies).
 126 .Pp
 127 If specified twice, display a histogram of deduplication statistics, showing
 128 the allocated (physically present on disk) and referenced (logically
 129 referenced in the pool) block counts and sizes by reference count.
 130 .It Fl h
 131 Display pool history similar to
 132 .Cm zpool history ,
 133 but include internal changes, transaction, and dataset information.
 134 .It Fl i
 135 Display information about intent log (ZIL) entries relating to each
 136 dataset.
 137 If specified multiple times, display counts of each intent log transaction
 138 type.
 139 .It Fl l Ar device
 140 Display the vdev labels from the specified device.
 141 If the
 142 .Fl u
 143 option is also specified, also display the uberblocks on this device.
 144 .It Fl L
 145 Disable leak tracing and the loading of space maps.
 146 By default,
 147 .Nm
 148 verifies that all non-free blocks are referenced, which can be very expensive.
 149 .It Fl m
 150 Display the offset, spacemap, and free space of each metaslab.
 151 When specified twice, also display information about the maximum contiguous
 152 free space and the percentage of free space in each space map.
 153 When specified three times display every spacemap record.
 154 .It Xo
 155 .Fl R Ar poolname
 156 .Ar vdev Ns : Ns Ar offset Ns : Ns Ar size Ns Op Ns : Ns Ar flags
 157 .Xc
 158 Read and display a block from the specified device. By default the block is
 159 displayed as a hex dump, but see the description of the
 160 .Fl r
 161 flag, below.
 162 .Pp
 163 The block is specified in terms of a colon-separated tuple
 164 .Ar vdev
 165 (an integer vdev identifier)
 166 .Ar offset
 167 (the offset within the vdev)
 168 .Ar size
 169 (the size of the block to read) and, optionally,
 170 .Ar flags
 171 (a set of flags, described below).
 172 .Bl -tag -width indent
 173 .It Sy b offset
 174 Print block pointer
 175 .It Sy d
 176 Decompress the block
 177 .It Sy e
 178 Byte swap the block
 179 .It Sy g
 180 Dump gang block header
 181 .It Sy i
 182 Dump indirect block
 183 .It Sy r
 184 Dump raw uninterpreted block data
 185 .El
 186 .It Fl s
 187 Report statistics on
 188 .Nm Ns 's
 189 I/O.
 190 Display operation counts, bandwidth, and error counts of I/O to the pool from
 191 .Nm .
 192 .It Fl S
 193 Simulate the effects of deduplication, constructing a DDT and then display
 194 that DDT as with \fB-DD\fR.
 195 .It Fl u
 196 Display the current uberblock.
 197 .El
 198 .Pp
 199 Other options:
 200 .Bl -tag -width indent
 201 .It Fl A
 202 Do not abort should any assertion fail.
 203 .It Fl AA
 204 Enable panic recovery, certain errors which would otherwise be fatal are
 205 demoted to warnings.
 206 .It Fl AAA
 207 Do not abort if asserts fail and also enable panic recovery.
 208 .It Fl e Op Fl p Ar path...
 209 Operate on an exported pool, not present in
 210 .Pa /etc/zfs/zpool.cache .
 211 The
 212 .Fl p
 213 flag specifies the path under which devices are to be searched.
 214 .It Fl F
 215 Attempt to make an unreadable pool readable by trying progressively older
 216 transactions.
 217 .It Fl M Ar inflight I/Os
 218 Limit the number of outstanding checksum I/Os to the specified value.
 219 The default value is 200. This option affects the performance of the
 220 .Fl c
 221 option.
 222 .It Fl P
 223 Print numbers in an unscaled form more amenable to parsing, eg. 1000000 rather
 224 than 1M.
 225 .It Fl t Ar transaction
 226 Specify the highest transaction to use when searching for uberblocks.
 227 See also the
 228 .Fl u
 229 and
 230 .Fl l
 231 options for a means to see the available uberblocks and their associated
 232 transaction numbers.
 233 .It Fl U Ar cachefile
 234 Use a cache file other than
 235 .Pa /boot/zfs/zpool.cache .
 236 .It Fl v
 237 Enable verbosity.
 238 Specify multiple times for increased verbosity.
 239 .It Fl X
 240 Attempt
 241 .Ql extreme
 242 transaction rewind, that is attempt the same recovery as
 243 .Fl F
 244 but read transactions otherwise deemed too old.
 245 .El
 246 .Pp
 247 Specifying a display option more than once enables verbosity for only that
 248 option, with more occurrences enabling more verbosity.
 249 .Pp
 250 If no options are specified, all information about the named pool will be
 251 displayed at default verbosity.
 252 .Sh EXAMPLES
 253 .Bl -tag -width 0n
 254 .It Sy Example 1 Display the configuration of imported pool 'rpool'
 255 .Bd -literal -offset 2n
 256 .Li # Ic zdb -C rpool
 257
 258 MOS Configuration:
 259         version: 28
 260         name: 'rpool'
 261  ...
 262 .Ed
 263 .It Sy Example 2 Display basic dataset information about 'rpool'
 264 .Bd -literal -offset 2n
 265 .Li # Ic zdb -d rpool
 266 Dataset mos [META], ID 0, cr_txg 4, 26.9M, 1051 objects
 267 Dataset rpool/swap [ZVOL], ID 59, cr_txg 356, 486M, 2 objects
 268  ...
 269 .Ed
 270 .It Xo Sy Example 3 Display basic information about object 0 in
 271 .Sy 'rpool/export/home'
 272 .Xc
 273 .Bd -literal -offset 2n
 274 .Li # Ic zdb -d rpool/export/home 0
 275 Dataset rpool/export/home [ZPL], ID 137, cr_txg 1546, 32K, 8 objects
 276
 277     Object  lvl   iblk   dblk  dsize  lsize   %full  type
 278          0    7    16K    16K  15.0K    16K   25.00  DMU dnode
 279 .Ed
 280 .It Xo Sy Example 4 Display the predicted effect of enabling deduplication on
 281 .Sy 'rpool'
 282 .Xc
 283 .Bd -literal -offset 2n
 284 .Li # Ic zdb -S rpool
 285 Simulated DDT histogram:
 286
 287 bucket             allocated                      referenced
 288 ______  ______________________________  ______________________________
 289 refcnt  blocks   LSIZE   PSIZE   DSIZE  blocks   LSIZE   PSIZE   DSIZE
 290 ------  ------   -----   -----   -----  ------   -----   -----   -----
 291      1    694K   27.1G   15.0G   15.0G    694K   27.1G   15.0G   15.0G
 292      2   35.0K   1.33G    699M    699M   74.7K   2.79G   1.45G   1.45G
 293  ...
 294 dedup = 1.11, compress = 1.80, copies = 1.00, dedup * compress / copies = 2.00
 295 .Ed
 296 .El
 297 .Sh SEE ALSO
 298 .Xr zfs 8 ,
 299 .Xr zpool 8
 300 .Sh AUTHORS
 301 This manual page is a
 302 .Xr mdoc 7
 303 reimplementation of the
 304 .Tn illumos
 305 manual page
 306 .Em zdb(1M) ,
 307 modified and customized for
 308 .Fx
 309 and licensed under the
 310 Common Development and Distribution License
 311 .Pq Tn CDDL .
 312 .Pp
 313 The
 314 .Xr mdoc 7
 315 implementation of this manual page was initially written by
 316 .An Martin Matuska Aq mm@FreeBSD.org
 317 and
 318 .An Marcelo Araujo Aq araujo@FreeBSD.org .