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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011 Pawel Jakub Dawidek <pawel@dawidek.net>.
25 * All rights reserved.
26 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
27 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
28 * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
29 * Copyright (c) 2013 Steven Hartland. All rights reserved.
30 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
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>
44 #include <sys/zfs_ioctl.h>
45 #include <libzfs_core.h>
52 * Miscellaneous ZFS constants
54 #define ZFS_MAXNAMELEN MAXNAMELEN
55 #define ZPOOL_MAXNAMELEN MAXNAMELEN
56 #define ZFS_MAXPROPLEN MAXPATHLEN
57 #define ZPOOL_MAXPROPLEN MAXPATHLEN
62 typedef enum zfs_error {
63 EZFS_SUCCESS = 0, /* no error -- success */
64 EZFS_NOMEM = 2000, /* out of memory */
65 EZFS_BADPROP, /* invalid property value */
66 EZFS_PROPREADONLY, /* cannot set readonly property */
67 EZFS_PROPTYPE, /* property does not apply to dataset type */
68 EZFS_PROPNONINHERIT, /* property is not inheritable */
69 EZFS_PROPSPACE, /* bad quota or reservation */
70 EZFS_BADTYPE, /* dataset is not of appropriate type */
71 EZFS_BUSY, /* pool or dataset is busy */
72 EZFS_EXISTS, /* pool or dataset already exists */
73 EZFS_NOENT, /* no such pool or dataset */
74 EZFS_BADSTREAM, /* bad backup stream */
75 EZFS_DSREADONLY, /* dataset is readonly */
76 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
77 EZFS_INVALIDNAME, /* invalid dataset name */
78 EZFS_BADRESTORE, /* unable to restore to destination */
79 EZFS_BADBACKUP, /* backup failed */
80 EZFS_BADTARGET, /* bad attach/detach/replace target */
81 EZFS_NODEVICE, /* no such device in pool */
82 EZFS_BADDEV, /* invalid device to add */
83 EZFS_NOREPLICAS, /* no valid replicas */
84 EZFS_RESILVERING, /* currently resilvering */
85 EZFS_BADVERSION, /* unsupported version */
86 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
87 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
88 EZFS_BADPATH, /* must be an absolute path */
89 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
90 EZFS_ZONED, /* used improperly in local zone */
91 EZFS_MOUNTFAILED, /* failed to mount dataset */
92 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
93 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
94 EZFS_SHARENFSFAILED, /* share(1M) failed */
95 EZFS_PERM, /* permission denied */
96 EZFS_NOSPC, /* out of space */
97 EZFS_FAULT, /* bad address */
98 EZFS_IO, /* I/O error */
99 EZFS_INTR, /* signal received */
100 EZFS_ISSPARE, /* device is a hot spare */
101 EZFS_INVALCONFIG, /* invalid vdev configuration */
102 EZFS_RECURSIVE, /* recursive dependency */
103 EZFS_NOHISTORY, /* no history object */
104 EZFS_POOLPROPS, /* couldn't retrieve pool props */
105 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
106 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
107 EZFS_NAMETOOLONG, /* dataset name is too long */
108 EZFS_OPENFAILED, /* open of device failed */
109 EZFS_NOCAP, /* couldn't get capacity */
110 EZFS_LABELFAILED, /* write of label failed */
111 EZFS_BADWHO, /* invalid permission who */
112 EZFS_BADPERM, /* invalid permission */
113 EZFS_BADPERMSET, /* invalid permission set name */
114 EZFS_NODELEGATION, /* delegated administration is disabled */
115 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
116 EZFS_SHARESMBFAILED, /* failed to share over smb */
117 EZFS_BADCACHE, /* bad cache file */
118 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
119 EZFS_VDEVNOTSUP, /* unsupported vdev type */
120 EZFS_NOTSUP, /* ops not supported on this dataset */
121 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
122 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
123 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
124 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
125 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
126 EZFS_PIPEFAILED, /* pipe create failed */
127 EZFS_THREADCREATEFAILED, /* thread create failed */
128 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
129 EZFS_SCRUBBING, /* currently scrubbing */
130 EZFS_NO_SCRUB, /* no active scrub */
131 EZFS_DIFF, /* general failure of zfs diff */
132 EZFS_DIFFDATA, /* bad zfs diff data */
133 EZFS_POOLREADONLY, /* pool is in read-only mode */
138 * The following data structures are all part
139 * of the zfs_allow_t data structure which is
140 * used for printing 'allow' permissions.
141 * It is a linked list of zfs_allow_t's which
142 * then contain avl tree's for user/group/sets/...
143 * and each one of the entries in those trees have
144 * avl tree's for the permissions they belong to and
145 * whether they are local,descendent or local+descendent
146 * permissions. The AVL trees are used primarily for
147 * sorting purposes, but also so that we can quickly find
148 * a given user and or permission.
150 typedef struct zfs_perm_node {
152 char z_pname[MAXPATHLEN];
155 typedef struct zfs_allow_node {
157 char z_key[MAXPATHLEN]; /* name, such as joe */
158 avl_tree_t z_localdescend; /* local+descendent perms */
159 avl_tree_t z_local; /* local permissions */
160 avl_tree_t z_descend; /* descendent permissions */
163 typedef struct zfs_allow {
164 struct zfs_allow *z_next;
165 char z_setpoint[MAXPATHLEN];
167 avl_tree_t z_crperms;
170 avl_tree_t z_everyone;
176 typedef struct zfs_handle zfs_handle_t;
177 typedef struct zpool_handle zpool_handle_t;
178 typedef struct libzfs_handle libzfs_handle_t;
181 * Library initialization
183 extern libzfs_handle_t *libzfs_init(void);
184 extern void libzfs_fini(libzfs_handle_t *);
186 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
187 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
189 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
191 extern void zfs_save_arguments(int argc, char **, char *, int);
192 extern int zpool_log_history(libzfs_handle_t *, const char *);
194 extern int libzfs_errno(libzfs_handle_t *);
195 extern const char *libzfs_error_action(libzfs_handle_t *);
196 extern const char *libzfs_error_description(libzfs_handle_t *);
197 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
198 extern void libzfs_mnttab_init(libzfs_handle_t *);
199 extern void libzfs_mnttab_fini(libzfs_handle_t *);
200 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
201 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
203 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
204 const char *, const char *);
205 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
208 * Basic handle functions
210 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
211 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
212 extern void zpool_close(zpool_handle_t *);
213 extern const char *zpool_get_name(zpool_handle_t *);
214 extern int zpool_get_state(zpool_handle_t *);
215 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
216 extern const char *zpool_pool_state_to_name(pool_state_t);
217 extern void zpool_free_handles(libzfs_handle_t *);
220 * Iterate over all active pools in the system.
222 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
223 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
226 * Functions to create and destroy pools
228 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
229 nvlist_t *, nvlist_t *);
230 extern int zpool_destroy(zpool_handle_t *, const char *);
231 extern int zpool_add(zpool_handle_t *, nvlist_t *);
233 typedef struct splitflags {
234 /* do not split, but return the config that would be split off */
237 /* after splitting, import the pool */
242 * Functions to manipulate pool and vdev state
244 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
245 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
246 extern int zpool_reguid(zpool_handle_t *);
247 extern int zpool_reopen(zpool_handle_t *);
249 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
251 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
252 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
253 const char *, nvlist_t *, int);
254 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
255 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
256 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
259 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
260 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
261 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
263 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
264 boolean_t *, boolean_t *);
265 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
266 boolean_t *, boolean_t *, boolean_t *);
267 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *);
270 * Functions to manage pool properties
272 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
273 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
274 size_t proplen, zprop_source_t *, boolean_t);
275 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
278 extern const char *zpool_prop_to_name(zpool_prop_t);
279 extern const char *zpool_prop_values(zpool_prop_t);
282 * Pool health statistics.
286 * The following correspond to faults as defined in the (fault.fs.zfs.*)
287 * event namespace. Each is associated with a corresponding message ID.
289 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
290 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
291 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
292 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
293 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
294 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
295 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
296 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
297 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
298 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
299 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
300 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
301 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
302 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
305 * If the pool has unsupported features but can still be opened in
306 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
307 * pool has unsupported features but cannot be opened at all, its
308 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
310 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
311 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
314 * These faults have no corresponding message ID. At the time we are
315 * checking the status, the original reason for the FMA fault (I/O or
316 * checksum errors) has been lost.
318 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
319 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
322 * The following are not faults per se, but still an error possibly
323 * requiring administrative attention. There is no corresponding
326 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
327 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
328 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
329 ZPOOL_STATUS_OFFLINE_DEV, /* device online */
330 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
331 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
334 * Finally, the following indicates a healthy pool.
339 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
340 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
341 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
344 * Statistics and configuration functions.
346 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
347 extern nvlist_t *zpool_get_features(zpool_handle_t *);
348 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
349 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
352 * Import and export functions
354 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
355 extern int zpool_export_force(zpool_handle_t *, const char *);
356 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
358 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
360 extern void zpool_print_unsup_feat(nvlist_t *config);
363 * Search for pools to import
366 typedef struct importargs {
367 char **path; /* a list of paths to search */
368 int paths; /* number of paths to search */
369 char *poolname; /* name of a pool to find */
370 uint64_t guid; /* guid of a pool to find */
371 char *cachefile; /* cachefile to use for import */
372 int can_be_active : 1; /* can the pool be active? */
373 int unique : 1; /* does 'poolname' already exist? */
374 int exists : 1; /* set on return if pool already exists */
377 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
379 /* legacy pool search routines */
380 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
381 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
385 * Miscellaneous pool functions
389 extern const char *zfs_history_event_names[];
391 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
393 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
394 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
395 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
396 nvlist_t ***, uint_t *);
397 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
399 extern int zfs_ioctl(libzfs_handle_t *, int request, struct zfs_cmd *);
400 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
401 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
405 * Basic handle manipulations. These functions do not create or destroy the
406 * underlying datasets, only the references to them.
408 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
409 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
410 extern void zfs_close(zfs_handle_t *);
411 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
412 extern const char *zfs_get_name(const zfs_handle_t *);
413 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
416 * Property management functions. Some functions are shared with the kernel,
417 * and are found in sys/fs/zfs.h.
421 * zfs dataset property management
423 extern const char *zfs_prop_default_string(zfs_prop_t);
424 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
425 extern const char *zfs_prop_column_name(zfs_prop_t);
426 extern boolean_t zfs_prop_align_right(zfs_prop_t);
428 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
429 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
431 extern const char *zfs_prop_to_name(zfs_prop_t);
432 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
433 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
434 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
435 zprop_source_t *, char *, size_t, boolean_t);
436 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
438 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
439 zprop_source_t *, char *, size_t);
440 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
441 uint64_t *propvalue);
442 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
443 char *propbuf, int proplen, boolean_t literal);
444 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
445 uint64_t *propvalue);
446 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
447 char *propbuf, int proplen, boolean_t literal);
448 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
449 char *buf, size_t len);
450 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
451 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
452 extern const char *zfs_prop_values(zfs_prop_t);
453 extern int zfs_prop_is_string(zfs_prop_t prop);
454 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
455 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
456 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
459 typedef struct zprop_list {
462 struct zprop_list *pl_next;
465 size_t pl_recvd_width;
469 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
471 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
473 #define ZFS_MOUNTPOINT_NONE "none"
474 #define ZFS_MOUNTPOINT_LEGACY "legacy"
476 #define ZFS_FEATURE_DISABLED "disabled"
477 #define ZFS_FEATURE_ENABLED "enabled"
478 #define ZFS_FEATURE_ACTIVE "active"
480 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
481 #define ZFS_UNSUPPORTED_READONLY "readonly"
484 * zpool property management
486 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
487 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
489 extern const char *zpool_prop_default_string(zpool_prop_t);
490 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
491 extern const char *zpool_prop_column_name(zpool_prop_t);
492 extern boolean_t zpool_prop_align_right(zpool_prop_t);
495 * Functions shared by zfs and zpool property management.
497 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
498 boolean_t ordered, zfs_type_t type);
499 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
501 extern void zprop_free_list(zprop_list_t *);
503 #define ZFS_GET_NCOLS 5
515 * Functions for printing zfs or zpool properties
517 typedef struct zprop_get_cbdata {
519 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
520 int cb_colwidths[ZFS_GET_NCOLS + 1];
521 boolean_t cb_scripted;
522 boolean_t cb_literal;
524 zprop_list_t *cb_proplist;
526 } zprop_get_cbdata_t;
528 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
529 const char *, const char *, zprop_source_t, const char *,
533 * Iterator functions.
535 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
536 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
537 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
538 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
539 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
540 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
541 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
542 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
543 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
545 typedef struct get_all_cb {
546 zfs_handle_t **cb_handles;
549 boolean_t cb_verbose;
550 int (*cb_getone)(zfs_handle_t *, void *);
553 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
554 int libzfs_dataset_cmp(const void *, const void *);
557 * Functions to create and destroy datasets.
559 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
561 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
562 extern int zfs_destroy(zfs_handle_t *, boolean_t);
563 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
564 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
565 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
566 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
567 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
569 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
571 typedef struct renameflags {
572 /* recursive rename */
575 /* don't unmount file systems */
578 /* force unmount file systems */
579 int forceunmount : 1;
582 extern int zfs_rename(zfs_handle_t *, const char *, const char *,
583 renameflags_t flags);
585 typedef struct sendflags {
586 /* print informational messages (ie, -v was specified) */
589 /* recursive send (ie, -R) */
592 /* for incrementals, do all intermediate snapshots */
595 /* if dataset is a clone, do incremental from its origin */
596 boolean_t fromorigin;
598 /* do deduplication */
601 /* send properties (ie, -p) */
604 /* do not send (no-op, ie. -n) */
607 /* parsable verbose output (ie. -P) */
610 /* show progress (ie. -v) */
613 /* large blocks (>128K) are permitted */
614 boolean_t largeblock;
616 /* WRITE_EMBEDDED records of type DATA are permitted */
617 boolean_t embed_data;
620 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
622 extern int zfs_send(zfs_handle_t *, const char *, const char *,
623 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
624 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
625 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
627 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
630 extern int zfs_promote(zfs_handle_t *);
631 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
633 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
634 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
635 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
636 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
638 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
639 uid_t rid, uint64_t space);
641 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
642 zfs_userspace_cb_t, void *);
644 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
645 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
647 typedef struct recvflags {
648 /* print informational messages (ie, -v was specified) */
651 /* the destination is a prefix, not the exact fs (ie, -d) */
655 * Only the tail of the sent snapshot path is appended to the
656 * destination to determine the received snapshot name (ie, -e).
660 /* do not actually do the recv, just check if it would work (ie, -n) */
663 /* rollback/destroy filesystems as necessary (eg, -F) */
666 /* set "canmount=off" on all modified filesystems */
667 boolean_t canmountoff;
670 * Mark the file systems as "resumable" and do not destroy them if the
671 * receive is interrupted
675 /* byteswap flag is used internally; callers need not specify */
678 /* do not mount file systems as they are extracted (private) */
682 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
683 recvflags_t *, int, avl_tree_t *);
685 typedef enum diff_flags {
686 ZFS_DIFF_PARSEABLE = 0x1,
687 ZFS_DIFF_TIMESTAMP = 0x2,
688 ZFS_DIFF_CLASSIFY = 0x4
691 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
695 * Miscellaneous functions.
697 extern const char *zfs_type_to_name(zfs_type_t);
698 extern void zfs_refresh_properties(zfs_handle_t *);
699 extern int zfs_name_valid(const char *, zfs_type_t);
700 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
701 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
703 extern int zfs_spa_version(zfs_handle_t *, int *);
704 extern boolean_t zfs_bookmark_exists(const char *path);
707 * Mount support functions.
709 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
710 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
711 extern int zfs_mount(zfs_handle_t *, const char *, int);
712 extern int zfs_unmount(zfs_handle_t *, const char *, int);
713 extern int zfs_unmountall(zfs_handle_t *, int);
716 * Share support functions.
718 extern boolean_t zfs_is_shared(zfs_handle_t *);
719 extern int zfs_share(zfs_handle_t *);
720 extern int zfs_unshare(zfs_handle_t *);
723 * Protocol-specific share support functions.
725 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
726 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
727 extern int zfs_share_nfs(zfs_handle_t *);
728 extern int zfs_share_smb(zfs_handle_t *);
729 extern int zfs_shareall(zfs_handle_t *);
730 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
731 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
732 extern int zfs_unshareall_nfs(zfs_handle_t *);
733 extern int zfs_unshareall_smb(zfs_handle_t *);
734 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
735 extern int zfs_unshareall(zfs_handle_t *);
736 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
737 void *, void *, int, zfs_share_op_t);
740 * FreeBSD-specific jail support function.
742 extern int zfs_jail(zfs_handle_t *, int, int);
745 * When dealing with nvlists, verify() is extremely useful
749 #define verify(EX) ((void)(EX))
751 #define verify(EX) assert(EX)
756 * Utility function to convert a number to a human-readable form.
758 extern void zfs_nicenum(uint64_t, char *, size_t);
759 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
762 * Given a device or file, determine if it is part of a pool.
764 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
768 * Label manipulation.
770 extern int zpool_read_label(int, nvlist_t **);
771 extern int zpool_clear_label(int);
773 /* is this zvol valid for use as a dump device? */
774 extern int zvol_check_dump_config(char *);
777 * Management interfaces for SMB ACL files
780 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
781 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
782 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
783 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
786 * Enable and disable datasets within a pool by mounting/unmounting and
787 * sharing/unsharing them.
789 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
790 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
793 * Mappings between vdev and FRU.
795 extern void libzfs_fru_refresh(libzfs_handle_t *);
796 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
797 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
798 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
800 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
801 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
804 extern int zmount(const char *, const char *, int, char *, char *, int, char *,
812 #endif /* _LIBZFS_H */