share/man/man7d/ramdisk.7d

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH RAMDISK 7D "Mar 04, 2003"
   7 .SH NAME
   8 ramdisk \- RAM disk device driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBramdisk@0:\fR\fIdiskname\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBramdisk\fR driver supports numerous ramdisk devices that are created by
  19 the system during the boot  process (see \fBboot\fR(8)) or during normal
  20 system operation (see \fBramdiskadm\fR(8) for more information).
  21 .SH DEVICE SPECIAL FILES
  22 .sp
  23 .LP
  24 Each ramdisk can be accessed either as a block device or as a raw device. When
  25 accessed as a block device, the normal buffering          mechanism is used
  26 when reading from and writing to the device, without regard to physical disk
  27 records. Accessing the ramdisk as a raw device enables direct transmission
  28 between the disk and the read or write buffer. A single read or write call
  29 usually results in a single  I/O operation, meaning that raw I/O is more
  30 efficient when many bytes are  transmitted. You can find block files names in
  31 \fB/dev/ramdisk\fR. Raw file names are found in \fB/dev/rramdisk\fR.
  32 .sp
  33 .LP
  34 There are no alignment or length restrictions on I/O requests to either block
  35 or character devices.
  36 .SH ERRORS
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBEFAULT\fR\fR
  41 .ad
  42 .RS 10n
  43 The argument features a bad address.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBEINVAL\fR\fR
  50 .ad
  51 .RS 10n
  52 Invalid argument. EIO. An I/O error occurred.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBEPERM\fR\fR
  59 .ad
  60 .RS 10n
  61 Cannot create or delete a ramdisk without write permission on
  62 \fB/dev/ramdiskctl\fR.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBENOTTY\fR\fR
  69 .ad
  70 .RS 10n
  71 The device does not support the requested ioctl function.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBENXIO\fR\fR
  78 .ad
  79 .RS 10n
  80 The device did not exist during opening.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBEBUSY\fR\fR
  87 .ad
  88 .RS 10n
  89 Cannot exclusively open \fB/dev/ramdiskctl\fR. One or more ramdisks are still
  90 open.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBEEXIST\fR\fR
  97 .ad
  98 .RS 10n
  99 A ramdisk with the indicated name already exists.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBEAGAIN\fR\fR
 106 .ad
 107 .RS 10n
 108 Cannot allocate resource for ramdisk. Try again later.
 109 .RE
 110
 111 .SH FILES
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB/dev/ramdisk/diskname\fR\fR
 116 .ad
 117 .sp .6
 118 .RS 4n
 119 Block device for ramdisk named \fIdiskname\fR.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fB/dev/rramdisk/diskname\fR\fR
 126 .ad
 127 .sp .6
 128 .RS 4n
 129 Raw device for ramdisk name \fIdiskname\fR
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fB/kernel/drv/ramdisk\fR\fR
 136 .ad
 137 .sp .6
 138 .RS 4n
 139 32-bit driver
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fB/kernel/drv/ramdisk.conf\fR\fR
 146 .ad
 147 .sp .6
 148 .RS 4n
 149 Driver configuration file. (Do not alter).
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fB/kernel/drv/sparcv9/ramdisk\fR\fR
 156 .ad
 157 .sp .6
 158 .RS 4n
 159 64-bit driver
 160 .RE
 161
 162 .SH ATTRIBUTES
 163 .sp
 164 .LP
 165 See \fBattributes\fR(5) for descriptions of the following attribute:
 166 .sp
 167
 168 .sp
 169 .TS
 170 box;
 171 c | c
 172 l | l .
 173 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 174 _
 175 Interface Stability     Evolving
 176 .TE
 177
 178 .SH SEE ALSO
 179 .sp
 180 .LP
 181 \fBramdiskadm\fR(8), \fBfsck\fR(8), \fBfstyp\fR(8), \fBmount\fR(8),
 182 \fBnewfs\fR(8), \fBdriver.conf\fR(4), \fBfilesystem\fR(5), \fBdkio\fR(7I)
 183 .SH NOTES
 184 .sp
 185 .LP
 186 The percentage of available physical memory that can be allocated to ramdisks
 187 is constrained by the variable \fBrd_percent_physmem\fR. You can tune the
 188 \fBrd_percent_physmem\fR variable in \fB/etc/system\fR. By default, the
 189 percentage of available physical memory that can be allocated to ramdisks is
 190 fixed at 25%.
 191 .sp
 192 .LP
 193 A ramdisk may not be the best possible use of system memory. Accordingly, use
 194 ramdisks only when absolutely necessary.