| 1 | /* $NetBSD: dkvar.h,v 1.27 2016/10/24 17:14:27 jdolecek Exp $ */ |
| 2 | |
| 3 | /*- |
| 4 | * Copyright (c) 2002 The NetBSD Foundation, Inc. |
| 5 | * All rights reserved. |
| 6 | * |
| 7 | * This code is derived from software contributed to The NetBSD Foundation |
| 8 | * by Roland C. Dowdeswell. |
| 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 | #include <sys/rndsource.h> |
| 33 | |
| 34 | struct pathbuf; /* from namei.h */ |
| 35 | |
| 36 | /* literally this is not a softc, but is intended to be included in |
| 37 | * the pseudo-disk's softc and passed to calls in dksubr.c. It |
| 38 | * should include the common elements of the pseudo-disk's softc. |
| 39 | * All elements that are included here should describe the external |
| 40 | * representation of the disk to the higher layers, and flags that |
| 41 | * are common to each of the pseudo-disk drivers. |
| 42 | */ |
| 43 | struct dk_softc { |
| 44 | device_t sc_dev; |
| 45 | u_int32_t sc_flags; /* flags */ |
| 46 | #define DK_XNAME_SIZE 8 |
| 47 | char sc_xname[DK_XNAME_SIZE]; /* external name */ |
| 48 | struct disk sc_dkdev; /* generic disk info */ |
| 49 | kmutex_t sc_iolock; /* protects buffer queue */ |
| 50 | struct bufq_state *sc_bufq; /* buffer queue */ |
| 51 | int sc_dtype; /* disk type */ |
| 52 | struct buf *sc_deferred; /* retry after start failed */ |
| 53 | bool sc_busy; /* processing buffers */ |
| 54 | krndsource_t sc_rnd_source; /* entropy source */ |
| 55 | }; |
| 56 | |
| 57 | /* sc_flags: |
| 58 | * We separate the flags into two varieties, those that dksubr.c |
| 59 | * understands and manipulates and those that it does not. |
| 60 | */ |
| 61 | |
| 62 | #define DKF_INITED 0x00010000 /* unit has been initialised */ |
| 63 | #define DKF_WLABEL 0x00020000 /* label area is writable */ |
| 64 | #define DKF_LABELLING 0x00040000 /* unit is currently being labeled */ |
| 65 | #define DKF_WARNLABEL 0x00080000 /* warn if disklabel not present */ |
| 66 | #define DKF_LABELSANITY 0x00100000 /* warn if disklabel not sane */ |
| 67 | #define DKF_TAKEDUMP 0x00200000 /* allow dumping */ |
| 68 | #define DKF_KLABEL 0x00400000 /* keep label on close */ |
| 69 | #define DKF_VLABEL 0x00800000 /* label is valid */ |
| 70 | #define DKF_SLEEP 0x80000000 /* dk_start/dk_done may sleep */ |
| 71 | |
| 72 | /* Mask of flags that dksubr.c understands, other flags are fair game */ |
| 73 | #define DK_FLAGMASK 0xffff0000 |
| 74 | |
| 75 | #define DK_ATTACHED(_dksc) ((_dksc)->sc_flags & DKF_INITED) |
| 76 | |
| 77 | #define DK_BUSY(_dksc, _pmask) \ |
| 78 | (((_dksc)->sc_dkdev.dk_openmask & ~(_pmask)) || \ |
| 79 | ((_dksc)->sc_dkdev.dk_bopenmask & (_pmask) && \ |
| 80 | ((_dksc)->sc_dkdev.dk_copenmask & (_pmask)))) |
| 81 | |
| 82 | /* |
| 83 | * Functions that are exported to the pseudo disk implementations: |
| 84 | */ |
| 85 | |
| 86 | void dk_init(struct dk_softc *, device_t, int); |
| 87 | void dk_attach(struct dk_softc *); |
| 88 | void dk_detach(struct dk_softc *); |
| 89 | |
| 90 | int dk_open(struct dk_softc *, dev_t, |
| 91 | int, int, struct lwp *); |
| 92 | int dk_close(struct dk_softc *, dev_t, |
| 93 | int, int, struct lwp *); |
| 94 | void dk_strategy(struct dk_softc *, struct buf *); |
| 95 | int dk_strategy_defer(struct dk_softc *, struct buf *); |
| 96 | int dk_strategy_pending(struct dk_softc *); |
| 97 | int dk_discard(struct dk_softc *, dev_t, off_t, off_t); |
| 98 | void dk_start(struct dk_softc *, struct buf *); |
| 99 | void dk_done(struct dk_softc *, struct buf *); |
| 100 | void dk_drain(struct dk_softc *); |
| 101 | int dk_size(struct dk_softc *, dev_t); |
| 102 | int dk_ioctl(struct dk_softc *, dev_t, |
| 103 | u_long, void *, int, struct lwp *); |
| 104 | int dk_dump(struct dk_softc *, dev_t, |
| 105 | daddr_t, void *, size_t); |
| 106 | void dk_getdisklabel(struct dk_softc *, dev_t); |
| 107 | void dk_getdefaultlabel(struct dk_softc *, struct disklabel *); |
| 108 | |
| 109 | int dk_lookup(struct pathbuf *, struct lwp *, struct vnode **); |
| 110 | |