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 2006 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_FS_ZFS_H 27 #define _SYS_FS_ZFS_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #include <sys/types.h> 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 /* 38 * Types and constants shared between userland and the kernel. 39 */ 40 41 /* 42 * Each dataset can be one of the following types. These constants can be 43 * combined into masks that can be passed to various functions. 44 */ 45 typedef enum { 46 ZFS_TYPE_FILESYSTEM = 0x1, 47 ZFS_TYPE_SNAPSHOT = 0x2, 48 ZFS_TYPE_VOLUME = 0x4 49 } zfs_type_t; 50 51 #define ZFS_TYPE_ANY \ 52 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 53 54 /* 55 * Properties are identified by these constants. They are arranged in order of 56 * how they should be displayed by 'zfs get'. If you make any changes to this 57 * list, be sure to update the property table in usr/src/common/zfs/zfs_prop.c. 58 */ 59 typedef enum { 60 ZFS_PROP_INVAL = -1, 61 ZFS_PROP_TYPE, 62 ZFS_PROP_CREATION, 63 ZFS_PROP_USED, 64 ZFS_PROP_AVAILABLE, 65 ZFS_PROP_REFERENCED, 66 ZFS_PROP_COMPRESSRATIO, 67 ZFS_PROP_MOUNTED, 68 ZFS_PROP_ORIGIN, 69 ZFS_PROP_QUOTA, 70 ZFS_PROP_RESERVATION, 71 ZFS_PROP_VOLSIZE, 72 ZFS_PROP_VOLBLOCKSIZE, 73 ZFS_PROP_RECORDSIZE, 74 ZFS_PROP_MOUNTPOINT, 75 ZFS_PROP_SHARENFS, 76 ZFS_PROP_CHECKSUM, 77 ZFS_PROP_COMPRESSION, 78 ZFS_PROP_ATIME, 79 ZFS_PROP_DEVICES, 80 ZFS_PROP_EXEC, 81 ZFS_PROP_SETUID, 82 ZFS_PROP_READONLY, 83 ZFS_PROP_ZONED, 84 ZFS_PROP_SNAPDIR, 85 ZFS_PROP_ACLMODE, 86 ZFS_PROP_ACLINHERIT, 87 /* 88 * The following properties are not exposed to the user, but are 89 * accessible by libzfs clients. 90 */ 91 ZFS_PROP_CREATETXG, 92 ZFS_PROP_NAME, 93 ZFS_NPROP_ALL 94 } zfs_prop_t; 95 96 #define ZFS_NPROP_VISIBLE ZFS_PROP_CREATETXG 97 98 #define ZFS_PROP_VALUE "value" 99 #define ZFS_PROP_SOURCE "source" 100 101 /* 102 * The following functions are shared between libzfs and the kernel. 103 */ 104 zfs_prop_t zfs_name_to_prop(const char *); 105 int zfs_prop_readonly(zfs_prop_t); 106 const char *zfs_prop_default_string(zfs_prop_t); 107 uint64_t zfs_prop_default_numeric(zfs_prop_t); 108 109 /* 110 * On-disk format version. 111 */ 112 #define ZFS_VERSION 1ULL 113 114 /* 115 * The following are configuration names used in the nvlist describing a pool's 116 * configuration. 117 */ 118 #define ZPOOL_CONFIG_VERSION "version" 119 #define ZPOOL_CONFIG_POOL_NAME "name" 120 #define ZPOOL_CONFIG_POOL_STATE "state" 121 #define ZPOOL_CONFIG_POOL_TXG "txg" 122 #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 123 #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 124 #define ZPOOL_CONFIG_TOP_GUID "top_guid" 125 #define ZPOOL_CONFIG_POOL_HEALTH "pool_health" 126 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 127 #define ZPOOL_CONFIG_TYPE "type" 128 #define ZPOOL_CONFIG_CHILDREN "children" 129 #define ZPOOL_CONFIG_ID "id" 130 #define ZPOOL_CONFIG_GUID "guid" 131 #define ZPOOL_CONFIG_PATH "path" 132 #define ZPOOL_CONFIG_DEVID "devid" 133 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 134 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 135 #define ZPOOL_CONFIG_ASHIFT "ashift" 136 #define ZPOOL_CONFIG_ASIZE "asize" 137 #define ZPOOL_CONFIG_DTL "DTL" 138 #define ZPOOL_CONFIG_STATS "stats" 139 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 140 #define ZPOOL_CONFIG_OFFLINE "offline" 141 #define ZPOOL_CONFIG_ERRCOUNT "error_count" 142 #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 143 144 #define VDEV_TYPE_ROOT "root" 145 #define VDEV_TYPE_MIRROR "mirror" 146 #define VDEV_TYPE_REPLACING "replacing" 147 #define VDEV_TYPE_RAIDZ "raidz" 148 #define VDEV_TYPE_DISK "disk" 149 #define VDEV_TYPE_FILE "file" 150 #define VDEV_TYPE_MISSING "missing" 151 152 /* 153 * This is needed in userland to report the minimum necessary device size. 154 */ 155 #define SPA_MINDEVSIZE (64ULL << 20) 156 157 /* 158 * The location of the pool configuration repository, shared between kernel and 159 * userland. 160 */ 161 #define ZPOOL_CACHE_DIR "/etc/zfs" 162 #define ZPOOL_CACHE_FILE "zpool.cache" 163 #define ZPOOL_CACHE_TMP ".zpool.cache" 164 165 #define ZPOOL_CACHE ZPOOL_CACHE_DIR "/" ZPOOL_CACHE_FILE 166 167 /* 168 * vdev states are ordered from least to most healthy. 169 * A vdev that's CANT_OPEN or below is considered unusable. 170 */ 171 typedef enum vdev_state { 172 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 173 VDEV_STATE_CLOSED, /* Not currently open */ 174 VDEV_STATE_OFFLINE, /* Not allowed to open */ 175 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 176 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 177 VDEV_STATE_HEALTHY /* Presumed good */ 178 } vdev_state_t; 179 180 /* 181 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 182 * of the vdev stats structure uses these constants to distinguish why. 183 */ 184 typedef enum vdev_aux { 185 VDEV_AUX_NONE, /* no error */ 186 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 187 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 188 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 189 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 190 VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 191 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 192 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 193 VDEV_AUX_VERSION_OLDER /* on-disk version is too old */ 194 } vdev_aux_t; 195 196 /* 197 * pool state. The following states are written to disk as part of the normal 198 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED. The remaining states are 199 * software abstractions used at various levels to communicate pool state. 200 */ 201 typedef enum pool_state { 202 POOL_STATE_ACTIVE = 0, /* In active use */ 203 POOL_STATE_EXPORTED, /* Explicitly exported */ 204 POOL_STATE_DESTROYED, /* Explicitly destroyed */ 205 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 206 POOL_STATE_UNAVAIL, /* Internal libzfs state */ 207 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 208 } pool_state_t; 209 210 /* 211 * Scrub types. 212 */ 213 typedef enum pool_scrub_type { 214 POOL_SCRUB_NONE, 215 POOL_SCRUB_RESILVER, 216 POOL_SCRUB_EVERYTHING, 217 POOL_SCRUB_TYPES 218 } pool_scrub_type_t; 219 220 /* 221 * ZIO types. Needed to interpret vdev statistics below. 222 */ 223 typedef enum zio_type { 224 ZIO_TYPE_NULL = 0, 225 ZIO_TYPE_READ, 226 ZIO_TYPE_WRITE, 227 ZIO_TYPE_FREE, 228 ZIO_TYPE_CLAIM, 229 ZIO_TYPE_IOCTL, 230 ZIO_TYPES 231 } zio_type_t; 232 233 /* 234 * Vdev statistics. Note: all fields should be 64-bit because this 235 * is passed between kernel and userland as an nvlist uint64 array. 236 */ 237 typedef struct vdev_stat { 238 hrtime_t vs_timestamp; /* time since vdev load */ 239 uint64_t vs_state; /* vdev state */ 240 uint64_t vs_aux; /* see vdev_aux_t */ 241 uint64_t vs_alloc; /* space allocated */ 242 uint64_t vs_space; /* total capacity */ 243 uint64_t vs_rsize; /* replaceable dev size */ 244 uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 245 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 246 uint64_t vs_read_errors; /* read errors */ 247 uint64_t vs_write_errors; /* write errors */ 248 uint64_t vs_checksum_errors; /* checksum errors */ 249 uint64_t vs_self_healed; /* self-healed bytes */ 250 uint64_t vs_scrub_type; /* pool_scrub_type_t */ 251 uint64_t vs_scrub_complete; /* completed? */ 252 uint64_t vs_scrub_examined; /* bytes examined; top */ 253 uint64_t vs_scrub_repaired; /* bytes repaired; leaf */ 254 uint64_t vs_scrub_errors; /* errors during scrub */ 255 uint64_t vs_scrub_start; /* UTC scrub start time */ 256 uint64_t vs_scrub_end; /* UTC scrub end time */ 257 } vdev_stat_t; 258 259 #define ZFS_DRIVER "zfs" 260 #define ZFS_DEV "/dev/zfs" 261 262 /* 263 * zvol paths. Irritatingly, the devfsadm interfaces want all these 264 * paths without the /dev prefix, but for some things, we want the 265 * /dev prefix. Below are the names without /dev. 266 */ 267 #define ZVOL_DEV_DIR "zvol/dsk" 268 #define ZVOL_RDEV_DIR "zvol/rdsk" 269 270 /* 271 * And here are the things we need with /dev, etc. in front of them. 272 */ 273 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zvol@0:" 274 #define ZVOL_FULL_DEV_DIR "/dev/" ZVOL_DEV_DIR 275 276 #define ZVOL_PROP_NAME "name" 277 278 /* 279 * /dev/zfs ioctl numbers. 280 */ 281 #define ZFS_IOC ('Z' << 8) 282 283 typedef enum zfs_ioc { 284 ZFS_IOC_POOL_CREATE = ZFS_IOC, 285 ZFS_IOC_POOL_DESTROY, 286 ZFS_IOC_POOL_IMPORT, 287 ZFS_IOC_POOL_EXPORT, 288 ZFS_IOC_POOL_CONFIGS, 289 ZFS_IOC_POOL_STATS, 290 ZFS_IOC_POOL_TRYIMPORT, 291 ZFS_IOC_POOL_SCRUB, 292 ZFS_IOC_POOL_FREEZE, 293 ZFS_IOC_POOL_UPGRADE, 294 ZFS_IOC_VDEV_ADD, 295 ZFS_IOC_VDEV_REMOVE, 296 ZFS_IOC_VDEV_ONLINE, 297 ZFS_IOC_VDEV_OFFLINE, 298 ZFS_IOC_VDEV_ATTACH, 299 ZFS_IOC_VDEV_DETACH, 300 ZFS_IOC_VDEV_SETPATH, 301 ZFS_IOC_OBJSET_STATS, 302 ZFS_IOC_DATASET_LIST_NEXT, 303 ZFS_IOC_SNAPSHOT_LIST_NEXT, 304 ZFS_IOC_SET_PROP, 305 ZFS_IOC_SET_QUOTA, 306 ZFS_IOC_SET_RESERVATION, 307 ZFS_IOC_SET_VOLSIZE, 308 ZFS_IOC_SET_VOLBLOCKSIZE, 309 ZFS_IOC_CREATE_MINOR, 310 ZFS_IOC_REMOVE_MINOR, 311 ZFS_IOC_CREATE, 312 ZFS_IOC_DESTROY, 313 ZFS_IOC_ROLLBACK, 314 ZFS_IOC_RENAME, 315 ZFS_IOC_RECVBACKUP, 316 ZFS_IOC_SENDBACKUP, 317 ZFS_IOC_INJECT_FAULT, 318 ZFS_IOC_CLEAR_FAULT, 319 ZFS_IOC_INJECT_LIST_NEXT, 320 ZFS_IOC_ERROR_LOG, 321 ZFS_IOC_CLEAR, 322 ZFS_IOC_BOOKMARK_NAME 323 } zfs_ioc_t; 324 325 /* 326 * Internal SPA load state. Used by FMA diagnosis engine. 327 */ 328 typedef enum { 329 SPA_LOAD_NONE, /* no load in progress */ 330 SPA_LOAD_OPEN, /* normal open */ 331 SPA_LOAD_IMPORT, /* import in progress */ 332 SPA_LOAD_TRYIMPORT /* tryimport in progress */ 333 } spa_load_state_t; 334 335 #ifdef __cplusplus 336 } 337 #endif 338 339 #endif /* _SYS_FS_ZFS_H */ 340