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
57 typedef enum zfs_error
{
58 EZFS_SUCCESS
= 0, /* no error -- success */
59 EZFS_NOMEM
= 2000, /* out of memory */
60 EZFS_BADPROP
, /* invalid property value */
61 EZFS_PROPREADONLY
, /* cannot set readonly property */
62 EZFS_PROPTYPE
, /* property does not apply to dataset type */
63 EZFS_PROPNONINHERIT
, /* property is not inheritable */
64 EZFS_PROPSPACE
, /* bad quota or reservation */
65 EZFS_BADTYPE
, /* dataset is not of appropriate type */
66 EZFS_BUSY
, /* pool or dataset is busy */
67 EZFS_EXISTS
, /* pool or dataset already exists */
68 EZFS_NOENT
, /* no such pool or dataset */
69 EZFS_BADSTREAM
, /* bad backup stream */
70 EZFS_DSREADONLY
, /* dataset is readonly */
71 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
72 EZFS_INVALIDNAME
, /* invalid dataset name */
73 EZFS_BADRESTORE
, /* unable to restore to destination */
74 EZFS_BADBACKUP
, /* backup failed */
75 EZFS_BADTARGET
, /* bad attach/detach/replace target */
76 EZFS_NODEVICE
, /* no such device in pool */
77 EZFS_BADDEV
, /* invalid device to add */
78 EZFS_NOREPLICAS
, /* no valid replicas */
79 EZFS_RESILVERING
, /* currently resilvering */
80 EZFS_BADVERSION
, /* unsupported version */
81 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
82 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
83 EZFS_BADPATH
, /* must be an absolute path */
84 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
85 EZFS_ZONED
, /* used improperly in local zone */
86 EZFS_MOUNTFAILED
, /* failed to mount dataset */
87 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
88 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
89 EZFS_SHARENFSFAILED
, /* share(1M) failed */
90 EZFS_PERM
, /* permission denied */
91 EZFS_NOSPC
, /* out of space */
92 EZFS_FAULT
, /* bad address */
93 EZFS_IO
, /* I/O error */
94 EZFS_INTR
, /* signal received */
95 EZFS_ISSPARE
, /* device is a hot spare */
96 EZFS_INVALCONFIG
, /* invalid vdev configuration */
97 EZFS_RECURSIVE
, /* recursive dependency */
98 EZFS_NOHISTORY
, /* no history object */
99 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
100 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
101 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
102 EZFS_NAMETOOLONG
, /* dataset name is too long */
103 EZFS_OPENFAILED
, /* open of device failed */
104 EZFS_NOCAP
, /* couldn't get capacity */
105 EZFS_LABELFAILED
, /* write of label failed */
106 EZFS_BADWHO
, /* invalid permission who */
107 EZFS_BADPERM
, /* invalid permission */
108 EZFS_BADPERMSET
, /* invalid permission set name */
109 EZFS_NODELEGATION
, /* delegated administration is disabled */
110 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
111 EZFS_SHARESMBFAILED
, /* failed to share over smb */
112 EZFS_BADCACHE
, /* bad cache file */
113 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
114 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
115 EZFS_NOTSUP
, /* ops not supported on this dataset */
116 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
117 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
118 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
119 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
120 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
121 EZFS_PIPEFAILED
, /* pipe create failed */
122 EZFS_THREADCREATEFAILED
, /* thread create failed */
123 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
124 EZFS_SCRUBBING
, /* currently scrubbing */
125 EZFS_NO_SCRUB
, /* no active scrub */
126 EZFS_DIFF
, /* general failure of zfs diff */
127 EZFS_DIFFDATA
, /* bad zfs diff data */
128 EZFS_POOLREADONLY
, /* pool is in read-only mode */
133 * The following data structures are all part
134 * of the zfs_allow_t data structure which is
135 * used for printing 'allow' permissions.
136 * It is a linked list of zfs_allow_t's which
137 * then contain avl tree's for user/group/sets/...
138 * and each one of the entries in those trees have
139 * avl tree's for the permissions they belong to and
140 * whether they are local,descendent or local+descendent
141 * permissions. The AVL trees are used primarily for
142 * sorting purposes, but also so that we can quickly find
143 * a given user and or permission.
145 typedef struct zfs_perm_node
{
147 char z_pname
[MAXPATHLEN
];
150 typedef struct zfs_allow_node
{
152 char z_key
[MAXPATHLEN
]; /* name, such as joe */
153 avl_tree_t z_localdescend
; /* local+descendent perms */
154 avl_tree_t z_local
; /* local permissions */
155 avl_tree_t z_descend
; /* descendent permissions */
158 typedef struct zfs_allow
{
159 struct zfs_allow
*z_next
;
160 char z_setpoint
[MAXPATHLEN
];
162 avl_tree_t z_crperms
;
165 avl_tree_t z_everyone
;
171 typedef struct zfs_handle zfs_handle_t
;
172 typedef struct zpool_handle zpool_handle_t
;
173 typedef struct libzfs_handle libzfs_handle_t
;
176 * Library initialization
178 extern libzfs_handle_t
*libzfs_init(void);
179 extern void libzfs_fini(libzfs_handle_t
*);
181 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
182 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
184 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
186 extern void zfs_save_arguments(int argc
, char **, char *, int);
187 extern int zpool_log_history(libzfs_handle_t
*, const char *);
189 extern int libzfs_errno(libzfs_handle_t
*);
190 extern const char *libzfs_error_action(libzfs_handle_t
*);
191 extern const char *libzfs_error_description(libzfs_handle_t
*);
192 extern void libzfs_mnttab_init(libzfs_handle_t
*);
193 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
194 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
195 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
197 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
198 const char *, const char *);
199 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
202 * Basic handle functions
204 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
205 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
206 extern void zpool_close(zpool_handle_t
*);
207 extern const char *zpool_get_name(zpool_handle_t
*);
208 extern int zpool_get_state(zpool_handle_t
*);
209 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_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
*, const char *);
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
*, 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
, const char *);
347 extern int zpool_export_force(zpool_handle_t
*, const char *);
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
[];
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_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
391 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
392 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
393 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
397 * Basic handle manipulations. These functions do not create or destroy the
398 * underlying datasets, only the references to them.
400 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
401 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
402 extern void zfs_close(zfs_handle_t
*);
403 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
404 extern const char *zfs_get_name(const zfs_handle_t
*);
405 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
408 * Property management functions. Some functions are shared with the kernel,
409 * and are found in sys/fs/zfs.h.
413 * zfs dataset property management
415 extern const char *zfs_prop_default_string(zfs_prop_t
);
416 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
417 extern const char *zfs_prop_column_name(zfs_prop_t
);
418 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
420 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
421 nvlist_t
*, uint64_t, zfs_handle_t
*, const char *);
423 extern const char *zfs_prop_to_name(zfs_prop_t
);
424 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
425 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
426 zprop_source_t
*, char *, size_t, boolean_t
);
427 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
429 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
430 zprop_source_t
*, char *, size_t);
431 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
432 uint64_t *propvalue
);
433 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
434 char *propbuf
, int proplen
, boolean_t literal
);
435 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
436 uint64_t *propvalue
);
437 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
438 char *propbuf
, int proplen
, boolean_t literal
);
439 extern int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
440 char *buf
, size_t len
);
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
*);
450 typedef struct zprop_list
{
453 struct zprop_list
*pl_next
;
456 size_t pl_recvd_width
;
460 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
);
461 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
463 #define ZFS_MOUNTPOINT_NONE "none"
464 #define ZFS_MOUNTPOINT_LEGACY "legacy"
466 #define ZFS_FEATURE_DISABLED "disabled"
467 #define ZFS_FEATURE_ENABLED "enabled"
468 #define ZFS_FEATURE_ACTIVE "active"
470 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
471 #define ZFS_UNSUPPORTED_READONLY "readonly"
474 * zpool property management
476 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
477 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
479 extern const char *zpool_prop_default_string(zpool_prop_t
);
480 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
481 extern const char *zpool_prop_column_name(zpool_prop_t
);
482 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
485 * Functions shared by zfs and zpool property management.
487 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
488 boolean_t ordered
, zfs_type_t type
);
489 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
491 extern void zprop_free_list(zprop_list_t
*);
493 #define ZFS_GET_NCOLS 5
505 * Functions for printing zfs or zpool properties
507 typedef struct zprop_get_cbdata
{
509 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
510 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
511 boolean_t cb_scripted
;
512 boolean_t cb_literal
;
514 zprop_list_t
*cb_proplist
;
516 } zprop_get_cbdata_t
;
518 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
519 const char *, const char *, zprop_source_t
, const char *,
523 * Iterator functions.
525 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
526 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
527 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
528 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
529 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
530 extern int zfs_iter_snapshots(zfs_handle_t
*, zfs_iter_f
, void *);
531 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
532 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
534 typedef struct get_all_cb
{
535 zfs_handle_t
**cb_handles
;
538 boolean_t cb_verbose
;
539 int (*cb_getone
)(zfs_handle_t
*, void *);
542 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
543 int libzfs_dataset_cmp(const void *, const void *);
546 * Functions to create and destroy datasets.
548 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
550 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
551 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
552 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
553 extern int zfs_destroy_snaps_nvl(zfs_handle_t
*, nvlist_t
*, boolean_t
);
554 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
555 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
556 extern int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
558 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
559 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
561 typedef struct sendflags
{
562 /* print informational messages (ie, -v was specified) */
565 /* recursive send (ie, -R) */
568 /* for incrementals, do all intermediate snapshots */
571 /* if dataset is a clone, do incremental from its origin */
572 boolean_t fromorigin
;
574 /* do deduplication */
577 /* send properties (ie, -p) */
580 /* do not send (no-op, ie. -n) */
583 /* parsable verbose output (ie. -P) */
586 /* show progress (ie. -v) */
590 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
592 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
593 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
595 extern int zfs_promote(zfs_handle_t
*);
596 extern int zfs_hold(zfs_handle_t
*, const char *, const char *, boolean_t
,
597 boolean_t
, boolean_t
, int, uint64_t, uint64_t);
598 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
599 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
600 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
602 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
603 uid_t rid
, uint64_t space
);
605 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
606 zfs_userspace_cb_t
, void *);
608 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
609 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
611 typedef struct recvflags
{
612 /* print informational messages (ie, -v was specified) */
615 /* the destination is a prefix, not the exact fs (ie, -d) */
619 * Only the tail of the sent snapshot path is appended to the
620 * destination to determine the received snapshot name (ie, -e).
624 /* do not actually do the recv, just check if it would work (ie, -n) */
627 /* rollback/destroy filesystems as necessary (eg, -F) */
630 /* set "canmount=off" on all modified filesystems */
631 boolean_t canmountoff
;
633 /* byteswap flag is used internally; callers need not specify */
636 /* do not mount file systems as they are extracted (private) */
640 extern int zfs_receive(libzfs_handle_t
*, const char *, recvflags_t
*,
643 typedef enum diff_flags
{
644 ZFS_DIFF_PARSEABLE
= 0x1,
645 ZFS_DIFF_TIMESTAMP
= 0x2,
646 ZFS_DIFF_CLASSIFY
= 0x4
649 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
653 * Miscellaneous functions.
655 extern const char *zfs_type_to_name(zfs_type_t
);
656 extern void zfs_refresh_properties(zfs_handle_t
*);
657 extern int zfs_name_valid(const char *, zfs_type_t
);
658 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
659 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
661 extern int zfs_spa_version(zfs_handle_t
*, int *);
664 * Mount support functions.
666 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
667 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
668 extern int zfs_mount(zfs_handle_t
*, const char *, int);
669 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
670 extern int zfs_unmountall(zfs_handle_t
*, int);
673 * Share support functions.
675 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
676 extern int zfs_share(zfs_handle_t
*);
677 extern int zfs_unshare(zfs_handle_t
*);
680 * Protocol-specific share support functions.
682 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
683 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
684 extern int zfs_share_nfs(zfs_handle_t
*);
685 extern int zfs_share_smb(zfs_handle_t
*);
686 extern int zfs_shareall(zfs_handle_t
*);
687 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
688 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
689 extern int zfs_unshareall_nfs(zfs_handle_t
*);
690 extern int zfs_unshareall_smb(zfs_handle_t
*);
691 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
692 extern int zfs_unshareall(zfs_handle_t
*);
693 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
694 void *, void *, int, zfs_share_op_t
);
697 * When dealing with nvlists, verify() is extremely useful
700 #define verify(EX) ((void)(EX))
702 #define verify(EX) assert(EX)
706 * Utility function to convert a number to a human-readable form.
708 extern void zfs_nicenum(uint64_t, char *, size_t);
709 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
712 * Given a device or file, determine if it is part of a pool.
714 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
718 * Label manipulation.
720 extern int zpool_read_label(int, nvlist_t
**);
721 extern int zpool_clear_label(int);
723 /* is this zvol valid for use as a dump device? */
724 extern int zvol_check_dump_config(char *);
727 * Management interfaces for SMB ACL files
730 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
731 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
732 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
733 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
736 * Enable and disable datasets within a pool by mounting/unmounting and
737 * sharing/unsharing them.
739 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
740 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
743 * Mappings between vdev and FRU.
745 extern void libzfs_fru_refresh(libzfs_handle_t
*);
746 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
747 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
748 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
750 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
751 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
757 #endif /* _LIBZFS_H */