/*

 * 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.

 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.

 * Copyright (c) 2012 by Delphix. All rights reserved.

 * Copyright (c) 2012, Joyent, Inc. All rights reserved.

 */

#ifndef	_LIBZFS_H

#define	_LIBZFS_H

#include <assert.h>

#include <libnvpair.h>

#include <sys/mnttab.h>

#include <sys/param.h>

#include <sys/types.h>

#include <sys/varargs.h>

#include <sys/fs/zfs.h>

#include <sys/avl.h>

#include <ucred.h>

#ifdef	__cplusplus

extern "C" {

#endif

/*

 * Miscellaneous ZFS constants

 */

#define	ZFS_MAXNAMELEN		MAXNAMELEN

#define	ZPOOL_MAXNAMELEN	MAXNAMELEN

#define	ZFS_MAXPROPLEN		MAXPATHLEN

#define	ZPOOL_MAXPROPLEN	MAXPATHLEN

/*

 * libzfs errors

 */

enum {

	EZFS_NOMEM = 2000,	/* out of memory */

	EZFS_BADPROP,		/* invalid property value */

	EZFS_PROPREADONLY,	/* cannot set readonly property */

	EZFS_PROPTYPE,		/* property does not apply to dataset type */

	EZFS_PROPNONINHERIT,	/* property is not inheritable */

	EZFS_PROPSPACE,		/* bad quota or reservation */

	EZFS_BADTYPE,		/* dataset is not of appropriate type */

	EZFS_BUSY,		/* pool or dataset is busy */

	EZFS_EXISTS,		/* pool or dataset already exists */

	EZFS_NOENT,		/* no such pool or dataset */

	EZFS_BADSTREAM,		/* bad backup stream */

	EZFS_DSREADONLY,	/* dataset is readonly */

	EZFS_VOLTOOBIG,		/* volume is too large for 32-bit system */

	EZFS_INVALIDNAME,	/* invalid dataset name */

	EZFS_BADRESTORE,	/* unable to restore to destination */

	EZFS_BADBACKUP,		/* backup failed */

	EZFS_BADTARGET,		/* bad attach/detach/replace target */

	EZFS_NODEVICE,		/* no such device in pool */

	EZFS_BADDEV,		/* invalid device to add */

	EZFS_NOREPLICAS,	/* no valid replicas */

	EZFS_RESILVERING,	/* currently resilvering */

	EZFS_BADVERSION,	/* unsupported version */

	EZFS_POOLUNAVAIL,	/* pool is currently unavailable */

	EZFS_DEVOVERFLOW,	/* too many devices in one vdev */

	EZFS_BADPATH,		/* must be an absolute path */

	EZFS_CROSSTARGET,	/* rename or clone across pool or dataset */

	EZFS_ZONED,		/* used improperly in local zone */

	EZFS_MOUNTFAILED,	/* failed to mount dataset */

	EZFS_UMOUNTFAILED,	/* failed to unmount dataset */

	EZFS_UNSHARENFSFAILED,	/* unshare(1M) failed */

	EZFS_SHARENFSFAILED,	/* share(1M) failed */

	EZFS_PERM,		/* permission denied */

	EZFS_NOSPC,		/* out of space */

	EZFS_FAULT,		/* bad address */

	EZFS_IO,		/* I/O error */

	EZFS_INTR,		/* signal received */

	EZFS_ISSPARE,		/* device is a hot spare */

	EZFS_INVALCONFIG,	/* invalid vdev configuration */

	EZFS_RECURSIVE,		/* recursive dependency */

	EZFS_NOHISTORY,		/* no history object */

	EZFS_POOLPROPS,		/* couldn't retrieve pool props */

	EZFS_POOL_NOTSUP,	/* ops not supported for this type of pool */

	EZFS_POOL_INVALARG,	/* invalid argument for this pool operation */

	EZFS_NAMETOOLONG,	/* dataset name is too long */

	EZFS_OPENFAILED,	/* open of device failed */

	EZFS_NOCAP,		/* couldn't get capacity */

	EZFS_LABELFAILED,	/* write of label failed */

	EZFS_BADWHO,		/* invalid permission who */

	EZFS_BADPERM,		/* invalid permission */

	EZFS_BADPERMSET,	/* invalid permission set name */

	EZFS_NODELEGATION,	/* delegated administration is disabled */

	EZFS_UNSHARESMBFAILED,	/* failed to unshare over smb */

	EZFS_SHARESMBFAILED,	/* failed to share over smb */

	EZFS_BADCACHE,		/* bad cache file */

	EZFS_ISL2CACHE,		/* device is for the level 2 ARC */

	EZFS_VDEVNOTSUP,	/* unsupported vdev type */

	EZFS_NOTSUP,		/* ops not supported on this dataset */

	EZFS_ACTIVE_SPARE,	/* pool has active shared spare devices */

	EZFS_UNPLAYED_LOGS,	/* log device has unplayed logs */

	EZFS_REFTAG_RELE,	/* snapshot release: tag not found */

	EZFS_REFTAG_HOLD,	/* snapshot hold: tag already exists */

	EZFS_TAGTOOLONG,	/* snapshot hold/rele: tag too long */

	EZFS_PIPEFAILED,	/* pipe create failed */

	EZFS_THREADCREATEFAILED, /* thread create failed */

	EZFS_POSTSPLIT_ONLINE,	/* onlining a disk after splitting it */

	EZFS_SCRUBBING,		/* currently scrubbing */

	EZFS_NO_SCRUB,		/* no active scrub */

	EZFS_DIFF,		/* general failure of zfs diff */

	EZFS_DIFFDATA,		/* bad zfs diff data */

	EZFS_POOLREADONLY,	/* pool is in read-only mode */

	EZFS_UNKNOWN

};

/*

 * The following data structures are all part

 * of the zfs_allow_t data structure which is

 * used for printing 'allow' permissions.

 * It is a linked list of zfs_allow_t's which

 * then contain avl tree's for user/group/sets/...

 * and each one of the entries in those trees have

 * avl tree's for the permissions they belong to and

 * whether they are local,descendent or local+descendent

 * permissions.  The AVL trees are used primarily for

 * sorting purposes, but also so that we can quickly find

 * a given user and or permission.

 */

typedef struct zfs_perm_node {

	avl_node_t z_node;

	char z_pname[MAXPATHLEN];

} zfs_perm_node_t;

typedef struct zfs_allow_node {

	avl_node_t z_node;

	char z_key[MAXPATHLEN];		/* name, such as joe */

	avl_tree_t z_localdescend;	/* local+descendent perms */

	avl_tree_t z_local;		/* local permissions */

	avl_tree_t z_descend;		/* descendent permissions */

} zfs_allow_node_t;

typedef struct zfs_allow {

	struct zfs_allow *z_next;

	char z_setpoint[MAXPATHLEN];

	avl_tree_t z_sets;

	avl_tree_t z_crperms;

	avl_tree_t z_user;

	avl_tree_t z_group;

	avl_tree_t z_everyone;

} zfs_allow_t;

/*

 * Basic handle types

 */

typedef struct zfs_handle zfs_handle_t;

typedef struct zpool_handle zpool_handle_t;

typedef struct libzfs_handle libzfs_handle_t;

/*

 * Library initialization

 */

extern libzfs_handle_t *libzfs_init(void);

extern void libzfs_fini(libzfs_handle_t *);

extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);

extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);

extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);

extern int libzfs_errno(libzfs_handle_t *);

extern const char *libzfs_error_action(libzfs_handle_t *);

extern const char *libzfs_error_description(libzfs_handle_t *);

extern void libzfs_mnttab_init(libzfs_handle_t *);

extern void libzfs_mnttab_fini(libzfs_handle_t *);

extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);

extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,

    struct mnttab *);

extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,

    const char *, const char *);

extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);

/*

 * Basic handle functions

 */

extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);

extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);

extern void zpool_close(zpool_handle_t *);

extern const char *zpool_get_name(zpool_handle_t *);

extern int zpool_get_state(zpool_handle_t *);

extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);

extern void zpool_free_handles(libzfs_handle_t *);

/*

 * Iterate over all active pools in the system.

 */

typedef int (*zpool_iter_f)(zpool_handle_t *, void *);

extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);

/*

 * Functions to create and destroy pools

 */

extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,

    nvlist_t *, nvlist_t *);

extern int zpool_destroy(zpool_handle_t *);

extern int zpool_add(zpool_handle_t *, nvlist_t *);

typedef struct splitflags {

	/* do not split, but return the config that would be split off */

	int dryrun : 1;

	/* after splitting, import the pool */

	int import : 1;

} splitflags_t;

/*

 * Functions to manipulate pool and vdev state

 */

extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);

extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);

extern int zpool_reguid(zpool_handle_t *);

extern int zpool_reopen(zpool_handle_t *);

extern int zpool_vdev_online(zpool_handle_t *, const char *, int,

    vdev_state_t *);

extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);

extern int zpool_vdev_attach(zpool_handle_t *, const char *,

    const char *, nvlist_t *, int);

extern int zpool_vdev_detach(zpool_handle_t *, const char *);

extern int zpool_vdev_remove(zpool_handle_t *, const char *);

extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,

    splitflags_t);

extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);

extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);

extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);

extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,

    boolean_t *, boolean_t *);

extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,

    boolean_t *, boolean_t *, boolean_t *);

extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);

/*

 * Functions to manage pool properties

 */

extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);

extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,

    size_t proplen, zprop_source_t *);

extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,

    zprop_source_t *);

extern const char *zpool_prop_to_name(zpool_prop_t);

extern const char *zpool_prop_values(zpool_prop_t);

/*

 * Pool health statistics.

 */

typedef enum {

	/*

	 * The following correspond to faults as defined in the (fault.fs.zfs.*)

	 * event namespace.  Each is associated with a corresponding message ID.

	 */

	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */

	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */

	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */

	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */

	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */

	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */

	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */

	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */

	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */

	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */

	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */

	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */

	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */

	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */

	/*

	 * These faults have no corresponding message ID.  At the time we are

	 * checking the status, the original reason for the FMA fault (I/O or

	 * checksum errors) has been lost.

	 */

	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */

	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */

	/*

	 * The following are not faults per se, but still an error possibly

	 * requiring administrative attention.  There is no corresponding

	 * message ID.

	 */

	ZPOOL_STATUS_VERSION_OLDER,	/* older on-disk version */

	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */

	ZPOOL_STATUS_OFFLINE_DEV,	/* device online */

	ZPOOL_STATUS_REMOVED_DEV,	/* removed device */

	/*

	 * Finally, the following indicates a healthy pool.

	 */

	ZPOOL_STATUS_OK

} zpool_status_t;

extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);

extern zpool_status_t zpool_import_status(nvlist_t *, char **);

extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);

/*

 * Statistics and configuration functions.

 */

extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);

extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);

extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);

/*

 * Import and export functions

 */

extern int zpool_export(zpool_handle_t *, boolean_t);

extern int zpool_export_force(zpool_handle_t *);

extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,

    char *altroot);

extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,

    nvlist_t *, int);

/*

 * Search for pools to import

 */

typedef struct importargs {

	char **path;		/* a list of paths to search		*/

	int paths;		/* number of paths to search		*/

	char *poolname;		/* name of a pool to find		*/

	uint64_t guid;		/* guid of a pool to find		*/

	char *cachefile;	/* cachefile to use for import		*/

	int can_be_active : 1;	/* can the pool be active?		*/

	int unique : 1;		/* does 'poolname' already exist?	*/

	int exists : 1;		/* set on return if pool already exists	*/

} importargs_t;

extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);

/* legacy pool search routines */

extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);

extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,

    char *, uint64_t);

/*

 * Miscellaneous pool functions

 */

struct zfs_cmd;

extern const char *zfs_history_event_names[LOG_END];

extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,

    boolean_t verbose);

extern int zpool_upgrade(zpool_handle_t *, uint64_t);

extern int zpool_get_history(zpool_handle_t *, nvlist_t **);

extern int zpool_history_unpack(char *, uint64_t, uint64_t *,

    nvlist_t ***, uint_t *);

extern void zpool_set_history_str(const char *subcommand, int argc,

    char **argv, char *history_str);

extern int zpool_stage_history(libzfs_handle_t *, const char *);

extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,

    size_t len);

extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);

extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);

extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,

    nvlist_t *);

/*

 * Basic handle manipulations.  These functions do not create or destroy the

 * underlying datasets, only the references to them.

 */

extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);

extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);

extern void zfs_close(zfs_handle_t *);

extern zfs_type_t zfs_get_type(const zfs_handle_t *);

extern const char *zfs_get_name(const zfs_handle_t *);

extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);

/*

 * Property management functions.  Some functions are shared with the kernel,

 * and are found in sys/fs/zfs.h.

 */

/*

 * zfs dataset property management

 */

extern const char *zfs_prop_default_string(zfs_prop_t);

extern uint64_t zfs_prop_default_numeric(zfs_prop_t);

extern const char *zfs_prop_column_name(zfs_prop_t);

extern boolean_t zfs_prop_align_right(zfs_prop_t);

extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,

    nvlist_t *, uint64_t, zfs_handle_t *, const char *);

extern const char *zfs_prop_to_name(zfs_prop_t);

extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);

extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,

    zprop_source_t *, char *, size_t, boolean_t);

extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,

    boolean_t);

extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,

    zprop_source_t *, char *, size_t);

extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,

    uint64_t *propvalue);

extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,

    char *propbuf, int proplen, boolean_t literal);

extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,

    uint64_t *propvalue);

extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,

    char *propbuf, int proplen, boolean_t literal);

extern int zfs_get_snapused_int(zfs_handle_t *firstsnap, zfs_handle_t *lastsnap,

    uint64_t *usedp);

extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);

extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);

extern const char *zfs_prop_values(zfs_prop_t);

extern int zfs_prop_is_string(zfs_prop_t prop);

extern nvlist_t *zfs_get_user_props(zfs_handle_t *);

extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);

extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);

typedef struct zprop_list {

	int		pl_prop;

	char		*pl_user_prop;

	struct zprop_list *pl_next;

	boolean_t	pl_all;

	size_t		pl_width;

	size_t		pl_recvd_width;

	boolean_t	pl_fixed;

} zprop_list_t;

extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t);

extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);

#define	ZFS_MOUNTPOINT_NONE	"none"

#define	ZFS_MOUNTPOINT_LEGACY	"legacy"

/*

 * zpool property management

 */

extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);

extern const char *zpool_prop_default_string(zpool_prop_t);

extern uint64_t zpool_prop_default_numeric(zpool_prop_t);

extern const char *zpool_prop_column_name(zpool_prop_t);

extern boolean_t zpool_prop_align_right(zpool_prop_t);

/*

 * Functions shared by zfs and zpool property management.

 */

extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,

    boolean_t ordered, zfs_type_t type);

extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,

    zfs_type_t);

extern void zprop_free_list(zprop_list_t *);