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