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.2 2003/06/17 04:28:58 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 /*
  81  * Dynamic configuration and disklabel support by:
  82  *      Jason R. Thorpe <thorpej@nas.nasa.gov>
  83  *      Numerical Aerodynamic Simulation Facility
  84  *      Mail Stop 258-6
  85  *      NASA Ames Research Center
  86  *      Moffett Field, CA 94035
  87  */
  88
  89 /*
  90  * A concatenated disk is described at initialization time by this structure.
  91  */
  92 struct ccddevice {
  93         int             ccd_unit;       /* logical unit of this ccd */
  94         int             ccd_interleave; /* interleave (DEV_BSIZE blocks) */
  95         int             ccd_flags;      /* misc. information */
  96         int             ccd_dk;         /* disk number */
  97         struct vnode    **ccd_vpp;      /* array of component vnodes */
  98         char            **ccd_cpp;      /* array of component pathnames */
  99         int             ccd_ndev;       /* number of component devices */
 100 };
 101
 102 /*
 103  * This structure is used to configure a ccd via ioctl(2).
 104  */
 105 struct ccd_ioctl {
 106         char    **ccio_disks;           /* pointer to component paths */
 107         u_int   ccio_ndisks;            /* number of disks to concatenate */
 108         int     ccio_ileave;            /* interleave (DEV_BSIZE blocks) */
 109         int     ccio_flags;             /* misc. information */
 110         int     ccio_unit;              /* unit number: use varies */
 111         size_t  ccio_size;              /* (returned) size of ccd */
 112 };
 113
 114 /* ccd_flags */
 115 #define CCDF_SWAP       0x01    /* interleave should be dmmax */
 116 #define CCDF_UNIFORM    0x02    /* use LCCD of sizes for uniform interleave */
 117 #define CCDF_MIRROR     0x04    /* use mirroring */
 118 #define CCDF_PARITY     0x08    /* use parity (RAID level 5) */
 119
 120 /* Mask of user-settable ccd flags. */
 121 #define CCDF_USERMASK   (CCDF_SWAP|CCDF_UNIFORM|CCDF_MIRROR|CCDF_PARITY)
 122
 123 /*
 124  * Component info table.
 125  * Describes a single component of a concatenated disk.
 126  */
 127 struct ccdcinfo {
 128         struct vnode    *ci_vp;                 /* device's vnode */
 129         dev_t           ci_dev;                 /* XXX: device's dev_t */
 130         size_t          ci_size;                /* size */
 131         char            *ci_path;               /* path to component */
 132         size_t          ci_pathlen;             /* length of component path */
 133 };
 134
 135 /*
 136  * Interleave description table.
 137  * Computed at boot time to speed irregular-interleave lookups.
 138  * The idea is that we interleave in "groups".  First we interleave
 139  * evenly over all component disks up to the size of the smallest
 140  * component (the first group), then we interleave evenly over all
 141  * remaining disks up to the size of the next-smallest (second group),
 142  * and so on.
 143  *
 144  * Each table entry describes the interleave characteristics of one
 145  * of these groups.  For example if a concatenated disk consisted of
 146  * three components of 5, 3, and 7 DEV_BSIZE blocks interleaved at
 147  * DEV_BSIZE (1), the table would have three entries:
 148  *
 149  *      ndisk   startblk        startoff        dev
 150  *      3       0               0               0, 1, 2
 151  *      2       9               3               0, 2
 152  *      1       13              5               2
 153  *      0       -               -               -
 154  *
 155  * which says that the first nine blocks (0-8) are interleaved over
 156  * 3 disks (0, 1, 2) starting at block offset 0 on any component disk,
 157  * the next 4 blocks (9-12) are interleaved over 2 disks (0, 2) starting
 158  * at component block 3, and the remaining blocks (13-14) are on disk
 159  * 2 starting at offset 5.
 160  */
 161 struct ccdiinfo {
 162         int     ii_ndisk;       /* # of disks range is interleaved over */
 163         daddr_t ii_startblk;    /* starting scaled block # for range */
 164         daddr_t ii_startoff;    /* starting component offset (block #) */
 165         int     *ii_index;      /* ordered list of components in range */
 166 };
 167
 168 /*
 169  * Concatenated disk pseudo-geometry information.
 170  */
 171 struct ccdgeom {
 172         u_int32_t       ccg_secsize;    /* # bytes per sector */
 173         u_int32_t       ccg_nsectors;   /* # data sectors per track */
 174         u_int32_t       ccg_ntracks;    /* # tracks per cylinder */
 175         u_int32_t       ccg_ncylinders; /* # cylinders per unit */
 176 };
 177
 178 /*
 179  * A concatenated disk is described after initialization by this structure.
 180  */
 181 struct ccd_softc {
 182         int              sc_unit;               /* logical unit number */
 183         int              sc_flags;              /* flags */
 184         int              sc_cflags;             /* configuration flags */
 185         size_t           sc_size;               /* size of ccd */
 186         int              sc_ileave;             /* interleave */
 187         u_int            sc_nccdisks;           /* number of components */
 188 #define CCD_MAXNDISKS    65536
 189         struct ccdcinfo  *sc_cinfo;             /* component info */
 190         struct ccdiinfo  *sc_itable;            /* interleave table */
 191         struct devstat   device_stats;          /* device statistics */
 192         struct ccdgeom   sc_geom;               /* pseudo geometry info */
 193         struct disklabel sc_label;              /* generic disk device info */
 194         int              sc_openmask;
 195         int              sc_pick;               /* side of mirror picked */
 196         daddr_t          sc_blk[2];             /* mirror localization */
 197 };
 198
 199 /* sc_flags */
 200 #define CCDF_INITED     0x01    /* unit has been initialized */
 201 #define CCDF_WLABEL     0x02    /* label area is writable */
 202 #define CCDF_LABELLING  0x04    /* unit is currently being labelled */
 203 #define CCDF_WANTED     0x40    /* someone is waiting to obtain a lock */
 204 #define CCDF_LOCKED     0x80    /* unit is locked */
 205
 206 /*
 207  * Before you can use a unit, it must be configured with CCDIOCSET.
 208  * The configuration persists across opens and closes of the device;
 209  * a CCDIOCCLR must be used to reset a configuration.  An attempt to
 210  * CCDIOCSET an already active unit will return EBUSY.  Attempts to
 211  * CCDIOCCLR an inactive unit will return ENXIO.
 212  */
 213 #define CCDIOCSET       _IOWR('F', 16, struct ccd_ioctl)   /* enable ccd */
 214 #define CCDIOCCLR       _IOW('F', 17, struct ccd_ioctl)    /* disable ccd */