NFSTEST_XATTR(1)

📦 version 3.2, in debian trixie, fedora 43, fedora 44, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

🌸 NFSTEST_XATTR 💖

okay so bestie, this is nfstest_xattr, it lives in section 1 of the manual, and it's version nfstest_xattr 1.1. it's giving very much "let's verify extended attributes and have a whole journey about it" energy, and honestly? we love that for us.

✨ NAME ✨

nfstest_xattr — Extended Attributes tests 🎀

🦋 SYNOPSIS 🦋

nfstest_xattr --server <server> [options]

💅 DESCRIPTION 💅

okay so first thing first, the whole point: verify correct functionality of extended attributes. that's the vibe check, that's the assignment. 🔥

so like, extended attributes are these name:value pairs that are permanently associated with files and directories, kinda like how environment strings are associated with a process, iykyk. an attribute can be defined or undefined. and if it is defined, its value can be empty or non-empty, both are valid, no drama. extended attributes are basically extensions to the normal attributes that get associated with all inodes in the system, and they're often used to give a filesystem some extra functionality. iconic behavior tbh.

the tests are divided into five groups: getxattr, setxattr, removexattr, listxattr and cinfo. let me break it down:

  • the getxattr tests verify the retrieval of extended attribute values 👑
  • the setxattr tests verify the creation or modification of extended attributes ✨
  • the removexattr tests verify the removal of extended attributes 🗑️
  • the listxattr tests verify the listing of extended attributes 📋
  • and finally, the cinfo tests verify the change info returned by the server is correct when the file is either modified or not from a different client 🧚

and bestie, there's more. when a different client is holding a read delegation, we verify the delegation is recalled only when creating, modifying or removing an extended attribute. on the other hand, verify the read delegation is not recalled when listing attributes or retrieving their values. the way that distinction matters... main character energy fr fr. 💖

negative testing is included too, like retrieval or removal of an extended attribute name which does not exist. creating an attribute which already exists should fail while using XATTR_CREATE flag. trying to modify an attribute which does not exist should fail if using XATTR_REPLACE flag. yes we test the fails too, we contain multitudes. 😭

🌈 OPTIONS 🌈

  • --version — show program's version number and exit, cute and simple 💫
  • -h, --help — show this help message and exit, the classic "help me help you" move 🫶
  • -f FILE, --file=FILE — File where options are specified besides the system wide file /etc/nfstest, user wide file $HOME/.nfstest or in the current directory .nfstest file. so you got layers of config files, so many places to stash your options 💜

🌸 NFS specific options 🌸

  • -s SERVER, --server=SERVER — Server name or IP address 📡
  • -e EXPORT, --export=EXPORT — Exported file system to mount [default: /]
  • --nfsversion=NFSVERSION — NFS version, e.g., 3, 4, 4.1, etc. [default: 4.2]
  • -m MTPOINT, --mtpoint=MTPOINT — Mount point [default: /mnt/t]
  • -p PORT, --port=PORT — NFS server port [default: 2049]
  • --proto=PROTO — NFS protocol name [default: tcp]
  • --sec=SEC — Security flavor [default: sys]
  • --nconnect=NCONNECT — Multiple TCP connections option [default: 1]
  • -o MTOPTS, --mtopts=MTOPTS — Mount options [default: hard,rsize=4096,wsize=4096]
  • --datadir=DATADIR — Data directory where files are created, directory is created on the mount point [default: '']

🎀 Logging options 🎀

  • -v VERBOSE, --verbose=VERBOSE — Verbose level for debug messages [default: opts|info|dbg1|dbg2|dbg3]
  • --tverbose=TVERBOSE — Verbose level for test messages [default: 1]
  • --createlog — Create log file 📝
  • --rexeclog — Create rexec log files 📝
  • --warnings — Display warnings ⚠️
  • --tag=TAG — Informational tag, it is displayed as an INFO message [default: '']
  • --notty — Do not use terminal colors on output 🚫🌈
  • --isatty — Use terminal colors on output -- useful when running with nohup 🌈

🦋 Packet trace options 🦋

  • --createtraces — Create a packet trace for each test 🔍
  • --tbsize=TBSIZE — Capture buffer size for tcpdump [default: 192k]
  • --trcdelay=TRCDELAY — Seconds to delay before stopping packet trace [default: 2.0]
  • --keeptraces — Do not remove any trace files [default: remove trace files if no errors]
  • --rmtraces — Remove trace files [default: remove trace files if no errors]
  • -i INTERFACE, --interface=INTERFACE — Device interface [default: automatically selected]

🍓 File options 🍓

  • --nfiles=NFILES — Number of files to create [default: 2]
  • --filesize=FILESIZE — File size to use for test files [default: 64k]
  • --rsize=RSIZE — Read size to use when reading files [default: 4k]
  • --wsize=WSIZE — Write size to use when writing files [default: 4k]
  • --iodelay=IODELAY — Seconds to delay I/O operations [default: 0.1]
  • --offset-delta=OFFSET_DELTA — Read/Write offset delta [default: 4k]

🧚 Path options 🧚

  • --sudo=SUDO — Full path of binary for sudo [default: /usr/bin/sudo]
  • --kill=KILL — Full path of binary for kill [default: /usr/bin/kill]
  • --nfsstat=NFSSTAT — Full path of binary for nfsstat [default: /usr/sbin/nfsstat]
  • --tcpdump=TCPDUMP — Full path of binary for tcpdump [default: /usr/sbin/tcpdump]
  • --iptables=IPTABLES — Full path of binary for iptables [default: /usr/sbin/iptables]
  • --messages=MESSAGES — Full path of log messages file [default: /var/log/messages]
  • --trcevents=TRCEVENTS — Full path of tracing events directory [default: /sys/kernel/debug/tracing/events]
  • --trcpipe=TRCPIPE — Full path of trace pipe file [default: /sys/kernel/debug/tracing/trace_pipe]
  • --tmpdir=TMPDIR — Temporary directory [default: /tmp]

💜 Debug options 💜

  • --nocleanup — Do not cleanup created files 🙈
  • --notimestamps — Do not display timestamps in debug messages ⏰
  • --bugmsgs=BUGMSGS — File containing test messages to mark as bugs if they failed 🐛
  • --nomount — Do not mount server and run the tests on local disk space 💾
  • --basename=BASENAME — Base name for all files and logs [default: automatically generated]
  • --nfsdebug=NFSDEBUG — Set NFS kernel debug flags and save log messages [default: '']
  • --rpcdebug=RPCDEBUG — Set RPC kernel debug flags and save log messages [default: '']
  • --tracepoints=TRACEPOINTS — List of trace points modules to enable [default: '']
  • --nfsstats — Get NFS stats [default: False]
  • --pktdisp — Display main packets related to the given test 📦
  • --nfserrors — Fail every NFS error found in the packet trace 💀
  • --client-ipaddr=CLIENT_IPADDR — IP address of localhost

⭐ Reporting options ⭐

  • --xunit-report — Generate xUnit compatible test report 📊
  • --xunit-report-file=XUNIT_REPORT_FILE — Path to xout report file

👑 Test options 👑

  • --runtest=RUNTEST — Comma separated list of tests to run, if list starts with a ^ then all tests are run except the ones listed [default: all]
  • --num-xattrs=NUM_XATTRS — Number of extended attributes to create for listxattr tests with many attributes [default: 20]
  • --client=CLIENT — Remote NFS client and options used for delegation tests. Clients are separated by a , and each client definition is a list of arguments separated by a : given in the following order if positional arguments is used (see examples):
clientname:server:export:nfsversion:port:proto:sec:mtpoint

[default: nfsversion=3:proto=tcp:port=2049]

  • --client-nfsvers=CLIENT_NFSVERS — Comma separated list of valid NFS versions to use in the --client option. An NFS version from this list, which is different than that given by --nfsversion, is selected and included in the --client option [default: 4.0,4.1]

🧪 TESTS 🧪

Okay bestie, this is the whole test menu. Every single one is listed, no skips, no cap. ✨

ngetxattr01

Verify getting extended attribute. simple, clean, iconic. 💖

ngetxattr02

Verify getting extended attribute fails when attribute does not exist. the “where is it tho” test. 😭

dgetxattr01

Verify getting extended attribute — when delegation is granted on second client. 💅

dgetxattr02

Verify getting extended attribute fails when attribute does not exist — when delegation is granted on second client. 🦋

nsetxattr01

Verify setting extended attribute with SETXATTR4_EITHER when attribute does not exist. either way, we ball. ✨

nsetxattr02

Verify setting extended attribute with SETXATTR4_CREATE when attribute does not exist. create the thing. 🌱

nsetxattr03

Verify setting extended attribute with SETXATTR4_REPLACE fails when attribute does not exist. can’t replace what isn’t there, bestie. 💀

nsetxattr04

Verify setting extended attribute with SETXATTR4_EITHER when attribute already exists. already here, still valid. 🍑

nsetxattr05

Verify setting extended attribute with SETXATTR4_CREATE fails when attribute already exists. no duplicates, periodt. 🙅‍♀️

nsetxattr06

Verify setting extended attribute with SETXATTR4_REPLACE when attribute already exists. swap it out, slay. 💜

dsetxattr01

Verify setting extended attribute with SETXATTR4_EITHER when attribute does not exist — when delegation is granted on second client. 🌈

dsetxattr02

Verify setting extended attribute with SETXATTR4_CREATE when attribute does not exist — when delegation is granted on second client. 🧚

dsetxattr03

Verify setting extended attribute with SETXATTR4_REPLACE fails when attribute does not exist — when delegation is granted on second client. 😭

dsetxattr04

Verify setting extended attribute with SETXATTR4_EITHER when attribute already exists — when delegation is granted on second client. 💖

dsetxattr05

Verify setting extended attribute with SETXATTR4_CREATE fails when attribute already exists — when delegation is granted on second client. 🫶

dsetxattr06

Verify setting extended attribute with SETXATTR4_REPLACE when attribute already exists — when delegation is granted on second client. 👑

nremovexattr01

Verify removing extended attribute. bye-bye, attribute. 👋

nremovexattr02

Verify removing extended attribute fails when attribute does not exist. nothing to remove, bestie. 💀

dremovexattr01

Verify removing extended attribute — when delegation is granted on second client. 🦋

dremovexattr02

Verify removing extended attribute fails when attribute does not exist — when delegation is granted on second client. 😭

nlistxattr01

Verify listing extended attributes with no user namespace attributes. empty list, but make it fashion. ✨

nlistxattr02

Verify listing extended attribute. just show me the list. 📝

nlistxattr03

Verify listing extended attribute (many attributes). so many attributes, so little time. 🔥

dlistxattr01

Verify listing extended attributes with no user namespace attributes — when delegation is granted on second client. 🌸

dlistxattr02

Verify listing extended attribute — when delegation is granted on second client. 💅

dlistxattr03

Verify listing extended attribute (many attributes) — when delegation is granted on second client. 💖

ncinfo01

Verify SETXATTR change info with SETXATTR4_EITHER when attribute does not exist. change info, but make it either. 🍑

ncinfo02

Verify SETXATTR change info with SETXATTR4_EITHER when attribute already exists. either again, but now it exists. 💖

ncinfo03

Verify SETXATTR change info with SETXATTR4_CREATE when attribute does not exist. create and inform. 🌱

ncinfo04

Verify SETXATTR change info with SETXATTR4_REPLACE when attribute already exists. replace and inform. 💜

mcinfo01

Verify SETXATTR change info with SETXATTR4_EITHER when attribute does not exist — when file is modified on second client. 🌈

mcinfo02

Verify SETXATTR change info with SETXATTR4_EITHER when attribute already exists — when file is modified on second client. 🧚

mcinfo03

Verify SETXATTR change info with SETXATTR4_CREATE when attribute does not exist — when file is modified on second client. ✨

mcinfo04

Verify SETXATTR change info with SETXATTR4_REPLACE when attribute already exists — when file is modified on second client. 👑

getxattr

Run all GETXATTR tests: ngetxattr01, ngetxattr02, dgetxattr01, dgetxattr02. the whole GETXATTR crew. 💖

ngetxattr

Run all GETXATTR tests when no open on second client: ngetxattr01, ngetxattr02. 🦋

dgetxattr

Run all GETXATTR tests when delegation is granted on second client: dgetxattr01, dgetxattr02. 💅

setxattr

Run all SETXATTR tests: nsetxattr01, nsetxattr02, nsetxattr03, nsetxattr04, nsetxattr05, nsetxattr06, dsetxattr01, dsetxattr02, dsetxattr03, dsetxattr04, dsetxattr05, dsetxattr06. all the SETXATTR energy. 🔥

nsetxattr

Run all SETXATTR tests when no open on second client: nsetxattr01, nsetxattr02, nsetxattr03, nsetxattr04, nsetxattr05, nsetxattr06. 🌸

dsetxattr

Run all SETXATTR tests when delegation is granted on second client: dsetxattr01, dsetxattr02, dsetxattr03, dsetxattr04, dsetxattr05, dsetxattr06. 💜

removexattr

Run all REMOVEXATTR tests: nremovexattr01, nremovexattr02, dremovexattr01, dremovexattr02. bye to all the attrs. 👋

nremovexattr

Run all REMOVEXATTR tests when no open on second client: nremovexattr01, nremovexattr02. 😭

dremovexattr

Run all REMOVEXATTR tests when delegation is granted on second client: dremovexattr01, dremovexattr02. 🦋

listxattr

Run all LISTXATTRS tests: nlistxattr01, nlistxattr02, nlistxattr03, dlistxattr01, dlistxattr02, dlistxattr03. list them all, bestie. 📝

nlistxattr

Run all LISTXATTRS tests when no open on second client: nlistxattr01, nlistxattr02, nlistxattr03. 🌸

dlistxattr

Run all LISTXATTRS tests when delegation is granted on second client: dlistxattr01, dlistxattr02, dlistxattr03. ✨

cinfo

Run all CINFO tests: ncinfo01, ncinfo02, ncinfo03, ncinfo04, mcinfo01, mcinfo02, mcinfo03, mcinfo04. change info overload. 💜

ncinfo

Run all CINFO tests when no open on second client: ncinfo01, ncinfo02, ncinfo03, ncinfo04. 🎀

mcinfo

Run all CINFO tests when file is modified on second client: mcinfo01, mcinfo02, mcinfo03, mcinfo04. 🌈

all

Run all tests: ngetxattr01, ngetxattr02, dgetxattr01, dgetxattr02, nsetxattr01, nsetxattr02, nsetxattr03, nsetxattr04, nsetxattr05, nsetxattr06, dsetxattr01, dsetxattr02, dsetxattr03, dsetxattr04, dsetxattr05, dsetxattr06, nremovexattr01, nremovexattr02, dremovexattr01, dremovexattr02, nlistxattr01, nlistxattr02, nlistxattr03, dlistxattr01, dlistxattr02, dlistxattr03, ncinfo01, ncinfo02, ncinfo03, ncinfo04, mcinfo01, mcinfo02, mcinfo03, mcinfo04. literally every single one. main character energy. 👑

🌟 EXAMPLES 🌟

The only required option is --server — that’s it, bestie. ✨

$ nfstest_xattr --server 192.168.0.11

📝 NOTES 📝

Heads up, queen: the user id in the local host and the host specified by --client must have access to run commands as root using the sudo command without the need for a password.
The user id must be able to ssh to remote host without the need for a password.
Valid only for NFS version 4.2 and above. so check ur NFS version, fr.

👀 SEE ALSO 👀

🐛 BUGS 🐛

No known bugs. we love a clean sheet. 💅

👑 AUTHOR 👑

Jorge Mora (mora@netapp.com) — the icon who wrote this. 💖

That’s the whole vibe, bestie. This was NFStest 3.2, dated 21 March 2023, and you just read NFSTEST_XATTR(1). Byeee! 🦋✨

📦 where this page comes from