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 21, 2008
  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 u Ar unit
  71 .Nm
  72 .Ar file
  73 .Sh DESCRIPTION
  74 The
  75 .Nm
  76 utility configures and enables
  77 .Xr md 4
  78 devices.
  79 .Pp
  80 Options indicate an action to be performed:
  81 .Bl -tag -width indent
  82 .It Fl a
  83 Attach a memory disk.
  84 This will configure and attach a memory disk with the
  85 parameters specified and attach it to the system.
  86 .It Fl d
  87 Detach a memory disk from the system and release all resources.
  88 .It Fl t Ar type
  89 Select the type of the memory disk.
  90 .Bl -tag -width "preload"
  91 .It Cm malloc
  92 Storage for this type of memory disk is allocated with
  93 .Xr malloc 9 .
  94 This limits the size to the malloc bucket limit in the kernel.
  95 If the
  96 .Fl o Cm reserve
  97 option is not set, creating and filling a large
  98 malloc-backed memory disk is a very easy way to
  99 panic a system.
 100 .It Cm vnode
 101 A file specified with
 102 .Fl f Ar file
 103 becomes the backing store for this memory disk.
 104 .It Cm swap
 105 Storage for this type of memory disk is allocated from buffer
 106 memory.
 107 Pages get pushed out to the swap when the system is under memory
 108 pressure, otherwise they stay in the operating memory.
 109 Using
 110 .Cm swap
 111 backing is generally preferable over
 112 .Cm malloc
 113 backing.
 114 .El
 115 .It Fl f Ar file
 116 Filename to use for the vnode type memory disk. Options
 117 .Fl a
 118 and
 119 .Fl t Ar vnode
 120 are implied if not specified.
 121 .It Fl l
 122 List configured devices.
 123 If given with
 124 .Fl u ,
 125 display details about that particular device.
 126 If
 127 .Fl v
 128 option specified, show all details.
 129 .It Fl n
 130 When printing md device names, print only the unit number without the
 131 md prefix.
 132 .It Fl s Ar size
 133 Size of the memory disk.
 134 .Ar Size
 135 is the number of 512 byte sectors unless suffixed with a
 136 .Cm b , k , m , g ,
 137 or
 138 .Cm t
 139 which
 140 denotes byte, kilobyte, megabyte, gigabyte and terabyte respectively. Options
 141 .Fl a
 142 and
 143 .Fl t Ar swap
 144 are implied if not specified.
 145 .It Fl S Ar sectorsize
 146 Sectorsize to use for malloc backed device.
 147 .It Fl x Ar sectors/track
 148 See the description of the
 149 .Fl y
 150 option below.
 151 .It Fl y Ar heads/cylinder
 152 For
 153 .Cm malloc
 154 or
 155 .Cm vnode
 156 backed devices, the
 157 .Fl x
 158 and
 159 .Fl y
 160 options can be used to specify a synthetic geometry.
 161 This is useful for constructing bootable images for later download to
 162 other devices.
 163 .It Fl o Oo Cm no Oc Ns Ar option
 164 Set or reset options.
 165 .Bl -tag -width indent
 166 .It Oo Cm no Oc Ns Cm async
 167 For
 168 .Cm vnode
 169 backed devices: avoid
 170 .Dv IO_SYNC
 171 for increased performance but
 172 at the risk of deadlocking the entire kernel.
 173 .It Oo Cm no Oc Ns Cm reserve
 174 Allocate and reserve all needed storage from the start, rather than as needed.
 175 .It Oo Cm no Oc Ns Cm cluster
 176 Enable clustering on this disk.
 177 .It Oo Cm no Oc Ns Cm compress
 178 Enable/Disable compression features to reduce memory usage.
 179 .It Oo Cm no Oc Ns Cm force
 180 Disable/Enable extra sanity checks to prevent the user from doing something
 181 that might adversely affect the system.
 182 .It Oo Cm no Oc Ns Cm readonly
 183 Enable/Disable readonly mode.
 184 .El
 185 .It Fl u Ar unit
 186 Request a specific unit number for the
 187 .Xr md 4
 188 device instead of automatic allocation.
 189 .El
 190 .Pp
 191 The last form,
 192 .Nm
 193 .Ar file ,
 194 is provided for convenience as an abbreviation of
 195 .Nm
 196 .Fl a
 197 .Fl t Ar vnode
 198 .Fl f Ar file .
 199 .Sh EXAMPLES
 200 To create a 4 megabyte
 201 .Xr malloc 9
 202 backed memory disk.
 203 The name of the allocated unit will be output on stdout like
 204 .Dq Li md3 :
 205 .Pp
 206 .Dl mdconfig -a -t malloc -s 4m
 207 .Pp
 208 To create a disk named
 209 .Pa /dev/md4
 210 with
 211 .Pa /tmp/boot.flp
 212 as backing storage:
 213 .Pp
 214 .Dl mdconfig -a -t vnode -f /tmp/boot.flp -u 4
 215 .Pp
 216 To detach and free all resources used by
 217 .Pa /dev/md4 :
 218 .Pp
 219 .Dl mdconfig -d -u 4
 220 .Pp
 221 To create a 128MByte swap backed disk, initialize an
 222 .Xr ffs 7
 223 file system on it, and mount it on
 224 .Pa /tmp :
 225 .Bd -literal -offset indent
 226 mdconfig -a -t swap -s 128M -u 10
 227 newfs -U /dev/md10
 228 mount /dev/md10 /tmp
 229 chmod 1777 /tmp
 230 .Ed
 231 .Pp
 232 To create a 5MB file-backed disk
 233 .Ns ( Fl a
 234 and
 235 .Fl t Ar vnode
 236 are implied):
 237 .Bd -literal -offset indent
 238 dd if=/dev/zero of=somebackingfile bs=1k count=5k
 239 mdconfig -f somebackingfile -u 0
 240 bsdlabel -w md0 auto
 241 newfs md0c
 242 mount /dev/md0c /mnt
 243 .Ed
 244 .Pp
 245 To create an
 246 .Xr md 4
 247 device out of an ISO 9660 CD image file
 248 .Ns ( Fl a
 249 and
 250 .Fl t Ar vnode
 251 are implied), using the first available
 252 .Xr md 4
 253 device, and then mount the new memory disk:
 254 .Bd -literal -offset indent
 255 mount -t cd9660 /dev/`mdconfig -f cdimage.iso` /mnt
 256 .Ed
 257 .Sh SEE ALSO
 258 .Xr md 4 ,
 259 .Xr ffs 7 ,
 260 .Xr bsdlabel 8 ,
 261 .Xr fdisk 8 ,
 262 .Xr mdmfs 8 ,
 263 .Xr malloc 9
 264 .Sh HISTORY
 265 The
 266 .Nm
 267 utility first appeared in
 268 .Fx 5.0
 269 as a cleaner replacement for the
 270 .Xr vn 4
 271 and
 272 .Xr vnconfig 8
 273 combo.
 274 .Sh AUTHORS
 275 The
 276 .Nm
 277 utility was written by
 278 .An Poul-Henning Kamp
 279 .Aq phk@FreeBSD.org .