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 (c) 2011, 2020 by Delphix. All rights reserved.
25 * Copyright Joyent, Inc.
26 * Copyright (c) 2013 Steven Hartland. All rights reserved.
27 * Copyright (c) 2016, Intel Corporation.
28 * Copyright 2016 Nexenta Systems, Inc.
29 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
30 * Copyright (c) 2019 Datto Inc.
37 #include <libnvpair.h>
38 #include <sys/mnttab.h>
39 #include <sys/param.h>
40 #include <sys/types.h>
41 #include <sys/varargs.h>
42 #include <sys/fs/zfs.h>
45 #include <libzfs_core.h>
52 * Miscellaneous ZFS constants
54 #define ZFS_MAXPROPLEN MAXPATHLEN
55 #define ZPOOL_MAXPROPLEN MAXPATHLEN
60 typedef enum zfs_error
{
61 EZFS_SUCCESS
= 0, /* no error -- success */
62 EZFS_NOMEM
= 2000, /* out of memory */
63 EZFS_BADPROP
, /* invalid property value */
64 EZFS_PROPREADONLY
, /* cannot set readonly property */
65 EZFS_PROPTYPE
, /* property does not apply to dataset type */
66 EZFS_PROPNONINHERIT
, /* property is not inheritable */
67 EZFS_PROPSPACE
, /* bad quota or reservation */
68 EZFS_BADTYPE
, /* dataset is not of appropriate type */
69 EZFS_BUSY
, /* pool or dataset is busy */
70 EZFS_EXISTS
, /* pool or dataset already exists */
71 EZFS_NOENT
, /* no such pool or dataset */
72 EZFS_BADSTREAM
, /* bad backup stream */
73 EZFS_DSREADONLY
, /* dataset is readonly */
74 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
75 EZFS_INVALIDNAME
, /* invalid dataset name */
76 EZFS_BADRESTORE
, /* unable to restore to destination */
77 EZFS_BADBACKUP
, /* backup failed */
78 EZFS_BADTARGET
, /* bad attach/detach/replace target */
79 EZFS_NODEVICE
, /* no such device in pool */
80 EZFS_BADDEV
, /* invalid device to add */
81 EZFS_NOREPLICAS
, /* no valid replicas */
82 EZFS_RESILVERING
, /* resilvering (healing reconstruction) */
83 EZFS_BADVERSION
, /* unsupported version */
84 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
85 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
86 EZFS_BADPATH
, /* must be an absolute path */
87 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
88 EZFS_ZONED
, /* used improperly in local zone */
89 EZFS_MOUNTFAILED
, /* failed to mount dataset */
90 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
91 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
92 EZFS_SHARENFSFAILED
, /* share(1M) failed */
93 EZFS_PERM
, /* permission denied */
94 EZFS_NOSPC
, /* out of space */
95 EZFS_FAULT
, /* bad address */
96 EZFS_IO
, /* I/O error */
97 EZFS_INTR
, /* signal received */
98 EZFS_ISSPARE
, /* device is a hot spare */
99 EZFS_INVALCONFIG
, /* invalid vdev configuration */
100 EZFS_RECURSIVE
, /* recursive dependency */
101 EZFS_NOHISTORY
, /* no history object */
102 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
103 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
104 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
105 EZFS_NAMETOOLONG
, /* dataset name is too long */
106 EZFS_OPENFAILED
, /* open of device failed */
107 EZFS_NOCAP
, /* couldn't get capacity */
108 EZFS_LABELFAILED
, /* write of label failed */
109 EZFS_BADWHO
, /* invalid permission who */
110 EZFS_BADPERM
, /* invalid permission */
111 EZFS_BADPERMSET
, /* invalid permission set name */
112 EZFS_NODELEGATION
, /* delegated administration is disabled */
113 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
114 EZFS_SHARESMBFAILED
, /* failed to share over smb */
115 EZFS_BADCACHE
, /* bad cache file */
116 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
117 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
118 EZFS_NOTSUP
, /* ops not supported on this dataset */
119 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
120 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
121 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
122 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
123 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
124 EZFS_PIPEFAILED
, /* pipe create failed */
125 EZFS_THREADCREATEFAILED
, /* thread create failed */
126 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
127 EZFS_SCRUBBING
, /* currently scrubbing */
128 EZFS_NO_SCRUB
, /* no active scrub */
129 EZFS_DIFF
, /* general failure of zfs diff */
130 EZFS_DIFFDATA
, /* bad zfs diff data */
131 EZFS_POOLREADONLY
, /* pool is in read-only mode */
132 EZFS_SCRUB_PAUSED
, /* scrub currently paused */
133 EZFS_ACTIVE_POOL
, /* pool is imported on a different system */
134 EZFS_CRYPTOFAILED
, /* failed to setup encryption */
135 EZFS_NO_PENDING
, /* cannot cancel, no operation is pending */
136 EZFS_CHECKPOINT_EXISTS
, /* checkpoint exists */
137 EZFS_DISCARDING_CHECKPOINT
, /* currently discarding a checkpoint */
138 EZFS_NO_CHECKPOINT
, /* pool has no checkpoint */
139 EZFS_DEVRM_IN_PROGRESS
, /* a device is currently being removed */
140 EZFS_VDEV_TOO_BIG
, /* a device is too big to be used */
141 EZFS_IOC_NOTSUPPORTED
, /* operation not supported by zfs module */
142 EZFS_TOOMANY
, /* argument list too long */
143 EZFS_INITIALIZING
, /* currently initializing */
144 EZFS_NO_INITIALIZE
, /* no active initialize */
145 EZFS_WRONG_PARENT
, /* invalid parent dataset (e.g ZVOL) */
146 EZFS_TRIMMING
, /* currently trimming */
147 EZFS_NO_TRIM
, /* no active trim */
148 EZFS_TRIM_NOTSUP
, /* device does not support trim */
149 EZFS_NO_RESILVER_DEFER
, /* pool doesn't support resilver_defer */
150 EZFS_EXPORT_IN_PROGRESS
, /* currently exporting the pool */
151 EZFS_REBUILDING
, /* resilvering (sequential reconstrution) */
156 * The following data structures are all part
157 * of the zfs_allow_t data structure which is
158 * used for printing 'allow' permissions.
159 * It is a linked list of zfs_allow_t's which
160 * then contain avl tree's for user/group/sets/...
161 * and each one of the entries in those trees have
162 * avl tree's for the permissions they belong to and
163 * whether they are local,descendent or local+descendent
164 * permissions. The AVL trees are used primarily for
165 * sorting purposes, but also so that we can quickly find
166 * a given user and or permission.
168 typedef struct zfs_perm_node
{
170 char z_pname
[MAXPATHLEN
];
173 typedef struct zfs_allow_node
{
175 char z_key
[MAXPATHLEN
]; /* name, such as joe */
176 avl_tree_t z_localdescend
; /* local+descendent perms */
177 avl_tree_t z_local
; /* local permissions */
178 avl_tree_t z_descend
; /* descendent permissions */
181 typedef struct zfs_allow
{
182 struct zfs_allow
*z_next
;
183 char z_setpoint
[MAXPATHLEN
];
185 avl_tree_t z_crperms
;
188 avl_tree_t z_everyone
;
194 typedef struct zfs_handle zfs_handle_t
;
195 typedef struct zpool_handle zpool_handle_t
;
196 typedef struct libzfs_handle libzfs_handle_t
;
198 extern int zpool_wait(zpool_handle_t
*, zpool_wait_activity_t
);
199 extern int zpool_wait_status(zpool_handle_t
*, zpool_wait_activity_t
,
200 boolean_t
*, boolean_t
*);
203 * Library initialization
205 extern libzfs_handle_t
*libzfs_init(void);
206 extern void libzfs_fini(libzfs_handle_t
*);
208 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
209 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
211 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
213 extern void zfs_save_arguments(int argc
, char **, char *, int);
214 extern int zpool_log_history(libzfs_handle_t
*, const char *);
216 extern int libzfs_errno(libzfs_handle_t
*);
217 extern const char *libzfs_error_init(int);
218 extern const char *libzfs_error_action(libzfs_handle_t
*);
219 extern const char *libzfs_error_description(libzfs_handle_t
*);
220 extern int zfs_standard_error(libzfs_handle_t
*, int, const char *);
221 extern void libzfs_mnttab_init(libzfs_handle_t
*);
222 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
223 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
224 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
226 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
227 const char *, const char *);
228 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
231 * Basic handle functions
233 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
234 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
235 extern void zpool_close(zpool_handle_t
*);
236 extern const char *zpool_get_name(zpool_handle_t
*);
237 extern int zpool_get_state(zpool_handle_t
*);
238 extern const char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
239 extern const char *zpool_pool_state_to_name(pool_state_t
);
240 extern void zpool_free_handles(libzfs_handle_t
*);
243 * Iterate over all active pools in the system.
245 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
246 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
247 extern boolean_t
zpool_skip_pool(const char *);
250 * Functions to create and destroy pools
252 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
253 nvlist_t
*, nvlist_t
*);
254 extern int zpool_destroy(zpool_handle_t
*, const char *);
255 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
257 typedef struct splitflags
{
258 /* do not split, but return the config that would be split off */
261 /* after splitting, import the pool */
266 typedef struct trimflags
{
267 /* requested vdevs are for the entire pool */
270 /* request a secure trim, requires support from device */
273 /* after starting trim, block until trim completes */
276 /* trim at the requested rate in bytes/second */
281 * Functions to manipulate pool and vdev state
283 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
, pool_scrub_cmd_t
);
284 extern int zpool_initialize(zpool_handle_t
*, pool_initialize_func_t
,
286 extern int zpool_initialize_wait(zpool_handle_t
*, pool_initialize_func_t
,
288 extern int zpool_trim(zpool_handle_t
*, pool_trim_func_t
, nvlist_t
*,
291 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
292 extern int zpool_reguid(zpool_handle_t
*);
293 extern int zpool_reopen_one(zpool_handle_t
*, void *);
295 extern int zpool_sync_one(zpool_handle_t
*, void *);
297 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
299 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
300 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
301 const char *, nvlist_t
*, int, boolean_t
);
302 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
303 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
304 extern int zpool_vdev_remove_cancel(zpool_handle_t
*);
305 extern int zpool_vdev_indirect_size(zpool_handle_t
*, const char *, uint64_t *);
306 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
309 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
310 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
311 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
313 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
314 boolean_t
*, boolean_t
*);
315 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
316 boolean_t
*, boolean_t
*, boolean_t
*);
317 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, const char *);
318 extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t
*zhp
, const char *path
);
320 const char *zpool_get_state_str(zpool_handle_t
*);
323 * Functions to manage pool properties
325 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
326 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
327 size_t proplen
, zprop_source_t
*, boolean_t literal
);
328 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
330 extern int zpool_props_refresh(zpool_handle_t
*);
332 extern const char *zpool_prop_to_name(zpool_prop_t
);
333 extern const char *zpool_prop_values(zpool_prop_t
);
336 * Pool health statistics.
340 * The following correspond to faults as defined in the (fault.fs.zfs.*)
341 * event namespace. Each is associated with a corresponding message ID.
342 * This must be kept in sync with the zfs_msgid_table in
343 * lib/libzfs/libzfs_status.c.
345 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
346 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
347 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
348 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
349 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
350 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
351 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
352 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
353 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
354 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
355 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
356 ZPOOL_STATUS_HOSTID_ACTIVE
, /* currently active on another system */
357 ZPOOL_STATUS_HOSTID_REQUIRED
, /* multihost=on and hostid=0 */
358 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
359 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
360 ZPOOL_STATUS_IO_FAILURE_MMP
, /* failed MMP, failmode not 'panic' */
361 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
362 ZPOOL_STATUS_ERRATA
, /* informational errata available */
365 * If the pool has unsupported features but can still be opened in
366 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
367 * pool has unsupported features but cannot be opened at all, its
368 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
370 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
371 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
374 * These faults have no corresponding message ID. At the time we are
375 * checking the status, the original reason for the FMA fault (I/O or
376 * checksum errors) has been lost.
378 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
379 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
382 * The following are not faults per se, but still an error possibly
383 * requiring administrative attention. There is no corresponding
386 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
387 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
388 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
389 ZPOOL_STATUS_OFFLINE_DEV
, /* device offline */
390 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
391 ZPOOL_STATUS_REBUILDING
, /* device being rebuilt */
392 ZPOOL_STATUS_REBUILD_SCRUB
, /* recommend scrubbing the pool */
395 * Finally, the following indicates a healthy pool.
400 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **,
402 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **,
406 * Statistics and configuration functions.
408 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
409 extern nvlist_t
*zpool_get_features(zpool_handle_t
*);
410 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
411 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
414 * Import and export functions
416 extern int zpool_export(zpool_handle_t
*, boolean_t
, const char *);
417 extern int zpool_export_force(zpool_handle_t
*, const char *);
418 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
420 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
422 extern void zpool_print_unsup_feat(nvlist_t
*config
);
425 * Miscellaneous pool functions
429 extern const char *zfs_history_event_names
[];
432 VDEV_NAME_PATH
= 1 << 0,
433 VDEV_NAME_GUID
= 1 << 1,
434 VDEV_NAME_FOLLOW_LINKS
= 1 << 2,
435 VDEV_NAME_TYPE_ID
= 1 << 3,
438 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
440 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
441 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**, uint64_t *,
443 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, unsigned,
445 extern int zpool_events_clear(libzfs_handle_t
*, int *);
446 extern int zpool_events_seek(libzfs_handle_t
*, uint64_t, int);
447 extern void zpool_obj_to_path_ds(zpool_handle_t
*, uint64_t, uint64_t, char *,
449 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
451 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
452 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
453 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
455 extern int zpool_checkpoint(zpool_handle_t
*);
456 extern int zpool_discard_checkpoint(zpool_handle_t
*);
459 * Basic handle manipulations. These functions do not create or destroy the
460 * underlying datasets, only the references to them.
462 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
463 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
464 extern void zfs_close(zfs_handle_t
*);
465 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
466 extern const char *zfs_get_name(const zfs_handle_t
*);
467 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
468 extern const char *zfs_get_pool_name(const zfs_handle_t
*);
471 * Property management functions. Some functions are shared with the kernel,
472 * and are found in sys/fs/zfs.h.
476 * zfs dataset property management
478 extern const char *zfs_prop_default_string(zfs_prop_t
);
479 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
480 extern const char *zfs_prop_column_name(zfs_prop_t
);
481 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
483 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
, nvlist_t
*,
484 uint64_t, zfs_handle_t
*, zpool_handle_t
*, boolean_t
, const char *);
486 extern const char *zfs_prop_to_name(zfs_prop_t
);
487 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
488 extern int zfs_prop_set_list(zfs_handle_t
*, nvlist_t
*);
489 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
490 zprop_source_t
*, char *, size_t, boolean_t
);
491 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
493 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
494 zprop_source_t
*, char *, size_t);
495 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
496 uint64_t *propvalue
);
497 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
498 char *propbuf
, int proplen
, boolean_t literal
);
499 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
500 uint64_t *propvalue
);
501 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
502 char *propbuf
, int proplen
, boolean_t literal
);
503 extern int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
504 char *buf
, size_t len
);
505 extern uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
506 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
507 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
508 extern const char *zfs_prop_values(zfs_prop_t
);
509 extern int zfs_prop_is_string(zfs_prop_t prop
);
510 extern nvlist_t
*zfs_get_all_props(zfs_handle_t
*);
511 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
512 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
513 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
515 extern int zfs_wait_status(zfs_handle_t
*, zfs_wait_activity_t
,
516 boolean_t
*, boolean_t
*);
519 * zfs encryption management
521 extern int zfs_crypto_get_encryption_root(zfs_handle_t
*, boolean_t
*, char *);
522 extern int zfs_crypto_create(libzfs_handle_t
*, char *, nvlist_t
*, nvlist_t
*,
523 boolean_t stdin_available
, uint8_t **, uint_t
*);
524 extern int zfs_crypto_clone_check(libzfs_handle_t
*, zfs_handle_t
*, char *,
526 extern int zfs_crypto_attempt_load_keys(libzfs_handle_t
*, char *);
527 extern int zfs_crypto_load_key(zfs_handle_t
*, boolean_t
, char *);
528 extern int zfs_crypto_unload_key(zfs_handle_t
*);
529 extern int zfs_crypto_rewrap(zfs_handle_t
*, nvlist_t
*, boolean_t
);
531 typedef struct zprop_list
{
534 struct zprop_list
*pl_next
;
537 size_t pl_recvd_width
;
541 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
,
543 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
545 #define ZFS_MOUNTPOINT_NONE "none"
546 #define ZFS_MOUNTPOINT_LEGACY "legacy"
548 #define ZFS_FEATURE_DISABLED "disabled"
549 #define ZFS_FEATURE_ENABLED "enabled"
550 #define ZFS_FEATURE_ACTIVE "active"
552 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
553 #define ZFS_UNSUPPORTED_READONLY "readonly"
556 * zpool property management
558 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
559 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
561 extern const char *zpool_prop_default_string(zpool_prop_t
);
562 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
563 extern const char *zpool_prop_column_name(zpool_prop_t
);
564 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
567 * Functions shared by zfs and zpool property management.
569 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
570 boolean_t ordered
, zfs_type_t type
);
571 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
573 extern void zprop_free_list(zprop_list_t
*);
575 #define ZFS_GET_NCOLS 5
587 * Functions for printing zfs or zpool properties
589 typedef struct zprop_get_cbdata
{
591 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
592 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
593 boolean_t cb_scripted
;
594 boolean_t cb_literal
;
596 zprop_list_t
*cb_proplist
;
598 } zprop_get_cbdata_t
;
600 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
601 const char *, const char *, zprop_source_t
, const char *,
605 * Iterator functions.
607 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
608 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
609 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
610 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
611 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
612 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *,
614 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *,
616 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
617 extern int zfs_iter_bookmarks(zfs_handle_t
*, zfs_iter_f
, void *);
618 extern int zfs_iter_mounted(zfs_handle_t
*, zfs_iter_f
, void *);
620 typedef struct get_all_cb
{
621 zfs_handle_t
**cb_handles
;
626 void zfs_foreach_mountpoint(libzfs_handle_t
*, zfs_handle_t
**, size_t,
627 zfs_iter_f
, void *, boolean_t
);
628 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
631 * Functions to create and destroy datasets.
633 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
635 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
636 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
637 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
638 extern int zfs_destroy_snaps_nvl(libzfs_handle_t
*, nvlist_t
*, boolean_t
);
639 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
640 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
641 extern int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
643 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
644 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
646 typedef struct sendflags
{
647 /* Amount of extra information to print. */
650 /* recursive send (ie, -R) */
653 /* for incrementals, do all intermediate snapshots */
656 /* if dataset is a clone, do incremental from its origin */
657 boolean_t fromorigin
;
659 /* field no longer used, maintained for backwards compatibility */
662 /* send properties (ie, -p) */
665 /* do not send (no-op, ie. -n) */
668 /* parsable verbose output (ie. -P) */
671 /* show progress (ie. -v) */
674 /* large blocks (>128K) are permitted */
675 boolean_t largeblock
;
677 /* WRITE_EMBEDDED records of type DATA are permitted */
678 boolean_t embed_data
;
680 /* compressed WRITE records are permitted */
683 /* raw encrypted records are permitted */
686 /* only send received properties (ie. -b) */
689 /* include snapshot holds in send stream */
692 /* stream represents a partially received dataset */
696 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
698 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
699 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
700 extern int zfs_send_one(zfs_handle_t
*, const char *, int, sendflags_t
*,
702 extern int zfs_send_progress(zfs_handle_t
*, int, uint64_t *, uint64_t *);
703 extern int zfs_send_resume(libzfs_handle_t
*, sendflags_t
*, int outfd
,
705 extern int zfs_send_saved(zfs_handle_t
*, sendflags_t
*, int, const char *);
706 extern nvlist_t
*zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
,
709 extern int zfs_promote(zfs_handle_t
*);
710 extern int zfs_hold(zfs_handle_t
*, const char *, const char *,
712 extern int zfs_hold_nvl(zfs_handle_t
*, int, nvlist_t
*);
713 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
714 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
715 extern uint64_t zvol_volsize_to_reservation(zpool_handle_t
*, uint64_t,
718 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
719 uid_t rid
, uint64_t space
);
721 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
722 zfs_userspace_cb_t
, void *);
724 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
725 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
727 typedef struct recvflags
{
728 /* print informational messages (ie, -v was specified) */
731 /* the destination is a prefix, not the exact fs (ie, -d) */
735 * Only the tail of the sent snapshot path is appended to the
736 * destination to determine the received snapshot name (ie, -e).
740 /* do not actually do the recv, just check if it would work (ie, -n) */
743 /* rollback/destroy filesystems as necessary (eg, -F) */
746 /* set "canmount=off" on all modified filesystems */
747 boolean_t canmountoff
;
750 * Mark the file systems as "resumable" and do not destroy them if the
751 * receive is interrupted
755 /* byteswap flag is used internally; callers need not specify */
758 /* do not mount file systems as they are extracted (private) */
761 /* Was holds flag set in the compound header? */
764 /* skip receive of snapshot holds */
767 /* mount the filesystem unless nomount is specified */
770 /* force unmount while recv snapshot (private) */
771 boolean_t forceunmount
;
774 extern int zfs_receive(libzfs_handle_t
*, const char *, nvlist_t
*,
775 recvflags_t
*, int, avl_tree_t
*);
777 typedef enum diff_flags
{
778 ZFS_DIFF_PARSEABLE
= 0x1,
779 ZFS_DIFF_TIMESTAMP
= 0x2,
780 ZFS_DIFF_CLASSIFY
= 0x4
783 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
787 * Miscellaneous functions.
789 extern const char *zfs_type_to_name(zfs_type_t
);
790 extern void zfs_refresh_properties(zfs_handle_t
*);
791 extern int zfs_name_valid(const char *, zfs_type_t
);
792 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
793 extern int zfs_parent_name(zfs_handle_t
*, char *, size_t);
794 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
796 extern int zfs_spa_version(zfs_handle_t
*, int *);
797 extern boolean_t
zfs_bookmark_exists(const char *path
);
800 * Mount support functions.
802 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
803 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
804 extern int zfs_mount(zfs_handle_t
*, const char *, int);
805 extern int zfs_mount_at(zfs_handle_t
*, const char *, int, const char *);
806 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
807 extern int zfs_unmountall(zfs_handle_t
*, int);
809 #if defined(__linux__)
810 extern int zfs_parse_mount_options(char *mntopts
, unsigned long *mntflags
,
811 unsigned long *zfsflags
, int sloppy
, char *badopt
, char *mtabopt
);
812 extern void zfs_adjust_mount_options(zfs_handle_t
*zhp
, const char *mntpoint
,
813 char *mntopts
, char *mtabopt
);
817 * Share support functions.
819 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
820 extern int zfs_share(zfs_handle_t
*);
821 extern int zfs_unshare(zfs_handle_t
*);
824 * Protocol-specific share support functions.
826 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
827 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
828 extern int zfs_share_nfs(zfs_handle_t
*);
829 extern int zfs_share_smb(zfs_handle_t
*);
830 extern int zfs_shareall(zfs_handle_t
*);
831 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
832 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
833 extern int zfs_unshareall_nfs(zfs_handle_t
*);
834 extern int zfs_unshareall_smb(zfs_handle_t
*);
835 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
836 extern int zfs_unshareall_bytype(zfs_handle_t
*, const char *, const char *);
837 extern int zfs_unshareall(zfs_handle_t
*);
838 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
839 void *, void *, int, zfs_share_op_t
);
841 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
844 * Utility functions to run an external process.
846 #define STDOUT_VERBOSE 0x01
847 #define STDERR_VERBOSE 0x02
848 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
850 int libzfs_run_process(const char *, char **, int);
851 int libzfs_run_process_get_stdout(const char *, char *[], char *[],
853 int libzfs_run_process_get_stdout_nopath(const char *, char *[], char *[],
856 void libzfs_free_str_array(char **, int);
858 int libzfs_envvar_is_set(char *);
861 * Utility functions for zfs version
863 extern void zfs_version_userland(char *, int);
864 extern int zfs_version_kernel(char *, int);
865 extern int zfs_version_print(void);
868 * Given a device or file, determine if it is part of a pool.
870 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
874 * Label manipulation.
876 extern int zpool_clear_label(int);
877 extern int zpool_set_bootenv(zpool_handle_t
*, const char *);
878 extern int zpool_get_bootenv(zpool_handle_t
*, char *, size_t, off_t
);
881 * Management interfaces for SMB ACL files
884 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
885 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
886 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
887 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
890 * Enable and disable datasets within a pool by mounting/unmounting and
891 * sharing/unsharing them.
893 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
894 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
900 #endif /* _LIBZFS_H */