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, 2017 by Delphix. All rights reserved.
26 * Copyright 2019 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
48extern "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 */
60typedef 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(1M) failed */
92	EZFS_SHARENFSFAILED,	/* share(1M) 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_UNKNOWN
150} zfs_error_t;
151
152/*
153 * UEFI boot support parameters. When creating whole disk boot pool,
154 * zpool create should allow to create EFI System partition for UEFI boot
155 * program. In case of BIOS, the EFI System partition is not used
156 * even if it does exist.
157 */
158typedef enum zpool_boot_label {
159	ZPOOL_NO_BOOT_LABEL = 0,
160	ZPOOL_CREATE_BOOT_LABEL,
161	ZPOOL_COPY_BOOT_LABEL
162} zpool_boot_label_t;
163
164/*
165 * The following data structures are all part
166 * of the zfs_allow_t data structure which is
167 * used for printing 'allow' permissions.
168 * It is a linked list of zfs_allow_t's which
169 * then contain avl tree's for user/group/sets/...
170 * and each one of the entries in those trees have
171 * avl tree's for the permissions they belong to and
172 * whether they are local,descendent or local+descendent
173 * permissions.  The AVL trees are used primarily for
174 * sorting purposes, but also so that we can quickly find
175 * a given user and or permission.
176 */
177typedef struct zfs_perm_node {
178	avl_node_t z_node;
179	char z_pname[MAXPATHLEN];
180} zfs_perm_node_t;
181
182typedef struct zfs_allow_node {
183	avl_node_t z_node;
184	char z_key[MAXPATHLEN];		/* name, such as joe */
185	avl_tree_t z_localdescend;	/* local+descendent perms */
186	avl_tree_t z_local;		/* local permissions */
187	avl_tree_t z_descend;		/* descendent permissions */
188} zfs_allow_node_t;
189
190typedef struct zfs_allow {
191	struct zfs_allow *z_next;
192	char z_setpoint[MAXPATHLEN];
193	avl_tree_t z_sets;
194	avl_tree_t z_crperms;
195	avl_tree_t z_user;
196	avl_tree_t z_group;
197	avl_tree_t z_everyone;
198} zfs_allow_t;
199
200/*
201 * Basic handle types
202 */
203typedef struct zfs_handle zfs_handle_t;
204typedef struct zpool_handle zpool_handle_t;
205typedef struct libzfs_handle libzfs_handle_t;
206
207/*
208 * Library initialization
209 */
210extern libzfs_handle_t *libzfs_init(void);
211extern void libzfs_fini(libzfs_handle_t *);
212
213extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
214extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
215
216extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
217
218extern void zfs_save_arguments(int argc, char **, char *, int);
219extern int zpool_log_history(libzfs_handle_t *, const char *);
220
221extern int libzfs_errno(libzfs_handle_t *);
222extern const char *libzfs_error_action(libzfs_handle_t *);
223extern const char *libzfs_error_description(libzfs_handle_t *);
224extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
225extern void libzfs_mnttab_init(libzfs_handle_t *);
226extern void libzfs_mnttab_fini(libzfs_handle_t *);
227extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
228extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
229    struct mnttab *);
230extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
231    const char *, const char *);
232extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
233
234/*
235 * Basic handle functions
236 */
237extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
238extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
239extern void zpool_close(zpool_handle_t *);
240extern const char *zpool_get_name(zpool_handle_t *);
241extern int zpool_get_state(zpool_handle_t *);
242extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
243extern const char *zpool_pool_state_to_name(pool_state_t);
244extern void zpool_free_handles(libzfs_handle_t *);
245
246/*
247 * Iterate over all active pools in the system.
248 */
249typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
250extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
251extern boolean_t zpool_skip_pool(const char *);
252
253/*
254 * Functions to create and destroy pools
255 */
256extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
257    nvlist_t *, nvlist_t *);
258extern int zpool_destroy(zpool_handle_t *, const char *);
259extern int zpool_add(zpool_handle_t *, nvlist_t *);
260
261typedef struct splitflags {
262	/* do not split, but return the config that would be split off */
263	int dryrun : 1;
264
265	/* after splitting, import the pool */
266	int import : 1;
267	int name_flags;
268} splitflags_t;
269
270typedef struct trimflags {
271	/* requested vdevs are for the entire pool */
272	boolean_t fullpool;
273
274	/* request a secure trim, requires support from device */
275	boolean_t secure;
276
277	/* trim at the requested rate in bytes/second */
278	uint64_t rate;
279} trimflags_t;
280
281/*
282 * Functions to manipulate pool and vdev state
283 */
284extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
285extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t,
286    nvlist_t *);
287extern int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *,
288    trimflags_t *);
289
290extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
291extern int zpool_reguid(zpool_handle_t *);
292extern int zpool_reopen(zpool_handle_t *);
293
294extern int zpool_sync_one(zpool_handle_t *, void *);
295
296extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
297    vdev_state_t *);
298extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
299extern int zpool_vdev_attach(zpool_handle_t *, const char *,
300    const char *, nvlist_t *, int);
301extern int zpool_vdev_detach(zpool_handle_t *, const char *);
302extern int zpool_vdev_remove(zpool_handle_t *, const char *);
303extern int zpool_vdev_remove_cancel(zpool_handle_t *);
304extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *);
305extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
306    splitflags_t);
307
308extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
309extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
310extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
311
312extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
313    boolean_t *, boolean_t *);
314extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
315    boolean_t *, boolean_t *, boolean_t *);
316extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *,
317    zpool_boot_label_t, uint64_t, int *);
318
319/*
320 * Functions to manage pool properties
321 */
322extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
323extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
324    size_t proplen, zprop_source_t *, boolean_t);
325extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
326    zprop_source_t *);
327
328extern const char *zpool_prop_to_name(zpool_prop_t);
329extern const char *zpool_prop_values(zpool_prop_t);
330
331/*
332 * Pool health statistics.
333 */
334typedef enum {
335	/*
336	 * The following correspond to faults as defined in the (fault.fs.zfs.*)
337	 * event namespace.  Each is associated with a corresponding message ID.
338	 * This must be kept in sync with the zfs_msgid_table in
339	 * lib/libzfs/libzfs_status.c.
340	 */
341	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */
342	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */
343	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */
344	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */
345	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */
346	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */
347	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */
348	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */
349	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */
350	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */
351	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */
352	ZPOOL_STATUS_HOSTID_ACTIVE,	/* currently active on another system */
353	ZPOOL_STATUS_HOSTID_REQUIRED,	/* multihost=on and hostid=0 */
354	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */
355	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
356	ZPOOL_STATUS_IO_FAILURE_MMP,	/* failed MMP, failmode not 'panic' */
357	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */
358	ZPOOL_STATUS_ERRATA,		/* informational errata available */
359
360	/*
361	 * If the pool has unsupported features but can still be opened in
362	 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
363	 * pool has unsupported features but cannot be opened at all, its
364	 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
365	 */
366	ZPOOL_STATUS_UNSUP_FEAT_READ,	/* unsupported features for read */
367	ZPOOL_STATUS_UNSUP_FEAT_WRITE,	/* unsupported features for write */
368
369	/*
370	 * These faults have no corresponding message ID.  At the time we are
371	 * checking the status, the original reason for the FMA fault (I/O or
372	 * checksum errors) has been lost.
373	 */
374	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */
375	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */
376
377	/*
378	 * The following are not faults per se, but still an error possibly
379	 * requiring administrative attention.  There is no corresponding
380	 * message ID.
381	 */
382	ZPOOL_STATUS_VERSION_OLDER,	/* older legacy on-disk version */
383	ZPOOL_STATUS_FEAT_DISABLED,	/* supported features are disabled */
384	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */
385	ZPOOL_STATUS_OFFLINE_DEV,	/* device offline */
386	ZPOOL_STATUS_REMOVED_DEV,	/* removed device */
387
388	/*
389	 * Finally, the following indicates a healthy pool.
390	 */
391	ZPOOL_STATUS_OK
392} zpool_status_t;
393
394extern zpool_status_t zpool_get_status(zpool_handle_t *, char **,
395    zpool_errata_t *);
396extern zpool_status_t zpool_import_status(nvlist_t *, char **,
397    zpool_errata_t *);
398extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
399
400/*
401 * Statistics and configuration functions.
402 */
403extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
404extern nvlist_t *zpool_get_features(zpool_handle_t *);
405extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
406extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
407extern boolean_t zpool_is_bootable(zpool_handle_t *);
408
409/*
410 * Import and export functions
411 */
412extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
413extern int zpool_export_force(zpool_handle_t *, const char *);
414extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
415    char *altroot);
416extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
417    nvlist_t *, int);
418extern void zpool_print_unsup_feat(nvlist_t *config);
419
420/*
421 * Search for pools to import
422 */
423
424typedef struct importargs {
425	char **path;		/* a list of paths to search		*/
426	int paths;		/* number of paths to search		*/
427	char *poolname;		/* name of a pool to find		*/
428	uint64_t guid;		/* guid of a pool to find		*/
429	char *cachefile;	/* cachefile to use for import		*/
430	int can_be_active : 1;	/* can the pool be active?		*/
431	int unique : 1;		/* does 'poolname' already exist?	*/
432	int exists : 1;		/* set on return if pool already exists	*/
433	nvlist_t *policy;	/* load policy (max txg, rewind, etc.)	*/
434} importargs_t;
435
436extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
437extern int zpool_tryimport(libzfs_handle_t *hdl, char *target,
438    nvlist_t **configp, importargs_t *args);
439
440/* legacy pool search routines */
441extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
442extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
443    char *, uint64_t);
444
445/*
446 * Miscellaneous pool functions
447 */
448struct zfs_cmd;
449
450extern const char *zfs_history_event_names[];
451
452typedef enum {
453	VDEV_NAME_PATH		= 1 << 0,
454	VDEV_NAME_GUID		= 1 << 1,
455	VDEV_NAME_FOLLOW_LINKS	= 1 << 2,
456	VDEV_NAME_TYPE_ID	= 1 << 3,
457} vdev_name_t;
458
459extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
460    int name_flags);
461extern int zpool_upgrade(zpool_handle_t *, uint64_t);
462extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
463extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
464    nvlist_t ***, uint_t *);
465extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
466    size_t len);
467extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
468extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
469extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
470    nvlist_t *);
471extern int zpool_checkpoint(zpool_handle_t *);
472extern int zpool_discard_checkpoint(zpool_handle_t *);
473
474/*
475 * Basic handle manipulations.  These functions do not create or destroy the
476 * underlying datasets, only the references to them.
477 */
478extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
479extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
480extern void zfs_close(zfs_handle_t *);
481extern zfs_type_t zfs_get_type(const zfs_handle_t *);
482extern const char *zfs_get_name(const zfs_handle_t *);
483extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
484extern const char *zfs_get_pool_name(const zfs_handle_t *);
485
486/*
487 * Property management functions.  Some functions are shared with the kernel,
488 * and are found in sys/fs/zfs.h.
489 */
490
491/*
492 * zfs dataset property management
493 */
494extern const char *zfs_prop_default_string(zfs_prop_t);
495extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
496extern const char *zfs_prop_column_name(zfs_prop_t);
497extern boolean_t zfs_prop_align_right(zfs_prop_t);
498
499extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *,
500    uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *);
501
502extern const char *zfs_prop_to_name(zfs_prop_t);
503extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
504extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
505extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
506    zprop_source_t *, char *, size_t, boolean_t);
507extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
508    boolean_t);
509extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
510    zprop_source_t *, char *, size_t);
511extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
512    uint64_t *propvalue);
513extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
514    char *propbuf, int proplen, boolean_t literal);
515extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
516    uint64_t *propvalue);
517extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
518    char *propbuf, int proplen, boolean_t literal);
519extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
520    char *buf, size_t len);
521extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
522extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
523extern const char *zfs_prop_values(zfs_prop_t);
524extern int zfs_prop_is_string(zfs_prop_t prop);
525extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
526extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
527extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
528
529
530/*
531 * zfs encryption management
532 */
533extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *);
534extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *,
535    boolean_t stdin_available, uint8_t **, uint_t *);
536extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *,
537    nvlist_t *);
538extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *);
539extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *);
540extern int zfs_crypto_unload_key(zfs_handle_t *);
541extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t);
542
543typedef struct zprop_list {
544	int		pl_prop;
545	char		*pl_user_prop;
546	struct zprop_list *pl_next;
547	boolean_t	pl_all;
548	size_t		pl_width;
549	size_t		pl_recvd_width;
550	boolean_t	pl_fixed;
551} zprop_list_t;
552
553extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
554    boolean_t);
555extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
556
557#define	ZFS_MOUNTPOINT_NONE	"none"
558#define	ZFS_MOUNTPOINT_LEGACY	"legacy"
559
560#define	ZFS_FEATURE_DISABLED	"disabled"
561#define	ZFS_FEATURE_ENABLED	"enabled"
562#define	ZFS_FEATURE_ACTIVE	"active"
563
564#define	ZFS_UNSUPPORTED_INACTIVE	"inactive"
565#define	ZFS_UNSUPPORTED_READONLY	"readonly"
566
567/*
568 * zpool property management
569 */
570extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
571extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
572    size_t);
573extern const char *zpool_prop_default_string(zpool_prop_t);
574extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
575extern const char *zpool_prop_column_name(zpool_prop_t);
576extern boolean_t zpool_prop_align_right(zpool_prop_t);
577
578/*
579 * Functions shared by zfs and zpool property management.
580 */
581extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
582    boolean_t ordered, zfs_type_t type);
583extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
584    zfs_type_t);
585extern void zprop_free_list(zprop_list_t *);
586
587#define	ZFS_GET_NCOLS	5
588
589typedef enum {
590	GET_COL_NONE,
591	GET_COL_NAME,
592	GET_COL_PROPERTY,
593	GET_COL_VALUE,
594	GET_COL_RECVD,
595	GET_COL_SOURCE
596} zfs_get_column_t;
597
598/*
599 * Functions for printing zfs or zpool properties
600 */
601typedef struct zprop_get_cbdata {
602	int cb_sources;
603	zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
604	int cb_colwidths[ZFS_GET_NCOLS + 1];
605	boolean_t cb_scripted;
606	boolean_t cb_literal;
607	boolean_t cb_first;
608	zprop_list_t *cb_proplist;
609	zfs_type_t cb_type;
610} zprop_get_cbdata_t;
611
612void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
613    const char *, const char *, zprop_source_t, const char *,
614    const char *);
615
616/*
617 * Iterator functions.
618 */
619typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
620extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
621extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
622extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
623extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
624extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
625extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
626extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
627extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
628
629typedef struct get_all_cb {
630	zfs_handle_t	**cb_handles;
631	size_t		cb_alloc;
632	size_t		cb_used;
633} get_all_cb_t;
634
635void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t,
636    zfs_iter_f, void *, boolean_t);
637void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
638
639/*
640 * Functions to create and destroy datasets.
641 */
642extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
643    nvlist_t *);
644extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
645extern int zfs_destroy(zfs_handle_t *, boolean_t);
646extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
647extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
648extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
649extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
650extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
651    nvlist_t *props);
652extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
653extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
654
655typedef struct sendflags {
656	/* print informational messages (ie, -v was specified) */
657	boolean_t verbose;
658
659	/* recursive send  (ie, -R) */
660	boolean_t replicate;
661
662	/* for incrementals, do all intermediate snapshots */
663	boolean_t doall;
664
665	/* if dataset is a clone, do incremental from its origin */
666	boolean_t fromorigin;
667
668	/* do deduplication */
669	boolean_t dedup;
670
671	/* send properties (ie, -p) */
672	boolean_t props;
673
674	/* do not send (no-op, ie. -n) */
675	boolean_t dryrun;
676
677	/* parsable verbose output (ie. -P) */
678	boolean_t parsable;
679
680	/* show progress (ie. -v) */
681	boolean_t progress;
682
683	/* large blocks (>128K) are permitted */
684	boolean_t largeblock;
685
686	/* WRITE_EMBEDDED records of type DATA are permitted */
687	boolean_t embed_data;
688
689	/* compressed WRITE records are permitted */
690	boolean_t compress;
691
692	/* raw encrypted records are permitted */
693	boolean_t raw;
694
695	/* only send received properties (ie. -b) */
696	boolean_t backup;
697
698	/* include snapshot holds in send stream */
699	boolean_t holds;
700} sendflags_t;
701
702typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
703
704extern int zfs_send(zfs_handle_t *, const char *, const char *,
705    sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
706extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
707extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
708    const char *);
709extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
710    const char *token);
711
712extern int zfs_promote(zfs_handle_t *);
713extern int zfs_hold(zfs_handle_t *, const char *, const char *,
714    boolean_t, int);
715extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
716extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
717extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
718extern uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t,
719    nvlist_t *);
720
721typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
722    uid_t rid, uint64_t space);
723
724extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
725    zfs_userspace_cb_t, void *);
726
727extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
728extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
729
730typedef struct recvflags {
731	/* print informational messages (ie, -v was specified) */
732	boolean_t verbose;
733
734	/* the destination is a prefix, not the exact fs (ie, -d) */
735	boolean_t isprefix;
736
737	/*
738	 * Only the tail of the sent snapshot path is appended to the
739	 * destination to determine the received snapshot name (ie, -e).
740	 */
741	boolean_t istail;
742
743	/* do not actually do the recv, just check if it would work (ie, -n) */
744	boolean_t dryrun;
745
746	/* rollback/destroy filesystems as necessary (eg, -F) */
747	boolean_t force;
748
749	/* set "canmount=off" on all modified filesystems */
750	boolean_t canmountoff;
751
752	/*
753	 * Mark the file systems as "resumable" and do not destroy them if the
754	 * receive is interrupted
755	 */
756	boolean_t resumable;
757
758	/* byteswap flag is used internally; callers need not specify */
759	boolean_t byteswap;
760
761	/* do not mount file systems as they are extracted (private) */
762	boolean_t nomount;
763
764	/* Was holds flag set in the compound header? */
765	boolean_t holds;
766
767	/* skip receive of snapshot holds */
768	boolean_t skipholds;
769} recvflags_t;
770
771extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
772    recvflags_t *, int, avl_tree_t *);
773
774typedef enum diff_flags {
775	ZFS_DIFF_PARSEABLE = 0x1,
776	ZFS_DIFF_TIMESTAMP = 0x2,
777	ZFS_DIFF_CLASSIFY = 0x4
778} diff_flags_t;
779
780extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
781    int);
782
783/*
784 * Miscellaneous functions.
785 */
786extern const char *zfs_type_to_name(zfs_type_t);
787extern void zfs_refresh_properties(zfs_handle_t *);
788extern int zfs_name_valid(const char *, zfs_type_t);
789extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
790extern int zfs_parent_name(zfs_handle_t *, char *, size_t);
791extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
792    zfs_type_t);
793extern int zfs_spa_version(zfs_handle_t *, int *);
794extern boolean_t zfs_bookmark_exists(const char *path);
795extern ulong_t get_system_hostid(void);
796
797/*
798 * Mount support functions.
799 */
800extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
801extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
802extern int zfs_mount(zfs_handle_t *, const char *, int);
803extern int zfs_unmount(zfs_handle_t *, const char *, int);
804extern int zfs_unmountall(zfs_handle_t *, int);
805
806/*
807 * Share support functions.
808 */
809extern boolean_t zfs_is_shared(zfs_handle_t *);
810extern int zfs_share(zfs_handle_t *);
811extern int zfs_unshare(zfs_handle_t *);
812
813/*
814 * Protocol-specific share support functions.
815 */
816extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
817extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
818extern int zfs_share_nfs(zfs_handle_t *);
819extern int zfs_share_smb(zfs_handle_t *);
820extern int zfs_shareall(zfs_handle_t *);
821extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
822extern int zfs_unshare_smb(zfs_handle_t *, const char *);
823extern int zfs_unshareall_nfs(zfs_handle_t *);
824extern int zfs_unshareall_smb(zfs_handle_t *);
825extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
826extern int zfs_unshareall(zfs_handle_t *);
827extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
828    void *, void *, int, zfs_share_op_t);
829
830/*
831 * When dealing with nvlists, verify() is extremely useful
832 */
833#ifdef NDEBUG
834#define	verify(EX)	((void)(EX))
835#else
836#define	verify(EX)	assert(EX)
837#endif
838
839/*
840 * Utility function to convert a number to a human-readable form.
841 */
842extern void zfs_nicenum(uint64_t, char *, size_t);
843extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
844
845/*
846 * Given a device or file, determine if it is part of a pool.
847 */
848extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
849    boolean_t *);
850
851/*
852 * Label manipulation.
853 */
854extern int zpool_read_label(int, nvlist_t **);
855extern int zpool_clear_label(int);
856
857/* is this zvol valid for use as a dump device? */
858extern int zvol_check_dump_config(char *);
859
860/*
861 * Management interfaces for SMB ACL files
862 */
863
864int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
865int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
866int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
867int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
868
869/*
870 * Enable and disable datasets within a pool by mounting/unmounting and
871 * sharing/unsharing them.
872 */
873extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
874extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
875
876/*
877 * Mappings between vdev and FRU.
878 */
879extern void libzfs_fru_refresh(libzfs_handle_t *);
880extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
881extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
882extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
883    const char *);
884extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
885extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
886
887extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *);
888extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *);
889
890/* Allow consumers to initialize libshare externally for optimal performance */
891extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *);
892/*
893 * For most consumers, zfs_init_libshare_arg is sufficient on its own, and
894 * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called
895 * if the caller has already initialized libshare for one set of zfs handles,
896 * and wishes to share or unshare filesystems outside of that set. In that case,
897 * the caller should uninitialize libshare, and then re-initialize it with the
898 * new handles being shared or unshared.
899 */
900extern void zfs_uninit_libshare(libzfs_handle_t *);
901#ifdef	__cplusplus
902}
903#endif
904
905#endif	/* _LIBZFS_H */
906