xref: /illumos-gate/usr/src/lib/libzfs/common/libzfs.h (revision 591e0e133f9980083db5d64ac33a30bcc3382ff7)
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.
240d8fa8f8SMartin Matuska  * Copyright (c) 2011 Pawel Jakub Dawidek. All rights reserved.
255cabbc6bSPrashanth Sreenivasa  * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
264e3c9f44SBill Pijewski  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27a7a845e4SSteven Hartland  * Copyright (c) 2013 Steven Hartland. All rights reserved.
28c3d26abcSMatthew Ahrens  * Copyright (c) 2014 Integros [integros.com]
298808ac5dSYuri Pankov  * Copyright 2016 Nexenta Systems, Inc.
301702cce7SAlek Pinchuk  * Copyright (c) 2017 Datto Inc.
31fa9e4066Sahrens  */
32fa9e4066Sahrens 
33fa9e4066Sahrens #ifndef	_LIBZFS_H
34fa9e4066Sahrens #define	_LIBZFS_H
35fa9e4066Sahrens 
36fa9e4066Sahrens #include <assert.h>
37fa9e4066Sahrens #include <libnvpair.h>
38ebedde84SEric Taylor #include <sys/mnttab.h>
39fa9e4066Sahrens #include <sys/param.h>
40fa9e4066Sahrens #include <sys/types.h>
41fa9e4066Sahrens #include <sys/varargs.h>
42fa9e4066Sahrens #include <sys/fs/zfs.h>
43ecd6cf80Smarks #include <sys/avl.h>
44ecd6cf80Smarks #include <ucred.h>
455d7b4d43SMatthew Ahrens #include <libzfs_core.h>
46fa9e4066Sahrens 
47fa9e4066Sahrens #ifdef	__cplusplus
48fa9e4066Sahrens extern "C" {
49fa9e4066Sahrens #endif
50fa9e4066Sahrens 
51fa9e4066Sahrens /*
52fa9e4066Sahrens  * Miscellaneous ZFS constants
53fa9e4066Sahrens  */
54fa9e4066Sahrens #define	ZFS_MAXPROPLEN		MAXPATHLEN
55990b4856Slling #define	ZPOOL_MAXPROPLEN	MAXPATHLEN
56fa9e4066Sahrens 
5799653d4eSeschrock /*
5899653d4eSeschrock  * libzfs errors
5999653d4eSeschrock  */
604445fffbSMatthew Ahrens typedef enum zfs_error {
614445fffbSMatthew Ahrens 	EZFS_SUCCESS = 0,	/* no error -- success */
6299653d4eSeschrock 	EZFS_NOMEM = 2000,	/* out of memory */
6399653d4eSeschrock 	EZFS_BADPROP,		/* invalid property value */
6499653d4eSeschrock 	EZFS_PROPREADONLY,	/* cannot set readonly property */
6599653d4eSeschrock 	EZFS_PROPTYPE,		/* property does not apply to dataset type */
6699653d4eSeschrock 	EZFS_PROPNONINHERIT,	/* property is not inheritable */
6799653d4eSeschrock 	EZFS_PROPSPACE,		/* bad quota or reservation */
6899653d4eSeschrock 	EZFS_BADTYPE,		/* dataset is not of appropriate type */
6999653d4eSeschrock 	EZFS_BUSY,		/* pool or dataset is busy */
7099653d4eSeschrock 	EZFS_EXISTS,		/* pool or dataset already exists */
7199653d4eSeschrock 	EZFS_NOENT,		/* no such pool or dataset */
7299653d4eSeschrock 	EZFS_BADSTREAM,		/* bad backup stream */
7399653d4eSeschrock 	EZFS_DSREADONLY,	/* dataset is readonly */
7499653d4eSeschrock 	EZFS_VOLTOOBIG,		/* volume is too large for 32-bit system */
7599653d4eSeschrock 	EZFS_INVALIDNAME,	/* invalid dataset name */
7699653d4eSeschrock 	EZFS_BADRESTORE,	/* unable to restore to destination */
7799653d4eSeschrock 	EZFS_BADBACKUP,		/* backup failed */
7899653d4eSeschrock 	EZFS_BADTARGET,		/* bad attach/detach/replace target */
7999653d4eSeschrock 	EZFS_NODEVICE,		/* no such device in pool */
8099653d4eSeschrock 	EZFS_BADDEV,		/* invalid device to add */
8199653d4eSeschrock 	EZFS_NOREPLICAS,	/* no valid replicas */
8299653d4eSeschrock 	EZFS_RESILVERING,	/* currently resilvering */
8399653d4eSeschrock 	EZFS_BADVERSION,	/* unsupported version */
8499653d4eSeschrock 	EZFS_POOLUNAVAIL,	/* pool is currently unavailable */
8599653d4eSeschrock 	EZFS_DEVOVERFLOW,	/* too many devices in one vdev */
8699653d4eSeschrock 	EZFS_BADPATH,		/* must be an absolute path */
8799653d4eSeschrock 	EZFS_CROSSTARGET,	/* rename or clone across pool or dataset */
8899653d4eSeschrock 	EZFS_ZONED,		/* used improperly in local zone */
8999653d4eSeschrock 	EZFS_MOUNTFAILED,	/* failed to mount dataset */
9099653d4eSeschrock 	EZFS_UMOUNTFAILED,	/* failed to unmount dataset */
91f3861e1aSahl 	EZFS_UNSHARENFSFAILED,	/* unshare(1M) failed */
92f3861e1aSahl 	EZFS_SHARENFSFAILED,	/* share(1M) failed */
9399653d4eSeschrock 	EZFS_PERM,		/* permission denied */
9499653d4eSeschrock 	EZFS_NOSPC,		/* out of space */
956e27f868SSam Falkner 	EZFS_FAULT,		/* bad address */
9699653d4eSeschrock 	EZFS_IO,		/* I/O error */
9799653d4eSeschrock 	EZFS_INTR,		/* signal received */
9899653d4eSeschrock 	EZFS_ISSPARE,		/* device is a hot spare */
9999653d4eSeschrock 	EZFS_INVALCONFIG,	/* invalid vdev configuration */
1003bb79becSeschrock 	EZFS_RECURSIVE,		/* recursive dependency */
10106eeb2adSek 	EZFS_NOHISTORY,		/* no history object */
102b1b8ab34Slling 	EZFS_POOLPROPS,		/* couldn't retrieve pool props */
103b1b8ab34Slling 	EZFS_POOL_NOTSUP,	/* ops not supported for this type of pool */
104b1b8ab34Slling 	EZFS_POOL_INVALARG,	/* invalid argument for this pool operation */
105b7661cccSmmusante 	EZFS_NAMETOOLONG,	/* dataset name is too long */
1068488aeb5Staylor 	EZFS_OPENFAILED,	/* open of device failed */
1078488aeb5Staylor 	EZFS_NOCAP,		/* couldn't get capacity */
1088488aeb5Staylor 	EZFS_LABELFAILED,	/* write of label failed */
109ecd6cf80Smarks 	EZFS_BADWHO,		/* invalid permission who */
110ecd6cf80Smarks 	EZFS_BADPERM,		/* invalid permission */
111ecd6cf80Smarks 	EZFS_BADPERMSET,	/* invalid permission set name */
112ecd6cf80Smarks 	EZFS_NODELEGATION,	/* delegated administration is disabled */
113da6c28aaSamw 	EZFS_UNSHARESMBFAILED,	/* failed to unshare over smb */
114da6c28aaSamw 	EZFS_SHARESMBFAILED,	/* failed to share over smb */
1152f8aaab3Seschrock 	EZFS_BADCACHE,		/* bad cache file */
116fa94a07fSbrendan 	EZFS_ISL2CACHE,		/* device is for the level 2 ARC */
117e7cbe64fSgw 	EZFS_VDEVNOTSUP,	/* unsupported vdev type */
11815e6edf1Sgw 	EZFS_NOTSUP,		/* ops not supported on this dataset */
11989a89ebfSlling 	EZFS_ACTIVE_SPARE,	/* pool has active shared spare devices */
120e6ca193dSGeorge Wilson 	EZFS_UNPLAYED_LOGS,	/* log device has unplayed logs */
121842727c2SChris Kirby 	EZFS_REFTAG_RELE,	/* snapshot release: tag not found */
122842727c2SChris Kirby 	EZFS_REFTAG_HOLD,	/* snapshot hold: tag already exists */
123ca45db41SChris Kirby 	EZFS_TAGTOOLONG,	/* snapshot hold/rele: tag too long */
1249e69d7d0SLori Alt 	EZFS_PIPEFAILED,	/* pipe create failed */
1259e69d7d0SLori Alt 	EZFS_THREADCREATEFAILED, /* thread create failed */
1261195e687SMark J Musante 	EZFS_POSTSPLIT_ONLINE,	/* onlining a disk after splitting it */
1273f9d6ad7SLin Ling 	EZFS_SCRUBBING,		/* currently scrubbing */
1283f9d6ad7SLin Ling 	EZFS_NO_SCRUB,		/* no active scrub */
12999d5e173STim Haley 	EZFS_DIFF,		/* general failure of zfs diff */
13099d5e173STim Haley 	EZFS_DIFFDATA,		/* bad zfs diff data */
131f9af39baSGeorge Wilson 	EZFS_POOLREADONLY,	/* pool is in read-only mode */
1321702cce7SAlek Pinchuk 	EZFS_SCRUB_PAUSED,	/* scrub currently paused */
1335cabbc6bSPrashanth Sreenivasa 	EZFS_NO_PENDING,	/* cannot cancel, no operation is pending */
13486714001SSerapheim Dimitropoulos 	EZFS_CHECKPOINT_EXISTS,	/* checkpoint exists */
13586714001SSerapheim Dimitropoulos 	EZFS_DISCARDING_CHECKPOINT,	/* currently discarding a checkpoint */
13686714001SSerapheim Dimitropoulos 	EZFS_NO_CHECKPOINT,	/* pool has no checkpoint */
13786714001SSerapheim Dimitropoulos 	EZFS_DEVRM_IN_PROGRESS,	/* a device is currently being removed */
13886714001SSerapheim Dimitropoulos 	EZFS_VDEV_TOO_BIG,	/* a device is too big to be used */
139094e47e9SGeorge Wilson 	EZFS_TOOMANY,		/* argument list too long */
140094e47e9SGeorge Wilson 	EZFS_INITIALIZING,	/* currently initializing */
141094e47e9SGeorge Wilson 	EZFS_NO_INITIALIZE,	/* no active initialize */
142b1b8ab34Slling 	EZFS_UNKNOWN
1434445fffbSMatthew Ahrens } zfs_error_t;
14499653d4eSeschrock 
1457855d95bSToomas Soome /*
1467855d95bSToomas Soome  * UEFI boot support parameters. When creating whole disk boot pool,
1477855d95bSToomas Soome  * zpool create should allow to create EFI System partition for UEFI boot
1487855d95bSToomas Soome  * program. In case of BIOS, the EFI System partition is not used
1497855d95bSToomas Soome  * even if it does exist.
1507855d95bSToomas Soome  */
1517855d95bSToomas Soome typedef enum zpool_boot_label {
1527855d95bSToomas Soome 	ZPOOL_NO_BOOT_LABEL = 0,
1537855d95bSToomas Soome 	ZPOOL_CREATE_BOOT_LABEL,
1547855d95bSToomas Soome 	ZPOOL_COPY_BOOT_LABEL
1557855d95bSToomas Soome } zpool_boot_label_t;
1567855d95bSToomas Soome 
157ecd6cf80Smarks /*
158ecd6cf80Smarks  * The following data structures are all part
159ecd6cf80Smarks  * of the zfs_allow_t data structure which is
160ecd6cf80Smarks  * used for printing 'allow' permissions.
161ecd6cf80Smarks  * It is a linked list of zfs_allow_t's which
162ecd6cf80Smarks  * then contain avl tree's for user/group/sets/...
163ecd6cf80Smarks  * and each one of the entries in those trees have
164ecd6cf80Smarks  * avl tree's for the permissions they belong to and
165ecd6cf80Smarks  * whether they are local,descendent or local+descendent
166ecd6cf80Smarks  * permissions.  The AVL trees are used primarily for
167ecd6cf80Smarks  * sorting purposes, but also so that we can quickly find
168ecd6cf80Smarks  * a given user and or permission.
169ecd6cf80Smarks  */
170ecd6cf80Smarks typedef struct zfs_perm_node {
171ecd6cf80Smarks 	avl_node_t z_node;
172ecd6cf80Smarks 	char z_pname[MAXPATHLEN];
173ecd6cf80Smarks } zfs_perm_node_t;
174ecd6cf80Smarks 
175ecd6cf80Smarks typedef struct zfs_allow_node {
176ecd6cf80Smarks 	avl_node_t z_node;
177ecd6cf80Smarks 	char z_key[MAXPATHLEN];		/* name, such as joe */
178ecd6cf80Smarks 	avl_tree_t z_localdescend;	/* local+descendent perms */
179ecd6cf80Smarks 	avl_tree_t z_local;		/* local permissions */
180ecd6cf80Smarks 	avl_tree_t z_descend;		/* descendent permissions */
181ecd6cf80Smarks } zfs_allow_node_t;
182ecd6cf80Smarks 
183ecd6cf80Smarks typedef struct zfs_allow {
184ecd6cf80Smarks 	struct zfs_allow *z_next;
185ecd6cf80Smarks 	char z_setpoint[MAXPATHLEN];
186ecd6cf80Smarks 	avl_tree_t z_sets;
187ecd6cf80Smarks 	avl_tree_t z_crperms;
188ecd6cf80Smarks 	avl_tree_t z_user;
189ecd6cf80Smarks 	avl_tree_t z_group;
190ecd6cf80Smarks 	avl_tree_t z_everyone;
191ecd6cf80Smarks } zfs_allow_t;
192ecd6cf80Smarks 
193fa9e4066Sahrens /*
194fa9e4066Sahrens  * Basic handle types
195fa9e4066Sahrens  */
196fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t;
197fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t;
19899653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t;
19999653d4eSeschrock 
20099653d4eSeschrock /*
20199653d4eSeschrock  * Library initialization
20299653d4eSeschrock  */
20399653d4eSeschrock extern libzfs_handle_t *libzfs_init(void);
20499653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *);
20599653d4eSeschrock 
20699653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
20799653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
20899653d4eSeschrock 
20999653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
21099653d4eSeschrock 
2114445fffbSMatthew Ahrens extern void zfs_save_arguments(int argc, char **, char *, int);
2124445fffbSMatthew Ahrens extern int zpool_log_history(libzfs_handle_t *, const char *);
2134445fffbSMatthew Ahrens 
21499653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *);
21599653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *);
21699653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *);
21778f17100SMatthew Ahrens extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
218ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *);
219ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *);
220b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
221ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
222ebedde84SEric Taylor     struct mnttab *);
223ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
224ebedde84SEric Taylor     const char *, const char *);
225ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
226fa9e4066Sahrens 
227fa9e4066Sahrens /*
228fa9e4066Sahrens  * Basic handle functions
229fa9e4066Sahrens  */
23099653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
23199653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
232fa9e4066Sahrens extern void zpool_close(zpool_handle_t *);
233fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *);
234fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *);
2356401734dSWill Andrews extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
2366401734dSWill Andrews extern const char *zpool_pool_state_to_name(pool_state_t);
23729ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *);
238fa9e4066Sahrens 
239fa9e4066Sahrens /*
240fa9e4066Sahrens  * Iterate over all active pools in the system.
241fa9e4066Sahrens  */
242fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
24399653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
2448808ac5dSYuri Pankov extern boolean_t zpool_skip_pool(const char *);
245fa9e4066Sahrens 
246fa9e4066Sahrens /*
247fa9e4066Sahrens  * Functions to create and destroy pools
248fa9e4066Sahrens  */
24999653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
2500a48a24eStimh     nvlist_t *, nvlist_t *);
2514445fffbSMatthew Ahrens extern int zpool_destroy(zpool_handle_t *, const char *);
252fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *);
253fa9e4066Sahrens 
2541195e687SMark J Musante typedef struct splitflags {
2551195e687SMark J Musante 	/* do not split, but return the config that would be split off */
2561195e687SMark J Musante 	int dryrun : 1;
2571195e687SMark J Musante 
2581195e687SMark J Musante 	/* after splitting, import the pool */
2591195e687SMark J Musante 	int import : 1;
2601195e687SMark J Musante } splitflags_t;
2611195e687SMark J Musante 
262fa9e4066Sahrens /*
263fa9e4066Sahrens  * Functions to manipulate pool and vdev state
264fa9e4066Sahrens  */
2651702cce7SAlek Pinchuk extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
266094e47e9SGeorge Wilson extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t,
267094e47e9SGeorge Wilson     nvlist_t *);
268468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
269e9103aaeSGarrett D'Amore extern int zpool_reguid(zpool_handle_t *);
2704263d13fSGeorge Wilson extern int zpool_reopen(zpool_handle_t *);
271fa9e4066Sahrens 
2723d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
2733d7072f8Seschrock     vdev_state_t *);
2743d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
2753d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *,
2763d7072f8Seschrock     const char *, nvlist_t *, int);
277fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *);
27899653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *);
2795cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_remove_cancel(zpool_handle_t *);
2805cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *);
2811195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
2821195e687SMark J Musante     splitflags_t);
2833d7072f8Seschrock 
284069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
285069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
2863d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
2873d7072f8Seschrock 
288fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
289ee0eb9f2SEric Schrock     boolean_t *, boolean_t *);
290573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
291573ca77eSGeorge Wilson     boolean_t *, boolean_t *, boolean_t *);
2927855d95bSToomas Soome extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *,
2937855d95bSToomas Soome     zpool_boot_label_t, uint64_t, int *);
294fa9e4066Sahrens 
295b1b8ab34Slling /*
296b1b8ab34Slling  * Functions to manage pool properties
297b1b8ab34Slling  */
298b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
2993d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
300c58b3526SAdam Stevko     size_t proplen, zprop_source_t *, boolean_t);
301990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
302990b4856Slling     zprop_source_t *);
303990b4856Slling 
304b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t);
305b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t);
306b1b8ab34Slling 
307fa9e4066Sahrens /*
308fa9e4066Sahrens  * Pool health statistics.
309fa9e4066Sahrens  */
310fa9e4066Sahrens typedef enum {
311fa9e4066Sahrens 	/*
312fa9e4066Sahrens 	 * The following correspond to faults as defined in the (fault.fs.zfs.*)
313b81d61a6Slling 	 * event namespace.  Each is associated with a corresponding message ID.
314fa9e4066Sahrens 	 */
315fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */
316fa9e4066Sahrens 	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */
317fa9e4066Sahrens 	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */
318fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */
319b81d61a6Slling 	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */
320fa9e4066Sahrens 	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */
321fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */
322fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */
323fa9e4066Sahrens 	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */
324eaca9bbdSeschrock 	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */
32595173954Sek 	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */
32632b87932Sek 	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */
32732b87932Sek 	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
328f67f35c3SEric Schrock 	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */
329f67f35c3SEric Schrock 
330ad135b5dSChristopher Siden 	/*
331ad135b5dSChristopher Siden 	 * If the pool has unsupported features but can still be opened in
332ad135b5dSChristopher Siden 	 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
333ad135b5dSChristopher Siden 	 * pool has unsupported features but cannot be opened at all, its
334ad135b5dSChristopher Siden 	 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
335ad135b5dSChristopher Siden 	 */
336ad135b5dSChristopher Siden 	ZPOOL_STATUS_UNSUP_FEAT_READ,	/* unsupported features for read */
337ad135b5dSChristopher Siden 	ZPOOL_STATUS_UNSUP_FEAT_WRITE,	/* unsupported features for write */
338ad135b5dSChristopher Siden 
339f67f35c3SEric Schrock 	/*
340f67f35c3SEric Schrock 	 * These faults have no corresponding message ID.  At the time we are
341f67f35c3SEric Schrock 	 * checking the status, the original reason for the FMA fault (I/O or
342f67f35c3SEric Schrock 	 * checksum errors) has been lost.
343f67f35c3SEric Schrock 	 */
3443d7072f8Seschrock 	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */
3453d7072f8Seschrock 	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */
346fa9e4066Sahrens 
347fa9e4066Sahrens 	/*
348fa9e4066Sahrens 	 * The following are not faults per se, but still an error possibly
349b81d61a6Slling 	 * requiring administrative attention.  There is no corresponding
350fa9e4066Sahrens 	 * message ID.
351fa9e4066Sahrens 	 */
35257221772SChristopher Siden 	ZPOOL_STATUS_VERSION_OLDER,	/* older legacy on-disk version */
35357221772SChristopher Siden 	ZPOOL_STATUS_FEAT_DISABLED,	/* supported features are disabled */
354fa9e4066Sahrens 	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */
355cb605c4dSGerhard Roethlin 	ZPOOL_STATUS_OFFLINE_DEV,	/* device offline */
356c25309d4SGeorge Wilson 	ZPOOL_STATUS_REMOVED_DEV,	/* removed device */
357fa9e4066Sahrens 
358fa9e4066Sahrens 	/*
359fa9e4066Sahrens 	 * Finally, the following indicates a healthy pool.
360fa9e4066Sahrens 	 */
361fa9e4066Sahrens 	ZPOOL_STATUS_OK
362fa9e4066Sahrens } zpool_status_t;
363fa9e4066Sahrens 
364ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
365ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **);
3669eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
367fa9e4066Sahrens 
368fa9e4066Sahrens /*
369fa9e4066Sahrens  * Statistics and configuration functions.
370fa9e4066Sahrens  */
371ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
372ad135b5dSChristopher Siden extern nvlist_t *zpool_get_features(zpool_handle_t *);
37394de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
37455434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
3757855d95bSToomas Soome extern boolean_t zpool_is_bootable(zpool_handle_t *);
376ea8dc4b6Seschrock 
377fa9e4066Sahrens /*
378fa9e4066Sahrens  * Import and export functions
379fa9e4066Sahrens  */
3804445fffbSMatthew Ahrens extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
3814445fffbSMatthew Ahrens extern int zpool_export_force(zpool_handle_t *, const char *);
38299653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
383990b4856Slling     char *altroot);
384990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
3854b964adaSGeorge Wilson     nvlist_t *, int);
386ad135b5dSChristopher Siden extern void zpool_print_unsup_feat(nvlist_t *config);
387fa9e4066Sahrens 
388fa9e4066Sahrens /*
389fa9e4066Sahrens  * Search for pools to import
390fa9e4066Sahrens  */
391d41c4376SMark J Musante 
392d41c4376SMark J Musante typedef struct importargs {
393d41c4376SMark J Musante 	char **path;		/* a list of paths to search		*/
394d41c4376SMark J Musante 	int paths;		/* number of paths to search		*/
395d41c4376SMark J Musante 	char *poolname;		/* name of a pool to find		*/
396d41c4376SMark J Musante 	uint64_t guid;		/* guid of a pool to find		*/
397d41c4376SMark J Musante 	char *cachefile;	/* cachefile to use for import		*/
398d41c4376SMark J Musante 	int can_be_active : 1;	/* can the pool be active?		*/
399d41c4376SMark J Musante 	int unique : 1;		/* does 'poolname' already exist?	*/
400d41c4376SMark J Musante 	int exists : 1;		/* set on return if pool already exists	*/
4015dafeea3SPavel Zakharov 	nvlist_t *policy;	/* load policy (max txg, rewind, etc.)	*/
402d41c4376SMark J Musante } importargs_t;
403d41c4376SMark J Musante 
404d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
405d41c4376SMark J Musante 
406d41c4376SMark J Musante /* legacy pool search routines */
40724e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
4083a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
409e829d913Sck     char *, uint64_t);
410fa9e4066Sahrens 
411c67d9675Seschrock /*
412c67d9675Seschrock  * Miscellaneous pool functions
413c67d9675Seschrock  */
414ecd6cf80Smarks struct zfs_cmd;
415ecd6cf80Smarks 
4164445fffbSMatthew Ahrens extern const char *zfs_history_event_names[];
4178f18d1faSGeorge Wilson 
41888ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
41988ecc943SGeorge Wilson     boolean_t verbose);
420990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t);
42106eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
4228f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
4238f18d1faSGeorge Wilson     nvlist_t ***, uint_t *);
42455434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
42555434c77Sek     size_t len);
426ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
427753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
428468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
429468c413aSTim Haley     nvlist_t *);
43086714001SSerapheim Dimitropoulos extern int zpool_checkpoint(zpool_handle_t *);
43186714001SSerapheim Dimitropoulos extern int zpool_discard_checkpoint(zpool_handle_t *);
432753a6d45SSherry Moore 
433fa9e4066Sahrens /*
434fa9e4066Sahrens  * Basic handle manipulations.  These functions do not create or destroy the
435fa9e4066Sahrens  * underlying datasets, only the references to them.
436fa9e4066Sahrens  */
43799653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
43819b94df9SMatthew Ahrens extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
439fa9e4066Sahrens extern void zfs_close(zfs_handle_t *);
440fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *);
441fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *);
442d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
4438808ac5dSYuri Pankov extern const char *zfs_get_pool_name(const zfs_handle_t *);
444fa9e4066Sahrens 
445fa9e4066Sahrens /*
446fa9e4066Sahrens  * Property management functions.  Some functions are shared with the kernel,
447b81d61a6Slling  * and are found in sys/fs/zfs.h.
448fa9e4066Sahrens  */
449990b4856Slling 
450990b4856Slling /*
451990b4856Slling  * zfs dataset property management
452990b4856Slling  */
453990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t);
454990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
455990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t);
456990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t);
457990b4856Slling 
4580a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
459e9316f76SJoe Stein     nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
4600a48a24eStimh 
461e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t);
462e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
46330925561SChris Williamson extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
464e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
465990b4856Slling     zprop_source_t *, char *, size_t, boolean_t);
46692241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
46792241e0bSTom Erickson     boolean_t);
468e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
469990b4856Slling     zprop_source_t *, char *, size_t);
470edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
471edea4b55SLin Ling     uint64_t *propvalue);
47214843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
47314843421SMatthew Ahrens     char *propbuf, int proplen, boolean_t literal);
47419b94df9SMatthew Ahrens extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
47519b94df9SMatthew Ahrens     uint64_t *propvalue);
47619b94df9SMatthew Ahrens extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
47719b94df9SMatthew Ahrens     char *propbuf, int proplen, boolean_t literal);
478ad135b5dSChristopher Siden extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
479ad135b5dSChristopher Siden     char *buf, size_t len);
480e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
48192241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
482e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t);
483e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop);
484990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
48592241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
48619b94df9SMatthew Ahrens extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
48719b94df9SMatthew Ahrens 
488e9dbad6fSeschrock 
489990b4856Slling typedef struct zprop_list {
490990b4856Slling 	int		pl_prop;
491e9dbad6fSeschrock 	char		*pl_user_prop;
492990b4856Slling 	struct zprop_list *pl_next;
493e9dbad6fSeschrock 	boolean_t	pl_all;
494e9dbad6fSeschrock 	size_t		pl_width;
49592241e0bSTom Erickson 	size_t		pl_recvd_width;
496e9dbad6fSeschrock 	boolean_t	pl_fixed;
497990b4856Slling } zprop_list_t;
498e9dbad6fSeschrock 
49943d68d68SYuri Pankov extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
50043d68d68SYuri Pankov     boolean_t);
5012e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
502fa9e4066Sahrens 
503fa9e4066Sahrens #define	ZFS_MOUNTPOINT_NONE	"none"
504fa9e4066Sahrens #define	ZFS_MOUNTPOINT_LEGACY	"legacy"
505fa9e4066Sahrens 
506ad135b5dSChristopher Siden #define	ZFS_FEATURE_DISABLED	"disabled"
507ad135b5dSChristopher Siden #define	ZFS_FEATURE_ENABLED	"enabled"
508ad135b5dSChristopher Siden #define	ZFS_FEATURE_ACTIVE	"active"
509ad135b5dSChristopher Siden 
510ad135b5dSChristopher Siden #define	ZFS_UNSUPPORTED_INACTIVE	"inactive"
511ad135b5dSChristopher Siden #define	ZFS_UNSUPPORTED_READONLY	"readonly"
512ad135b5dSChristopher Siden 
513b1b8ab34Slling /*
514990b4856Slling  * zpool property management
515990b4856Slling  */
516990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
517ad135b5dSChristopher Siden extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
518ad135b5dSChristopher Siden     size_t);
519990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t);
520990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
521990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t);
522990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t);
523990b4856Slling 
524990b4856Slling /*
525990b4856Slling  * Functions shared by zfs and zpool property management.
526b1b8ab34Slling  */
527990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
528990b4856Slling     boolean_t ordered, zfs_type_t type);
529990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
530990b4856Slling     zfs_type_t);
531990b4856Slling extern void zprop_free_list(zprop_list_t *);
532990b4856Slling 
53392241e0bSTom Erickson #define	ZFS_GET_NCOLS	5
53492241e0bSTom Erickson 
53592241e0bSTom Erickson typedef enum {
53692241e0bSTom Erickson 	GET_COL_NONE,
53792241e0bSTom Erickson 	GET_COL_NAME,
53892241e0bSTom Erickson 	GET_COL_PROPERTY,
53992241e0bSTom Erickson 	GET_COL_VALUE,
54092241e0bSTom Erickson 	GET_COL_RECVD,
54192241e0bSTom Erickson 	GET_COL_SOURCE
54292241e0bSTom Erickson } zfs_get_column_t;
54392241e0bSTom Erickson 
544990b4856Slling /*
545990b4856Slling  * Functions for printing zfs or zpool properties
546990b4856Slling  */
547990b4856Slling typedef struct zprop_get_cbdata {
548b1b8ab34Slling 	int cb_sources;
54992241e0bSTom Erickson 	zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
55092241e0bSTom Erickson 	int cb_colwidths[ZFS_GET_NCOLS + 1];
551b1b8ab34Slling 	boolean_t cb_scripted;
552b1b8ab34Slling 	boolean_t cb_literal;
553b1b8ab34Slling 	boolean_t cb_first;
554990b4856Slling 	zprop_list_t *cb_proplist;
555990b4856Slling 	zfs_type_t cb_type;
556990b4856Slling } zprop_get_cbdata_t;
557b1b8ab34Slling 
558990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
55992241e0bSTom Erickson     const char *, const char *, zprop_source_t, const char *,
56092241e0bSTom Erickson     const char *);
561b1b8ab34Slling 
562fa9e4066Sahrens /*
563fa9e4066Sahrens  * Iterator functions.
564fa9e4066Sahrens  */
565fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
56699653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
567fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
5683bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
5697f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
5700d8fa8f8SMartin Matuska extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
571ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
57219b94df9SMatthew Ahrens extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
57378f17100SMatthew Ahrens extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
574fa9e4066Sahrens 
5759d9a58e3SEric Taylor typedef struct get_all_cb {
5769d9a58e3SEric Taylor 	zfs_handle_t	**cb_handles;
5779d9a58e3SEric Taylor 	size_t		cb_alloc;
5789d9a58e3SEric Taylor 	size_t		cb_used;
5799d9a58e3SEric Taylor } get_all_cb_t;
5809d9a58e3SEric Taylor 
581*591e0e13SSebastien Roy void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t,
582*591e0e13SSebastien Roy     zfs_iter_f, void *, boolean_t);
5839d9a58e3SEric Taylor void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
5849d9a58e3SEric Taylor 
585fa9e4066Sahrens /*
586fa9e4066Sahrens  * Functions to create and destroy datasets.
587fa9e4066Sahrens  */
58899653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
589e9dbad6fSeschrock     nvlist_t *);
5907f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
591842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t);
592842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
5933b2aab18SMatthew Ahrens extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
594e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
595bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
5964445fffbSMatthew Ahrens extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
5974445fffbSMatthew Ahrens     nvlist_t *props);
598c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
5996a9cb0eaSEric Schrock extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
6009e69d7d0SLori Alt 
6019e69d7d0SLori Alt typedef struct sendflags {
6029e69d7d0SLori Alt 	/* print informational messages (ie, -v was specified) */
60319b94df9SMatthew Ahrens 	boolean_t verbose;
6049e69d7d0SLori Alt 
60592241e0bSTom Erickson 	/* recursive send  (ie, -R) */
60619b94df9SMatthew Ahrens 	boolean_t replicate;
6079e69d7d0SLori Alt 
6089e69d7d0SLori Alt 	/* for incrementals, do all intermediate snapshots */
60919b94df9SMatthew Ahrens 	boolean_t doall;
6109e69d7d0SLori Alt 
6119e69d7d0SLori Alt 	/* if dataset is a clone, do incremental from its origin */
61219b94df9SMatthew Ahrens 	boolean_t fromorigin;
6139e69d7d0SLori Alt 
6149e69d7d0SLori Alt 	/* do deduplication */
61519b94df9SMatthew Ahrens 	boolean_t dedup;
61692241e0bSTom Erickson 
61792241e0bSTom Erickson 	/* send properties (ie, -p) */
61819b94df9SMatthew Ahrens 	boolean_t props;
61919b94df9SMatthew Ahrens 
62019b94df9SMatthew Ahrens 	/* do not send (no-op, ie. -n) */
62119b94df9SMatthew Ahrens 	boolean_t dryrun;
62219b94df9SMatthew Ahrens 
62319b94df9SMatthew Ahrens 	/* parsable verbose output (ie. -P) */
62419b94df9SMatthew Ahrens 	boolean_t parsable;
6254e3c9f44SBill Pijewski 
6264e3c9f44SBill Pijewski 	/* show progress (ie. -v) */
6274e3c9f44SBill Pijewski 	boolean_t progress;
6285d7b4d43SMatthew Ahrens 
629b5152584SMatthew Ahrens 	/* large blocks (>128K) are permitted */
630b5152584SMatthew Ahrens 	boolean_t largeblock;
631b5152584SMatthew Ahrens 
6325d7b4d43SMatthew Ahrens 	/* WRITE_EMBEDDED records of type DATA are permitted */
6335d7b4d43SMatthew Ahrens 	boolean_t embed_data;
6345602294fSDan Kimmel 
6355602294fSDan Kimmel 	/* compressed WRITE records are permitted */
6365602294fSDan Kimmel 	boolean_t compress;
6379e69d7d0SLori Alt } sendflags_t;
6389e69d7d0SLori Alt 
6399e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
6409e69d7d0SLori Alt 
64119b94df9SMatthew Ahrens extern int zfs_send(zfs_handle_t *, const char *, const char *,
64219b94df9SMatthew Ahrens     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
6435d7b4d43SMatthew Ahrens extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
6449c3fd121SMatthew Ahrens extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
6459c3fd121SMatthew Ahrens     const char *);
6469c3fd121SMatthew Ahrens extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
6479c3fd121SMatthew Ahrens     const char *token);
6489e69d7d0SLori Alt 
64999653d4eSeschrock extern int zfs_promote(zfs_handle_t *);
6503b2aab18SMatthew Ahrens extern int zfs_hold(zfs_handle_t *, const char *, const char *,
651a7a845e4SSteven Hartland     boolean_t, int);
652a7a845e4SSteven Hartland extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
653842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
6541af68beaSAlexander Stetsenko extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
655c1449561SEric Taylor extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
656fa9e4066Sahrens 
6570aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
65814843421SMatthew Ahrens     uid_t rid, uint64_t space);
65914843421SMatthew Ahrens 
6601af68beaSAlexander Stetsenko extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
6611af68beaSAlexander Stetsenko     zfs_userspace_cb_t, void *);
6621af68beaSAlexander Stetsenko 
6631af68beaSAlexander Stetsenko extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
6641af68beaSAlexander Stetsenko extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
66514843421SMatthew Ahrens 
6663cb34c60Sahrens typedef struct recvflags {
6674ccbb6e7Sahrens 	/* print informational messages (ie, -v was specified) */
66819b94df9SMatthew Ahrens 	boolean_t verbose;
6694ccbb6e7Sahrens 
6704ccbb6e7Sahrens 	/* the destination is a prefix, not the exact fs (ie, -d) */
67119b94df9SMatthew Ahrens 	boolean_t isprefix;
6724ccbb6e7Sahrens 
673f64930f5STom Erickson 	/*
674f64930f5STom Erickson 	 * Only the tail of the sent snapshot path is appended to the
675f64930f5STom Erickson 	 * destination to determine the received snapshot name (ie, -e).
676f64930f5STom Erickson 	 */
67719b94df9SMatthew Ahrens 	boolean_t istail;
678f64930f5STom Erickson 
6794ccbb6e7Sahrens 	/* do not actually do the recv, just check if it would work (ie, -n) */
68019b94df9SMatthew Ahrens 	boolean_t dryrun;
6814ccbb6e7Sahrens 
6824ccbb6e7Sahrens 	/* rollback/destroy filesystems as necessary (eg, -F) */
68319b94df9SMatthew Ahrens 	boolean_t force;
6844ccbb6e7Sahrens 
6854ccbb6e7Sahrens 	/* set "canmount=off" on all modified filesystems */
68619b94df9SMatthew Ahrens 	boolean_t canmountoff;
6874ccbb6e7Sahrens 
6889c3fd121SMatthew Ahrens 	/*
6899c3fd121SMatthew Ahrens 	 * Mark the file systems as "resumable" and do not destroy them if the
6909c3fd121SMatthew Ahrens 	 * receive is interrupted
6919c3fd121SMatthew Ahrens 	 */
6929c3fd121SMatthew Ahrens 	boolean_t resumable;
6939c3fd121SMatthew Ahrens 
6944ccbb6e7Sahrens 	/* byteswap flag is used internally; callers need not specify */
69519b94df9SMatthew Ahrens 	boolean_t byteswap;
69633408eefSLori Alt 
69733408eefSLori Alt 	/* do not mount file systems as they are extracted (private) */
69819b94df9SMatthew Ahrens 	boolean_t nomount;
6993cb34c60Sahrens } recvflags_t;
7003cb34c60Sahrens 
701a2cdcdd2SPaul Dagnelie extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
702a2cdcdd2SPaul Dagnelie     recvflags_t *, int, avl_tree_t *);
7033cb34c60Sahrens 
70499d5e173STim Haley typedef enum diff_flags {
70599d5e173STim Haley 	ZFS_DIFF_PARSEABLE = 0x1,
70699d5e173STim Haley 	ZFS_DIFF_TIMESTAMP = 0x2,
70799d5e173STim Haley 	ZFS_DIFF_CLASSIFY = 0x4
70899d5e173STim Haley } diff_flags_t;
70999d5e173STim Haley 
71099d5e173STim Haley extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
71199d5e173STim Haley     int);
71299d5e173STim Haley 
713fa9e4066Sahrens /*
714fa9e4066Sahrens  * Miscellaneous functions.
715fa9e4066Sahrens  */
716fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t);
717fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *);
718fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t);
7195aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
7207f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
7217f1f55eaSvb     zfs_type_t);
7227b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *);
72378f17100SMatthew Ahrens extern boolean_t zfs_bookmark_exists(const char *path);
724fa9e4066Sahrens 
725fa9e4066Sahrens /*
726fa9e4066Sahrens  * Mount support functions.
727fa9e4066Sahrens  */
72855434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
72999653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
730fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int);
731fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int);
732fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int);
733fa9e4066Sahrens 
734fa9e4066Sahrens /*
735fa9e4066Sahrens  * Share support functions.
736fa9e4066Sahrens  */
737f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *);
738fa9e4066Sahrens extern int zfs_share(zfs_handle_t *);
739f3861e1aSahl extern int zfs_unshare(zfs_handle_t *);
740f3861e1aSahl 
741f3861e1aSahl /*
7423d7072f8Seschrock  * Protocol-specific share support functions.
743f3861e1aSahl  */
744f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
745da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
746f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *);
747da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *);
748da6c28aaSamw extern int zfs_shareall(zfs_handle_t *);
749f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
750da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *);
751f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *);
752da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *);
753da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
754da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *);
755743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
756da6c28aaSamw     void *, void *, int, zfs_share_op_t);
757fa9e4066Sahrens 
758fa9e4066Sahrens /*
759fa9e4066Sahrens  * When dealing with nvlists, verify() is extremely useful
760fa9e4066Sahrens  */
761fa9e4066Sahrens #ifdef NDEBUG
762fa9e4066Sahrens #define	verify(EX)	((void)(EX))
763fa9e4066Sahrens #else
764fa9e4066Sahrens #define	verify(EX)	assert(EX)
765fa9e4066Sahrens #endif
766fa9e4066Sahrens 
767fa9e4066Sahrens /*
768fa9e4066Sahrens  * Utility function to convert a number to a human-readable form.
769fa9e4066Sahrens  */
770fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t);
771e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
772fa9e4066Sahrens 
773fa9e4066Sahrens /*
774fa9e4066Sahrens  * Given a device or file, determine if it is part of a pool.
775fa9e4066Sahrens  */
77699653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
77799653d4eSeschrock     boolean_t *);
778fa9e4066Sahrens 
779fa9e4066Sahrens /*
780096d22d4SEric Schrock  * Label manipulation.
781fa9e4066Sahrens  */
78299653d4eSeschrock extern int zpool_read_label(int, nvlist_t **);
783096d22d4SEric Schrock extern int zpool_clear_label(int);
784fa9e4066Sahrens 
785e7cbe64fSgw /* is this zvol valid for use as a dump device? */
786e7cbe64fSgw extern int zvol_check_dump_config(char *);
787e7cbe64fSgw 
788743a77edSAlan Wright /*
789743a77edSAlan Wright  * Management interfaces for SMB ACL files
790743a77edSAlan Wright  */
791743a77edSAlan Wright 
792743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
793743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
794743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
795743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
796743a77edSAlan Wright 
7973bb79becSeschrock /*
798f3861e1aSahl  * Enable and disable datasets within a pool by mounting/unmounting and
799f3861e1aSahl  * sharing/unsharing them.
8003bb79becSeschrock  */
801f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
802f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
8033bb79becSeschrock 
804069f55e2SEric Schrock /*
805069f55e2SEric Schrock  * Mappings between vdev and FRU.
806069f55e2SEric Schrock  */
807069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *);
808069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
809069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
810069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
811069f55e2SEric Schrock     const char *);
812069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
813069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
814069f55e2SEric Schrock 
8152bcf0248SMax Grossman extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *);
8165cabbc6bSPrashanth Sreenivasa extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *);
8172bcf0248SMax Grossman 
8188a981c33SDaniel Hoffman /* Allow consumers to initialize libshare externally for optimal performance */
8198a981c33SDaniel Hoffman extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *);
8208a981c33SDaniel Hoffman /*
8218a981c33SDaniel Hoffman  * For most consumers, zfs_init_libshare_arg is sufficient on its own, and
8228a981c33SDaniel Hoffman  * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called
8238a981c33SDaniel Hoffman  * if the caller has already initialized libshare for one set of zfs handles,
8248a981c33SDaniel Hoffman  * and wishes to share or unshare filesystems outside of that set. In that case,
8258a981c33SDaniel Hoffman  * the caller should uninitialize libshare, and then re-initialize it with the
8268a981c33SDaniel Hoffman  * new handles being shared or unshared.
8278a981c33SDaniel Hoffman  */
8288a981c33SDaniel Hoffman extern void zfs_uninit_libshare(libzfs_handle_t *);
829fa9e4066Sahrens #ifdef	__cplusplus
830fa9e4066Sahrens }
831fa9e4066Sahrens #endif
832fa9e4066Sahrens 
833fa9e4066Sahrens #endif	/* _LIBZFS_H */
834