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