sys/dev/ccdvar.h

   1 /*      $NetBSD: ccdvar.h,v 1.30 2008/04/28 20:23:46 martin 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) 1990, 1993
  34  *      The Regents of the University of California.  All rights reserved.
  35  *
  36  * This code is derived from software contributed to Berkeley by
  37  * the Systems Programming Group of the University of Utah Computer
  38  * Science Department.
  39  *
  40  * Redistribution and use in source and binary forms, with or without
  41  * modification, are permitted provided that the following conditions
  42  * are met:
  43  * 1. Redistributions of source code must retain the above copyright
  44  *    notice, this list of conditions and the following disclaimer.
  45  * 2. Redistributions in binary form must reproduce the above copyright
  46  *    notice, this list of conditions and the following disclaimer in the
  47  *    documentation and/or other materials provided with the distribution.
  48  * 3. Neither the name of the University nor the names of its contributors
  49  *    may be used to endorse or promote products derived from this software
  50  *    without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  62  * SUCH DAMAGE.
  63  *
  64  * from: Utah $Hdr: cdvar.h 1.1 90/07/09$
  65  *
  66  *      @(#)cdvar.h     8.1 (Berkeley) 6/10/93
  67  */
  68
  69 /*
  70  * Copyright (c) 1988 University of Utah.
  71  *
  72  * This code is derived from software contributed to Berkeley by
  73  * the Systems Programming Group of the University of Utah Computer
  74  * Science Department.
  75  *
  76  * Redistribution and use in source and binary forms, with or without
  77  * modification, are permitted provided that the following conditions
  78  * are met:
  79  * 1. Redistributions of source code must retain the above copyright
  80  *    notice, this list of conditions and the following disclaimer.
  81  * 2. Redistributions in binary form must reproduce the above copyright
  82  *    notice, this list of conditions and the following disclaimer in the
  83  *    documentation and/or other materials provided with the distribution.
  84  * 3. All advertising materials mentioning features or use of this software
  85  *    must display the following acknowledgement:
  86  *      This product includes software developed by the University of
  87  *      California, Berkeley and its contributors.
  88  * 4. Neither the name of the University nor the names of its contributors
  89  *    may be used to endorse or promote products derived from this software
  90  *    without specific prior written permission.
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  93  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  95  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  96  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  97  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  98  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 100  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 101  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 102  * SUCH DAMAGE.
 103  *
 104  * from: Utah $Hdr: cdvar.h 1.1 90/07/09$
 105  *
 106  *      @(#)cdvar.h     8.1 (Berkeley) 6/10/93
 107  */
 108
 109 #ifndef _DEV_CCDVAR_H_
 110 #define _DEV_CCDVAR_H_
 111
 112 #include <sys/buf.h>
 113 #include <sys/mutex.h>
 114 #include <sys/queue.h>
 115 #include <sys/condvar.h>
 116
 117 /*
 118  * Dynamic configuration and disklabel support by:
 119  *      Jason R. Thorpe <thorpej@nas.nasa.gov>
 120  *      Numerical Aerodynamic Simulation Facility
 121  *      Mail Stop 258-6
 122  *      NASA Ames Research Center
 123  *      Moffett Field, CA 94035
 124  */
 125
 126 /*
 127  * This structure is used to configure a ccd via ioctl(2).
 128  */
 129 struct ccd_ioctl {
 130         char    **ccio_disks;           /* pointer to component paths */
 131         u_int   ccio_ndisks;            /* number of disks to concatenate */
 132         int     ccio_ileave;            /* interleave (DEV_BSIZE blocks) */
 133         int     ccio_flags;             /* see sc_flags below */
 134         int     ccio_unit;              /* unit number: use varies */
 135         size_t  ccio_size;              /* (returned) size of ccd */
 136 };
 137
 138 /*
 139  * Component info table.
 140  * Describes a single component of a concatenated disk.
 141  */
 142 struct ccdcinfo {
 143         struct vnode    *ci_vp;                 /* device's vnode */
 144         dev_t           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         size_t  ii_indexsz;     /* size of memory area */
 182 };
 183
 184 /*
 185  * Concatenated disk pseudo-geometry information.
 186  */
 187 struct ccdgeom {
 188         u_int32_t       ccg_secsize;    /* # bytes per sector */
 189         u_int32_t       ccg_nsectors;   /* # data sectors per track */
 190         u_int32_t       ccg_ntracks;    /* # tracks per cylinder */
 191         u_int32_t       ccg_ncylinders; /* # cylinders per unit */
 192 };
 193
 194 struct ccdbuf;
 195
 196 /*
 197  * A concatenated disk is described after initialization by this structure.
 198  */
 199 struct ccd_softc {
 200         int              sc_flags;              /* flags */
 201         size_t           sc_size;               /* size of ccd */
 202         int              sc_ileave;             /* interleave */
 203         u_int            sc_nccdisks;           /* number of components */
 204 #define CCD_MAXNDISKS   65536
 205         struct ccdcinfo  *sc_cinfo;             /* component info */
 206         struct ccdiinfo  *sc_itable;            /* interleave table */
 207         struct ccdgeom   sc_geom;               /* pseudo geometry info */
 208         char             sc_xname[8];           /* XXX external name */
 209         struct disk      sc_dkdev;              /* generic disk device info */
 210         kmutex_t         sc_dvlock;             /* lock on device node */
 211 #if defined(_KERNEL) /* XXX ccdconfig(8) refers softc directly using kvm */
 212         struct bufq_state *sc_bufq;             /* buffer queue */
 213         kmutex_t         *sc_iolock;            /* lock on I/O start/stop */
 214         kcondvar_t       sc_stop;               /* when inflight goes zero */
 215         struct lwp       *sc_thread;            /* for deferred I/O */
 216         kcondvar_t       sc_push;               /* for deferred I/O */
 217         bool             sc_zap;                /* for deferred I/O */
 218 #endif
 219 };
 220
 221 /* sc_flags */
 222 #define CCDF_UNIFORM    0x002   /* use LCCD of sizes for uniform interleave */
 223 #define CCDF_NOLABEL    0x004   /* ignore on-disk (raw) disklabel */
 224
 225 #define CCDF_INITED     0x010   /* unit has been initialized */
 226 #define CCDF_WLABEL     0x020   /* label area is writable */
 227 #define CCDF_LABELLING  0x040   /* unit is currently being labelled */
 228 #define CCDF_KLABEL     0x080   /* keep label on close */
 229 #define CCDF_VLABEL     0x100   /* label is valid */
 230 #define CCDF_RLABEL     0x200   /* currently reading label */
 231
 232 /* Mask of user-settable ccd flags. */
 233 #define CCDF_USERMASK   (CCDF_UNIFORM|CCDF_NOLABEL)
 234
 235 /*
 236  * Before you can use a unit, it must be configured with CCDIOCSET.
 237  * The configuration persists across opens and closes of the device;
 238  * a CCDIOCCLR must be used to reset a configuration.  An attempt to
 239  * CCDIOCSET an already active unit will return EBUSY.  Attempts to
 240  * CCDIOCCLR an inactive unit will return ENXIO.
 241  */
 242 #define CCDIOCSET       _IOWR('F', 16, struct ccd_ioctl)   /* enable ccd */
 243 #define CCDIOCCLR       _IOW('F', 17, struct ccd_ioctl)    /* disable ccd */
 244
 245 #endif /* _DEV_CCDVAR_H_ */