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.
31 * Copyright (c) 2014 Integros [integros.com]
38 #include <libnvpair.h>
39 #include <sys/mnttab.h>
40 #include <sys/param.h>
41 #include <sys/types.h>
42 #include <sys/varargs.h>
43 #include <sys/fs/zfs.h>
45 #include <sys/zfs_ioctl.h>
46 #include <libzfs_core.h>
53 * Miscellaneous ZFS constants
55 #define ZFS_MAXNAMELEN MAXNAMELEN
56 #define ZPOOL_MAXNAMELEN MAXNAMELEN
57 #define ZFS_MAXPROPLEN MAXPATHLEN
58 #define ZPOOL_MAXPROPLEN MAXPATHLEN
63 typedef enum zfs_error {
64 EZFS_SUCCESS = 0, /* no error -- success */
65 EZFS_NOMEM = 2000, /* out of memory */
66 EZFS_BADPROP, /* invalid property value */
67 EZFS_PROPREADONLY, /* cannot set readonly property */
68 EZFS_PROPTYPE, /* property does not apply to dataset type */
69 EZFS_PROPNONINHERIT, /* property is not inheritable */
70 EZFS_PROPSPACE, /* bad quota or reservation */
71 EZFS_BADTYPE, /* dataset is not of appropriate type */
72 EZFS_BUSY, /* pool or dataset is busy */
73 EZFS_EXISTS, /* pool or dataset already exists */
74 EZFS_NOENT, /* no such pool or dataset */
75 EZFS_BADSTREAM, /* bad backup stream */
76 EZFS_DSREADONLY, /* dataset is readonly */
77 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
78 EZFS_INVALIDNAME, /* invalid dataset name */
79 EZFS_BADRESTORE, /* unable to restore to destination */
80 EZFS_BADBACKUP, /* backup failed */
81 EZFS_BADTARGET, /* bad attach/detach/replace target */
82 EZFS_NODEVICE, /* no such device in pool */
83 EZFS_BADDEV, /* invalid device to add */
84 EZFS_NOREPLICAS, /* no valid replicas */
85 EZFS_RESILVERING, /* currently resilvering */
86 EZFS_BADVERSION, /* unsupported version */
87 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
88 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
89 EZFS_BADPATH, /* must be an absolute path */
90 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
91 EZFS_ZONED, /* used improperly in local zone */
92 EZFS_MOUNTFAILED, /* failed to mount dataset */
93 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
94 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
95 EZFS_SHARENFSFAILED, /* share(1M) failed */
96 EZFS_PERM, /* permission denied */
97 EZFS_NOSPC, /* out of space */
98 EZFS_FAULT, /* bad address */
99 EZFS_IO, /* I/O error */
100 EZFS_INTR, /* signal received */
101 EZFS_ISSPARE, /* device is a hot spare */
102 EZFS_INVALCONFIG, /* invalid vdev configuration */
103 EZFS_RECURSIVE, /* recursive dependency */
104 EZFS_NOHISTORY, /* no history object */
105 EZFS_POOLPROPS, /* couldn't retrieve pool props */
106 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
107 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
108 EZFS_NAMETOOLONG, /* dataset name is too long */
109 EZFS_OPENFAILED, /* open of device failed */
110 EZFS_NOCAP, /* couldn't get capacity */
111 EZFS_LABELFAILED, /* write of label failed */
112 EZFS_BADWHO, /* invalid permission who */
113 EZFS_BADPERM, /* invalid permission */
114 EZFS_BADPERMSET, /* invalid permission set name */
115 EZFS_NODELEGATION, /* delegated administration is disabled */
116 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
117 EZFS_SHARESMBFAILED, /* failed to share over smb */
118 EZFS_BADCACHE, /* bad cache file */
119 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
120 EZFS_VDEVNOTSUP, /* unsupported vdev type */
121 EZFS_NOTSUP, /* ops not supported on this dataset */
122 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
123 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
124 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
125 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
126 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
127 EZFS_PIPEFAILED, /* pipe create failed */
128 EZFS_THREADCREATEFAILED, /* thread create failed */
129 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
130 EZFS_SCRUBBING, /* currently scrubbing */
131 EZFS_NO_SCRUB, /* no active scrub */
132 EZFS_DIFF, /* general failure of zfs diff */
133 EZFS_DIFFDATA, /* bad zfs diff data */
134 EZFS_POOLREADONLY, /* pool is in read-only mode */
139 * The following data structures are all part
140 * of the zfs_allow_t data structure which is
141 * used for printing 'allow' permissions.
142 * It is a linked list of zfs_allow_t's which
143 * then contain avl tree's for user/group/sets/...
144 * and each one of the entries in those trees have
145 * avl tree's for the permissions they belong to and
146 * whether they are local,descendent or local+descendent
147 * permissions. The AVL trees are used primarily for
148 * sorting purposes, but also so that we can quickly find
149 * a given user and or permission.
151 typedef struct zfs_perm_node {
153 char z_pname[MAXPATHLEN];
156 typedef struct zfs_allow_node {
158 char z_key[MAXPATHLEN]; /* name, such as joe */
159 avl_tree_t z_localdescend; /* local+descendent perms */
160 avl_tree_t z_local; /* local permissions */
161 avl_tree_t z_descend; /* descendent permissions */
164 typedef struct zfs_allow {
165 struct zfs_allow *z_next;
166 char z_setpoint[MAXPATHLEN];
168 avl_tree_t z_crperms;
171 avl_tree_t z_everyone;
177 typedef struct zfs_handle zfs_handle_t;
178 typedef struct zpool_handle zpool_handle_t;
179 typedef struct libzfs_handle libzfs_handle_t;
182 * Library initialization
184 extern libzfs_handle_t *libzfs_init(void);
185 extern void libzfs_fini(libzfs_handle_t *);
187 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
188 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
190 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
192 extern void zfs_save_arguments(int argc, char **, char *, int);
193 extern int zpool_log_history(libzfs_handle_t *, const char *);
195 extern int libzfs_errno(libzfs_handle_t *);
196 extern const char *libzfs_error_action(libzfs_handle_t *);
197 extern const char *libzfs_error_description(libzfs_handle_t *);
198 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
199 extern void libzfs_mnttab_init(libzfs_handle_t *);
200 extern void libzfs_mnttab_fini(libzfs_handle_t *);
201 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
202 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
204 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
205 const char *, const char *);
206 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
209 * Basic handle functions
211 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
212 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
213 extern void zpool_close(zpool_handle_t *);
214 extern const char *zpool_get_name(zpool_handle_t *);
215 extern int zpool_get_state(zpool_handle_t *);
216 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
217 extern const char *zpool_pool_state_to_name(pool_state_t);
218 extern void zpool_free_handles(libzfs_handle_t *);
221 * Iterate over all active pools in the system.
223 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
224 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
227 * Functions to create and destroy pools
229 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
230 nvlist_t *, nvlist_t *);
231 extern int zpool_destroy(zpool_handle_t *, const char *);
232 extern int zpool_add(zpool_handle_t *, nvlist_t *);
234 typedef struct splitflags {
235 /* do not split, but return the config that would be split off */
238 /* after splitting, import the pool */
243 * Functions to manipulate pool and vdev state
245 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
246 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
247 extern int zpool_reguid(zpool_handle_t *);
248 extern int zpool_reopen(zpool_handle_t *);
250 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
252 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
253 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
254 const char *, nvlist_t *, int);
255 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
256 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
257 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
260 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
261 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
262 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
264 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
265 boolean_t *, boolean_t *);
266 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
267 boolean_t *, boolean_t *, boolean_t *);
268 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *);
271 * Functions to manage pool properties
273 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
274 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
275 size_t proplen, zprop_source_t *, boolean_t);
276 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
279 extern const char *zpool_prop_to_name(zpool_prop_t);
280 extern const char *zpool_prop_values(zpool_prop_t);
283 * Pool health statistics.
287 * The following correspond to faults as defined in the (fault.fs.zfs.*)
288 * event namespace. Each is associated with a corresponding message ID.
290 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
291 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
292 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
293 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
294 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
295 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
296 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
297 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
298 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
299 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
300 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
301 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
302 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
303 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
306 * If the pool has unsupported features but can still be opened in
307 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
308 * pool has unsupported features but cannot be opened at all, its
309 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
311 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
312 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
315 * These faults have no corresponding message ID. At the time we are
316 * checking the status, the original reason for the FMA fault (I/O or
317 * checksum errors) has been lost.
319 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
320 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
323 * The following are not faults per se, but still an error possibly
324 * requiring administrative attention. There is no corresponding
327 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
328 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
329 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
330 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */
331 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
332 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
335 * Finally, the following indicates a healthy pool.
340 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
341 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
342 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
345 * Statistics and configuration functions.
347 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
348 extern nvlist_t *zpool_get_features(zpool_handle_t *);
349 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
350 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
353 * Import and export functions
355 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
356 extern int zpool_export_force(zpool_handle_t *, const char *);
357 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
359 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
361 extern void zpool_print_unsup_feat(nvlist_t *config);
364 * Search for pools to import
367 typedef struct importargs {
368 char **path; /* a list of paths to search */
369 int paths; /* number of paths to search */
370 char *poolname; /* name of a pool to find */
371 uint64_t guid; /* guid of a pool to find */
372 char *cachefile; /* cachefile to use for import */
373 int can_be_active : 1; /* can the pool be active? */
374 int unique : 1; /* does 'poolname' already exist? */
375 int exists : 1; /* set on return if pool already exists */
378 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
380 /* legacy pool search routines */
381 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
382 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
386 * Miscellaneous pool functions
390 extern const char *zfs_history_event_names[];
392 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
394 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
395 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
396 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
397 nvlist_t ***, uint_t *);
398 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
400 extern int zfs_ioctl(libzfs_handle_t *, int request, struct zfs_cmd *);
401 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
402 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
406 * Basic handle manipulations. These functions do not create or destroy the
407 * underlying datasets, only the references to them.
409 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
410 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
411 extern void zfs_close(zfs_handle_t *);
412 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
413 extern const char *zfs_get_name(const zfs_handle_t *);
414 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
417 * Property management functions. Some functions are shared with the kernel,
418 * and are found in sys/fs/zfs.h.
422 * zfs dataset property management
424 extern const char *zfs_prop_default_string(zfs_prop_t);
425 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
426 extern const char *zfs_prop_column_name(zfs_prop_t);
427 extern boolean_t zfs_prop_align_right(zfs_prop_t);
429 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
430 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
432 extern const char *zfs_prop_to_name(zfs_prop_t);
433 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
434 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
435 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
436 zprop_source_t *, char *, size_t, boolean_t);
437 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
439 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
440 zprop_source_t *, char *, size_t);
441 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
442 uint64_t *propvalue);
443 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
444 char *propbuf, int proplen, boolean_t literal);
445 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
446 uint64_t *propvalue);
447 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
448 char *propbuf, int proplen, boolean_t literal);
449 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
450 char *buf, size_t len);
451 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
452 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
453 extern const char *zfs_prop_values(zfs_prop_t);
454 extern int zfs_prop_is_string(zfs_prop_t prop);
455 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
456 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
457 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
460 typedef struct zprop_list {
463 struct zprop_list *pl_next;
466 size_t pl_recvd_width;
470 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
472 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
474 #define ZFS_MOUNTPOINT_NONE "none"
475 #define ZFS_MOUNTPOINT_LEGACY "legacy"
477 #define ZFS_FEATURE_DISABLED "disabled"
478 #define ZFS_FEATURE_ENABLED "enabled"
479 #define ZFS_FEATURE_ACTIVE "active"
481 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
482 #define ZFS_UNSUPPORTED_READONLY "readonly"
485 * zpool property management
487 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
488 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
490 extern const char *zpool_prop_default_string(zpool_prop_t);
491 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
492 extern const char *zpool_prop_column_name(zpool_prop_t);
493 extern boolean_t zpool_prop_align_right(zpool_prop_t);
496 * Functions shared by zfs and zpool property management.
498 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
499 boolean_t ordered, zfs_type_t type);
500 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
502 extern void zprop_free_list(zprop_list_t *);
504 #define ZFS_GET_NCOLS 5
516 * Functions for printing zfs or zpool properties
518 typedef struct zprop_get_cbdata {
520 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
521 int cb_colwidths[ZFS_GET_NCOLS + 1];
522 boolean_t cb_scripted;
523 boolean_t cb_literal;
525 zprop_list_t *cb_proplist;
527 } zprop_get_cbdata_t;
529 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
530 const char *, const char *, zprop_source_t, const char *,
534 * Iterator functions.
536 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
537 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
538 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
539 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
540 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
541 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
542 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
543 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
544 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
546 typedef struct get_all_cb {
547 zfs_handle_t **cb_handles;
550 boolean_t cb_verbose;
551 int (*cb_getone)(zfs_handle_t *, void *);
554 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
555 int libzfs_dataset_cmp(const void *, const void *);
558 * Functions to create and destroy datasets.
560 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
562 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
563 extern int zfs_destroy(zfs_handle_t *, boolean_t);
564 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
565 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
566 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
567 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
568 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
570 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
572 typedef struct renameflags {
573 /* recursive rename */
576 /* don't unmount file systems */
579 /* force unmount file systems */
580 int forceunmount : 1;
583 extern int zfs_rename(zfs_handle_t *, const char *, const char *,
584 renameflags_t flags);
586 typedef struct sendflags {
587 /* print informational messages (ie, -v was specified) */
590 /* recursive send (ie, -R) */
593 /* for incrementals, do all intermediate snapshots */
596 /* if dataset is a clone, do incremental from its origin */
597 boolean_t fromorigin;
599 /* do deduplication */
602 /* send properties (ie, -p) */
605 /* do not send (no-op, ie. -n) */
608 /* parsable verbose output (ie. -P) */
611 /* show progress (ie. -v) */
614 /* large blocks (>128K) are permitted */
615 boolean_t largeblock;
617 /* WRITE_EMBEDDED records of type DATA are permitted */
618 boolean_t embed_data;
621 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
623 extern int zfs_send(zfs_handle_t *, const char *, const char *,
624 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
625 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
626 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
628 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
631 extern int zfs_promote(zfs_handle_t *);
632 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
634 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
635 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
636 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
637 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
639 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
640 uid_t rid, uint64_t space);
642 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
643 zfs_userspace_cb_t, void *);
645 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
646 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
648 typedef struct recvflags {
649 /* print informational messages (ie, -v was specified) */
652 /* the destination is a prefix, not the exact fs (ie, -d) */
656 * Only the tail of the sent snapshot path is appended to the
657 * destination to determine the received snapshot name (ie, -e).
661 /* do not actually do the recv, just check if it would work (ie, -n) */
664 /* rollback/destroy filesystems as necessary (eg, -F) */
667 /* set "canmount=off" on all modified filesystems */
668 boolean_t canmountoff;
671 * Mark the file systems as "resumable" and do not destroy them if the
672 * receive is interrupted
676 /* byteswap flag is used internally; callers need not specify */
679 /* do not mount file systems as they are extracted (private) */
683 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
684 recvflags_t *, int, avl_tree_t *);
686 typedef enum diff_flags {
687 ZFS_DIFF_PARSEABLE = 0x1,
688 ZFS_DIFF_TIMESTAMP = 0x2,
689 ZFS_DIFF_CLASSIFY = 0x4
692 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
696 * Miscellaneous functions.
698 extern const char *zfs_type_to_name(zfs_type_t);
699 extern void zfs_refresh_properties(zfs_handle_t *);
700 extern int zfs_name_valid(const char *, zfs_type_t);
701 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
702 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
704 extern int zfs_spa_version(zfs_handle_t *, int *);
705 extern boolean_t zfs_bookmark_exists(const char *path);
708 * Mount support functions.
710 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
711 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
712 extern int zfs_mount(zfs_handle_t *, const char *, int);
713 extern int zfs_unmount(zfs_handle_t *, const char *, int);
714 extern int zfs_unmountall(zfs_handle_t *, int);
717 * Share support functions.
719 extern boolean_t zfs_is_shared(zfs_handle_t *);
720 extern int zfs_share(zfs_handle_t *);
721 extern int zfs_unshare(zfs_handle_t *);
724 * Protocol-specific share support functions.
726 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
727 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
728 extern int zfs_share_nfs(zfs_handle_t *);
729 extern int zfs_share_smb(zfs_handle_t *);
730 extern int zfs_shareall(zfs_handle_t *);
731 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
732 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
733 extern int zfs_unshareall_nfs(zfs_handle_t *);
734 extern int zfs_unshareall_smb(zfs_handle_t *);
735 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
736 extern int zfs_unshareall(zfs_handle_t *);
737 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
738 void *, void *, int, zfs_share_op_t);
741 * FreeBSD-specific jail support function.
743 extern int zfs_jail(zfs_handle_t *, int, int);
746 * When dealing with nvlists, verify() is extremely useful
750 #define verify(EX) ((void)(EX))
752 #define verify(EX) assert(EX)
757 * Utility function to convert a number to a human-readable form.
759 extern void zfs_nicenum(uint64_t, char *, size_t);
760 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
763 * Given a device or file, determine if it is part of a pool.
765 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
769 * Label manipulation.
771 extern int zpool_read_label(int, nvlist_t **);
772 extern int zpool_clear_label(int);
774 /* is this zvol valid for use as a dump device? */
775 extern int zvol_check_dump_config(char *);
778 * Management interfaces for SMB ACL files
781 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
782 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
783 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
784 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
787 * Enable and disable datasets within a pool by mounting/unmounting and
788 * sharing/unsharing them.
790 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
791 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
794 * Mappings between vdev and FRU.
796 extern void libzfs_fru_refresh(libzfs_handle_t *);
797 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
798 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
799 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
801 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
802 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
805 extern int zmount(const char *, const char *, int, char *, char *, int, char *,
813 #endif /* _LIBZFS_H */