sys/sys/ccdvar.h

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