1/* $NetBSD: ccdvar.h,v 1.37 2018/03/18 20:33:52 christos 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/ioccom.h>
74#ifdef _KERNEL
75#include <sys/buf.h>
76#include <sys/mutex.h>
77#include <sys/queue.h>
78#include <sys/condvar.h>
79#endif
80
81/*
82 * Dynamic configuration and disklabel support by:
83 * Jason R. Thorpe <thorpej@nas.nasa.gov>
84 * Numerical Aerodynamic Simulation Facility
85 * Mail Stop 258-6
86 * NASA Ames Research Center
87 * Moffett Field, CA 94035
88 */
89
90/*
91 * This structure is used to configure a ccd via ioctl(2).
92 */
93struct ccd_ioctl {
94 char **ccio_disks; /* pointer to component paths */
95 u_int ccio_ndisks; /* number of disks to concatenate */
96 int ccio_ileave; /* interleave (DEV_BSIZE blocks) */
97 int ccio_flags; /* see sc_flags below */
98 int ccio_unit; /* unit number: use varies */
99 uint64_t ccio_size; /* (returned) size of ccd */
100};
101
102#ifdef _KERNEL
103
104/*
105 * Component info table.
106 * Describes a single component of a concatenated disk.
107 */
108struct ccdcinfo {
109 struct vnode *ci_vp; /* device's vnode */
110 dev_t ci_dev; /* XXX: device's dev_t */
111 uint64_t ci_size; /* size */
112 char *ci_path; /* path to component */
113 size_t ci_pathlen; /* length of component path */
114};
115
116/*
117 * Interleave description table.
118 * Computed at boot time to speed irregular-interleave lookups.
119 * The idea is that we interleave in "groups". First we interleave
120 * evenly over all component disks up to the size of the smallest
121 * component (the first group), then we interleave evenly over all
122 * remaining disks up to the size of the next-smallest (second group),
123 * and so on.
124 *
125 * Each table entry describes the interleave characteristics of one
126 * of these groups. For example if a concatenated disk consisted of
127 * three components of 5, 3, and 7 DEV_BSIZE blocks interleaved at
128 * DEV_BSIZE (1), the table would have three entries:
129 *
130 * ndisk startblk startoff dev
131 * 3 0 0 0, 1, 2
132 * 2 9 3 0, 2
133 * 1 13 5 2
134 * 0 - - -
135 *
136 * which says that the first nine blocks (0-8) are interleaved over
137 * 3 disks (0, 1, 2) starting at block offset 0 on any component disk,
138 * the next 4 blocks (9-12) are interleaved over 2 disks (0, 2) starting
139 * at component block 3, and the remaining blocks (13-14) are on disk
140 * 2 starting at offset 5.
141 */
142struct ccdiinfo {
143 int ii_ndisk; /* # of disks range is interleaved over */
144 daddr_t ii_startblk; /* starting scaled block # for range */
145 daddr_t ii_startoff; /* starting component offset (block #) */
146 int *ii_index; /* ordered list of components in range */
147 size_t ii_indexsz; /* size of memory area */
148};
149
150/*
151 * Concatenated disk pseudo-geometry information.
152 */
153struct ccdgeom {
154 u_int32_t ccg_secsize; /* # bytes per sector */
155 u_int32_t ccg_nsectors; /* # data sectors per track */
156 u_int32_t ccg_ntracks; /* # tracks per cylinder */
157 u_int32_t ccg_ncylinders; /* # cylinders per unit */
158};
159
160struct ccdbuf;
161
162/*
163 * A concatenated disk is described after initialization by this structure.
164 */
165struct ccd_softc {
166 int sc_unit;
167 int sc_flags; /* flags */
168 uint64_t sc_size; /* size of ccd */
169 int sc_ileave; /* interleave */
170 u_int sc_nccdisks; /* number of components */
171#define CCD_MAXNDISKS 65536
172 struct ccdcinfo *sc_cinfo; /* component info */
173 struct ccdiinfo *sc_itable; /* interleave table */
174 struct ccdgeom sc_geom; /* pseudo geometry info */
175 char sc_xname[8]; /* XXX external name */
176 struct disk sc_dkdev; /* generic disk device info */
177 kmutex_t sc_dvlock; /* lock on device node */
178 struct bufq_state *sc_bufq; /* buffer queue */
179 kmutex_t *sc_iolock; /* lock on I/O start/stop */
180 kcondvar_t sc_stop; /* when inflight goes zero */
181 struct lwp *sc_thread; /* for deferred I/O */
182 kcondvar_t sc_push; /* for deferred I/O */
183 bool sc_zap; /* for deferred I/O */
184 LIST_ENTRY(ccd_softc) sc_link;
185};
186
187#endif /* _KERNEL */
188
189/* sc_flags */
190#define CCDF_UNIFORM 0x002 /* use LCCD of sizes for uniform interleave */
191#define CCDF_NOLABEL 0x004 /* ignore on-disk (raw) disklabel */
192
193#define CCDF_INITED 0x010 /* unit has been initialized */
194#define CCDF_WLABEL 0x020 /* label area is writable */
195#define CCDF_LABELLING 0x040 /* unit is currently being labelled */
196#define CCDF_KLABEL 0x080 /* keep label on close */
197#define CCDF_VLABEL 0x100 /* label is valid */
198#define CCDF_RLABEL 0x200 /* currently reading label */
199
200/* Mask of user-settable ccd flags. */
201#define CCDF_USERMASK (CCDF_UNIFORM|CCDF_NOLABEL)
202
203/*
204 * Before you can use a unit, it must be configured with CCDIOCSET.
205 * The configuration persists across opens and closes of the device;
206 * a CCDIOCCLR must be used to reset a configuration. An attempt to
207 * CCDIOCSET an already active unit will return EBUSY. Attempts to
208 * CCDIOCCLR an inactive unit will return ENXIO.
209 */
210#define CCDIOCSET _IOWR('F', 16, struct ccd_ioctl) /* enable ccd */
211#define CCDIOCCLR _IOW('F', 17, struct ccd_ioctl) /* disable ccd */
212
213/*
214 * Sysctl information
215 */
216struct ccddiskinfo {
217 int ccd_ileave;
218 u_int ccd_ndisks;
219 uint64_t ccd_size;
220 int ccd_flags;
221};
222
223#endif /* _DEV_CCDVAR_H_ */
224