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.
30 #include <libnvpair.h>
31 #include <sys/mnttab.h>
32 #include <sys/param.h>
33 #include <sys/types.h>
34 #include <sys/varargs.h>
35 #include <sys/fs/zfs.h>
44 * Miscellaneous ZFS constants
46 #define ZFS_MAXNAMELEN MAXNAMELEN
47 #define ZPOOL_MAXNAMELEN MAXNAMELEN
48 #define ZFS_MAXPROPLEN MAXPATHLEN
49 #define ZPOOL_MAXPROPLEN MAXPATHLEN
55 EZFS_NOMEM
= 2000, /* out of memory */
56 EZFS_BADPROP
, /* invalid property value */
57 EZFS_PROPREADONLY
, /* cannot set readonly property */
58 EZFS_PROPTYPE
, /* property does not apply to dataset type */
59 EZFS_PROPNONINHERIT
, /* property is not inheritable */
60 EZFS_PROPSPACE
, /* bad quota or reservation */
61 EZFS_BADTYPE
, /* dataset is not of appropriate type */
62 EZFS_BUSY
, /* pool or dataset is busy */
63 EZFS_EXISTS
, /* pool or dataset already exists */
64 EZFS_NOENT
, /* no such pool or dataset */
65 EZFS_BADSTREAM
, /* bad backup stream */
66 EZFS_DSREADONLY
, /* dataset is readonly */
67 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
68 EZFS_INVALIDNAME
, /* invalid dataset name */
69 EZFS_BADRESTORE
, /* unable to restore to destination */
70 EZFS_BADBACKUP
, /* backup failed */
71 EZFS_BADTARGET
, /* bad attach/detach/replace target */
72 EZFS_NODEVICE
, /* no such device in pool */
73 EZFS_BADDEV
, /* invalid device to add */
74 EZFS_NOREPLICAS
, /* no valid replicas */
75 EZFS_RESILVERING
, /* currently resilvering */
76 EZFS_BADVERSION
, /* unsupported version */
77 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
78 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
79 EZFS_BADPATH
, /* must be an absolute path */
80 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
81 EZFS_ZONED
, /* used improperly in local zone */
82 EZFS_MOUNTFAILED
, /* failed to mount dataset */
83 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
84 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
85 EZFS_SHARENFSFAILED
, /* share(1M) failed */
86 EZFS_PERM
, /* permission denied */
87 EZFS_NOSPC
, /* out of space */
88 EZFS_FAULT
, /* bad address */
89 EZFS_IO
, /* I/O error */
90 EZFS_INTR
, /* signal received */
91 EZFS_ISSPARE
, /* device is a hot spare */
92 EZFS_INVALCONFIG
, /* invalid vdev configuration */
93 EZFS_RECURSIVE
, /* recursive dependency */
94 EZFS_NOHISTORY
, /* no history object */
95 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
96 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
97 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
98 EZFS_NAMETOOLONG
, /* dataset name is too long */
99 EZFS_OPENFAILED
, /* open of device failed */
100 EZFS_NOCAP
, /* couldn't get capacity */
101 EZFS_LABELFAILED
, /* write of label failed */
102 EZFS_BADWHO
, /* invalid permission who */
103 EZFS_BADPERM
, /* invalid permission */
104 EZFS_BADPERMSET
, /* invalid permission set name */
105 EZFS_NODELEGATION
, /* delegated administration is disabled */
106 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
107 EZFS_SHARESMBFAILED
, /* failed to share over smb */
108 EZFS_BADCACHE
, /* bad cache file */
109 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
110 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
111 EZFS_NOTSUP
, /* ops not supported on this dataset */
112 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
113 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
114 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
115 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
116 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
117 EZFS_PIPEFAILED
, /* pipe create failed */
118 EZFS_THREADCREATEFAILED
, /* thread create failed */
119 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
120 EZFS_SCRUBBING
, /* currently scrubbing */
121 EZFS_NO_SCRUB
, /* no active scrub */
122 EZFS_DIFF
, /* general failure of zfs diff */
123 EZFS_DIFFDATA
, /* bad zfs diff data */
124 EZFS_POOLREADONLY
, /* pool is in read-only mode */
129 * The following data structures are all part
130 * of the zfs_allow_t data structure which is
131 * used for printing 'allow' permissions.
132 * It is a linked list of zfs_allow_t's which
133 * then contain avl tree's for user/group/sets/...
134 * and each one of the entries in those trees have
135 * avl tree's for the permissions they belong to and
136 * whether they are local,descendent or local+descendent
137 * permissions. The AVL trees are used primarily for
138 * sorting purposes, but also so that we can quickly find
139 * a given user and or permission.
141 typedef struct zfs_perm_node
{
143 char z_pname
[MAXPATHLEN
];
146 typedef struct zfs_allow_node
{
148 char z_key
[MAXPATHLEN
]; /* name, such as joe */
149 avl_tree_t z_localdescend
; /* local+descendent perms */
150 avl_tree_t z_local
; /* local permissions */
151 avl_tree_t z_descend
; /* descendent permissions */
154 typedef struct zfs_allow
{
155 struct zfs_allow
*z_next
;
156 char z_setpoint
[MAXPATHLEN
];
158 avl_tree_t z_crperms
;
161 avl_tree_t z_everyone
;
167 typedef struct zfs_handle zfs_handle_t
;
168 typedef struct zpool_handle zpool_handle_t
;
169 typedef struct libzfs_handle libzfs_handle_t
;
172 * Library initialization
174 extern libzfs_handle_t
*libzfs_init(void);
175 extern void libzfs_fini(libzfs_handle_t
*);
177 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
178 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
180 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
182 extern int libzfs_errno(libzfs_handle_t
*);
183 extern const char *libzfs_error_action(libzfs_handle_t
*);
184 extern const char *libzfs_error_description(libzfs_handle_t
*);
185 extern void libzfs_mnttab_init(libzfs_handle_t
*);
186 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
187 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
188 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
190 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
191 const char *, const char *);
192 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
195 * Basic handle functions
197 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
198 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
199 extern void zpool_close(zpool_handle_t
*);
200 extern const char *zpool_get_name(zpool_handle_t
*);
201 extern int zpool_get_state(zpool_handle_t
*);
202 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
203 extern void zpool_free_handles(libzfs_handle_t
*);
206 * Iterate over all active pools in the system.
208 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
209 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
212 * Functions to create and destroy pools
214 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
215 nvlist_t
*, nvlist_t
*);
216 extern int zpool_destroy(zpool_handle_t
*);
217 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
219 typedef struct splitflags
{
220 /* do not split, but return the config that would be split off */
223 /* after splitting, import the pool */
228 * Functions to manipulate pool and vdev state
230 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
);
231 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
233 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
235 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
236 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
237 const char *, nvlist_t
*, int);
238 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
239 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
240 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
243 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
244 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
245 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
247 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
248 boolean_t
*, boolean_t
*);
249 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
250 boolean_t
*, boolean_t
*, boolean_t
*);
251 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
254 * Functions to manage pool properties
256 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
257 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
258 size_t proplen
, zprop_source_t
*);
259 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
262 extern const char *zpool_prop_to_name(zpool_prop_t
);
263 extern const char *zpool_prop_values(zpool_prop_t
);
266 * Pool health statistics.
270 * The following correspond to faults as defined in the (fault.fs.zfs.*)
271 * event namespace. Each is associated with a corresponding message ID.
273 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
274 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
275 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
276 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
277 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
278 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
279 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
280 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
281 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
282 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
283 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
284 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
285 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
286 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
289 * These faults have no corresponding message ID. At the time we are
290 * checking the status, the original reason for the FMA fault (I/O or
291 * checksum errors) has been lost.
293 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
294 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
297 * The following are not faults per se, but still an error possibly
298 * requiring administrative attention. There is no corresponding
301 ZPOOL_STATUS_VERSION_OLDER
, /* older on-disk version */
302 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
303 ZPOOL_STATUS_OFFLINE_DEV
, /* device online */
304 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
307 * Finally, the following indicates a healthy pool.
312 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **);
313 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **);
314 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
317 * Statistics and configuration functions.
319 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
320 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
321 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
324 * Import and export functions
326 extern int zpool_export(zpool_handle_t
*, boolean_t
);
327 extern int zpool_export_force(zpool_handle_t
*);
328 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
330 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
334 * Search for pools to import
337 typedef struct importargs
{
338 char **path
; /* a list of paths to search */
339 int paths
; /* number of paths to search */
340 char *poolname
; /* name of a pool to find */
341 uint64_t guid
; /* guid of a pool to find */
342 char *cachefile
; /* cachefile to use for import */
343 int can_be_active
: 1; /* can the pool be active? */
344 int unique
: 1; /* does 'poolname' already exist? */
345 int exists
: 1; /* set on return if pool already exists */
348 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
350 /* legacy pool search routines */
351 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
352 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
356 * Miscellaneous pool functions
360 extern const char *zfs_history_event_names
[LOG_END
];
362 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
364 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
365 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
366 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
367 nvlist_t
***, uint_t
*);
368 extern void zpool_set_history_str(const char *subcommand
, int argc
,
369 char **argv
, char *history_str
);
370 extern int zpool_stage_history(libzfs_handle_t
*, const char *);
371 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, int, int);
372 extern int zpool_events_clear(libzfs_handle_t
*, int *);
373 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
375 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
376 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
377 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
381 * Basic handle manipulations. These functions do not create or destroy the
382 * underlying datasets, only the references to them.
384 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
385 extern void zfs_close(zfs_handle_t
*);
386 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
387 extern const char *zfs_get_name(const zfs_handle_t
*);
388 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
391 * Property management functions. Some functions are shared with the kernel,
392 * and are found in sys/fs/zfs.h.
396 * zfs dataset property management
398 extern const char *zfs_prop_default_string(zfs_prop_t
);
399 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
400 extern const char *zfs_prop_column_name(zfs_prop_t
);
401 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
403 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
404 nvlist_t
*, uint64_t, zfs_handle_t
*, const char *);
406 extern const char *zfs_prop_to_name(zfs_prop_t
);
407 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
408 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
409 zprop_source_t
*, char *, size_t, boolean_t
);
410 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
412 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
413 zprop_source_t
*, char *, size_t);
414 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
415 uint64_t *propvalue
);
416 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
417 char *propbuf
, int proplen
, boolean_t literal
);
418 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
419 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
420 extern const char *zfs_prop_values(zfs_prop_t
);
421 extern int zfs_prop_is_string(zfs_prop_t prop
);
422 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
423 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
425 typedef struct zprop_list
{
428 struct zprop_list
*pl_next
;
431 size_t pl_recvd_width
;
435 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
);
436 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
438 #define ZFS_MOUNTPOINT_NONE "none"
439 #define ZFS_MOUNTPOINT_LEGACY "legacy"
442 * zpool property management
444 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
445 extern const char *zpool_prop_default_string(zpool_prop_t
);
446 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
447 extern const char *zpool_prop_column_name(zpool_prop_t
);
448 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
451 * Functions shared by zfs and zpool property management.
453 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
454 boolean_t ordered
, zfs_type_t type
);
455 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
457 extern void zprop_free_list(zprop_list_t
*);
459 #define ZFS_GET_NCOLS 5
471 * Functions for printing zfs or zpool properties
473 typedef struct zprop_get_cbdata
{
475 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
476 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
477 boolean_t cb_scripted
;
478 boolean_t cb_literal
;
480 zprop_list_t
*cb_proplist
;
482 } zprop_get_cbdata_t
;
484 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
485 const char *, const char *, zprop_source_t
, const char *,
489 * Iterator functions.
491 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
492 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
493 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
494 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
495 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
496 extern int zfs_iter_snapshots(zfs_handle_t
*, zfs_iter_f
, void *);
497 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
499 typedef struct get_all_cb
{
500 zfs_handle_t
**cb_handles
;
503 boolean_t cb_verbose
;
504 int (*cb_getone
)(zfs_handle_t
*, void *);
507 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
508 int libzfs_dataset_cmp(const void *, const void *);
511 * Functions to create and destroy datasets.
513 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
515 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
516 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
517 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
518 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
519 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
520 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
521 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
);
523 typedef struct sendflags
{
524 /* print informational messages (ie, -v was specified) */
527 /* recursive send (ie, -R) */
530 /* for incrementals, do all intermediate snapshots */
531 int doall
: 1; /* (ie, -I) */
533 /* if dataset is a clone, do incremental from its origin */
536 /* do deduplication */
539 /* send properties (ie, -p) */
543 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
545 extern int zfs_send(zfs_handle_t
*zhp
, const char *fromsnap
, const char *tosnap
,
546 sendflags_t flags
, int outfd
, snapfilter_cb_t filter_func
,
547 void *cb_arg
, nvlist_t
**debugnvp
);
549 extern int zfs_promote(zfs_handle_t
*);
550 extern int zfs_hold(zfs_handle_t
*, const char *, const char *, boolean_t
,
551 boolean_t
, boolean_t
, int, uint64_t, uint64_t);
552 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
553 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
555 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
556 uid_t rid
, uint64_t space
);
558 extern int zfs_userspace(zfs_handle_t
*zhp
, zfs_userquota_prop_t type
,
559 zfs_userspace_cb_t func
, void *arg
);
561 typedef struct recvflags
{
562 /* print informational messages (ie, -v was specified) */
565 /* the destination is a prefix, not the exact fs (ie, -d) */
569 * Only the tail of the sent snapshot path is appended to the
570 * destination to determine the received snapshot name (ie, -e).
574 /* do not actually do the recv, just check if it would work (ie, -n) */
577 /* rollback/destroy filesystems as necessary (eg, -F) */
580 /* set "canmount=off" on all modified filesystems */
583 /* byteswap flag is used internally; callers need not specify */
586 /* do not mount file systems as they are extracted (private) */
590 extern int zfs_receive(libzfs_handle_t
*, const char *, recvflags_t
,
593 typedef enum diff_flags
{
594 ZFS_DIFF_PARSEABLE
= 0x1,
595 ZFS_DIFF_TIMESTAMP
= 0x2,
596 ZFS_DIFF_CLASSIFY
= 0x4
599 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
603 * Miscellaneous functions.
605 extern const char *zfs_type_to_name(zfs_type_t
);
606 extern void zfs_refresh_properties(zfs_handle_t
*);
607 extern int zfs_name_valid(const char *, zfs_type_t
);
608 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
609 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
611 extern int zfs_spa_version(zfs_handle_t
*, int *);
614 * Mount support functions.
616 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
617 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
618 extern int zfs_mount(zfs_handle_t
*, const char *, int);
619 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
620 extern int zfs_unmountall(zfs_handle_t
*, int);
623 * Share support functions.
625 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
626 extern int zfs_share(zfs_handle_t
*);
627 extern int zfs_unshare(zfs_handle_t
*);
630 * Protocol-specific share support functions.
632 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
633 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
634 extern int zfs_share_nfs(zfs_handle_t
*);
635 extern int zfs_share_smb(zfs_handle_t
*);
636 extern int zfs_shareall(zfs_handle_t
*);
637 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
638 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
639 extern int zfs_unshareall_nfs(zfs_handle_t
*);
640 extern int zfs_unshareall_smb(zfs_handle_t
*);
641 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
642 extern int zfs_unshareall(zfs_handle_t
*);
643 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
644 void *, void *, int, zfs_share_op_t
);
647 * Utility function to convert a number to a human-readable form.
649 extern void zfs_nicenum(uint64_t, char *, size_t);
650 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
653 * Given a device or file, determine if it is part of a pool.
655 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
659 * Label manipulation.
661 extern int zpool_read_label(int, nvlist_t
**);
662 extern int zpool_clear_label(int);
664 /* is this zvol valid for use as a dump device? */
665 extern int zvol_check_dump_config(char *);
668 * Management interfaces for SMB ACL files
671 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
672 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
673 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
674 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
677 * Enable and disable datasets within a pool by mounting/unmounting and
678 * sharing/unsharing them.
680 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
681 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
684 * Mappings between vdev and FRU.
686 extern void libzfs_fru_refresh(libzfs_handle_t
*);
687 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
688 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
689 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
691 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
692 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
698 #endif /* _LIBZFS_H */