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 #ifdef _KERNEL
  41
  42 #include <sys/queue.h>
  43 #include <sys/_lock.h>
  44 #include <sys/_mutex.h>
  45 #include <sys/disk.h>
  46
  47 #define G_DISK_CLASS_NAME       "DISK"
  48
  49 struct disk;
  50
  51 typedef int     disk_open_t(struct disk *);
  52 typedef int     disk_close_t(struct disk *);
  53 typedef void    disk_strategy_t(struct bio *bp);
  54 typedef int     disk_getattr_t(struct bio *bp);
  55 typedef void    disk_gone_t(struct disk *);
  56 typedef int     disk_ioctl_t(struct disk *, u_long cmd, void *data,
  57                         int fflag, struct thread *td);
  58                 /* NB: disk_ioctl_t SHALL be cast'able to d_ioctl_t */
  59
  60 struct g_geom;
  61 struct devstat;
  62
  63 typedef enum {
  64         DISK_INIT_NONE,
  65         DISK_INIT_START,
  66         DISK_INIT_DONE
  67 } disk_init_level;
  68
  69 struct disk_alias {
  70         LIST_ENTRY(disk_alias)  da_next;
  71         const char              *da_alias;
  72 };
  73
  74 struct disk {
  75         /* Fields which are private to geom_disk */
  76         struct g_geom           *d_geom;
  77         struct devstat          *d_devstat;
  78         int                     d_goneflag;
  79         int                     d_destroyed;
  80         disk_init_level         d_init_level;
  81
  82         /* Shared fields */
  83         u_int                   d_flags;
  84         const char              *d_name;
  85         u_int                   d_unit;
  86         struct bio_queue_head   *d_queue;
  87         struct mtx              *d_lock;
  88
  89         /* Disk methods  */
  90         disk_open_t             *d_open;
  91         disk_close_t            *d_close;
  92         disk_strategy_t         *d_strategy;
  93         disk_ioctl_t            *d_ioctl;
  94         dumper_t                *d_dump;
  95         disk_getattr_t          *d_getattr;
  96         disk_gone_t             *d_gone;
  97
  98         /* Info fields from driver to geom_disk.c. Valid when open */
  99         u_int                   d_sectorsize;
 100         off_t                   d_mediasize;
 101         u_int                   d_fwsectors;
 102         u_int                   d_fwheads;
 103         u_int                   d_maxsize;
 104         off_t                   d_delmaxsize;
 105         u_int                   d_stripeoffset;
 106         u_int                   d_stripesize;
 107         char                    d_ident[DISK_IDENT_SIZE];
 108         char                    d_descr[DISK_IDENT_SIZE];
 109         uint16_t                d_hba_vendor;
 110         uint16_t                d_hba_device;
 111         uint16_t                d_hba_subvendor;
 112         uint16_t                d_hba_subdevice;
 113         uint16_t                d_rotation_rate;
 114
 115         /* Fields private to the driver */
 116         void                    *d_drv1;
 117
 118         /* Fields private to geom_disk, to be moved on next version bump */
 119         LIST_HEAD(,disk_alias)  d_aliases;
 120 };
 121
 122 #define DISKFLAG_RESERVED       0x1     /* Was NEEDSGIANT */
 123 #define DISKFLAG_OPEN           0x2
 124 #define DISKFLAG_CANDELETE      0x4
 125 #define DISKFLAG_CANFLUSHCACHE  0x8
 126 #define DISKFLAG_UNMAPPED_BIO   0x10
 127 #define DISKFLAG_DIRECT_COMPLETION      0x20
 128 #define DISKFLAG_CANZONE        0x80
 129
 130 #define DISK_RR_UNKNOWN         0
 131 #define DISK_RR_NON_ROTATING    1
 132 #define DISK_RR_MIN             0x0401
 133 #define DISK_RR_MAX             0xfffe
 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_ */