ld.c revision 1.96 1 /* $NetBSD: ld.c,v 1.96 2016/09/19 23:32:30 jdolecek Exp $ */
2
3 /*-
4 * Copyright (c) 1998, 2000 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Andrew Doran and Charles M. Hannum.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /*
33 * Disk driver for use by RAID controllers.
34 */
35
36 #include <sys/cdefs.h>
37 __KERNEL_RCSID(0, "$NetBSD: ld.c,v 1.96 2016/09/19 23:32:30 jdolecek Exp $");
38
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/device.h>
43 #include <sys/queue.h>
44 #include <sys/proc.h>
45 #include <sys/buf.h>
46 #include <sys/bufq.h>
47 #include <sys/endian.h>
48 #include <sys/disklabel.h>
49 #include <sys/disk.h>
50 #include <sys/dkio.h>
51 #include <sys/stat.h>
52 #include <sys/conf.h>
53 #include <sys/fcntl.h>
54 #include <sys/vnode.h>
55 #include <sys/syslog.h>
56 #include <sys/mutex.h>
57
58 #include <dev/ldvar.h>
59
60 #include <prop/proplib.h>
61
62 static void ldminphys(struct buf *bp);
63 static bool ld_suspend(device_t, const pmf_qual_t *);
64 static bool ld_shutdown(device_t, int);
65 static int ld_diskstart(device_t, struct buf *bp);
66 static void ld_iosize(device_t, int *);
67 static int ld_dumpblocks(device_t, void *, daddr_t, int);
68 static void ld_fake_geometry(struct ld_softc *);
69 static void ld_set_geometry(struct ld_softc *);
70 static void ld_config_interrupts (device_t);
71 static int ld_lastclose(device_t);
72 static int ld_discard(device_t, off_t, off_t);
73
74 extern struct cfdriver ld_cd;
75
76 static dev_type_open(ldopen);
77 static dev_type_close(ldclose);
78 static dev_type_read(ldread);
79 static dev_type_write(ldwrite);
80 static dev_type_ioctl(ldioctl);
81 static dev_type_strategy(ldstrategy);
82 static dev_type_dump(lddump);
83 static dev_type_size(ldsize);
84 static dev_type_discard(lddiscard);
85
86 const struct bdevsw ld_bdevsw = {
87 .d_open = ldopen,
88 .d_close = ldclose,
89 .d_strategy = ldstrategy,
90 .d_ioctl = ldioctl,
91 .d_dump = lddump,
92 .d_psize = ldsize,
93 .d_discard = lddiscard,
94 .d_flag = D_DISK | D_MPSAFE
95 };
96
97 const struct cdevsw ld_cdevsw = {
98 .d_open = ldopen,
99 .d_close = ldclose,
100 .d_read = ldread,
101 .d_write = ldwrite,
102 .d_ioctl = ldioctl,
103 .d_stop = nostop,
104 .d_tty = notty,
105 .d_poll = nopoll,
106 .d_mmap = nommap,
107 .d_kqfilter = nokqfilter,
108 .d_discard = lddiscard,
109 .d_flag = D_DISK | D_MPSAFE
110 };
111
112 static struct dkdriver lddkdriver = {
113 .d_open = ldopen,
114 .d_close = ldclose,
115 .d_strategy = ldstrategy,
116 .d_iosize = ld_iosize,
117 .d_minphys = ldminphys,
118 .d_diskstart = ld_diskstart,
119 .d_dumpblocks = ld_dumpblocks,
120 .d_lastclose = ld_lastclose,
121 .d_discard = ld_discard
122 };
123
124 void
125 ldattach(struct ld_softc *sc, const char *default_strategy)
126 {
127 device_t self = sc->sc_dv;
128 struct dk_softc *dksc = &sc->sc_dksc;
129
130 mutex_init(&sc->sc_mutex, MUTEX_DEFAULT, IPL_VM);
131 cv_init(&sc->sc_drain, "lddrain");
132
133 if ((sc->sc_flags & LDF_ENABLED) == 0) {
134 return;
135 }
136
137 /* Initialise dk and disk structure. */
138 dk_init(dksc, self, DKTYPE_LD);
139 disk_init(&dksc->sc_dkdev, dksc->sc_xname, &lddkdriver);
140
141 if (sc->sc_maxxfer > MAXPHYS)
142 sc->sc_maxxfer = MAXPHYS;
143
144 /* Build synthetic geometry if necessary. */
145 if (sc->sc_nheads == 0 || sc->sc_nsectors == 0 ||
146 sc->sc_ncylinders == 0)
147 ld_fake_geometry(sc);
148
149 sc->sc_disksize512 = sc->sc_secperunit * sc->sc_secsize / DEV_BSIZE;
150
151 /* Attach dk and disk subsystems */
152 dk_attach(dksc);
153 disk_attach(&dksc->sc_dkdev);
154 ld_set_geometry(sc);
155
156 bufq_alloc(&dksc->sc_bufq, default_strategy, BUFQ_SORT_RAWBLOCK);
157
158 /* Register with PMF */
159 if (!pmf_device_register1(dksc->sc_dev, ld_suspend, NULL, ld_shutdown))
160 aprint_error_dev(dksc->sc_dev,
161 "couldn't establish power handler\n");
162
163 /* Discover wedges on this disk. */
164 config_interrupts(sc->sc_dv, ld_config_interrupts);
165 }
166
167 int
168 ldadjqparam(struct ld_softc *sc, int xmax)
169 {
170
171 mutex_enter(&sc->sc_mutex);
172 sc->sc_maxqueuecnt = xmax;
173 mutex_exit(&sc->sc_mutex);
174
175 return (0);
176 }
177
178 int
179 ldbegindetach(struct ld_softc *sc, int flags)
180 {
181 struct dk_softc *dksc = &sc->sc_dksc;
182 int rv = 0;
183
184 if ((sc->sc_flags & LDF_ENABLED) == 0)
185 return (0);
186
187 rv = disk_begindetach(&dksc->sc_dkdev, ld_lastclose, dksc->sc_dev, flags);
188
189 if (rv != 0)
190 return rv;
191
192 mutex_enter(&sc->sc_mutex);
193 sc->sc_maxqueuecnt = 0;
194
195 while (sc->sc_queuecnt > 0) {
196 sc->sc_flags |= LDF_DRAIN;
197 cv_wait(&sc->sc_drain, &sc->sc_mutex);
198 }
199 mutex_exit(&sc->sc_mutex);
200
201 return (rv);
202 }
203
204 void
205 ldenddetach(struct ld_softc *sc)
206 {
207 struct dk_softc *dksc = &sc->sc_dksc;
208 int bmaj, cmaj, i, mn;
209
210 if ((sc->sc_flags & LDF_ENABLED) == 0)
211 return;
212
213 mutex_enter(&sc->sc_mutex);
214
215 /* Wait for commands queued with the hardware to complete. */
216 if (sc->sc_queuecnt != 0) {
217 if (cv_timedwait(&sc->sc_drain, &sc->sc_mutex, 30 * hz))
218 printf("%s: not drained\n", dksc->sc_xname);
219 }
220 mutex_exit(&sc->sc_mutex);
221
222 /* Kill off any queued buffers. */
223 dk_drain(dksc);
224 bufq_free(dksc->sc_bufq);
225
226 /* Locate the major numbers. */
227 bmaj = bdevsw_lookup_major(&ld_bdevsw);
228 cmaj = cdevsw_lookup_major(&ld_cdevsw);
229
230 /* Nuke the vnodes for any open instances. */
231 for (i = 0; i < MAXPARTITIONS; i++) {
232 mn = DISKMINOR(device_unit(dksc->sc_dev), i);
233 vdevgone(bmaj, mn, mn, VBLK);
234 vdevgone(cmaj, mn, mn, VCHR);
235 }
236
237 /* Delete all of our wedges. */
238 dkwedge_delall(&dksc->sc_dkdev);
239
240 /* Detach from the disk list. */
241 disk_detach(&dksc->sc_dkdev);
242 disk_destroy(&dksc->sc_dkdev);
243
244 dk_detach(dksc);
245
246 /* Deregister with PMF */
247 pmf_device_deregister(dksc->sc_dev);
248
249 /*
250 * XXX We can't really flush the cache here, beceause the
251 * XXX device may already be non-existent from the controller's
252 * XXX perspective.
253 */
254 #if 0
255 /* Flush the device's cache. */
256 if (sc->sc_flush != NULL)
257 if ((*sc->sc_flush)(sc, 0) != 0)
258 device_printf(dksc->sc_dev, "unable to flush cache\n");
259 #endif
260 cv_destroy(&sc->sc_drain);
261 mutex_destroy(&sc->sc_mutex);
262 }
263
264 /* ARGSUSED */
265 static bool
266 ld_suspend(device_t dev, const pmf_qual_t *qual)
267 {
268 return ld_shutdown(dev, 0);
269 }
270
271 /* ARGSUSED */
272 static bool
273 ld_shutdown(device_t dev, int flags)
274 {
275 struct ld_softc *sc = device_private(dev);
276 struct dk_softc *dksc = &sc->sc_dksc;
277
278 if (sc->sc_flush != NULL && (*sc->sc_flush)(sc, LDFL_POLL) != 0) {
279 device_printf(dksc->sc_dev, "unable to flush cache\n");
280 return false;
281 }
282
283 return true;
284 }
285
286 /* ARGSUSED */
287 static int
288 ldopen(dev_t dev, int flags, int fmt, struct lwp *l)
289 {
290 struct ld_softc *sc;
291 struct dk_softc *dksc;
292 int unit;
293
294 unit = DISKUNIT(dev);
295 if ((sc = device_lookup_private(&ld_cd, unit)) == NULL)
296 return (ENXIO);
297 dksc = &sc->sc_dksc;
298
299 return dk_open(dksc, dev, flags, fmt, l);
300 }
301
302 static int
303 ld_lastclose(device_t self)
304 {
305 struct ld_softc *sc = device_private(self);
306
307 if (sc->sc_flush != NULL && (*sc->sc_flush)(sc, 0) != 0)
308 device_printf(self, "unable to flush cache\n");
309
310 return 0;
311 }
312
313 /* ARGSUSED */
314 static int
315 ldclose(dev_t dev, int flags, int fmt, struct lwp *l)
316 {
317 struct ld_softc *sc;
318 struct dk_softc *dksc;
319 int unit;
320
321 unit = DISKUNIT(dev);
322 sc = device_lookup_private(&ld_cd, unit);
323 dksc = &sc->sc_dksc;
324
325 return dk_close(dksc, dev, flags, fmt, l);
326 }
327
328 /* ARGSUSED */
329 static int
330 ldread(dev_t dev, struct uio *uio, int ioflag)
331 {
332
333 return (physio(ldstrategy, NULL, dev, B_READ, ldminphys, uio));
334 }
335
336 /* ARGSUSED */
337 static int
338 ldwrite(dev_t dev, struct uio *uio, int ioflag)
339 {
340
341 return (physio(ldstrategy, NULL, dev, B_WRITE, ldminphys, uio));
342 }
343
344 /* ARGSUSED */
345 static int
346 ldioctl(dev_t dev, u_long cmd, void *addr, int32_t flag, struct lwp *l)
347 {
348 struct ld_softc *sc;
349 struct dk_softc *dksc;
350 int unit, error;
351
352 unit = DISKUNIT(dev);
353 sc = device_lookup_private(&ld_cd, unit);
354 dksc = &sc->sc_dksc;
355
356 error = 0;
357
358 switch (cmd) {
359 case DIOCCACHESYNC:
360 /*
361 * XXX Do we really need to care about having a writable
362 * file descriptor here?
363 */
364 if ((flag & FWRITE) == 0)
365 error = EBADF;
366 else if (sc->sc_flush)
367 error = (*sc->sc_flush)(sc, 0);
368 else
369 error = 0; /* XXX Error out instead? */
370 break;
371
372 default:
373 error = dk_ioctl(dksc, dev, cmd, addr, flag, l);
374 break;
375 }
376
377 return (error);
378 }
379
380 static void
381 ldstrategy(struct buf *bp)
382 {
383 struct ld_softc *sc;
384 struct dk_softc *dksc;
385 int unit;
386
387 unit = DISKUNIT(bp->b_dev);
388 sc = device_lookup_private(&ld_cd, unit);
389 dksc = &sc->sc_dksc;
390
391 dk_strategy(dksc, bp);
392 }
393
394 static int
395 ld_diskstart(device_t dev, struct buf *bp)
396 {
397 struct ld_softc *sc = device_private(dev);
398 int error;
399
400 if (sc->sc_queuecnt >= sc->sc_maxqueuecnt)
401 return EAGAIN;
402
403 mutex_enter(&sc->sc_mutex);
404
405 if (sc->sc_queuecnt >= sc->sc_maxqueuecnt)
406 error = EAGAIN;
407 else {
408 error = (*sc->sc_start)(sc, bp);
409 if (error == 0)
410 sc->sc_queuecnt++;
411 }
412
413 mutex_exit(&sc->sc_mutex);
414
415 return error;
416 }
417
418 void
419 lddone(struct ld_softc *sc, struct buf *bp)
420 {
421 struct dk_softc *dksc = &sc->sc_dksc;
422
423 dk_done(dksc, bp);
424
425 mutex_enter(&sc->sc_mutex);
426 if (--sc->sc_queuecnt <= sc->sc_maxqueuecnt) {
427 if ((sc->sc_flags & LDF_DRAIN) != 0) {
428 sc->sc_flags &= ~LDF_DRAIN;
429 cv_broadcast(&sc->sc_drain);
430 }
431 mutex_exit(&sc->sc_mutex);
432 dk_start(dksc, NULL);
433 } else
434 mutex_exit(&sc->sc_mutex);
435 }
436
437 static int
438 ldsize(dev_t dev)
439 {
440 struct ld_softc *sc;
441 struct dk_softc *dksc;
442 int unit;
443
444 unit = DISKUNIT(dev);
445 if ((sc = device_lookup_private(&ld_cd, unit)) == NULL)
446 return (ENODEV);
447 dksc = &sc->sc_dksc;
448
449 if ((sc->sc_flags & LDF_ENABLED) == 0)
450 return (ENODEV);
451
452 return dk_size(dksc, dev);
453 }
454
455 /*
456 * Take a dump.
457 */
458 static int
459 lddump(dev_t dev, daddr_t blkno, void *va, size_t size)
460 {
461 struct ld_softc *sc;
462 struct dk_softc *dksc;
463 int unit;
464
465 unit = DISKUNIT(dev);
466 if ((sc = device_lookup_private(&ld_cd, unit)) == NULL)
467 return (ENXIO);
468 dksc = &sc->sc_dksc;
469
470 if ((sc->sc_flags & LDF_ENABLED) == 0)
471 return (ENODEV);
472
473 return dk_dump(dksc, dev, blkno, va, size);
474 }
475
476 static int
477 ld_dumpblocks(device_t dev, void *va, daddr_t blkno, int nblk)
478 {
479 struct ld_softc *sc = device_private(dev);
480
481 if (sc->sc_dump == NULL)
482 return (ENODEV);
483
484 return (*sc->sc_dump)(sc, va, blkno, nblk);
485 }
486
487 /*
488 * Adjust the size of a transfer.
489 */
490 static void
491 ldminphys(struct buf *bp)
492 {
493 int unit;
494 struct ld_softc *sc;
495
496 unit = DISKUNIT(bp->b_dev);
497 sc = device_lookup_private(&ld_cd, unit);
498
499 ld_iosize(sc->sc_dv, &bp->b_bcount);
500 minphys(bp);
501 }
502
503 static void
504 ld_iosize(device_t d, int *countp)
505 {
506 struct ld_softc *sc = device_private(d);
507
508 if (*countp > sc->sc_maxxfer)
509 *countp = sc->sc_maxxfer;
510 }
511
512 static void
513 ld_fake_geometry(struct ld_softc *sc)
514 {
515 uint64_t ncyl;
516
517 if (sc->sc_secperunit <= 528 * 2048) /* 528MB */
518 sc->sc_nheads = 16;
519 else if (sc->sc_secperunit <= 1024 * 2048) /* 1GB */
520 sc->sc_nheads = 32;
521 else if (sc->sc_secperunit <= 21504 * 2048) /* 21GB */
522 sc->sc_nheads = 64;
523 else if (sc->sc_secperunit <= 43008 * 2048) /* 42GB */
524 sc->sc_nheads = 128;
525 else
526 sc->sc_nheads = 255;
527
528 sc->sc_nsectors = 63;
529 sc->sc_ncylinders = INT_MAX;
530 ncyl = sc->sc_secperunit /
531 (sc->sc_nheads * sc->sc_nsectors);
532 if (ncyl < INT_MAX)
533 sc->sc_ncylinders = (int)ncyl;
534 }
535
536 static void
537 ld_set_geometry(struct ld_softc *sc)
538 {
539 struct dk_softc *dksc = &sc->sc_dksc;
540 struct disk_geom *dg = &dksc->sc_dkdev.dk_geom;
541 char tbuf[9];
542
543 format_bytes(tbuf, sizeof(tbuf), sc->sc_secperunit *
544 sc->sc_secsize);
545 aprint_normal_dev(dksc->sc_dev, "%s, %d cyl, %d head, %d sec, "
546 "%d bytes/sect x %"PRIu64" sectors\n",
547 tbuf, sc->sc_ncylinders, sc->sc_nheads,
548 sc->sc_nsectors, sc->sc_secsize, sc->sc_secperunit);
549
550 memset(dg, 0, sizeof(*dg));
551 dg->dg_secperunit = sc->sc_secperunit;
552 dg->dg_secsize = sc->sc_secsize;
553 dg->dg_nsectors = sc->sc_nsectors;
554 dg->dg_ntracks = sc->sc_nheads;
555 dg->dg_ncylinders = sc->sc_ncylinders;
556
557 disk_set_info(dksc->sc_dev, &dksc->sc_dkdev, NULL);
558 }
559
560 static void
561 ld_config_interrupts(device_t d)
562 {
563 struct ld_softc *sc = device_private(d);
564 struct dk_softc *dksc = &sc->sc_dksc;
565
566 dkwedge_discover(&dksc->sc_dkdev);
567 }
568
569 static int
570 ld_discard(device_t dev, off_t pos, off_t len)
571 {
572 struct ld_softc *sc = device_private(dev);
573
574 if (sc->sc_discard == NULL)
575 return (ENODEV);
576
577 return (*sc->sc_discard)(sc, pos, len);
578 }
579
580 static int
581 lddiscard(dev_t dev, off_t pos, off_t len)
582 {
583 struct ld_softc *sc;
584 struct dk_softc *dksc;
585 int unit;
586
587 unit = DISKUNIT(dev);
588 sc = device_lookup_private(&ld_cd, unit);
589 dksc = &sc->sc_dksc;
590
591 return dk_discard(dksc, dev, pos, len);
592 }
593