GNOP(8)

πŸ“¦ version 15.1, in freebsd 14.5, freebsd 15.1

πŸ’… GNOP(8) β€” the manual, but make it make sense πŸ’…

Okay bestie, welcome to the GNOP(8) era! This is the control utility for the NOP GEOM class, and yes, we're gonna get through it together. It's giving "niche but iconic" and honestly? Kinda obsessed. Let's go. πŸŽ€


✨ NAME ✨

gnop β€” control utility for the NOP GEOM class. That's the whole vibe. Short, sweet, slays.


🌸 SYNOPSIS 🌸

Here's the main character energy. Copy these exact, don't get creative:

gnop create [-v] [-c count_until_fail] [-d delaymsec] [-e error]
     [-o offset] [-p stripesize] [-P stripeoffset] [-q rdelayprob]
     [-r rfailprob] [-s size] [-S secsize] [-w wfailprob]
     [-x wdelayprob] [-z physpath] [-Z gnopname] dev ...
gnop configure [-v] [-c count_until_fail] [-d delaymsec] [-e error]
     [-q rdelayprob] [-r rfailprob] [-w wfailprob] [-x wdelayprob] prov
     ...
gnop destroy [-fv] prov ...
gnop reset [-v] prov ...
gnop list
gnop status
gnop load
gnop unload

Lowkey a lot of brackets, but we move. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So the tea is: the gnop utility is used for setting up transparent providers on existing ones. Its main purpose is testing other GEOM classes, because it lets you do forced provider removal and I/O error simulation with a given probability. It also gathers statistics on the number of read, write, delete, getattr, flush, and other requests, and the number of bytes read and written. Not me being a whole stats girlie. gnop can also be used as a good starting point for implementing new GEOM classes β€” like a little starter pack, iykyk.

The first argument to gnop indicates an action to be performed. Here's the rundown:

  • create β€” Set up a transparent provider on the given devices. If the operation succeeds, the new provider should appear with name /dev/⟨dev⟩.nop. The kernel module geom_nop.ko will be loaded if it is not loaded already. It's giving "set it up and let it cook."
  • configure β€” Configure an existing transparent provider. At the moment it is only used for changing failure probability. Lowkey a one-trick pony but she's doing her best.
  • destroy β€” Turn off the given transparent providers. Bye bestie, it was real. πŸ’€
  • reset β€” Reset statistics for the given transparent providers. Fresh start era.
  • list β€” See geom(8).
  • status β€” See geom(8).
  • load β€” See geom(8).
  • unload β€” See geom(8).

Additional options β€” the whole menu πŸ“

  • -c count_until_fail β€” Specifies the number of I/O requests to allow before setting the read, write and delay failure probabilities. Like a countdown to chaos.
  • -d delaymsec β€” Specifies the delay of the requests in milliseconds. Note that requests will be delayed before they are sent to the backing device. Important detail, don't skip it.
  • -e error β€” Specifies the error number to return on failure.
  • -f β€” Force the removal of the specified provider. Forceful, but make it fashion.
  • -o offset β€” Where to begin on the original provider.
  • -p stripesize β€” Value of the stripesize property of the transparent provider.
  • -P stripeoffset β€” Value of the stripeoffset property of the transparent provider.
  • -q rdelayprob β€” Specifies read delay probability in percent.
  • -r rfailprob β€” Specifies read failure probability in percent.
  • -s size β€” Size of the transparent provider.
  • -S secsize β€” Sector size of the transparent provider.
  • -w wfailprob β€” Specifies write failure probability in percent.
  • -v β€” Be more verbose. Talk to me, tell me everything.
  • -x wdelayprob β€” Specifies write delay probability in percent.
  • -z physpath β€” Physical path of the transparent provider.
  • -Z gnopname β€” The name of the new provider. The suffix .nop will be appended to the provider name. Cute little signature, no cap.

🌈 SYSCTL VARIABLES 🌈

The following sysctl(8) variables can be used to control the behavior of the NOP GEOM class. The default value is shown next to each variable.

  • kern.geom.nop.debug: 0 β€” Debug level of the NOP GEOM class. This can be set to a number between 0 and 2 inclusive. If set to 0, minimal debug information is printed. If set to 1, basic debug information is logged along with the I/O requests that were returned as errors. If set to 2, the maximum amount of debug information is printed including all I/O requests. Choose your fighter: minimal, basic, or maximum overdrive. πŸ‘‘

πŸ’– EXIT STATUS πŸ’–

Exit status is 0 on success, and 1 if the command fails. Simple as that. We love a binary queen.


🌟 EXAMPLES 🌟

The following example shows how to create a transparent provider for disk /dev/da0 with 50% write failure probability, and how to destroy it. Living dangerously, we respect it.

gnop create -v -w 50 da0
gnop destroy -v da0.nop

The traffic statistics for the given transparent providers can be obtained with the list command. The example below shows the number of bytes written with newfs(8):

gnop create da0
newfs /dev/da0.nop
gnop list

It's giving "watch me work." ✨


🧚 SEE ALSO 🧚

geom(4), geom(8). The homework, bestie. Do the reading.


πŸ‘‘ HISTORY πŸ‘‘

The gnop utility appeared in FreeBSD 5.3. A classic. We stan an OG.


🫢 AUTHORS 🫢

Pawel Jakub Dawidek <pjd@FreeBSD.org>. Icon behavior.


Debian Β· December 29, 2019 Β· GNOP(8) β€” that's a wrap, bestie! Screenshot this, study it, live it. You're gonna slay. πŸ’…πŸ’–βœ¨

πŸ“¦ where this page comes from