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 October 10, 2015
  45 .Dt MDCONFIG 8
  46 .Os
  47 .Sh NAME
  48 .Nm mdconfig
  49 .Nd create and control 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 r
  68 .Fl u Ar unit
  69 .Fl s Ar size
  70 .Op Fl o Oo Cm no Oc Ns Ar force
  71 .Nm
  72 .Fl l
  73 .Op Fl n
  74 .Op Fl v
  75 .Op Fl f Ar file
  76 .Op Fl u Ar unit
  77 .Nm
  78 .Ar file
  79 .Sh DESCRIPTION
  80 The
  81 .Nm
  82 utility creates and controls
  83 .Xr md 4
  84 devices.
  85 .Pp
  86 Options indicate an action to be performed:
  87 .Bl -tag -width indent
  88 .It Fl a
  89 Attach a memory disk.
  90 This will configure and attach a memory disk with the
  91 parameters specified and attach it to the system.
  92 If the
  93 .Fl u Ar unit
  94 option is not provided, the newly created device name will be printed on stdout.
  95 .It Fl d
  96 Detach a memory disk from the system and release all resources.
  97 .It Fl r
  98 Resize a memory disk.
  99 .It Fl t Ar type
 100 Select the type of the memory disk.
 101 .Bl -tag -width "malloc"
 102 .It Cm malloc
 103 Storage for this type of memory disk is allocated with
 104 .Xr malloc 9 .
 105 This limits the size to the malloc bucket limit in the kernel.
 106 If the
 107 .Fl o Cm reserve
 108 option is not set, creating and filling a large
 109 malloc-backed memory disk is a very easy way to
 110 panic the system.
 111 .It Cm vnode
 112 A file specified with
 113 .Fl f Ar file
 114 becomes the backing store for this memory disk.
 115 .It Cm swap
 116 Storage for this type of memory disk is allocated from buffer
 117 memory.
 118 Pages get pushed out to swap when the system is under memory
 119 pressure, otherwise they stay in the operating memory.
 120 Using
 121 .Cm swap
 122 backing is generally preferred instead of using
 123 .Cm malloc
 124 backing.
 125 .It Cm null
 126 Bitsink; all writes do nothing, all reads return zeroes.
 127 .El
 128 .It Fl f Ar file
 129 Filename to use for the vnode type memory disk.
 130 The
 131 .Fl a
 132 and
 133 .Fl t Ar vnode
 134 options are implied if not specified.
 135 .It Fl l
 136 List configured devices.
 137 If given with
 138 .Fl u ,
 139 display details about that particular device.
 140 If given with
 141 .Fl f Ar file ,
 142 display
 143 .Xr md 4
 144 device names of which
 145 .Ar file
 146 is used as the backing store.
 147 If both of
 148 .Fl u
 149 and
 150 .Fl f
 151 options are specified,
 152 display devices which match the two conditions.
 153 If the
 154 .Fl v
 155 option is specified, show all details.
 156 .It Fl n
 157 When printing
 158 .Xr md 4
 159 device names, print only the unit number without the
 160 .Xr md 4
 161 prefix.
 162 .It Fl s Ar size
 163 Size of the memory disk.
 164 .Ar Size
 165 is the number of 512 byte sectors unless suffixed with a
 166 .Cm b , k , m , g , t ,
 167 or
 168 .Cm p
 169 which
 170 denotes byte, kilobyte, megabyte, gigabyte, terabyte and petabyte respectively.
 171 When used without the
 172 .Fl r
 173 option, the
 174 .Fl a
 175 and
 176 .Fl t Ar swap
 177 options are implied if not specified.
 178 .It Fl S Ar sectorsize
 179 Sectorsize to use for the memory disk, in bytes.
 180 .It Fl x Ar sectors/track
 181 See the description of the
 182 .Fl y
 183 option below.
 184 .It Fl y Ar heads/cylinder
 185 For
 186 .Cm malloc
 187 or
 188 .Cm vnode
 189 backed devices, the
 190 .Fl x
 191 and
 192 .Fl y
 193 options can be used to specify a synthetic geometry.
 194 This is useful for constructing bootable images for later download to
 195 other devices.
 196 .It Fl o Oo Cm no Oc Ns Ar option
 197 Set or reset options.
 198 .Bl -tag -width indent
 199 .It Oo Cm no Oc Ns Cm async
 200 For
 201 .Cm vnode
 202 backed devices: avoid
 203 .Dv IO_SYNC
 204 for increased performance but
 205 at the risk of deadlocking the entire kernel.
 206 .It Oo Cm no Oc Ns Cm reserve
 207 Allocate and reserve all needed storage from the start, rather than as needed.
 208 .It Oo Cm no Oc Ns Cm cluster
 209 Enable clustering on this disk.
 210 .It Oo Cm no Oc Ns Cm compress
 211 Enable/disable compression features to reduce memory usage.
 212 .It Oo Cm no Oc Ns Cm force
 213 Disable/enable extra sanity checks to prevent the user from doing something
 214 that might adversely affect the system.
 215 This can be used with the
 216 .Fl d
 217 flag to forcibly destroy an
 218 .Xr md 4
 219 disk that is still in use.
 220 .It Oo Cm no Oc Ns Cm readonly
 221 Enable/disable readonly mode.
 222 .El
 223 .It Fl u Ar unit
 224 Request a specific unit number or device name for the
 225 .Xr md 4
 226 device instead of automatic allocation.
 227 If a device name is specified, it must be start with
 228 .Dq md
 229 followed by the unit number.
 230 .El
 231 .Pp
 232 The last form,
 233 .Nm
 234 .Ar file ,
 235 is provided for convenience as an abbreviation of
 236 .Nm
 237 .Fl a
 238 .Fl t Ar vnode
 239 .Fl f Ar file .
 240 .Sh EXAMPLES
 241 Create a disk with
 242 .Pa /tmp/boot.flp
 243 as backing storage.
 244 The name of the allocated unit will be printed on stdout, such as
 245 .Dq Li md0 :
 246 .Bd -literal -offset indent
 247 mdconfig /tmp/boot.flp
 248 .Ed
 249 .Pp
 250 Create a 1 gigabyte swap backed memory disk named
 251 .Dq Li md3 :
 252 .Bd -literal -offset indent
 253 mdconfig -s 1g -u md3
 254 .Ed
 255 .Pp
 256 Detach and free all resources used by
 257 .Pa /dev/md3 :
 258 .Bd -literal -offset indent
 259 mdconfig -du md3
 260 .Ed
 261 .Pp
 262 Show detailed information on current memory disks:
 263 .Bd -literal -offset indent
 264 mdconfig -lv
 265 .Ed
 266 .Pp
 267 Resize the
 268 .Dq Li md3
 269 memory disk to 2 gigabytes:
 270 .Bd -literal -offset indent
 271 mdconfig -rs 2g -u md3
 272 .Ed
 273 .Pp
 274 Create a 1 gigabyte swap backed disk, initialize an
 275 .Xr ffs 7
 276 file system on it, and mount it on
 277 .Pa /tmp :
 278 .Bd -literal -offset indent
 279 mdconfig -s 1g -u md10
 280 newfs -U /dev/md10
 281 mount /dev/md10 /tmp
 282 chmod 1777 /tmp
 283 .Ed
 284 .Pp
 285 Create a memory disk out of an ISO 9660 CD image file,
 286 using the first available
 287 .Xr md 4
 288 device, and then mount it:
 289 .Bd -literal -offset indent
 290 mount -t cd9660 /dev/`mdconfig -f cdimage.iso` /mnt
 291 .Ed
 292 .Pp
 293 Create a file-backed device from a hard disk image that begins
 294 with 512K of raw header information.
 295 .Xr gnop 8
 296 is used to skip over the header information, positioning
 297 .Pa md1.nop
 298 to the start of the filesystem in the image.
 299 .Bd -literal -offset indent
 300 mdconfig -u md1 -f diskimage.img
 301 gnop create -o 512K md1
 302 mount /dev/md1.nop /mnt
 303 .Ed
 304 .Sh SEE ALSO
 305 .Xr md 4 ,
 306 .Xr ffs 7 ,
 307 .Xr gpart 8 ,
 308 .Xr mdmfs 8 ,
 309 .Xr malloc 9
 310 .Sh HISTORY
 311 The
 312 .Nm
 313 utility first appeared in
 314 .Fx 5.0
 315 as a cleaner replacement for the
 316 .Xr vn 4
 317 and
 318 .Xr vnconfig 8
 319 combo.
 320 .Sh AUTHORS
 321 The
 322 .Nm
 323 utility was written by
 324 .An Poul-Henning Kamp Aq Mt phk@FreeBSD.org .