1 files changed, 427 insertions, 0 deletions
diff --git a/sys/contrib/openzfs/man/man1/zarcstat.1 b/sys/contrib/openzfs/man/man1/zarcstat.1
new file mode 100644
index 000000000000..3633c5d417fe
--- /dev/null
+++ b/sys/contrib/openzfs/man/man1/zarcstat.1
@@ -0,0 +1,427 @@
+.\" SPDX-License-Identifier: CDDL-1.0
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source.  A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\" Copyright 2014 Adam Stevko.  All rights reserved.
+.\" Copyright (c) 2015 by Delphix. All rights reserved.
+.\" Copyright (c) 2020 by AJ Jordan. All rights reserved.
+.\"
+.Dd September 19, 2024
+.Dt ZARCSTAT 1
+.Os
+.
+.Sh NAME
+.Nm zarcstat
+.Nd report ZFS ARC and L2ARC statistics
+.Sh SYNOPSIS
+.Nm
+.Op Fl havxp
+.Op Fl f Ar field Ns Op , Ns Ar field Ns …
+.Op Fl o Ar file
+.Op Fl s Ar string
+.Op Ar interval
+.Op Ar count
+.
+.Sh DESCRIPTION
+.Nm
+prints various ZFS ARC and L2ARC statistics in vmstat-like fashion:
+.Bl -tag -compact -offset Ds -width "l2asize"
+.It Sy c
+ARC target size
+.It Sy dh%
+Demand hit percentage
+.It Sy di%
+Demand I/O hit percentage
+.It Sy dm%
+Demand miss percentage
+.It Sy ddh%
+Demand data hit percentage
+.It Sy ddi%
+Demand data I/O hit percentage
+.It Sy ddm%
+Demand data miss percentage
+.It Sy dmh%
+Demand metadata hit percentage
+.It Sy dmi%
+Demand metadata I/O hit percentage
+.It Sy dmm%
+Demand metadata miss percentage
+.It Sy mfu
+MFU list hits per second
+.It Sy mh%
+Metadata hit percentage
+.It Sy mi%
+Metadata I/O hit percentage
+.It Sy mm%
+Metadata miss percentage
+.It Sy mru
+MRU list hits per second
+.It Sy ph%
+Prefetch hits percentage
+.It Sy pi%
+Prefetch I/O hits percentage
+.It Sy pm%
+Prefetch miss percentage
+.It Sy pdh%
+Prefetch data hits percentage
+.It Sy pdi%
+Prefetch data I/O hits percentage
+.It Sy pdm%
+Prefetch data miss percentage
+.It Sy pmh%
+Prefetch metadata hits percentage
+.It Sy pmi%
+Prefetch metadata I/O hits percentage
+.It Sy pmm%
+Prefetch metadata miss percentage
+.It Sy dhit
+Demand hits per second
+.It Sy dioh
+Demand I/O hits per second
+.It Sy dmis
+Demand misses per second
+.It Sy ddhit
+Demand data hits per second
+.It Sy ddioh
+Demand data I/O hits per second
+.It Sy ddmis
+Demand data misses per second
+.It Sy dmhit
+Demand metadata hits per second
+.It Sy dmioh
+Demand metadata I/O hits per second
+.It Sy dmmis
+Demand metadata misses per second
+.It Sy hit%
+ARC hit percentage
+.It Sy hits
+ARC hits per second
+.It Sy ioh%
+ARC I/O hits percentage
+.It Sy iohs
+ARC I/O hits per second
+.It Sy mfug
+MFU ghost list hits per second
+.It Sy mhit
+Metadata hits per second
+.It Sy mioh
+Metadata I/O hits per second
+.It Sy miss
+ARC misses per second
+.It Sy mmis
+Metadata misses per second
+.It Sy mrug
+MRU ghost list hits per second
+.It Sy phit
+Prefetch hits per second
+.It Sy pioh
+Prefetch I/O hits per second
+.It Sy pmis
+Prefetch misses per second
+.It Sy pdhit
+Prefetch data hits per second
+.It Sy pdioh
+Prefetch data I/O hits per second
+.It Sy pdmis
+Prefetch data misses per second
+.It Sy pmhit
+Prefetch metadata hits per second
+.It Sy pmioh
+Prefetch metadata I/O hits per second
+.It Sy pmmis
+Prefetch metadata misses per second
+.It Sy read
+Total ARC accesses per second
+.It Sy time
+Current time
+.It Sy size
+ARC size
+.It Sy arcsz
+Alias for
+.Sy size
+.It Sy unc
+Uncached list hits per second
+.It Sy dread
+Demand accesses per second
+.It Sy ddread
+Demand data accesses per second
+.It Sy dmread
+Demand metadata accesses per second
+.It Sy eskip
+evict_skip per second
+.It Sy miss%
+ARC miss percentage
+.It Sy mread
+Metadata accesses per second
+.It Sy pread
+Prefetch accesses per second
+.It Sy pdread
+Prefetch data accesses per second
+.It Sy pmread
+Prefetch metadata accesses per second
+.It Sy l2hit%
+L2ARC access hit percentage
+.It Sy l2hits
+L2ARC hits per second
+.It Sy l2miss
+L2ARC misses per second
+.It Sy l2read
+Total L2ARC accesses per second
+.It Sy l2pref
+L2ARC prefetch allocated size per second
+.It Sy l2pref%
+L2ARC prefetch allocated size percentage
+.It Sy l2mfu
+L2ARC MFU allocated size per second
+.It Sy l2mfu%
+L2ARC MFU allocated size percentage
+.It Sy l2mru
+L2ARC MRU allocated size per second
+.It Sy l2mru%
+L2ARC MRU allocated size percentage
+.It Sy l2data
+L2ARC data (buf content) allocated size per second
+.It Sy l2data%
+L2ARC data (buf content) allocated size percentage
+.It Sy l2meta
+L2ARC metadata (buf content) allocated size per second
+.It Sy l2meta%
+L2ARC metadata (buf content) allocated size percentage
+.It Sy l2size
+Size of the L2ARC
+.It Sy mtxmis
+mutex_miss per second
+.It Sy l2bytes
+Bytes read per second from the L2ARC
+.It Sy l2wbytes
+Bytes written per second to the L2ARC
+.It Sy l2miss%
+L2ARC access miss percentage
+.It Sy l2asize
+Actual (compressed) size of the L2ARC
+.It Sy cmpsz
+Compressed size
+.It Sy cmpsz%
+Compressed size percentage
+.It Sy ovhsz
+Overhead size
+.It Sy ovhsz%
+Overhead size percentage
+.It Sy bonsz
+Bonus size
+.It Sy bonsz%
+Bonus size percentage
+.It Sy dnosz
+Dnode size
+.It Sy dnosz%
+Dnode size percentage
+.It Sy dbusz
+Dbuf size
+.It Sy dbusz%
+Dbuf size percentage
+.It Sy hdrsz
+Header size
+.It Sy hdrsz%
+Header size percentage
+.It Sy l2hsz
+L2 header size
+.It Sy l2hsz%
+L2 header size percentage
+.It Sy abdsz
+ABD chunk waste size
+.It Sy abdsz%
+ABD chunk waste size percentage
+.It Sy datatg
+ARC data target
+.It Sy datatg%
+ARC data target percentage
+.It Sy datasz
+ARC data size
+.It Sy datasz%
+ARC data size percentage
+.It Sy metatg
+ARC metadata target
+.It Sy metatg%
+ARC metadata target percentage
+.It Sy metasz
+ARC metadata size
+.It Sy metasz%
+ARC metadata size percentage
+.It Sy anosz
+Anonymous size
+.It Sy anosz%
+Anonymous size percentage
+.It Sy anoda
+Anonymous data size
+.It Sy anoda%
+Anonymous data size percentage
+.It Sy anome
+Anonymous metadata size
+.It Sy anome%
+Anonymous metadata size percentage
+.It Sy anoed
+Anonymous evictable data size
+.It Sy anoed%
+Anonymous evictable data size percentage
+.It Sy anoem
+Anonymous evictable metadata size
+.It Sy anoem%
+Anonymous evictable metadata size percentage
+.It Sy mfutg
+MFU target
+.It Sy mfutg%
+MFU target percentage
+.It Sy mfudt
+MFU data target
+.It Sy mfudt%
+MFU data target percentage
+.It Sy mfumt
+MFU metadata target
+.It Sy mfumt%
+MFU metadata target percentage
+.It Sy mfusz
+MFU size
+.It Sy mfusz%
+MFU size percentage
+.It Sy mfuda
+MFU data size
+.It Sy mfuda%
+MFU data size percentage
+.It Sy mfume
+MFU metadata size
+.It Sy mfume%
+MFU metadata size percentage
+.It Sy mfued
+MFU evictable data size
+.It Sy mfued%
+MFU evictable data size percentage
+.It Sy mfuem
+MFU evictable metadata size
+.It Sy mfuem%
+MFU evictable metadata size percentage
+.It Sy mfugsz
+MFU ghost size
+.It Sy mfugd
+MFU ghost data size
+.It Sy mfugm
+MFU ghost metadata size
+.It Sy mrutg
+MRU target
+.It Sy mrutg%
+MRU target percentage
+.It Sy mrudt
+MRU data target
+.It Sy mrudt%
+MRU data target percentage
+.It Sy mrumt
+MRU metadata target
+.It Sy mrumt%
+MRU metadata target percentage
+.It Sy mrusz
+MRU size
+.It Sy mrusz%
+MRU size percentage
+.It Sy mruda
+MRU data size
+.It Sy mruda%
+MRU data size percentage
+.It Sy mrume
+MRU metadata size
+.It Sy mrume%
+MRU metadata size percentage
+.It Sy mrued
+MRU evictable data size
+.It Sy mrued%
+MRU evictable data size percentage
+.It Sy mruem
+MRU evictable metadata size
+.It Sy mruem%
+MRU evictable metadata size percentage
+.It Sy mrugsz
+MRU ghost size
+.It Sy mrugd
+MRU ghost data size
+.It Sy mrugm
+MRU ghost metadata size
+.It Sy uncsz
+Uncached size
+.It Sy uncsz%
+Uncached size percentage
+.It Sy uncda
+Uncached data size
+.It Sy uncda%
+Uncached data size percentage
+.It Sy uncme
+Uncached metadata size
+.It Sy uncme%
+Uncached metadata size percentage
+.It Sy unced
+Uncached evictable data size
+.It Sy unced%
+Uncached evictable data size percentage
+.It Sy uncem
+Uncached evictable metadata size
+.It Sy uncem%
+Uncached evictable metadata size percentage
+.It Sy grow
+ARC grow disabled
+.It Sy need
+ARC reclaim needed
+.It Sy free
+The ARC's idea of how much free memory there is, which includes evictable memory
+in the page cache.
+Since the ARC tries to keep
+.Sy avail
+above zero,
+.Sy avail
+is usually more instructive to observe than
+.Sy free .
+.It Sy avail
+The ARC's idea of how much free memory is available to it, which is a bit less
+than
+.Sy free .
+May temporarily be negative, in which case the ARC will reduce the target size
+.Sy c .
+.El
+.
+.Sh OPTIONS
+.Bl -tag -width "-v"
+.It Fl a
+Print all possible stats.
+.It Fl f
+Display only specific fields.
+See
+.Sx DESCRIPTION
+for supported statistics.
+.It Fl h
+Display help message.
+.It Fl o
+Report statistics to a file instead of the standard output.
+.It Fl p
+Disable auto-scaling of numerical fields (for raw, machine-parsable values).
+.It Fl s
+Display data with a specified separator (default: 2 spaces).
+.It Fl x
+Print extended stats
+.Pq same as Fl f Sy time , Ns Sy mfu , Ns Sy mru , Ns Sy mfug , Ns Sy mrug , Ns Sy eskip , Ns Sy mtxmis , Ns Sy dread , Ns Sy pread , Ns Sy read .
+.It Fl v
+Show field headers and definitions
+.El
+.
+.Sh OPERANDS
+The following operands are supported:
+.Bl -tag -compact -offset Ds -width "interval"
+.It Ar interval
+Specify the sampling interval in seconds.
+.It Ar count
+Display only
+.Ar count
+reports.
+.El