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
57 #define DISK_ROOT "/dev"
58 #define UDISK_ROOT "/dev/disk"
60 #define DEFAULT_IMPORT_PATH_SIZE 8
61 extern char *zpool_default_import_path[DEFAULT_IMPORT_PATH_SIZE];
67 EZFS_NOMEM = 2000, /* out of memory */
68 EZFS_BADPROP, /* invalid property value */
69 EZFS_PROPREADONLY, /* cannot set readonly property */
70 EZFS_PROPTYPE, /* property does not apply to dataset type */
71 EZFS_PROPNONINHERIT, /* property is not inheritable */
72 EZFS_PROPSPACE, /* bad quota or reservation */
73 EZFS_BADTYPE, /* dataset is not of appropriate type */
74 EZFS_BUSY, /* pool or dataset is busy */
75 EZFS_EXISTS, /* pool or dataset already exists */
76 EZFS_NOENT, /* no such pool or dataset */
77 EZFS_BADSTREAM, /* bad backup stream */
78 EZFS_DSREADONLY, /* dataset is readonly */
79 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
80 EZFS_INVALIDNAME, /* invalid dataset name */
81 EZFS_BADRESTORE, /* unable to restore to destination */
82 EZFS_BADBACKUP, /* backup failed */
83 EZFS_BADTARGET, /* bad attach/detach/replace target */
84 EZFS_NODEVICE, /* no such device in pool */
85 EZFS_BADDEV, /* invalid device to add */
86 EZFS_NOREPLICAS, /* no valid replicas */
87 EZFS_RESILVERING, /* currently resilvering */
88 EZFS_BADVERSION, /* unsupported version */
89 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
90 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
91 EZFS_BADPATH, /* must be an absolute path */
92 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
93 EZFS_ZONED, /* used improperly in local zone */
94 EZFS_MOUNTFAILED, /* failed to mount dataset */
95 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
96 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
97 EZFS_SHARENFSFAILED, /* share(1M) failed */
98 EZFS_PERM, /* permission denied */
99 EZFS_NOSPC, /* out of space */
100 EZFS_FAULT, /* bad address */
101 EZFS_IO, /* I/O error */
102 EZFS_INTR, /* signal received */
103 EZFS_ISSPARE, /* device is a hot spare */
104 EZFS_INVALCONFIG, /* invalid vdev configuration */
105 EZFS_RECURSIVE, /* recursive dependency */
106 EZFS_NOHISTORY, /* no history object */
107 EZFS_POOLPROPS, /* couldn't retrieve pool props */
108 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
109 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
110 EZFS_NAMETOOLONG, /* dataset name is too long */
111 EZFS_OPENFAILED, /* open of device failed */
112 EZFS_NOCAP, /* couldn't get capacity */
113 EZFS_LABELFAILED, /* write of label failed */
114 EZFS_BADWHO, /* invalid permission who */
115 EZFS_BADPERM, /* invalid permission */
116 EZFS_BADPERMSET, /* invalid permission set name */
117 EZFS_NODELEGATION, /* delegated administration is disabled */
118 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
119 EZFS_SHARESMBFAILED, /* failed to share over smb */
120 EZFS_BADCACHE, /* bad cache file */
121 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
122 EZFS_VDEVNOTSUP, /* unsupported vdev type */
123 EZFS_NOTSUP, /* ops not supported on this dataset */
124 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
125 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
126 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
127 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
128 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
129 EZFS_PIPEFAILED, /* pipe create failed */
130 EZFS_THREADCREATEFAILED, /* thread create failed */
131 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
132 EZFS_SCRUBBING, /* currently scrubbing */
133 EZFS_NO_SCRUB, /* no active scrub */
134 EZFS_DIFF, /* general failure of zfs diff */
135 EZFS_DIFFDATA, /* bad zfs diff data */
136 EZFS_POOLREADONLY, /* pool is in read-only mode */
141 * The following data structures are all part
142 * of the zfs_allow_t data structure which is
143 * used for printing 'allow' permissions.
144 * It is a linked list of zfs_allow_t's which
145 * then contain avl tree's for user/group/sets/...
146 * and each one of the entries in those trees have
147 * avl tree's for the permissions they belong to and
148 * whether they are local,descendent or local+descendent
149 * permissions. The AVL trees are used primarily for
150 * sorting purposes, but also so that we can quickly find
151 * a given user and or permission.
153 typedef struct zfs_perm_node {
155 char z_pname[MAXPATHLEN];
158 typedef struct zfs_allow_node {
160 char z_key[MAXPATHLEN]; /* name, such as joe */
161 avl_tree_t z_localdescend; /* local+descendent perms */
162 avl_tree_t z_local; /* local permissions */
163 avl_tree_t z_descend; /* descendent permissions */
166 typedef struct zfs_allow {
167 struct zfs_allow *z_next;
168 char z_setpoint[MAXPATHLEN];
170 avl_tree_t z_crperms;
173 avl_tree_t z_everyone;
179 typedef struct zfs_handle zfs_handle_t;
180 typedef struct zpool_handle zpool_handle_t;
181 typedef struct libzfs_handle libzfs_handle_t;
184 * Library initialization
186 extern libzfs_handle_t *libzfs_init(void);
187 extern void libzfs_fini(libzfs_handle_t *);
189 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
190 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
192 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
194 extern int libzfs_errno(libzfs_handle_t *);
195 extern const char *libzfs_error_action(libzfs_handle_t *);
196 extern const char *libzfs_error_description(libzfs_handle_t *);
197 extern void libzfs_mnttab_init(libzfs_handle_t *);
198 extern void libzfs_mnttab_fini(libzfs_handle_t *);
199 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
200 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
202 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
203 const char *, const char *);
204 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
207 * Basic handle functions
209 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
210 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
211 extern void zpool_close(zpool_handle_t *);
212 extern const char *zpool_get_name(zpool_handle_t *);
213 extern int zpool_get_state(zpool_handle_t *);
214 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
215 extern void zpool_free_handles(libzfs_handle_t *);
218 * Iterate over all active pools in the system.
220 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
221 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
224 * Functions to create and destroy pools
226 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
227 nvlist_t *, nvlist_t *);
228 extern int zpool_destroy(zpool_handle_t *);
229 extern int zpool_add(zpool_handle_t *, nvlist_t *);
231 typedef struct splitflags {
232 /* do not split, but return the config that would be split off */
235 /* after splitting, import the pool */
240 * Functions to manipulate pool and vdev state
242 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
243 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
244 extern int zpool_reguid(zpool_handle_t *);
245 extern int zpool_reopen(zpool_handle_t *);
247 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
249 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
250 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
251 const char *, nvlist_t *, int);
252 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
253 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
254 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
257 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
258 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
259 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
261 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
262 boolean_t *, boolean_t *);
263 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
264 boolean_t *, boolean_t *, boolean_t *);
265 extern int zpool_label_disk_wait(char *, int);
266 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
269 * Functions to manage pool properties
271 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
272 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
273 size_t proplen, zprop_source_t *);
274 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
277 extern const char *zpool_prop_to_name(zpool_prop_t);
278 extern const char *zpool_prop_values(zpool_prop_t);
281 * Pool health statistics.
285 * The following correspond to faults as defined in the (fault.fs.zfs.*)
286 * event namespace. Each is associated with a corresponding message ID.
288 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
289 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
290 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
291 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
292 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
293 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
294 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
295 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
296 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
297 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
298 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
299 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
300 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
301 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
304 * These faults have no corresponding message ID. At the time we are
305 * checking the status, the original reason for the FMA fault (I/O or
306 * checksum errors) has been lost.
308 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
309 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
312 * The following are not faults per se, but still an error possibly
313 * requiring administrative attention. There is no corresponding
316 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */
317 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
318 ZPOOL_STATUS_OFFLINE_DEV, /* device online */
319 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
322 * Finally, the following indicates a healthy pool.
327 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
328 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
329 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
332 * Statistics and configuration functions.
334 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
335 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
336 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
339 * Import and export functions
341 extern int zpool_export(zpool_handle_t *, boolean_t);
342 extern int zpool_export_force(zpool_handle_t *);
343 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
345 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
349 * Search for pools to import
352 typedef struct importargs {
353 char **path; /* a list of paths to search */
354 int paths; /* number of paths to search */
355 char *poolname; /* name of a pool to find */
356 uint64_t guid; /* guid of a pool to find */
357 char *cachefile; /* cachefile to use for import */
358 int can_be_active : 1; /* can the pool be active? */
359 int unique : 1; /* does 'poolname' already exist? */
360 int exists : 1; /* set on return if pool already exists */
363 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
365 /* legacy pool search routines */
366 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
367 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
371 * Miscellaneous pool functions
375 extern const char *zfs_history_event_names[LOG_END];
377 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
379 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
380 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
381 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
382 nvlist_t ***, uint_t *);
383 extern void zpool_set_history_str(const char *subcommand, int argc,
384 char **argv, char *history_str);
385 extern int zpool_stage_history(libzfs_handle_t *, const char *);
386 extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, int, int);
387 extern int zpool_events_clear(libzfs_handle_t *, int *);
388 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
390 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
391 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
392 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
396 * Basic handle manipulations. These functions do not create or destroy the
397 * underlying datasets, only the references to them.
399 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
400 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
401 extern void zfs_close(zfs_handle_t *);
402 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
403 extern const char *zfs_get_name(const zfs_handle_t *);
404 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
407 * Property management functions. Some functions are shared with the kernel,
408 * and are found in sys/fs/zfs.h.
412 * zfs dataset property management
414 extern const char *zfs_prop_default_string(zfs_prop_t);
415 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
416 extern const char *zfs_prop_column_name(zfs_prop_t);
417 extern boolean_t zfs_prop_align_right(zfs_prop_t);
419 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
420 nvlist_t *, uint64_t, zfs_handle_t *, const char *);
422 extern const char *zfs_prop_to_name(zfs_prop_t);
423 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
424 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
425 zprop_source_t *, char *, size_t, boolean_t);
426 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
428 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
429 zprop_source_t *, char *, size_t);
430 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
431 uint64_t *propvalue);
432 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
433 char *propbuf, int proplen, boolean_t literal);
434 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
435 uint64_t *propvalue);
436 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
437 char *propbuf, int proplen, boolean_t literal);
438 extern int zfs_get_snapused_int(zfs_handle_t *firstsnap, zfs_handle_t *lastsnap,
440 extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **);
441 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
442 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
443 extern const char *zfs_prop_values(zfs_prop_t);
444 extern int zfs_prop_is_string(zfs_prop_t prop);
445 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
446 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
447 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
449 typedef struct zprop_list {
452 struct zprop_list *pl_next;
455 size_t pl_recvd_width;
459 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t);
460 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
462 #define ZFS_MOUNTPOINT_NONE "none"
463 #define ZFS_MOUNTPOINT_LEGACY "legacy"
466 * zpool property management
468 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
469 extern const char *zpool_prop_default_string(zpool_prop_t);
470 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
471 extern const char *zpool_prop_column_name(zpool_prop_t);
472 extern boolean_t zpool_prop_align_right(zpool_prop_t);
475 * Functions shared by zfs and zpool property management.
477 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
478 boolean_t ordered, zfs_type_t type);
479 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
481 extern void zprop_free_list(zprop_list_t *);
483 #define ZFS_GET_NCOLS 5
495 * Functions for printing zfs or zpool properties
497 typedef struct zprop_get_cbdata {
499 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
500 int cb_colwidths[ZFS_GET_NCOLS + 1];
501 boolean_t cb_scripted;
502 boolean_t cb_literal;
504 zprop_list_t *cb_proplist;
506 } zprop_get_cbdata_t;
508 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
509 const char *, const char *, zprop_source_t, const char *,
513 * Iterator functions.
515 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
516 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
517 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
518 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
519 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
520 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
521 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
522 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
524 typedef struct get_all_cb {
525 zfs_handle_t **cb_handles;
528 boolean_t cb_verbose;
529 int (*cb_getone)(zfs_handle_t *, void *);
532 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
533 int libzfs_dataset_cmp(const void *, const void *);
536 * Functions to create and destroy datasets.
538 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
540 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
541 extern int zfs_destroy(zfs_handle_t *, boolean_t);
542 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
543 extern int zfs_destroy_snaps_nvl(zfs_handle_t *, nvlist_t *, boolean_t);
544 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
545 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
546 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
547 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
549 typedef struct sendflags {
550 /* print informational messages (ie, -v was specified) */
553 /* recursive send (ie, -R) */
556 /* for incrementals, do all intermediate snapshots */
559 /* if dataset is a clone, do incremental from its origin */
560 boolean_t fromorigin;
562 /* do deduplication */
565 /* send properties (ie, -p) */
568 /* do not send (no-op, ie. -n) */
571 /* parsable verbose output (ie. -P) */
574 /* show progress (ie. -v) */
578 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
580 extern int zfs_send(zfs_handle_t *, const char *, const char *,
581 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
583 extern int zfs_promote(zfs_handle_t *);
584 extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t,
585 boolean_t, boolean_t, int, uint64_t, uint64_t);
586 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
587 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
588 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
590 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
591 uid_t rid, uint64_t space);
593 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
594 zfs_userspace_cb_t, void *);
596 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
597 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
599 typedef struct recvflags {
600 /* print informational messages (ie, -v was specified) */
603 /* the destination is a prefix, not the exact fs (ie, -d) */
607 * Only the tail of the sent snapshot path is appended to the
608 * destination to determine the received snapshot name (ie, -e).
612 /* do not actually do the recv, just check if it would work (ie, -n) */
615 /* rollback/destroy filesystems as necessary (eg, -F) */
618 /* set "canmount=off" on all modified filesystems */
619 boolean_t canmountoff;
621 /* byteswap flag is used internally; callers need not specify */
624 /* do not mount file systems as they are extracted (private) */
628 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *,
631 typedef enum diff_flags {
632 ZFS_DIFF_PARSEABLE = 0x1,
633 ZFS_DIFF_TIMESTAMP = 0x2,
634 ZFS_DIFF_CLASSIFY = 0x4
637 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
641 * Miscellaneous functions.
643 extern const char *zfs_type_to_name(zfs_type_t);
644 extern void zfs_refresh_properties(zfs_handle_t *);
645 extern int zfs_name_valid(const char *, zfs_type_t);
646 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
647 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
649 extern int zfs_spa_version(zfs_handle_t *, int *);
650 extern int zfs_append_partition(char *path, size_t max_len);
651 extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen);
652 extern int zfs_strcmp_pathname(char *name, char *cmp_name, int wholedisk);
655 * Mount support functions.
657 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
658 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
659 extern int zfs_mount(zfs_handle_t *, const char *, int);
660 extern int zfs_unmount(zfs_handle_t *, const char *, int);
661 extern int zfs_unmountall(zfs_handle_t *, int);
664 * Share support functions.
666 extern boolean_t zfs_is_shared(zfs_handle_t *);
667 extern int zfs_share(zfs_handle_t *);
668 extern int zfs_unshare(zfs_handle_t *);
671 * Protocol-specific share support functions.
673 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
674 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
675 extern int zfs_share_nfs(zfs_handle_t *);
676 extern int zfs_share_smb(zfs_handle_t *);
677 extern int zfs_shareall(zfs_handle_t *);
678 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
679 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
680 extern int zfs_unshareall_nfs(zfs_handle_t *);
681 extern int zfs_unshareall_smb(zfs_handle_t *);
682 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
683 extern int zfs_unshareall(zfs_handle_t *);
684 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
685 void *, void *, int, zfs_share_op_t);
688 * Utility function to convert a number to a human-readable form.
690 extern void zfs_nicenum(uint64_t, char *, size_t);
691 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
694 * Utility functions to run an external process.
696 #define STDOUT_VERBOSE 0x01
697 #define STDERR_VERBOSE 0x02
699 int libzfs_run_process(const char *, char **, int flags);
700 int libzfs_load_module(const char *);
703 * Given a device or file, determine if it is part of a pool.
705 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
709 * Label manipulation.
711 extern int zpool_read_label(int, nvlist_t **);
712 extern int zpool_clear_label(int);
715 * Management interfaces for SMB ACL files
718 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
719 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
720 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
721 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
724 * Enable and disable datasets within a pool by mounting/unmounting and
725 * sharing/unsharing them.
727 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
728 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
731 * Mappings between vdev and FRU.
733 extern void libzfs_fru_refresh(libzfs_handle_t *);
734 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
735 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
736 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
738 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
739 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
745 #endif /* _LIBZFS_H */