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