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