sbin/geom/class/nop/gnop.8

   1 .\" Copyright (c) 2004-2006 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd October 10, 2015
  28 .Dt GNOP 8
  29 .Os
  30 .Sh NAME
  31 .Nm gnop
  32 .Nd "control utility for NOP GEOM class"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Cm create
  36 .Op Fl v
  37 .Op Fl e Ar error
  38 .Op Fl o Ar offset
  39 .Op Fl p Ar stripesize
  40 .Op Fl P Ar stripeoffset
  41 .Op Fl r Ar rfailprob
  42 .Op Fl s Ar size
  43 .Op Fl S Ar secsize
  44 .Op Fl w Ar wfailprob
  45 .Ar dev ...
  46 .Nm
  47 .Cm configure
  48 .Op Fl v
  49 .Op Fl e Ar error
  50 .Op Fl r Ar rfailprob
  51 .Op Fl w Ar wfailprob
  52 .Ar prov ...
  53 .Nm
  54 .Cm destroy
  55 .Op Fl fv
  56 .Ar prov ...
  57 .Nm
  58 .Cm reset
  59 .Op Fl v
  60 .Ar prov ...
  61 .Nm
  62 .Cm list
  63 .Nm
  64 .Cm status
  65 .Nm
  66 .Cm load
  67 .Nm
  68 .Cm unload
  69 .Sh DESCRIPTION
  70 The
  71 .Nm
  72 utility is used for setting up transparent providers on existing ones.
  73 Its main purpose is testing other GEOM classes, as it allows forced provider
  74 removal and I/O error simulation with a given probability.
  75 It also gathers statistics on the number of read, write, delete,
  76 getattr, flush, and other requests, and the number of bytes read and written.
  77 .Nm
  78 can also be used as a good starting point for implementing new GEOM
  79 classes.
  80 .Pp
  81 The first argument to
  82 .Nm
  83 indicates an action to be performed:
  84 .Bl -tag -width ".Cm configure"
  85 .It Cm create
  86 Set up a transparent provider on the given devices.
  87 If the operation succeeds, the new provider should appear with name
  88 .Pa /dev/ Ns Ao Ar dev Ac Ns Pa .nop .
  89 The kernel module
  90 .Pa geom_nop.ko
  91 will be loaded if it is not loaded already.
  92 .It Cm configure
  93 Configure existing transparent provider.
  94 At the moment it is only used for changing failure probability.
  95 .It Cm destroy
  96 Turn off the given transparent providers.
  97 .It Cm reset
  98 Reset statistics for the given transparent providers.
  99 .It Cm list
 100 See
 101 .Xr geom 8 .
 102 .It Cm status
 103 See
 104 .Xr geom 8 .
 105 .It Cm load
 106 See
 107 .Xr geom 8 .
 108 .It Cm unload
 109 See
 110 .Xr geom 8 .
 111 .El
 112 .Pp
 113 Additional options:
 114 .Bl -tag -width ".Fl r Ar rfailprob"
 115 .It Fl e Ar error
 116 Specifies the error number to return on failure.
 117 .It Fl f
 118 Force the removal of the specified provider.
 119 .It Fl o Ar offset
 120 Where to begin on the original provider.
 121 .It Fl p Ar stripesize
 122 Value of the stripesize property of the transparent provider.
 123 .It Fl P Ar stripeoffset
 124 Value of the stripeoffset property of the transparent provider.
 125 .It Fl r Ar rfailprob
 126 Specifies read failure probability in percent.
 127 .It Fl s Ar size
 128 Size of the transparent provider.
 129 .It Fl S Ar secsize
 130 Sector size of the transparent provider.
 131 .It Fl w Ar wfailprob
 132 Specifies write failure probability in percent.
 133 .It Fl v
 134 Be more verbose.
 135 .El
 136 .Sh SYSCTL VARIABLES
 137 The following
 138 .Xr sysctl 8
 139 variables can be used to control the behavior of the
 140 .Nm NOP
 141 GEOM class.
 142 The default value is shown next to each variable.
 143 .Bl -tag -width indent
 144 .It Va kern.geom.nop.debug : No 0
 145 Debug level of the
 146 .Nm NOP
 147 GEOM class.
 148 This can be set to a number between 0 and 2 inclusive.
 149 If set to 0, minimal debug information is printed.
 150 If set to 1, basic debug information is logged along with the I/O requests
 151 that were returned as errors.
 152 If set to 2, the maximum amount of debug information is printed including
 153 all I/O requests.
 154 .El
 155 .Sh EXIT STATUS
 156 Exit status is 0 on success, and 1 if the command fails.
 157 .Sh EXAMPLES
 158 The following example shows how to create a transparent provider for disk
 159 .Pa /dev/da0
 160 with 50% write failure probability, and how to destroy it.
 161 .Bd -literal -offset indent
 162 gnop create -v -w 50 da0
 163 gnop destroy -v da0.nop
 164 .Ed
 165 .Pp
 166 The traffic statistics for the given transparent providers can be obtained
 167 with the
 168 .Cm list
 169 command.
 170 The example below shows the number of bytes written with
 171 .Xr newfs 8 :
 172 .Bd -literal -offset indent
 173 gnop create da0
 174 newfs /dev/da0.nop
 175 gnop list
 176 .Ed
 177 .Sh SEE ALSO
 178 .Xr geom 4 ,
 179 .Xr geom 8
 180 .Sh HISTORY
 181 The
 182 .Nm
 183 utility appeared in
 184 .Fx 5.3 .
 185 .Sh AUTHORS
 186 .An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org