2 .\" Copyright (c) 2013 by Turbo Fredriksson <turbo@bayour.com>. All rights reserved.
3 .\" The contents of this file are subject to the terms of the Common Development
4 .\" and Distribution License (the "License"). You may not use this file except
5 .\" in compliance with the License. You can obtain a copy of the license at
6 .\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
8 .\" See the License for the specific language governing permissions and
9 .\" limitations under the License. When distributing Covered Code, include this
10 .\" CDDL HEADER in each file and include the License file at
11 .\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
12 .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
13 .\" own identifying information:
14 .\" Portions Copyright [yyyy] [name of copyright owner]
15 .TH ZFS-EVENTS 5 "Jun 6, 2015"
17 zfs\-events \- Events created by the ZFS filesystem.
21 Description of the different events generated by the ZFS stack.
23 Most of these don't have any description. The events generated by ZFS
24 have never been publicly documented. What is here is intended as a
25 starting point to provide documentation for all possible events.
27 To view all events created since the loading of the ZFS infrastructure
28 (i.e, "the module"), run
34 to get a short list, and
40 to get a full detail of the events and what information
41 is available about it.
43 This man page lists the different subclasses that are issued
44 in the case of an event. The full event name would be
45 \fIereport.fs.zfs.SUBCLASS\fR, but we only list the last
48 .SS "EVENTS (SUBCLASS)"
58 Issued when a checksum error have been detected.
67 Issued when there is an I/O error in a vdev in the pool.
76 Issued when there have been data errors in the pool.
85 Issued when an I/O was slow to complete as defined by the zio_delay_max module
95 Issued every time a vdev change have been done to the pool.
104 Issued when a pool cannot be imported.
113 Issued when a pool is destroyed.
122 Issued when a pool is exported.
131 Issued when a pool is imported.
140 Issued when a REGUID (new unique identifier for the pool have been regenerated) have been detected.
149 Issued when the vdev is unknown. Such as trying to clear device
150 errors on a vdev that have failed/been kicked from the system/pool
151 and is no longer available.
157 \fBvdev.open_failed\fR
160 Issued when a vdev could not be opened (because it didn't exist for example).
166 \fBvdev.corrupt_data\fR
169 Issued when corrupt data have been detected on a vdev.
175 \fBvdev.no_replicas\fR
178 Issued when there are no more replicas to sustain the pool.
179 This would lead to the pool being \fIDEGRADED\fR.
185 \fBvdev.bad_guid_sum\fR
188 Issued when a missing device in the pool have been detected.
197 Issued when the system (kernel) have removed a device, and ZFS
198 notices that the device isn't there any more. This is usually
199 followed by a \fBprobe_failure\fR event.
208 Issued when the label is OK but invalid.
214 \fBvdev.bad_ashift\fR
217 Issued when the ashift alignment requirement has increased.
226 Issued when a vdev is detached from a mirror (or a spare detached from a
227 vdev where it have been used to replace a failed drive - only works if
228 the original drive have been readded).
237 Issued when clearing device errors in a pool. Such as running \fBzpool clear\fR
238 on a device in the pool.
247 Issued when a check to see if a given vdev could be opened is started.
256 Issued when a spare have kicked in to replace a failed device.
262 \fBvdev.autoexpand\fR
265 Issued when a vdev can be automatically expanded.
274 Issued when there is an I/O failure in a vdev in the pool.
283 Issued when a probe fails on a vdev. This would occur if a vdeev
284 have been kicked from the system outside of ZFS (such as the kernel
285 have removed the device).
294 Issued when the intent log cannot be replayed. The can occur in the case
295 of a missing or damaged log device.
304 Issued when a resilver is started.
310 \fBresilver.finish\fR
313 Issued when the running resilver have finished.
322 Issued when a scrub is started on a pool.
331 Issued when a pool have finished scrubbing.
337 \fBbootfs.vdev.attach\fR
345 This is the payload (data, information) that accompanies an
350 these are set to uppercase and prefixed with \fBZEVENT_\fR.
367 Failmode - \fBwait\fR, \fBcontinue\fR or \fBpanic\fR.
370 (\fIfailmode\fR property) for more information.
379 The GUID of the pool.
388 The load state for the pool (0=none, 1=open, 2=import, 3=tryimport, 4=recover
398 The GUID of the vdev in question (the vdev failing or operated upon with
399 \fBzpool clear\fR etc).
408 Type of vdev - \fBdisk\fR, \fBfile\fR, \fBmirror\fR etc. See
410 under \fBVirtual Devices\fR for more information on possible values.
419 Full path of the vdev, including any \fI-partX\fR.
437 Physical FRU location.
446 State of vdev (0=uninitialized, 1=closed, 2=offline, 3=removed, 4=failed to open, 5=faulted, 6=degraded, 7=healty).
455 The ashift value of the vdev.
461 \fBvdev_complete_ts\fR
464 The time the last I/O completed for the specified vdev.
473 The time since the last I/O completed for the specified vdev.
479 \fBvdev_spare_paths\fR
482 List of spares, including full path and any \fI-partX\fR.
488 \fBvdev_spare_guids\fR
497 \fBvdev_read_errors\fR
500 How many read errors that have been detected on the vdev.
506 \fBvdev_write_errors\fR
509 How many write errors that have been detected on the vdev.
515 \fBvdev_cksum_errors\fR
518 How many checkum errors that have been detected on the vdev.
527 GUID of the vdev parent.
536 Type of parent. See \fBvdev_type\fR.
545 Path of the vdev parent (if any).
554 ID of the vdev parent (if any).
563 The object set number for a given I/O.
572 The object number for a given I/O.
581 The block level for a given I/O.
590 The block ID for a given I/O.
599 The errno for a failure when handling a given I/O.
608 The offset in bytes of where to write the I/O for the specified vdev.
617 The size in bytes of the I/O.
626 The current flags describing how the I/O should be handled. See the
627 \fBI/O FLAGS\fR section for the full list of I/O flags.
636 The current stage of the I/O in the pipeline. See the \fBI/O STAGES\fR
637 section for a full list of all the I/O stages.
646 The valid pipeline stages for the I/O. See the \fBI/O STAGES\fR section for a
647 full list of all the I/O stages.
656 The time in ticks (HZ) required for the block layer to service the I/O. Unlike
657 \fBzio_delta\fR this does not include any vdev queuing time and is therefore
658 solely a measure of the block layer performance. On most modern Linux systems
659 HZ is defined as 1000 making a tick equivalent to 1 millisecond.
668 The time when a given I/O was submitted.
677 The time required to service a given I/O.
686 The previous state of the vdev.
695 The expected checksum value.
704 The actual/current checksum value.
710 \fBcksum_algorithm\fR
713 Checksum algorithm used. See \fBzfs\fR(8) for more information on checksum algorithms available.
722 Checksum value is byte swapped.
731 Checksum bad offset ranges.
737 \fBbad_ranges_min_gap\fR
740 Checksum allowed minimum gap.
749 Checksum for each range the number of bits set.
755 \fBbad_range_clears\fR
758 Checksum for each range the number of bits cleared.
767 Checksum array of bits set.
773 \fBbad_cleared_bits\fR
776 Checksum array of bits cleared.
782 \fBbad_set_histogram\fR
785 Checksum histogram of set bits by bit number in a 64-bit word.
791 \fBbad_cleared_histogram\fR
794 Checksum histogram of cleared bits by bit number in a 64-bit word.
800 The ZFS I/O pipeline is comprised of various stages which are defined
801 below. The individual stages are used to construct these basic I/O
802 operations: Read, Write, Free, Claim, and Ioctl. These stages may be
803 set on an event to describe the life cycle of a given I/O.
808 Stage:Bit Mask:Operations
810 ZIO_STAGE_OPEN:0x00000001:RWFCI
812 ZIO_STAGE_READ_BP_INIT:0x00000002:R----
813 ZIO_STAGE_FREE_BP_INIT:0x00000004:--F--
814 ZIO_STAGE_ISSUE_ASYNC:0x00000008:RWF--
815 ZIO_STAGE_WRITE_BP_INIT:0x00000010:-W---
817 ZIO_STAGE_CHECKSUM_GENERATE:0x00000020:-W---
819 ZIO_STAGE_NOP_WRITE:0x00000040:-W---
821 ZIO_STAGE_DDT_READ_START:0x00000080:R----
822 ZIO_STAGE_DDT_READ_DONE:0x00000100:R----
823 ZIO_STAGE_DDT_WRITE:0x00000200:-W---
824 ZIO_STAGE_DDT_FREE:0x00000400:--F--
826 ZIO_STAGE_GANG_ASSEMBLE:0x00000800:RWFC-
827 ZIO_STAGE_GANG_ISSUE:0x00001000:RWFC-
829 ZIO_STAGE_DVA_ALLOCATE:0x00002000:-W---
830 ZIO_STAGE_DVA_FREE:0x00004000:--F--
831 ZIO_STAGE_DVA_CLAIM:0x00008000:---C-
833 ZIO_STAGE_READY:0x00010000:RWFCI
835 ZIO_STAGE_VDEV_IO_START:0x00020000:RW--I
836 ZIO_STAGE_VDEV_IO_DONE:0x00040000:RW--I
837 ZIO_STAGE_VDEV_IO_ASSESS:0x00080000:RW--I
839 ZIO_STAGE_CHECKSUM_VERIFY0:0x00100000:R----
841 ZIO_STAGE_DONE:0x00200000:RWFCI
847 Every I/O in the pipeline contains a set of flags which describe its
848 function and are used to govern its behavior. These flags will be set
849 in an event as an \fBzio_flags\fR payload entry.
856 ZIO_FLAG_DONT_AGGREGATE:0x00000001
857 ZIO_FLAG_IO_REPAIR:0x00000002
858 ZIO_FLAG_SELF_HEAL:0x00000004
859 ZIO_FLAG_RESILVER:0x00000008
860 ZIO_FLAG_SCRUB:0x00000010
861 ZIO_FLAG_SCAN_THREAD:0x00000020
862 ZIO_FLAG_PHYSICAL:0x00000040
864 ZIO_FLAG_CANFAIL:0x00000080
865 ZIO_FLAG_SPECULATIVE:0x00000100
866 ZIO_FLAG_CONFIG_WRITER:0x00000200
867 ZIO_FLAG_DONT_RETRY:0x00000400
868 ZIO_FLAG_DONT_CACHE:0x00000800
869 ZIO_FLAG_NODATA:0x00001000
870 ZIO_FLAG_INDUCE_DAMAGE:0x00002000
872 ZIO_FLAG_IO_RETRY:0x00004000
873 ZIO_FLAG_PROBE:0x00008000
874 ZIO_FLAG_TRYHARD:0x00010000
875 ZIO_FLAG_OPTIONAL:0x00020000
877 ZIO_FLAG_DONT_QUEUE:0x00040000
878 ZIO_FLAG_DONT_PROPAGATE:0x00080000
879 ZIO_FLAG_IO_BYPASS:0x00100000
880 ZIO_FLAG_IO_REWRITE:0x00200000
881 ZIO_FLAG_RAW:0x00400000
882 ZIO_FLAG_GANG_CHILD:0x00800000
883 ZIO_FLAG_DDT_CHILD:0x01000000
884 ZIO_FLAG_GODFATHER:0x02000000
885 ZIO_FLAG_NOPWRITE:0x04000000
886 ZIO_FLAG_REEXECUTED:0x08000000
887 ZIO_FLAG_DELEGATED:0x10000000
888 ZIO_FLAG_FASTWRITE:0x20000000