Fedora 28: Fix misc bounds check compiler warnings
[zfs.git] / man / man5 / zfs-events.5
blob4c60eecc5d5f15f896a3033df08dcea7326b9a5e
1 '\" te
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.
7 .\"
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"
16 .SH NAME
17 zfs\-events \- Events created by the ZFS filesystem.
18 .SH DESCRIPTION
19 .sp
20 .LP
21 Description of the different events generated by the ZFS stack.
22 .sp
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.
26 .sp
27 To view all events created since the loading of the ZFS infrastructure
28 (i.e, "the module"), run
30 .nf
31 \fBzpool events\fR
32 .fi
34 to get a short list, and
36 .nf
37 \fBzpool events -v\fR
38 .fi
40 to get a full detail of the events and what information
41 is available about it.
42 .sp
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
46 part here.
48 .SS "EVENTS (SUBCLASS)"
49 .sp
50 .LP
52 .sp
53 .ne 2
54 .na
55 \fBchecksum\fR
56 .ad
57 .RS 12n
58 Issued when a checksum error has been detected.
59 .RE
61 .sp
62 .ne 2
63 .na
64 \fBio\fR
65 .ad
66 .RS 12n
67 Issued when there is an I/O error in a vdev in the pool.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fBdata\fR
74 .ad
75 .RS 12n
76 Issued when there have been data errors in the pool.
77 .RE
79 .sp
80 .ne 2
81 .na
82 \fBdeadman\fR
83 .ad
84 .RS 12n
85 Issued when an I/O is determined to be "hung", this can be caused by lost
86 completion events due to flaky hardware or drivers.  See the
87 \fBzfs_deadman_failmode\fR module option description for additional
88 information regarding "hung" I/O detection and configuration.
89 .RE
91 .sp
92 .ne 2
93 .na
94 \fBdelay\fR
95 .ad
96 .RS 12n
97 Issued when a completed I/O exceeds the maximum allowed time specified
98 by the \fBzio_delay_max\fR module option.  This can be an indicator of
99 problems with the underlying storage device.
103 .ne 2
105 \fBconfig.sync\fR
107 .RS 12n
108 Issued every time a vdev change have been done to the pool.
112 .ne 2
114 \fBzpool\fR
116 .RS 12n
117 Issued when a pool cannot be imported.
121 .ne 2
123 \fBzpool.destroy\fR
125 .RS 12n
126 Issued when a pool is destroyed.
130 .ne 2
132 \fBzpool.export\fR
134 .RS 12n
135 Issued when a pool is exported.
139 .ne 2
141 \fBzpool.import\fR
143 .RS 12n
144 Issued when a pool is imported.
148 .ne 2
150 \fBzpool.reguid\fR
152 .RS 12n
153 Issued when a REGUID (new unique identifier for the pool have been regenerated) have been detected.
157 .ne 2
159 \fBvdev.unknown\fR
161 .RS 12n
162 Issued when the vdev is unknown. Such as trying to clear device
163 errors on a vdev that have failed/been kicked from the system/pool
164 and is no longer available.
168 .ne 2
170 \fBvdev.open_failed\fR
172 .RS 12n
173 Issued when a vdev could not be opened (because it didn't exist for example).
177 .ne 2
179 \fBvdev.corrupt_data\fR
181 .RS 12n
182 Issued when corrupt data have been detected on a vdev.
186 .ne 2
188 \fBvdev.no_replicas\fR
190 .RS 12n
191 Issued when there are no more replicas to sustain the pool.
192 This would lead to the pool being \fIDEGRADED\fR.
196 .ne 2
198 \fBvdev.bad_guid_sum\fR
200 .RS 12n
201 Issued when a missing device in the pool have been detected.
205 .ne 2
207 \fBvdev.too_small\fR
209 .RS 12n
210 Issued when the system (kernel) have removed a device, and ZFS
211 notices that the device isn't there any more. This is usually
212 followed by a \fBprobe_failure\fR event.
216 .ne 2
218 \fBvdev.bad_label\fR
220 .RS 12n
221 Issued when the label is OK but invalid.
225 .ne 2
227 \fBvdev.bad_ashift\fR
229 .RS 12n
230 Issued when the ashift alignment requirement has increased.
234 .ne 2
236 \fBvdev.remove\fR
238 .RS 12n
239 Issued when a vdev is detached from a mirror (or a spare detached from a
240 vdev where it have been used to replace a failed drive - only works if
241 the original drive have been readded).
245 .ne 2
247 \fBvdev.clear\fR
249 .RS 12n
250 Issued when clearing device errors in a pool. Such as running \fBzpool clear\fR
251 on a device in the pool.
255 .ne 2
257 \fBvdev.check\fR
259 .RS 12n
260 Issued when a check to see if a given vdev could be opened is started.
264 .ne 2
266 \fBvdev.spare\fR
268 .RS 12n
269 Issued when a spare have kicked in to replace a failed device.
273 .ne 2
275 \fBvdev.autoexpand\fR
277 .RS 12n
278 Issued when a vdev can be automatically expanded.
282 .ne 2
284 \fBio_failure\fR
286 .RS 12n
287 Issued when there is an I/O failure in a vdev in the pool.
291 .ne 2
293 \fBprobe_failure\fR
295 .RS 12n
296 Issued when a probe fails on a vdev. This would occur if a vdev
297 have been kicked from the system outside of ZFS (such as the kernel
298 have removed the device).
302 .ne 2
304 \fBlog_replay\fR
306 .RS 12n
307 Issued when the intent log cannot be replayed.  The can occur in the case
308 of a missing or damaged log device.
312 .ne 2
314 \fBresilver.start\fR
316 .RS 12n
317 Issued when a resilver is started.
321 .ne 2
323 \fBresilver.finish\fR
325 .RS 12n
326 Issued when the running resilver have finished.
330 .ne 2
332 \fBscrub.start\fR
334 .RS 12n
335 Issued when a scrub is started on a pool.
339 .ne 2
341 \fBscrub.finish\fR
343 .RS 12n
344 Issued when a pool has finished scrubbing.
348 .ne 2
350 \fBscrub.abort\fR
352 .RS 12n
353 Issued when a scrub is aborted on a pool.
357 .ne 2
359 \fBscrub.resume\fR
361 .RS 12n
362 Issued when a scrub is resumed on a pool.
366 .ne 2
368 \fBscrub.paused\fR
370 .RS 12n
371 Issued when a scrub is paused on a pool.
375 .ne 2
377 \fBbootfs.vdev.attach\fR
379 .RS 12n
382 .SS "PAYLOADS"
385 This is the payload (data, information) that accompanies an
386 event.
389 .BR zed (8),
390 these are set to uppercase and prefixed with \fBZEVENT_\fR.
393 .ne 2
395 \fBpool\fR
397 .RS 12n
398 Pool name.
402 .ne 2
404 \fBpool_failmode\fR
406 .RS 12n
407 Failmode - \fBwait\fR, \fBcontinue\fR or \fBpanic\fR.
409 .BR pool (8)
410 (\fIfailmode\fR property) for more information.
414 .ne 2
416 \fBpool_guid\fR
418 .RS 12n
419 The GUID of the pool.
423 .ne 2
425 \fBpool_context\fR
427 .RS 12n
428 The load state for the pool (0=none, 1=open, 2=import, 3=tryimport, 4=recover
429 5=error).
433 .ne 2
435 \fBvdev_guid\fR
437 .RS 12n
438 The GUID of the vdev in question (the vdev failing or operated upon with
439 \fBzpool clear\fR etc).
443 .ne 2
445 \fBvdev_type\fR
447 .RS 12n
448 Type of vdev - \fBdisk\fR, \fBfile\fR, \fBmirror\fR etc. See
449 .BR zpool (8)
450 under \fBVirtual Devices\fR for more information on possible values.
454 .ne 2
456 \fBvdev_path\fR
458 .RS 12n
459 Full path of the vdev, including any \fI-partX\fR.
463 .ne 2
465 \fBvdev_devid\fR
467 .RS 12n
468 ID of vdev (if any).
472 .ne 2
474 \fBvdev_fru\fR
476 .RS 12n
477 Physical FRU location.
481 .ne 2
483 \fBvdev_state\fR
485 .RS 12n
486 State of vdev (0=uninitialized, 1=closed, 2=offline, 3=removed, 4=failed to open, 5=faulted, 6=degraded, 7=healthy).
490 .ne 2
492 \fBvdev_ashift\fR
494 .RS 12n
495 The ashift value of the vdev.
499 .ne 2
501 \fBvdev_complete_ts\fR
503 .RS 12n
504 The time the last I/O completed for the specified vdev.
508 .ne 2
510 \fBvdev_delta_ts\fR
512 .RS 12n
513 The time since the last I/O completed for the specified vdev.
517 .ne 2
519 \fBvdev_spare_paths\fR
521 .RS 12n
522 List of spares, including full path and any \fI-partX\fR.
526 .ne 2
528 \fBvdev_spare_guids\fR
530 .RS 12n
531 GUID(s) of spares.
535 .ne 2
537 \fBvdev_read_errors\fR
539 .RS 12n
540 How many read errors that have been detected on the vdev.
544 .ne 2
546 \fBvdev_write_errors\fR
548 .RS 12n
549 How many write errors that have been detected on the vdev.
553 .ne 2
555 \fBvdev_cksum_errors\fR
557 .RS 12n
558 How many checkum errors that have been detected on the vdev.
562 .ne 2
564 \fBparent_guid\fR
566 .RS 12n
567 GUID of the vdev parent.
571 .ne 2
573 \fBparent_type\fR
575 .RS 12n
576 Type of parent. See \fBvdev_type\fR.
580 .ne 2
582 \fBparent_path\fR
584 .RS 12n
585 Path of the vdev parent (if any).
589 .ne 2
591 \fBparent_devid\fR
593 .RS 12n
594 ID of the vdev parent (if any).
598 .ne 2
600 \fBzio_objset\fR
602 .RS 12n
603 The object set number for a given I/O.
607 .ne 2
609 \fBzio_object\fR
611 .RS 12n
612 The object number for a given I/O.
616 .ne 2
618 \fBzio_level\fR
620 .RS 12n
621 The block level for a given I/O.
625 .ne 2
627 \fBzio_blkid\fR
629 .RS 12n
630 The block ID for a given I/O.
634 .ne 2
636 \fBzio_err\fR
638 .RS 12n
639 The errno for a failure when handling a given I/O.
643 .ne 2
645 \fBzio_offset\fR
647 .RS 12n
648 The offset in bytes of where to write the I/O for the specified vdev.
652 .ne 2
654 \fBzio_size\fR
656 .RS 12n
657 The size in bytes of the I/O.
661 .ne 2
663 \fBzio_flags\fR
665 .RS 12n
666 The current flags describing how the I/O should be handled.  See the
667 \fBI/O FLAGS\fR section for the full list of I/O flags.
671 .ne 2
673 \fBzio_stage\fR
675 .RS 12n
676 The current stage of the I/O in the pipeline.  See the \fBI/O STAGES\fR
677 section for a full list of all the I/O stages.
681 .ne 2
683 \fBzio_pipeline\fR
685 .RS 12n
686 The valid pipeline stages for the I/O.  See the \fBI/O STAGES\fR section for a
687 full list of all the I/O stages.
691 .ne 2
693 \fBzio_delay\fR
695 .RS 12n
696 The time in ticks (HZ) required for the block layer to service the I/O.  Unlike
697 \fBzio_delta\fR this does not include any vdev queuing time and is therefore
698 solely a measure of the block layer performance.  On most modern Linux systems
699 HZ is defined as 1000 making a tick equivalent to 1 millisecond.
703 .ne 2
705 \fBzio_timestamp\fR
707 .RS 12n
708 The time when a given I/O was submitted.
712 .ne 2
714 \fBzio_delta\fR
716 .RS 12n
717 The time required to service a given I/O.
721 .ne 2
723 \fBprev_state\fR
725 .RS 12n
726 The previous state of the vdev.
730 .ne 2
732 \fBcksum_expected\fR
734 .RS 12n
735 The expected checksum value.
739 .ne 2
741 \fBcksum_actual\fR
743 .RS 12n
744 The actual/current checksum value.
748 .ne 2
750 \fBcksum_algorithm\fR
752 .RS 12n
753 Checksum algorithm used. See \fBzfs\fR(8) for more information on checksum algorithms available.
757 .ne 2
759 \fBcksum_byteswap\fR
761 .RS 12n
762 Checksum value is byte swapped.
766 .ne 2
768 \fBbad_ranges\fR
770 .RS 12n
771 Checksum bad offset ranges.
775 .ne 2
777 \fBbad_ranges_min_gap\fR
779 .RS 12n
780 Checksum allowed minimum gap.
784 .ne 2
786 \fBbad_range_sets\fR
788 .RS 12n
789 Checksum for each range the number of bits set.
793 .ne 2
795 \fBbad_range_clears\fR
797 .RS 12n
798 Checksum for each range the number of bits cleared.
802 .ne 2
804 \fBbad_set_bits\fR
806 .RS 12n
807 Checksum array of bits set.
811 .ne 2
813 \fBbad_cleared_bits\fR
815 .RS 12n
816 Checksum array of bits cleared.
820 .ne 2
822 \fBbad_set_histogram\fR
824 .RS 12n
825 Checksum histogram of set bits by bit number in a 64-bit word.
829 .ne 2
831 \fBbad_cleared_histogram\fR
833 .RS 12n
834 Checksum histogram of cleared bits by bit number in a 64-bit word.
837 .SS "I/O STAGES"
840 The ZFS I/O pipeline is comprised of various stages which are defined
841 below.  The individual stages are used to construct these basic I/O
842 operations: Read, Write, Free, Claim, and Ioctl.  These stages may be
843 set on an event to describe the life cycle of a given I/O.
846 tab(:);
847 l l l .
848 Stage:Bit Mask:Operations
849 _:_:_
850 ZIO_STAGE_OPEN:0x00000001:RWFCI
852 ZIO_STAGE_READ_BP_INIT:0x00000002:R----
853 ZIO_STAGE_FREE_BP_INIT:0x00000004:--F--
854 ZIO_STAGE_ISSUE_ASYNC:0x00000008:RWF--
855 ZIO_STAGE_WRITE_BP_INIT:0x00000010:-W---
857 ZIO_STAGE_CHECKSUM_GENERATE:0x00000020:-W---
859 ZIO_STAGE_NOP_WRITE:0x00000040:-W---
861 ZIO_STAGE_DDT_READ_START:0x00000080:R----
862 ZIO_STAGE_DDT_READ_DONE:0x00000100:R----
863 ZIO_STAGE_DDT_WRITE:0x00000200:-W---
864 ZIO_STAGE_DDT_FREE:0x00000400:--F--
866 ZIO_STAGE_GANG_ASSEMBLE:0x00000800:RWFC-
867 ZIO_STAGE_GANG_ISSUE:0x00001000:RWFC-
869 ZIO_STAGE_DVA_ALLOCATE:0x00002000:-W---
870 ZIO_STAGE_DVA_FREE:0x00004000:--F--
871 ZIO_STAGE_DVA_CLAIM:0x00008000:---C-
873 ZIO_STAGE_READY:0x00010000:RWFCI
875 ZIO_STAGE_VDEV_IO_START:0x00020000:RW--I
876 ZIO_STAGE_VDEV_IO_DONE:0x00040000:RW--I
877 ZIO_STAGE_VDEV_IO_ASSESS:0x00080000:RW--I
879 ZIO_STAGE_CHECKSUM_VERIFY0:0x00100000:R----
881 ZIO_STAGE_DONE:0x00200000:RWFCI
884 .SS "I/O FLAGS"
887 Every I/O in the pipeline contains a set of flags which describe its
888 function and are used to govern its behavior.  These flags will be set
889 in an event as an \fBzio_flags\fR payload entry.
892 tab(:);
893 l l .
894 Flag:Bit Mask
896 ZIO_FLAG_DONT_AGGREGATE:0x00000001
897 ZIO_FLAG_IO_REPAIR:0x00000002
898 ZIO_FLAG_SELF_HEAL:0x00000004
899 ZIO_FLAG_RESILVER:0x00000008
900 ZIO_FLAG_SCRUB:0x00000010
901 ZIO_FLAG_SCAN_THREAD:0x00000020
902 ZIO_FLAG_PHYSICAL:0x00000040
904 ZIO_FLAG_CANFAIL:0x00000080
905 ZIO_FLAG_SPECULATIVE:0x00000100
906 ZIO_FLAG_CONFIG_WRITER:0x00000200
907 ZIO_FLAG_DONT_RETRY:0x00000400
908 ZIO_FLAG_DONT_CACHE:0x00000800
909 ZIO_FLAG_NODATA:0x00001000
910 ZIO_FLAG_INDUCE_DAMAGE:0x00002000
912 ZIO_FLAG_IO_RETRY:0x00004000
913 ZIO_FLAG_PROBE:0x00008000
914 ZIO_FLAG_TRYHARD:0x00010000
915 ZIO_FLAG_OPTIONAL:0x00020000
917 ZIO_FLAG_DONT_QUEUE:0x00040000
918 ZIO_FLAG_DONT_PROPAGATE:0x00080000
919 ZIO_FLAG_IO_BYPASS:0x00100000
920 ZIO_FLAG_IO_REWRITE:0x00200000
921 ZIO_FLAG_RAW:0x00400000
922 ZIO_FLAG_GANG_CHILD:0x00800000
923 ZIO_FLAG_DDT_CHILD:0x01000000
924 ZIO_FLAG_GODFATHER:0x02000000
925 ZIO_FLAG_NOPWRITE:0x04000000
926 ZIO_FLAG_REEXECUTED:0x08000000
927 ZIO_FLAG_DELEGATED:0x10000000
928 ZIO_FLAG_FASTWRITE:0x20000000