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
52 * Default device paths
55 #if defined(__sun__) || defined(__sun)
56 #define DISK_ROOT "/dev/dsk"
57 #define RDISK_ROOT "/dev/rdsk"
58 #define UDISK_ROOT RDISK_ROOT
59 #define FIRST_SLICE "s0"
60 #define BACKUP_SLICE "s2"
64 #define DISK_ROOT "/dev"
65 #define RDISK_ROOT DISK_ROOT
66 #define UDISK_ROOT "/dev/disk"
67 #define FIRST_SLICE "1"
68 #define BACKUP_SLICE ""
75 EZFS_NOMEM
= 2000, /* out of memory */
76 EZFS_BADPROP
, /* invalid property value */
77 EZFS_PROPREADONLY
, /* cannot set readonly property */
78 EZFS_PROPTYPE
, /* property does not apply to dataset type */
79 EZFS_PROPNONINHERIT
, /* property is not inheritable */
80 EZFS_PROPSPACE
, /* bad quota or reservation */
81 EZFS_BADTYPE
, /* dataset is not of appropriate type */
82 EZFS_BUSY
, /* pool or dataset is busy */
83 EZFS_EXISTS
, /* pool or dataset already exists */
84 EZFS_NOENT
, /* no such pool or dataset */
85 EZFS_BADSTREAM
, /* bad backup stream */
86 EZFS_DSREADONLY
, /* dataset is readonly */
87 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
88 EZFS_INVALIDNAME
, /* invalid dataset name */
89 EZFS_BADRESTORE
, /* unable to restore to destination */
90 EZFS_BADBACKUP
, /* backup failed */
91 EZFS_BADTARGET
, /* bad attach/detach/replace target */
92 EZFS_NODEVICE
, /* no such device in pool */
93 EZFS_BADDEV
, /* invalid device to add */
94 EZFS_NOREPLICAS
, /* no valid replicas */
95 EZFS_RESILVERING
, /* currently resilvering */
96 EZFS_BADVERSION
, /* unsupported version */
97 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
98 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
99 EZFS_BADPATH
, /* must be an absolute path */
100 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
101 EZFS_ZONED
, /* used improperly in local zone */
102 EZFS_MOUNTFAILED
, /* failed to mount dataset */
103 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
104 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
105 EZFS_SHARENFSFAILED
, /* share(1M) failed */
106 EZFS_PERM
, /* permission denied */
107 EZFS_NOSPC
, /* out of space */
108 EZFS_FAULT
, /* bad address */
109 EZFS_IO
, /* I/O error */
110 EZFS_INTR
, /* signal received */
111 EZFS_ISSPARE
, /* device is a hot spare */
112 EZFS_INVALCONFIG
, /* invalid vdev configuration */
113 EZFS_RECURSIVE
, /* recursive dependency */
114 EZFS_NOHISTORY
, /* no history object */
115 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
116 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
117 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
118 EZFS_NAMETOOLONG
, /* dataset name is too long */
119 EZFS_OPENFAILED
, /* open of device failed */
120 EZFS_NOCAP
, /* couldn't get capacity */
121 EZFS_LABELFAILED
, /* write of label failed */
122 EZFS_BADWHO
, /* invalid permission who */
123 EZFS_BADPERM
, /* invalid permission */
124 EZFS_BADPERMSET
, /* invalid permission set name */
125 EZFS_NODELEGATION
, /* delegated administration is disabled */
126 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
127 EZFS_SHARESMBFAILED
, /* failed to share over smb */
128 EZFS_BADCACHE
, /* bad cache file */
129 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
130 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
131 EZFS_NOTSUP
, /* ops not supported on this dataset */
132 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
133 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
134 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
135 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
136 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
137 EZFS_PIPEFAILED
, /* pipe create failed */
138 EZFS_THREADCREATEFAILED
, /* thread create failed */
139 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
140 EZFS_SCRUBBING
, /* currently scrubbing */
141 EZFS_NO_SCRUB
, /* no active scrub */
142 EZFS_DIFF
, /* general failure of zfs diff */
143 EZFS_DIFFDATA
, /* bad zfs diff data */
144 EZFS_POOLREADONLY
, /* pool is in read-only mode */
149 * The following data structures are all part
150 * of the zfs_allow_t data structure which is
151 * used for printing 'allow' permissions.
152 * It is a linked list of zfs_allow_t's which
153 * then contain avl tree's for user/group/sets/...
154 * and each one of the entries in those trees have
155 * avl tree's for the permissions they belong to and
156 * whether they are local,descendent or local+descendent
157 * permissions. The AVL trees are used primarily for
158 * sorting purposes, but also so that we can quickly find
159 * a given user and or permission.
161 typedef struct zfs_perm_node
{
163 char z_pname
[MAXPATHLEN
];
166 typedef struct zfs_allow_node
{
168 char z_key
[MAXPATHLEN
]; /* name, such as joe */
169 avl_tree_t z_localdescend
; /* local+descendent perms */
170 avl_tree_t z_local
; /* local permissions */
171 avl_tree_t z_descend
; /* descendent permissions */
174 typedef struct zfs_allow
{
175 struct zfs_allow
*z_next
;
176 char z_setpoint
[MAXPATHLEN
];
178 avl_tree_t z_crperms
;
181 avl_tree_t z_everyone
;
187 typedef struct zfs_handle zfs_handle_t
;
188 typedef struct zpool_handle zpool_handle_t
;
189 typedef struct libzfs_handle libzfs_handle_t
;
192 * Library initialization
194 extern libzfs_handle_t
*libzfs_init(void);
195 extern void libzfs_fini(libzfs_handle_t
*);
197 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
198 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
200 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
202 extern int libzfs_errno(libzfs_handle_t
*);
203 extern const char *libzfs_error_action(libzfs_handle_t
*);
204 extern const char *libzfs_error_description(libzfs_handle_t
*);
205 extern void libzfs_mnttab_init(libzfs_handle_t
*);
206 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
207 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
208 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
210 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
211 const char *, const char *);
212 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
215 * Basic handle functions
217 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
218 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
219 extern void zpool_close(zpool_handle_t
*);
220 extern const char *zpool_get_name(zpool_handle_t
*);
221 extern int zpool_get_state(zpool_handle_t
*);
222 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
223 extern void zpool_free_handles(libzfs_handle_t
*);
226 * Iterate over all active pools in the system.
228 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
229 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
232 * Functions to create and destroy pools
234 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
235 nvlist_t
*, nvlist_t
*);
236 extern int zpool_destroy(zpool_handle_t
*);
237 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
239 typedef struct splitflags
{
240 /* do not split, but return the config that would be split off */
243 /* after splitting, import the pool */
248 * Functions to manipulate pool and vdev state
250 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
);
251 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
253 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
255 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
256 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
257 const char *, nvlist_t
*, int);
258 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
259 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
260 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
263 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
264 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
265 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
267 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
268 boolean_t
*, boolean_t
*);
269 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
270 boolean_t
*, boolean_t
*, boolean_t
*);
271 extern int zpool_label_disk_wait(char *, int);
272 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
275 * Functions to manage pool properties
277 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
278 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
279 size_t proplen
, zprop_source_t
*);
280 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
283 extern const char *zpool_prop_to_name(zpool_prop_t
);
284 extern const char *zpool_prop_values(zpool_prop_t
);
287 * Pool health statistics.
291 * The following correspond to faults as defined in the (fault.fs.zfs.*)
292 * event namespace. Each is associated with a corresponding message ID.
294 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
295 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
296 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
297 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
298 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
299 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
300 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
301 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
302 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
303 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
304 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
305 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
306 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
307 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
310 * These faults have no corresponding message ID. At the time we are
311 * checking the status, the original reason for the FMA fault (I/O or
312 * checksum errors) has been lost.
314 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
315 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
318 * The following are not faults per se, but still an error possibly
319 * requiring administrative attention. There is no corresponding
322 ZPOOL_STATUS_VERSION_OLDER
, /* older on-disk version */
323 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
324 ZPOOL_STATUS_OFFLINE_DEV
, /* device online */
325 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
328 * Finally, the following indicates a healthy pool.
333 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **);
334 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **);
335 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
338 * Statistics and configuration functions.
340 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
341 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
342 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
345 * Import and export functions
347 extern int zpool_export(zpool_handle_t
*, boolean_t
);
348 extern int zpool_export_force(zpool_handle_t
*);
349 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
351 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
355 * Search for pools to import
358 typedef struct importargs
{
359 char **path
; /* a list of paths to search */
360 int paths
; /* number of paths to search */
361 char *poolname
; /* name of a pool to find */
362 uint64_t guid
; /* guid of a pool to find */
363 char *cachefile
; /* cachefile to use for import */
364 int can_be_active
: 1; /* can the pool be active? */
365 int unique
: 1; /* does 'poolname' already exist? */
366 int exists
: 1; /* set on return if pool already exists */
369 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
371 /* legacy pool search routines */
372 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
373 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
377 * Miscellaneous pool functions
381 extern const char *zfs_history_event_names
[LOG_END
];
383 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
385 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
386 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
387 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
388 nvlist_t
***, uint_t
*);
389 extern void zpool_set_history_str(const char *subcommand
, int argc
,
390 char **argv
, char *history_str
);
391 extern int zpool_stage_history(libzfs_handle_t
*, const char *);
392 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, int, int);
393 extern int zpool_events_clear(libzfs_handle_t
*, int *);
394 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
396 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
397 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
398 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
402 * Basic handle manipulations. These functions do not create or destroy the
403 * underlying datasets, only the references to them.
405 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
406 extern void zfs_close(zfs_handle_t
*);
407 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
408 extern const char *zfs_get_name(const zfs_handle_t
*);
409 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
412 * Property management functions. Some functions are shared with the kernel,
413 * and are found in sys/fs/zfs.h.
417 * zfs dataset property management
419 extern const char *zfs_prop_default_string(zfs_prop_t
);
420 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
421 extern const char *zfs_prop_column_name(zfs_prop_t
);
422 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
424 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
425 nvlist_t
*, uint64_t, zfs_handle_t
*, const char *);
427 extern const char *zfs_prop_to_name(zfs_prop_t
);
428 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
429 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
430 zprop_source_t
*, char *, size_t, boolean_t
);
431 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
433 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
434 zprop_source_t
*, char *, size_t);
435 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
436 uint64_t *propvalue
);
437 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
438 char *propbuf
, int proplen
, boolean_t literal
);
439 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
440 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
441 extern const char *zfs_prop_values(zfs_prop_t
);
442 extern int zfs_prop_is_string(zfs_prop_t prop
);
443 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
444 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
446 typedef struct zprop_list
{
449 struct zprop_list
*pl_next
;
452 size_t pl_recvd_width
;
456 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
);
457 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
459 #define ZFS_MOUNTPOINT_NONE "none"
460 #define ZFS_MOUNTPOINT_LEGACY "legacy"
463 * zpool property management
465 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
466 extern const char *zpool_prop_default_string(zpool_prop_t
);
467 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
468 extern const char *zpool_prop_column_name(zpool_prop_t
);
469 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
472 * Functions shared by zfs and zpool property management.
474 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
475 boolean_t ordered
, zfs_type_t type
);
476 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
478 extern void zprop_free_list(zprop_list_t
*);
480 #define ZFS_GET_NCOLS 5
492 * Functions for printing zfs or zpool properties
494 typedef struct zprop_get_cbdata
{
496 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
497 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
498 boolean_t cb_scripted
;
499 boolean_t cb_literal
;
501 zprop_list_t
*cb_proplist
;
503 } zprop_get_cbdata_t
;
505 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
506 const char *, const char *, zprop_source_t
, const char *,
510 * Iterator functions.
512 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
513 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
514 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
515 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
516 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
517 extern int zfs_iter_snapshots(zfs_handle_t
*, zfs_iter_f
, void *);
518 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
520 typedef struct get_all_cb
{
521 zfs_handle_t
**cb_handles
;
524 boolean_t cb_verbose
;
525 int (*cb_getone
)(zfs_handle_t
*, void *);
528 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
529 int libzfs_dataset_cmp(const void *, const void *);
532 * Functions to create and destroy datasets.
534 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
536 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
537 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
538 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
539 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
540 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
541 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
542 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
);
544 typedef struct sendflags
{
545 /* print informational messages (ie, -v was specified) */
548 /* recursive send (ie, -R) */
551 /* for incrementals, do all intermediate snapshots */
552 int doall
: 1; /* (ie, -I) */
554 /* if dataset is a clone, do incremental from its origin */
557 /* do deduplication */
560 /* send properties (ie, -p) */
564 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
566 extern int zfs_send(zfs_handle_t
*zhp
, const char *fromsnap
, const char *tosnap
,
567 sendflags_t flags
, int outfd
, snapfilter_cb_t filter_func
,
568 void *cb_arg
, nvlist_t
**debugnvp
);
570 extern int zfs_promote(zfs_handle_t
*);
571 extern int zfs_hold(zfs_handle_t
*, const char *, const char *, boolean_t
,
572 boolean_t
, boolean_t
, int, uint64_t, uint64_t);
573 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
574 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
576 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
577 uid_t rid
, uint64_t space
);
579 extern int zfs_userspace(zfs_handle_t
*zhp
, zfs_userquota_prop_t type
,
580 zfs_userspace_cb_t func
, void *arg
);
582 typedef struct recvflags
{
583 /* print informational messages (ie, -v was specified) */
586 /* the destination is a prefix, not the exact fs (ie, -d) */
590 * Only the tail of the sent snapshot path is appended to the
591 * destination to determine the received snapshot name (ie, -e).
595 /* do not actually do the recv, just check if it would work (ie, -n) */
598 /* rollback/destroy filesystems as necessary (eg, -F) */
601 /* set "canmount=off" on all modified filesystems */
604 /* byteswap flag is used internally; callers need not specify */
607 /* do not mount file systems as they are extracted (private) */
611 extern int zfs_receive(libzfs_handle_t
*, const char *, recvflags_t
,
614 typedef enum diff_flags
{
615 ZFS_DIFF_PARSEABLE
= 0x1,
616 ZFS_DIFF_TIMESTAMP
= 0x2,
617 ZFS_DIFF_CLASSIFY
= 0x4
620 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
624 * Miscellaneous functions.
626 extern const char *zfs_type_to_name(zfs_type_t
);
627 extern void zfs_refresh_properties(zfs_handle_t
*);
628 extern int zfs_name_valid(const char *, zfs_type_t
);
629 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
630 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
632 extern int zfs_spa_version(zfs_handle_t
*, int *);
633 extern void zfs_append_partition(const char *path
, char *buf
, size_t buflen
);
634 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
637 * Mount support functions.
639 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
640 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
641 extern int zfs_mount(zfs_handle_t
*, const char *, int);
642 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
643 extern int zfs_unmountall(zfs_handle_t
*, int);
646 * Share support functions.
648 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
649 extern int zfs_share(zfs_handle_t
*);
650 extern int zfs_unshare(zfs_handle_t
*);
653 * Protocol-specific share support functions.
655 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
656 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
657 extern int zfs_share_nfs(zfs_handle_t
*);
658 extern int zfs_share_smb(zfs_handle_t
*);
659 extern int zfs_shareall(zfs_handle_t
*);
660 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
661 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
662 extern int zfs_unshareall_nfs(zfs_handle_t
*);
663 extern int zfs_unshareall_smb(zfs_handle_t
*);
664 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
665 extern int zfs_unshareall(zfs_handle_t
*);
666 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
667 void *, void *, int, zfs_share_op_t
);
670 * Utility function to convert a number to a human-readable form.
672 extern void zfs_nicenum(uint64_t, char *, size_t);
673 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
676 * Utility functions to run an external process.
678 #define STDOUT_VERBOSE 0x01
679 #define STDERR_VERBOSE 0x02
681 int libzfs_run_process(const char *, char **, int flags
);
682 int libzfs_load_module(const char *);
685 * Given a device or file, determine if it is part of a pool.
687 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
691 * Label manipulation.
693 extern int zpool_read_label(int, nvlist_t
**);
694 extern int zpool_clear_label(int);
697 * Management interfaces for SMB ACL files
700 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
701 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
702 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
703 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
706 * Enable and disable datasets within a pool by mounting/unmounting and
707 * sharing/unsharing them.
709 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
710 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
713 * Mappings between vdev and FRU.
715 extern void libzfs_fru_refresh(libzfs_handle_t
*);
716 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
717 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
718 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
720 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
721 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
727 #endif /* _LIBZFS_H */