/*

 * CDDL HEADER START

 *

 * The contents of this file are subject to the terms of the

 * Common Development and Distribution License (the "License").

 * You may not use this file except in compliance with the License.

 *

 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

 * or http://www.opensolaris.org/os/licensing.

 * See the License for the specific language governing permissions

 * and limitations under the License.

 *

 * When distributing Covered Code, include this CDDL HEADER in each

 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.

 * If applicable, add the following below this CDDL HEADER, with the

 * fields enclosed by brackets "[]" replaced with your own identifying

 * information: Portions Copyright [yyyy] [name of copyright owner]

 *

 * CDDL HEADER END

 */

/*

 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.

 */

/* Portions Copyright 2010 Robert Milkowski */

#ifndef	_SYS_FS_ZFS_H

#define	_SYS_FS_ZFS_H

#include <sys/time.h>

#ifdef	__cplusplus

extern "C" {

#endif

/*

 * Types and constants shared between userland and the kernel.

 */

/*

 * Each dataset can be one of the following types.  These constants can be

 * combined into masks that can be passed to various functions.

 */

typedef enum {

	ZFS_TYPE_FILESYSTEM	= 0x1,

	ZFS_TYPE_SNAPSHOT	= 0x2,

	ZFS_TYPE_VOLUME		= 0x4,

	ZFS_TYPE_POOL		= 0x8

} zfs_type_t;

#define	ZFS_TYPE_DATASET	\

	(ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)

#define	ZAP_MAXNAMELEN 256

#define	ZAP_MAXVALUELEN (1024 * 8)

#define	ZAP_OLDMAXVALUELEN 1024

/*

 * Dataset properties are identified by these constants and must be added to

 * the end of this list to ensure that external consumers are not affected

 * by the change. If you make any changes to this list, be sure to update

 * the property table in usr/src/common/zfs/zfs_prop.c.

 */

typedef enum {

	ZFS_PROP_TYPE,

	ZFS_PROP_CREATION,

	ZFS_PROP_USED,

	ZFS_PROP_AVAILABLE,

	ZFS_PROP_REFERENCED,

	ZFS_PROP_COMPRESSRATIO,

	ZFS_PROP_MOUNTED,

	ZFS_PROP_ORIGIN,

	ZFS_PROP_QUOTA,

	ZFS_PROP_RESERVATION,

	ZFS_PROP_VOLSIZE,

	ZFS_PROP_VOLBLOCKSIZE,

	ZFS_PROP_RECORDSIZE,

	ZFS_PROP_MOUNTPOINT,

	ZFS_PROP_SHARENFS,

	ZFS_PROP_CHECKSUM,

	ZFS_PROP_COMPRESSION,

	ZFS_PROP_ATIME,

	ZFS_PROP_DEVICES,

	ZFS_PROP_EXEC,

	ZFS_PROP_SETUID,

	ZFS_PROP_READONLY,

	ZFS_PROP_ZONED,

	ZFS_PROP_SNAPDIR,

	ZFS_PROP_PRIVATE,		/* not exposed to user, temporary */

	ZFS_PROP_ACLINHERIT,

	ZFS_PROP_CREATETXG,		/* not exposed to the user */

	ZFS_PROP_NAME,			/* not exposed to the user */

	ZFS_PROP_CANMOUNT,

	ZFS_PROP_ISCSIOPTIONS,		/* not exposed to the user */

	ZFS_PROP_XATTR,

	ZFS_PROP_NUMCLONES,		/* not exposed to the user */

	ZFS_PROP_COPIES,

	ZFS_PROP_VERSION,

	ZFS_PROP_UTF8ONLY,

	ZFS_PROP_NORMALIZE,

	ZFS_PROP_CASE,

	ZFS_PROP_VSCAN,

	ZFS_PROP_NBMAND,

	ZFS_PROP_SHARESMB,

	ZFS_PROP_REFQUOTA,

	ZFS_PROP_REFRESERVATION,

	ZFS_PROP_GUID,

	ZFS_PROP_PRIMARYCACHE,

	ZFS_PROP_SECONDARYCACHE,

	ZFS_PROP_USEDSNAP,

	ZFS_PROP_USEDDS,

	ZFS_PROP_USEDCHILD,

	ZFS_PROP_USEDREFRESERV,

	ZFS_PROP_USERACCOUNTING,	/* not exposed to the user */

	ZFS_PROP_STMF_SHAREINFO,	/* not exposed to the user */

	ZFS_PROP_DEFER_DESTROY,

	ZFS_PROP_USERREFS,

	ZFS_PROP_LOGBIAS,

	ZFS_PROP_UNIQUE,		/* not exposed to the user */

	ZFS_PROP_OBJSETID,		/* not exposed to the user */

	ZFS_PROP_DEDUP,

	ZFS_PROP_MLSLABEL,

	ZFS_PROP_SYNC,

	ZFS_NUM_PROPS

} zfs_prop_t;

typedef enum {

	ZFS_PROP_USERUSED,

	ZFS_PROP_USERQUOTA,

	ZFS_PROP_GROUPUSED,

	ZFS_PROP_GROUPQUOTA,

	ZFS_NUM_USERQUOTA_PROPS

} zfs_userquota_prop_t;

extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];

/*

 * Pool properties are identified by these constants and must be added to the

 * end of this list to ensure that external consumers are not affected

 * by the change. If you make any changes to this list, be sure to update

 * the property table in usr/src/common/zfs/zpool_prop.c.

 */

typedef enum {

	ZPOOL_PROP_NAME,

	ZPOOL_PROP_SIZE,

	ZPOOL_PROP_CAPACITY,

	ZPOOL_PROP_ALTROOT,

	ZPOOL_PROP_HEALTH,

	ZPOOL_PROP_GUID,

	ZPOOL_PROP_VERSION,

	ZPOOL_PROP_BOOTFS,

	ZPOOL_PROP_DELEGATION,

	ZPOOL_PROP_AUTOREPLACE,

	ZPOOL_PROP_CACHEFILE,

	ZPOOL_PROP_FAILUREMODE,

	ZPOOL_PROP_LISTSNAPS,

	ZPOOL_PROP_AUTOEXPAND,

	ZPOOL_PROP_DEDUPDITTO,

	ZPOOL_PROP_DEDUPRATIO,

	ZPOOL_PROP_FREE,

	ZPOOL_PROP_ALLOCATED,

	ZPOOL_NUM_PROPS

} zpool_prop_t;

#define	ZPROP_CONT		-2

#define	ZPROP_INVAL		-1

#define	ZPROP_VALUE		"value"

#define	ZPROP_SOURCE		"source"

typedef enum {

	ZPROP_SRC_NONE = 0x1,

	ZPROP_SRC_DEFAULT = 0x2,

	ZPROP_SRC_TEMPORARY = 0x4,

	ZPROP_SRC_LOCAL = 0x8,

	ZPROP_SRC_INHERITED = 0x10,

	ZPROP_SRC_RECEIVED = 0x20

} zprop_source_t;

#define	ZPROP_SRC_ALL	0x3f

#define	ZPROP_SOURCE_VAL_RECVD	"$recvd"

#define	ZPROP_N_MORE_ERRORS	"N_MORE_ERRORS"

/*

 * Dataset flag implemented as a special entry in the props zap object

 * indicating that the dataset has received properties on or after

 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties

 * just as it did in earlier versions, and thereafter, local properties are

 * preserved.

 */

#define	ZPROP_HAS_RECVD		"$hasrecvd"

typedef enum {

	ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */

	ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */

} zprop_errflags_t;

typedef int (*zprop_func)(int, void *);

/*

 * Properties to be set on the root file system of a new pool

 * are stuffed into their own nvlist, which is then included in

 * the properties nvlist with the pool properties.

 */

#define	ZPOOL_ROOTFS_PROPS	"root-props-nvl"

/*

 * Dataset property functions shared between libzfs and kernel.

 */

const char *zfs_prop_default_string(zfs_prop_t);

uint64_t zfs_prop_default_numeric(zfs_prop_t);

boolean_t zfs_prop_readonly(zfs_prop_t);

boolean_t zfs_prop_inheritable(zfs_prop_t);

boolean_t zfs_prop_setonce(zfs_prop_t);

const char *zfs_prop_to_name(zfs_prop_t);

zfs_prop_t zfs_name_to_prop(const char *);

boolean_t zfs_prop_user(const char *);

boolean_t zfs_prop_userquota(const char *);

int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);

int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);

uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);

boolean_t zfs_prop_valid_for_type(int, zfs_type_t);

/*

 * Pool property functions shared between libzfs and kernel.

 */

zpool_prop_t zpool_name_to_prop(const char *);

const char *zpool_prop_to_name(zpool_prop_t);

const char *zpool_prop_default_string(zpool_prop_t);

uint64_t zpool_prop_default_numeric(zpool_prop_t);

boolean_t zpool_prop_readonly(zpool_prop_t);

int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);

int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);

uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);

/*

 * Definitions for the Delegation.

 */

typedef enum {

	ZFS_DELEG_WHO_UNKNOWN = 0,

	ZFS_DELEG_USER = 'u',

	ZFS_DELEG_USER_SETS = 'U',

	ZFS_DELEG_GROUP = 'g',

	ZFS_DELEG_GROUP_SETS = 'G',

	ZFS_DELEG_EVERYONE = 'e',

	ZFS_DELEG_EVERYONE_SETS = 'E',

	ZFS_DELEG_CREATE = 'c',

	ZFS_DELEG_CREATE_SETS = 'C',

	ZFS_DELEG_NAMED_SET = 's',

	ZFS_DELEG_NAMED_SET_SETS = 'S'

} zfs_deleg_who_type_t;

typedef enum {

	ZFS_DELEG_NONE = 0,

	ZFS_DELEG_PERM_LOCAL = 1,

	ZFS_DELEG_PERM_DESCENDENT = 2,

	ZFS_DELEG_PERM_LOCALDESCENDENT = 3,

	ZFS_DELEG_PERM_CREATE = 4

} zfs_deleg_inherit_t;

#define	ZFS_DELEG_PERM_UID	"uid"

#define	ZFS_DELEG_PERM_GID	"gid"

#define	ZFS_DELEG_PERM_GROUPS	"groups"

#define	ZFS_MLSLABEL_DEFAULT	"none"

#define	ZFS_SMB_ACL_SRC		"src"

#define	ZFS_SMB_ACL_TARGET	"target"

typedef enum {

	ZFS_CANMOUNT_OFF = 0,

	ZFS_CANMOUNT_ON = 1,

	ZFS_CANMOUNT_NOAUTO = 2

} zfs_canmount_type_t;

typedef enum {

	ZFS_LOGBIAS_LATENCY = 0,

	ZFS_LOGBIAS_THROUGHPUT = 1

} zfs_logbias_op_t;

typedef enum zfs_share_op {

	ZFS_SHARE_NFS = 0,

	ZFS_UNSHARE_NFS = 1,

	ZFS_SHARE_SMB = 2,

	ZFS_UNSHARE_SMB = 3

} zfs_share_op_t;

typedef enum zfs_smb_acl_op {

	ZFS_SMB_ACL_ADD,

	ZFS_SMB_ACL_REMOVE,

	ZFS_SMB_ACL_RENAME,

	ZFS_SMB_ACL_PURGE

} zfs_smb_acl_op_t;

typedef enum zfs_cache_type {

	ZFS_CACHE_NONE = 0,

	ZFS_CACHE_METADATA = 1,

	ZFS_CACHE_ALL = 2

} zfs_cache_type_t;

typedef enum {

	ZFS_SYNC_STANDARD = 0,

	ZFS_SYNC_ALWAYS = 1,

	ZFS_SYNC_DISABLED = 2

} zfs_sync_type_t;

/*

 * On-disk version number.

 */

#define	SPA_VERSION_1			1ULL

#define	SPA_VERSION_2			2ULL

#define	SPA_VERSION_3			3ULL

#define	SPA_VERSION_4			4ULL

#define	SPA_VERSION_5			5ULL

#define	SPA_VERSION_6			6ULL

#define	SPA_VERSION_7			7ULL

#define	SPA_VERSION_8			8ULL

#define	SPA_VERSION_9			9ULL

#define	SPA_VERSION_10			10ULL

#define	SPA_VERSION_11			11ULL

#define	SPA_VERSION_12			12ULL

#define	SPA_VERSION_13			13ULL

#define	SPA_VERSION_14			14ULL

#define	SPA_VERSION_15			15ULL

#define	SPA_VERSION_16			16ULL

#define	SPA_VERSION_17			17ULL

#define	SPA_VERSION_18			18ULL

#define	SPA_VERSION_19			19ULL

#define	SPA_VERSION_20			20ULL

#define	SPA_VERSION_21			21ULL

#define	SPA_VERSION_22			22ULL

#define	SPA_VERSION_23			23ULL

#define	SPA_VERSION_24			24ULL

#define	SPA_VERSION_25			25ULL

#define	SPA_VERSION_26			26ULL

#define	SPA_VERSION_27			27ULL

/*

 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk

 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},

 * and do the appropriate changes.  Also bump the version number in

 * usr/src/grub/capability.

 */

/*

 * Symbolic names for the changes that caused a SPA_VERSION switch.

 * Used in the code when checking for presence or absence of a feature.

 * Feel free to define multiple symbolic names for each version if there

 * were multiple changes to on-disk structures during that version.

 *

 * NOTE: When checking the current SPA_VERSION in your code, be sure

 *       to use spa_version() since it reports the version of the

 *       last synced uberblock.  Checking the in-flight version can

 *       be dangerous in some cases.

 */

#define	SPA_VERSION_INITIAL		SPA_VERSION_1

#define	SPA_VERSION_DITTO_BLOCKS	SPA_VERSION_2

#define	SPA_VERSION_SPARES		SPA_VERSION_3

#define	SPA_VERSION_RAIDZ2		SPA_VERSION_3

#define	SPA_VERSION_BPOBJ_ACCOUNT	SPA_VERSION_3

#define	SPA_VERSION_RAIDZ_DEFLATE	SPA_VERSION_3

#define	SPA_VERSION_DNODE_BYTES		SPA_VERSION_3

#define	SPA_VERSION_ZPOOL_HISTORY	SPA_VERSION_4

#define	SPA_VERSION_GZIP_COMPRESSION	SPA_VERSION_5

#define	SPA_VERSION_BOOTFS		SPA_VERSION_6

#define	SPA_VERSION_SLOGS		SPA_VERSION_7

#define	SPA_VERSION_DELEGATED_PERMS	SPA_VERSION_8

#define	SPA_VERSION_FUID		SPA_VERSION_9

#define	SPA_VERSION_REFRESERVATION	SPA_VERSION_9

#define	SPA_VERSION_REFQUOTA		SPA_VERSION_9

#define	SPA_VERSION_UNIQUE_ACCURATE	SPA_VERSION_9

#define	SPA_VERSION_L2CACHE		SPA_VERSION_10

#define	SPA_VERSION_NEXT_CLONES		SPA_VERSION_11

#define	SPA_VERSION_ORIGIN		SPA_VERSION_11

#define	SPA_VERSION_DSL_SCRUB		SPA_VERSION_11

#define	SPA_VERSION_SNAP_PROPS		SPA_VERSION_12

#define	SPA_VERSION_USED_BREAKDOWN	SPA_VERSION_13

#define	SPA_VERSION_PASSTHROUGH_X	SPA_VERSION_14

#define	SPA_VERSION_USERSPACE		SPA_VERSION_15

#define	SPA_VERSION_STMF_PROP		SPA_VERSION_16

#define	SPA_VERSION_RAIDZ3		SPA_VERSION_17

#define	SPA_VERSION_USERREFS		SPA_VERSION_18

#define	SPA_VERSION_HOLES		SPA_VERSION_19

#define	SPA_VERSION_ZLE_COMPRESSION	SPA_VERSION_20

#define	SPA_VERSION_DEDUP		SPA_VERSION_21

#define	SPA_VERSION_RECVD_PROPS		SPA_VERSION_22

#define	SPA_VERSION_SLIM_ZIL		SPA_VERSION_23

#define	SPA_VERSION_SA			SPA_VERSION_24

#define	SPA_VERSION_SCAN		SPA_VERSION_25

#define	SPA_VERSION_DIR_CLONES		SPA_VERSION_26

#define	SPA_VERSION_DEADLISTS		SPA_VERSION_26

#define	SPA_VERSION_FAST_SNAP		SPA_VERSION_27

/*

 * ZPL version - rev'd whenever an incompatible on-disk format change

 * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must

 * also update the version_table[] and help message in zfs_prop.c.

 *

 * When changing, be sure to teach GRUB how to read the new format!

 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}

 */

#define	ZPL_VERSION_1			1ULL

#define	ZPL_VERSION_2			2ULL

#define	ZPL_VERSION_3			3ULL

#define	ZPL_VERSION_4			4ULL

#define	ZPL_VERSION_5			5ULL

#define	ZPL_VERSION			ZPL_VERSION_5

#define	ZPL_VERSION_STRING		"5"

#define	ZPL_VERSION_INITIAL		ZPL_VERSION_1

#define	ZPL_VERSION_DIRENT_TYPE		ZPL_VERSION_2

#define	ZPL_VERSION_FUID		ZPL_VERSION_3

#define	ZPL_VERSION_NORMALIZATION	ZPL_VERSION_3

#define	ZPL_VERSION_SYSATTR		ZPL_VERSION_3

#define	ZPL_VERSION_USERSPACE		ZPL_VERSION_4

#define	ZPL_VERSION_SA			ZPL_VERSION_5

/* Rewind request information */

#define	ZPOOL_NO_REWIND		1  /* No policy - default behavior */

#define	ZPOOL_NEVER_REWIND	2  /* Do not search for best txg or rewind */

#define	ZPOOL_TRY_REWIND	4  /* Search for best txg, but do not rewind */

#define	ZPOOL_DO_REWIND		8  /* Rewind to best txg w/in deferred frees */

#define	ZPOOL_EXTREME_REWIND	16 /* Allow extreme measures to find best txg */

#define	ZPOOL_REWIND_MASK	28 /* All the possible rewind bits */

#define	ZPOOL_REWIND_POLICIES	31 /* All the possible policy bits */

typedef struct zpool_rewind_policy {

	uint32_t	zrp_request;	/* rewind behavior requested */

	uint64_t	zrp_maxmeta;	/* max acceptable meta-data errors */

	uint64_t	zrp_maxdata;	/* max acceptable data errors */

	uint64_t	zrp_txg;	/* specific txg to load */

} zpool_rewind_policy_t;

/*

 * The following are configuration names used in the nvlist describing a pool's

 * configuration.

 */

#define	ZPOOL_CONFIG_VERSION		"version"

#define	ZPOOL_CONFIG_POOL_NAME		"name"

#define	ZPOOL_CONFIG_POOL_STATE		"state"

#define	ZPOOL_CONFIG_POOL_TXG		"txg"

#define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"

#define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"

#define	ZPOOL_CONFIG_TOP_GUID		"top_guid"

#define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"

#define	ZPOOL_CONFIG_TYPE		"type"

#define	ZPOOL_CONFIG_CHILDREN		"children"

#define	ZPOOL_CONFIG_ID			"id"

#define	ZPOOL_CONFIG_GUID		"guid"

#define	ZPOOL_CONFIG_PATH		"path"

#define	ZPOOL_CONFIG_DEVID		"devid"

#define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"

#define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"

#define	ZPOOL_CONFIG_ASHIFT		"ashift"

#define	ZPOOL_CONFIG_ASIZE		"asize"

#define	ZPOOL_CONFIG_DTL		"DTL"

#define	ZPOOL_CONFIG_SCAN_STATS		"scan_stats"	/* not stored on disk */

#define	ZPOOL_CONFIG_VDEV_STATS		"vdev_stats"	/* not stored on disk */

#define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"

#define	ZPOOL_CONFIG_ERRCOUNT		"error_count"

#define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"

#define	ZPOOL_CONFIG_SPARES		"spares"

#define	ZPOOL_CONFIG_IS_SPARE		"is_spare"

#define	ZPOOL_CONFIG_NPARITY		"nparity"

#define	ZPOOL_CONFIG_HOSTID		"hostid"

#define	ZPOOL_CONFIG_HOSTNAME		"hostname"

#define	ZPOOL_CONFIG_LOADED_TIME	"initial_load_time"

#define	ZPOOL_CONFIG_UNSPARE		"unspare"

#define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"

#define	ZPOOL_CONFIG_IS_LOG		"is_log"

#define	ZPOOL_CONFIG_L2CACHE		"l2cache"

#define	ZPOOL_CONFIG_HOLE_ARRAY		"hole_array"

#define	ZPOOL_CONFIG_VDEV_CHILDREN	"vdev_children"

#define	ZPOOL_CONFIG_IS_HOLE		"is_hole"

#define	ZPOOL_CONFIG_DDT_HISTOGRAM	"ddt_histogram"

#define	ZPOOL_CONFIG_DDT_OBJ_STATS	"ddt_object_stats"

#define	ZPOOL_CONFIG_DDT_STATS		"ddt_stats"

#define	ZPOOL_CONFIG_SPLIT		"splitcfg"

#define	ZPOOL_CONFIG_ORIG_GUID		"orig_guid"

#define	ZPOOL_CONFIG_SPLIT_GUID		"split_guid"

#define	ZPOOL_CONFIG_SPLIT_LIST		"guid_list"

#define	ZPOOL_CONFIG_REMOVING		"removing"

#define	ZPOOL_CONFIG_SUSPENDED		"suspended"	/* not stored on disk */