root/sys/sys/ccdvar.h
/* $FreeBSD: src/sys/sys/ccdvar.h,v 1.11.2.1 2001/09/11 09:49:54 kris Exp $ */
/* $DragonFly: src/sys/sys/ccdvar.h,v 1.7 2007/07/12 00:25:57 dillon Exp $ */

/*      $NetBSD: ccdvar.h,v 1.7.2.1 1995/10/12 21:30:18 thorpej Exp $   */

/*
 * Copyright (c) 1995 Jason R. Thorpe.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed for the NetBSD Project
 *      by Jason R. Thorpe.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * Copyright (c) 1988 University of Utah.
 * Copyright (c) 1990, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * the Systems Programming Group of the University of Utah Computer
 * Science Department.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * from: Utah $Hdr: cdvar.h 1.1 90/07/09$
 *
 *      @(#)cdvar.h     8.1 (Berkeley) 6/10/93
 */

#ifndef _SYS_CCDVAR_H_
#define _SYS_CCDVAR_H_

/*
 * Original dynamic configuration support by:
 *      Jason R. Thorpe <thorpej@nas.nasa.gov>
 *      Numerical Aerodynamic Simulation Facility
 *      Mail Stop 258-6
 *      NASA Ames Research Center
 *      Moffett Field, CA 94035
 */

#ifndef _SYS_TYPES_H_
#include <sys/types.h>
#endif
#ifndef _SYS_CONF_H_
#include <sys/conf.h>
#endif
#ifndef _SYS_DEVICESTAT_H_
#include <sys/devicestat.h>
#endif
#ifndef _SYS_DISK_H_
#include <sys/disk.h>
#endif
#ifndef _SYS_DISKSLICE_H_
#include <sys/diskslice.h>
#endif
#ifndef _SYS_IOCCOM_H_
#include <sys/ioccom.h>
#endif

/*
 * A concatenated disk is described at initialization time by this structure.
 */
struct ccddevice {
        int             ccd_unit;       /* logical unit of this ccd */
        int             ccd_interleave; /* interleave (DEV_BSIZE blocks) */
        int             ccd_flags;      /* misc. information */
        int             ccd_unused01;   /* disk number */
        struct vnode    **ccd_vpp;      /* array of component vnodes */
        char            **ccd_cpp;      /* array of component pathnames */
        int             ccd_ndev;       /* number of component devices */
};

/*
 * This structure is used to configure a ccd via ioctl(2).
 */
struct ccd_ioctl {
        char    **ccio_disks;           /* pointer to component paths */
        u_int   ccio_ndisks;            /* number of disks to concatenate */
        int     ccio_ileave;            /* interleave (DEV_BSIZE blocks) */
        int     ccio_flags;             /* misc. information */
        int     ccio_unit;              /* unit number: use varies */
        u_int64_t ccio_size;            /* (returned) size of ccd in sectors */
};

/* ccd_flags */
#define CCDF_SWAP       0x01    /* interleave should be dmmax */
#define CCDF_UNIFORM    0x02    /* use LCCD of sizes for uniform interleave */
#define CCDF_MIRROR     0x04    /* use mirroring */
#define CCDF_PARITY     0x08    /* use parity (RAID level 5) */

/* Mask of user-settable ccd flags. */
#define CCDF_USERMASK   (CCDF_SWAP|CCDF_UNIFORM|CCDF_MIRROR|CCDF_PARITY)

/*
 * Component info table.
 * Describes a single component of a concatenated disk.
 */
struct cdev;

struct ccdcinfo {
        struct vnode    *ci_vp;                 /* device's vnode */
        struct cdev     *ci_dev;                /* XXX: device's dev_t */
        u_int64_t       ci_size;                /* size in sectors */
        u_int64_t       ci_skip;                /* start skip in sectors */
        char            *ci_path;               /* path to component */
        size_t          ci_pathlen;             /* length of component path */
};

/*
 * Interleave description table.
 * Computed at boot time to speed irregular-interleave lookups.
 * The idea is that we interleave in "groups".  First we interleave
 * evenly over all component disks up to the size of the smallest
 * component (the first group), then we interleave evenly over all
 * remaining disks up to the size of the next-smallest (second group),
 * and so on.
 *
 * Each table entry describes the interleave characteristics of one
 * of these groups.  For example if a concatenated disk consisted of
 * three components of 5, 3, and 7 DEV_BSIZE blocks interleaved at
 * DEV_BSIZE (1), the table would have three entries:
 *
 *      ndisk   startblk        startoff        dev
 *      3       0               0               0, 1, 2
 *      2       9               3               0, 2
 *      1       13              5               2
 *      0       -               -               -
 *
 * which says that the first nine blocks (0-8) are interleaved over
 * 3 disks (0, 1, 2) starting at block offset 0 on any component disk,
 * the next 4 blocks (9-12) are interleaved over 2 disks (0, 2) starting
 * at component block 3, and the remaining blocks (13-14) are on disk
 * 2 starting at offset 5.
 */
struct ccdiinfo {
        int     ii_ndisk;       /* # of disks range is interleaved over */
        u_int64_t ii_startblk;  /* starting scaled block # for range */
        u_int64_t ii_startoff;  /* starting component offset (block #) */
        int     *ii_index;      /* ordered list of components in range */
};

/*
 * Concatenated disk pseudo-geometry information.
 */
struct ccdgeom {
        u_int32_t       ccg_secsize;    /* # bytes per sector */
        u_int32_t       ccg_nsectors;   /* # data sectors per track */
        u_int32_t       ccg_ntracks;    /* # tracks per cylinder */
        u_int32_t       ccg_ncylinders; /* # cylinders per unit */
};

/*
 * A concatenated disk is described after initialization by this structure.
 */
struct ccd_softc {
        int              sc_unit;               /* logical unit number */
        int              sc_flags;              /* flags */
        int              sc_cflags;             /* configuration flags */
        u_int64_t        sc_size;               /* size of ccd in sectors */
        int              sc_ileave;             /* interleave */
        int              sc_maxiosize;          /* maximum I/O size */
        u_int            sc_nccdisks;           /* number of components */
#define CCD_MAXNDISKS    65536
        struct lock      sc_lock;
        struct ccdcinfo  *sc_cinfo;             /* component info */
        struct ccdiinfo  *sc_itable;            /* interleave table */
        struct devstat   device_stats;          /* device statistics */
        struct ccdgeom   sc_geom;               /* pseudo geometry info */
        struct disk      sc_disk;               /* disk overlay for ccd */
        struct cdev      *sc_dev;               /* raw ccd device */
        int              sc_pick;               /* side of mirror picked */
        off_t            sc_blk[2];             /* mirror localization */
};

/* sc_flags */
#define CCDF_INITED     0x01    /* unit has been initialized */
#define CCDF_UNUSED02   0x02    /* label area is writable */
#define CCDF_UNUSED04   0x04    /* unit is currently being labelled */

/*
 * Before you can use a unit, it must be configured with CCDIOCSET.
 * The configuration persists across opens and closes of the device;
 * a CCDIOCCLR must be used to reset a configuration.  An attempt to
 * CCDIOCSET an already active unit will return EBUSY.  Attempts to
 * CCDIOCCLR an inactive unit will return ENXIO.
 */
#define CCDIOCSET       _IOWR('F', 16, struct ccd_ioctl)   /* enable ccd */
#define CCDIOCCLR       _IOW('F', 17, struct ccd_ioctl)    /* disable ccd */

#endif