Change the kernel dev_t, representing a pointer to a specinfo structure,
[dragonfly.git] / sys / sys / ccdvar.h
1 /* $FreeBSD: src/sys/sys/ccdvar.h,v 1.11.2.1 2001/09/11 09:49:54 kris Exp $ */
2 /* $DragonFly: src/sys/sys/ccdvar.h,v 1.5 2006/09/10 01:26:40 dillon Exp $ */
3
4 /*      $NetBSD: ccdvar.h,v 1.7.2.1 1995/10/12 21:30:18 thorpej Exp $   */
5
6 /*
7  * Copyright (c) 1995 Jason R. Thorpe.
8  * All rights reserved.
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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed for the NetBSD Project
21  *      by Jason R. Thorpe.
22  * 4. The name of the author may not be used to endorse or promote products
23  *    derived from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
32  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
33  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37
38 /*
39  * Copyright (c) 1988 University of Utah.
40  * Copyright (c) 1990, 1993
41  *      The Regents of the University of California.  All rights reserved.
42  *
43  * This code is derived from software contributed to Berkeley by
44  * the Systems Programming Group of the University of Utah Computer
45  * Science Department.
46  *
47  * Redistribution and use in source and binary forms, with or without
48  * modification, are permitted provided that the following conditions
49  * are met:
50  * 1. Redistributions of source code must retain the above copyright
51  *    notice, this list of conditions and the following disclaimer.
52  * 2. Redistributions in binary form must reproduce the above copyright
53  *    notice, this list of conditions and the following disclaimer in the
54  *    documentation and/or other materials provided with the distribution.
55  * 3. All advertising materials mentioning features or use of this software
56  *    must display the following acknowledgement:
57  *      This product includes software developed by the University of
58  *      California, Berkeley and its contributors.
59  * 4. Neither the name of the University nor the names of its contributors
60  *    may be used to endorse or promote products derived from this software
61  *    without specific prior written permission.
62  *
63  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
64  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
65  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
66  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
67  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
68  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
69  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
70  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
71  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
72  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
73  * SUCH DAMAGE.
74  *
75  * from: Utah $Hdr: cdvar.h 1.1 90/07/09$
76  *
77  *      @(#)cdvar.h     8.1 (Berkeley) 6/10/93
78  */
79
80 #ifndef _SYS_CCDVAR_H_
81 #define _SYS_CCDVAR_H_
82
83 /*
84  * Dynamic configuration and disklabel support by:
85  *      Jason R. Thorpe <thorpej@nas.nasa.gov>
86  *      Numerical Aerodynamic Simulation Facility
87  *      Mail Stop 258-6
88  *      NASA Ames Research Center
89  *      Moffett Field, CA 94035
90  */
91
92 #ifndef _SYS_TYPES_H_
93 #include <sys/types.h>
94 #endif
95 #ifndef _SYS_DEVICESTAT_H_
96 #include <sys/devicestat.h>
97 #endif
98 #ifndef _SYS_DISKLABEL_H_
99 #include <sys/disklabel.h>
100 #endif
101
102 /*
103  * A concatenated disk is described at initialization time by this structure.
104  */
105 struct ccddevice {
106         int             ccd_unit;       /* logical unit of this ccd */
107         int             ccd_interleave; /* interleave (DEV_BSIZE blocks) */
108         int             ccd_flags;      /* misc. information */
109         int             ccd_dk;         /* disk number */
110         struct vnode    **ccd_vpp;      /* array of component vnodes */
111         char            **ccd_cpp;      /* array of component pathnames */
112         int             ccd_ndev;       /* number of component devices */
113 };
114
115 /*
116  * This structure is used to configure a ccd via ioctl(2).
117  */
118 struct ccd_ioctl {
119         char    **ccio_disks;           /* pointer to component paths */
120         u_int   ccio_ndisks;            /* number of disks to concatenate */
121         int     ccio_ileave;            /* interleave (DEV_BSIZE blocks) */
122         int     ccio_flags;             /* misc. information */
123         int     ccio_unit;              /* unit number: use varies */
124         size_t  ccio_size;              /* (returned) size of ccd */
125 };
126
127 /* ccd_flags */
128 #define CCDF_SWAP       0x01    /* interleave should be dmmax */
129 #define CCDF_UNIFORM    0x02    /* use LCCD of sizes for uniform interleave */
130 #define CCDF_MIRROR     0x04    /* use mirroring */
131 #define CCDF_PARITY     0x08    /* use parity (RAID level 5) */
132
133 /* Mask of user-settable ccd flags. */
134 #define CCDF_USERMASK   (CCDF_SWAP|CCDF_UNIFORM|CCDF_MIRROR|CCDF_PARITY)
135
136 /*
137  * Component info table.
138  * Describes a single component of a concatenated disk.
139  */
140 struct cdev;
141
142 struct ccdcinfo {
143         struct vnode    *ci_vp;                 /* device's vnode */
144         struct cdev     *ci_dev;                /* XXX: device's dev_t */
145         size_t          ci_size;                /* size */
146         char            *ci_path;               /* path to component */
147         size_t          ci_pathlen;             /* length of component path */
148 };
149
150 /*
151  * Interleave description table.
152  * Computed at boot time to speed irregular-interleave lookups.
153  * The idea is that we interleave in "groups".  First we interleave
154  * evenly over all component disks up to the size of the smallest
155  * component (the first group), then we interleave evenly over all
156  * remaining disks up to the size of the next-smallest (second group),
157  * and so on.
158  *
159  * Each table entry describes the interleave characteristics of one
160  * of these groups.  For example if a concatenated disk consisted of
161  * three components of 5, 3, and 7 DEV_BSIZE blocks interleaved at
162  * DEV_BSIZE (1), the table would have three entries:
163  *
164  *      ndisk   startblk        startoff        dev
165  *      3       0               0               0, 1, 2
166  *      2       9               3               0, 2
167  *      1       13              5               2
168  *      0       -               -               -
169  *
170  * which says that the first nine blocks (0-8) are interleaved over
171  * 3 disks (0, 1, 2) starting at block offset 0 on any component disk,
172  * the next 4 blocks (9-12) are interleaved over 2 disks (0, 2) starting
173  * at component block 3, and the remaining blocks (13-14) are on disk
174  * 2 starting at offset 5.
175  */
176 struct ccdiinfo {
177         int     ii_ndisk;       /* # of disks range is interleaved over */
178         daddr_t ii_startblk;    /* starting scaled block # for range */
179         daddr_t ii_startoff;    /* starting component offset (block #) */
180         int     *ii_index;      /* ordered list of components in range */
181 };
182
183 /*
184  * Concatenated disk pseudo-geometry information.
185  */
186 struct ccdgeom {
187         u_int32_t       ccg_secsize;    /* # bytes per sector */
188         u_int32_t       ccg_nsectors;   /* # data sectors per track */
189         u_int32_t       ccg_ntracks;    /* # tracks per cylinder */
190         u_int32_t       ccg_ncylinders; /* # cylinders per unit */
191 };
192
193 /*
194  * A concatenated disk is described after initialization by this structure.
195  */
196 struct ccd_softc {
197         int              sc_unit;               /* logical unit number */
198         int              sc_flags;              /* flags */
199         int              sc_cflags;             /* configuration flags */
200         size_t           sc_size;               /* size of ccd */
201         int              sc_ileave;             /* interleave */
202         u_int            sc_nccdisks;           /* number of components */
203 #define CCD_MAXNDISKS    65536
204         struct ccdcinfo  *sc_cinfo;             /* component info */
205         struct ccdiinfo  *sc_itable;            /* interleave table */
206         struct devstat   device_stats;          /* device statistics */
207         struct ccdgeom   sc_geom;               /* pseudo geometry info */
208         struct disklabel sc_label;              /* generic disk device info */
209         int              sc_openmask;
210         int              sc_pick;               /* side of mirror picked */
211         off_t            sc_blk[2];             /* mirror localization */
212 };
213
214 /* sc_flags */
215 #define CCDF_INITED     0x01    /* unit has been initialized */
216 #define CCDF_WLABEL     0x02    /* label area is writable */
217 #define CCDF_LABELLING  0x04    /* unit is currently being labelled */
218 #define CCDF_WANTED     0x40    /* someone is waiting to obtain a lock */
219 #define CCDF_LOCKED     0x80    /* unit is locked */
220
221 /*
222  * Before you can use a unit, it must be configured with CCDIOCSET.
223  * The configuration persists across opens and closes of the device;
224  * a CCDIOCCLR must be used to reset a configuration.  An attempt to
225  * CCDIOCSET an already active unit will return EBUSY.  Attempts to
226  * CCDIOCCLR an inactive unit will return ENXIO.
227  */
228 #define CCDIOCSET       _IOWR('F', 16, struct ccd_ioctl)   /* enable ccd */
229 #define CCDIOCCLR       _IOW('F', 17, struct ccd_ioctl)    /* disable ccd */
230
231 #endif