xref: /illumos-gate/usr/src/lib/libzfs/common/libzfs.h (revision b4fb003914e70b41d96dec8011864f6af1faf3ef)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2011 Pawel Jakub Dawidek. All rights reserved.
25  * Copyright (c) 2011, 2018 by Delphix. All rights reserved.
26  * Copyright 2020 Joyent, Inc.
27  * Copyright (c) 2013 Steven Hartland. All rights reserved.
28  * Copyright (c) 2014 Integros [integros.com]
29  * Copyright 2016 Nexenta Systems, Inc.
30  * Copyright (c) 2017 Datto Inc.
31  */
32 
33 #ifndef	_LIBZFS_H
34 #define	_LIBZFS_H
35 
36 #include <assert.h>
37 #include <libnvpair.h>
38 #include <sys/mnttab.h>
39 #include <sys/param.h>
40 #include <sys/types.h>
41 #include <sys/varargs.h>
42 #include <sys/fs/zfs.h>
43 #include <sys/avl.h>
44 #include <ucred.h>
45 #include <libzfs_core.h>
46 
47 #ifdef	__cplusplus
48 extern "C" {
49 #endif
50 
51 /*
52  * Miscellaneous ZFS constants
53  */
54 #define	ZFS_MAXPROPLEN		MAXPATHLEN
55 #define	ZPOOL_MAXPROPLEN	MAXPATHLEN
56 
57 /*
58  * libzfs errors
59  */
60 typedef enum zfs_error {
61 	EZFS_SUCCESS = 0,	/* no error -- success */
62 	EZFS_NOMEM = 2000,	/* out of memory */
63 	EZFS_BADPROP,		/* invalid property value */
64 	EZFS_PROPREADONLY,	/* cannot set readonly property */
65 	EZFS_PROPTYPE,		/* property does not apply to dataset type */
66 	EZFS_PROPNONINHERIT,	/* property is not inheritable */
67 	EZFS_PROPSPACE,		/* bad quota or reservation */
68 	EZFS_BADTYPE,		/* dataset is not of appropriate type */
69 	EZFS_BUSY,		/* pool or dataset is busy */
70 	EZFS_EXISTS,		/* pool or dataset already exists */
71 	EZFS_NOENT,		/* no such pool or dataset */
72 	EZFS_BADSTREAM,		/* bad backup stream */
73 	EZFS_DSREADONLY,	/* dataset is readonly */
74 	EZFS_VOLTOOBIG,		/* volume is too large for 32-bit system */
75 	EZFS_INVALIDNAME,	/* invalid dataset name */
76 	EZFS_BADRESTORE,	/* unable to restore to destination */
77 	EZFS_BADBACKUP,		/* backup failed */
78 	EZFS_BADTARGET,		/* bad attach/detach/replace target */
79 	EZFS_NODEVICE,		/* no such device in pool */
80 	EZFS_BADDEV,		/* invalid device to add */
81 	EZFS_NOREPLICAS,	/* no valid replicas */
82 	EZFS_RESILVERING,	/* currently resilvering */
83 	EZFS_BADVERSION,	/* unsupported version */
84 	EZFS_POOLUNAVAIL,	/* pool is currently unavailable */
85 	EZFS_DEVOVERFLOW,	/* too many devices in one vdev */
86 	EZFS_BADPATH,		/* must be an absolute path */
87 	EZFS_CROSSTARGET,	/* rename or clone across pool or dataset */
88 	EZFS_ZONED,		/* used improperly in local zone */
89 	EZFS_MOUNTFAILED,	/* failed to mount dataset */
90 	EZFS_UMOUNTFAILED,	/* failed to unmount dataset */
91 	EZFS_UNSHARENFSFAILED,	/* unshare(8) failed */
92 	EZFS_SHARENFSFAILED,	/* share(8) failed */
93 	EZFS_PERM,		/* permission denied */
94 	EZFS_NOSPC,		/* out of space */
95 	EZFS_FAULT,		/* bad address */
96 	EZFS_IO,		/* I/O error */
97 	EZFS_INTR,		/* signal received */
98 	EZFS_ISSPARE,		/* device is a hot spare */
99 	EZFS_INVALCONFIG,	/* invalid vdev configuration */
100 	EZFS_RECURSIVE,		/* recursive dependency */
101 	EZFS_NOHISTORY,		/* no history object */
102 	EZFS_POOLPROPS,		/* couldn't retrieve pool props */
103 	EZFS_POOL_NOTSUP,	/* ops not supported for this type of pool */
104 	EZFS_POOL_INVALARG,	/* invalid argument for this pool operation */
105 	EZFS_NAMETOOLONG,	/* dataset name is too long */
106 	EZFS_OPENFAILED,	/* open of device failed */
107 	EZFS_NOCAP,		/* couldn't get capacity */
108 	EZFS_LABELFAILED,	/* write of label failed */
109 	EZFS_BADWHO,		/* invalid permission who */
110 	EZFS_BADPERM,		/* invalid permission */
111 	EZFS_BADPERMSET,	/* invalid permission set name */
112 	EZFS_NODELEGATION,	/* delegated administration is disabled */
113 	EZFS_UNSHARESMBFAILED,	/* failed to unshare over smb */
114 	EZFS_SHARESMBFAILED,	/* failed to share over smb */
115 	EZFS_BADCACHE,		/* bad cache file */
116 	EZFS_ISL2CACHE,		/* device is for the level 2 ARC */
117 	EZFS_VDEVNOTSUP,	/* unsupported vdev type */
118 	EZFS_NOTSUP,		/* ops not supported on this dataset */
119 	EZFS_ACTIVE_SPARE,	/* pool has active shared spare devices */
120 	EZFS_UNPLAYED_LOGS,	/* log device has unplayed logs */
121 	EZFS_REFTAG_RELE,	/* snapshot release: tag not found */
122 	EZFS_REFTAG_HOLD,	/* snapshot hold: tag already exists */
123 	EZFS_TAGTOOLONG,	/* snapshot hold/rele: tag too long */
124 	EZFS_PIPEFAILED,	/* pipe create failed */
125 	EZFS_THREADCREATEFAILED, /* thread create failed */
126 	EZFS_POSTSPLIT_ONLINE,	/* onlining a disk after splitting it */
127 	EZFS_SCRUBBING,		/* currently scrubbing */
128 	EZFS_NO_SCRUB,		/* no active scrub */
129 	EZFS_DIFF,		/* general failure of zfs diff */
130 	EZFS_DIFFDATA,		/* bad zfs diff data */
131 	EZFS_POOLREADONLY,	/* pool is in read-only mode */
132 	EZFS_SCRUB_PAUSED,	/* scrub currently paused */
133 	EZFS_ACTIVE_POOL,	/* pool is imported on a different system */
134 	EZFS_CRYPTOFAILED,	/* failed to setup encryption */
135 	EZFS_NO_PENDING,	/* cannot cancel, no operation is pending */
136 	EZFS_CHECKPOINT_EXISTS,	/* checkpoint exists */
137 	EZFS_DISCARDING_CHECKPOINT,	/* currently discarding a checkpoint */
138 	EZFS_NO_CHECKPOINT,	/* pool has no checkpoint */
139 	EZFS_DEVRM_IN_PROGRESS,	/* a device is currently being removed */
140 	EZFS_VDEV_TOO_BIG,	/* a device is too big to be used */
141 	EZFS_TOOMANY,		/* argument list too long */
142 	EZFS_INITIALIZING,	/* currently initializing */
143 	EZFS_NO_INITIALIZE,	/* no active initialize */
144 	EZFS_WRONG_PARENT,	/* invalid parent dataset (e.g ZVOL) */
145 	EZFS_TRIMMING,		/* currently trimming */
146 	EZFS_NO_TRIM,		/* no active trim */
147 	EZFS_TRIM_NOTSUP,	/* device does not support trim */
148 	EZFS_NO_RESILVER_DEFER,	/* pool doesn't support resilver_defer */
149 	EZFS_IOC_NOTSUPPORTED,	/* operation not supported by zfs module */
150 	EZFS_UNKNOWN
151 } zfs_error_t;
152 
153 /*
154  * UEFI boot support parameters. When creating whole disk boot pool,
155  * zpool create should allow to create EFI System partition for UEFI boot
156  * program. In case of BIOS, the EFI System partition is not used
157  * even if it does exist.
158  */
159 typedef enum zpool_boot_label {
160 	ZPOOL_NO_BOOT_LABEL = 0,
161 	ZPOOL_CREATE_BOOT_LABEL,
162 	ZPOOL_COPY_BOOT_LABEL
163 } zpool_boot_label_t;
164 
165 /*
166  * The following data structures are all part
167  * of the zfs_allow_t data structure which is
168  * used for printing 'allow' permissions.
169  * It is a linked list of zfs_allow_t's which
170  * then contain avl tree's for user/group/sets/...
171  * and each one of the entries in those trees have
172  * avl tree's for the permissions they belong to and
173  * whether they are local,descendent or local+descendent
174  * permissions.  The AVL trees are used primarily for
175  * sorting purposes, but also so that we can quickly find
176  * a given user and or permission.
177  */
178 typedef struct zfs_perm_node {
179 	avl_node_t z_node;
180 	char z_pname[MAXPATHLEN];
181 } zfs_perm_node_t;
182 
183 typedef struct zfs_allow_node {
184 	avl_node_t z_node;
185 	char z_key[MAXPATHLEN];		/* name, such as joe */
186 	avl_tree_t z_localdescend;	/* local+descendent perms */
187 	avl_tree_t z_local;		/* local permissions */
188 	avl_tree_t z_descend;		/* descendent permissions */
189 } zfs_allow_node_t;
190 
191 typedef struct zfs_allow {
192 	struct zfs_allow *z_next;
193 	char z_setpoint[MAXPATHLEN];
194 	avl_tree_t z_sets;
195 	avl_tree_t z_crperms;
196 	avl_tree_t z_user;
197 	avl_tree_t z_group;
198 	avl_tree_t z_everyone;
199 } zfs_allow_t;
200 
201 /*
202  * Basic handle types
203  */
204 typedef struct zfs_handle zfs_handle_t;
205 typedef struct zpool_handle zpool_handle_t;
206 typedef struct libzfs_handle libzfs_handle_t;
207 
208 /*
209  * Library initialization
210  */
211 extern libzfs_handle_t *libzfs_init(void);
212 extern void libzfs_fini(libzfs_handle_t *);
213 
214 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
215 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
216 
217 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
218 
219 extern void zfs_save_arguments(int argc, char **, char *, int);
220 extern int zpool_log_history(libzfs_handle_t *, const char *);
221 
222 extern int libzfs_errno(libzfs_handle_t *);
223 extern const char *libzfs_error_action(libzfs_handle_t *);
224 extern const char *libzfs_error_description(libzfs_handle_t *);
225 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
226 extern void libzfs_mnttab_init(libzfs_handle_t *);
227 extern void libzfs_mnttab_fini(libzfs_handle_t *);
228 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
229 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
230     struct mnttab *);
231 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
232     const char *, const char *);
233 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
234 
235 /*
236  * Basic handle functions
237  */
238 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
239 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
240 extern void zpool_close(zpool_handle_t *);
241 extern const char *zpool_get_name(zpool_handle_t *);
242 extern int zpool_get_state(zpool_handle_t *);
243 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
244 extern const char *zpool_pool_state_to_name(pool_state_t);
245 extern void zpool_free_handles(libzfs_handle_t *);
246 
247 /*
248  * Iterate over all active pools in the system.
249  */
250 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
251 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
252 extern boolean_t zpool_skip_pool(const char *);
253 
254 /*
255  * Functions to create and destroy pools
256  */
257 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
258     nvlist_t *, nvlist_t *);
259 extern int zpool_destroy(zpool_handle_t *, const char *);
260 extern int zpool_add(zpool_handle_t *, nvlist_t *);
261 
262 typedef struct splitflags {
263 	/* do not split, but return the config that would be split off */
264 	int dryrun : 1;
265 
266 	/* after splitting, import the pool */
267 	int import : 1;
268 	int name_flags;
269 } splitflags_t;
270 
271 typedef struct trimflags {
272 	/* requested vdevs are for the entire pool */
273 	boolean_t fullpool;
274 
275 	/* request a secure trim, requires support from device */
276 	boolean_t secure;
277 
278 	/* trim at the requested rate in bytes/second */
279 	uint64_t rate;
280 } trimflags_t;
281 
282 /*
283  * Functions to manipulate pool and vdev state
284  */
285 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
286 extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t,
287     nvlist_t *);
288 extern int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *,
289     trimflags_t *);
290 
291 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
292 extern int zpool_reguid(zpool_handle_t *);
293 extern int zpool_reopen(zpool_handle_t *);
294 
295 extern int zpool_sync_one(zpool_handle_t *, void *);
296 
297 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
298     vdev_state_t *);
299 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
300 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
301     const char *, nvlist_t *, int);
302 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
303 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
304 extern int zpool_vdev_remove_cancel(zpool_handle_t *);
305 extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *);
306 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
307     splitflags_t);
308 
309 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
310 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
311 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
312 
313 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
314     boolean_t *, boolean_t *);
315 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
316     boolean_t *, boolean_t *, boolean_t *);
317 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *,
318     zpool_boot_label_t, uint64_t, int *);
319 extern void zpool_vdev_refresh_path(libzfs_handle_t *, zpool_handle_t *,
320     nvlist_t *);
321 
322 /*
323  * Functions to manage pool properties
324  */
325 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
326 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
327     size_t proplen, zprop_source_t *, boolean_t);
328 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
329     zprop_source_t *);
330 
331 extern const char *zpool_prop_to_name(zpool_prop_t);
332 extern const char *zpool_prop_values(zpool_prop_t);
333 
334 /*
335  * Pool health statistics.
336  */
337 typedef enum {
338 	/*
339 	 * The following correspond to faults as defined in the (fault.fs.zfs.*)
340 	 * event namespace.  Each is associated with a corresponding message ID.
341 	 * This must be kept in sync with the zfs_msgid_table in
342 	 * lib/libzfs/libzfs_status.c.
343 	 */
344 	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */
345 	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */
346 	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */
347 	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */
348 	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */
349 	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */
350 	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */
351 	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */
352 	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */
353 	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */
354 	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */
355 	ZPOOL_STATUS_HOSTID_ACTIVE,	/* currently active on another system */
356 	ZPOOL_STATUS_HOSTID_REQUIRED,	/* multihost=on and hostid=0 */
357 	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */
358 	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
359 	ZPOOL_STATUS_IO_FAILURE_MMP,	/* failed MMP, failmode not 'panic' */
360 	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */
361 	ZPOOL_STATUS_ERRATA,		/* informational errata available */
362 
363 	/*
364 	 * If the pool has unsupported features but can still be opened in
365 	 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
366 	 * pool has unsupported features but cannot be opened at all, its
367 	 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
368 	 */
369 	ZPOOL_STATUS_UNSUP_FEAT_READ,	/* unsupported features for read */
370 	ZPOOL_STATUS_UNSUP_FEAT_WRITE,	/* unsupported features for write */
371 
372 	/*
373 	 * These faults have no corresponding message ID.  At the time we are
374 	 * checking the status, the original reason for the FMA fault (I/O or
375 	 * checksum errors) has been lost.
376 	 */
377 	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */
378 	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */
379 
380 	/*
381 	 * The following are not faults per se, but still an error possibly
382 	 * requiring administrative attention.  There is no corresponding
383 	 * message ID.
384 	 */
385 	ZPOOL_STATUS_VERSION_OLDER,	/* older legacy on-disk version */
386 	ZPOOL_STATUS_FEAT_DISABLED,	/* supported features are disabled */
387 	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */
388 	ZPOOL_STATUS_OFFLINE_DEV,	/* device offline */
389 	ZPOOL_STATUS_REMOVED_DEV,	/* removed device */
390 
391 	/*
392 	 * Finally, the following indicates a healthy pool.
393 	 */
394 	ZPOOL_STATUS_OK
395 } zpool_status_t;
396 
397 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **,
398     zpool_errata_t *);
399 extern zpool_status_t zpool_import_status(nvlist_t *, char **,
400     zpool_errata_t *);
401 
402 /*
403  * Statistics and configuration functions.
404  */
405 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
406 extern nvlist_t *zpool_get_features(zpool_handle_t *);
407 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
408 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
409 extern boolean_t zpool_is_bootable(zpool_handle_t *);
410 
411 /*
412  * Import and export functions
413  */
414 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
415 extern int zpool_export_force(zpool_handle_t *, const char *);
416 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
417     char *altroot);
418 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
419     nvlist_t *, int);
420 extern void zpool_print_unsup_feat(nvlist_t *config);
421 
422 /*
423  * Miscellaneous pool functions
424  */
425 struct zfs_cmd;
426 
427 extern const char *zfs_history_event_names[];
428 
429 typedef enum {
430 	VDEV_NAME_PATH		= 1 << 0,
431 	VDEV_NAME_GUID		= 1 << 1,
432 	VDEV_NAME_FOLLOW_LINKS	= 1 << 2,
433 	VDEV_NAME_TYPE_ID	= 1 << 3,
434 } vdev_name_t;
435 
436 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
437     int name_flags);
438 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
439 extern int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *,
440     boolean_t *);
441 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
442     size_t len);
443 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
444 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
445 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
446     nvlist_t *);
447 extern int zpool_checkpoint(zpool_handle_t *);
448 extern int zpool_discard_checkpoint(zpool_handle_t *);
449 
450 /*
451  * Basic handle manipulations.  These functions do not create or destroy the
452  * underlying datasets, only the references to them.
453  */
454 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
455 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
456 extern void zfs_close(zfs_handle_t *);
457 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
458 extern const char *zfs_get_name(const zfs_handle_t *);
459 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
460 extern const char *zfs_get_pool_name(const zfs_handle_t *);
461 
462 /*
463  * Property management functions.  Some functions are shared with the kernel,
464  * and are found in sys/fs/zfs.h.
465  */
466 
467 /*
468  * zfs dataset property management
469  */
470 extern const char *zfs_prop_default_string(zfs_prop_t);
471 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
472 extern const char *zfs_prop_column_name(zfs_prop_t);
473 extern boolean_t zfs_prop_align_right(zfs_prop_t);
474 
475 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *,
476     uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *);
477 
478 extern const char *zfs_prop_to_name(zfs_prop_t);
479 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
480 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
481 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
482     zprop_source_t *, char *, size_t, boolean_t);
483 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
484     boolean_t);
485 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
486     zprop_source_t *, char *, size_t);
487 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
488     uint64_t *propvalue);
489 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
490     char *propbuf, int proplen, boolean_t literal);
491 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
492     uint64_t *propvalue);
493 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
494     char *propbuf, int proplen, boolean_t literal);
495 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
496     char *buf, size_t len);
497 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
498 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
499 extern const char *zfs_prop_values(zfs_prop_t);
500 extern int zfs_prop_is_string(zfs_prop_t prop);
501 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
502 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
503 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
504 
505 
506 /*
507  * zfs encryption management
508  */
509 extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *);
510 extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *,
511     boolean_t stdin_available, uint8_t **, uint_t *);
512 extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *,
513     nvlist_t *);
514 extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *);
515 extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *);
516 extern int zfs_crypto_unload_key(zfs_handle_t *);
517 extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t);
518 
519 typedef struct zprop_list {
520 	int		pl_prop;
521 	char		*pl_user_prop;
522 	struct zprop_list *pl_next;
523 	boolean_t	pl_all;
524 	size_t		pl_width;
525 	size_t		pl_recvd_width;
526 	boolean_t	pl_fixed;
527 } zprop_list_t;
528 
529 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
530     boolean_t);
531 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
532 
533 #define	ZFS_MOUNTPOINT_NONE	"none"
534 #define	ZFS_MOUNTPOINT_LEGACY	"legacy"
535 
536 #define	ZFS_FEATURE_DISABLED	"disabled"
537 #define	ZFS_FEATURE_ENABLED	"enabled"
538 #define	ZFS_FEATURE_ACTIVE	"active"
539 
540 #define	ZFS_UNSUPPORTED_INACTIVE	"inactive"
541 #define	ZFS_UNSUPPORTED_READONLY	"readonly"
542 
543 /*
544  * zpool property management
545  */
546 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
547 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
548     size_t);
549 extern const char *zpool_prop_default_string(zpool_prop_t);
550 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
551 extern const char *zpool_prop_column_name(zpool_prop_t);
552 extern boolean_t zpool_prop_align_right(zpool_prop_t);
553 
554 /*
555  * Functions shared by zfs and zpool property management.
556  */
557 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
558     boolean_t ordered, zfs_type_t type);
559 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
560     zfs_type_t);
561 extern void zprop_free_list(zprop_list_t *);
562 
563 #define	ZFS_GET_NCOLS	5
564 
565 typedef enum {
566 	GET_COL_NONE,
567 	GET_COL_NAME,
568 	GET_COL_PROPERTY,
569 	GET_COL_VALUE,
570 	GET_COL_RECVD,
571 	GET_COL_SOURCE
572 } zfs_get_column_t;
573 
574 /*
575  * Functions for printing zfs or zpool properties
576  */
577 typedef struct zprop_get_cbdata {
578 	int cb_sources;
579 	zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
580 	int cb_colwidths[ZFS_GET_NCOLS + 1];
581 	boolean_t cb_scripted;
582 	boolean_t cb_literal;
583 	boolean_t cb_first;
584 	zprop_list_t *cb_proplist;
585 	zfs_type_t cb_type;
586 } zprop_get_cbdata_t;
587 
588 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
589     const char *, const char *, zprop_source_t, const char *,
590     const char *);
591 
592 /*
593  * Iterator functions.
594  */
595 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
596 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
597 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
598 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
599 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
600 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
601 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
602 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
603 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
604 
605 typedef struct get_all_cb {
606 	zfs_handle_t	**cb_handles;
607 	size_t		cb_alloc;
608 	size_t		cb_used;
609 } get_all_cb_t;
610 
611 void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t,
612     zfs_iter_f, void *, boolean_t);
613 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
614 
615 /*
616  * Functions to create and destroy datasets.
617  */
618 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
619     nvlist_t *);
620 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
621 extern int zfs_destroy(zfs_handle_t *, boolean_t);
622 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
623 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
624 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
625 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
626 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
627     nvlist_t *props);
628 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
629 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
630 
631 typedef struct sendflags {
632 	/* print informational messages (ie, -v was specified) */
633 	boolean_t verbose;
634 
635 	/* recursive send  (ie, -R) */
636 	boolean_t replicate;
637 
638 	/* for incrementals, do all intermediate snapshots */
639 	boolean_t doall;
640 
641 	/* if dataset is a clone, do incremental from its origin */
642 	boolean_t fromorigin;
643 
644 	/* do deduplication */
645 	boolean_t dedup;
646 
647 	/* send properties (ie, -p) */
648 	boolean_t props;
649 
650 	/* do not send (no-op, ie. -n) */
651 	boolean_t dryrun;
652 
653 	/* parsable verbose output (ie. -P) */
654 	boolean_t parsable;
655 
656 	/* show progress (ie. -v) */
657 	boolean_t progress;
658 
659 	/* large blocks (>128K) are permitted */
660 	boolean_t largeblock;
661 
662 	/* WRITE_EMBEDDED records of type DATA are permitted */
663 	boolean_t embed_data;
664 
665 	/* compressed WRITE records are permitted */
666 	boolean_t compress;
667 
668 	/* raw encrypted records are permitted */
669 	boolean_t raw;
670 
671 	/* only send received properties (ie. -b) */
672 	boolean_t backup;
673 
674 	/* include snapshot holds in send stream */
675 	boolean_t holds;
676 } sendflags_t;
677 
678 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
679 
680 extern int zfs_send(zfs_handle_t *, const char *, const char *,
681     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
682 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
683 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
684     const char *);
685 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
686     const char *token);
687 
688 extern int zfs_promote(zfs_handle_t *);
689 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
690     boolean_t, int);
691 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
692 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
693 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
694 extern uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t,
695     nvlist_t *);
696 
697 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
698     uid_t rid, uint64_t space);
699 
700 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
701     zfs_userspace_cb_t, void *);
702 
703 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
704 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
705 
706 typedef struct recvflags {
707 	/* print informational messages (ie, -v was specified) */
708 	boolean_t verbose;
709 
710 	/* the destination is a prefix, not the exact fs (ie, -d) */
711 	boolean_t isprefix;
712 
713 	/*
714 	 * Only the tail of the sent snapshot path is appended to the
715 	 * destination to determine the received snapshot name (ie, -e).
716 	 */
717 	boolean_t istail;
718 
719 	/* do not actually do the recv, just check if it would work (ie, -n) */
720 	boolean_t dryrun;
721 
722 	/* rollback/destroy filesystems as necessary (eg, -F) */
723 	boolean_t force;
724 
725 	/* set "canmount=off" on all modified filesystems */
726 	boolean_t canmountoff;
727 
728 	/*
729 	 * Mark the file systems as "resumable" and do not destroy them if the
730 	 * receive is interrupted
731 	 */
732 	boolean_t resumable;
733 
734 	/* byteswap flag is used internally; callers need not specify */
735 	boolean_t byteswap;
736 
737 	/* do not mount file systems as they are extracted (private) */
738 	boolean_t nomount;
739 
740 	/* Was holds flag set in the compound header? */
741 	boolean_t holds;
742 
743 	/* skip receive of snapshot holds */
744 	boolean_t skipholds;
745 } recvflags_t;
746 
747 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
748     recvflags_t *, int, avl_tree_t *);
749 
750 typedef enum diff_flags {
751 	ZFS_DIFF_PARSEABLE = 0x1,
752 	ZFS_DIFF_TIMESTAMP = 0x2,
753 	ZFS_DIFF_CLASSIFY = 0x4
754 } diff_flags_t;
755 
756 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
757     int);
758 
759 /*
760  * Miscellaneous functions.
761  */
762 extern const char *zfs_type_to_name(zfs_type_t);
763 extern void zfs_refresh_properties(zfs_handle_t *);
764 extern int zfs_name_valid(const char *, zfs_type_t);
765 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
766 extern int zfs_parent_name(zfs_handle_t *, char *, size_t);
767 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
768     zfs_type_t);
769 extern int zfs_spa_version(zfs_handle_t *, int *);
770 extern boolean_t zfs_bookmark_exists(const char *path);
771 
772 /*
773  * Mount support functions.
774  */
775 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
776 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
777 extern int zfs_mount(zfs_handle_t *, const char *, int);
778 extern int zfs_unmount(zfs_handle_t *, const char *, int);
779 extern int zfs_unmountall(zfs_handle_t *, int);
780 
781 /*
782  * Share support functions.
783  */
784 extern boolean_t zfs_is_shared(zfs_handle_t *);
785 extern int zfs_share(zfs_handle_t *);
786 extern int zfs_unshare(zfs_handle_t *);
787 
788 /*
789  * Protocol-specific share support functions.
790  */
791 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
792 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
793 extern int zfs_share_nfs(zfs_handle_t *);
794 extern int zfs_share_smb(zfs_handle_t *);
795 extern int zfs_shareall(zfs_handle_t *);
796 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
797 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
798 extern int zfs_unshareall_nfs(zfs_handle_t *);
799 extern int zfs_unshareall_smb(zfs_handle_t *);
800 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
801 extern int zfs_unshareall(zfs_handle_t *);
802 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
803     void *, void *, int, zfs_share_op_t);
804 
805 /*
806  * When dealing with nvlists, verify() is extremely useful
807  */
808 #ifdef NDEBUG
809 #define	verify(EX)	((void)(EX))
810 #else
811 #define	verify(EX)	assert(EX)
812 #endif
813 
814 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
815 
816 /*
817  * Given a device or file, determine if it is part of a pool.
818  */
819 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
820     boolean_t *);
821 
822 /*
823  * Label manipulation.
824  */
825 extern int zpool_clear_label(int);
826 extern int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *);
827 extern int zpool_get_bootenv(zpool_handle_t *, nvlist_t **);
828 
829 /* is this zvol valid for use as a dump device? */
830 extern int zvol_check_dump_config(char *);
831 
832 /*
833  * Management interfaces for SMB ACL files
834  */
835 
836 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
837 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
838 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
839 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
840 
841 /*
842  * Enable and disable datasets within a pool by mounting/unmounting and
843  * sharing/unsharing them.
844  */
845 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
846 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
847 
848 /*
849  * Mappings between vdev and FRU.
850  */
851 extern void libzfs_fru_refresh(libzfs_handle_t *);
852 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
853 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
854 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
855     const char *);
856 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
857 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
858 
859 extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *);
860 extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *);
861 
862 /* Allow consumers to initialize libshare externally for optimal performance */
863 extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *);
864 /*
865  * For most consumers, zfs_init_libshare_arg is sufficient on its own, and
866  * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called
867  * if the caller has already initialized libshare for one set of zfs handles,
868  * and wishes to share or unshare filesystems outside of that set. In that case,
869  * the caller should uninitialize libshare, and then re-initialize it with the
870  * new handles being shared or unshared.
871  */
872 extern void zfs_uninit_libshare(libzfs_handle_t *);
873 #ifdef	__cplusplus
874 }
875 #endif
876 
877 #endif	/* _LIBZFS_H */
878