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