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 /* 111 * On-disk version number. 112 */ 113 #define ZFS_VERSION_1 1ULL 114 #define ZFS_VERSION_2 2ULL 115 #define ZFS_VERSION_3 3ULL 116 #define ZFS_VERSION ZFS_VERSION_3 117 118 /* 119 * Symbolic names for the changes that caused a ZFS_VERSION switch. 120 * Used in the code when checking for presence or absence of a feature. 121 * Feel free to define multiple symbolic names for each version if there 122 * were multiple changes to on-disk structures during that version. 123 * 124 * NOTE: When checking the current ZFS_VERSION in your code, be sure 125 * to use spa_version() since it reports the version of the 126 * last synced uberblock. Checking the in-flight version can 127 * be dangerous in some cases. 128 */ 129 #define ZFS_VERSION_INITIAL ZFS_VERSION_1 130 #define ZFS_VERSION_DITTO_BLOCKS ZFS_VERSION_2 131 #define ZFS_VERSION_SPARES ZFS_VERSION_3 132 #define ZFS_VERSION_RAID6 ZFS_VERSION_3 133 #define ZFS_VERSION_BPLIST_ACCOUNT ZFS_VERSION_3 134 #define ZFS_VERSION_RAIDZ_DEFLATE ZFS_VERSION_3 135 #define ZFS_VERSION_DNODE_BYTES ZFS_VERSION_3 136 137 /* 138 * The following are configuration names used in the nvlist describing a pool's 139 * configuration. 140 */ 141 #define ZPOOL_CONFIG_VERSION "version" 142 #define ZPOOL_CONFIG_POOL_NAME "name" 143 #define ZPOOL_CONFIG_POOL_STATE "state" 144 #define ZPOOL_CONFIG_POOL_TXG "txg" 145 #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 146 #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 147 #define ZPOOL_CONFIG_TOP_GUID "top_guid" 148 #define ZPOOL_CONFIG_POOL_HEALTH "pool_health" 149 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 150 #define ZPOOL_CONFIG_TYPE "type" 151 #define ZPOOL_CONFIG_CHILDREN "children" 152 #define ZPOOL_CONFIG_ID "id" 153 #define ZPOOL_CONFIG_GUID "guid" 154 #define ZPOOL_CONFIG_PATH "path" 155 #define ZPOOL_CONFIG_DEVID "devid" 156 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 157 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 158 #define ZPOOL_CONFIG_ASHIFT "ashift" 159 #define ZPOOL_CONFIG_ASIZE "asize" 160 #define ZPOOL_CONFIG_DTL "DTL" 161 #define ZPOOL_CONFIG_STATS "stats" 162 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 163 #define ZPOOL_CONFIG_OFFLINE "offline" 164 #define ZPOOL_CONFIG_ERRCOUNT "error_count" 165 #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 166 #define ZPOOL_CONFIG_SPARES "spares" 167 #define ZPOOL_CONFIG_IS_SPARE "is_spare" 168 #define ZPOOL_CONFIG_NPARITY "nparity" 169 170 #define VDEV_TYPE_ROOT "root" 171 #define VDEV_TYPE_MIRROR "mirror" 172 #define VDEV_TYPE_REPLACING "replacing" 173 #define VDEV_TYPE_RAIDZ "raidz" 174 #define VDEV_TYPE_DISK "disk" 175 #define VDEV_TYPE_FILE "file" 176 #define VDEV_TYPE_MISSING "missing" 177 #define VDEV_TYPE_SPARE "spare" 178 179 /* 180 * This is needed in userland to report the minimum necessary device size. 181 */ 182 #define SPA_MINDEVSIZE (64ULL << 20) 183 184 /* 185 * The location of the pool configuration repository, shared between kernel and 186 * userland. 187 */ 188 #define ZPOOL_CACHE_DIR "/etc/zfs" 189 #define ZPOOL_CACHE_FILE "zpool.cache" 190 #define ZPOOL_CACHE_TMP ".zpool.cache" 191 192 #define ZPOOL_CACHE ZPOOL_CACHE_DIR "/" ZPOOL_CACHE_FILE 193 194 /* 195 * vdev states are ordered from least to most healthy. 196 * A vdev that's CANT_OPEN or below is considered unusable. 197 */ 198 typedef enum vdev_state { 199 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 200 VDEV_STATE_CLOSED, /* Not currently open */ 201 VDEV_STATE_OFFLINE, /* Not allowed to open */ 202 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 203 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 204 VDEV_STATE_HEALTHY /* Presumed good */ 205 } vdev_state_t; 206 207 /* 208 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 209 * of the vdev stats structure uses these constants to distinguish why. 210 */ 211 typedef enum vdev_aux { 212 VDEV_AUX_NONE, /* no error */ 213 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 214 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 215 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 216 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 217 VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 218 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 219 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 220 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 221 VDEV_AUX_SPARED /* hot spare used in another pool */ 222 } vdev_aux_t; 223 224 /* 225 * pool state. The following states are written to disk as part of the normal 226 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE. The remaining states are 227 * software abstractions used at various levels to communicate pool state. 228 */ 229 typedef enum pool_state { 230 POOL_STATE_ACTIVE = 0, /* In active use */ 231 POOL_STATE_EXPORTED, /* Explicitly exported */ 232 POOL_STATE_DESTROYED, /* Explicitly destroyed */ 233 POOL_STATE_SPARE, /* Reserved for hot spare use */ 234 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 235 POOL_STATE_UNAVAIL, /* Internal libzfs state */ 236 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 237 } pool_state_t; 238 239 /* 240 * Scrub types. 241 */ 242 typedef enum pool_scrub_type { 243 POOL_SCRUB_NONE, 244 POOL_SCRUB_RESILVER, 245 POOL_SCRUB_EVERYTHING, 246 POOL_SCRUB_TYPES 247 } pool_scrub_type_t; 248 249 /* 250 * ZIO types. Needed to interpret vdev statistics below. 251 */ 252 typedef enum zio_type { 253 ZIO_TYPE_NULL = 0, 254 ZIO_TYPE_READ, 255 ZIO_TYPE_WRITE, 256 ZIO_TYPE_FREE, 257 ZIO_TYPE_CLAIM, 258 ZIO_TYPE_IOCTL, 259 ZIO_TYPES 260 } zio_type_t; 261 262 /* 263 * Vdev statistics. Note: all fields should be 64-bit because this 264 * is passed between kernel and userland as an nvlist uint64 array. 265 */ 266 typedef struct vdev_stat { 267 hrtime_t vs_timestamp; /* time since vdev load */ 268 uint64_t vs_state; /* vdev state */ 269 uint64_t vs_aux; /* see vdev_aux_t */ 270 uint64_t vs_alloc; /* space allocated */ 271 uint64_t vs_space; /* total capacity */ 272 uint64_t vs_dspace; /* deflated capacity */ 273 uint64_t vs_rsize; /* replaceable dev size */ 274 uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 275 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 276 uint64_t vs_read_errors; /* read errors */ 277 uint64_t vs_write_errors; /* write errors */ 278 uint64_t vs_checksum_errors; /* checksum errors */ 279 uint64_t vs_self_healed; /* self-healed bytes */ 280 uint64_t vs_scrub_type; /* pool_scrub_type_t */ 281 uint64_t vs_scrub_complete; /* completed? */ 282 uint64_t vs_scrub_examined; /* bytes examined; top */ 283 uint64_t vs_scrub_repaired; /* bytes repaired; leaf */ 284 uint64_t vs_scrub_errors; /* errors during scrub */ 285 uint64_t vs_scrub_start; /* UTC scrub start time */ 286 uint64_t vs_scrub_end; /* UTC scrub end time */ 287 } vdev_stat_t; 288 289 #define ZFS_DRIVER "zfs" 290 #define ZFS_DEV "/dev/zfs" 291 292 /* 293 * zvol paths. Irritatingly, the devfsadm interfaces want all these 294 * paths without the /dev prefix, but for some things, we want the 295 * /dev prefix. Below are the names without /dev. 296 */ 297 #define ZVOL_DEV_DIR "zvol/dsk" 298 #define ZVOL_RDEV_DIR "zvol/rdsk" 299 300 /* 301 * And here are the things we need with /dev, etc. in front of them. 302 */ 303 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zvol@0:" 304 #define ZVOL_FULL_DEV_DIR "/dev/" ZVOL_DEV_DIR 305 306 #define ZVOL_PROP_NAME "name" 307 308 /* 309 * /dev/zfs ioctl numbers. 310 */ 311 #define ZFS_IOC ('Z' << 8) 312 313 typedef enum zfs_ioc { 314 ZFS_IOC_POOL_CREATE = ZFS_IOC, 315 ZFS_IOC_POOL_DESTROY, 316 ZFS_IOC_POOL_IMPORT, 317 ZFS_IOC_POOL_EXPORT, 318 ZFS_IOC_POOL_CONFIGS, 319 ZFS_IOC_POOL_STATS, 320 ZFS_IOC_POOL_TRYIMPORT, 321 ZFS_IOC_POOL_SCRUB, 322 ZFS_IOC_POOL_FREEZE, 323 ZFS_IOC_POOL_UPGRADE, 324 ZFS_IOC_VDEV_ADD, 325 ZFS_IOC_VDEV_REMOVE, 326 ZFS_IOC_VDEV_ONLINE, 327 ZFS_IOC_VDEV_OFFLINE, 328 ZFS_IOC_VDEV_ATTACH, 329 ZFS_IOC_VDEV_DETACH, 330 ZFS_IOC_VDEV_SETPATH, 331 ZFS_IOC_OBJSET_STATS, 332 ZFS_IOC_DATASET_LIST_NEXT, 333 ZFS_IOC_SNAPSHOT_LIST_NEXT, 334 ZFS_IOC_SET_PROP, 335 ZFS_IOC_SET_QUOTA, 336 ZFS_IOC_SET_RESERVATION, 337 ZFS_IOC_SET_VOLSIZE, 338 ZFS_IOC_SET_VOLBLOCKSIZE, 339 ZFS_IOC_CREATE_MINOR, 340 ZFS_IOC_REMOVE_MINOR, 341 ZFS_IOC_CREATE, 342 ZFS_IOC_DESTROY, 343 ZFS_IOC_ROLLBACK, 344 ZFS_IOC_RENAME, 345 ZFS_IOC_RECVBACKUP, 346 ZFS_IOC_SENDBACKUP, 347 ZFS_IOC_INJECT_FAULT, 348 ZFS_IOC_CLEAR_FAULT, 349 ZFS_IOC_INJECT_LIST_NEXT, 350 ZFS_IOC_ERROR_LOG, 351 ZFS_IOC_CLEAR, 352 ZFS_IOC_BOOKMARK_NAME, 353 ZFS_IOC_PROMOTE 354 } zfs_ioc_t; 355 356 /* 357 * Internal SPA load state. Used by FMA diagnosis engine. 358 */ 359 typedef enum { 360 SPA_LOAD_NONE, /* no load in progress */ 361 SPA_LOAD_OPEN, /* normal open */ 362 SPA_LOAD_IMPORT, /* import in progress */ 363 SPA_LOAD_TRYIMPORT /* tryimport in progress */ 364 } spa_load_state_t; 365 366 #ifdef __cplusplus 367 } 368 #endif 369 370 #endif /* _SYS_FS_ZFS_H */ 371