Annotation of XNU/bsd/sys/disklabel.h, revision 1.1

1.1     ! root        1: /*
        !             2:  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
        !             3:  *
        !             4:  * @APPLE_LICENSE_HEADER_START@
        !             5:  * 
        !             6:  * The contents of this file constitute Original Code as defined in and
        !             7:  * are subject to the Apple Public Source License Version 1.1 (the
        !             8:  * "License").  You may not use this file except in compliance with the
        !             9:  * License.  Please obtain a copy of the License at
        !            10:  * http://www.apple.com/publicsource and read it before using this file.
        !            11:  * 
        !            12:  * This Original Code and all software distributed under the License are
        !            13:  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
        !            14:  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
        !            15:  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
        !            16:  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
        !            17:  * License for the specific language governing rights and limitations
        !            18:  * under the License.
        !            19:  * 
        !            20:  * @APPLE_LICENSE_HEADER_END@
        !            21:  */
        !            22: /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
        !            23: /*
        !            24:  * Copyright (c) 1987, 1988, 1993
        !            25:  *     The Regents of the University of California.  All rights reserved.
        !            26:  *
        !            27:  * Redistribution and use in source and binary forms, with or without
        !            28:  * modification, are permitted provided that the following conditions
        !            29:  * are met:
        !            30:  * 1. Redistributions of source code must retain the above copyright
        !            31:  *    notice, this list of conditions and the following disclaimer.
        !            32:  * 2. Redistributions in binary form must reproduce the above copyright
        !            33:  *    notice, this list of conditions and the following disclaimer in the
        !            34:  *    documentation and/or other materials provided with the distribution.
        !            35:  * 3. All advertising materials mentioning features or use of this software
        !            36:  *    must display the following acknowledgement:
        !            37:  *     This product includes software developed by the University of
        !            38:  *     California, Berkeley and its contributors.
        !            39:  * 4. Neither the name of the University nor the names of its contributors
        !            40:  *    may be used to endorse or promote products derived from this software
        !            41:  *    without specific prior written permission.
        !            42:  *
        !            43:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
        !            44:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        !            45:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        !            46:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
        !            47:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        !            48:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
        !            49:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
        !            50:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
        !            51:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
        !            52:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
        !            53:  * SUCH DAMAGE.
        !            54:  *
        !            55:  *     @(#)disklabel.h 8.2 (Berkeley) 7/10/94
        !            56:  */
        !            57: #ifndef _SYS_DISKLABEL_H_
        !            58: #define _SYS_DISKLABEL_H_
        !            59: 
        !            60: /*
        !            61:  * Disk description table, see disktab(5)
        !            62:  */
        !            63: #define        _PATH_DISKTAB   "/etc/disktab"
        !            64: #define        DISKTAB         "/etc/disktab"          /* deprecated */
        !            65: 
        !            66: /*
        !            67:  * Each disk has a label which includes information about the hardware
        !            68:  * disk geometry, filesystem partitions, and drive specific information.
        !            69:  * The location of the label, as well as the number of partitions the
        !            70:  * label can describe and the number of the "whole disk" (raw)
        !            71:  * paritition are machine dependent.
        !            72:  */
        !            73: #include <machine/disklabel.h>
        !            74: 
        !            75: /*
        !            76:  * The absolute maximum number of disk partitions allowed.
        !            77:  * This is the maximum value of MAXPARTITIONS for which 'struct disklabel'
        !            78:  * is <= DEV_BSIZE bytes long.  If MAXPARTITIONS is greater than this, beware.
        !            79:  */
        !            80: #define        MAXMAXPARTITIONS        22
        !            81: #if MAXPARTITIONS > MAXMAXPARTITIONS
        !            82: #warning beware: MAXPARTITIONS bigger than MAXMAXPARTITIONS
        !            83: #endif
        !            84: 
        !            85: /*
        !            86:  * Translate between device numbers and major/disk unit/disk partition.
        !            87:  */
        !            88: #define        DISKUNIT(dev)   (minor(dev) / MAXPARTITIONS)
        !            89: #define        DISKPART(dev)   (minor(dev) % MAXPARTITIONS)
        !            90: #define        MAKEDISKDEV(maj, unit, part) \
        !            91:     (makedev((maj), ((unit) * MAXPARTITIONS) + (part)))
        !            92: 
        !            93: #define DISKMAGIC      ((u_int32_t)0x82564557) /* The disk magic number */
        !            94: 
        !            95: #ifndef LOCORE
        !            96: struct disklabel {
        !            97:        u_int32_t d_magic;              /* the magic number */
        !            98:        u_int16_t d_type;               /* drive type */
        !            99:        u_int16_t d_subtype;            /* controller/d_type specific */
        !           100:        char      d_typename[16];       /* type name, e.g. "eagle" */
        !           101: 
        !           102:        /* 
        !           103:         * d_packname contains the pack identifier and is returned when
        !           104:         * the disklabel is read off the disk or in-core copy.
        !           105:         * d_boot0 and d_boot1 are the (optional) names of the
        !           106:         * primary (block 0) and secondary (block 1-15) bootstraps
        !           107:         * as found in /usr/mdec.  These are returned when using
        !           108:         * getdiskbyname(3) to retrieve the values from /etc/disktab.
        !           109:         */
        !           110:        union {
        !           111:                char    un_d_packname[16];      /* pack identifier */ 
        !           112:                struct {
        !           113:                        char *un_d_boot0;       /* primary bootstrap name */
        !           114:                        char *un_d_boot1;       /* secondary bootstrap name */
        !           115:                } un_b; 
        !           116:        } d_un; 
        !           117: #define d_packname     d_un.un_d_packname
        !           118: #define d_boot0                d_un.un_b.un_d_boot0
        !           119: #define d_boot1                d_un.un_b.un_d_boot1
        !           120: 
        !           121:                        /* disk geometry: */
        !           122:        u_int32_t d_secsize;            /* # of bytes per sector */
        !           123:        u_int32_t d_nsectors;           /* # of data sectors per track */
        !           124:        u_int32_t d_ntracks;            /* # of tracks per cylinder */
        !           125:        u_int32_t d_ncylinders;         /* # of data cylinders per unit */
        !           126:        u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
        !           127:        u_int32_t d_secperunit;         /* # of data sectors per unit */
        !           128: 
        !           129:        /*
        !           130:         * Spares (bad sector replacements) below are not counted in
        !           131:         * d_nsectors or d_secpercyl.  Spare sectors are assumed to
        !           132:         * be physical sectors which occupy space at the end of each
        !           133:         * track and/or cylinder.
        !           134:         */
        !           135:        u_int16_t d_sparespertrack;     /* # of spare sectors per track */
        !           136:        u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
        !           137:        /*
        !           138:         * Alternate cylinders include maintenance, replacement, configuration
        !           139:         * description areas, etc.
        !           140:         */
        !           141:        u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
        !           142: 
        !           143:                        /* hardware characteristics: */
        !           144:        /*
        !           145:         * d_interleave, d_trackskew and d_cylskew describe perturbations
        !           146:         * in the media format used to compensate for a slow controller.
        !           147:         * Interleave is physical sector interleave, set up by the
        !           148:         * formatter or controller when formatting.  When interleaving is
        !           149:         * in use, logically adjacent sectors are not physically
        !           150:         * contiguous, but instead are separated by some number of
        !           151:         * sectors.  It is specified as the ratio of physical sectors
        !           152:         * traversed per logical sector.  Thus an interleave of 1:1
        !           153:         * implies contiguous layout, while 2:1 implies that logical
        !           154:         * sector 0 is separated by one sector from logical sector 1.
        !           155:         * d_trackskew is the offset of sector 0 on track N relative to
        !           156:         * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
        !           157:         * is the offset of sector 0 on cylinder N relative to sector 0
        !           158:         * on cylinder N-1.
        !           159:         */
        !           160:        u_int16_t d_rpm;                /* rotational speed */
        !           161:        u_int16_t d_interleave;         /* hardware sector interleave */
        !           162:        u_int16_t d_trackskew;          /* sector 0 skew, per track */
        !           163:        u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
        !           164:        u_int32_t d_headswitch;         /* head switch time, usec */
        !           165:        u_int32_t d_trkseek;            /* track-to-track seek, usec */
        !           166:        u_int32_t d_flags;              /* generic flags */
        !           167: #define NDDATA 5
        !           168:        u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
        !           169: #define NSPARE 5
        !           170:        u_int32_t d_spare[NSPARE];      /* reserved for future use */
        !           171:        u_int32_t d_magic2;             /* the magic number (again) */
        !           172:        u_int16_t d_checksum;           /* xor of data incl. partitions */
        !           173: 
        !           174:                        /* filesystem and partition information: */
        !           175:        u_int16_t d_npartitions;        /* number of partitions in following */
        !           176:        u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
        !           177:        u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
        !           178:        struct  partition {             /* the partition table */
        !           179:                u_int32_t p_size;       /* number of sectors in partition */
        !           180:                u_int32_t p_offset;     /* starting sector */
        !           181:                u_int32_t p_fsize;      /* filesystem basic fragment size */
        !           182:                u_int8_t p_fstype;      /* filesystem type, see below */
        !           183:                u_int8_t p_frag;        /* filesystem fragments per block */
        !           184:                union {
        !           185:                        u_int16_t cpg;  /* UFS: FS cylinders per group */
        !           186:                        u_int16_t sgs;  /* LFS: FS segment shift */
        !           187:                } __partition_u1;
        !           188: #define        p_cpg   __partition_u1.cpg
        !           189: #define        p_sgs   __partition_u1.sgs
        !           190:        } d_partitions[MAXPARTITIONS];  /* actually may be more */
        !           191: };
        !           192: #else /* LOCORE */
        !           193:        /*
        !           194:         * offsets for asm boot files.
        !           195:         */
        !           196:        .set    d_secsize,40
        !           197:        .set    d_nsectors,44
        !           198:        .set    d_ntracks,48
        !           199:        .set    d_ncylinders,52
        !           200:        .set    d_secpercyl,56
        !           201:        .set    d_secperunit,60
        !           202:        .set    d_end_,276              /* size of disk label */
        !           203: #endif /* LOCORE */
        !           204: 
        !           205: /* d_type values: */
        !           206: #define        DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
        !           207: #define        DTYPE_MSCP              2               /* MSCP */
        !           208: #define        DTYPE_DEC               3               /* other DEC (rk, rl) */
        !           209: #define        DTYPE_SCSI              4               /* SCSI */
        !           210: #define        DTYPE_ESDI              5               /* ESDI interface */
        !           211: #define        DTYPE_ST506             6               /* ST506 etc. */
        !           212: #define        DTYPE_HPIB              7               /* CS/80 on HP-IB */
        !           213: #define        DTYPE_HPFL              8               /* HP Fiber-link */
        !           214: #define        DTYPE_FLOPPY            10              /* floppy */
        !           215: 
        !           216: #ifdef DKTYPENAMES
        !           217: static char *dktypenames[] = {
        !           218:        "unknown",
        !           219:        "SMD",
        !           220:        "MSCP",
        !           221:        "old DEC",
        !           222:        "SCSI",
        !           223:        "ESDI",
        !           224:        "ST506",
        !           225:        "HP-IB",
        !           226:        "HP-FL",
        !           227:        "type 9",
        !           228:        "floppy",
        !           229:        NULL
        !           230: };
        !           231: #define DKMAXTYPES     (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
        !           232: #endif
        !           233: 
        !           234: /*
        !           235:  * Filesystem type and version.
        !           236:  * Used to interpret other filesystem-specific
        !           237:  * per-partition information.
        !           238:  */
        !           239: #define        FS_UNUSED       0               /* unused */
        !           240: #define        FS_SWAP         1               /* swap */
        !           241: #define        FS_V6           2               /* Sixth Edition */
        !           242: #define        FS_V7           3               /* Seventh Edition */
        !           243: #define        FS_SYSV         4               /* System V */
        !           244: #define        FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
        !           245: #define        FS_V8           6               /* Eighth Edition, 4K blocks */
        !           246: #define        FS_BSDFFS       7               /* 4.2BSD fast file system */
        !           247: #define        FS_MSDOS        8               /* MSDOS file system */
        !           248: #define        FS_BSDLFS       9               /* 4.4BSD log-structured file system */
        !           249: #define        FS_OTHER        10              /* in use, but unknown/unsupported */
        !           250: #define        FS_HPFS         11              /* OS/2 high-performance file system */
        !           251: #define        FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
        !           252: #define        FS_BOOT         13              /* partition contains bootstrap */
        !           253: #define        FS_ADOS         14              /* AmigaDOS fast file system */
        !           254: #define        FS_HFS          15              /* Macintosh HFS */
        !           255: 
        !           256: #ifdef DKTYPENAMES
        !           257: static char *fstypenames[] = {
        !           258:        "unused",
        !           259:        "swap",
        !           260:        "Version 6",
        !           261:        "Version 7",
        !           262:        "System V",
        !           263:        "4.1BSD",
        !           264:        "Eighth Edition",
        !           265:        "4.2BSD",
        !           266:        "MSDOS",
        !           267:        "4.4LFS",
        !           268:        "unknown",
        !           269:        "HPFS",
        !           270:        "ISO9660",
        !           271:        "boot",
        !           272:        "ADOS",
        !           273:        "HFS",
        !           274:        NULL
        !           275: };
        !           276: #define FSMAXTYPES     (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
        !           277: #endif
        !           278: 
        !           279: /*
        !           280:  * flags shared by various drives:
        !           281:  */
        !           282: #define                D_REMOVABLE     0x01            /* removable media */
        !           283: #define                D_ECC           0x02            /* supports ECC */
        !           284: #define                D_BADSECT       0x04            /* supports bad sector forw. */
        !           285: #define                D_RAMDISK       0x08            /* disk emulator */
        !           286: #define                D_CHAIN         0x10            /* can do back-back transfers */
        !           287: 
        !           288: /*
        !           289:  * Drive data for SMD.
        !           290:  */
        !           291: #define        d_smdflags      d_drivedata[0]
        !           292: #define                D_SSE           0x1             /* supports skip sectoring */
        !           293: #define        d_mindist       d_drivedata[1]
        !           294: #define        d_maxdist       d_drivedata[2]
        !           295: #define        d_sdist         d_drivedata[3]
        !           296: 
        !           297: /*
        !           298:  * Drive data for ST506.
        !           299:  */
        !           300: #define d_precompcyl   d_drivedata[0]
        !           301: #define d_gap3         d_drivedata[1]          /* used only when formatting */
        !           302: 
        !           303: /*
        !           304:  * Drive data for SCSI.
        !           305:  */
        !           306: #define        d_blind         d_drivedata[0]
        !           307: 
        !           308: #ifndef LOCORE
        !           309: /*
        !           310:  * Structure used to perform a format or other raw operation, returning
        !           311:  * data and/or register values.  Register identification and format
        !           312:  * are device- and driver-dependent.
        !           313:  */
        !           314: struct format_op {
        !           315:        char    *df_buf;
        !           316:        int      df_count;              /* value-result */
        !           317:        daddr_t  df_startblk;
        !           318:        int      df_reg[8];             /* result */
        !           319: };
        !           320: 
        !           321: /*
        !           322:  * Structure used internally to retrieve information about a partition
        !           323:  * on a disk.
        !           324:  */
        !           325: struct partinfo {
        !           326:        struct disklabel *disklab;
        !           327:        struct partition *part;
        !           328: };
        !           329: 
        !           330: /*
        !           331:  * Disk-specific ioctls.
        !           332:  */
        !           333:                /* get and set disklabel; DIOCGPART used internally */
        !           334: #define DIOCGDINFO     _IOR('d', 101, struct disklabel)/* get */
        !           335: #define DIOCSDINFO     _IOW('d', 102, struct disklabel)/* set */
        !           336: #define DIOCWDINFO     _IOW('d', 103, struct disklabel)/* set, update disk */
        !           337: #define DIOCGPART      _IOW('d', 104, struct partinfo) /* get partition */
        !           338: 
        !           339: /* do format operation, read or write */
        !           340: #define DIOCRFORMAT    _IOWR('d', 105, struct format_op)
        !           341: #define DIOCWFORMAT    _IOWR('d', 106, struct format_op)
        !           342: 
        !           343: #define DIOCSSTEP      _IOW('d', 107, int)     /* set step rate */
        !           344: #define DIOCSRETRIES   _IOW('d', 108, int)     /* set # of retries */
        !           345: #define DIOCWLABEL     _IOW('d', 109, int)     /* write en/disable label */
        !           346: 
        !           347: #define DIOCSBAD       _IOW('d', 110, struct dkbad)    /* set kernel dkbad */
        !           348: 
        !           349: #endif /* LOCORE */
        !           350: 
        !           351: #if !defined(KERNEL) && !defined(LOCORE)
        !           352: 
        !           353: #include <sys/cdefs.h>
        !           354: 
        !           355: __BEGIN_DECLS
        !           356: struct disklabel *getdiskbyname __P((const char *));
        !           357: __END_DECLS
        !           358: 
        !           359: #endif
        !           360: 
        !           361: #endif /* ! _SYS_DISKLABEL_H_ */
        !           362: 

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.