ccdvar.h revision 1.34 1 /* $NetBSD: ccdvar.h,v 1.34 2014/08/16 19:27:27 sborrill Exp $ */
2
3 /*-
4 * Copyright (c) 1996, 1997, 1998, 1999, 2007, 2009 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
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 * Copyright (c) 1988 University of Utah.
34 * Copyright (c) 1990, 1993
35 * The Regents of the University of California. All rights reserved.
36 *
37 * This code is derived from software contributed to Berkeley by
38 * the Systems Programming Group of the University of Utah Computer
39 * Science Department.
40 *
41 * Redistribution and use in source and binary forms, with or without
42 * modification, are permitted provided that the following conditions
43 * are met:
44 * 1. Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * 2. Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in the
48 * documentation and/or other materials provided with the distribution.
49 * 3. 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.
52 *
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
63 * SUCH DAMAGE.
64 *
65 * from: Utah $Hdr: cdvar.h 1.1 90/07/09$
66 *
67 * @(#)cdvar.h 8.1 (Berkeley) 6/10/93
68 */
69
70 #ifndef _DEV_CCDVAR_H_
71 #define _DEV_CCDVAR_H_
72
73 #include <sys/buf.h>
74 #include <sys/mutex.h>
75 #include <sys/queue.h>
76 #include <sys/condvar.h>
77
78 /*
79 * Dynamic configuration and disklabel support by:
80 * Jason R. Thorpe <thorpej (at) nas.nasa.gov>
81 * Numerical Aerodynamic Simulation Facility
82 * Mail Stop 258-6
83 * NASA Ames Research Center
84 * Moffett Field, CA 94035
85 */
86
87 /*
88 * This structure is used to configure a ccd via ioctl(2).
89 */
90 struct ccd_ioctl {
91 char **ccio_disks; /* pointer to component paths */
92 u_int ccio_ndisks; /* number of disks to concatenate */
93 int ccio_ileave; /* interleave (DEV_BSIZE blocks) */
94 int ccio_flags; /* see sc_flags below */
95 int ccio_unit; /* unit number: use varies */
96 uint64_t ccio_size; /* (returned) size of ccd */
97 };
98
99
100 /*
101 * Component info table.
102 * Describes a single component of a concatenated disk.
103 */
104 struct ccdcinfo {
105 struct vnode *ci_vp; /* device's vnode */
106 dev_t ci_dev; /* XXX: device's dev_t */
107 uint64_t ci_size; /* size */
108 char *ci_path; /* path to component */
109 size_t ci_pathlen; /* length of component path */
110 };
111
112 /*
113 * Interleave description table.
114 * Computed at boot time to speed irregular-interleave lookups.
115 * The idea is that we interleave in "groups". First we interleave
116 * evenly over all component disks up to the size of the smallest
117 * component (the first group), then we interleave evenly over all
118 * remaining disks up to the size of the next-smallest (second group),
119 * and so on.
120 *
121 * Each table entry describes the interleave characteristics of one
122 * of these groups. For example if a concatenated disk consisted of
123 * three components of 5, 3, and 7 DEV_BSIZE blocks interleaved at
124 * DEV_BSIZE (1), the table would have three entries:
125 *
126 * ndisk startblk startoff dev
127 * 3 0 0 0, 1, 2
128 * 2 9 3 0, 2
129 * 1 13 5 2
130 * 0 - - -
131 *
132 * which says that the first nine blocks (0-8) are interleaved over
133 * 3 disks (0, 1, 2) starting at block offset 0 on any component disk,
134 * the next 4 blocks (9-12) are interleaved over 2 disks (0, 2) starting
135 * at component block 3, and the remaining blocks (13-14) are on disk
136 * 2 starting at offset 5.
137 */
138 struct ccdiinfo {
139 int ii_ndisk; /* # of disks range is interleaved over */
140 daddr_t ii_startblk; /* starting scaled block # for range */
141 daddr_t ii_startoff; /* starting component offset (block #) */
142 int *ii_index; /* ordered list of components in range */
143 size_t ii_indexsz; /* size of memory area */
144 };
145
146 /*
147 * Concatenated disk pseudo-geometry information.
148 */
149 struct ccdgeom {
150 u_int32_t ccg_secsize; /* # bytes per sector */
151 u_int32_t ccg_nsectors; /* # data sectors per track */
152 u_int32_t ccg_ntracks; /* # tracks per cylinder */
153 u_int32_t ccg_ncylinders; /* # cylinders per unit */
154 };
155
156 struct ccdbuf;
157
158 /*
159 * A concatenated disk is described after initialization by this structure.
160 */
161 struct ccd_softc {
162 int sc_unit;
163 int sc_flags; /* flags */
164 uint64_t sc_size; /* size of ccd */
165 int sc_ileave; /* interleave */
166 u_int sc_nccdisks; /* number of components */
167 #define CCD_MAXNDISKS 65536
168 struct ccdcinfo *sc_cinfo; /* component info */
169 struct ccdiinfo *sc_itable; /* interleave table */
170 struct ccdgeom sc_geom; /* pseudo geometry info */
171 char sc_xname[8]; /* XXX external name */
172 struct disk sc_dkdev; /* generic disk device info */
173 kmutex_t sc_dvlock; /* lock on device node */
174 struct bufq_state *sc_bufq; /* buffer queue */
175 kmutex_t *sc_iolock; /* lock on I/O start/stop */
176 kcondvar_t sc_stop; /* when inflight goes zero */
177 struct lwp *sc_thread; /* for deferred I/O */
178 kcondvar_t sc_push; /* for deferred I/O */
179 bool sc_zap; /* for deferred I/O */
180 LIST_ENTRY(ccd_softc) sc_link;
181 };
182
183 /* sc_flags */
184 #define CCDF_UNIFORM 0x002 /* use LCCD of sizes for uniform interleave */
185 #define CCDF_NOLABEL 0x004 /* ignore on-disk (raw) disklabel */
186
187 #define CCDF_INITED 0x010 /* unit has been initialized */
188 #define CCDF_WLABEL 0x020 /* label area is writable */
189 #define CCDF_LABELLING 0x040 /* unit is currently being labelled */
190 #define CCDF_KLABEL 0x080 /* keep label on close */
191 #define CCDF_VLABEL 0x100 /* label is valid */
192 #define CCDF_RLABEL 0x200 /* currently reading label */
193
194 /* Mask of user-settable ccd flags. */
195 #define CCDF_USERMASK (CCDF_UNIFORM|CCDF_NOLABEL)
196
197 /*
198 * Before you can use a unit, it must be configured with CCDIOCSET.
199 * The configuration persists across opens and closes of the device;
200 * a CCDIOCCLR must be used to reset a configuration. An attempt to
201 * CCDIOCSET an already active unit will return EBUSY. Attempts to
202 * CCDIOCCLR an inactive unit will return ENXIO.
203 */
204 #define CCDIOCSET _IOWR('F', 16, struct ccd_ioctl) /* enable ccd */
205 #define CCDIOCCLR _IOW('F', 17, struct ccd_ioctl) /* disable ccd */
206
207 #if defined(COMPAT_60) && !defined(_LP64)
208 /*
209 * Old version with incorrect ccio_size
210 */
211 struct ccd_ioctl_60 {
212 char **ccio_disks; /* pointer to component paths */
213 u_int ccio_ndisks; /* number of disks to concatenate */
214 int ccio_ileave; /* interleave (DEV_BSIZE blocks) */
215 int ccio_flags; /* see sc_flags below */
216 int ccio_unit; /* unit number: use varies */
217 size_t ccio_size; /* (returned) size of ccd */
218 };
219
220 #define CCDIOCSET_60 _IOWR('F', 16, struct ccd_ioctl_60) /* enable ccd */
221 #define CCDIOCCLR_60 _IOW('F', 17, struct ccd_ioctl_60) /* disable ccd */
222 #endif /* COMPAT_60 && !LP64*/
223 /*
224 * Sysctl information
225 */
226 struct ccddiskinfo {
227 int ccd_ileave;
228 u_int ccd_ndisks;
229 uint64_t ccd_size;
230 int ccd_flags;
231 };
232
233 #endif /* _DEV_CCDVAR_H_ */
234