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 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2011 Pawel Jakub Dawidek <pawel@dawidek.net>.
26 * All rights reserved.
27 * Copyright (c) 2012 by Delphix. All rights reserved.
28 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
29 * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
36 #include <libnvpair.h>
37 #include <sys/mnttab.h>
38 #include <sys/param.h>
39 #include <sys/types.h>
40 #include <sys/varargs.h>
41 #include <sys/fs/zfs.h>
43 #include <sys/zfs_ioctl.h>
50 * Miscellaneous ZFS constants
52 #define ZFS_MAXNAMELEN MAXNAMELEN
53 #define ZPOOL_MAXNAMELEN MAXNAMELEN
54 #define ZFS_MAXPROPLEN MAXPATHLEN
55 #define ZPOOL_MAXPROPLEN MAXPATHLEN
61 EZFS_NOMEM = 2000, /* out of memory */
62 EZFS_BADPROP, /* invalid property value */
63 EZFS_PROPREADONLY, /* cannot set readonly property */
64 EZFS_PROPTYPE, /* property does not apply to dataset type */
65 EZFS_PROPNONINHERIT, /* property is not inheritable */
66 EZFS_PROPSPACE, /* bad quota or reservation */
67 EZFS_BADTYPE, /* dataset is not of appropriate type */
68 EZFS_BUSY, /* pool or dataset is busy */
69 EZFS_EXISTS, /* pool or dataset already exists */
70 EZFS_NOENT, /* no such pool or dataset */
71 EZFS_BADSTREAM, /* bad backup stream */
72 EZFS_DSREADONLY, /* dataset is readonly */
73 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
74 EZFS_INVALIDNAME, /* invalid dataset name */
75 EZFS_BADRESTORE, /* unable to restore to destination */
76 EZFS_BADBACKUP, /* backup failed */
77 EZFS_BADTARGET, /* bad attach/detach/replace target */
78 EZFS_NODEVICE, /* no such device in pool */
79 EZFS_BADDEV, /* invalid device to add */
80 EZFS_NOREPLICAS, /* no valid replicas */
81 EZFS_RESILVERING, /* currently resilvering */
82 EZFS_BADVERSION, /* unsupported version */
83 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
84 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
85 EZFS_BADPATH, /* must be an absolute path */
86 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
87 EZFS_ZONED, /* used improperly in local zone */
88 EZFS_MOUNTFAILED, /* failed to mount dataset */
89 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
90 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
91 EZFS_SHARENFSFAILED, /* share(1M) failed */
92 EZFS_PERM, /* permission denied */
93 EZFS_NOSPC, /* out of space */
94 EZFS_FAULT, /* bad address */
95 EZFS_IO, /* I/O error */
96 EZFS_INTR, /* signal received */
97 EZFS_ISSPARE, /* device is a hot spare */
98 EZFS_INVALCONFIG, /* invalid vdev configuration */
99 EZFS_RECURSIVE, /* recursive dependency */
100 EZFS_NOHISTORY, /* no history object */
101 EZFS_POOLPROPS, /* couldn't retrieve pool props */
102 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
103 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
104 EZFS_NAMETOOLONG, /* dataset name is too long */
105 EZFS_OPENFAILED, /* open of device failed */
106 EZFS_NOCAP, /* couldn't get capacity */
107 EZFS_LABELFAILED, /* write of label failed */
108 EZFS_BADWHO, /* invalid permission who */
109 EZFS_BADPERM, /* invalid permission */
110 EZFS_BADPERMSET, /* invalid permission set name */
111 EZFS_NODELEGATION, /* delegated administration is disabled */
112 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
113 EZFS_SHARESMBFAILED, /* failed to share over smb */
114 EZFS_BADCACHE, /* bad cache file */
115 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
116 EZFS_VDEVNOTSUP, /* unsupported vdev type */
117 EZFS_NOTSUP, /* ops not supported on this dataset */
118 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
119 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
120 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
121 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
122 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
123 EZFS_PIPEFAILED, /* pipe create failed */
124 EZFS_THREADCREATEFAILED, /* thread create failed */
125 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
126 EZFS_SCRUBBING, /* currently scrubbing */
127 EZFS_NO_SCRUB, /* no active scrub */
128 EZFS_DIFF, /* general failure of zfs diff */
129 EZFS_DIFFDATA, /* bad zfs diff data */
130 EZFS_POOLREADONLY, /* pool is in read-only mode */
135 * The following data structures are all part
136 * of the zfs_allow_t data structure which is
137 * used for printing 'allow' permissions.
138 * It is a linked list of zfs_allow_t's which
139 * then contain avl tree's for user/group/sets/...
140 * and each one of the entries in those trees have
141 * avl tree's for the permissions they belong to and
142 * whether they are local,descendent or local+descendent
143 * permissions. The AVL trees are used primarily for
144 * sorting purposes, but also so that we can quickly find
145 * a given user and or permission.
147 typedef struct zfs_perm_node {
149 char z_pname[MAXPATHLEN];
152 typedef struct zfs_allow_node {
154 char z_key[MAXPATHLEN]; /* name, such as joe */
155 avl_tree_t z_localdescend; /* local+descendent perms */
156 avl_tree_t z_local; /* local permissions */
157 avl_tree_t z_descend; /* descendent permissions */
160 typedef struct zfs_allow {
161 struct zfs_allow *z_next;
162 char z_setpoint[MAXPATHLEN];
164 avl_tree_t z_crperms;
167 avl_tree_t z_everyone;
173 typedef struct zfs_handle zfs_handle_t;
174 typedef struct zpool_handle zpool_handle_t;
175 typedef struct libzfs_handle libzfs_handle_t;
178 * Library initialization
180 extern libzfs_handle_t *libzfs_init(void);
181 extern void libzfs_fini(libzfs_handle_t *);
183 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
184 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
186 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
188 extern int libzfs_errno(libzfs_handle_t *);
189 extern const char *libzfs_error_action(libzfs_handle_t *);
190 extern const char *libzfs_error_description(libzfs_handle_t *);
191 extern void libzfs_mnttab_init(libzfs_handle_t *);
192 extern void libzfs_mnttab_fini(libzfs_handle_t *);
193 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
194 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
196 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
197 const char *, const char *);
198 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
201 * Basic handle functions
203 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
204 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
205 extern void zpool_close(zpool_handle_t *);
206 extern const char *zpool_get_name(zpool_handle_t *);
207 extern int zpool_get_state(zpool_handle_t *);
208 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
209 extern const char *zpool_pool_state_to_name(pool_state_t);
210 extern void zpool_free_handles(libzfs_handle_t *);
213 * Iterate over all active pools in the system.
215 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
216 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
219 * Functions to create and destroy pools
221 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
222 nvlist_t *, nvlist_t *);
223 extern int zpool_destroy(zpool_handle_t *);
224 extern int zpool_add(zpool_handle_t *, nvlist_t *);
226 typedef struct splitflags {
227 /* do not split, but return the config that would be split off */
230 /* after splitting, import the pool */
235 * Functions to manipulate pool and vdev state
237 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
238 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
239 extern int zpool_reguid(zpool_handle_t *);
240 extern int zpool_reopen(zpool_handle_t *);
242 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
244 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
245 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
246 const char *, nvlist_t *, int);
247 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
248 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
249 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
252 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
253 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
254 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
256 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
257 boolean_t *, boolean_t *);
258 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
259 boolean_t *, boolean_t *, boolean_t *);
260 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *);
263 * Functions to manage pool properties
265 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
266 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
267 size_t proplen, zprop_source_t *);
268 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
271 extern const char *zpool_prop_to_name(zpool_prop_t);
272 extern const char *zpool_prop_values(zpool_prop_t);
275 * Pool health statistics.
279 * The following correspond to faults as defined in the (fault.fs.zfs.*)
280 * event namespace. Each is associated with a corresponding message ID.
282 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
283 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
284 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
285 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
286 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
287 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
288 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
289 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
290 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
291 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
292 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
293 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
294 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
295 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
298 * If the pool has unsupported features but can still be opened in
299 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
300 * pool has unsupported features but cannot be opened at all, its
301 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
303 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
304 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
307 * These faults have no corresponding message ID. At the time we are
308 * checking the status, the original reason for the FMA fault (I/O or
309 * checksum errors) has been lost.
311 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
312 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
315 * The following are not faults per se, but still an error possibly
316 * requiring administrative attention. There is no corresponding
319 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
320 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
321 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
322 ZPOOL_STATUS_OFFLINE_DEV, /* device online */
323 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
326 * Finally, the following indicates a healthy pool.
331 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
332 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
333 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
336 * Statistics and configuration functions.
338 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
339 extern nvlist_t *zpool_get_features(zpool_handle_t *);
340 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
341 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
344 * Import and export functions
346 extern int zpool_export(zpool_handle_t *, boolean_t);
347 extern int zpool_export_force(zpool_handle_t *);
348 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
350 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
352 extern void zpool_print_unsup_feat(nvlist_t *config);
355 * Search for pools to import
358 typedef struct importargs {
359 char **path; /* a list of paths to search */
360 int paths; /* number of paths to search */
361 char *poolname; /* name of a pool to find */
362 uint64_t guid; /* guid of a pool to find */
363 char *cachefile; /* cachefile to use for import */
364 int can_be_active : 1; /* can the pool be active? */
365 int unique : 1; /* does 'poolname' already exist? */
366 int exists : 1; /* set on return if pool already exists */
369 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
371 /* legacy pool search routines */
372 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
373 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
377 * Miscellaneous pool functions
381 extern const char *zfs_history_event_names[LOG_END];
383 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
385 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
386 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
387 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
388 nvlist_t ***, uint_t *);
389 extern void zpool_set_history_str(const char *subcommand, int argc,
390 char **argv, char *history_str);
391 extern int zpool_stage_history(libzfs_handle_t *, const char *);
392 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
394 extern int zfs_ioctl(libzfs_handle_t *, unsigned long, struct zfs_cmd *);
395 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
396 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
400 * Basic handle manipulations. These functions do not create or destroy the
401 * underlying datasets, only the references to them.
403 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
404 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
405 extern void zfs_close(zfs_handle_t *);
406 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
407 extern const char *zfs_get_name(const zfs_handle_t *);
408 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
411 * Property management functions. Some functions are shared with the kernel,
412 * and are found in sys/fs/zfs.h.
416 * zfs dataset property management
418 extern const char *zfs_prop_default_string(zfs_prop_t);
419 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
420 extern const char *zfs_prop_column_name(zfs_prop_t);
421 extern boolean_t zfs_prop_align_right(zfs_prop_t);
423 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
424 nvlist_t *, uint64_t, zfs_handle_t *, const char *);
426 extern const char *zfs_prop_to_name(zfs_prop_t);
427 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
428 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
429 zprop_source_t *, char *, size_t, boolean_t);
430 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
432 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
433 zprop_source_t *, char *, size_t);
434 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
435 uint64_t *propvalue);
436 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
437 char *propbuf, int proplen, boolean_t literal);
438 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
439 uint64_t *propvalue);
440 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
441 char *propbuf, int proplen, boolean_t literal);
442 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
443 char *buf, size_t len);
444 extern int zfs_get_snapused_int(zfs_handle_t *firstsnap, zfs_handle_t *lastsnap,
446 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
447 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
448 extern const char *zfs_prop_values(zfs_prop_t);
449 extern int zfs_prop_is_string(zfs_prop_t prop);
450 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
451 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
452 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
455 typedef struct zprop_list {
458 struct zprop_list *pl_next;
461 size_t pl_recvd_width;
465 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t);
466 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
468 #define ZFS_MOUNTPOINT_NONE "none"
469 #define ZFS_MOUNTPOINT_LEGACY "legacy"
471 #define ZFS_FEATURE_DISABLED "disabled"
472 #define ZFS_FEATURE_ENABLED "enabled"
473 #define ZFS_FEATURE_ACTIVE "active"
475 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
476 #define ZFS_UNSUPPORTED_READONLY "readonly"
479 * zpool property management
481 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
482 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
484 extern const char *zpool_prop_default_string(zpool_prop_t);
485 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
486 extern const char *zpool_prop_column_name(zpool_prop_t);
487 extern boolean_t zpool_prop_align_right(zpool_prop_t);
490 * Functions shared by zfs and zpool property management.
492 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
493 boolean_t ordered, zfs_type_t type);
494 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
496 extern void zprop_free_list(zprop_list_t *);
498 #define ZFS_GET_NCOLS 5
510 * Functions for printing zfs or zpool properties
512 typedef struct zprop_get_cbdata {
514 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
515 int cb_colwidths[ZFS_GET_NCOLS + 1];
516 boolean_t cb_scripted;
517 boolean_t cb_literal;
519 zprop_list_t *cb_proplist;
521 } zprop_get_cbdata_t;
523 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
524 const char *, const char *, zprop_source_t, const char *,
528 * Iterator functions.
530 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
531 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
532 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
533 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
534 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
535 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
536 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
537 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
539 typedef struct get_all_cb {
540 zfs_handle_t **cb_handles;
543 boolean_t cb_verbose;
544 int (*cb_getone)(zfs_handle_t *, void *);
547 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
548 int libzfs_dataset_cmp(const void *, const void *);
551 * Functions to create and destroy datasets.
553 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
555 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
556 extern int zfs_destroy(zfs_handle_t *, boolean_t);
557 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
558 extern int zfs_destroy_snaps_nvl(zfs_handle_t *, nvlist_t *, boolean_t);
559 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
560 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
561 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
563 typedef struct renameflags {
564 /* recursive rename */
567 /* don't unmount file systems */
570 /* force unmount file systems */
571 int forceunmount : 1;
574 extern int zfs_rename(zfs_handle_t *, const char *, renameflags_t flags);
576 typedef struct sendflags {
577 /* print informational messages (ie, -v was specified) */
580 /* recursive send (ie, -R) */
583 /* for incrementals, do all intermediate snapshots */
586 /* if dataset is a clone, do incremental from its origin */
587 boolean_t fromorigin;
589 /* do deduplication */
592 /* send properties (ie, -p) */
595 /* do not send (no-op, ie. -n) */
598 /* parsable verbose output (ie. -P) */
601 /* show progress (ie. -v) */
605 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
607 extern int zfs_send(zfs_handle_t *, const char *, const char *,
608 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
610 extern int zfs_promote(zfs_handle_t *);
611 extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t,
612 boolean_t, boolean_t, int, uint64_t, uint64_t);
613 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
614 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
615 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
617 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
618 uid_t rid, uint64_t space);
620 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
621 zfs_userspace_cb_t, void *);
623 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
624 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
626 typedef struct recvflags {
627 /* print informational messages (ie, -v was specified) */
630 /* the destination is a prefix, not the exact fs (ie, -d) */
634 * Only the tail of the sent snapshot path is appended to the
635 * destination to determine the received snapshot name (ie, -e).
639 /* do not actually do the recv, just check if it would work (ie, -n) */
642 /* rollback/destroy filesystems as necessary (eg, -F) */
645 /* set "canmount=off" on all modified filesystems */
646 boolean_t canmountoff;
648 /* byteswap flag is used internally; callers need not specify */
651 /* do not mount file systems as they are extracted (private) */
655 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *,
658 typedef enum diff_flags {
659 ZFS_DIFF_PARSEABLE = 0x1,
660 ZFS_DIFF_TIMESTAMP = 0x2,
661 ZFS_DIFF_CLASSIFY = 0x4
664 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
668 * Miscellaneous functions.
670 extern const char *zfs_type_to_name(zfs_type_t);
671 extern void zfs_refresh_properties(zfs_handle_t *);
672 extern int zfs_name_valid(const char *, zfs_type_t);
673 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
674 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
676 extern int zfs_spa_version(zfs_handle_t *, int *);
679 * Mount support functions.
681 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
682 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
683 extern int zfs_mount(zfs_handle_t *, const char *, int);
684 extern int zfs_unmount(zfs_handle_t *, const char *, int);
685 extern int zfs_unmountall(zfs_handle_t *, int);
688 * Share support functions.
690 extern boolean_t zfs_is_shared(zfs_handle_t *);
691 extern int zfs_share(zfs_handle_t *);
692 extern int zfs_unshare(zfs_handle_t *);
695 * Protocol-specific share support functions.
697 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
698 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
699 extern int zfs_share_nfs(zfs_handle_t *);
700 extern int zfs_share_smb(zfs_handle_t *);
701 extern int zfs_shareall(zfs_handle_t *);
702 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
703 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
704 extern int zfs_unshareall_nfs(zfs_handle_t *);
705 extern int zfs_unshareall_smb(zfs_handle_t *);
706 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
707 extern int zfs_unshareall(zfs_handle_t *);
708 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
709 void *, void *, int, zfs_share_op_t);
712 * FreeBSD-specific jail support function.
714 extern int zfs_jail(zfs_handle_t *, int, int);
717 * When dealing with nvlists, verify() is extremely useful
721 #define verify(EX) ((void)(EX))
723 #define verify(EX) assert(EX)
728 * Utility function to convert a number to a human-readable form.
730 extern void zfs_nicenum(uint64_t, char *, size_t);
731 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
734 * Given a device or file, determine if it is part of a pool.
736 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
740 * Label manipulation.
742 extern int zpool_read_label(int, nvlist_t **);
743 extern int zpool_clear_label(int);
745 /* is this zvol valid for use as a dump device? */
746 extern int zvol_check_dump_config(char *);
749 * Management interfaces for SMB ACL files
752 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
753 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
754 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
755 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
758 * Enable and disable datasets within a pool by mounting/unmounting and
759 * sharing/unsharing them.
761 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
762 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
765 * Mappings between vdev and FRU.
767 extern void libzfs_fru_refresh(libzfs_handle_t *);
768 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
769 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
770 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
772 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
773 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
776 extern int zmount(const char *, const char *, int, char *, char *, int, char *,
784 #endif /* _LIBZFS_H */