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) 2011 by Delphix. All rights reserved.
32 #include <libnvpair.h>
33 #include <sys/mnttab.h>
34 #include <sys/param.h>
35 #include <sys/types.h>
36 #include <sys/varargs.h>
37 #include <sys/fs/zfs.h>
46 * Miscellaneous ZFS constants
48 #define ZFS_MAXNAMELEN MAXNAMELEN
49 #define ZPOOL_MAXNAMELEN MAXNAMELEN
50 #define ZFS_MAXPROPLEN MAXPATHLEN
51 #define ZPOOL_MAXPROPLEN MAXPATHLEN
54 * Default device paths
57 #if defined(__sun__) || defined(__sun)
58 #define DISK_ROOT "/dev/dsk"
59 #define RDISK_ROOT "/dev/rdsk"
60 #define UDISK_ROOT RDISK_ROOT
61 #define FIRST_SLICE "s0"
62 #define BACKUP_SLICE "s2"
66 #define DISK_ROOT "/dev"
67 #define RDISK_ROOT DISK_ROOT
68 #define UDISK_ROOT "/dev/disk"
69 #define FIRST_SLICE "1"
70 #define BACKUP_SLICE ""
77 EZFS_NOMEM
= 2000, /* out of memory */
78 EZFS_BADPROP
, /* invalid property value */
79 EZFS_PROPREADONLY
, /* cannot set readonly property */
80 EZFS_PROPTYPE
, /* property does not apply to dataset type */
81 EZFS_PROPNONINHERIT
, /* property is not inheritable */
82 EZFS_PROPSPACE
, /* bad quota or reservation */
83 EZFS_BADTYPE
, /* dataset is not of appropriate type */
84 EZFS_BUSY
, /* pool or dataset is busy */
85 EZFS_EXISTS
, /* pool or dataset already exists */
86 EZFS_NOENT
, /* no such pool or dataset */
87 EZFS_BADSTREAM
, /* bad backup stream */
88 EZFS_DSREADONLY
, /* dataset is readonly */
89 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
90 EZFS_INVALIDNAME
, /* invalid dataset name */
91 EZFS_BADRESTORE
, /* unable to restore to destination */
92 EZFS_BADBACKUP
, /* backup failed */
93 EZFS_BADTARGET
, /* bad attach/detach/replace target */
94 EZFS_NODEVICE
, /* no such device in pool */
95 EZFS_BADDEV
, /* invalid device to add */
96 EZFS_NOREPLICAS
, /* no valid replicas */
97 EZFS_RESILVERING
, /* currently resilvering */
98 EZFS_BADVERSION
, /* unsupported version */
99 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
100 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
101 EZFS_BADPATH
, /* must be an absolute path */
102 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
103 EZFS_ZONED
, /* used improperly in local zone */
104 EZFS_MOUNTFAILED
, /* failed to mount dataset */
105 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
106 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
107 EZFS_SHARENFSFAILED
, /* share(1M) failed */
108 EZFS_PERM
, /* permission denied */
109 EZFS_NOSPC
, /* out of space */
110 EZFS_FAULT
, /* bad address */
111 EZFS_IO
, /* I/O error */
112 EZFS_INTR
, /* signal received */
113 EZFS_ISSPARE
, /* device is a hot spare */
114 EZFS_INVALCONFIG
, /* invalid vdev configuration */
115 EZFS_RECURSIVE
, /* recursive dependency */
116 EZFS_NOHISTORY
, /* no history object */
117 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
118 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
119 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
120 EZFS_NAMETOOLONG
, /* dataset name is too long */
121 EZFS_OPENFAILED
, /* open of device failed */
122 EZFS_NOCAP
, /* couldn't get capacity */
123 EZFS_LABELFAILED
, /* write of label failed */
124 EZFS_BADWHO
, /* invalid permission who */
125 EZFS_BADPERM
, /* invalid permission */
126 EZFS_BADPERMSET
, /* invalid permission set name */
127 EZFS_NODELEGATION
, /* delegated administration is disabled */
128 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
129 EZFS_SHARESMBFAILED
, /* failed to share over smb */
130 EZFS_BADCACHE
, /* bad cache file */
131 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
132 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
133 EZFS_NOTSUP
, /* ops not supported on this dataset */
134 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
135 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
136 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
137 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
138 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
139 EZFS_PIPEFAILED
, /* pipe create failed */
140 EZFS_THREADCREATEFAILED
, /* thread create failed */
141 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
142 EZFS_SCRUBBING
, /* currently scrubbing */
143 EZFS_NO_SCRUB
, /* no active scrub */
144 EZFS_DIFF
, /* general failure of zfs diff */
145 EZFS_DIFFDATA
, /* bad zfs diff data */
146 EZFS_POOLREADONLY
, /* pool is in read-only mode */
151 * The following data structures are all part
152 * of the zfs_allow_t data structure which is
153 * used for printing 'allow' permissions.
154 * It is a linked list of zfs_allow_t's which
155 * then contain avl tree's for user/group/sets/...
156 * and each one of the entries in those trees have
157 * avl tree's for the permissions they belong to and
158 * whether they are local,descendent or local+descendent
159 * permissions. The AVL trees are used primarily for
160 * sorting purposes, but also so that we can quickly find
161 * a given user and or permission.
163 typedef struct zfs_perm_node
{
165 char z_pname
[MAXPATHLEN
];
168 typedef struct zfs_allow_node
{
170 char z_key
[MAXPATHLEN
]; /* name, such as joe */
171 avl_tree_t z_localdescend
; /* local+descendent perms */
172 avl_tree_t z_local
; /* local permissions */
173 avl_tree_t z_descend
; /* descendent permissions */
176 typedef struct zfs_allow
{
177 struct zfs_allow
*z_next
;
178 char z_setpoint
[MAXPATHLEN
];
180 avl_tree_t z_crperms
;
183 avl_tree_t z_everyone
;
189 typedef struct zfs_handle zfs_handle_t
;
190 typedef struct zpool_handle zpool_handle_t
;
191 typedef struct libzfs_handle libzfs_handle_t
;
194 * Library initialization
196 extern libzfs_handle_t
*libzfs_init(void);
197 extern void libzfs_fini(libzfs_handle_t
*);
199 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
200 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
202 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
204 extern int libzfs_errno(libzfs_handle_t
*);
205 extern const char *libzfs_error_action(libzfs_handle_t
*);
206 extern const char *libzfs_error_description(libzfs_handle_t
*);
207 extern void libzfs_mnttab_init(libzfs_handle_t
*);
208 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
209 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
210 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
212 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
213 const char *, const char *);
214 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
217 * Basic handle functions
219 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
220 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
221 extern void zpool_close(zpool_handle_t
*);
222 extern const char *zpool_get_name(zpool_handle_t
*);
223 extern int zpool_get_state(zpool_handle_t
*);
224 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
225 extern void zpool_free_handles(libzfs_handle_t
*);
228 * Iterate over all active pools in the system.
230 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
231 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
234 * Functions to create and destroy pools
236 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
237 nvlist_t
*, nvlist_t
*);
238 extern int zpool_destroy(zpool_handle_t
*);
239 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
241 typedef struct splitflags
{
242 /* do not split, but return the config that would be split off */
245 /* after splitting, import the pool */
250 * Functions to manipulate pool and vdev state
252 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
);
253 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
254 extern int zpool_reguid(zpool_handle_t
*);
256 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
258 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
259 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
260 const char *, nvlist_t
*, int);
261 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
262 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
263 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
266 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
267 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
268 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
270 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
271 boolean_t
*, boolean_t
*);
272 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
273 boolean_t
*, boolean_t
*, boolean_t
*);
274 extern int zpool_label_disk_wait(char *, int);
275 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
278 * Functions to manage pool properties
280 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
281 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
282 size_t proplen
, zprop_source_t
*);
283 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
286 extern const char *zpool_prop_to_name(zpool_prop_t
);
287 extern const char *zpool_prop_values(zpool_prop_t
);
290 * Pool health statistics.
294 * The following correspond to faults as defined in the (fault.fs.zfs.*)
295 * event namespace. Each is associated with a corresponding message ID.
297 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
298 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
299 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
300 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
301 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
302 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
303 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
304 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
305 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
306 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
307 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
308 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
309 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
310 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
313 * These faults have no corresponding message ID. At the time we are
314 * checking the status, the original reason for the FMA fault (I/O or
315 * checksum errors) has been lost.
317 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
318 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
321 * The following are not faults per se, but still an error possibly
322 * requiring administrative attention. There is no corresponding
325 ZPOOL_STATUS_VERSION_OLDER
, /* older on-disk version */
326 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
327 ZPOOL_STATUS_OFFLINE_DEV
, /* device online */
328 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
331 * Finally, the following indicates a healthy pool.
336 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **);
337 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **);
338 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
341 * Statistics and configuration functions.
343 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
344 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
345 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
348 * Import and export functions
350 extern int zpool_export(zpool_handle_t
*, boolean_t
);
351 extern int zpool_export_force(zpool_handle_t
*);
352 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
354 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
358 * Search for pools to import
361 typedef struct importargs
{
362 char **path
; /* a list of paths to search */
363 int paths
; /* number of paths to search */
364 char *poolname
; /* name of a pool to find */
365 uint64_t guid
; /* guid of a pool to find */
366 char *cachefile
; /* cachefile to use for import */
367 int can_be_active
: 1; /* can the pool be active? */
368 int unique
: 1; /* does 'poolname' already exist? */
369 int exists
: 1; /* set on return if pool already exists */
372 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
374 /* legacy pool search routines */
375 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
376 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
380 * Miscellaneous pool functions
384 extern const char *zfs_history_event_names
[LOG_END
];
386 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
388 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
389 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
390 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
391 nvlist_t
***, uint_t
*);
392 extern void zpool_set_history_str(const char *subcommand
, int argc
,
393 char **argv
, char *history_str
);
394 extern int zpool_stage_history(libzfs_handle_t
*, const char *);
395 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, int, int);
396 extern int zpool_events_clear(libzfs_handle_t
*, int *);
397 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
399 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
400 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
401 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
405 * Basic handle manipulations. These functions do not create or destroy the
406 * underlying datasets, only the references to them.
408 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
409 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
410 extern void zfs_close(zfs_handle_t
*);
411 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
412 extern const char *zfs_get_name(const zfs_handle_t
*);
413 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
416 * Property management functions. Some functions are shared with the kernel,
417 * and are found in sys/fs/zfs.h.
421 * zfs dataset property management
423 extern const char *zfs_prop_default_string(zfs_prop_t
);
424 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
425 extern const char *zfs_prop_column_name(zfs_prop_t
);
426 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
428 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
429 nvlist_t
*, uint64_t, zfs_handle_t
*, const char *);
431 extern const char *zfs_prop_to_name(zfs_prop_t
);
432 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
433 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
434 zprop_source_t
*, char *, size_t, boolean_t
);
435 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
437 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
438 zprop_source_t
*, char *, size_t);
439 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
440 uint64_t *propvalue
);
441 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
442 char *propbuf
, int proplen
, boolean_t literal
);
443 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
444 uint64_t *propvalue
);
445 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
446 char *propbuf
, int proplen
, boolean_t literal
);
447 extern int zfs_get_snapused_int(zfs_handle_t
*firstsnap
, zfs_handle_t
*lastsnap
,
449 extern uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
450 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
451 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
452 extern const char *zfs_prop_values(zfs_prop_t
);
453 extern int zfs_prop_is_string(zfs_prop_t prop
);
454 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
455 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
456 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
458 typedef struct zprop_list
{
461 struct zprop_list
*pl_next
;
464 size_t pl_recvd_width
;
468 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
);
469 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
471 #define ZFS_MOUNTPOINT_NONE "none"
472 #define ZFS_MOUNTPOINT_LEGACY "legacy"
475 * zpool property management
477 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
478 extern const char *zpool_prop_default_string(zpool_prop_t
);
479 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
480 extern const char *zpool_prop_column_name(zpool_prop_t
);
481 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
484 * Functions shared by zfs and zpool property management.
486 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
487 boolean_t ordered
, zfs_type_t type
);
488 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
490 extern void zprop_free_list(zprop_list_t
*);
492 #define ZFS_GET_NCOLS 5
504 * Functions for printing zfs or zpool properties
506 typedef struct zprop_get_cbdata
{
508 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
509 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
510 boolean_t cb_scripted
;
511 boolean_t cb_literal
;
513 zprop_list_t
*cb_proplist
;
515 } zprop_get_cbdata_t
;
517 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
518 const char *, const char *, zprop_source_t
, const char *,
522 * Iterator functions.
524 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
525 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
526 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
527 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
528 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
529 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
530 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
531 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
533 typedef struct get_all_cb
{
534 zfs_handle_t
**cb_handles
;
537 boolean_t cb_verbose
;
538 int (*cb_getone
)(zfs_handle_t
*, void *);
541 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
542 int libzfs_dataset_cmp(const void *, const void *);
545 * Functions to create and destroy datasets.
547 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
549 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
550 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
551 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
552 extern int zfs_destroy_snaps_nvl(zfs_handle_t
*, nvlist_t
*, boolean_t
);
553 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
554 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
555 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
556 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
558 typedef struct sendflags
{
559 /* print informational messages (ie, -v was specified) */
562 /* recursive send (ie, -R) */
565 /* for incrementals, do all intermediate snapshots */
568 /* if dataset is a clone, do incremental from its origin */
569 boolean_t fromorigin
;
571 /* do deduplication */
574 /* send properties (ie, -p) */
577 /* do not send (no-op, ie. -n) */
580 /* parsable verbose output (ie. -P) */
584 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
586 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
587 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
589 extern int zfs_promote(zfs_handle_t
*);
590 extern int zfs_hold(zfs_handle_t
*, const char *, const char *, boolean_t
,
591 boolean_t
, boolean_t
, int, uint64_t, uint64_t);
592 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
593 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
594 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
596 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
597 uid_t rid
, uint64_t space
);
599 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
600 zfs_userspace_cb_t
, void *);
602 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
603 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
605 typedef struct recvflags
{
606 /* print informational messages (ie, -v was specified) */
609 /* the destination is a prefix, not the exact fs (ie, -d) */
613 * Only the tail of the sent snapshot path is appended to the
614 * destination to determine the received snapshot name (ie, -e).
618 /* do not actually do the recv, just check if it would work (ie, -n) */
621 /* rollback/destroy filesystems as necessary (eg, -F) */
624 /* set "canmount=off" on all modified filesystems */
625 boolean_t canmountoff
;
627 /* byteswap flag is used internally; callers need not specify */
630 /* do not mount file systems as they are extracted (private) */
634 extern int zfs_receive(libzfs_handle_t
*, const char *, recvflags_t
*,
637 typedef enum diff_flags
{
638 ZFS_DIFF_PARSEABLE
= 0x1,
639 ZFS_DIFF_TIMESTAMP
= 0x2,
640 ZFS_DIFF_CLASSIFY
= 0x4
643 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
647 * Miscellaneous functions.
649 extern const char *zfs_type_to_name(zfs_type_t
);
650 extern void zfs_refresh_properties(zfs_handle_t
*);
651 extern int zfs_name_valid(const char *, zfs_type_t
);
652 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
653 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
655 extern int zfs_spa_version(zfs_handle_t
*, int *);
656 extern void zfs_append_partition(const char *path
, char *buf
, size_t buflen
);
657 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
660 * Mount support functions.
662 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
663 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
664 extern int zfs_mount(zfs_handle_t
*, const char *, int);
665 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
666 extern int zfs_unmountall(zfs_handle_t
*, int);
669 * Share support functions.
671 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
672 extern int zfs_share(zfs_handle_t
*);
673 extern int zfs_unshare(zfs_handle_t
*);
676 * Protocol-specific share support functions.
678 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
679 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
680 extern int zfs_share_nfs(zfs_handle_t
*);
681 extern int zfs_share_smb(zfs_handle_t
*);
682 extern int zfs_shareall(zfs_handle_t
*);
683 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
684 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
685 extern int zfs_unshareall_nfs(zfs_handle_t
*);
686 extern int zfs_unshareall_smb(zfs_handle_t
*);
687 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
688 extern int zfs_unshareall(zfs_handle_t
*);
689 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
690 void *, void *, int, zfs_share_op_t
);
693 * Utility function to convert a number to a human-readable form.
695 extern void zfs_nicenum(uint64_t, char *, size_t);
696 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
699 * Utility functions to run an external process.
701 #define STDOUT_VERBOSE 0x01
702 #define STDERR_VERBOSE 0x02
704 int libzfs_run_process(const char *, char **, int flags
);
705 int libzfs_load_module(const char *);
708 * Given a device or file, determine if it is part of a pool.
710 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
714 * Label manipulation.
716 extern int zpool_read_label(int, nvlist_t
**);
717 extern int zpool_clear_label(int);
720 * Management interfaces for SMB ACL files
723 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
724 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
725 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
726 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
729 * Enable and disable datasets within a pool by mounting/unmounting and
730 * sharing/unsharing them.
732 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
733 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
736 * Mappings between vdev and FRU.
738 extern void libzfs_fru_refresh(libzfs_handle_t
*);
739 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
740 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
741 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
743 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
744 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
750 #endif /* _LIBZFS_H */