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