sbin/mdconfig/mdconfig.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 .\" Copyright (c) 2000
   5 .\"     Poul-Henning Kamp  All rights reserved.
   6 .\"
   7 .\" This code is derived from software contributed to Berkeley by
   8 .\" the Systems Programming Group of the University of Utah Computer
   9 .\" Science Department.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)vnconfig.8  8.1 (Berkeley) 6/5/93
  36 .\" from: src/usr.sbin/vnconfig/vnconfig.8,v 1.19 2000/12/27 15:30:29
  37 .\"
  38 .\" $FreeBSD$
  39 .\"
  40 .Dd November 30, 2013
  41 .Dt MDCONFIG 8
  42 .Os
  43 .Sh NAME
  44 .Nm mdconfig
  45 .Nd configure and enable memory disks
  46 .Sh SYNOPSIS
  47 .Nm
  48 .Fl a
  49 .Fl t Ar type
  50 .Op Fl n
  51 .Oo Fl o Oo Cm no Oc Ns Ar option Oc ...
  52 .Op Fl f Ar file
  53 .Op Fl s Ar size
  54 .Op Fl S Ar sectorsize
  55 .Op Fl u Ar unit
  56 .Op Fl x Ar sectors/track
  57 .Op Fl y Ar heads/cylinder
  58 .Nm
  59 .Fl d
  60 .Fl u Ar unit
  61 .Op Fl o Oo Cm no Oc Ns Ar force
  62 .Nm
  63 .Fl r
  64 .Fl u Ar unit
  65 .Fl s Ar size
  66 .Op Fl o Oo Cm no Oc Ns Ar force
  67 .Nm
  68 .Fl l
  69 .Op Fl n
  70 .Op Fl v
  71 .Op Fl f Ar file
  72 .Op Fl u Ar unit
  73 .Nm
  74 .Ar file
  75 .Sh DESCRIPTION
  76 The
  77 .Nm
  78 utility configures and enables
  79 .Xr md 4
  80 devices.
  81 .Pp
  82 Options indicate an action to be performed:
  83 .Bl -tag -width indent
  84 .It Fl a
  85 Attach a memory disk.
  86 This will configure and attach a memory disk with the
  87 parameters specified and attach it to the system.
  88 If the
  89 .Fl u Ar unit
  90 option is not provided, the newly created device name will be printed on stdout.
  91 .It Fl d
  92 Detach a memory disk from the system and release all resources.
  93 .It Fl r
  94 Resize a memory disk.
  95 .It Fl t Ar type
  96 Select the type of the memory disk.
  97 .Bl -tag -width "malloc"
  98 .It Cm malloc
  99 Storage for this type of memory disk is allocated with
 100 .Xr malloc 9 .
 101 This limits the size to the malloc bucket limit in the kernel.
 102 If the
 103 .Fl o Cm reserve
 104 option is not set, creating and filling a large
 105 malloc-backed memory disk is a very easy way to
 106 panic a system.
 107 .It Cm vnode
 108 A file specified with
 109 .Fl f Ar file
 110 becomes the backing store for this memory disk.
 111 .It Cm swap
 112 Storage for this type of memory disk is allocated from buffer
 113 memory.
 114 Pages get pushed out to swap when the system is under memory
 115 pressure, otherwise they stay in the operating memory.
 116 Using
 117 .Cm swap
 118 backing is generally preferred instead of using
 119 .Cm malloc
 120 backing.
 121 .It Cm null
 122 Bitsink; all writes do nothing, all reads return zeroes.
 123 .El
 124 .It Fl f Ar file
 125 Filename to use for the vnode type memory disk.
 126 The
 127 .Fl a
 128 and
 129 .Fl t Ar vnode
 130 options are implied if not specified.
 131 .It Fl l
 132 List configured devices.
 133 If given with
 134 .Fl u ,
 135 display details about that particular device.
 136 If given with
 137 .Fl f Ar file ,
 138 display
 139 .Xr md 4
 140 device names of which
 141 .Ar file
 142 is used as the backing store.
 143 If both of
 144 .Fl u
 145 and
 146 .Fl f
 147 options are specified,
 148 display devices which match the two conditions.
 149 If the
 150 .Fl v
 151 option is specified, show all details.
 152 .It Fl n
 153 When printing
 154 .Xr md 4
 155 device names, print only the unit number without the
 156 .Xr md 4
 157 prefix.
 158 .It Fl s Ar size
 159 Size of the memory disk.
 160 .Ar Size
 161 is the number of 512 byte sectors unless suffixed with a
 162 .Cm b , k , m , g ,
 163 or
 164 .Cm t
 165 which
 166 denotes byte, kilobyte, megabyte, gigabyte and terabyte respectively.
 167 The
 168 .Fl a
 169 and
 170 .Fl t Ar swap
 171 options are implied if not specified.
 172 .It Fl S Ar sectorsize
 173 Sectorsize to use for the memory disk, in bytes.
 174 .It Fl x Ar sectors/track
 175 See the description of the
 176 .Fl y
 177 option below.
 178 .It Fl y Ar heads/cylinder
 179 For
 180 .Cm malloc
 181 or
 182 .Cm vnode
 183 backed devices, the
 184 .Fl x
 185 and
 186 .Fl y
 187 options can be used to specify a synthetic geometry.
 188 This is useful for constructing bootable images for later download to
 189 other devices.
 190 .It Fl o Oo Cm no Oc Ns Ar option
 191 Set or reset options.
 192 .Bl -tag -width indent
 193 .It Oo Cm no Oc Ns Cm async
 194 For
 195 .Cm vnode
 196 backed devices: avoid
 197 .Dv IO_SYNC
 198 for increased performance but
 199 at the risk of deadlocking the entire kernel.
 200 .It Oo Cm no Oc Ns Cm reserve
 201 Allocate and reserve all needed storage from the start, rather than as needed.
 202 .It Oo Cm no Oc Ns Cm cluster
 203 Enable clustering on this disk.
 204 .It Oo Cm no Oc Ns Cm compress
 205 Enable/disable compression features to reduce memory usage.
 206 .It Oo Cm no Oc Ns Cm force
 207 Disable/enable extra sanity checks to prevent the user from doing something
 208 that might adversely affect the system.
 209 .It Oo Cm no Oc Ns Cm readonly
 210 Enable/disable readonly mode.
 211 .El
 212 .It Fl u Ar unit
 213 Request a specific unit number or device name for the
 214 .Xr md 4
 215 device instead of automatic allocation.
 216 If a device name is specified, it must be start with
 217 .Dq md
 218 followed by the unit number.
 219 .El
 220 .Pp
 221 The last form,
 222 .Nm
 223 .Ar file ,
 224 is provided for convenience as an abbreviation of
 225 .Nm
 226 .Fl a
 227 .Fl t Ar vnode
 228 .Fl f Ar file .
 229 .Sh EXAMPLES
 230 Create a 4 megabyte
 231 .Xr malloc 9
 232 backed memory disk.
 233 The name of the allocated unit will be printed on stdout, such as
 234 .Dq Li md3 :
 235 .Pp
 236 .Dl mdconfig -a -t malloc -s 4m
 237 .Pp
 238 Create a disk named
 239 .Pa /dev/md4
 240 with
 241 .Pa /tmp/boot.flp
 242 as backing storage:
 243 .Pp
 244 .Dl mdconfig -a -t vnode -f /tmp/boot.flp -u md4
 245 .Pp
 246 Detach and free all resources used by
 247 .Pa /dev/md4 :
 248 .Pp
 249 .Dl mdconfig -d -u md4
 250 .Pp
 251 Create a 128MByte swap backed disk, initialize an
 252 .Xr ffs 7
 253 file system on it, and mount it on
 254 .Pa /tmp :
 255 .Bd -literal -offset indent
 256 mdconfig -a -t swap -s 128M -u md10
 257 newfs -U /dev/md10
 258 mount /dev/md10 /tmp
 259 chmod 1777 /tmp
 260 .Ed
 261 .Pp
 262 Create a 5MB file-backed disk
 263 .Po Fl a
 264 and
 265 .Fl t Ar vnode
 266 are implied
 267 .Pc :
 268 .Bd -literal -offset indent
 269 dd if=/dev/zero of=somebackingfile bs=1k count=5k
 270 mdconfig -f somebackingfile -u md0
 271 bsdlabel -w md0 auto
 272 newfs md0c
 273 mount /dev/md0c /mnt
 274 .Ed
 275 .Pp
 276 Create an
 277 .Xr md 4
 278 device out of an ISO 9660 CD image file
 279 .Po Fl a
 280 and
 281 .Fl t Ar vnode
 282 are implied
 283 .Pc , using the first available
 284 .Xr md 4
 285 device, and then mount the new memory disk:
 286 .Bd -literal -offset indent
 287 mount -t cd9660 /dev/`mdconfig -f cdimage.iso` /mnt
 288 .Pp
 289 .Ed
 290 Create a file-backed device from a hard disk image that begins
 291 with 512K of raw header information.
 292 .Xr gnop 8
 293 is used to skip over the header information, positioning
 294 .Pa md1.nop
 295 to the start of the filesystem in the image.
 296 .Bd -literal -offset indent
 297 mdconfig -f diskimage.img -u md1
 298 gnop create -o 512K md1
 299 mount /dev/md1.nop /mnt
 300 .Ed
 301 .Sh SEE ALSO
 302 .Xr md 4 ,
 303 .Xr ffs 7 ,
 304 .Xr bsdlabel 8 ,
 305 .Xr fdisk 8 ,
 306 .Xr mdmfs 8 ,
 307 .Xr malloc 9
 308 .Sh HISTORY
 309 The
 310 .Nm
 311 utility first appeared in
 312 .Fx 5.0
 313 as a cleaner replacement for the
 314 .Xr vn 4
 315 and
 316 .Xr vnconfig 8
 317 combo.
 318 .Sh AUTHORS
 319 The
 320 .Nm
 321 utility was written by
 322 .An Poul-Henning Kamp Aq Mt phk@FreeBSD.org .