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) 2012 by Delphix. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. 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>
47 * Miscellaneous ZFS constants
49 #define ZFS_MAXNAMELEN MAXNAMELEN
50 #define ZPOOL_MAXNAMELEN MAXNAMELEN
51 #define ZFS_MAXPROPLEN MAXPATHLEN
52 #define ZPOOL_MAXPROPLEN MAXPATHLEN
55 * Default device paths
58 #if defined(__sun__) || defined(__sun)
59 #define DISK_ROOT "/dev/dsk"
60 #define RDISK_ROOT "/dev/rdsk"
61 #define UDISK_ROOT RDISK_ROOT
62 #define FIRST_SLICE "s0"
63 #define BACKUP_SLICE "s2"
67 #define DISK_ROOT "/dev"
68 #define RDISK_ROOT DISK_ROOT
69 #define UDISK_ROOT "/dev/disk"
70 #define FIRST_SLICE "1"
71 #define BACKUP_SLICE ""
78 EZFS_NOMEM = 2000, /* out of memory */
79 EZFS_BADPROP, /* invalid property value */
80 EZFS_PROPREADONLY, /* cannot set readonly property */
81 EZFS_PROPTYPE, /* property does not apply to dataset type */
82 EZFS_PROPNONINHERIT, /* property is not inheritable */
83 EZFS_PROPSPACE, /* bad quota or reservation */
84 EZFS_BADTYPE, /* dataset is not of appropriate type */
85 EZFS_BUSY, /* pool or dataset is busy */
86 EZFS_EXISTS, /* pool or dataset already exists */
87 EZFS_NOENT, /* no such pool or dataset */
88 EZFS_BADSTREAM, /* bad backup stream */
89 EZFS_DSREADONLY, /* dataset is readonly */
90 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
91 EZFS_INVALIDNAME, /* invalid dataset name */
92 EZFS_BADRESTORE, /* unable to restore to destination */
93 EZFS_BADBACKUP, /* backup failed */
94 EZFS_BADTARGET, /* bad attach/detach/replace target */
95 EZFS_NODEVICE, /* no such device in pool */
96 EZFS_BADDEV, /* invalid device to add */
97 EZFS_NOREPLICAS, /* no valid replicas */
98 EZFS_RESILVERING, /* currently resilvering */
99 EZFS_BADVERSION, /* unsupported version */
100 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
101 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
102 EZFS_BADPATH, /* must be an absolute path */
103 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
104 EZFS_ZONED, /* used improperly in local zone */
105 EZFS_MOUNTFAILED, /* failed to mount dataset */
106 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
107 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
108 EZFS_SHARENFSFAILED, /* share(1M) failed */
109 EZFS_PERM, /* permission denied */
110 EZFS_NOSPC, /* out of space */
111 EZFS_FAULT, /* bad address */
112 EZFS_IO, /* I/O error */
113 EZFS_INTR, /* signal received */
114 EZFS_ISSPARE, /* device is a hot spare */
115 EZFS_INVALCONFIG, /* invalid vdev configuration */
116 EZFS_RECURSIVE, /* recursive dependency */
117 EZFS_NOHISTORY, /* no history object */
118 EZFS_POOLPROPS, /* couldn't retrieve pool props */
119 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
120 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
121 EZFS_NAMETOOLONG, /* dataset name is too long */
122 EZFS_OPENFAILED, /* open of device failed */
123 EZFS_NOCAP, /* couldn't get capacity */
124 EZFS_LABELFAILED, /* write of label failed */
125 EZFS_BADWHO, /* invalid permission who */
126 EZFS_BADPERM, /* invalid permission */
127 EZFS_BADPERMSET, /* invalid permission set name */
128 EZFS_NODELEGATION, /* delegated administration is disabled */
129 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
130 EZFS_SHARESMBFAILED, /* failed to share over smb */
131 EZFS_BADCACHE, /* bad cache file */
132 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
133 EZFS_VDEVNOTSUP, /* unsupported vdev type */
134 EZFS_NOTSUP, /* ops not supported on this dataset */
135 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
136 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
137 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
138 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
139 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
140 EZFS_PIPEFAILED, /* pipe create failed */
141 EZFS_THREADCREATEFAILED, /* thread create failed */
142 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
143 EZFS_SCRUBBING, /* currently scrubbing */
144 EZFS_NO_SCRUB, /* no active scrub */
145 EZFS_DIFF, /* general failure of zfs diff */
146 EZFS_DIFFDATA, /* bad zfs diff data */
147 EZFS_POOLREADONLY, /* pool is in read-only mode */
152 * The following data structures are all part
153 * of the zfs_allow_t data structure which is
154 * used for printing 'allow' permissions.
155 * It is a linked list of zfs_allow_t's which
156 * then contain avl tree's for user/group/sets/...
157 * and each one of the entries in those trees have
158 * avl tree's for the permissions they belong to and
159 * whether they are local,descendent or local+descendent
160 * permissions. The AVL trees are used primarily for
161 * sorting purposes, but also so that we can quickly find
162 * a given user and or permission.
164 typedef struct zfs_perm_node {
166 char z_pname[MAXPATHLEN];
169 typedef struct zfs_allow_node {
171 char z_key[MAXPATHLEN]; /* name, such as joe */
172 avl_tree_t z_localdescend; /* local+descendent perms */
173 avl_tree_t z_local; /* local permissions */
174 avl_tree_t z_descend; /* descendent permissions */
177 typedef struct zfs_allow {
178 struct zfs_allow *z_next;
179 char z_setpoint[MAXPATHLEN];
181 avl_tree_t z_crperms;
184 avl_tree_t z_everyone;
190 typedef struct zfs_handle zfs_handle_t;
191 typedef struct zpool_handle zpool_handle_t;
192 typedef struct libzfs_handle libzfs_handle_t;
195 * Library initialization
197 extern libzfs_handle_t *libzfs_init(void);
198 extern void libzfs_fini(libzfs_handle_t *);
200 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
201 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
203 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
205 extern int libzfs_errno(libzfs_handle_t *);
206 extern const char *libzfs_error_action(libzfs_handle_t *);
207 extern const char *libzfs_error_description(libzfs_handle_t *);
208 extern void libzfs_mnttab_init(libzfs_handle_t *);
209 extern void libzfs_mnttab_fini(libzfs_handle_t *);
210 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
211 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
213 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
214 const char *, const char *);
215 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
218 * Basic handle functions
220 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
221 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
222 extern void zpool_close(zpool_handle_t *);
223 extern const char *zpool_get_name(zpool_handle_t *);
224 extern int zpool_get_state(zpool_handle_t *);
225 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
226 extern void zpool_free_handles(libzfs_handle_t *);
229 * Iterate over all active pools in the system.
231 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
232 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
235 * Functions to create and destroy pools
237 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
238 nvlist_t *, nvlist_t *);
239 extern int zpool_destroy(zpool_handle_t *);
240 extern int zpool_add(zpool_handle_t *, nvlist_t *);
242 typedef struct splitflags {
243 /* do not split, but return the config that would be split off */
246 /* after splitting, import the pool */
251 * Functions to manipulate pool and vdev state
253 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
254 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
255 extern int zpool_reguid(zpool_handle_t *);
256 extern int zpool_reopen(zpool_handle_t *);
258 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
260 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
261 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
262 const char *, nvlist_t *, int);
263 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
264 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
265 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
268 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
269 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
270 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
272 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
273 boolean_t *, boolean_t *);
274 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
275 boolean_t *, boolean_t *, boolean_t *);
276 extern int zpool_label_disk_wait(char *, int);
277 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
280 * Functions to manage pool properties
282 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
283 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
284 size_t proplen, zprop_source_t *);
285 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
288 extern const char *zpool_prop_to_name(zpool_prop_t);
289 extern const char *zpool_prop_values(zpool_prop_t);
292 * Pool health statistics.
296 * The following correspond to faults as defined in the (fault.fs.zfs.*)
297 * event namespace. Each is associated with a corresponding message ID.
299 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
300 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
301 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
302 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
303 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
304 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
305 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
306 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
307 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
308 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
309 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
310 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
311 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
312 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
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 on-disk version */
328 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
329 ZPOOL_STATUS_OFFLINE_DEV, /* device online */
330 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
333 * Finally, the following indicates a healthy pool.
338 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
339 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
340 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
343 * Statistics and configuration functions.
345 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
346 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
347 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
350 * Import and export functions
352 extern int zpool_export(zpool_handle_t *, boolean_t);
353 extern int zpool_export_force(zpool_handle_t *);
354 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
356 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
360 * Search for pools to import
363 typedef struct importargs {
364 char **path; /* a list of paths to search */
365 int paths; /* number of paths to search */
366 char *poolname; /* name of a pool to find */
367 uint64_t guid; /* guid of a pool to find */
368 char *cachefile; /* cachefile to use for import */
369 int can_be_active : 1; /* can the pool be active? */
370 int unique : 1; /* does 'poolname' already exist? */
371 int exists : 1; /* set on return if pool already exists */
374 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
376 /* legacy pool search routines */
377 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
378 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
382 * Miscellaneous pool functions
386 extern const char *zfs_history_event_names[LOG_END];
388 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
390 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
391 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
392 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
393 nvlist_t ***, uint_t *);
394 extern void zpool_set_history_str(const char *subcommand, int argc,
395 char **argv, char *history_str);
396 extern int zpool_stage_history(libzfs_handle_t *, const char *);
397 extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, int, int);
398 extern int zpool_events_clear(libzfs_handle_t *, int *);
399 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
401 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
402 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
403 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
407 * Basic handle manipulations. These functions do not create or destroy the
408 * underlying datasets, only the references to them.
410 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
411 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
412 extern void zfs_close(zfs_handle_t *);
413 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
414 extern const char *zfs_get_name(const zfs_handle_t *);
415 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
418 * Property management functions. Some functions are shared with the kernel,
419 * and are found in sys/fs/zfs.h.
423 * zfs dataset property management
425 extern const char *zfs_prop_default_string(zfs_prop_t);
426 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
427 extern const char *zfs_prop_column_name(zfs_prop_t);
428 extern boolean_t zfs_prop_align_right(zfs_prop_t);
430 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
431 nvlist_t *, uint64_t, zfs_handle_t *, const char *);
433 extern const char *zfs_prop_to_name(zfs_prop_t);
434 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
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_get_snapused_int(zfs_handle_t *firstsnap, zfs_handle_t *lastsnap,
451 extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **);
452 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
453 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
454 extern const char *zfs_prop_values(zfs_prop_t);
455 extern int zfs_prop_is_string(zfs_prop_t prop);
456 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
457 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
458 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);
471 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
473 #define ZFS_MOUNTPOINT_NONE "none"
474 #define ZFS_MOUNTPOINT_LEGACY "legacy"
477 * zpool property management
479 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
480 extern const char *zpool_prop_default_string(zpool_prop_t);
481 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
482 extern const char *zpool_prop_column_name(zpool_prop_t);
483 extern boolean_t zpool_prop_align_right(zpool_prop_t);
486 * Functions shared by zfs and zpool property management.
488 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
489 boolean_t ordered, zfs_type_t type);
490 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
492 extern void zprop_free_list(zprop_list_t *);
494 #define ZFS_GET_NCOLS 5
506 * Functions for printing zfs or zpool properties
508 typedef struct zprop_get_cbdata {
510 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
511 int cb_colwidths[ZFS_GET_NCOLS + 1];
512 boolean_t cb_scripted;
513 boolean_t cb_literal;
515 zprop_list_t *cb_proplist;
517 } zprop_get_cbdata_t;
519 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
520 const char *, const char *, zprop_source_t, const char *,
524 * Iterator functions.
526 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
527 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
528 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
529 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
530 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
531 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
532 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
533 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
535 typedef struct get_all_cb {
536 zfs_handle_t **cb_handles;
539 boolean_t cb_verbose;
540 int (*cb_getone)(zfs_handle_t *, void *);
543 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
544 int libzfs_dataset_cmp(const void *, const void *);
547 * Functions to create and destroy datasets.
549 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
551 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
552 extern int zfs_destroy(zfs_handle_t *, boolean_t);
553 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
554 extern int zfs_destroy_snaps_nvl(zfs_handle_t *, nvlist_t *, boolean_t);
555 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
556 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
557 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
558 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
560 typedef struct sendflags {
561 /* print informational messages (ie, -v was specified) */
564 /* recursive send (ie, -R) */
567 /* for incrementals, do all intermediate snapshots */
570 /* if dataset is a clone, do incremental from its origin */
571 boolean_t fromorigin;
573 /* do deduplication */
576 /* send properties (ie, -p) */
579 /* do not send (no-op, ie. -n) */
582 /* parsable verbose output (ie. -P) */
585 /* show progress (ie. -v) */
589 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
591 extern int zfs_send(zfs_handle_t *, const char *, const char *,
592 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
594 extern int zfs_promote(zfs_handle_t *);
595 extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t,
596 boolean_t, boolean_t, int, uint64_t, uint64_t);
597 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
598 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
599 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
601 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
602 uid_t rid, uint64_t space);
604 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
605 zfs_userspace_cb_t, void *);
607 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
608 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
610 typedef struct recvflags {
611 /* print informational messages (ie, -v was specified) */
614 /* the destination is a prefix, not the exact fs (ie, -d) */
618 * Only the tail of the sent snapshot path is appended to the
619 * destination to determine the received snapshot name (ie, -e).
623 /* do not actually do the recv, just check if it would work (ie, -n) */
626 /* rollback/destroy filesystems as necessary (eg, -F) */
629 /* set "canmount=off" on all modified filesystems */
630 boolean_t canmountoff;
632 /* byteswap flag is used internally; callers need not specify */
635 /* do not mount file systems as they are extracted (private) */
639 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *,
642 typedef enum diff_flags {
643 ZFS_DIFF_PARSEABLE = 0x1,
644 ZFS_DIFF_TIMESTAMP = 0x2,
645 ZFS_DIFF_CLASSIFY = 0x4
648 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
652 * Miscellaneous functions.
654 extern const char *zfs_type_to_name(zfs_type_t);
655 extern void zfs_refresh_properties(zfs_handle_t *);
656 extern int zfs_name_valid(const char *, zfs_type_t);
657 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
658 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
660 extern int zfs_spa_version(zfs_handle_t *, int *);
661 extern void zfs_append_partition(const char *path, char *buf, size_t buflen);
662 extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen);
665 * Mount support functions.
667 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
668 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
669 extern int zfs_mount(zfs_handle_t *, const char *, int);
670 extern int zfs_unmount(zfs_handle_t *, const char *, int);
671 extern int zfs_unmountall(zfs_handle_t *, int);
674 * Share support functions.
676 extern boolean_t zfs_is_shared(zfs_handle_t *);
677 extern int zfs_share(zfs_handle_t *);
678 extern int zfs_unshare(zfs_handle_t *);
681 * Protocol-specific share support functions.
683 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
684 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
685 extern int zfs_share_nfs(zfs_handle_t *);
686 extern int zfs_share_smb(zfs_handle_t *);
687 extern int zfs_shareall(zfs_handle_t *);
688 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
689 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
690 extern int zfs_unshareall_nfs(zfs_handle_t *);
691 extern int zfs_unshareall_smb(zfs_handle_t *);
692 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
693 extern int zfs_unshareall(zfs_handle_t *);
694 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
695 void *, void *, int, zfs_share_op_t);
698 * Utility function to convert a number to a human-readable form.
700 extern void zfs_nicenum(uint64_t, char *, size_t);
701 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
704 * Utility functions to run an external process.
706 #define STDOUT_VERBOSE 0x01
707 #define STDERR_VERBOSE 0x02
709 int libzfs_run_process(const char *, char **, int flags);
710 int libzfs_load_module(const char *);
713 * Given a device or file, determine if it is part of a pool.
715 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
719 * Label manipulation.
721 extern int zpool_read_label(int, nvlist_t **);
722 extern int zpool_clear_label(int);
725 * Management interfaces for SMB ACL files
728 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
729 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
730 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
731 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
734 * Enable and disable datasets within a pool by mounting/unmounting and
735 * sharing/unsharing them.
737 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
738 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
741 * Mappings between vdev and FRU.
743 extern void libzfs_fru_refresh(libzfs_handle_t *);
744 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
745 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
746 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
748 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
749 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
755 #endif /* _LIBZFS_H */