sys/geom/geom_disk.h

   1 /*-
   2  * Copyright (c) 2003 Poul-Henning Kamp
   3  * All rights reserved.
   4  *
   5  * This software was developed for the FreeBSD Project by Poul-Henning Kamp
   6  * and NAI Labs, the Security Research Division of Network Associates, Inc.
   7  * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
   8  * DARPA CHATS research program.
   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. The names of the authors may not be used to endorse or promote
  19  *    products derived from this software without specific prior written
  20  *    permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _GEOM_GEOM_DISK_H_
  38 #define _GEOM_GEOM_DISK_H_
  39
  40 #define DISK_RR_UNKNOWN         0
  41 #define DISK_RR_NON_ROTATING    1
  42 #define DISK_RR_MIN             0x0401
  43 #define DISK_RR_MAX             0xfffe
  44
  45 #ifdef _KERNEL
  46
  47 #include <sys/queue.h>
  48 #include <sys/_lock.h>
  49 #include <sys/_mutex.h>
  50 #include <sys/disk.h>
  51
  52 #define G_DISK_CLASS_NAME       "DISK"
  53
  54 struct disk;
  55
  56 typedef int     disk_open_t(struct disk *);
  57 typedef int     disk_close_t(struct disk *);
  58 typedef void    disk_strategy_t(struct bio *bp);
  59 typedef int     disk_getattr_t(struct bio *bp);
  60 typedef void    disk_gone_t(struct disk *);
  61 typedef int     disk_ioctl_t(struct disk *, u_long cmd, void *data,
  62                         int fflag, struct thread *td);
  63                 /* NB: disk_ioctl_t SHALL be cast'able to d_ioctl_t */
  64
  65 struct g_geom;
  66 struct devstat;
  67
  68 typedef enum {
  69         DISK_INIT_NONE,
  70         DISK_INIT_START,
  71         DISK_INIT_DONE
  72 } disk_init_level;
  73
  74 struct disk_alias {
  75         LIST_ENTRY(disk_alias)  da_next;
  76         const char              *da_alias;
  77 };
  78
  79 struct disk {
  80         /* Fields which are private to geom_disk */
  81         struct g_geom           *d_geom;
  82         struct devstat          *d_devstat;
  83         int                     d_goneflag;
  84         int                     d_destroyed;
  85         disk_init_level         d_init_level;
  86
  87         /* Shared fields */
  88         u_int                   d_flags;
  89         const char              *d_name;
  90         u_int                   d_unit;
  91         struct bio_queue_head   *d_queue;
  92         struct mtx              *d_lock;
  93
  94         /* Disk methods  */
  95         disk_open_t             *d_open;
  96         disk_close_t            *d_close;
  97         disk_strategy_t         *d_strategy;
  98         disk_ioctl_t            *d_ioctl;
  99         dumper_t                *d_dump;
 100         disk_getattr_t          *d_getattr;
 101         disk_gone_t             *d_gone;
 102
 103         /* Info fields from driver to geom_disk.c. Valid when open */
 104         u_int                   d_sectorsize;
 105         off_t                   d_mediasize;
 106         u_int                   d_fwsectors;
 107         u_int                   d_fwheads;
 108         u_int                   d_maxsize;
 109         off_t                   d_delmaxsize;
 110         u_int                   d_stripeoffset;
 111         u_int                   d_stripesize;
 112         char                    d_ident[DISK_IDENT_SIZE];
 113         char                    d_descr[DISK_IDENT_SIZE];
 114         uint16_t                d_hba_vendor;
 115         uint16_t                d_hba_device;
 116         uint16_t                d_hba_subvendor;
 117         uint16_t                d_hba_subdevice;
 118         uint16_t                d_rotation_rate;
 119
 120         /* Fields private to the driver */
 121         void                    *d_drv1;
 122
 123         /* Fields private to geom_disk, to be moved on next version bump */
 124         LIST_HEAD(,disk_alias)  d_aliases;
 125 };
 126
 127 #define DISKFLAG_RESERVED       0x1     /* Was NEEDSGIANT */
 128 #define DISKFLAG_OPEN           0x2
 129 #define DISKFLAG_CANDELETE      0x4
 130 #define DISKFLAG_CANFLUSHCACHE  0x8
 131 #define DISKFLAG_UNMAPPED_BIO   0x10
 132 #define DISKFLAG_DIRECT_COMPLETION      0x20
 133 #define DISKFLAG_CANZONE        0x80
 134
 135 struct disk *disk_alloc(void);
 136 void disk_create(struct disk *disk, int version);
 137 void disk_destroy(struct disk *disk);
 138 void disk_gone(struct disk *disk);
 139 void disk_attr_changed(struct disk *dp, const char *attr, int flag);
 140 void disk_media_changed(struct disk *dp, int flag);
 141 void disk_media_gone(struct disk *dp, int flag);
 142 int disk_resize(struct disk *dp, int flag);
 143 void disk_add_alias(struct disk *disk, const char *);
 144
 145 #define DISK_VERSION_00         0x58561059
 146 #define DISK_VERSION_01         0x5856105a
 147 #define DISK_VERSION_02         0x5856105b
 148 #define DISK_VERSION_03         0x5856105c
 149 #define DISK_VERSION_04         0x5856105d
 150 #define DISK_VERSION_05         0x5856105e
 151 #define DISK_VERSION            DISK_VERSION_05
 152
 153 #endif /* _KERNEL */
 154 #endif /* _GEOM_GEOM_DISK_H_ */