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