md.c revision 1.29 1 /* $NetBSD: md.c,v 1.29 2002/07/20 11:28:08 hannken Exp $ */
2
3 /*
4 * Copyright (c) 1995 Gordon W. Ross, Leo Weppelman.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 * 4. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by
20 * Gordon W. Ross and Leo Weppelman.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 /*
35 * This implements a general-purpose memory-disk.
36 * See md.h for notes on the config types.
37 *
38 * Note that this driver provides the same functionality
39 * as the MFS filesystem hack, but this is better because
40 * you can use this for any filesystem type you'd like!
41 *
42 * Credit for most of the kmem ramdisk code goes to:
43 * Leo Weppelman (atari) and Phil Nelson (pc532)
44 * Credit for the ideas behind the "user space memory" code goes
45 * to the authors of the MFS implementation.
46 */
47
48 #include <sys/cdefs.h>
49 __KERNEL_RCSID(0, "$NetBSD: md.c,v 1.29 2002/07/20 11:28:08 hannken Exp $");
50
51 #include "opt_md.h"
52
53 #include <sys/param.h>
54 #include <sys/kernel.h>
55 #include <sys/malloc.h>
56 #include <sys/systm.h>
57 #include <sys/buf.h>
58 #include <sys/device.h>
59 #include <sys/disk.h>
60 #include <sys/proc.h>
61 #include <sys/conf.h>
62 #include <sys/disklabel.h>
63
64 #include <uvm/uvm_extern.h>
65
66 #include <dev/md.h>
67
68 /*
69 * By default, include the user-space functionality.
70 * Use `options MEMORY_DISK_SERVER=0' to turn it off.
71 */
72 #ifndef MEMORY_DISK_SERVER
73 #define MEMORY_DISK_SERVER 1
74 #endif
75
76 /*
77 * We should use the raw partition for ioctl.
78 */
79 #define MD_MAX_UNITS 0x10
80 #define MD_UNIT(unit) DISKUNIT(unit)
81
82 /* autoconfig stuff... */
83
84 struct md_softc {
85 struct device sc_dev; /* REQUIRED first entry */
86 struct disk sc_dkdev; /* hook for generic disk handling */
87 struct md_conf sc_md;
88 struct bufq_state sc_buflist;
89 };
90 /* shorthand for fields in sc_md: */
91 #define sc_addr sc_md.md_addr
92 #define sc_size sc_md.md_size
93 #define sc_type sc_md.md_type
94
95 void mdattach __P((int));
96 static void md_attach __P((struct device *, struct device *, void *));
97
98 void mdstrategy __P((struct buf *bp));
99 struct dkdriver mddkdriver = { mdstrategy };
100
101 static int ramdisk_ndevs;
102 static void *ramdisk_devs[MD_MAX_UNITS];
103
104 /*
105 * This is called if we are configured as a pseudo-device
106 */
107 void
108 mdattach(n)
109 int n;
110 {
111 struct md_softc *sc;
112 int i;
113
114 #ifdef DIAGNOSTIC
115 if (ramdisk_ndevs) {
116 printf("ramdisk: multiple attach calls?\n");
117 return;
118 }
119 #endif
120
121 /* XXX: Are we supposed to provide a default? */
122 if (n <= 1)
123 n = 1;
124 if (n > MD_MAX_UNITS)
125 n = MD_MAX_UNITS;
126 ramdisk_ndevs = n;
127
128 /* Attach as if by autoconfig. */
129 for (i = 0; i < n; i++) {
130
131 sc = malloc(sizeof(*sc), M_DEVBUF, M_NOWAIT|M_ZERO);
132 if (!sc) {
133 printf("ramdisk: malloc for attach failed!\n");
134 return;
135 }
136 ramdisk_devs[i] = sc;
137 sc->sc_dev.dv_unit = i;
138 sprintf(sc->sc_dev.dv_xname, "md%d", i);
139 md_attach(NULL, &sc->sc_dev, NULL);
140 }
141 }
142
143 static void
144 md_attach(parent, self, aux)
145 struct device *parent, *self;
146 void *aux;
147 {
148 struct md_softc *sc = (struct md_softc *)self;
149
150 bufq_init(&sc->sc_buflist, BUFQ_FCFS);
151
152 /* XXX - Could accept aux info here to set the config. */
153 #ifdef MEMORY_DISK_HOOKS
154 /*
155 * This external function might setup a pre-loaded disk.
156 * All it would need to do is setup the md_conf struct.
157 * See sys/dev/md_root.c for an example.
158 */
159 md_attach_hook(sc->sc_dev.dv_unit, &sc->sc_md);
160 #endif
161
162 /*
163 * Initialize and attach the disk structure.
164 */
165 sc->sc_dkdev.dk_driver = &mddkdriver;
166 sc->sc_dkdev.dk_name = sc->sc_dev.dv_xname;
167 disk_attach(&sc->sc_dkdev);
168 }
169
170 /*
171 * operational routines:
172 * open, close, read, write, strategy,
173 * ioctl, dump, size
174 */
175
176 #if MEMORY_DISK_SERVER
177 static int md_server_loop __P((struct md_softc *sc));
178 static int md_ioctl_server __P((struct md_softc *sc,
179 struct md_conf *umd, struct proc *proc));
180 #endif
181 static int md_ioctl_kalloc __P((struct md_softc *sc,
182 struct md_conf *umd, struct proc *proc));
183
184 dev_type_open(mdopen);
185 dev_type_close(mdclose);
186 dev_type_read(mdread);
187 dev_type_write(mdwrite);
188 dev_type_ioctl(mdioctl);
189 dev_type_size(mdsize);
190 dev_type_dump(mddump);
191
192 int
193 mddump(dev, blkno, va, size)
194 dev_t dev;
195 daddr_t blkno;
196 caddr_t va;
197 size_t size;
198 {
199 return ENODEV;
200 }
201
202 int
203 mdsize(dev_t dev)
204 {
205 int unit;
206 struct md_softc *sc;
207
208 unit = MD_UNIT(dev);
209 if (unit >= ramdisk_ndevs)
210 return 0;
211 sc = ramdisk_devs[unit];
212 if (sc == NULL)
213 return 0;
214
215 if (sc->sc_type == MD_UNCONFIGURED)
216 return 0;
217
218 return (sc->sc_size >> DEV_BSHIFT);
219 }
220
221 int
222 mdopen(dev, flag, fmt, proc)
223 dev_t dev;
224 int flag, fmt;
225 struct proc *proc;
226 {
227 int unit;
228 struct md_softc *sc;
229
230 unit = MD_UNIT(dev);
231 if (unit >= ramdisk_ndevs)
232 return ENXIO;
233 sc = ramdisk_devs[unit];
234 if (sc == NULL)
235 return ENXIO;
236
237 /*
238 * The raw partition is used for ioctl to configure.
239 */
240 if (DISKPART(dev) == RAW_PART)
241 return 0;
242
243 #ifdef MEMORY_DISK_HOOKS
244 /* Call the open hook to allow loading the device. */
245 md_open_hook(unit, &sc->sc_md);
246 #endif
247
248 /*
249 * This is a normal, "slave" device, so
250 * enforce initialized.
251 */
252 if (sc->sc_type == MD_UNCONFIGURED)
253 return ENXIO;
254
255 return 0;
256 }
257
258 int
259 mdclose(dev, flag, fmt, proc)
260 dev_t dev;
261 int flag, fmt;
262 struct proc *proc;
263 {
264 int unit;
265
266 unit = MD_UNIT(dev);
267
268 if (unit >= ramdisk_ndevs)
269 return ENXIO;
270
271 return 0;
272 }
273
274 int
275 mdread(dev, uio, flags)
276 dev_t dev;
277 struct uio *uio;
278 int flags;
279 {
280 int unit;
281 struct md_softc *sc;
282
283 unit = MD_UNIT(dev);
284
285 if (unit >= ramdisk_ndevs)
286 return ENXIO;
287
288 sc = ramdisk_devs[unit];
289
290 if (sc->sc_type == MD_UNCONFIGURED)
291 return ENXIO;
292
293 return (physio(mdstrategy, NULL, dev, B_READ, minphys, uio));
294 }
295
296 int
297 mdwrite(dev, uio, flags)
298 dev_t dev;
299 struct uio *uio;
300 int flags;
301 {
302 int unit;
303 struct md_softc *sc;
304
305 unit = MD_UNIT(dev);
306
307 if (unit >= ramdisk_ndevs)
308 return ENXIO;
309
310 sc = ramdisk_devs[unit];
311
312 if (sc->sc_type == MD_UNCONFIGURED)
313 return ENXIO;
314
315 return (physio(mdstrategy, NULL, dev, B_WRITE, minphys, uio));
316 }
317
318 /*
319 * Handle I/O requests, either directly, or
320 * by passing them to the server process.
321 */
322 void
323 mdstrategy(bp)
324 struct buf *bp;
325 {
326 int unit;
327 struct md_softc *sc;
328 caddr_t addr;
329 size_t off, xfer;
330
331 unit = MD_UNIT(bp->b_dev);
332 sc = ramdisk_devs[unit];
333
334 if (sc->sc_type == MD_UNCONFIGURED) {
335 bp->b_error = ENXIO;
336 bp->b_flags |= B_ERROR;
337 goto done;
338 }
339
340 switch (sc->sc_type) {
341 #if MEMORY_DISK_SERVER
342 case MD_UMEM_SERVER:
343 /* Just add this job to the server's queue. */
344 BUFQ_PUT(&sc->sc_buflist, bp);
345 wakeup((caddr_t)sc);
346 /* see md_server_loop() */
347 /* no biodone in this case */
348 return;
349 #endif /* MEMORY_DISK_SERVER */
350
351 case MD_KMEM_FIXED:
352 case MD_KMEM_ALLOCATED:
353 /* These are in kernel space. Access directly. */
354 bp->b_resid = bp->b_bcount;
355 off = (bp->b_blkno << DEV_BSHIFT);
356 if (off >= sc->sc_size) {
357 if (bp->b_flags & B_READ)
358 break; /* EOF */
359 goto set_eio;
360 }
361 xfer = bp->b_resid;
362 if (xfer > (sc->sc_size - off))
363 xfer = (sc->sc_size - off);
364 addr = sc->sc_addr + off;
365 if (bp->b_flags & B_READ)
366 memcpy(bp->b_data, addr, xfer);
367 else
368 memcpy(addr, bp->b_data, xfer);
369 bp->b_resid -= xfer;
370 break;
371
372 default:
373 bp->b_resid = bp->b_bcount;
374 set_eio:
375 bp->b_error = EIO;
376 bp->b_flags |= B_ERROR;
377 break;
378 }
379 done:
380 biodone(bp);
381 }
382
383 int
384 mdioctl(dev, cmd, data, flag, proc)
385 dev_t dev;
386 u_long cmd;
387 int flag;
388 caddr_t data;
389 struct proc *proc;
390 {
391 int unit;
392 struct md_softc *sc;
393 struct md_conf *umd;
394
395 unit = MD_UNIT(dev);
396 sc = ramdisk_devs[unit];
397
398 /* If this is not the raw partition, punt! */
399 if (DISKPART(dev) != RAW_PART)
400 return ENOTTY;
401
402 umd = (struct md_conf *)data;
403 switch (cmd) {
404 case MD_GETCONF:
405 *umd = sc->sc_md;
406 return 0;
407
408 case MD_SETCONF:
409 /* Can only set it once. */
410 if (sc->sc_type != MD_UNCONFIGURED)
411 break;
412 switch (umd->md_type) {
413 case MD_KMEM_ALLOCATED:
414 return md_ioctl_kalloc(sc, umd, proc);
415 #if MEMORY_DISK_SERVER
416 case MD_UMEM_SERVER:
417 return md_ioctl_server(sc, umd, proc);
418 #endif
419 default:
420 break;
421 }
422 break;
423 }
424 return EINVAL;
425 }
426
427 /*
428 * Handle ioctl MD_SETCONF for (sc_type == MD_KMEM_ALLOCATED)
429 * Just allocate some kernel memory and return.
430 */
431 static int
432 md_ioctl_kalloc(sc, umd, proc)
433 struct md_softc *sc;
434 struct md_conf *umd;
435 struct proc *proc;
436 {
437 vaddr_t addr;
438 vsize_t size;
439
440 /* Sanity check the size. */
441 size = umd->md_size;
442 addr = uvm_km_zalloc(kernel_map, size);
443 if (!addr)
444 return ENOMEM;
445
446 /* This unit is now configured. */
447 sc->sc_addr = (caddr_t)addr; /* kernel space */
448 sc->sc_size = (size_t)size;
449 sc->sc_type = MD_KMEM_ALLOCATED;
450 return 0;
451 }
452
453 #if MEMORY_DISK_SERVER
454
455 /*
456 * Handle ioctl MD_SETCONF for (sc_type == MD_UMEM_SERVER)
457 * Set config, then become the I/O server for this unit.
458 */
459 static int
460 md_ioctl_server(sc, umd, proc)
461 struct md_softc *sc;
462 struct md_conf *umd;
463 struct proc *proc;
464 {
465 vaddr_t end;
466 int error;
467
468 /* Sanity check addr, size. */
469 end = (vaddr_t) (umd->md_addr + umd->md_size);
470
471 if ((end >= VM_MAXUSER_ADDRESS) ||
472 (end < ((vaddr_t) umd->md_addr)) )
473 return EINVAL;
474
475 /* This unit is now configured. */
476 sc->sc_addr = umd->md_addr; /* user space */
477 sc->sc_size = umd->md_size;
478 sc->sc_type = MD_UMEM_SERVER;
479
480 /* Become the server daemon */
481 error = md_server_loop(sc);
482
483 /* This server is now going away! */
484 sc->sc_type = MD_UNCONFIGURED;
485 sc->sc_addr = 0;
486 sc->sc_size = 0;
487
488 return (error);
489 }
490
491 int md_sleep_pri = PWAIT | PCATCH;
492
493 static int
494 md_server_loop(sc)
495 struct md_softc *sc;
496 {
497 struct buf *bp;
498 caddr_t addr; /* user space address */
499 size_t off; /* offset into "device" */
500 size_t xfer; /* amount to transfer */
501 int error;
502
503 for (;;) {
504 /* Wait for some work to arrive. */
505 while ((bp = BUFQ_GET(&sc->sc_buflist)) == NULL) {
506 error = tsleep((caddr_t)sc, md_sleep_pri, "md_idle", 0);
507 if (error)
508 return error;
509 }
510
511 /* Do the transfer to/from user space. */
512 error = 0;
513 bp->b_resid = bp->b_bcount;
514 off = (bp->b_blkno << DEV_BSHIFT);
515 if (off >= sc->sc_size) {
516 if (bp->b_flags & B_READ)
517 goto done; /* EOF (not an error) */
518 error = EIO;
519 goto done;
520 }
521 xfer = bp->b_resid;
522 if (xfer > (sc->sc_size - off))
523 xfer = (sc->sc_size - off);
524 addr = sc->sc_addr + off;
525 if (bp->b_flags & B_READ)
526 error = copyin(addr, bp->b_data, xfer);
527 else
528 error = copyout(bp->b_data, addr, xfer);
529 if (!error)
530 bp->b_resid -= xfer;
531
532 done:
533 if (error) {
534 bp->b_error = error;
535 bp->b_flags |= B_ERROR;
536 }
537 biodone(bp);
538 }
539 }
540 #endif /* MEMORY_DISK_SERVER */
541