2 * Copyright (c) 2004-2006 Apple Computer, Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * Copyright (c) 1988 University of Utah.
30 * Copyright (c) 1990, 1993
31 * The Regents of the University of California. All rights reserved.
33 * This code is derived from software contributed to Berkeley by
34 * the Systems Programming Group of the University of Utah Computer
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
40 * 1. Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
45 * 3. All advertising materials mentioning features or use of this software
46 * must display the following acknowledgement:
47 * This product includes software developed by the University of
48 * California, Berkeley and its contributors.
49 * 4. Neither the name of the University nor the names of its contributors
50 * may be used to endorse or promote products derived from this software
51 * without specific prior written permission.
53 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65 * from: Utah Hdr: vn.c 1.13 94/04/02
67 * from: @(#)vn.c 8.6 (Berkeley) 4/1/94
68 * $FreeBSD: src/sys/dev/vn/vn.c,v 1.105.2.4 2001/11/18 07:11:00 dillon Exp $
74 * Block interface to a ramdisk.
78 #include <sys/param.h>
79 #include <sys/kernel.h>
80 #include <sys/mount.h>
81 #include <sys/namei.h>
84 #include <sys/malloc.h>
85 #include <sys/mount.h>
86 #include <sys/fcntl.h>
91 #include <sys/uio_internal.h>
92 #include <libkern/libkern.h>
95 #include <vm/vm_pager.h>
96 #include <mach/memory_object_types.h>
97 #include <kern/debug.h>
99 #include <miscfs/devfs/devfs.h>
102 void mdevinit(int the_cnt
);
104 static open_close_fcn_t mdevopen
;
105 static open_close_fcn_t mdevclose
;
106 static psize_fcn_t mdevsize
;
107 static strategy_fcn_t mdevstrategy
;
108 static int mdevbioctl(dev_t dev
, u_long cmd
, caddr_t data
, int flag
, struct proc
*p
);
109 static int mdevcioctl(dev_t dev
, u_long cmd
, caddr_t data
, int flag
, struct proc
*p
);
110 static int mdevrw(dev_t dev
, struct uio
*uio
, int ioflag
);
111 static char * nonspace(char *pos
, char *end
);
112 static char * getspace(char *pos
, char *end
);
113 static char * cvtnum(char *pos
, char *end
, unsigned int *num
);
115 extern void bcopy_phys(addr64_t from
, addr64_t to
, vm_size_t bytes
);
116 extern void mapping_set_mod(ppnum_t pn
);
117 extern ppnum_t
pmap_find_phys(pmap_t pmap
, addr64_t va
);
122 * D_DISK we want to look like a disk
123 * D_CANFREE We support B_FREEBUF
126 static struct bdevsw mdevbdevsw
= {
128 /* close */ mdevclose
,
129 /* strategy */ mdevstrategy
,
130 /* ioctl */ mdevbioctl
,
132 /* psize */ mdevsize
,
136 static struct cdevsw mdevcdevsw
= {
138 /* close */ mdevclose
,
141 /* ioctl */ mdevcioctl
,
143 /* reset */ eno_reset
,
145 /* select */ eno_select
,
147 /* strategy */ eno_strat
,
154 vm_offset_t mdBase
; /* file size in bytes */
155 uint32_t mdSize
; /* file size in bytes */
156 int mdFlags
; /* flags */
157 int mdSecsize
; /* sector size */
158 int mdBDev
; /* Block device number */
159 int mdCDev
; /* Character device number */
165 #define mdInited 0x01 /* This device defined */
166 #define mdRO 0x02 /* This device is read-only */
167 #define mdPhys 0x04 /* This device is in physical memory */
172 static int mdevioctl(dev_t dev
, u_long cmd
, caddr_t data
, int flag
, struct proc
*p
, int is_char
);
173 dev_t
mdevadd(int devid
, ppnum_t base
, unsigned int size
, int phys
);
174 dev_t
mdevlookup(int devid
);
175 void mdevremoveall(void);
177 static int mdevclose(__unused dev_t dev
, __unused
int flags
,
178 __unused
int devtype
, __unused
struct proc
*p
) {
183 static int mdevopen(dev_t dev
, int flags
, __unused
int devtype
, __unused
struct proc
*p
) {
187 devid
= minor(dev
); /* Get minor device number */
189 if (devid
> 16) return (ENXIO
); /* Not valid */
191 if ((flags
& FWRITE
) && (mdev
[devid
].mdFlags
& mdRO
)) return (EACCES
); /* Currently mounted RO */
196 static int mdevrw(dev_t dev
, struct uio
*uio
, __unused
int ioflag
) {
200 enum uio_seg saveflag
;
202 devid
= minor(dev
); /* Get minor device number */
204 if (devid
> 16) return (ENXIO
); /* Not valid */
205 if (!(mdev
[devid
].mdFlags
& mdInited
)) return (ENXIO
); /* Have we actually been defined yet? */
207 mdata
= ((addr64_t
)mdev
[devid
].mdBase
<< 12) + uio
->uio_offset
; /* Point to the area in "file" */
209 saveflag
= uio
->uio_segflg
; /* Remember what the request is */
211 if (IS_VALID_UIO_SEGFLG(uio
->uio_segflg
) == 0) {
212 panic("mdevrw - invalid uio_segflg\n");
214 #endif /* LP64_DEBUG */
215 /* Make sure we are moving from physical ram if physical device */
216 if (mdev
[devid
].mdFlags
& mdPhys
) {
217 if (uio
->uio_segflg
== UIO_USERSPACE64
)
218 uio
->uio_segflg
= UIO_PHYS_USERSPACE64
;
219 else if (uio
->uio_segflg
== UIO_USERSPACE32
)
220 uio
->uio_segflg
= UIO_PHYS_USERSPACE32
;
222 uio
->uio_segflg
= UIO_PHYS_USERSPACE
;
224 status
= uiomove64(mdata
, uio_resid(uio
), uio
); /* Move the data */
225 uio
->uio_segflg
= saveflag
; /* Restore the flag */
230 static void mdevstrategy(struct buf
*bp
) {
231 unsigned int left
, lop
, csize
;
232 vm_offset_t vaddr
, blkoff
;
234 addr64_t paddr
, fvaddr
;
237 devid
= minor(buf_device(bp
)); /* Get minor device number */
239 if ((mdev
[devid
].mdFlags
& mdInited
) == 0) { /* Have we actually been defined yet? */
240 buf_seterror(bp
, ENXIO
);
245 buf_setresid(bp
, buf_count(bp
)); /* Set byte count */
247 blkoff
= buf_blkno(bp
) * mdev
[devid
].mdSecsize
; /* Get offset into file */
250 * Note that reading past end is an error, but reading at end is an EOF. For these
251 * we just return with resid == count.
254 if (blkoff
>= (mdev
[devid
].mdSize
<< 12)) { /* Are they trying to read/write at/after end? */
255 if(blkoff
!= (mdev
[devid
].mdSize
<< 12)) { /* Are we trying to read after EOF? */
256 buf_seterror(bp
, EINVAL
); /* Yeah, this is an error */
258 buf_biodone(bp
); /* Return */
262 if ((blkoff
+ buf_count(bp
)) > (mdev
[devid
].mdSize
<< 12)) { /* Will this read go past end? */
263 buf_setcount(bp
, ((mdev
[devid
].mdSize
<< 12) - blkoff
)); /* Yes, trim to max */
266 * make sure the buffer's data area is
269 if (buf_map(bp
, (caddr_t
*)&vaddr
))
270 panic("ramstrategy: buf_map failed\n");
272 fvaddr
= (mdev
[devid
].mdBase
<< 12) + blkoff
; /* Point to offset into ram disk */
274 if (buf_flags(bp
) & B_READ
) { /* Is this a read? */
275 if(!(mdev
[devid
].mdFlags
& mdPhys
)) { /* Physical mapped disk? */
276 bcopy((void *)((uintptr_t)fvaddr
),
277 (void *)vaddr
, (size_t)buf_count(bp
)); /* This is virtual, just get the data */
280 left
= buf_count(bp
); /* Init the amount left to copy */
281 while(left
) { /* Go until it is all copied */
283 lop
= min((4096 - (vaddr
& 4095)), (4096 - (fvaddr
& 4095))); /* Get smallest amount left on sink and source */
284 csize
= min(lop
, left
); /* Don't move more than we need to */
286 pp
= pmap_find_phys(kernel_pmap
, (addr64_t
)((unsigned int)vaddr
)); /* Get the sink physical address */
287 if(!pp
) { /* Not found, what gives? */
288 panic("mdevstrategy: sink address %016llX not mapped\n", (addr64_t
)((unsigned int)vaddr
));
290 paddr
= (addr64_t
)(((addr64_t
)pp
<< 12) | (addr64_t
)(vaddr
& 4095)); /* Get actual address */
291 bcopy_phys(fvaddr
, paddr
, csize
); /* Copy this on in */
292 mapping_set_mod(paddr
>> 12); /* Make sure we know that it is modified */
294 left
= left
- csize
; /* Calculate what is left */
295 vaddr
= vaddr
+ csize
; /* Move to next sink address */
296 fvaddr
= fvaddr
+ csize
; /* Bump to next physical address */
300 else { /* This is a write */
301 if(!(mdev
[devid
].mdFlags
& mdPhys
)) { /* Physical mapped disk? */
302 bcopy((void *)vaddr
, (void *)((uintptr_t)fvaddr
),
303 (size_t)buf_count(bp
)); /* This is virtual, just put the data */
306 left
= buf_count(bp
); /* Init the amount left to copy */
307 while(left
) { /* Go until it is all copied */
309 lop
= min((4096 - (vaddr
& 4095)), (4096 - (fvaddr
& 4095))); /* Get smallest amount left on sink and source */
310 csize
= min(lop
, left
); /* Don't move more than we need to */
312 pp
= pmap_find_phys(kernel_pmap
, (addr64_t
)((unsigned int)vaddr
)); /* Get the source physical address */
313 if(!pp
) { /* Not found, what gives? */
314 panic("mdevstrategy: source address %016llX not mapped\n", (addr64_t
)((unsigned int)vaddr
));
316 paddr
= (addr64_t
)(((addr64_t
)pp
<< 12) | (addr64_t
)(vaddr
& 4095)); /* Get actual address */
318 bcopy_phys(paddr
, fvaddr
, csize
); /* Move this on out */
320 left
= left
- csize
; /* Calculate what is left */
321 vaddr
= vaddr
+ csize
; /* Move to next sink address */
322 fvaddr
= fvaddr
+ csize
; /* Bump to next physical address */
327 * buf_unmap takes care of all the cases
328 * it will unmap the buffer from kernel
329 * virtual space if that was the state
334 buf_setresid(bp
, 0); /* Nothing more to do */
335 buf_biodone(bp
); /* Say we've finished */
338 static int mdevbioctl(dev_t dev
, u_long cmd
, caddr_t data
, int flag
, struct proc
*p
) {
339 return (mdevioctl(dev
, cmd
, data
, flag
, p
, 0));
342 static int mdevcioctl(dev_t dev
, u_long cmd
, caddr_t data
, int flag
, struct proc
*p
) {
343 return (mdevioctl(dev
, cmd
, data
, flag
, p
, 1));
346 static int mdevioctl(dev_t dev
, u_long cmd
, caddr_t data
, __unused
int flag
,
347 struct proc
*p
, int is_char
) {
353 devid
= minor(dev
); /* Get minor device number */
355 if (devid
> 16) return (ENXIO
); /* Not valid */
357 error
= proc_suser(p
); /* Are we superman? */
358 if (error
) return (error
); /* Nope... */
361 o
= (u_int64_t
*)data
;
365 case DKIOCGETMAXBLOCKCOUNTREAD
:
369 case DKIOCGETMAXBLOCKCOUNTWRITE
:
373 case DKIOCGETMAXSEGMENTCOUNTREAD
:
377 case DKIOCGETMAXSEGMENTCOUNTWRITE
:
381 case DKIOCGETBLOCKSIZE
:
382 *f
= mdev
[devid
].mdSecsize
;
385 case DKIOCSETBLOCKSIZE
:
386 if (is_char
) return (ENODEV
); /* We can only do this for a block */
388 if (*f
< DEV_BSIZE
) return (EINVAL
); /* Too short? */
390 mdev
[devid
].mdSecsize
= *f
; /* set the new block size */
393 case DKIOCISWRITABLE
:
397 case DKIOCGETBLOCKCOUNT32
:
398 if(!(mdev
[devid
].mdFlags
& mdInited
)) return (ENXIO
);
399 *f
= ((mdev
[devid
].mdSize
<< 12) + mdev
[devid
].mdSecsize
- 1) / mdev
[devid
].mdSecsize
;
402 case DKIOCGETBLOCKCOUNT
:
403 if(!(mdev
[devid
].mdFlags
& mdInited
)) return (ENXIO
);
404 *o
= ((mdev
[devid
].mdSize
<< 12) + mdev
[devid
].mdSecsize
- 1) / mdev
[devid
].mdSecsize
;
415 static int mdevsize(dev_t dev
) {
419 devid
= minor(dev
); /* Get minor device number */
420 if (devid
> 16) return (ENXIO
); /* Not valid */
422 if ((mdev
[devid
].mdFlags
& mdInited
) == 0) return(-1); /* Not inited yet */
424 return(mdev
[devid
].mdSecsize
);
427 #include <pexpert/pexpert.h>
429 void mdevinit(__unused
int the_cnt
) {
438 ba
= PE_boot_args(); /* Get the boot arguments */
439 lp
= ba
+ 256; /* Point to the end */
441 while(1) { /* Step through, looking for our keywords */
442 phys
= 0; /* Assume virtual memory device */
443 ba
= nonspace(ba
, lp
); /* Find non-space */
444 if(ba
>= lp
) return; /* We are done if no more... */
445 if(((ba
[0] != 'v') && (ba
[0] != 'p'))
446 || (ba
[1] != 'm') || (ba
[2] != 'd') || (ba
[4] != '=')
447 || (ba
[3] < '0') || (ba
[3] > 'f')
448 || ((ba
[3] > '9') && (ba
[3] < 'a'))) { /* Is this of form "vmdx=" or "pmdx=" where x is hex digit? */
450 ba
= getspace(ba
, lp
); /* Find next white space or end */
451 continue; /* Start looking for the next one */
454 if(ba
[0] == 'p') phys
= 1; /* Set physical memory disk */
456 devid
= ba
[3] & 0xF; /* Assume digit */
457 if(ba
[3] > '9') devid
+= 9; /* Adjust for hex digits */
459 ba
= &ba
[5]; /* Step past keyword */
460 ba
= cvtnum(ba
, lp
, &base
); /* Convert base of memory disk */
461 if(ba
>= lp
) return; /* Malformed one at the end, leave */
462 if(ba
[0] != '.') continue; /* If not length separater, try next... */
463 if(base
& 0xFFF) continue; /* Only allow page aligned stuff */
465 ba
++; /* Step past '.' */
466 ba
= cvtnum(ba
, lp
, &size
); /* Try to convert it */
467 if(!size
|| (size
& 0xFFF)) continue; /* Allow only non-zer page size multiples */
468 if(ba
< lp
) { /* If we are not at end, check end character */
469 if((ba
[0] != ' ') && (ba
[0] != 0)) continue; /* End must be null or space */
472 dev
= mdevadd(devid
, base
>> 12, size
>> 12, phys
); /* Go add the device */
479 char *nonspace(char *pos
, char *end
) { /* Find next non-space in string */
481 if(pos
>= end
) return end
; /* Don't go past end */
482 if(pos
[0] == 0) return end
; /* If at null, make end */
484 while(1) { /* Keep going */
485 if(pos
[0] != ' ') return pos
; /* Leave if we found one */
487 if(pos
>= end
) return end
; /* Quit if we run off end */
491 char *getspace(char *pos
, char *end
) { /* Find next non-space in string */
493 while(1) { /* Keep going */
494 if(pos
>= end
) return end
; /* Don't go past end */
495 if(pos
[0] == 0) return end
; /* Leave if we hit null */
496 if(pos
[0] == ' ') return pos
; /* Leave if we found one */
501 char *cvtnum(char *pos
, char *end
, unsigned int *num
) { /* Convert to a number */
505 *num
= 0; /* Set answer to 0 to start */
508 if(pos
>= end
) return end
; /* Don't go past end */
509 if(pos
[0] == 0) return end
; /* If at null, make end */
511 if(pos
[0] == '0' && ((pos
[1] == 'x') || (pos
[1] == 'x'))) { /* A hex constant? */
513 pos
+= 2; /* Point to the number */
516 while(1) { /* Convert it */
518 if(pos
>= end
) return end
; /* Don't go past end */
519 if(pos
[0] == 0) return end
; /* If at null, make end */
520 if(pos
[0] < '0') return pos
; /* Leave if non-digit */
521 dig
= pos
[0] & 0xF; /* Extract digit */
522 if(pos
[0] > '9') { /* Is it bigger than 9? */
523 if(rad
== 10) return pos
; /* Leave if not base 10 */
524 if(!(((pos
[0] >= 'A') && (pos
[0] <= 'F'))
525 || ((pos
[0] >= 'a') && (pos
[0] <= 'f')))) return pos
; /* Leave if bogus char */
526 dig
= dig
+ 9; /* Adjust for character */
528 *num
= (*num
* rad
) + dig
; /* Accumulate the number */
533 dev_t
mdevadd(int devid
, ppnum_t base
, unsigned int size
, int phys
) {
540 for(i
= 0; i
< 16; i
++) { /* Search all known memory devices */
541 if(!(mdev
[i
].mdFlags
& mdInited
)) { /* Is this a free one? */
542 if(devid
< 0)devid
= i
; /* Remember first free one */
543 continue; /* Skip check */
545 if(!(((base
+ size
-1 ) < mdev
[i
].mdBase
) || ((mdev
[i
].mdBase
+ mdev
[i
].mdSize
- 1) < base
))) { /* Is there any overlap? */
546 panic("mdevadd: attempt to add overlapping memory device at %08X-%08X\n", mdev
[i
].mdBase
, mdev
[i
].mdBase
+ mdev
[i
].mdSize
- 1);
549 if(devid
< 0) { /* Do we have free slots? */
550 panic("mdevadd: attempt to add more than 16 memory devices\n");
554 if(devid
>= 16) { /* Giving us something bogus? */
555 panic("mdevadd: attempt to explicitly add a bogus memory device: %08X\n", devid
);
557 if(mdev
[devid
].mdFlags
&mdInited
) { /* Already there? */
558 panic("mdevadd: attempt to explicitly add a previously defined memory device: %08X\n", devid
);
562 if(mdevBMajor
< 0) { /* Have we gotten a major number yet? */
563 mdevBMajor
= bdevsw_add(-1, &mdevbdevsw
); /* Add to the table and figure out a major number */
564 if (mdevBMajor
< 0) {
565 printf("mdevadd: error - bdevsw_add() returned %d\n", mdevBMajor
);
570 if(mdevCMajor
< 0) { /* Have we gotten a major number yet? */
571 mdevCMajor
= cdevsw_add_with_bdev(-1, &mdevcdevsw
, mdevBMajor
); /* Add to the table and figure out a major number */
572 if (mdevCMajor
< 0) {
573 printf("ramdevice_init: error - cdevsw_add() returned %d\n", mdevCMajor
);
578 mdev
[devid
].mdBDev
= makedev(mdevBMajor
, devid
); /* Get the device number */
579 mdev
[devid
].mdbdevb
= devfs_make_node(mdev
[devid
].mdBDev
, DEVFS_BLOCK
, /* Make the node */
580 UID_ROOT
, GID_OPERATOR
,
581 0600, "md%d", devid
);
582 if (mdev
[devid
].mdbdevb
== NULL
) { /* Did we make one? */
583 printf("mdevadd: devfs_make_node for block failed!\n");
584 return -1; /* Nope... */
587 mdev
[devid
].mdCDev
= makedev(mdevCMajor
, devid
); /* Get the device number */
588 mdev
[devid
].mdcdevb
= devfs_make_node(mdev
[devid
].mdCDev
, DEVFS_CHAR
, /* Make the node */
589 UID_ROOT
, GID_OPERATOR
,
590 0600, "rmd%d", devid
);
591 if (mdev
[devid
].mdcdevb
== NULL
) { /* Did we make one? */
592 printf("mdevadd: devfs_make_node for character failed!\n");
593 return -1; /* Nope... */
596 mdev
[devid
].mdBase
= base
; /* Set the base address of ram disk */
597 mdev
[devid
].mdSize
= size
; /* Set the length of the ram disk */
598 mdev
[devid
].mdSecsize
= DEV_BSIZE
; /* Set starting block size */
599 if(phys
) mdev
[devid
].mdFlags
|= mdPhys
; /* Show that we are in physical memory */
600 mdev
[devid
].mdFlags
|= mdInited
; /* Show we are all set up */
601 printf("Added memory device md%x/rmd%x (%08X/%08X) at %08X for %08X\n",
602 devid
, devid
, mdev
[devid
].mdBDev
, mdev
[devid
].mdCDev
, base
<< 12, size
<< 12);
603 return mdev
[devid
].mdBDev
;
607 dev_t
mdevlookup(int devid
) {
609 if((devid
< 0) || (devid
> 15)) return -1; /* Filter any bogus requests */
610 if(!(mdev
[devid
].mdFlags
& mdInited
)) return -1; /* This one hasn't been defined */
611 return mdev
[devid
].mdBDev
; /* Return the device number */
614 void mdevremoveall(void) {
618 for(i
= 0; i
< 16; i
++) {
619 if(!(mdev
[i
].mdFlags
& mdInited
)) continue; /* Ignore unused mdevs */
621 devfs_remove(mdev
[i
].mdbdevb
); /* Remove the block device */
622 devfs_remove(mdev
[i
].mdcdevb
); /* Remove the character device */
624 mdev
[i
].mdBase
= 0; /* Clear the mdev's storage */
626 mdev
[i
].mdSecsize
= 0;