usr.sbin/vnconfig/vnconfig.8

   1 .\" Copyright (c) 1993 University of Utah.
   2 .\" Copyright (c) 1980, 1989, 1991, 1993
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" the Systems Programming Group of the University of Utah Computer
   7 .\" Science Department.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the University of
  20 .\"     California, Berkeley and its contributors.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\"     @(#)vnconfig.8  8.1 (Berkeley) 6/5/93
  38 .\" $FreeBSD: src/usr.sbin/vnconfig/vnconfig.8,v 1.14.2.8 2003/01/04 22:35:53 keramida Exp $
  39 .\" $DragonFly: src/usr.sbin/vnconfig/vnconfig.8,v 1.7 2008/01/30 12:35:07 swildner Exp $
  40 .\"
  41 .Dd January 30, 2008
  42 .Dt VNCONFIG 8
  43 .Os
  44 .Sh NAME
  45 .Nm vnconfig
  46 .Nd configure and enable vnode disks
  47 .Sh SYNOPSIS
  48 .Nm
  49 .Op Fl cdeguvTZ
  50 .Oo Fl s Ar option Ns
  51 .Op , Ns Ar option Ns Ar ... Oc
  52 .Oo Fl r Ar option Ns
  53 .Op , Ns Ar option Ns Ar ... Oc
  54 .Op Fl S Ar value
  55 .Ar special_file Op Ar regular_file
  56 .Op Ar feature
  57 .Nm
  58 .Fl a
  59 .Op Fl cdeguv
  60 .Op Fl s Ar option
  61 .Op Fl r Ar option
  62 .Op Fl f Ar config_file
  63 .Nm
  64 .Fl l
  65 .Op Ar special_file Ar ...
  66 .Sh DESCRIPTION
  67 The
  68 .Nm
  69 command configures, enables and lists vnode pseudo disk devices.
  70 The first form of the command will associate the special file
  71 .Ar special_file
  72 with the regular file
  73 .Ar regular_file
  74 allowing the latter to be accessed as though it were a disk.
  75 Hence a regular file within the filesystem can be used for swapping
  76 or can contain a filesystem that is mounted in the name space.  If you
  77 want to use swap backing store for your device instead of a file, you
  78 can leave regular_file out and specify the size of the block device
  79 with the -S option.
  80 .Pp
  81 Options indicate an action to be performed:
  82 .Bl -tag -width indent
  83 .It Fl a
  84 Read a command file and performs the
  85 specified actions for each device/file pair.
  86 .It Fl c
  87 Configure the device.
  88 If successful, references to
  89 .Ar special_file
  90 will access the contents of
  91 .Ar regular_file .
  92 .It Fl d
  93 Disable (if possible) the specified feature.
  94 .It Fl e
  95 Configure the device and enables any
  96 .Ar feature
  97 that was specified.
  98 If no feature was specified,
  99 .Fl e
 100 is the same as
 101 .Fl c .
 102 .It Fl f Ar config_file
 103 Use
 104 .Ar config_file
 105 as an alternate config file.
 106 .It Fl g
 107 Fiddle global options.
 108 .It Fl l Ar special_file...
 109 List the vn devices and indicate which ones are in use.
 110 If a
 111 .Ar special_file
 112 list is given, only those devices will be described.
 113 .It Fl r Ar flag
 114 Reset
 115 .Ar flag .
 116 The list of allowed flags and their meanings are:
 117 .Bl -tag -width "follow"
 118 .It Ar labels
 119 use disk/slice labels.
 120 .It Ar reserve
 121 Pre-reserve the blocks underlying the file or swap backing store.  Currently only
 122 works for swap backing store.  This option also disables on-the-fly freeing of
 123 the underlying backing store (for example, when you remove a large file).
 124 Use this option if you wish to avoid long-term fragmentation of the backing
 125 store.  Also note that when this option is used, the initial contents of the
 126 backing store may contain garbage rather than zeros.  It may even be possible to
 127 recover the prior contents of a swap-backed VN across a reboot if the VN device
 128 is configured before any swap is allocated by the system.
 129 .It Ar follow
 130 debug flow in the
 131 .Xr vn 4
 132 driver.
 133 .It Ar debug
 134 debug data in the
 135 .Xr vn 4
 136 driver.
 137 .It Ar io
 138 debug I/O in the
 139 .Xr vn 4
 140 driver.
 141 .It Ar all
 142 turn on all flags.
 143 .It Ar none
 144 turn off all flags.
 145 .El
 146 .It Fl s Ar flag
 147 Set
 148 .Ar flag .
 149 The list of allowed flags and their meanings are the same as for the
 150 .Fl r
 151 option.
 152 .It Fl S Xo
 153 .Sm off
 154 .Ar value
 155 .Es \&{ \&}
 156 .En Cm k , m , g , t
 157 .Sm on
 158 .Xc
 159 If no regular file is specified, VN will use swap for backing store.
 160 This option specifies the size of the device.  For example, '23m' for
 161 23 megabytes.  The VN device will round the size up to a machine page boundary.
 162 Filesystems up to 7.9 terabytes are supported.  When specified along with
 163 a regular file, this option overrides the regular file's size insofar as
 164 VN is concerned.
 165 .It Fl T
 166 When a regular file is specified, VN will ftruncate() the file to 0 first.
 167 Normally you should also specify the -S option to set the size of the file.
 168 This option also creates the file if it did not previously exist.
 169 This option is only meaningful if the -S option has been specified.
 170 .It Fl Z
 171 When a regular file is specified, VN will zero the contents of the file to
 172 ensure that all blocks have been allocated by the filesystem.  This option is
 173 only meaningful if the -S option has been specified.
 174 .It Fl u
 175 Disable and ``unconfigure'' the device.
 176 .It Fl v
 177 Print messages to stdout describing actions taken.
 178 .El
 179 .Pp
 180 If no action option is given,
 181 .Fl c
 182 is assumed.
 183 .Pp
 184 The
 185 .Ar feature
 186 argument specifies a feature that can be enabled via the
 187 .Fl e
 188 option:
 189 .Bl -tag -width indent
 190 .It Dv swap
 191 Swapping is enabled on the special file.
 192 See
 193 .Xr swapon 2 .
 194 .It Dv mountro Ns = Ns Pa mount_point
 195 The special file is mounted read-only on
 196 .Ar mount_point .
 197 See
 198 .Xr mount 2 .
 199 .It Dv mountrw Ns = Ns Pa mount_point
 200 The special file is mounted read-write on
 201 .Ar mount_point .
 202 See
 203 .Xr mount 2 .
 204 .It Dv mount Ns = Ns Pa mount_point
 205 Same as ``mountrw=''.
 206 .El
 207 .Pp
 208 A configuration file contains one line per device/file pair in the form:
 209 .Bd -literal
 210         special_file    regular_file    [ feature ]
 211 .Ed
 212 .Pp
 213 where fields are separated by white space.
 214 The previously described action options serve to configure, enable,
 215 disable or unconfigure all devices in the configuration file.
 216 .Sh FILES
 217 .Bl -tag -width /etc/vntab -compact
 218 .It Pa /etc/vntab
 219 default configuration file for
 220 .Fl a
 221 option
 222 .El
 223 .Sh EXAMPLES
 224 .Dl vnconfig vn0 /tmp/diskimage
 225 .Pp
 226 Configures the vnode disk
 227 .Pa vn0 .
 228 .Pp
 229 .Dl vnconfig -e vn0 /var/swapfile swap
 230 .Pp
 231 Configures
 232 .Pa vn0
 233 and enables swapping on it.
 234 .Pp
 235 .Dl vnconfig -c -v /dev/vn0 cdimage.iso
 236 .Dl mount -t cd9660 -o ro /dev/vn0 /mnt
 237 .Pp
 238 Mount an ISO9660 CD image file.
 239 .Pp
 240 .Dl umount /mnt
 241 .Dl vnconfig -u vn0
 242 .Pp
 243 Unmount the CD image file.
 244 .Pp
 245 .Dl vnconfig -d vn0 myfilesystem mount=/mnt
 246 .Pp
 247 Unmounts (disables)
 248 .Pa vn0 .
 249 .Pp
 250 .Dl vnconfig -ae
 251 .Pp
 252 Configures and enables all devices specified in
 253 .Pa /etc/vntab .
 254 .Pp
 255 .Dl vnconfig -s labels -c vn0 somebackingfile
 256 .Dl disklabel -r -w vn0s0 auto
 257 .Dl disklabel -e vn0s0
 258 .Pp
 259 Is an example of how to configure a file-backed VN disk with a disk label
 260 and to initialize and then edit the label.  Once you create the label, you
 261 can partition your VN disk and, for example, create a filesystem on one of
 262 the partitions.  If you are using a file as backing store, it may be possible
 263 to recover your VN disk after a crash by vnconfig'ing the same file again
 264 and using the VN configuration already stored in the file rather than
 265 relabeling and recreating the filesystem.  It is even possible to fsck the
 266 VN partitions that previously contained filesystems.
 267 .Pp
 268 .Dl vnconfig -e -s labels,reserve -S 400m vn1
 269 .Dl disklabel -r -w vn1s0 auto
 270 .Dl newfs /dev/vn1s0
 271 .Dl mount /dev/vn1s0 /usr/obj
 272 .Pp
 273 Is an example of a swap-backed VN disk configuration.  This example assumes
 274 that you have at least 400 megabytes of swap free (and hopefully much more).
 275 The swap space is pre-reserved in order to maintain maximum performance.
 276 We then label the disk, newfs it, and mount it as /usr/obj.  Swap-backed VN
 277 devices are recoverable after a crash if you (A) use the reserve flag, and if
 278 (B) the same swap is reserved as was the last time, meaning that such
 279 vnconfig's would have to be run in your rc.local.  In general, though, you
 280 only use swap-backed VN devices to hold information you don't mind losing
 281 on every reboot.
 282 .Sh SEE ALSO
 283 .Xr mount 2 ,
 284 .Xr swapon 2 ,
 285 .Xr unmount 2 ,
 286 .Xr vn 4