xref: /dragonfly/sys/sys/ccdvar.h (revision 8e1c6f81)
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.7 2007/07/12 00:25:57 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  * Original dynamic configuration 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_CONF_H_
96 #include <sys/conf.h>
97 #endif
98 #ifndef _SYS_DEVICESTAT_H_
99 #include <sys/devicestat.h>
100 #endif
101 #ifndef _SYS_DISK_H_
102 #include <sys/disk.h>
103 #endif
104 #ifndef _SYS_DISKSLICE_H_
105 #include <sys/diskslice.h>
106 #endif
107 
108 /*
109  * A concatenated disk is described at initialization time by this structure.
110  */
111 struct ccddevice {
112 	int		ccd_unit;	/* logical unit of this ccd */
113 	int		ccd_interleave;	/* interleave (DEV_BSIZE blocks) */
114 	int		ccd_flags;	/* misc. information */
115 	int		ccd_unused01;	/* disk number */
116 	struct vnode	**ccd_vpp;	/* array of component vnodes */
117 	char		**ccd_cpp;	/* array of component pathnames */
118 	int		ccd_ndev;	/* number of component devices */
119 };
120 
121 /*
122  * This structure is used to configure a ccd via ioctl(2).
123  */
124 struct ccd_ioctl {
125 	char	**ccio_disks;		/* pointer to component paths */
126 	u_int	ccio_ndisks;		/* number of disks to concatenate */
127 	int	ccio_ileave;		/* interleave (DEV_BSIZE blocks) */
128 	int	ccio_flags;		/* misc. information */
129 	int	ccio_unit;		/* unit number: use varies */
130 	u_int64_t ccio_size;		/* (returned) size of ccd in sectors */
131 };
132 
133 /* ccd_flags */
134 #define	CCDF_SWAP	0x01	/* interleave should be dmmax */
135 #define CCDF_UNIFORM	0x02	/* use LCCD of sizes for uniform interleave */
136 #define CCDF_MIRROR	0x04	/* use mirroring */
137 #define CCDF_PARITY	0x08	/* use parity (RAID level 5) */
138 
139 /* Mask of user-settable ccd flags. */
140 #define CCDF_USERMASK	(CCDF_SWAP|CCDF_UNIFORM|CCDF_MIRROR|CCDF_PARITY)
141 
142 /*
143  * Component info table.
144  * Describes a single component of a concatenated disk.
145  */
146 struct cdev;
147 
148 struct ccdcinfo {
149 	struct vnode	*ci_vp;			/* device's vnode */
150 	struct cdev 	*ci_dev;		/* XXX: device's dev_t */
151 	u_int64_t	ci_size; 		/* size in sectors */
152 	u_int64_t	ci_skip;		/* start skip in sectors */
153 	char		*ci_path;		/* path to component */
154 	size_t		ci_pathlen;		/* length of component path */
155 };
156 
157 /*
158  * Interleave description table.
159  * Computed at boot time to speed irregular-interleave lookups.
160  * The idea is that we interleave in "groups".  First we interleave
161  * evenly over all component disks up to the size of the smallest
162  * component (the first group), then we interleave evenly over all
163  * remaining disks up to the size of the next-smallest (second group),
164  * and so on.
165  *
166  * Each table entry describes the interleave characteristics of one
167  * of these groups.  For example if a concatenated disk consisted of
168  * three components of 5, 3, and 7 DEV_BSIZE blocks interleaved at
169  * DEV_BSIZE (1), the table would have three entries:
170  *
171  *	ndisk	startblk	startoff	dev
172  *	3	0		0		0, 1, 2
173  *	2	9		3		0, 2
174  *	1	13		5		2
175  *	0	-		-		-
176  *
177  * which says that the first nine blocks (0-8) are interleaved over
178  * 3 disks (0, 1, 2) starting at block offset 0 on any component disk,
179  * the next 4 blocks (9-12) are interleaved over 2 disks (0, 2) starting
180  * at component block 3, and the remaining blocks (13-14) are on disk
181  * 2 starting at offset 5.
182  */
183 struct ccdiinfo {
184 	int	ii_ndisk;	/* # of disks range is interleaved over */
185 	u_int64_t ii_startblk;	/* starting scaled block # for range */
186 	u_int64_t ii_startoff;	/* starting component offset (block #) */
187 	int	*ii_index;	/* ordered list of components in range */
188 };
189 
190 /*
191  * Concatenated disk pseudo-geometry information.
192  */
193 struct ccdgeom {
194 	u_int32_t	ccg_secsize;	/* # bytes per sector */
195 	u_int32_t	ccg_nsectors;	/* # data sectors per track */
196 	u_int32_t	ccg_ntracks;	/* # tracks per cylinder */
197 	u_int32_t	ccg_ncylinders;	/* # cylinders per unit */
198 };
199 
200 /*
201  * A concatenated disk is described after initialization by this structure.
202  */
203 struct ccd_softc {
204 	int		 sc_unit;		/* logical unit number */
205 	int		 sc_flags;		/* flags */
206 	int		 sc_cflags;		/* configuration flags */
207 	u_int64_t	 sc_size;		/* size of ccd in sectors */
208 	int		 sc_ileave;		/* interleave */
209 	int		 sc_maxiosize;		/* maximum I/O size */
210 	u_int		 sc_nccdisks;		/* number of components */
211 #define	CCD_MAXNDISKS	 65536
212 	struct ccdcinfo	 *sc_cinfo;		/* component info */
213 	struct ccdiinfo	 *sc_itable;		/* interleave table */
214 	struct devstat	 device_stats;		/* device statistics */
215 	struct ccdgeom   sc_geom;		/* pseudo geometry info */
216 	struct disk	 sc_disk;		/* disk overlay for ccd */
217 	struct cdev	 *sc_dev;		/* raw ccd device */
218 	int		 sc_pick;		/* side of mirror picked */
219 	off_t		 sc_blk[2];		/* mirror localization */
220 };
221 
222 /* sc_flags */
223 #define CCDF_INITED	0x01	/* unit has been initialized */
224 #define CCDF_UNUSED02	0x02	/* label area is writable */
225 #define CCDF_UNUSED04	0x04	/* unit is currently being labelled */
226 #define CCDF_WANTED	0x40	/* someone is waiting to obtain a lock */
227 #define CCDF_LOCKED	0x80	/* unit is locked */
228 
229 /*
230  * Before you can use a unit, it must be configured with CCDIOCSET.
231  * The configuration persists across opens and closes of the device;
232  * a CCDIOCCLR must be used to reset a configuration.  An attempt to
233  * CCDIOCSET an already active unit will return EBUSY.  Attempts to
234  * CCDIOCCLR an inactive unit will return ENXIO.
235  */
236 #define CCDIOCSET	_IOWR('F', 16, struct ccd_ioctl)   /* enable ccd */
237 #define CCDIOCCLR	_IOW('F', 17, struct ccd_ioctl)    /* disable ccd */
238 
239 #endif
240