zfs/lib/libport/include/libdiskmgt.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #include "zfs_config.h"
  27
  28 #ifdef HAVE_LIBDISKMGT_H
  29 #include_next <libdiskmgt.h>
  30 #else
  31
  32 #ifndef _LIBDISKMGT_H
  33 #define _LIBDISKMGT_H
  34
  35
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #include <libnvpair.h>
  42 #include <sys/swap.h>
  43
  44
  45 /*
  46  * Holds all the data regarding the device.
  47  * Private to libdiskmgt. Must use dm_xxx functions to set/get data.
  48  */
  49 typedef uint64_t  dm_descriptor_t;
  50
  51 typedef enum {
  52         DM_WHO_MKFS = 0,
  53         DM_WHO_ZPOOL,
  54         DM_WHO_ZPOOL_FORCE,
  55         DM_WHO_FORMAT,
  56         DM_WHO_SWAP,
  57         DM_WHO_DUMP,
  58         DM_WHO_ZPOOL_SPARE
  59 } dm_who_type_t;
  60
  61 typedef enum {
  62     DM_DRIVE = 0,
  63     DM_CONTROLLER,
  64     DM_MEDIA,
  65     DM_SLICE,
  66     DM_PARTITION,
  67     DM_PATH,
  68     DM_ALIAS,
  69     DM_BUS
  70 } dm_desc_type_t;
  71
  72
  73 typedef enum {
  74     DM_DT_UNKNOWN = 0,
  75     DM_DT_FIXED,
  76     DM_DT_ZIP,
  77     DM_DT_JAZ,
  78     DM_DT_FLOPPY,
  79     DM_DT_MO_ERASABLE,
  80     DM_DT_MO_WRITEONCE,
  81     DM_DT_AS_MO,
  82     DM_DT_CDROM,
  83     DM_DT_CDR,
  84     DM_DT_CDRW,
  85     DM_DT_DVDROM,
  86     DM_DT_DVDR,
  87     DM_DT_DVDRAM,
  88     DM_DT_DVDRW,
  89     DM_DT_DDCDROM,
  90     DM_DT_DDCDR,
  91     DM_DT_DDCDRW
  92 } dm_drive_type_t;
  93
  94 typedef enum {
  95     DM_MT_UNKNOWN = 0,
  96     DM_MT_FIXED,
  97     DM_MT_FLOPPY,
  98     DM_MT_CDROM,
  99     DM_MT_ZIP,
 100     DM_MT_JAZ,
 101     DM_MT_CDR,
 102     DM_MT_CDRW,
 103     DM_MT_DVDROM,
 104     DM_MT_DVDR,
 105     DM_MT_DVDRAM,
 106     DM_MT_MO_ERASABLE,
 107     DM_MT_MO_WRITEONCE,
 108     DM_MT_AS_MO
 109 } dm_media_type_t;
 110
 111 #define DM_FILTER_END   -1
 112
 113 /* drive stat name */
 114 typedef enum {
 115     DM_DRV_STAT_PERFORMANCE = 0,
 116     DM_DRV_STAT_DIAGNOSTIC,
 117     DM_DRV_STAT_TEMPERATURE
 118 } dm_drive_stat_t;
 119
 120 /* slice stat name */
 121 typedef enum {
 122     DM_SLICE_STAT_USE = 0
 123 } dm_slice_stat_t;
 124
 125 /* attribute definitions */
 126
 127 /* drive */
 128 #define DM_DISK_UP              1
 129 #define DM_DISK_DOWN            0
 130
 131 #define DM_CLUSTERED            "clustered"
 132 #define DM_DRVTYPE              "drvtype"
 133 #define DM_FAILING              "failing"
 134 #define DM_LOADED               "loaded"        /* also in media */
 135 #define DM_NDNRERRS             "ndevice_not_ready_errors"
 136 #define DM_NBYTESREAD           "nbytes_read"
 137 #define DM_NBYTESWRITTEN        "nbytes_written"
 138 #define DM_NHARDERRS            "nhard_errors"
 139 #define DM_NILLREQERRS          "nillegal_req_errors"
 140 #define DM_NMEDIAERRS           "nmedia_errors"
 141 #define DM_NNODEVERRS           "nno_dev_errors"
 142 #define DM_NREADOPS             "nread_ops"
 143 #define DM_NRECOVERRS           "nrecoverable_errors"
 144 #define DM_NSOFTERRS            "nsoft_errors"
 145 #define DM_NTRANSERRS           "ntransport_errors"
 146 #define DM_NWRITEOPS            "nwrite_ops"
 147 #define DM_OPATH                "opath"
 148 #define DM_PRODUCT_ID           "product_id"
 149 #define DM_REMOVABLE            "removable"     /* also in media */
 150 #define DM_RPM                  "rpm"
 151 #define DM_STATUS               "status"
 152 #define DM_SYNC_SPEED           "sync_speed"
 153 #define DM_TEMPERATURE          "temperature"
 154 #define DM_VENDOR_ID            "vendor_id"
 155 #define DM_WIDE                 "wide"          /* also on controller */
 156 #define DM_WWN                  "wwn"
 157
 158 /* bus */
 159 #define DM_BTYPE                "btype"
 160 #define DM_CLOCK                "clock"         /* also on controller */
 161 #define DM_PNAME                "pname"
 162
 163 /* controller */
 164 #define DM_FAST                 "fast"
 165 #define DM_FAST20               "fast20"
 166 #define DM_FAST40               "fast40"
 167 #define DM_FAST80               "fast80"
 168 #define DM_MULTIPLEX            "multiplex"
 169 #define DM_PATH_STATE           "path_state"
 170
 171 #define DM_CTYPE_ATA            "ata"
 172 #define DM_CTYPE_SCSI           "scsi"
 173 #define DM_CTYPE_FIBRE          "fibre channel"
 174 #define DM_CTYPE_USB            "usb"
 175 #define DM_CTYPE_UNKNOWN        "unknown"
 176
 177 /* media */
 178 #define DM_BLOCKSIZE            "blocksize"
 179 #define DM_FDISK                "fdisk"
 180 #define DM_MTYPE                "mtype"
 181 #define DM_NACTUALCYLINDERS     "nactual_cylinders"
 182 #define DM_NALTCYLINDERS        "nalt_cylinders"
 183 #define DM_NCYLINDERS           "ncylinders"
 184 #define DM_NHEADS               "nheads"
 185 #define DM_NPHYSCYLINDERS       "nphys_cylinders"
 186 #define DM_NSECTORS             "nsectors"      /* also in partition */
 187 #define DM_SIZE                 "size"          /* also in slice */
 188 #define DM_NACCESSIBLE          "naccessible"
 189 #define DM_LABEL                "label"
 190
 191 /* partition */
 192 #define DM_BCYL                 "bcyl"
 193 #define DM_BHEAD                "bhead"
 194 #define DM_BOOTID               "bootid"
 195 #define DM_BSECT                "bsect"
 196 #define DM_ECYL                 "ecyl"
 197 #define DM_EHEAD                "ehead"
 198 #define DM_ESECT                "esect"
 199 #define DM_PTYPE                "ptype"
 200 #define DM_RELSECT              "relsect"
 201
 202 /* slice */
 203 #define DM_DEVICEID             "deviceid"
 204 #define DM_DEVT                 "devt"
 205 #define DM_INDEX                "index"
 206 #define DM_EFI_NAME             "name"
 207 #define DM_MOUNTPOINT           "mountpoint"
 208 #define DM_LOCALNAME            "localname"
 209 #define DM_START                "start"
 210 #define DM_TAG                  "tag"
 211 #define DM_FLAG                 "flag"
 212 #define DM_EFI                  "efi"   /* also on media */
 213 #define DM_USED_BY              "used_by"
 214 #define DM_USED_NAME            "used_name"
 215 #define DM_USE_MOUNT            "mount"
 216 #define DM_USE_SVM              "svm"
 217 #define DM_USE_LU               "lu"
 218 #define DM_USE_DUMP             "dump"
 219 #define DM_USE_VXVM             "vxvm"
 220 #define DM_USE_FS               "fs"
 221 #define DM_USE_VFSTAB           "vfstab"
 222 #define DM_USE_EXPORTED_ZPOOL   "exported_zpool"
 223 #define DM_USE_ACTIVE_ZPOOL     "active_zpool"
 224 #define DM_USE_SPARE_ZPOOL      "spare_zpool"
 225 #define DM_USE_L2CACHE_ZPOOL    "l2cache_zpool"
 226
 227 /* event */
 228 #define DM_EV_NAME              "name"
 229 #define DM_EV_DTYPE             "edtype"
 230 #define DM_EV_TYPE              "evtype"
 231 #define DM_EV_TADD              "add"
 232 #define DM_EV_TREMOVE           "remove"
 233 #define DM_EV_TCHANGE           "change"
 234
 235 /* findisks */
 236 #define DM_CTYPE                "ctype"
 237 #define DM_LUN                  "lun"
 238 #define DM_TARGET               "target"
 239
 240 #define NOINUSE_SET     getenv("NOINUSE_CHECK") != NULL
 241
 242 void                    dm_free_descriptors(dm_descriptor_t *desc_list);
 243 void                    dm_free_descriptor(dm_descriptor_t desc);
 244 void                    dm_free_name(char *name);
 245 void                    dm_free_swapentries(swaptbl_t *);
 246
 247 dm_descriptor_t         *dm_get_descriptors(dm_desc_type_t type, int filter[],
 248                             int *errp);
 249 dm_descriptor_t         *dm_get_associated_descriptors(dm_descriptor_t desc,
 250                             dm_desc_type_t type, int *errp);
 251 dm_desc_type_t          *dm_get_associated_types(dm_desc_type_t type);
 252 dm_descriptor_t         dm_get_descriptor_by_name(dm_desc_type_t desc_type,
 253                             char *name, int *errp);
 254 char                    *dm_get_name(dm_descriptor_t desc, int *errp);
 255 dm_desc_type_t          dm_get_type(dm_descriptor_t desc);
 256 nvlist_t                *dm_get_attributes(dm_descriptor_t desc, int *errp);
 257 nvlist_t                *dm_get_stats(dm_descriptor_t desc, int stat_type,
 258                             int *errp);
 259 void                    dm_init_event_queue(void(*callback)(nvlist_t *, int),
 260                             int *errp);
 261 nvlist_t                *dm_get_event(int *errp);
 262 void                    dm_get_slices(char *drive, dm_descriptor_t **slices,
 263                             int *errp);
 264 void                    dm_get_slice_stats(char *slice, nvlist_t **dev_stats,
 265                             int *errp);
 266 int                     dm_get_swapentries(swaptbl_t **, int *);
 267 void                    dm_get_usage_string(char *who, char *data, char **msg);
 268 int                     dm_inuse(char *dev_name, char **msg, dm_who_type_t who,
 269                             int *errp);
 270 int                     dm_inuse_swap(const char *dev_name, int *errp);
 271 int                     dm_isoverlapping(char *dev_name, char **msg, int *errp);
 272
 273 #ifdef __cplusplus
 274 }
 275 #endif
 276
 277 #endif /* _LIBDISKMGT_H */
 278 #endif /* HAVE_LIBDISKMGT_H */