xref: /freebsd/sys/contrib/openzfs/include/libzfs.h (revision aca928a50a42f00f344df934005b09dbcb4e2f77)
1eda14cbcSMatt Macy /*
2eda14cbcSMatt Macy  * CDDL HEADER START
3eda14cbcSMatt Macy  *
4eda14cbcSMatt Macy  * The contents of this file are subject to the terms of the
5eda14cbcSMatt Macy  * Common Development and Distribution License (the "License").
6eda14cbcSMatt Macy  * You may not use this file except in compliance with the License.
7eda14cbcSMatt Macy  *
8eda14cbcSMatt Macy  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9271171e0SMartin Matuska  * or https://opensource.org/licenses/CDDL-1.0.
10eda14cbcSMatt Macy  * See the License for the specific language governing permissions
11eda14cbcSMatt Macy  * and limitations under the License.
12eda14cbcSMatt Macy  *
13eda14cbcSMatt Macy  * When distributing Covered Code, include this CDDL HEADER in each
14eda14cbcSMatt Macy  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15eda14cbcSMatt Macy  * If applicable, add the following below this CDDL HEADER, with the
16eda14cbcSMatt Macy  * fields enclosed by brackets "[]" replaced with your own identifying
17eda14cbcSMatt Macy  * information: Portions Copyright [yyyy] [name of copyright owner]
18eda14cbcSMatt Macy  *
19eda14cbcSMatt Macy  * CDDL HEADER END
20eda14cbcSMatt Macy  */
21eda14cbcSMatt Macy 
22eda14cbcSMatt Macy /*
23eda14cbcSMatt Macy  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24783d3ff6SMartin Matuska  * Copyright (c) 2011, 2024 by Delphix. All rights reserved.
25eda14cbcSMatt Macy  * Copyright Joyent, Inc.
26eda14cbcSMatt Macy  * Copyright (c) 2013 Steven Hartland. All rights reserved.
27eda14cbcSMatt Macy  * Copyright (c) 2016, Intel Corporation.
28eda14cbcSMatt Macy  * Copyright 2016 Nexenta Systems, Inc.
29eda14cbcSMatt Macy  * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
30eda14cbcSMatt Macy  * Copyright (c) 2019 Datto Inc.
31ee36e25aSMartin Matuska  * Copyright (c) 2021, Colm Buckley <colm@tuatha.org>
32eda14cbcSMatt Macy  */
33eda14cbcSMatt Macy 
34eda14cbcSMatt Macy #ifndef	_LIBZFS_H
3516038816SMartin Matuska #define	_LIBZFS_H extern __attribute__((visibility("default")))
36eda14cbcSMatt Macy 
37eda14cbcSMatt Macy #include <assert.h>
38716fd348SMartin Matuska #include <libshare.h>
39eda14cbcSMatt Macy #include <libnvpair.h>
40eda14cbcSMatt Macy #include <sys/mnttab.h>
41eda14cbcSMatt Macy #include <sys/param.h>
42eda14cbcSMatt Macy #include <sys/types.h>
43eda14cbcSMatt Macy #include <sys/fs/zfs.h>
44eda14cbcSMatt Macy #include <sys/avl.h>
45eda14cbcSMatt Macy #include <libzfs_core.h>
46eda14cbcSMatt Macy 
47eda14cbcSMatt Macy #ifdef	__cplusplus
48eda14cbcSMatt Macy extern "C" {
49eda14cbcSMatt Macy #endif
50eda14cbcSMatt Macy 
51eda14cbcSMatt Macy /*
52eda14cbcSMatt Macy  * Miscellaneous ZFS constants
53eda14cbcSMatt Macy  */
54eda14cbcSMatt Macy #define	ZFS_MAXPROPLEN		MAXPATHLEN
55eda14cbcSMatt Macy #define	ZPOOL_MAXPROPLEN	MAXPATHLEN
56eda14cbcSMatt Macy 
57eda14cbcSMatt Macy /*
58eda14cbcSMatt Macy  * libzfs errors
59eda14cbcSMatt Macy  */
60eda14cbcSMatt Macy typedef enum zfs_error {
61eda14cbcSMatt Macy 	EZFS_SUCCESS = 0,	/* no error -- success */
62eda14cbcSMatt Macy 	EZFS_NOMEM = 2000,	/* out of memory */
63eda14cbcSMatt Macy 	EZFS_BADPROP,		/* invalid property value */
64eda14cbcSMatt Macy 	EZFS_PROPREADONLY,	/* cannot set readonly property */
65eda14cbcSMatt Macy 	EZFS_PROPTYPE,		/* property does not apply to dataset type */
66eda14cbcSMatt Macy 	EZFS_PROPNONINHERIT,	/* property is not inheritable */
67eda14cbcSMatt Macy 	EZFS_PROPSPACE,		/* bad quota or reservation */
68eda14cbcSMatt Macy 	EZFS_BADTYPE,		/* dataset is not of appropriate type */
69eda14cbcSMatt Macy 	EZFS_BUSY,		/* pool or dataset is busy */
70eda14cbcSMatt Macy 	EZFS_EXISTS,		/* pool or dataset already exists */
71eda14cbcSMatt Macy 	EZFS_NOENT,		/* no such pool or dataset */
72eda14cbcSMatt Macy 	EZFS_BADSTREAM,		/* bad backup stream */
73eda14cbcSMatt Macy 	EZFS_DSREADONLY,	/* dataset is readonly */
74eda14cbcSMatt Macy 	EZFS_VOLTOOBIG,		/* volume is too large for 32-bit system */
75eda14cbcSMatt Macy 	EZFS_INVALIDNAME,	/* invalid dataset name */
76eda14cbcSMatt Macy 	EZFS_BADRESTORE,	/* unable to restore to destination */
77eda14cbcSMatt Macy 	EZFS_BADBACKUP,		/* backup failed */
78eda14cbcSMatt Macy 	EZFS_BADTARGET,		/* bad attach/detach/replace target */
79eda14cbcSMatt Macy 	EZFS_NODEVICE,		/* no such device in pool */
80eda14cbcSMatt Macy 	EZFS_BADDEV,		/* invalid device to add */
81eda14cbcSMatt Macy 	EZFS_NOREPLICAS,	/* no valid replicas */
82eda14cbcSMatt Macy 	EZFS_RESILVERING,	/* resilvering (healing reconstruction) */
83eda14cbcSMatt Macy 	EZFS_BADVERSION,	/* unsupported version */
84eda14cbcSMatt Macy 	EZFS_POOLUNAVAIL,	/* pool is currently unavailable */
85eda14cbcSMatt Macy 	EZFS_DEVOVERFLOW,	/* too many devices in one vdev */
86eda14cbcSMatt Macy 	EZFS_BADPATH,		/* must be an absolute path */
87eda14cbcSMatt Macy 	EZFS_CROSSTARGET,	/* rename or clone across pool or dataset */
88eda14cbcSMatt Macy 	EZFS_ZONED,		/* used improperly in local zone */
89eda14cbcSMatt Macy 	EZFS_MOUNTFAILED,	/* failed to mount dataset */
90eda14cbcSMatt Macy 	EZFS_UMOUNTFAILED,	/* failed to unmount dataset */
917877fdebSMatt Macy 	EZFS_UNSHARENFSFAILED,	/* failed to unshare over nfs */
927877fdebSMatt Macy 	EZFS_SHARENFSFAILED,	/* failed to share over nfs */
93eda14cbcSMatt Macy 	EZFS_PERM,		/* permission denied */
94eda14cbcSMatt Macy 	EZFS_NOSPC,		/* out of space */
95eda14cbcSMatt Macy 	EZFS_FAULT,		/* bad address */
96eda14cbcSMatt Macy 	EZFS_IO,		/* I/O error */
97eda14cbcSMatt Macy 	EZFS_INTR,		/* signal received */
98eda14cbcSMatt Macy 	EZFS_ISSPARE,		/* device is a hot spare */
99eda14cbcSMatt Macy 	EZFS_INVALCONFIG,	/* invalid vdev configuration */
100eda14cbcSMatt Macy 	EZFS_RECURSIVE,		/* recursive dependency */
101eda14cbcSMatt Macy 	EZFS_NOHISTORY,		/* no history object */
102eda14cbcSMatt Macy 	EZFS_POOLPROPS,		/* couldn't retrieve pool props */
103eda14cbcSMatt Macy 	EZFS_POOL_NOTSUP,	/* ops not supported for this type of pool */
104eda14cbcSMatt Macy 	EZFS_POOL_INVALARG,	/* invalid argument for this pool operation */
105eda14cbcSMatt Macy 	EZFS_NAMETOOLONG,	/* dataset name is too long */
106eda14cbcSMatt Macy 	EZFS_OPENFAILED,	/* open of device failed */
107eda14cbcSMatt Macy 	EZFS_NOCAP,		/* couldn't get capacity */
108eda14cbcSMatt Macy 	EZFS_LABELFAILED,	/* write of label failed */
109eda14cbcSMatt Macy 	EZFS_BADWHO,		/* invalid permission who */
110eda14cbcSMatt Macy 	EZFS_BADPERM,		/* invalid permission */
111eda14cbcSMatt Macy 	EZFS_BADPERMSET,	/* invalid permission set name */
112eda14cbcSMatt Macy 	EZFS_NODELEGATION,	/* delegated administration is disabled */
113eda14cbcSMatt Macy 	EZFS_UNSHARESMBFAILED,	/* failed to unshare over smb */
114eda14cbcSMatt Macy 	EZFS_SHARESMBFAILED,	/* failed to share over smb */
115eda14cbcSMatt Macy 	EZFS_BADCACHE,		/* bad cache file */
116eda14cbcSMatt Macy 	EZFS_ISL2CACHE,		/* device is for the level 2 ARC */
117eda14cbcSMatt Macy 	EZFS_VDEVNOTSUP,	/* unsupported vdev type */
118eda14cbcSMatt Macy 	EZFS_NOTSUP,		/* ops not supported on this dataset */
119eda14cbcSMatt Macy 	EZFS_ACTIVE_SPARE,	/* pool has active shared spare devices */
120eda14cbcSMatt Macy 	EZFS_UNPLAYED_LOGS,	/* log device has unplayed logs */
121eda14cbcSMatt Macy 	EZFS_REFTAG_RELE,	/* snapshot release: tag not found */
122eda14cbcSMatt Macy 	EZFS_REFTAG_HOLD,	/* snapshot hold: tag already exists */
123eda14cbcSMatt Macy 	EZFS_TAGTOOLONG,	/* snapshot hold/rele: tag too long */
124eda14cbcSMatt Macy 	EZFS_PIPEFAILED,	/* pipe create failed */
125eda14cbcSMatt Macy 	EZFS_THREADCREATEFAILED, /* thread create failed */
126eda14cbcSMatt Macy 	EZFS_POSTSPLIT_ONLINE,	/* onlining a disk after splitting it */
127eda14cbcSMatt Macy 	EZFS_SCRUBBING,		/* currently scrubbing */
128c0a83fe0SMartin Matuska 	EZFS_ERRORSCRUBBING,	/* currently error scrubbing */
129c0a83fe0SMartin Matuska 	EZFS_ERRORSCRUB_PAUSED,	/* error scrub currently paused */
130eda14cbcSMatt Macy 	EZFS_NO_SCRUB,		/* no active scrub */
131eda14cbcSMatt Macy 	EZFS_DIFF,		/* general failure of zfs diff */
132eda14cbcSMatt Macy 	EZFS_DIFFDATA,		/* bad zfs diff data */
133eda14cbcSMatt Macy 	EZFS_POOLREADONLY,	/* pool is in read-only mode */
134eda14cbcSMatt Macy 	EZFS_SCRUB_PAUSED,	/* scrub currently paused */
135c0a83fe0SMartin Matuska 	EZFS_SCRUB_PAUSED_TO_CANCEL,	/* scrub currently paused */
136eda14cbcSMatt Macy 	EZFS_ACTIVE_POOL,	/* pool is imported on a different system */
137eda14cbcSMatt Macy 	EZFS_CRYPTOFAILED,	/* failed to setup encryption */
138eda14cbcSMatt Macy 	EZFS_NO_PENDING,	/* cannot cancel, no operation is pending */
139eda14cbcSMatt Macy 	EZFS_CHECKPOINT_EXISTS,	/* checkpoint exists */
140eda14cbcSMatt Macy 	EZFS_DISCARDING_CHECKPOINT,	/* currently discarding a checkpoint */
141eda14cbcSMatt Macy 	EZFS_NO_CHECKPOINT,	/* pool has no checkpoint */
142eda14cbcSMatt Macy 	EZFS_DEVRM_IN_PROGRESS,	/* a device is currently being removed */
143eda14cbcSMatt Macy 	EZFS_VDEV_TOO_BIG,	/* a device is too big to be used */
144eda14cbcSMatt Macy 	EZFS_IOC_NOTSUPPORTED,	/* operation not supported by zfs module */
145eda14cbcSMatt Macy 	EZFS_TOOMANY,		/* argument list too long */
146eda14cbcSMatt Macy 	EZFS_INITIALIZING,	/* currently initializing */
147eda14cbcSMatt Macy 	EZFS_NO_INITIALIZE,	/* no active initialize */
148eda14cbcSMatt Macy 	EZFS_WRONG_PARENT,	/* invalid parent dataset (e.g ZVOL) */
149eda14cbcSMatt Macy 	EZFS_TRIMMING,		/* currently trimming */
150eda14cbcSMatt Macy 	EZFS_NO_TRIM,		/* no active trim */
151eda14cbcSMatt Macy 	EZFS_TRIM_NOTSUP,	/* device does not support trim */
152eda14cbcSMatt Macy 	EZFS_NO_RESILVER_DEFER,	/* pool doesn't support resilver_defer */
153eda14cbcSMatt Macy 	EZFS_EXPORT_IN_PROGRESS,	/* currently exporting the pool */
154eda14cbcSMatt Macy 	EZFS_REBUILDING,	/* resilvering (sequential reconstrution) */
155681ce946SMartin Matuska 	EZFS_VDEV_NOTSUP,	/* ops not supported for this type of vdev */
1561f1e2261SMartin Matuska 	EZFS_NOT_USER_NAMESPACE,	/* a file is not a user namespace */
157c7046f76SMartin Matuska 	EZFS_CKSUM,		/* insufficient replicas */
158be181ee2SMartin Matuska 	EZFS_RESUME_EXISTS,	/* Resume on existing dataset without force */
1592ad756a6SMartin Matuska 	EZFS_SHAREFAILED,	/* filesystem share failed */
160e716630dSMartin Matuska 	EZFS_RAIDZ_EXPAND_IN_PROGRESS,	/* a raidz is currently expanding */
161783d3ff6SMartin Matuska 	EZFS_ASHIFT_MISMATCH,   /* can't add vdevs with different ashifts */
162eda14cbcSMatt Macy 	EZFS_UNKNOWN
163eda14cbcSMatt Macy } zfs_error_t;
164eda14cbcSMatt Macy 
165eda14cbcSMatt Macy /*
166eda14cbcSMatt Macy  * The following data structures are all part
167eda14cbcSMatt Macy  * of the zfs_allow_t data structure which is
168eda14cbcSMatt Macy  * used for printing 'allow' permissions.
169eda14cbcSMatt Macy  * It is a linked list of zfs_allow_t's which
170eda14cbcSMatt Macy  * then contain avl tree's for user/group/sets/...
171eda14cbcSMatt Macy  * and each one of the entries in those trees have
172eda14cbcSMatt Macy  * avl tree's for the permissions they belong to and
173eda14cbcSMatt Macy  * whether they are local,descendent or local+descendent
174eda14cbcSMatt Macy  * permissions.  The AVL trees are used primarily for
175eda14cbcSMatt Macy  * sorting purposes, but also so that we can quickly find
176eda14cbcSMatt Macy  * a given user and or permission.
177eda14cbcSMatt Macy  */
178eda14cbcSMatt Macy typedef struct zfs_perm_node {
179eda14cbcSMatt Macy 	avl_node_t z_node;
180eda14cbcSMatt Macy 	char z_pname[MAXPATHLEN];
181eda14cbcSMatt Macy } zfs_perm_node_t;
182eda14cbcSMatt Macy 
183eda14cbcSMatt Macy typedef struct zfs_allow_node {
184eda14cbcSMatt Macy 	avl_node_t z_node;
185eda14cbcSMatt Macy 	char z_key[MAXPATHLEN];		/* name, such as joe */
186eda14cbcSMatt Macy 	avl_tree_t z_localdescend;	/* local+descendent perms */
187eda14cbcSMatt Macy 	avl_tree_t z_local;		/* local permissions */
188eda14cbcSMatt Macy 	avl_tree_t z_descend;		/* descendent permissions */
189eda14cbcSMatt Macy } zfs_allow_node_t;
190eda14cbcSMatt Macy 
191eda14cbcSMatt Macy typedef struct zfs_allow {
192eda14cbcSMatt Macy 	struct zfs_allow *z_next;
193eda14cbcSMatt Macy 	char z_setpoint[MAXPATHLEN];
194eda14cbcSMatt Macy 	avl_tree_t z_sets;
195eda14cbcSMatt Macy 	avl_tree_t z_crperms;
196eda14cbcSMatt Macy 	avl_tree_t z_user;
197eda14cbcSMatt Macy 	avl_tree_t z_group;
198eda14cbcSMatt Macy 	avl_tree_t z_everyone;
199eda14cbcSMatt Macy } zfs_allow_t;
200eda14cbcSMatt Macy 
201eda14cbcSMatt Macy /*
202eda14cbcSMatt Macy  * Basic handle types
203eda14cbcSMatt Macy  */
204eda14cbcSMatt Macy typedef struct zfs_handle zfs_handle_t;
205eda14cbcSMatt Macy typedef struct zpool_handle zpool_handle_t;
206eda14cbcSMatt Macy typedef struct libzfs_handle libzfs_handle_t;
207eda14cbcSMatt Macy 
20816038816SMartin Matuska _LIBZFS_H int zpool_wait(zpool_handle_t *, zpool_wait_activity_t);
20916038816SMartin Matuska _LIBZFS_H int zpool_wait_status(zpool_handle_t *, zpool_wait_activity_t,
210eda14cbcSMatt Macy     boolean_t *, boolean_t *);
211eda14cbcSMatt Macy 
212eda14cbcSMatt Macy /*
213eda14cbcSMatt Macy  * Library initialization
214eda14cbcSMatt Macy  */
21516038816SMartin Matuska _LIBZFS_H libzfs_handle_t *libzfs_init(void);
21616038816SMartin Matuska _LIBZFS_H void libzfs_fini(libzfs_handle_t *);
217eda14cbcSMatt Macy 
21816038816SMartin Matuska _LIBZFS_H libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
21916038816SMartin Matuska _LIBZFS_H libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
220eda14cbcSMatt Macy 
22116038816SMartin Matuska _LIBZFS_H void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
222eda14cbcSMatt Macy 
22316038816SMartin Matuska _LIBZFS_H void zfs_save_arguments(int argc, char **, char *, int);
22416038816SMartin Matuska _LIBZFS_H int zpool_log_history(libzfs_handle_t *, const char *);
225eda14cbcSMatt Macy 
22616038816SMartin Matuska _LIBZFS_H int libzfs_errno(libzfs_handle_t *);
22716038816SMartin Matuska _LIBZFS_H const char *libzfs_error_init(int);
22816038816SMartin Matuska _LIBZFS_H const char *libzfs_error_action(libzfs_handle_t *);
22916038816SMartin Matuska _LIBZFS_H const char *libzfs_error_description(libzfs_handle_t *);
23016038816SMartin Matuska _LIBZFS_H int zfs_standard_error(libzfs_handle_t *, int, const char *);
23116038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_init(libzfs_handle_t *);
23216038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_fini(libzfs_handle_t *);
23316038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
23416038816SMartin Matuska _LIBZFS_H int libzfs_mnttab_find(libzfs_handle_t *, const char *,
235eda14cbcSMatt Macy     struct mnttab *);
23616038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_add(libzfs_handle_t *, const char *,
237eda14cbcSMatt Macy     const char *, const char *);
23816038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
239eda14cbcSMatt Macy 
240eda14cbcSMatt Macy /*
241eda14cbcSMatt Macy  * Basic handle functions
242eda14cbcSMatt Macy  */
24316038816SMartin Matuska _LIBZFS_H zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
24416038816SMartin Matuska _LIBZFS_H zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
24516038816SMartin Matuska _LIBZFS_H void zpool_close(zpool_handle_t *);
24616038816SMartin Matuska _LIBZFS_H const char *zpool_get_name(zpool_handle_t *);
24716038816SMartin Matuska _LIBZFS_H int zpool_get_state(zpool_handle_t *);
24816038816SMartin Matuska _LIBZFS_H const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
24916038816SMartin Matuska _LIBZFS_H const char *zpool_pool_state_to_name(pool_state_t);
25016038816SMartin Matuska _LIBZFS_H void zpool_free_handles(libzfs_handle_t *);
251eda14cbcSMatt Macy 
252eda14cbcSMatt Macy /*
253eda14cbcSMatt Macy  * Iterate over all active pools in the system.
254eda14cbcSMatt Macy  */
255eda14cbcSMatt Macy typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
25616038816SMartin Matuska _LIBZFS_H int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
25716038816SMartin Matuska _LIBZFS_H boolean_t zpool_skip_pool(const char *);
258eda14cbcSMatt Macy 
259eda14cbcSMatt Macy /*
260eda14cbcSMatt Macy  * Functions to create and destroy pools
261eda14cbcSMatt Macy  */
26216038816SMartin Matuska _LIBZFS_H int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
263eda14cbcSMatt Macy     nvlist_t *, nvlist_t *);
26416038816SMartin Matuska _LIBZFS_H int zpool_destroy(zpool_handle_t *, const char *);
265783d3ff6SMartin Matuska _LIBZFS_H int zpool_add(zpool_handle_t *, nvlist_t *, boolean_t check_ashift);
266eda14cbcSMatt Macy 
267eda14cbcSMatt Macy typedef struct splitflags {
268eda14cbcSMatt Macy 	/* do not split, but return the config that would be split off */
269dbd5678dSMartin Matuska 	unsigned int dryrun : 1;
270eda14cbcSMatt Macy 
271eda14cbcSMatt Macy 	/* after splitting, import the pool */
272dbd5678dSMartin Matuska 	unsigned int import : 1;
273eda14cbcSMatt Macy 	int name_flags;
274eda14cbcSMatt Macy } splitflags_t;
275eda14cbcSMatt Macy 
276eda14cbcSMatt Macy typedef struct trimflags {
277eda14cbcSMatt Macy 	/* requested vdevs are for the entire pool */
278eda14cbcSMatt Macy 	boolean_t fullpool;
279eda14cbcSMatt Macy 
280eda14cbcSMatt Macy 	/* request a secure trim, requires support from device */
281eda14cbcSMatt Macy 	boolean_t secure;
282eda14cbcSMatt Macy 
283eda14cbcSMatt Macy 	/* after starting trim, block until trim completes */
284eda14cbcSMatt Macy 	boolean_t wait;
285eda14cbcSMatt Macy 
286eda14cbcSMatt Macy 	/* trim at the requested rate in bytes/second */
287eda14cbcSMatt Macy 	uint64_t rate;
288eda14cbcSMatt Macy } trimflags_t;
289eda14cbcSMatt Macy 
290eda14cbcSMatt Macy /*
291eda14cbcSMatt Macy  * Functions to manipulate pool and vdev state
292eda14cbcSMatt Macy  */
29316038816SMartin Matuska _LIBZFS_H int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
29416038816SMartin Matuska _LIBZFS_H int zpool_initialize(zpool_handle_t *, pool_initialize_func_t,
295eda14cbcSMatt Macy     nvlist_t *);
29616038816SMartin Matuska _LIBZFS_H int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t,
297eda14cbcSMatt Macy     nvlist_t *);
29816038816SMartin Matuska _LIBZFS_H int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *,
299eda14cbcSMatt Macy     trimflags_t *);
300eda14cbcSMatt Macy 
30116038816SMartin Matuska _LIBZFS_H int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
30216038816SMartin Matuska _LIBZFS_H int zpool_reguid(zpool_handle_t *);
30316038816SMartin Matuska _LIBZFS_H int zpool_reopen_one(zpool_handle_t *, void *);
304eda14cbcSMatt Macy 
30516038816SMartin Matuska _LIBZFS_H int zpool_sync_one(zpool_handle_t *, void *);
306eda14cbcSMatt Macy 
30716038816SMartin Matuska _LIBZFS_H int zpool_vdev_online(zpool_handle_t *, const char *, int,
308eda14cbcSMatt Macy     vdev_state_t *);
30916038816SMartin Matuska _LIBZFS_H int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
31016038816SMartin Matuska _LIBZFS_H int zpool_vdev_attach(zpool_handle_t *, const char *,
311eda14cbcSMatt Macy     const char *, nvlist_t *, int, boolean_t);
31216038816SMartin Matuska _LIBZFS_H int zpool_vdev_detach(zpool_handle_t *, const char *);
31316038816SMartin Matuska _LIBZFS_H int zpool_vdev_remove(zpool_handle_t *, const char *);
31416038816SMartin Matuska _LIBZFS_H int zpool_vdev_remove_cancel(zpool_handle_t *);
31516038816SMartin Matuska _LIBZFS_H int zpool_vdev_indirect_size(zpool_handle_t *, const char *,
31616038816SMartin Matuska     uint64_t *);
31716038816SMartin Matuska _LIBZFS_H int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **,
31816038816SMartin Matuska     nvlist_t *, splitflags_t);
319be181ee2SMartin Matuska _LIBZFS_H int zpool_vdev_remove_wanted(zpool_handle_t *, const char *);
320eda14cbcSMatt Macy 
32116038816SMartin Matuska _LIBZFS_H int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
32216038816SMartin Matuska _LIBZFS_H int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
323b356da80SMartin Matuska _LIBZFS_H int zpool_vdev_set_removed_state(zpool_handle_t *, uint64_t,
324b356da80SMartin Matuska     vdev_aux_t);
325b356da80SMartin Matuska 
32616038816SMartin Matuska _LIBZFS_H int zpool_vdev_clear(zpool_handle_t *, uint64_t);
327eda14cbcSMatt Macy 
32816038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
329eda14cbcSMatt Macy     boolean_t *, boolean_t *);
33016038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
331eda14cbcSMatt Macy     boolean_t *, boolean_t *, boolean_t *);
33216038816SMartin Matuska _LIBZFS_H int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *,
33316038816SMartin Matuska     const char *);
334abcdc1b9SMartin Matuska _LIBZFS_H int zpool_prepare_disk(zpool_handle_t *zhp, nvlist_t *vdev_nv,
335abcdc1b9SMartin Matuska     const char *prepare_str, char **lines[], int *lines_cnt);
336abcdc1b9SMartin Matuska _LIBZFS_H int zpool_prepare_and_label_disk(libzfs_handle_t *hdl,
337abcdc1b9SMartin Matuska     zpool_handle_t *, const char *, nvlist_t *vdev_nv, const char *prepare_str,
338abcdc1b9SMartin Matuska     char **lines[], int *lines_cnt);
339abcdc1b9SMartin Matuska _LIBZFS_H char ** zpool_vdev_script_alloc_env(const char *pool_name,
340abcdc1b9SMartin Matuska     const char *vdev_path, const char *vdev_upath,
341abcdc1b9SMartin Matuska     const char *vdev_enc_sysfs_path, const char *opt_key, const char *opt_val);
342abcdc1b9SMartin Matuska _LIBZFS_H void zpool_vdev_script_free_env(char **env);
34316038816SMartin Matuska _LIBZFS_H uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp,
34416038816SMartin Matuska     const char *path);
345eda14cbcSMatt Macy 
34616038816SMartin Matuska _LIBZFS_H const char *zpool_get_state_str(zpool_handle_t *);
347eda14cbcSMatt Macy 
348eda14cbcSMatt Macy /*
349eda14cbcSMatt Macy  * Functions to manage pool properties
350eda14cbcSMatt Macy  */
35116038816SMartin Matuska _LIBZFS_H int zpool_set_prop(zpool_handle_t *, const char *, const char *);
35216038816SMartin Matuska _LIBZFS_H int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
353eda14cbcSMatt Macy     size_t proplen, zprop_source_t *, boolean_t literal);
354c98ecfceSAllan Jude _LIBZFS_H int zpool_get_userprop(zpool_handle_t *, const char *, char *,
355c98ecfceSAllan Jude     size_t proplen, zprop_source_t *);
35616038816SMartin Matuska _LIBZFS_H uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
357eda14cbcSMatt Macy     zprop_source_t *);
35816038816SMartin Matuska _LIBZFS_H int zpool_props_refresh(zpool_handle_t *);
359eda14cbcSMatt Macy 
36016038816SMartin Matuska _LIBZFS_H const char *zpool_prop_to_name(zpool_prop_t);
36116038816SMartin Matuska _LIBZFS_H const char *zpool_prop_values(zpool_prop_t);
362eda14cbcSMatt Macy 
363eda14cbcSMatt Macy /*
364681ce946SMartin Matuska  * Functions to manage vdev properties
365681ce946SMartin Matuska  */
366681ce946SMartin Matuska _LIBZFS_H int zpool_get_vdev_prop_value(nvlist_t *, vdev_prop_t, char *, char *,
367681ce946SMartin Matuska     size_t, zprop_source_t *, boolean_t);
368681ce946SMartin Matuska _LIBZFS_H int zpool_get_vdev_prop(zpool_handle_t *, const char *, vdev_prop_t,
369681ce946SMartin Matuska     char *, char *, size_t, zprop_source_t *, boolean_t);
370681ce946SMartin Matuska _LIBZFS_H int zpool_get_all_vdev_props(zpool_handle_t *, const char *,
371681ce946SMartin Matuska     nvlist_t **);
372681ce946SMartin Matuska _LIBZFS_H int zpool_set_vdev_prop(zpool_handle_t *, const char *, const char *,
373681ce946SMartin Matuska     const char *);
374681ce946SMartin Matuska 
375681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_to_name(vdev_prop_t);
376681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_values(vdev_prop_t);
377681ce946SMartin Matuska _LIBZFS_H boolean_t vdev_prop_user(const char *name);
378681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_column_name(vdev_prop_t);
379681ce946SMartin Matuska _LIBZFS_H boolean_t vdev_prop_align_right(vdev_prop_t);
380681ce946SMartin Matuska 
381681ce946SMartin Matuska /*
382eda14cbcSMatt Macy  * Pool health statistics.
383eda14cbcSMatt Macy  */
384eda14cbcSMatt Macy typedef enum {
385eda14cbcSMatt Macy 	/*
386eda14cbcSMatt Macy 	 * The following correspond to faults as defined in the (fault.fs.zfs.*)
387eda14cbcSMatt Macy 	 * event namespace.  Each is associated with a corresponding message ID.
388eda14cbcSMatt Macy 	 * This must be kept in sync with the zfs_msgid_table in
389eda14cbcSMatt Macy 	 * lib/libzfs/libzfs_status.c.
390eda14cbcSMatt Macy 	 */
391eda14cbcSMatt Macy 	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */
392eda14cbcSMatt Macy 	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */
393eda14cbcSMatt Macy 	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */
394eda14cbcSMatt Macy 	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */
395eda14cbcSMatt Macy 	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */
396eda14cbcSMatt Macy 	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */
397eda14cbcSMatt Macy 	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */
398eda14cbcSMatt Macy 	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */
399eda14cbcSMatt Macy 	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */
400eda14cbcSMatt Macy 	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */
401eda14cbcSMatt Macy 	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */
402eda14cbcSMatt Macy 	ZPOOL_STATUS_HOSTID_ACTIVE,	/* currently active on another system */
403eda14cbcSMatt Macy 	ZPOOL_STATUS_HOSTID_REQUIRED,	/* multihost=on and hostid=0 */
404eda14cbcSMatt Macy 	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */
405eda14cbcSMatt Macy 	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
406eda14cbcSMatt Macy 	ZPOOL_STATUS_IO_FAILURE_MMP,	/* failed MMP, failmode not 'panic' */
407eda14cbcSMatt Macy 	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */
408eda14cbcSMatt Macy 	ZPOOL_STATUS_ERRATA,		/* informational errata available */
409eda14cbcSMatt Macy 
410eda14cbcSMatt Macy 	/*
411eda14cbcSMatt Macy 	 * If the pool has unsupported features but can still be opened in
412eda14cbcSMatt Macy 	 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
413eda14cbcSMatt Macy 	 * pool has unsupported features but cannot be opened at all, its
414eda14cbcSMatt Macy 	 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
415eda14cbcSMatt Macy 	 */
416eda14cbcSMatt Macy 	ZPOOL_STATUS_UNSUP_FEAT_READ,	/* unsupported features for read */
417eda14cbcSMatt Macy 	ZPOOL_STATUS_UNSUP_FEAT_WRITE,	/* unsupported features for write */
418eda14cbcSMatt Macy 
419eda14cbcSMatt Macy 	/*
420eda14cbcSMatt Macy 	 * These faults have no corresponding message ID.  At the time we are
421eda14cbcSMatt Macy 	 * checking the status, the original reason for the FMA fault (I/O or
422eda14cbcSMatt Macy 	 * checksum errors) has been lost.
423eda14cbcSMatt Macy 	 */
424eda14cbcSMatt Macy 	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */
425eda14cbcSMatt Macy 	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */
426eda14cbcSMatt Macy 
427eda14cbcSMatt Macy 	/*
428eda14cbcSMatt Macy 	 * The following are not faults per se, but still an error possibly
429eda14cbcSMatt Macy 	 * requiring administrative attention.  There is no corresponding
430eda14cbcSMatt Macy 	 * message ID.
431eda14cbcSMatt Macy 	 */
432eda14cbcSMatt Macy 	ZPOOL_STATUS_VERSION_OLDER,	/* older legacy on-disk version */
433eda14cbcSMatt Macy 	ZPOOL_STATUS_FEAT_DISABLED,	/* supported features are disabled */
434eda14cbcSMatt Macy 	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */
435eda14cbcSMatt Macy 	ZPOOL_STATUS_OFFLINE_DEV,	/* device offline */
436eda14cbcSMatt Macy 	ZPOOL_STATUS_REMOVED_DEV,	/* removed device */
437eda14cbcSMatt Macy 	ZPOOL_STATUS_REBUILDING,	/* device being rebuilt */
438eda14cbcSMatt Macy 	ZPOOL_STATUS_REBUILD_SCRUB,	/* recommend scrubbing the pool */
439eda14cbcSMatt Macy 	ZPOOL_STATUS_NON_NATIVE_ASHIFT,	/* (e.g. 512e dev with ashift of 9) */
440ee36e25aSMartin Matuska 	ZPOOL_STATUS_COMPATIBILITY_ERR,	/* bad 'compatibility' property */
44116038816SMartin Matuska 	ZPOOL_STATUS_INCOMPATIBLE_FEAT,	/* feature set outside compatibility */
442eda14cbcSMatt Macy 
443eda14cbcSMatt Macy 	/*
444eda14cbcSMatt Macy 	 * Finally, the following indicates a healthy pool.
445eda14cbcSMatt Macy 	 */
446eda14cbcSMatt Macy 	ZPOOL_STATUS_OK
447eda14cbcSMatt Macy } zpool_status_t;
448eda14cbcSMatt Macy 
449a0b956f5SMartin Matuska _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, const char **,
450eda14cbcSMatt Macy     zpool_errata_t *);
451a0b956f5SMartin Matuska _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, const char **,
452eda14cbcSMatt Macy     zpool_errata_t *);
453eda14cbcSMatt Macy 
454eda14cbcSMatt Macy /*
455eda14cbcSMatt Macy  * Statistics and configuration functions.
456eda14cbcSMatt Macy  */
45716038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
45816038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *);
45916038816SMartin Matuska _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
46016038816SMartin Matuska _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
461eda14cbcSMatt Macy 
462eda14cbcSMatt Macy /*
463eda14cbcSMatt Macy  * Import and export functions
464eda14cbcSMatt Macy  */
46516038816SMartin Matuska _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *);
46616038816SMartin Matuska _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *);
46716038816SMartin Matuska _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
468eda14cbcSMatt Macy     char *altroot);
46916038816SMartin Matuska _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
470eda14cbcSMatt Macy     nvlist_t *, int);
47116038816SMartin Matuska _LIBZFS_H void zpool_print_unsup_feat(nvlist_t *config);
472eda14cbcSMatt Macy 
473eda14cbcSMatt Macy /*
474eda14cbcSMatt Macy  * Miscellaneous pool functions
475eda14cbcSMatt Macy  */
476eda14cbcSMatt Macy struct zfs_cmd;
477eda14cbcSMatt Macy 
478e92ffd9bSMartin Matuska _LIBZFS_H const char *const zfs_history_event_names[];
479eda14cbcSMatt Macy 
480eda14cbcSMatt Macy typedef enum {
481eda14cbcSMatt Macy 	VDEV_NAME_PATH		= 1 << 0,
482eda14cbcSMatt Macy 	VDEV_NAME_GUID		= 1 << 1,
483eda14cbcSMatt Macy 	VDEV_NAME_FOLLOW_LINKS	= 1 << 2,
484eda14cbcSMatt Macy 	VDEV_NAME_TYPE_ID	= 1 << 3,
485eda14cbcSMatt Macy } vdev_name_t;
486eda14cbcSMatt Macy 
48716038816SMartin Matuska _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
488eda14cbcSMatt Macy     int name_flags);
48916038816SMartin Matuska _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t);
49016038816SMartin Matuska _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *,
491eda14cbcSMatt Macy     boolean_t *);
49216038816SMartin Matuska _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned,
493eda14cbcSMatt Macy     int);
49416038816SMartin Matuska _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *);
49516038816SMartin Matuska _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int);
49616038816SMartin Matuska _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t,
49716038816SMartin Matuska     char *, size_t);
49816038816SMartin Matuska _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
499eda14cbcSMatt Macy     size_t);
50016038816SMartin Matuska _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
50116038816SMartin Matuska _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int,
502eda14cbcSMatt Macy     nvlist_t *);
50316038816SMartin Matuska _LIBZFS_H int zpool_checkpoint(zpool_handle_t *);
50416038816SMartin Matuska _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *);
50516038816SMartin Matuska _LIBZFS_H boolean_t zpool_is_draid_spare(const char *);
506eda14cbcSMatt Macy 
507eda14cbcSMatt Macy /*
508eda14cbcSMatt Macy  * Basic handle manipulations.  These functions do not create or destroy the
509eda14cbcSMatt Macy  * underlying datasets, only the references to them.
510eda14cbcSMatt Macy  */
51116038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
51216038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
51316038816SMartin Matuska _LIBZFS_H void zfs_close(zfs_handle_t *);
51416038816SMartin Matuska _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *);
51516038816SMartin Matuska _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *);
51616038816SMartin Matuska _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *);
51716038816SMartin Matuska _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
51816038816SMartin Matuska _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *);
519eda14cbcSMatt Macy 
520eda14cbcSMatt Macy /*
521eda14cbcSMatt Macy  * Property management functions.  Some functions are shared with the kernel,
522eda14cbcSMatt Macy  * and are found in sys/fs/zfs.h.
523eda14cbcSMatt Macy  */
524eda14cbcSMatt Macy 
525eda14cbcSMatt Macy /*
526eda14cbcSMatt Macy  * zfs dataset property management
527eda14cbcSMatt Macy  */
52816038816SMartin Matuska _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t);
52916038816SMartin Matuska _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t);
53016038816SMartin Matuska _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t);
53116038816SMartin Matuska _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t);
532eda14cbcSMatt Macy 
53316038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
53416038816SMartin Matuska     nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t,
53516038816SMartin Matuska     const char *);
536eda14cbcSMatt Macy 
53716038816SMartin Matuska _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t);
53816038816SMartin Matuska _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *);
53916038816SMartin Matuska _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
540f7f4bd06SMartin Matuska _LIBZFS_H int zfs_prop_set_list_flags(zfs_handle_t *, nvlist_t *, int);
54116038816SMartin Matuska _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
542eda14cbcSMatt Macy     zprop_source_t *, char *, size_t, boolean_t);
54316038816SMartin Matuska _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
544eda14cbcSMatt Macy     boolean_t);
54516038816SMartin Matuska _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
546eda14cbcSMatt Macy     zprop_source_t *, char *, size_t);
54716038816SMartin Matuska _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp,
54816038816SMartin Matuska     const char *propname, uint64_t *propvalue);
54916038816SMartin Matuska _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
550eda14cbcSMatt Macy     char *propbuf, int proplen, boolean_t literal);
55116038816SMartin Matuska _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
552eda14cbcSMatt Macy     uint64_t *propvalue);
55316038816SMartin Matuska _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
554eda14cbcSMatt Macy     char *propbuf, int proplen, boolean_t literal);
55516038816SMartin Matuska _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
556eda14cbcSMatt Macy     char *buf, size_t len);
5572a58b312SMartin Matuska _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, const char **);
55816038816SMartin Matuska _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
55916038816SMartin Matuska _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
56016038816SMartin Matuska _LIBZFS_H const char *zfs_prop_values(zfs_prop_t);
56116038816SMartin Matuska _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop);
56216038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *);
56316038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *);
56416038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
56516038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
566eda14cbcSMatt Macy 
56716038816SMartin Matuska _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t,
568eda14cbcSMatt Macy     boolean_t *, boolean_t *);
569eda14cbcSMatt Macy 
570eda14cbcSMatt Macy /*
571eda14cbcSMatt Macy  * zfs encryption management
572eda14cbcSMatt Macy  */
57316038816SMartin Matuska _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *,
57416038816SMartin Matuska     char *);
57516038816SMartin Matuska _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *,
57616038816SMartin Matuska     nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *);
57716038816SMartin Matuska _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *,
578eda14cbcSMatt Macy     nvlist_t *);
579c03c5b1cSMartin Matuska _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *);
580c03c5b1cSMartin Matuska _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *);
58116038816SMartin Matuska _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *);
58216038816SMartin Matuska _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t);
583eda14cbcSMatt Macy 
584eda14cbcSMatt Macy typedef struct zprop_list {
585eda14cbcSMatt Macy 	int		pl_prop;
586eda14cbcSMatt Macy 	char		*pl_user_prop;
587eda14cbcSMatt Macy 	struct zprop_list *pl_next;
588eda14cbcSMatt Macy 	boolean_t	pl_all;
589eda14cbcSMatt Macy 	size_t		pl_width;
590eda14cbcSMatt Macy 	size_t		pl_recvd_width;
591eda14cbcSMatt Macy 	boolean_t	pl_fixed;
592eda14cbcSMatt Macy } zprop_list_t;
593eda14cbcSMatt Macy 
59416038816SMartin Matuska _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
595eda14cbcSMatt Macy     boolean_t);
59616038816SMartin Matuska _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
597681ce946SMartin Matuska _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *,
598681ce946SMartin Matuska     zprop_list_t **);
599eda14cbcSMatt Macy 
600eda14cbcSMatt Macy #define	ZFS_MOUNTPOINT_NONE	"none"
601eda14cbcSMatt Macy #define	ZFS_MOUNTPOINT_LEGACY	"legacy"
602eda14cbcSMatt Macy 
603eda14cbcSMatt Macy #define	ZFS_FEATURE_DISABLED	"disabled"
604eda14cbcSMatt Macy #define	ZFS_FEATURE_ENABLED	"enabled"
605eda14cbcSMatt Macy #define	ZFS_FEATURE_ACTIVE	"active"
606eda14cbcSMatt Macy 
607eda14cbcSMatt Macy #define	ZFS_UNSUPPORTED_INACTIVE	"inactive"
608eda14cbcSMatt Macy #define	ZFS_UNSUPPORTED_READONLY	"readonly"
609eda14cbcSMatt Macy 
610eda14cbcSMatt Macy /*
611eda14cbcSMatt Macy  * zpool property management
612eda14cbcSMatt Macy  */
61316038816SMartin Matuska _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **,
614681ce946SMartin Matuska     zfs_type_t, boolean_t);
61516038816SMartin Matuska _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
616eda14cbcSMatt Macy     size_t);
61716038816SMartin Matuska _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t);
61816038816SMartin Matuska _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t);
61916038816SMartin Matuska _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t);
62016038816SMartin Matuska _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t);
621eda14cbcSMatt Macy 
622eda14cbcSMatt Macy /*
623eda14cbcSMatt Macy  * Functions shared by zfs and zpool property management.
624eda14cbcSMatt Macy  */
62516038816SMartin Matuska _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
626eda14cbcSMatt Macy     boolean_t ordered, zfs_type_t type);
62716038816SMartin Matuska _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
628eda14cbcSMatt Macy     zfs_type_t);
62916038816SMartin Matuska _LIBZFS_H void zprop_free_list(zprop_list_t *);
630eda14cbcSMatt Macy 
631eda14cbcSMatt Macy #define	ZFS_GET_NCOLS	5
632eda14cbcSMatt Macy 
633eda14cbcSMatt Macy typedef enum {
634eda14cbcSMatt Macy 	GET_COL_NONE,
635eda14cbcSMatt Macy 	GET_COL_NAME,
636eda14cbcSMatt Macy 	GET_COL_PROPERTY,
637eda14cbcSMatt Macy 	GET_COL_VALUE,
638eda14cbcSMatt Macy 	GET_COL_RECVD,
639eda14cbcSMatt Macy 	GET_COL_SOURCE
640eda14cbcSMatt Macy } zfs_get_column_t;
641eda14cbcSMatt Macy 
642eda14cbcSMatt Macy /*
643eda14cbcSMatt Macy  * Functions for printing zfs or zpool properties
644eda14cbcSMatt Macy  */
645681ce946SMartin Matuska typedef struct vdev_cbdata {
646681ce946SMartin Matuska 	int cb_name_flags;
647681ce946SMartin Matuska 	char **cb_names;
648681ce946SMartin Matuska 	unsigned int cb_names_count;
649681ce946SMartin Matuska } vdev_cbdata_t;
650681ce946SMartin Matuska 
651eda14cbcSMatt Macy typedef struct zprop_get_cbdata {
652eda14cbcSMatt Macy 	int cb_sources;
653eda14cbcSMatt Macy 	zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
654eda14cbcSMatt Macy 	int cb_colwidths[ZFS_GET_NCOLS + 1];
655eda14cbcSMatt Macy 	boolean_t cb_scripted;
656eda14cbcSMatt Macy 	boolean_t cb_literal;
657eda14cbcSMatt Macy 	boolean_t cb_first;
658eda14cbcSMatt Macy 	zprop_list_t *cb_proplist;
659eda14cbcSMatt Macy 	zfs_type_t cb_type;
660681ce946SMartin Matuska 	vdev_cbdata_t cb_vdevs;
661eda14cbcSMatt Macy } zprop_get_cbdata_t;
662eda14cbcSMatt Macy 
663f7f4bd06SMartin Matuska #define	ZFS_SET_NOMOUNT		1
664f7f4bd06SMartin Matuska 
665f7f4bd06SMartin Matuska typedef struct zprop_set_cbdata {
666f7f4bd06SMartin Matuska 	int cb_flags;
667f7f4bd06SMartin Matuska 	nvlist_t *cb_proplist;
668f7f4bd06SMartin Matuska } zprop_set_cbdata_t;
669f7f4bd06SMartin Matuska 
67016038816SMartin Matuska _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
671eda14cbcSMatt Macy     const char *, const char *, zprop_source_t, const char *,
672eda14cbcSMatt Macy     const char *);
673eda14cbcSMatt Macy 
674eda14cbcSMatt Macy /*
675eda14cbcSMatt Macy  * Iterator functions.
676eda14cbcSMatt Macy  */
67715f0b8c3SMartin Matuska #define	ZFS_ITER_RECURSE		(1 << 0)
67815f0b8c3SMartin Matuska #define	ZFS_ITER_ARGS_CAN_BE_PATHS	(1 << 1)
67915f0b8c3SMartin Matuska #define	ZFS_ITER_PROP_LISTSNAPS		(1 << 2)
68015f0b8c3SMartin Matuska #define	ZFS_ITER_DEPTH_LIMIT		(1 << 3)
68115f0b8c3SMartin Matuska #define	ZFS_ITER_RECVD_PROPS		(1 << 4)
68215f0b8c3SMartin Matuska #define	ZFS_ITER_LITERAL_PROPS		(1 << 5)
68315f0b8c3SMartin Matuska #define	ZFS_ITER_SIMPLE			(1 << 6)
68415f0b8c3SMartin Matuska 
685eda14cbcSMatt Macy typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
68616038816SMartin Matuska _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
687d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
688d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f,
68916038816SMartin Matuska     void *);
690d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
691d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *,
692eda14cbcSMatt Macy     uint64_t, uint64_t);
693d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *,
694eda14cbcSMatt Macy     uint64_t, uint64_t);
695d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f,
69616038816SMartin Matuska     void *);
697d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
698d411c1d6SMartin Matuska 
699d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_children_v2(zfs_handle_t *, int, zfs_iter_f, void *);
700d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_dependents_v2(zfs_handle_t *, int, boolean_t, zfs_iter_f,
701d411c1d6SMartin Matuska     void *);
702d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_filesystems_v2(zfs_handle_t *, int, zfs_iter_f, void *);
703d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_v2(zfs_handle_t *, int, zfs_iter_f, void *,
704d411c1d6SMartin Matuska     uint64_t, uint64_t);
705d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_sorted_v2(zfs_handle_t *, int, zfs_iter_f,
706d411c1d6SMartin Matuska     void *, uint64_t, uint64_t);
707d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapspec_v2(zfs_handle_t *, int, const char *,
708d411c1d6SMartin Matuska     zfs_iter_f, void *);
709d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_bookmarks_v2(zfs_handle_t *, int, zfs_iter_f, void *);
71016038816SMartin Matuska _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *);
711eda14cbcSMatt Macy 
712eda14cbcSMatt Macy typedef struct get_all_cb {
713eda14cbcSMatt Macy 	zfs_handle_t	**cb_handles;
714eda14cbcSMatt Macy 	size_t		cb_alloc;
715eda14cbcSMatt Macy 	size_t		cb_used;
716eda14cbcSMatt Macy } get_all_cb_t;
717eda14cbcSMatt Macy 
71816038816SMartin Matuska _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **,
719*aca928a5SMartin Matuska     size_t, zfs_iter_f, void *, uint_t);
72016038816SMartin Matuska _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
721eda14cbcSMatt Macy 
722eda14cbcSMatt Macy /*
723eda14cbcSMatt Macy  * Functions to create and destroy datasets.
724eda14cbcSMatt Macy  */
72516038816SMartin Matuska _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
726eda14cbcSMatt Macy     nvlist_t *);
72716038816SMartin Matuska _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *);
72816038816SMartin Matuska _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t);
72916038816SMartin Matuska _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
73016038816SMartin Matuska _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
7316ba2210eSMartin Matuska _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *);
73216038816SMartin Matuska _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
73316038816SMartin Matuska _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t,
73416038816SMartin Matuska     nvlist_t *);
73516038816SMartin Matuska _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
736eda14cbcSMatt Macy     nvlist_t *props);
73716038816SMartin Matuska _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
738eac7052fSMatt Macy 
739eac7052fSMatt Macy typedef struct renameflags {
740eac7052fSMatt Macy 	/* recursive rename */
741dbd5678dSMartin Matuska 	unsigned int recursive : 1;
742eac7052fSMatt Macy 
743eac7052fSMatt Macy 	/* don't unmount file systems */
744dbd5678dSMartin Matuska 	unsigned int nounmount : 1;
745eac7052fSMatt Macy 
746eac7052fSMatt Macy 	/* force unmount file systems */
747dbd5678dSMartin Matuska 	unsigned int forceunmount : 1;
748eac7052fSMatt Macy } renameflags_t;
749eac7052fSMatt Macy 
75016038816SMartin Matuska _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t);
751eda14cbcSMatt Macy 
752eda14cbcSMatt Macy typedef struct sendflags {
753eda14cbcSMatt Macy 	/* Amount of extra information to print. */
754eda14cbcSMatt Macy 	int verbosity;
755eda14cbcSMatt Macy 
756eda14cbcSMatt Macy 	/* recursive send  (ie, -R) */
757eda14cbcSMatt Macy 	boolean_t replicate;
758eda14cbcSMatt Macy 
75916038816SMartin Matuska 	/* for recursive send, skip sending missing snapshots */
76016038816SMartin Matuska 	boolean_t skipmissing;
76116038816SMartin Matuska 
762eda14cbcSMatt Macy 	/* for incrementals, do all intermediate snapshots */
763eda14cbcSMatt Macy 	boolean_t doall;
764eda14cbcSMatt Macy 
765eda14cbcSMatt Macy 	/* if dataset is a clone, do incremental from its origin */
766eda14cbcSMatt Macy 	boolean_t fromorigin;
767eda14cbcSMatt Macy 
768eda14cbcSMatt Macy 	/* field no longer used, maintained for backwards compatibility */
769eda14cbcSMatt Macy 	boolean_t pad;
770eda14cbcSMatt Macy 
771eda14cbcSMatt Macy 	/* send properties (ie, -p) */
772eda14cbcSMatt Macy 	boolean_t props;
773eda14cbcSMatt Macy 
774eda14cbcSMatt Macy 	/* do not send (no-op, ie. -n) */
775eda14cbcSMatt Macy 	boolean_t dryrun;
776eda14cbcSMatt Macy 
777eda14cbcSMatt Macy 	/* parsable verbose output (ie. -P) */
778eda14cbcSMatt Macy 	boolean_t parsable;
779eda14cbcSMatt Macy 
780eda14cbcSMatt Macy 	/* show progress (ie. -v) */
781eda14cbcSMatt Macy 	boolean_t progress;
782eda14cbcSMatt Macy 
78315f0b8c3SMartin Matuska 	/* show progress as process title (ie. -V) */
78415f0b8c3SMartin Matuska 	boolean_t progressastitle;
78515f0b8c3SMartin Matuska 
786eda14cbcSMatt Macy 	/* large blocks (>128K) are permitted */
787eda14cbcSMatt Macy 	boolean_t largeblock;
788eda14cbcSMatt Macy 
789eda14cbcSMatt Macy 	/* WRITE_EMBEDDED records of type DATA are permitted */
790eda14cbcSMatt Macy 	boolean_t embed_data;
791eda14cbcSMatt Macy 
792eda14cbcSMatt Macy 	/* compressed WRITE records are permitted */
793eda14cbcSMatt Macy 	boolean_t compress;
794eda14cbcSMatt Macy 
795eda14cbcSMatt Macy 	/* raw encrypted records are permitted */
796eda14cbcSMatt Macy 	boolean_t raw;
797eda14cbcSMatt Macy 
798eda14cbcSMatt Macy 	/* only send received properties (ie. -b) */
799eda14cbcSMatt Macy 	boolean_t backup;
800eda14cbcSMatt Macy 
801eda14cbcSMatt Macy 	/* include snapshot holds in send stream */
802eda14cbcSMatt Macy 	boolean_t holds;
803eda14cbcSMatt Macy 
804eda14cbcSMatt Macy 	/* stream represents a partially received dataset */
805eda14cbcSMatt Macy 	boolean_t saved;
806eda14cbcSMatt Macy } sendflags_t;
807eda14cbcSMatt Macy 
808eda14cbcSMatt Macy typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
809eda14cbcSMatt Macy 
81016038816SMartin Matuska _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *,
811eda14cbcSMatt Macy     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
81216038816SMartin Matuska _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *,
813eda14cbcSMatt Macy     const char *);
81416038816SMartin Matuska _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *);
81516038816SMartin Matuska _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
816eda14cbcSMatt Macy     const char *);
81716038816SMartin Matuska _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *);
81816038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
819eda14cbcSMatt Macy     const char *token);
820eda14cbcSMatt Macy 
82116038816SMartin Matuska _LIBZFS_H int zfs_promote(zfs_handle_t *);
82216038816SMartin Matuska _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *,
823eda14cbcSMatt Macy     boolean_t, int);
82416038816SMartin Matuska _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
82516038816SMartin Matuska _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *,
82616038816SMartin Matuska     boolean_t);
82716038816SMartin Matuska _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **);
82816038816SMartin Matuska _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t,
829eda14cbcSMatt Macy     nvlist_t *);
830eda14cbcSMatt Macy 
831eda14cbcSMatt Macy typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
832eda14cbcSMatt Macy     uid_t rid, uint64_t space);
833eda14cbcSMatt Macy 
83416038816SMartin Matuska _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
835eda14cbcSMatt Macy     zfs_userspace_cb_t, void *);
836eda14cbcSMatt Macy 
83716038816SMartin Matuska _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
83816038816SMartin Matuska _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
839eda14cbcSMatt Macy 
840eda14cbcSMatt Macy typedef struct recvflags {
841eda14cbcSMatt Macy 	/* print informational messages (ie, -v was specified) */
842eda14cbcSMatt Macy 	boolean_t verbose;
843eda14cbcSMatt Macy 
844eda14cbcSMatt Macy 	/* the destination is a prefix, not the exact fs (ie, -d) */
845eda14cbcSMatt Macy 	boolean_t isprefix;
846eda14cbcSMatt Macy 
847eda14cbcSMatt Macy 	/*
848eda14cbcSMatt Macy 	 * Only the tail of the sent snapshot path is appended to the
849eda14cbcSMatt Macy 	 * destination to determine the received snapshot name (ie, -e).
850eda14cbcSMatt Macy 	 */
851eda14cbcSMatt Macy 	boolean_t istail;
852eda14cbcSMatt Macy 
853eda14cbcSMatt Macy 	/* do not actually do the recv, just check if it would work (ie, -n) */
854eda14cbcSMatt Macy 	boolean_t dryrun;
855eda14cbcSMatt Macy 
856eda14cbcSMatt Macy 	/* rollback/destroy filesystems as necessary (eg, -F) */
857eda14cbcSMatt Macy 	boolean_t force;
858eda14cbcSMatt Macy 
859eda14cbcSMatt Macy 	/* set "canmount=off" on all modified filesystems */
860eda14cbcSMatt Macy 	boolean_t canmountoff;
861eda14cbcSMatt Macy 
862eda14cbcSMatt Macy 	/*
863eda14cbcSMatt Macy 	 * Mark the file systems as "resumable" and do not destroy them if the
864eda14cbcSMatt Macy 	 * receive is interrupted
865eda14cbcSMatt Macy 	 */
866eda14cbcSMatt Macy 	boolean_t resumable;
867eda14cbcSMatt Macy 
868eda14cbcSMatt Macy 	/* byteswap flag is used internally; callers need not specify */
869eda14cbcSMatt Macy 	boolean_t byteswap;
870eda14cbcSMatt Macy 
871eda14cbcSMatt Macy 	/* do not mount file systems as they are extracted (private) */
872eda14cbcSMatt Macy 	boolean_t nomount;
873eda14cbcSMatt Macy 
874eda14cbcSMatt Macy 	/* Was holds flag set in the compound header? */
875eda14cbcSMatt Macy 	boolean_t holds;
876eda14cbcSMatt Macy 
877eda14cbcSMatt Macy 	/* skip receive of snapshot holds */
878eda14cbcSMatt Macy 	boolean_t skipholds;
879eda14cbcSMatt Macy 
880eda14cbcSMatt Macy 	/* mount the filesystem unless nomount is specified */
881eda14cbcSMatt Macy 	boolean_t domount;
882eda14cbcSMatt Macy 
883eda14cbcSMatt Macy 	/* force unmount while recv snapshot (private) */
884eda14cbcSMatt Macy 	boolean_t forceunmount;
885271171e0SMartin Matuska 
886271171e0SMartin Matuska 	/* use this recv to check (and heal if needed) an existing snapshot */
887271171e0SMartin Matuska 	boolean_t heal;
888eda14cbcSMatt Macy } recvflags_t;
889eda14cbcSMatt Macy 
89016038816SMartin Matuska _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
891eda14cbcSMatt Macy     recvflags_t *, int, avl_tree_t *);
892eda14cbcSMatt Macy 
893eda14cbcSMatt Macy typedef enum diff_flags {
894681ce946SMartin Matuska 	ZFS_DIFF_PARSEABLE = 1 << 0,
895681ce946SMartin Matuska 	ZFS_DIFF_TIMESTAMP = 1 << 1,
896681ce946SMartin Matuska 	ZFS_DIFF_CLASSIFY = 1 << 2,
897681ce946SMartin Matuska 	ZFS_DIFF_NO_MANGLE = 1 << 3
898eda14cbcSMatt Macy } diff_flags_t;
899eda14cbcSMatt Macy 
90016038816SMartin Matuska _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
901eda14cbcSMatt Macy     int);
902eda14cbcSMatt Macy 
903eda14cbcSMatt Macy /*
904eda14cbcSMatt Macy  * Miscellaneous functions.
905eda14cbcSMatt Macy  */
90616038816SMartin Matuska _LIBZFS_H const char *zfs_type_to_name(zfs_type_t);
90716038816SMartin Matuska _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *);
90816038816SMartin Matuska _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t);
90916038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *,
910eda14cbcSMatt Macy     zfs_type_t);
91116038816SMartin Matuska _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t);
91216038816SMartin Matuska _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
913eda14cbcSMatt Macy     zfs_type_t);
91416038816SMartin Matuska _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *);
91516038816SMartin Matuska _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path);
916eda14cbcSMatt Macy 
917eda14cbcSMatt Macy /*
918eda14cbcSMatt Macy  * Mount support functions.
919eda14cbcSMatt Macy  */
92016038816SMartin Matuska _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
92116038816SMartin Matuska _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **);
92216038816SMartin Matuska _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int);
92316038816SMartin Matuska _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *);
92416038816SMartin Matuska _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int);
92516038816SMartin Matuska _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int);
92616038816SMartin Matuska _LIBZFS_H int zfs_mount_delegation_check(void);
927eda14cbcSMatt Macy 
92853b70c86SMartin Matuska #if defined(__linux__) || defined(__APPLE__)
929a0b956f5SMartin Matuska _LIBZFS_H int zfs_parse_mount_options(const char *mntopts,
930a0b956f5SMartin Matuska     unsigned long *mntflags, unsigned long *zfsflags, int sloppy, char *badopt,
931a0b956f5SMartin Matuska     char *mtabopt);
93216038816SMartin Matuska _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint,
933eda14cbcSMatt Macy     char *mntopts, char *mtabopt);
934eda14cbcSMatt Macy #endif
935eda14cbcSMatt Macy 
936eda14cbcSMatt Macy /*
937eda14cbcSMatt Macy  * Share support functions.
938716fd348SMartin Matuska  *
939716fd348SMartin Matuska  * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL,
940716fd348SMartin Matuska  * NULL means "all/any known to this libzfs".
941eda14cbcSMatt Macy  */
942716fd348SMartin Matuska #define	SA_NO_PROTOCOL -1
943eda14cbcSMatt Macy 
944716fd348SMartin Matuska _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where,
945716fd348SMartin Matuska     const enum sa_protocol *proto);
946716fd348SMartin Matuska _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto);
947716fd348SMartin Matuska _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint,
948716fd348SMartin Matuska     const enum sa_protocol *proto);
949716fd348SMartin Matuska _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp,
950716fd348SMartin Matuska     const enum sa_protocol *proto);
951716fd348SMartin Matuska _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto);
952c7046f76SMartin Matuska _LIBZFS_H void zfs_truncate_shares(const enum sa_protocol *proto);
953eda14cbcSMatt Macy 
95416038816SMartin Matuska _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
955eda14cbcSMatt Macy 
956eda14cbcSMatt Macy /*
957716fd348SMartin Matuska  * Utility functions to run an external process.
958eda14cbcSMatt Macy  */
959eda14cbcSMatt Macy #define	STDOUT_VERBOSE	0x01
960eda14cbcSMatt Macy #define	STDERR_VERBOSE	0x02
961eda14cbcSMatt Macy #define	NO_DEFAULT_PATH	0x04 /* Don't use $PATH to lookup the command */
962eda14cbcSMatt Macy 
96316038816SMartin Matuska _LIBZFS_H int libzfs_run_process(const char *, char **, int);
96416038816SMartin Matuska _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[],
965eda14cbcSMatt Macy     char **[], int *);
96616038816SMartin Matuska _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[],
96716038816SMartin Matuska     char *[], char **[], int *);
968eda14cbcSMatt Macy 
96916038816SMartin Matuska _LIBZFS_H void libzfs_free_str_array(char **, int);
970eda14cbcSMatt Macy 
971a0b956f5SMartin Matuska _LIBZFS_H boolean_t libzfs_envvar_is_set(const char *);
972eda14cbcSMatt Macy 
973eda14cbcSMatt Macy /*
974eda14cbcSMatt Macy  * Utility functions for zfs version
975eda14cbcSMatt Macy  */
976e3aa18adSMartin Matuska _LIBZFS_H const char *zfs_version_userland(void);
977e3aa18adSMartin Matuska _LIBZFS_H char *zfs_version_kernel(void);
97816038816SMartin Matuska _LIBZFS_H int zfs_version_print(void);
979eda14cbcSMatt Macy 
980eda14cbcSMatt Macy /*
981eda14cbcSMatt Macy  * Given a device or file, determine if it is part of a pool.
982eda14cbcSMatt Macy  */
98316038816SMartin Matuska _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
984eda14cbcSMatt Macy     boolean_t *);
985eda14cbcSMatt Macy 
986eda14cbcSMatt Macy /*
987eda14cbcSMatt Macy  * Label manipulation.
988eda14cbcSMatt Macy  */
98916038816SMartin Matuska _LIBZFS_H int zpool_clear_label(int);
99016038816SMartin Matuska _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *);
99116038816SMartin Matuska _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **);
992eda14cbcSMatt Macy 
993eda14cbcSMatt Macy /*
994eda14cbcSMatt Macy  * Management interfaces for SMB ACL files
995eda14cbcSMatt Macy  */
996eda14cbcSMatt Macy 
99716038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
99816038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
99916038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
100016038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *,
100116038816SMartin Matuska     char *);
1002eda14cbcSMatt Macy 
1003eda14cbcSMatt Macy /*
1004eda14cbcSMatt Macy  * Enable and disable datasets within a pool by mounting/unmounting and
1005eda14cbcSMatt Macy  * sharing/unsharing them.
1006eda14cbcSMatt Macy  */
1007*aca928a5SMartin Matuska _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int,
1008*aca928a5SMartin Matuska     uint_t);
100916038816SMartin Matuska _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t);
101053b70c86SMartin Matuska _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t);
101153b70c86SMartin Matuska _LIBZFS_H void zpool_disable_volume_os(const char *);
1012eda14cbcSMatt Macy 
1013ee36e25aSMartin Matuska /*
1014ee36e25aSMartin Matuska  * Parse a features file for -o compatibility
1015ee36e25aSMartin Matuska  */
1016ee36e25aSMartin Matuska typedef enum {
1017ee36e25aSMartin Matuska 	ZPOOL_COMPATIBILITY_OK,
101816038816SMartin Matuska 	ZPOOL_COMPATIBILITY_WARNTOKEN,
101916038816SMartin Matuska 	ZPOOL_COMPATIBILITY_BADTOKEN,
1020ee36e25aSMartin Matuska 	ZPOOL_COMPATIBILITY_BADFILE,
1021ee36e25aSMartin Matuska 	ZPOOL_COMPATIBILITY_NOFILES
1022ee36e25aSMartin Matuska } zpool_compat_status_t;
1023ee36e25aSMartin Matuska 
102416038816SMartin Matuska _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *,
102516038816SMartin Matuska     boolean_t *, char *, size_t);
1026ee36e25aSMartin Matuska 
1027eda14cbcSMatt Macy #ifdef __FreeBSD__
1028eda14cbcSMatt Macy 
1029eda14cbcSMatt Macy /*
1030eda14cbcSMatt Macy  * Attach/detach the given filesystem to/from the given jail.
1031eda14cbcSMatt Macy  */
103216038816SMartin Matuska _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach);
1033eda14cbcSMatt Macy 
1034eda14cbcSMatt Macy /*
1035eda14cbcSMatt Macy  * Set loader options for next boot.
1036eda14cbcSMatt Macy  */
103716038816SMartin Matuska _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t,
103816038816SMartin Matuska     const char *);
1039eda14cbcSMatt Macy 
1040eda14cbcSMatt Macy #endif /* __FreeBSD__ */
1041eda14cbcSMatt Macy 
10421f1e2261SMartin Matuska #ifdef __linux__
10431f1e2261SMartin Matuska 
10441f1e2261SMartin Matuska /*
10451f1e2261SMartin Matuska  * Add or delete the given filesystem to/from the given user namespace.
10461f1e2261SMartin Matuska  */
10471f1e2261SMartin Matuska _LIBZFS_H int zfs_userns(zfs_handle_t *zhp, const char *nspath, int attach);
10481f1e2261SMartin Matuska 
10491f1e2261SMartin Matuska #endif
10501f1e2261SMartin Matuska 
1051eda14cbcSMatt Macy #ifdef	__cplusplus
1052eda14cbcSMatt Macy }
1053eda14cbcSMatt Macy #endif
1054eda14cbcSMatt Macy 
1055eda14cbcSMatt Macy #endif	/* _LIBZFS_H */
1056