xref: /illumos-gate/usr/src/lib/libzfs/common/libzfs.h (revision 5d7b4d43)
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  */
21f3861e1aSahl 
22fa9e4066Sahrens /*
233f9d6ad7SLin Ling  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
2478f17100SMatthew Ahrens  * Copyright (c) 2013 by Delphix. All rights reserved.
254e3c9f44SBill Pijewski  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
26a7a845e4SSteven Hartland  * Copyright (c) 2013 Steven Hartland. All rights reserved.
2743d68d68SYuri Pankov  * Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
28fa9e4066Sahrens  */
29fa9e4066Sahrens 
30fa9e4066Sahrens #ifndef	_LIBZFS_H
31fa9e4066Sahrens #define	_LIBZFS_H
32fa9e4066Sahrens 
33fa9e4066Sahrens #include <assert.h>
34fa9e4066Sahrens #include <libnvpair.h>
35ebedde84SEric Taylor #include <sys/mnttab.h>
36fa9e4066Sahrens #include <sys/param.h>
37fa9e4066Sahrens #include <sys/types.h>
38fa9e4066Sahrens #include <sys/varargs.h>
39fa9e4066Sahrens #include <sys/fs/zfs.h>
40ecd6cf80Smarks #include <sys/avl.h>
41ecd6cf80Smarks #include <ucred.h>
42*5d7b4d43SMatthew Ahrens #include <libzfs_core.h>
43fa9e4066Sahrens 
44fa9e4066Sahrens #ifdef	__cplusplus
45fa9e4066Sahrens extern "C" {
46fa9e4066Sahrens #endif
47fa9e4066Sahrens 
48fa9e4066Sahrens /*
49fa9e4066Sahrens  * Miscellaneous ZFS constants
50fa9e4066Sahrens  */
51fa9e4066Sahrens #define	ZFS_MAXNAMELEN		MAXNAMELEN
52fa9e4066Sahrens #define	ZPOOL_MAXNAMELEN	MAXNAMELEN
53fa9e4066Sahrens #define	ZFS_MAXPROPLEN		MAXPATHLEN
54990b4856Slling #define	ZPOOL_MAXPROPLEN	MAXPATHLEN
55fa9e4066Sahrens 
5699653d4eSeschrock /*
5799653d4eSeschrock  * libzfs errors
5899653d4eSeschrock  */
594445fffbSMatthew Ahrens typedef enum zfs_error {
604445fffbSMatthew Ahrens 	EZFS_SUCCESS = 0,	/* no error -- success */
6199653d4eSeschrock 	EZFS_NOMEM = 2000,	/* out of memory */
6299653d4eSeschrock 	EZFS_BADPROP,		/* invalid property value */
6399653d4eSeschrock 	EZFS_PROPREADONLY,	/* cannot set readonly property */
6499653d4eSeschrock 	EZFS_PROPTYPE,		/* property does not apply to dataset type */
6599653d4eSeschrock 	EZFS_PROPNONINHERIT,	/* property is not inheritable */
6699653d4eSeschrock 	EZFS_PROPSPACE,		/* bad quota or reservation */
6799653d4eSeschrock 	EZFS_BADTYPE,		/* dataset is not of appropriate type */
6899653d4eSeschrock 	EZFS_BUSY,		/* pool or dataset is busy */
6999653d4eSeschrock 	EZFS_EXISTS,		/* pool or dataset already exists */
7099653d4eSeschrock 	EZFS_NOENT,		/* no such pool or dataset */
7199653d4eSeschrock 	EZFS_BADSTREAM,		/* bad backup stream */
7299653d4eSeschrock 	EZFS_DSREADONLY,	/* dataset is readonly */
7399653d4eSeschrock 	EZFS_VOLTOOBIG,		/* volume is too large for 32-bit system */
7499653d4eSeschrock 	EZFS_INVALIDNAME,	/* invalid dataset name */
7599653d4eSeschrock 	EZFS_BADRESTORE,	/* unable to restore to destination */
7699653d4eSeschrock 	EZFS_BADBACKUP,		/* backup failed */
7799653d4eSeschrock 	EZFS_BADTARGET,		/* bad attach/detach/replace target */
7899653d4eSeschrock 	EZFS_NODEVICE,		/* no such device in pool */
7999653d4eSeschrock 	EZFS_BADDEV,		/* invalid device to add */
8099653d4eSeschrock 	EZFS_NOREPLICAS,	/* no valid replicas */
8199653d4eSeschrock 	EZFS_RESILVERING,	/* currently resilvering */
8299653d4eSeschrock 	EZFS_BADVERSION,	/* unsupported version */
8399653d4eSeschrock 	EZFS_POOLUNAVAIL,	/* pool is currently unavailable */
8499653d4eSeschrock 	EZFS_DEVOVERFLOW,	/* too many devices in one vdev */
8599653d4eSeschrock 	EZFS_BADPATH,		/* must be an absolute path */
8699653d4eSeschrock 	EZFS_CROSSTARGET,	/* rename or clone across pool or dataset */
8799653d4eSeschrock 	EZFS_ZONED,		/* used improperly in local zone */
8899653d4eSeschrock 	EZFS_MOUNTFAILED,	/* failed to mount dataset */
8999653d4eSeschrock 	EZFS_UMOUNTFAILED,	/* failed to unmount dataset */
90f3861e1aSahl 	EZFS_UNSHARENFSFAILED,	/* unshare(1M) failed */
91f3861e1aSahl 	EZFS_SHARENFSFAILED,	/* share(1M) failed */
9299653d4eSeschrock 	EZFS_PERM,		/* permission denied */
9399653d4eSeschrock 	EZFS_NOSPC,		/* out of space */
946e27f868SSam Falkner 	EZFS_FAULT,		/* bad address */
9599653d4eSeschrock 	EZFS_IO,		/* I/O error */
9699653d4eSeschrock 	EZFS_INTR,		/* signal received */
9799653d4eSeschrock 	EZFS_ISSPARE,		/* device is a hot spare */
9899653d4eSeschrock 	EZFS_INVALCONFIG,	/* invalid vdev configuration */
993bb79becSeschrock 	EZFS_RECURSIVE,		/* recursive dependency */
10006eeb2adSek 	EZFS_NOHISTORY,		/* no history object */
101b1b8ab34Slling 	EZFS_POOLPROPS,		/* couldn't retrieve pool props */
102b1b8ab34Slling 	EZFS_POOL_NOTSUP,	/* ops not supported for this type of pool */
103b1b8ab34Slling 	EZFS_POOL_INVALARG,	/* invalid argument for this pool operation */
104b7661cccSmmusante 	EZFS_NAMETOOLONG,	/* dataset name is too long */
1058488aeb5Staylor 	EZFS_OPENFAILED,	/* open of device failed */
1068488aeb5Staylor 	EZFS_NOCAP,		/* couldn't get capacity */
1078488aeb5Staylor 	EZFS_LABELFAILED,	/* write of label failed */
108ecd6cf80Smarks 	EZFS_BADWHO,		/* invalid permission who */
109ecd6cf80Smarks 	EZFS_BADPERM,		/* invalid permission */
110ecd6cf80Smarks 	EZFS_BADPERMSET,	/* invalid permission set name */
111ecd6cf80Smarks 	EZFS_NODELEGATION,	/* delegated administration is disabled */
112da6c28aaSamw 	EZFS_UNSHARESMBFAILED,	/* failed to unshare over smb */
113da6c28aaSamw 	EZFS_SHARESMBFAILED,	/* failed to share over smb */
1142f8aaab3Seschrock 	EZFS_BADCACHE,		/* bad cache file */
115fa94a07fSbrendan 	EZFS_ISL2CACHE,		/* device is for the level 2 ARC */
116e7cbe64fSgw 	EZFS_VDEVNOTSUP,	/* unsupported vdev type */
11715e6edf1Sgw 	EZFS_NOTSUP,		/* ops not supported on this dataset */
11889a89ebfSlling 	EZFS_ACTIVE_SPARE,	/* pool has active shared spare devices */
119e6ca193dSGeorge Wilson 	EZFS_UNPLAYED_LOGS,	/* log device has unplayed logs */
120842727c2SChris Kirby 	EZFS_REFTAG_RELE,	/* snapshot release: tag not found */
121842727c2SChris Kirby 	EZFS_REFTAG_HOLD,	/* snapshot hold: tag already exists */
122ca45db41SChris Kirby 	EZFS_TAGTOOLONG,	/* snapshot hold/rele: tag too long */
1239e69d7d0SLori Alt 	EZFS_PIPEFAILED,	/* pipe create failed */
1249e69d7d0SLori Alt 	EZFS_THREADCREATEFAILED, /* thread create failed */
1251195e687SMark J Musante 	EZFS_POSTSPLIT_ONLINE,	/* onlining a disk after splitting it */
1263f9d6ad7SLin Ling 	EZFS_SCRUBBING,		/* currently scrubbing */
1273f9d6ad7SLin Ling 	EZFS_NO_SCRUB,		/* no active scrub */
12899d5e173STim Haley 	EZFS_DIFF,		/* general failure of zfs diff */
12999d5e173STim Haley 	EZFS_DIFFDATA,		/* bad zfs diff data */
130f9af39baSGeorge Wilson 	EZFS_POOLREADONLY,	/* pool is in read-only mode */
131b1b8ab34Slling 	EZFS_UNKNOWN
1324445fffbSMatthew Ahrens } zfs_error_t;
13399653d4eSeschrock 
134ecd6cf80Smarks /*
135ecd6cf80Smarks  * The following data structures are all part
136ecd6cf80Smarks  * of the zfs_allow_t data structure which is
137ecd6cf80Smarks  * used for printing 'allow' permissions.
138ecd6cf80Smarks  * It is a linked list of zfs_allow_t's which
139ecd6cf80Smarks  * then contain avl tree's for user/group/sets/...
140ecd6cf80Smarks  * and each one of the entries in those trees have
141ecd6cf80Smarks  * avl tree's for the permissions they belong to and
142ecd6cf80Smarks  * whether they are local,descendent or local+descendent
143ecd6cf80Smarks  * permissions.  The AVL trees are used primarily for
144ecd6cf80Smarks  * sorting purposes, but also so that we can quickly find
145ecd6cf80Smarks  * a given user and or permission.
146ecd6cf80Smarks  */
147ecd6cf80Smarks typedef struct zfs_perm_node {
148ecd6cf80Smarks 	avl_node_t z_node;
149ecd6cf80Smarks 	char z_pname[MAXPATHLEN];
150ecd6cf80Smarks } zfs_perm_node_t;
151ecd6cf80Smarks 
152ecd6cf80Smarks typedef struct zfs_allow_node {
153ecd6cf80Smarks 	avl_node_t z_node;
154ecd6cf80Smarks 	char z_key[MAXPATHLEN];		/* name, such as joe */
155ecd6cf80Smarks 	avl_tree_t z_localdescend;	/* local+descendent perms */
156ecd6cf80Smarks 	avl_tree_t z_local;		/* local permissions */
157ecd6cf80Smarks 	avl_tree_t z_descend;		/* descendent permissions */
158ecd6cf80Smarks } zfs_allow_node_t;
159ecd6cf80Smarks 
160ecd6cf80Smarks typedef struct zfs_allow {
161ecd6cf80Smarks 	struct zfs_allow *z_next;
162ecd6cf80Smarks 	char z_setpoint[MAXPATHLEN];
163ecd6cf80Smarks 	avl_tree_t z_sets;
164ecd6cf80Smarks 	avl_tree_t z_crperms;
165ecd6cf80Smarks 	avl_tree_t z_user;
166ecd6cf80Smarks 	avl_tree_t z_group;
167ecd6cf80Smarks 	avl_tree_t z_everyone;
168ecd6cf80Smarks } zfs_allow_t;
169ecd6cf80Smarks 
170fa9e4066Sahrens /*
171fa9e4066Sahrens  * Basic handle types
172fa9e4066Sahrens  */
173fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t;
174fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t;
17599653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t;
17699653d4eSeschrock 
17799653d4eSeschrock /*
17899653d4eSeschrock  * Library initialization
17999653d4eSeschrock  */
18099653d4eSeschrock extern libzfs_handle_t *libzfs_init(void);
18199653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *);
18299653d4eSeschrock 
18399653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
18499653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
18599653d4eSeschrock 
18699653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
18799653d4eSeschrock 
1884445fffbSMatthew Ahrens extern void zfs_save_arguments(int argc, char **, char *, int);
1894445fffbSMatthew Ahrens extern int zpool_log_history(libzfs_handle_t *, const char *);
1904445fffbSMatthew Ahrens 
19199653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *);
19299653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *);
19399653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *);
19478f17100SMatthew Ahrens extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
195ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *);
196ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *);
197b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
198ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
199ebedde84SEric Taylor     struct mnttab *);
200ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
201ebedde84SEric Taylor     const char *, const char *);
202ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
203fa9e4066Sahrens 
204fa9e4066Sahrens /*
205fa9e4066Sahrens  * Basic handle functions
206fa9e4066Sahrens  */
20799653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
20899653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
209fa9e4066Sahrens extern void zpool_close(zpool_handle_t *);
210fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *);
211fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *);
212990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
21329ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *);
214fa9e4066Sahrens 
215fa9e4066Sahrens /*
216fa9e4066Sahrens  * Iterate over all active pools in the system.
217fa9e4066Sahrens  */
218fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
21999653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
220fa9e4066Sahrens 
221fa9e4066Sahrens /*
222fa9e4066Sahrens  * Functions to create and destroy pools
223fa9e4066Sahrens  */
22499653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
2250a48a24eStimh     nvlist_t *, nvlist_t *);
2264445fffbSMatthew Ahrens extern int zpool_destroy(zpool_handle_t *, const char *);
227fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *);
228fa9e4066Sahrens 
2291195e687SMark J Musante typedef struct splitflags {
2301195e687SMark J Musante 	/* do not split, but return the config that would be split off */
2311195e687SMark J Musante 	int dryrun : 1;
2321195e687SMark J Musante 
2331195e687SMark J Musante 	/* after splitting, import the pool */
2341195e687SMark J Musante 	int import : 1;
2351195e687SMark J Musante } splitflags_t;
2361195e687SMark J Musante 
237fa9e4066Sahrens /*
238fa9e4066Sahrens  * Functions to manipulate pool and vdev state
239fa9e4066Sahrens  */
2403f9d6ad7SLin Ling extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
241468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
242e9103aaeSGarrett D'Amore extern int zpool_reguid(zpool_handle_t *);
2434263d13fSGeorge Wilson extern int zpool_reopen(zpool_handle_t *);
244fa9e4066Sahrens 
2453d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
2463d7072f8Seschrock     vdev_state_t *);
2473d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
2483d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *,
2493d7072f8Seschrock     const char *, nvlist_t *, int);
250fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *);
25199653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *);
2521195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
2531195e687SMark J Musante     splitflags_t);
2543d7072f8Seschrock 
255069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
256069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
2573d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
2583d7072f8Seschrock 
259fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
260ee0eb9f2SEric Schrock     boolean_t *, boolean_t *);
261573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
262573ca77eSGeorge Wilson     boolean_t *, boolean_t *, boolean_t *);
2638488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
264fa9e4066Sahrens 
265b1b8ab34Slling /*
266b1b8ab34Slling  * Functions to manage pool properties
267b1b8ab34Slling  */
268b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
2693d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
270c58b3526SAdam Stevko     size_t proplen, zprop_source_t *, boolean_t);
271990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
272990b4856Slling     zprop_source_t *);
273990b4856Slling 
274b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t);
275b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t);
276b1b8ab34Slling 
277fa9e4066Sahrens /*
278fa9e4066Sahrens  * Pool health statistics.
279fa9e4066Sahrens  */
280fa9e4066Sahrens typedef enum {
281fa9e4066Sahrens 	/*
282fa9e4066Sahrens 	 * The following correspond to faults as defined in the (fault.fs.zfs.*)
283b81d61a6Slling 	 * event namespace.  Each is associated with a corresponding message ID.
284fa9e4066Sahrens 	 */
285fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */
286fa9e4066Sahrens 	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */
287fa9e4066Sahrens 	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */
288fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */
289b81d61a6Slling 	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */
290fa9e4066Sahrens 	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */
291fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */
292fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */
293fa9e4066Sahrens 	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */
294eaca9bbdSeschrock 	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */
29595173954Sek 	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */
29632b87932Sek 	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */
29732b87932Sek 	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
298f67f35c3SEric Schrock 	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */
299f67f35c3SEric Schrock 
300ad135b5dSChristopher Siden 	/*
301ad135b5dSChristopher Siden 	 * If the pool has unsupported features but can still be opened in
302ad135b5dSChristopher Siden 	 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
303ad135b5dSChristopher Siden 	 * pool has unsupported features but cannot be opened at all, its
304ad135b5dSChristopher Siden 	 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
305ad135b5dSChristopher Siden 	 */
306ad135b5dSChristopher Siden 	ZPOOL_STATUS_UNSUP_FEAT_READ,	/* unsupported features for read */
307ad135b5dSChristopher Siden 	ZPOOL_STATUS_UNSUP_FEAT_WRITE,	/* unsupported features for write */
308ad135b5dSChristopher Siden 
309f67f35c3SEric Schrock 	/*
310f67f35c3SEric Schrock 	 * These faults have no corresponding message ID.  At the time we are
311f67f35c3SEric Schrock 	 * checking the status, the original reason for the FMA fault (I/O or
312f67f35c3SEric Schrock 	 * checksum errors) has been lost.
313f67f35c3SEric Schrock 	 */
3143d7072f8Seschrock 	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */
3153d7072f8Seschrock 	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */
316fa9e4066Sahrens 
317fa9e4066Sahrens 	/*
318fa9e4066Sahrens 	 * The following are not faults per se, but still an error possibly
319b81d61a6Slling 	 * requiring administrative attention.  There is no corresponding
320fa9e4066Sahrens 	 * message ID.
321fa9e4066Sahrens 	 */
32257221772SChristopher Siden 	ZPOOL_STATUS_VERSION_OLDER,	/* older legacy on-disk version */
32357221772SChristopher Siden 	ZPOOL_STATUS_FEAT_DISABLED,	/* supported features are disabled */
324fa9e4066Sahrens 	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */
325fa9e4066Sahrens 	ZPOOL_STATUS_OFFLINE_DEV,	/* device online */
326c25309d4SGeorge Wilson 	ZPOOL_STATUS_REMOVED_DEV,	/* removed device */
327fa9e4066Sahrens 
328fa9e4066Sahrens 	/*
329fa9e4066Sahrens 	 * Finally, the following indicates a healthy pool.
330fa9e4066Sahrens 	 */
331fa9e4066Sahrens 	ZPOOL_STATUS_OK
332fa9e4066Sahrens } zpool_status_t;
333fa9e4066Sahrens 
334ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
335ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **);
3369eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
337fa9e4066Sahrens 
338fa9e4066Sahrens /*
339fa9e4066Sahrens  * Statistics and configuration functions.
340fa9e4066Sahrens  */
341ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
342ad135b5dSChristopher Siden extern nvlist_t *zpool_get_features(zpool_handle_t *);
34394de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
34455434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
345ea8dc4b6Seschrock 
346fa9e4066Sahrens /*
347fa9e4066Sahrens  * Import and export functions
348fa9e4066Sahrens  */
3494445fffbSMatthew Ahrens extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
3504445fffbSMatthew Ahrens extern int zpool_export_force(zpool_handle_t *, const char *);
35199653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
352990b4856Slling     char *altroot);
353990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
3544b964adaSGeorge Wilson     nvlist_t *, int);
355ad135b5dSChristopher Siden extern void zpool_print_unsup_feat(nvlist_t *config);
356fa9e4066Sahrens 
357fa9e4066Sahrens /*
358fa9e4066Sahrens  * Search for pools to import
359fa9e4066Sahrens  */
360d41c4376SMark J Musante 
361d41c4376SMark J Musante typedef struct importargs {
362d41c4376SMark J Musante 	char **path;		/* a list of paths to search		*/
363d41c4376SMark J Musante 	int paths;		/* number of paths to search		*/
364d41c4376SMark J Musante 	char *poolname;		/* name of a pool to find		*/
365d41c4376SMark J Musante 	uint64_t guid;		/* guid of a pool to find		*/
366d41c4376SMark J Musante 	char *cachefile;	/* cachefile to use for import		*/
367d41c4376SMark J Musante 	int can_be_active : 1;	/* can the pool be active?		*/
368d41c4376SMark J Musante 	int unique : 1;		/* does 'poolname' already exist?	*/
369d41c4376SMark J Musante 	int exists : 1;		/* set on return if pool already exists	*/
370d41c4376SMark J Musante } importargs_t;
371d41c4376SMark J Musante 
372d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
373d41c4376SMark J Musante 
374d41c4376SMark J Musante /* legacy pool search routines */
37524e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
3763a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
377e829d913Sck     char *, uint64_t);
378fa9e4066Sahrens 
379c67d9675Seschrock /*
380c67d9675Seschrock  * Miscellaneous pool functions
381c67d9675Seschrock  */
382ecd6cf80Smarks struct zfs_cmd;
383ecd6cf80Smarks 
3844445fffbSMatthew Ahrens extern const char *zfs_history_event_names[];
3858f18d1faSGeorge Wilson 
38688ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
38788ecc943SGeorge Wilson     boolean_t verbose);
388990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t);
38906eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
3908f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
3918f18d1faSGeorge Wilson     nvlist_t ***, uint_t *);
39255434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
39355434c77Sek     size_t len);
394ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
395753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
396468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
397468c413aSTim Haley     nvlist_t *);
398753a6d45SSherry Moore 
399fa9e4066Sahrens /*
400fa9e4066Sahrens  * Basic handle manipulations.  These functions do not create or destroy the
401fa9e4066Sahrens  * underlying datasets, only the references to them.
402fa9e4066Sahrens  */
40399653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
40419b94df9SMatthew Ahrens extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
405fa9e4066Sahrens extern void zfs_close(zfs_handle_t *);
406fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *);
407fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *);
408d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
409fa9e4066Sahrens 
410fa9e4066Sahrens /*
411fa9e4066Sahrens  * Property management functions.  Some functions are shared with the kernel,
412b81d61a6Slling  * and are found in sys/fs/zfs.h.
413fa9e4066Sahrens  */
414990b4856Slling 
415990b4856Slling /*
416990b4856Slling  * zfs dataset property management
417990b4856Slling  */
418990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t);
419990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
420990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t);
421990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t);
422990b4856Slling 
4230a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
4240a48a24eStimh     nvlist_t *, uint64_t, zfs_handle_t *, const char *);
4250a48a24eStimh 
426e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t);
427e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
428e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
429990b4856Slling     zprop_source_t *, char *, size_t, boolean_t);
43092241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
43192241e0bSTom Erickson     boolean_t);
432e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
433990b4856Slling     zprop_source_t *, char *, size_t);
434edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
435edea4b55SLin Ling     uint64_t *propvalue);
43614843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
43714843421SMatthew Ahrens     char *propbuf, int proplen, boolean_t literal);
43819b94df9SMatthew Ahrens extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
43919b94df9SMatthew Ahrens     uint64_t *propvalue);
44019b94df9SMatthew Ahrens extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
44119b94df9SMatthew Ahrens     char *propbuf, int proplen, boolean_t literal);
442ad135b5dSChristopher Siden extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
443ad135b5dSChristopher Siden     char *buf, size_t len);
444e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
44592241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
446e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t);
447e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop);
448990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
44992241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
45019b94df9SMatthew Ahrens extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
45119b94df9SMatthew Ahrens 
452e9dbad6fSeschrock 
453990b4856Slling typedef struct zprop_list {
454990b4856Slling 	int		pl_prop;
455e9dbad6fSeschrock 	char		*pl_user_prop;
456990b4856Slling 	struct zprop_list *pl_next;
457e9dbad6fSeschrock 	boolean_t	pl_all;
458e9dbad6fSeschrock 	size_t		pl_width;
45992241e0bSTom Erickson 	size_t		pl_recvd_width;
460e9dbad6fSeschrock 	boolean_t	pl_fixed;
461990b4856Slling } zprop_list_t;
462e9dbad6fSeschrock 
46343d68d68SYuri Pankov extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
46443d68d68SYuri Pankov     boolean_t);
4652e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
466fa9e4066Sahrens 
467fa9e4066Sahrens #define	ZFS_MOUNTPOINT_NONE	"none"
468fa9e4066Sahrens #define	ZFS_MOUNTPOINT_LEGACY	"legacy"
469fa9e4066Sahrens 
470ad135b5dSChristopher Siden #define	ZFS_FEATURE_DISABLED	"disabled"
471ad135b5dSChristopher Siden #define	ZFS_FEATURE_ENABLED	"enabled"
472ad135b5dSChristopher Siden #define	ZFS_FEATURE_ACTIVE	"active"
473ad135b5dSChristopher Siden 
474ad135b5dSChristopher Siden #define	ZFS_UNSUPPORTED_INACTIVE	"inactive"
475ad135b5dSChristopher Siden #define	ZFS_UNSUPPORTED_READONLY	"readonly"
476ad135b5dSChristopher Siden 
477b1b8ab34Slling /*
478990b4856Slling  * zpool property management
479990b4856Slling  */
480990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
481ad135b5dSChristopher Siden extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
482ad135b5dSChristopher Siden     size_t);
483990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t);
484990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
485990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t);
486990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t);
487990b4856Slling 
488990b4856Slling /*
489990b4856Slling  * Functions shared by zfs and zpool property management.
490b1b8ab34Slling  */
491990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
492990b4856Slling     boolean_t ordered, zfs_type_t type);
493990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
494990b4856Slling     zfs_type_t);
495990b4856Slling extern void zprop_free_list(zprop_list_t *);
496990b4856Slling 
49792241e0bSTom Erickson #define	ZFS_GET_NCOLS	5
49892241e0bSTom Erickson 
49992241e0bSTom Erickson typedef enum {
50092241e0bSTom Erickson 	GET_COL_NONE,
50192241e0bSTom Erickson 	GET_COL_NAME,
50292241e0bSTom Erickson 	GET_COL_PROPERTY,
50392241e0bSTom Erickson 	GET_COL_VALUE,
50492241e0bSTom Erickson 	GET_COL_RECVD,
50592241e0bSTom Erickson 	GET_COL_SOURCE
50692241e0bSTom Erickson } zfs_get_column_t;
50792241e0bSTom Erickson 
508990b4856Slling /*
509990b4856Slling  * Functions for printing zfs or zpool properties
510990b4856Slling  */
511990b4856Slling typedef struct zprop_get_cbdata {
512b1b8ab34Slling 	int cb_sources;
51392241e0bSTom Erickson 	zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
51492241e0bSTom Erickson 	int cb_colwidths[ZFS_GET_NCOLS + 1];
515b1b8ab34Slling 	boolean_t cb_scripted;
516b1b8ab34Slling 	boolean_t cb_literal;
517b1b8ab34Slling 	boolean_t cb_first;
518990b4856Slling 	zprop_list_t *cb_proplist;
519990b4856Slling 	zfs_type_t cb_type;
520990b4856Slling } zprop_get_cbdata_t;
521b1b8ab34Slling 
522990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
52392241e0bSTom Erickson     const char *, const char *, zprop_source_t, const char *,
52492241e0bSTom Erickson     const char *);
525b1b8ab34Slling 
526fa9e4066Sahrens /*
527fa9e4066Sahrens  * Iterator functions.
528fa9e4066Sahrens  */
529fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
53099653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
531fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
5323bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
5337f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
5347f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
535ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
53619b94df9SMatthew Ahrens extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
53778f17100SMatthew Ahrens extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
538fa9e4066Sahrens 
5399d9a58e3SEric Taylor typedef struct get_all_cb {
5409d9a58e3SEric Taylor 	zfs_handle_t	**cb_handles;
5419d9a58e3SEric Taylor 	size_t		cb_alloc;
5429d9a58e3SEric Taylor 	size_t		cb_used;
5439d9a58e3SEric Taylor 	boolean_t	cb_verbose;
5449d9a58e3SEric Taylor 	int		(*cb_getone)(zfs_handle_t *, void *);
5459d9a58e3SEric Taylor } get_all_cb_t;
5469d9a58e3SEric Taylor 
5479d9a58e3SEric Taylor void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
5489d9a58e3SEric Taylor int libzfs_dataset_cmp(const void *, const void *);
5499d9a58e3SEric Taylor 
550fa9e4066Sahrens /*
551fa9e4066Sahrens  * Functions to create and destroy datasets.
552fa9e4066Sahrens  */
55399653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
554e9dbad6fSeschrock     nvlist_t *);
5557f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
556842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t);
557842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
5583b2aab18SMatthew Ahrens extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
559e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
560bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
5614445fffbSMatthew Ahrens extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
5624445fffbSMatthew Ahrens     nvlist_t *props);
563c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
5646a9cb0eaSEric Schrock extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
5659e69d7d0SLori Alt 
5669e69d7d0SLori Alt typedef struct sendflags {
5679e69d7d0SLori Alt 	/* print informational messages (ie, -v was specified) */
56819b94df9SMatthew Ahrens 	boolean_t verbose;
5699e69d7d0SLori Alt 
57092241e0bSTom Erickson 	/* recursive send  (ie, -R) */
57119b94df9SMatthew Ahrens 	boolean_t replicate;
5729e69d7d0SLori Alt 
5739e69d7d0SLori Alt 	/* for incrementals, do all intermediate snapshots */
57419b94df9SMatthew Ahrens 	boolean_t doall;
5759e69d7d0SLori Alt 
5769e69d7d0SLori Alt 	/* if dataset is a clone, do incremental from its origin */
57719b94df9SMatthew Ahrens 	boolean_t fromorigin;
5789e69d7d0SLori Alt 
5799e69d7d0SLori Alt 	/* do deduplication */
58019b94df9SMatthew Ahrens 	boolean_t dedup;
58192241e0bSTom Erickson 
58292241e0bSTom Erickson 	/* send properties (ie, -p) */
58319b94df9SMatthew Ahrens 	boolean_t props;
58419b94df9SMatthew Ahrens 
58519b94df9SMatthew Ahrens 	/* do not send (no-op, ie. -n) */
58619b94df9SMatthew Ahrens 	boolean_t dryrun;
58719b94df9SMatthew Ahrens 
58819b94df9SMatthew Ahrens 	/* parsable verbose output (ie. -P) */
58919b94df9SMatthew Ahrens 	boolean_t parsable;
5904e3c9f44SBill Pijewski 
5914e3c9f44SBill Pijewski 	/* show progress (ie. -v) */
5924e3c9f44SBill Pijewski 	boolean_t progress;
593*5d7b4d43SMatthew Ahrens 
594*5d7b4d43SMatthew Ahrens 	/* WRITE_EMBEDDED records of type DATA are permitted */
595*5d7b4d43SMatthew Ahrens 	boolean_t embed_data;
5969e69d7d0SLori Alt } sendflags_t;
5979e69d7d0SLori Alt 
5989e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
5999e69d7d0SLori Alt 
60019b94df9SMatthew Ahrens extern int zfs_send(zfs_handle_t *, const char *, const char *,
60119b94df9SMatthew Ahrens     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
602*5d7b4d43SMatthew Ahrens extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
6039e69d7d0SLori Alt 
60499653d4eSeschrock extern int zfs_promote(zfs_handle_t *);
6053b2aab18SMatthew Ahrens extern int zfs_hold(zfs_handle_t *, const char *, const char *,
606a7a845e4SSteven Hartland     boolean_t, int);
607a7a845e4SSteven Hartland extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
608842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
6091af68beaSAlexander Stetsenko extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
610c1449561SEric Taylor extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
611fa9e4066Sahrens 
6120aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
61314843421SMatthew Ahrens     uid_t rid, uint64_t space);
61414843421SMatthew Ahrens 
6151af68beaSAlexander Stetsenko extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
6161af68beaSAlexander Stetsenko     zfs_userspace_cb_t, void *);
6171af68beaSAlexander Stetsenko 
6181af68beaSAlexander Stetsenko extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
6191af68beaSAlexander Stetsenko extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
62014843421SMatthew Ahrens 
6213cb34c60Sahrens typedef struct recvflags {
6224ccbb6e7Sahrens 	/* print informational messages (ie, -v was specified) */
62319b94df9SMatthew Ahrens 	boolean_t verbose;
6244ccbb6e7Sahrens 
6254ccbb6e7Sahrens 	/* the destination is a prefix, not the exact fs (ie, -d) */
62619b94df9SMatthew Ahrens 	boolean_t isprefix;
6274ccbb6e7Sahrens 
628f64930f5STom Erickson 	/*
629f64930f5STom Erickson 	 * Only the tail of the sent snapshot path is appended to the
630f64930f5STom Erickson 	 * destination to determine the received snapshot name (ie, -e).
631f64930f5STom Erickson 	 */
63219b94df9SMatthew Ahrens 	boolean_t istail;
633f64930f5STom Erickson 
6344ccbb6e7Sahrens 	/* do not actually do the recv, just check if it would work (ie, -n) */
63519b94df9SMatthew Ahrens 	boolean_t dryrun;
6364ccbb6e7Sahrens 
6374ccbb6e7Sahrens 	/* rollback/destroy filesystems as necessary (eg, -F) */
63819b94df9SMatthew Ahrens 	boolean_t force;
6394ccbb6e7Sahrens 
6404ccbb6e7Sahrens 	/* set "canmount=off" on all modified filesystems */
64119b94df9SMatthew Ahrens 	boolean_t canmountoff;
6424ccbb6e7Sahrens 
6434ccbb6e7Sahrens 	/* byteswap flag is used internally; callers need not specify */
64419b94df9SMatthew Ahrens 	boolean_t byteswap;
64533408eefSLori Alt 
64633408eefSLori Alt 	/* do not mount file systems as they are extracted (private) */
64719b94df9SMatthew Ahrens 	boolean_t nomount;
6483cb34c60Sahrens } recvflags_t;
6493cb34c60Sahrens 
65019b94df9SMatthew Ahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *,
6513cb34c60Sahrens     int, avl_tree_t *);
6523cb34c60Sahrens 
65399d5e173STim Haley typedef enum diff_flags {
65499d5e173STim Haley 	ZFS_DIFF_PARSEABLE = 0x1,
65599d5e173STim Haley 	ZFS_DIFF_TIMESTAMP = 0x2,
65699d5e173STim Haley 	ZFS_DIFF_CLASSIFY = 0x4
65799d5e173STim Haley } diff_flags_t;
65899d5e173STim Haley 
65999d5e173STim Haley extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
66099d5e173STim Haley     int);
66199d5e173STim Haley 
662fa9e4066Sahrens /*
663fa9e4066Sahrens  * Miscellaneous functions.
664fa9e4066Sahrens  */
665fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t);
666fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *);
667fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t);
6685aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
6697f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
6707f1f55eaSvb     zfs_type_t);
6717b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *);
67278f17100SMatthew Ahrens extern boolean_t zfs_bookmark_exists(const char *path);
673fa9e4066Sahrens 
674fa9e4066Sahrens /*
675fa9e4066Sahrens  * Mount support functions.
676fa9e4066Sahrens  */
67755434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
67899653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
679fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int);
680fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int);
681fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int);
682fa9e4066Sahrens 
683fa9e4066Sahrens /*
684fa9e4066Sahrens  * Share support functions.
685fa9e4066Sahrens  */
686f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *);
687fa9e4066Sahrens extern int zfs_share(zfs_handle_t *);
688f3861e1aSahl extern int zfs_unshare(zfs_handle_t *);
689f3861e1aSahl 
690f3861e1aSahl /*
6913d7072f8Seschrock  * Protocol-specific share support functions.
692f3861e1aSahl  */
693f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
694da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
695f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *);
696da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *);
697da6c28aaSamw extern int zfs_shareall(zfs_handle_t *);
698f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
699da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *);
700f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *);
701da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *);
702da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
703da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *);
704743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
705da6c28aaSamw     void *, void *, int, zfs_share_op_t);
706fa9e4066Sahrens 
707fa9e4066Sahrens /*
708fa9e4066Sahrens  * When dealing with nvlists, verify() is extremely useful
709fa9e4066Sahrens  */
710fa9e4066Sahrens #ifdef NDEBUG
711fa9e4066Sahrens #define	verify(EX)	((void)(EX))
712fa9e4066Sahrens #else
713fa9e4066Sahrens #define	verify(EX)	assert(EX)
714fa9e4066Sahrens #endif
715fa9e4066Sahrens 
716fa9e4066Sahrens /*
717fa9e4066Sahrens  * Utility function to convert a number to a human-readable form.
718fa9e4066Sahrens  */
719fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t);
720e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
721fa9e4066Sahrens 
722fa9e4066Sahrens /*
723fa9e4066Sahrens  * Given a device or file, determine if it is part of a pool.
724fa9e4066Sahrens  */
72599653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
72699653d4eSeschrock     boolean_t *);
727fa9e4066Sahrens 
728fa9e4066Sahrens /*
729096d22d4SEric Schrock  * Label manipulation.
730fa9e4066Sahrens  */
73199653d4eSeschrock extern int zpool_read_label(int, nvlist_t **);
732096d22d4SEric Schrock extern int zpool_clear_label(int);
733fa9e4066Sahrens 
734e7cbe64fSgw /* is this zvol valid for use as a dump device? */
735e7cbe64fSgw extern int zvol_check_dump_config(char *);
736e7cbe64fSgw 
737743a77edSAlan Wright /*
738743a77edSAlan Wright  * Management interfaces for SMB ACL files
739743a77edSAlan Wright  */
740743a77edSAlan Wright 
741743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
742743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
743743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
744743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
745743a77edSAlan Wright 
7463bb79becSeschrock /*
747f3861e1aSahl  * Enable and disable datasets within a pool by mounting/unmounting and
748f3861e1aSahl  * sharing/unsharing them.
7493bb79becSeschrock  */
750f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
751f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
7523bb79becSeschrock 
753069f55e2SEric Schrock /*
754069f55e2SEric Schrock  * Mappings between vdev and FRU.
755069f55e2SEric Schrock  */
756069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *);
757069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
758069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
759069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
760069f55e2SEric Schrock     const char *);
761069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
762069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
763069f55e2SEric Schrock 
764fa9e4066Sahrens #ifdef	__cplusplus
765fa9e4066Sahrens }
766fa9e4066Sahrens #endif
767fa9e4066Sahrens 
768fa9e4066Sahrens #endif	/* _LIBZFS_H */
769