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 2010 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2011 Pawel Jakub Dawidek <pawel@dawidek.net>.
26 * All rights reserved.
33 #include <libnvpair.h>
34 #include <sys/mnttab.h>
35 #include <sys/param.h>
36 #include <sys/types.h>
37 #include <sys/varargs.h>
38 #include <sys/fs/zfs.h>
40 #include <sys/zfs_ioctl.h>
47 * Miscellaneous ZFS constants
49 #define ZFS_MAXNAMELEN MAXNAMELEN
50 #define ZPOOL_MAXNAMELEN MAXNAMELEN
51 #define ZFS_MAXPROPLEN MAXPATHLEN
52 #define ZPOOL_MAXPROPLEN MAXPATHLEN
58 EZFS_NOMEM = 2000, /* out of memory */
59 EZFS_BADPROP, /* invalid property value */
60 EZFS_PROPREADONLY, /* cannot set readonly property */
61 EZFS_PROPTYPE, /* property does not apply to dataset type */
62 EZFS_PROPNONINHERIT, /* property is not inheritable */
63 EZFS_PROPSPACE, /* bad quota or reservation */
64 EZFS_BADTYPE, /* dataset is not of appropriate type */
65 EZFS_BUSY, /* pool or dataset is busy */
66 EZFS_EXISTS, /* pool or dataset already exists */
67 EZFS_NOENT, /* no such pool or dataset */
68 EZFS_BADSTREAM, /* bad backup stream */
69 EZFS_DSREADONLY, /* dataset is readonly */
70 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
71 EZFS_INVALIDNAME, /* invalid dataset name */
72 EZFS_BADRESTORE, /* unable to restore to destination */
73 EZFS_BADBACKUP, /* backup failed */
74 EZFS_BADTARGET, /* bad attach/detach/replace target */
75 EZFS_NODEVICE, /* no such device in pool */
76 EZFS_BADDEV, /* invalid device to add */
77 EZFS_NOREPLICAS, /* no valid replicas */
78 EZFS_RESILVERING, /* currently resilvering */
79 EZFS_BADVERSION, /* unsupported version */
80 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
81 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
82 EZFS_BADPATH, /* must be an absolute path */
83 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
84 EZFS_ZONED, /* used improperly in local zone */
85 EZFS_MOUNTFAILED, /* failed to mount dataset */
86 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
87 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
88 EZFS_SHARENFSFAILED, /* share(1M) failed */
89 EZFS_PERM, /* permission denied */
90 EZFS_NOSPC, /* out of space */
91 EZFS_FAULT, /* bad address */
92 EZFS_IO, /* I/O error */
93 EZFS_INTR, /* signal received */
94 EZFS_ISSPARE, /* device is a hot spare */
95 EZFS_INVALCONFIG, /* invalid vdev configuration */
96 EZFS_RECURSIVE, /* recursive dependency */
97 EZFS_NOHISTORY, /* no history object */
98 EZFS_POOLPROPS, /* couldn't retrieve pool props */
99 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
100 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
101 EZFS_NAMETOOLONG, /* dataset name is too long */
102 EZFS_OPENFAILED, /* open of device failed */
103 EZFS_NOCAP, /* couldn't get capacity */
104 EZFS_LABELFAILED, /* write of label failed */
105 EZFS_BADWHO, /* invalid permission who */
106 EZFS_BADPERM, /* invalid permission */
107 EZFS_BADPERMSET, /* invalid permission set name */
108 EZFS_NODELEGATION, /* delegated administration is disabled */
109 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
110 EZFS_SHARESMBFAILED, /* failed to share over smb */
111 EZFS_BADCACHE, /* bad cache file */
112 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
113 EZFS_VDEVNOTSUP, /* unsupported vdev type */
114 EZFS_NOTSUP, /* ops not supported on this dataset */
115 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
116 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
117 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
118 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
119 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
120 EZFS_PIPEFAILED, /* pipe create failed */
121 EZFS_THREADCREATEFAILED, /* thread create failed */
122 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
123 EZFS_SCRUBBING, /* currently scrubbing */
124 EZFS_NO_SCRUB, /* no active scrub */
125 EZFS_DIFF, /* general failure of zfs diff */
126 EZFS_DIFFDATA, /* bad zfs diff data */
127 EZFS_POOLREADONLY, /* pool is in read-only mode */
132 * The following data structures are all part
133 * of the zfs_allow_t data structure which is
134 * used for printing 'allow' permissions.
135 * It is a linked list of zfs_allow_t's which
136 * then contain avl tree's for user/group/sets/...
137 * and each one of the entries in those trees have
138 * avl tree's for the permissions they belong to and
139 * whether they are local,descendent or local+descendent
140 * permissions. The AVL trees are used primarily for
141 * sorting purposes, but also so that we can quickly find
142 * a given user and or permission.
144 typedef struct zfs_perm_node {
146 char z_pname[MAXPATHLEN];
149 typedef struct zfs_allow_node {
151 char z_key[MAXPATHLEN]; /* name, such as joe */
152 avl_tree_t z_localdescend; /* local+descendent perms */
153 avl_tree_t z_local; /* local permissions */
154 avl_tree_t z_descend; /* descendent permissions */
157 typedef struct zfs_allow {
158 struct zfs_allow *z_next;
159 char z_setpoint[MAXPATHLEN];
161 avl_tree_t z_crperms;
164 avl_tree_t z_everyone;
170 typedef struct zfs_handle zfs_handle_t;
171 typedef struct zpool_handle zpool_handle_t;
172 typedef struct libzfs_handle libzfs_handle_t;
175 * Library initialization
177 extern libzfs_handle_t *libzfs_init(void);
178 extern void libzfs_fini(libzfs_handle_t *);
180 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
181 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
183 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
185 extern int libzfs_errno(libzfs_handle_t *);
186 extern const char *libzfs_error_action(libzfs_handle_t *);
187 extern const char *libzfs_error_description(libzfs_handle_t *);
188 extern void libzfs_mnttab_init(libzfs_handle_t *);
189 extern void libzfs_mnttab_fini(libzfs_handle_t *);
190 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
191 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
193 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
194 const char *, const char *);
195 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
198 * Basic handle functions
200 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
201 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
202 extern void zpool_close(zpool_handle_t *);
203 extern const char *zpool_get_name(zpool_handle_t *);
204 extern int zpool_get_state(zpool_handle_t *);
205 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
206 extern const char *zpool_pool_state_to_name(pool_state_t);
207 extern void zpool_free_handles(libzfs_handle_t *);
210 * Iterate over all active pools in the system.
212 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
213 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
216 * Functions to create and destroy pools
218 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
219 nvlist_t *, nvlist_t *);
220 extern int zpool_destroy(zpool_handle_t *);
221 extern int zpool_add(zpool_handle_t *, nvlist_t *);
223 typedef struct splitflags {
224 /* do not split, but return the config that would be split off */
227 /* after splitting, import the pool */
232 * Functions to manipulate pool and vdev state
234 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
235 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
237 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
239 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
240 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
241 const char *, nvlist_t *, int);
242 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
243 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
244 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
247 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
248 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
249 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
251 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
252 boolean_t *, boolean_t *);
253 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
254 boolean_t *, boolean_t *, boolean_t *);
255 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *);
258 * Functions to manage pool properties
260 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
261 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
262 size_t proplen, zprop_source_t *);
263 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
266 extern const char *zpool_prop_to_name(zpool_prop_t);
267 extern const char *zpool_prop_values(zpool_prop_t);
270 * Pool health statistics.
274 * The following correspond to faults as defined in the (fault.fs.zfs.*)
275 * event namespace. Each is associated with a corresponding message ID.
277 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
278 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
279 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
280 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
281 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
282 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
283 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
284 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
285 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
286 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
287 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
288 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
289 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
290 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
293 * These faults have no corresponding message ID. At the time we are
294 * checking the status, the original reason for the FMA fault (I/O or
295 * checksum errors) has been lost.
297 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
298 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
301 * The following are not faults per se, but still an error possibly
302 * requiring administrative attention. There is no corresponding
305 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */
306 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
307 ZPOOL_STATUS_OFFLINE_DEV, /* device online */
308 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
311 * Finally, the following indicates a healthy pool.
316 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
317 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
318 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
321 * Statistics and configuration functions.
323 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
324 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
325 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
328 * Import and export functions
330 extern int zpool_export(zpool_handle_t *, boolean_t);
331 extern int zpool_export_force(zpool_handle_t *);
332 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
334 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
338 * Search for pools to import
341 typedef struct importargs {
342 char **path; /* a list of paths to search */
343 int paths; /* number of paths to search */
344 char *poolname; /* name of a pool to find */
345 uint64_t guid; /* guid of a pool to find */
346 char *cachefile; /* cachefile to use for import */
347 int can_be_active : 1; /* can the pool be active? */
348 int unique : 1; /* does 'poolname' already exist? */
349 int exists : 1; /* set on return if pool already exists */
352 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
354 /* legacy pool search routines */
355 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
356 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
360 * Miscellaneous pool functions
364 extern const char *zfs_history_event_names[LOG_END];
366 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
368 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
369 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
370 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
371 nvlist_t ***, uint_t *);
372 extern void zpool_set_history_str(const char *subcommand, int argc,
373 char **argv, char *history_str);
374 extern int zpool_stage_history(libzfs_handle_t *, const char *);
375 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
377 extern int zfs_ioctl(libzfs_handle_t *, unsigned long, struct zfs_cmd *);
378 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
379 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
383 * Basic handle manipulations. These functions do not create or destroy the
384 * underlying datasets, only the references to them.
386 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
387 extern void zfs_close(zfs_handle_t *);
388 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
389 extern const char *zfs_get_name(const zfs_handle_t *);
390 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
393 * Property management functions. Some functions are shared with the kernel,
394 * and are found in sys/fs/zfs.h.
398 * zfs dataset property management
400 extern const char *zfs_prop_default_string(zfs_prop_t);
401 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
402 extern const char *zfs_prop_column_name(zfs_prop_t);
403 extern boolean_t zfs_prop_align_right(zfs_prop_t);
405 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
406 nvlist_t *, uint64_t, zfs_handle_t *, const char *);
408 extern const char *zfs_prop_to_name(zfs_prop_t);
409 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
410 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
411 zprop_source_t *, char *, size_t, boolean_t);
412 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
414 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
415 zprop_source_t *, char *, size_t);
416 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
417 uint64_t *propvalue);
418 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
419 char *propbuf, int proplen, boolean_t literal);
420 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
421 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
422 extern const char *zfs_prop_values(zfs_prop_t);
423 extern int zfs_prop_is_string(zfs_prop_t prop);
424 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
425 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
427 typedef struct zprop_list {
430 struct zprop_list *pl_next;
433 size_t pl_recvd_width;
437 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t);
438 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
440 #define ZFS_MOUNTPOINT_NONE "none"
441 #define ZFS_MOUNTPOINT_LEGACY "legacy"
444 * zpool property management
446 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
447 extern const char *zpool_prop_default_string(zpool_prop_t);
448 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
449 extern const char *zpool_prop_column_name(zpool_prop_t);
450 extern boolean_t zpool_prop_align_right(zpool_prop_t);
453 * Functions shared by zfs and zpool property management.
455 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
456 boolean_t ordered, zfs_type_t type);
457 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
459 extern void zprop_free_list(zprop_list_t *);
461 #define ZFS_GET_NCOLS 5
473 * Functions for printing zfs or zpool properties
475 typedef struct zprop_get_cbdata {
477 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
478 int cb_colwidths[ZFS_GET_NCOLS + 1];
479 boolean_t cb_scripted;
480 boolean_t cb_literal;
482 zprop_list_t *cb_proplist;
484 } zprop_get_cbdata_t;
486 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
487 const char *, const char *, zprop_source_t, const char *,
491 * Iterator functions.
493 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
494 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
495 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
496 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
497 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
498 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
499 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
501 typedef struct get_all_cb {
502 zfs_handle_t **cb_handles;
505 boolean_t cb_verbose;
506 int (*cb_getone)(zfs_handle_t *, void *);
509 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
510 int libzfs_dataset_cmp(const void *, const void *);
513 * Functions to create and destroy datasets.
515 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
517 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
518 extern int zfs_destroy(zfs_handle_t *, boolean_t);
519 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
520 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
521 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
522 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
524 typedef struct renameflags {
525 /* recursive rename */
528 /* don't unmount file systems */
532 extern int zfs_rename(zfs_handle_t *, const char *, renameflags_t flags);
534 typedef struct sendflags {
535 /* print informational messages (ie, -v was specified) */
538 /* recursive send (ie, -R) */
541 /* for incrementals, do all intermediate snapshots */
542 int doall : 1; /* (ie, -I) */
544 /* if dataset is a clone, do incremental from its origin */
547 /* do deduplication */
550 /* send properties (ie, -p) */
554 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
556 extern int zfs_send(zfs_handle_t *zhp, const char *fromsnap, const char *tosnap,
557 sendflags_t flags, int outfd, snapfilter_cb_t filter_func,
558 void *cb_arg, nvlist_t **debugnvp);
560 extern int zfs_promote(zfs_handle_t *);
561 extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t,
562 boolean_t, boolean_t, int, uint64_t, uint64_t);
563 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
564 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
565 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
567 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
568 uid_t rid, uint64_t space);
570 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
571 zfs_userspace_cb_t, void *);
573 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
574 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
576 typedef struct recvflags {
577 /* print informational messages (ie, -v was specified) */
580 /* the destination is a prefix, not the exact fs (ie, -d) */
584 * Only the tail of the sent snapshot path is appended to the
585 * destination to determine the received snapshot name (ie, -e).
589 /* do not actually do the recv, just check if it would work (ie, -n) */
592 /* rollback/destroy filesystems as necessary (eg, -F) */
595 /* set "canmount=off" on all modified filesystems */
598 /* byteswap flag is used internally; callers need not specify */
601 /* do not mount file systems as they are extracted (private) */
605 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
608 typedef enum diff_flags {
609 ZFS_DIFF_PARSEABLE = 0x1,
610 ZFS_DIFF_TIMESTAMP = 0x2,
611 ZFS_DIFF_CLASSIFY = 0x4
614 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
618 * Miscellaneous functions.
620 extern const char *zfs_type_to_name(zfs_type_t);
621 extern void zfs_refresh_properties(zfs_handle_t *);
622 extern int zfs_name_valid(const char *, zfs_type_t);
623 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
624 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
626 extern int zfs_spa_version(zfs_handle_t *, int *);
629 * Mount support functions.
631 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
632 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
633 extern int zfs_mount(zfs_handle_t *, const char *, int);
634 extern int zfs_unmount(zfs_handle_t *, const char *, int);
635 extern int zfs_unmountall(zfs_handle_t *, int);
638 * Share support functions.
640 extern boolean_t zfs_is_shared(zfs_handle_t *);
641 extern int zfs_share(zfs_handle_t *);
642 extern int zfs_unshare(zfs_handle_t *);
645 * Protocol-specific share support functions.
647 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
648 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
649 extern int zfs_share_nfs(zfs_handle_t *);
650 extern int zfs_share_smb(zfs_handle_t *);
651 extern int zfs_shareall(zfs_handle_t *);
652 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
653 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
654 extern int zfs_unshareall_nfs(zfs_handle_t *);
655 extern int zfs_unshareall_smb(zfs_handle_t *);
656 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
657 extern int zfs_unshareall(zfs_handle_t *);
658 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
659 void *, void *, int, zfs_share_op_t);
662 * FreeBSD-specific jail support function.
664 extern int zfs_jail(zfs_handle_t *, int, int);
667 * When dealing with nvlists, verify() is extremely useful
671 #define verify(EX) ((void)(EX))
673 #define verify(EX) assert(EX)
678 * Utility function to convert a number to a human-readable form.
680 extern void zfs_nicenum(uint64_t, char *, size_t);
681 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
684 * Given a device or file, determine if it is part of a pool.
686 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
690 * Label manipulation.
692 extern int zpool_read_label(int, nvlist_t **);
693 extern int zpool_clear_label(int);
695 /* is this zvol valid for use as a dump device? */
696 extern int zvol_check_dump_config(char *);
699 * Management interfaces for SMB ACL files
702 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
703 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
704 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
705 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
708 * Enable and disable datasets within a pool by mounting/unmounting and
709 * sharing/unsharing them.
711 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
712 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
715 * Mappings between vdev and FRU.
717 extern void libzfs_fru_refresh(libzfs_handle_t *);
718 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
719 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
720 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
722 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
723 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
726 extern int zmount(const char *, const char *, int, char *, char *, int, char *,
734 #endif /* _LIBZFS_H */