sys/geom/geom_disk.h

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