cmd: rename arcstat to zarcstat

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Colm Buckley <colm@tuatha.org>
Signed-off-by: Shengqi Chen <harry-chen@outlook.com>
Closes #16357
Closes #17712

cmd/Makefile.am

@@ -98,11 +98,11 @@ endif
 
 
 if USING_PYTHON
-bin_SCRIPTS      += zarcsummary     arcstat        dbufstat        zilstat
+bin_SCRIPTS      += zarcsummary     zarcstat        dbufstat        zilstat
-CLEANFILES       += zarcsummary     arcstat        dbufstat        zilstat
+CLEANFILES       += zarcsummary     zarcstat        dbufstat        zilstat
-dist_noinst_DATA += %D%/zarcsummary %D%/arcstat.in %D%/dbufstat.in %D%/zilstat.in
+dist_noinst_DATA += %D%/zarcsummary %D%/zarcstat.in %D%/dbufstat.in %D%/zilstat.in
 
-$(call SUBST,arcstat,%D%/)
+$(call SUBST,zarcstat,%D%/)
 $(call SUBST,dbufstat,%D%/)
 $(call SUBST,zilstat,%D%/)
 zarcsummary: %D%/zarcsummary

cmd/zarcstat.in

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: CDDL-1.0
 #
 # Print out ZFS ARC Statistics exported via kstat(1)
-# For a definition of fields, or usage, use arcstat -v
+# For a definition of fields, or usage, use zarcstat -v
 #
 # This script was originally a fork of the original arcstat.pl (0.1)
 # by Neelakanth Nadgir, originally published on his Sun blog on
@@ -262,7 +262,7 @@ hdr_intr = 20          # Print header every 20 lines of output
 opfile = None
 sep = "  "              # Default separator is 2 spaces
 l2exist = False
-cmd = ("Usage: arcstat [-havxp] [-f fields] [-o file] [-s string] [interval "
+cmd = ("Usage: zarcstat [-havxp] [-f fields] [-o file] [-s string] [interval "
        "[count]]\n")
 cur = {}
 d = {}
@@ -349,10 +349,10 @@ def usage():
                      "character or string\n")
     sys.stderr.write("\t -p : Disable auto-scaling of numerical fields\n")
     sys.stderr.write("\nExamples:\n")
-    sys.stderr.write("\tarcstat -o /tmp/a.log 2 10\n")
+    sys.stderr.write("\tzarcstat -o /tmp/a.log 2 10\n")
-    sys.stderr.write("\tarcstat -s \",\" -o /tmp/a.log 2 10\n")
+    sys.stderr.write("\tzarcstat -s \",\" -o /tmp/a.log 2 10\n")
-    sys.stderr.write("\tarcstat -v\n")
+    sys.stderr.write("\tzarcstat -v\n")
-    sys.stderr.write("\tarcstat -f time,hit%,dh%,ph%,mh% 1\n")
+    sys.stderr.write("\tzarcstat -f time,hit%,dh%,ph%,mh% 1\n")
     sys.stderr.write("\n")
 
     sys.exit(1)

contrib/debian/openzfs-zfsutils.install

@@ -37,12 +37,12 @@ usr/lib/zfs-linux/zpool.d/
 usr/lib/zfs-linux/zpool_influxdb
 usr/lib/zfs-linux/zfs_prepare_disk
 usr/sbin/zarcsummary
-usr/sbin/arcstat
+usr/sbin/zarcstat
 usr/sbin/dbufstat
 usr/sbin/zilstat
 usr/share/zfs/compatibility.d/
 usr/share/bash-completion/completions
-usr/share/man/man1/arcstat.1
+usr/share/man/man1/zarcstat.1
 usr/share/man/man1/zhack.1
 usr/share/man/man1/zvol_wait.1
 usr/share/man/man5/

contrib/debian/rules.in

@@ -82,7 +82,7 @@ override_dh_auto_install:
 	# https://www.debian.org/doc/debian-policy/ch-files.html#s-scripts
 	mkdir -p '$(CURDIR)/debian/tmp/usr/sbin/'
 	mv '$(CURDIR)/debian/tmp/usr/bin/zarcsummary' '$(CURDIR)/debian/tmp/usr/sbin/zarcsummary'
-	mv '$(CURDIR)/debian/tmp/usr/bin/arcstat' '$(CURDIR)/debian/tmp/usr/sbin/arcstat'
+	mv '$(CURDIR)/debian/tmp/usr/bin/zarcstat' '$(CURDIR)/debian/tmp/usr/sbin/zarcstat'
 	mv '$(CURDIR)/debian/tmp/usr/bin/dbufstat' '$(CURDIR)/debian/tmp/usr/sbin/dbufstat'
 	mv '$(CURDIR)/debian/tmp/usr/bin/zilstat' '$(CURDIR)/debian/tmp/usr/sbin/zilstat'
 

man/Makefile.am

@@ -2,7 +2,7 @@ dist_noinst_man_MANS = \
 	%D%/man1/cstyle.1
 
 dist_man_MANS = \
-	%D%/man1/arcstat.1 \
+	%D%/man1/zarcstat.1 \
 	%D%/man1/raidz_test.1 \
 	%D%/man1/test-runner.1 \
 	%D%/man1/zhack.1 \

man/man1/zarcstat.1

@@ -14,11 +14,11 @@
 .\" Copyright (c) 2020 by AJ Jordan. All rights reserved.
 .\"
 .Dd September 19, 2024
-.Dt ARCSTAT 1
+.Dt ZARCSTAT 1
 .Os
 .
 .Sh NAME
-.Nm arcstat
+.Nm zarcstat
 .Nd report ZFS ARC and L2ARC statistics
 .Sh SYNOPSIS
 .Nm

rpm/generic/zfs.spec.in

@@ -433,7 +433,7 @@ make install DESTDIR=%{?buildroot}
 find %{?buildroot}%{_libdir} -name '*.la' -exec rm -f {} \;
 %if 0%{!?__brp_mangle_shebangs:1}
 find %{?buildroot}%{_bindir} \
-    \( -name zarcsummary -or -name arcstat -or -name dbufstat \
+    \( -name zarcsummary -or -name zarcstat -or -name dbufstat \
     -or -name zilstat \) \
     -exec %{__sed} -i 's|^#!.*|#!%{__python}|' {} \;
 find %{?buildroot}%{_datadir} \
@@ -509,7 +509,7 @@ systemctl --system daemon-reload >/dev/null || true
 %{_bindir}/zvol_wait
 # Optional Python 3 scripts
 %{_bindir}/zarcsummary
-%{_bindir}/arcstat
+%{_bindir}/zarcstat
 %{_bindir}/dbufstat
 %{_bindir}/zilstat
 # Man pages

scripts/spdxcheck.pl

@@ -83,7 +83,7 @@ my $tagged_patterns = q(
 	man/man?/*.?.in
 
 	# Unsuffixed programs (or generated of same)
-	cmd/arcstat.in
+	cmd/zarcstat.in
 	cmd/zarcsummary
 	cmd/dbufstat.in
 	cmd/zilstat.in

tests/runfiles/common.run

@@ -624,7 +624,7 @@ tests = ['zdb_001_neg', 'zfs_001_neg', 'zfs_allow_001_neg',
     'zpool_history_001_neg', 'zpool_import_001_neg', 'zpool_import_002_neg',
     'zpool_offline_001_neg', 'zpool_online_001_neg', 'zpool_remove_001_neg',
     'zpool_replace_001_neg', 'zpool_scrub_001_neg', 'zpool_set_001_neg',
-    'zpool_status_001_neg', 'zpool_upgrade_001_neg', 'arcstat_001_pos',
+    'zpool_status_001_neg', 'zpool_upgrade_001_neg', 'zarcstat_001_pos',
     'zarcsummary_001_pos', 'zarcsummary_002_neg', 'zpool_wait_privilege',
     'zilstat_001_pos']
 user =

tests/runfiles/sanity.run

@@ -400,7 +400,7 @@ tests = ['zdb_001_neg', 'zfs_001_neg', 'zfs_allow_001_neg',
     'zpool_detach_001_neg', 'zpool_export_001_neg', 'zpool_get_001_neg',
     'zpool_history_001_neg', 'zpool_offline_001_neg', 'zpool_online_001_neg',
     'zpool_remove_001_neg', 'zpool_scrub_001_neg', 'zpool_set_001_neg',
-    'zpool_status_001_neg', 'zpool_upgrade_001_neg', 'arcstat_001_pos',
+    'zpool_status_001_neg', 'zpool_upgrade_001_neg', 'zarcstat_001_pos',
     'zarcsummary_001_pos', 'zarcsummary_002_neg', 'zpool_wait_privilege',
     'zilstat_001_pos']
 user =

tests/zfs-tests/include/commands.cfg

@@ -172,7 +172,7 @@ export ZFS_FILES='zdb
     ztest
     raidz_test
     zarcsummary
-    arcstat
+    zarcstat
     zilstat
     dbufstat
     mount.zfs

tests/zfs-tests/tests/Makefile.am

@@ -1351,7 +1351,7 @@ nobase_dist_datadir_zfs_tests_tests_SCRIPTS += \
 	functional/cli_root/zpool/zpool_002_pos.ksh \
 	functional/cli_root/zpool/zpool_003_pos.ksh \
 	functional/cli_root/zpool/zpool_colors.ksh \
-	functional/cli_user/misc/arcstat_001_pos.ksh \
+	functional/cli_user/misc/zarcstat_001_pos.ksh \
 	functional/cli_user/misc/zarcsummary_001_pos.ksh \
 	functional/cli_user/misc/zarcsummary_002_neg.ksh \
 	functional/cli_user/misc/zilstat_001_pos.ksh \

tests/zfs-tests/tests/functional/cli_user/misc/zarcstat_001_pos.ksh

@@ -37,7 +37,7 @@ log_assert "arcstat generates output and doesn't return an error code"
 
 typeset -i i=0
 while [[ $i -lt ${#args[*]} ]]; do
-        log_must eval "arcstat ${args[i]} > /dev/null"
+        log_must eval "zarcstat ${args[i]} > /dev/null"
         ((i = i + 1))
 done
 log_pass "arcstat generates output and doesn't return an error code"