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