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