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 https://opensource.org/licenses/CDDL-1.0.
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, 2022 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.
31 * Copyright (c) 2021, Colm Buckley <colm@tuatha.org>
35 #define _LIBZFS_H extern __attribute__((visibility("default")))
39 #include <libnvpair.h>
40 #include <sys/mnttab.h>
41 #include <sys/param.h>
42 #include <sys/types.h>
43 #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, /* failed to unshare over nfs */
92 EZFS_SHARENFSFAILED, /* failed to share over nfs */
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_ERRORSCRUBBING, /* currently error scrubbing */
129 EZFS_ERRORSCRUB_PAUSED, /* error scrub currently paused */
130 EZFS_NO_SCRUB, /* no active scrub */
131 EZFS_DIFF, /* general failure of zfs diff */
132 EZFS_DIFFDATA, /* bad zfs diff data */
133 EZFS_POOLREADONLY, /* pool is in read-only mode */
134 EZFS_SCRUB_PAUSED, /* scrub currently paused */
135 EZFS_SCRUB_PAUSED_TO_CANCEL, /* scrub currently paused */
136 EZFS_ACTIVE_POOL, /* pool is imported on a different system */
137 EZFS_CRYPTOFAILED, /* failed to setup encryption */
138 EZFS_NO_PENDING, /* cannot cancel, no operation is pending */
139 EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */
140 EZFS_DISCARDING_CHECKPOINT, /* currently discarding a checkpoint */
141 EZFS_NO_CHECKPOINT, /* pool has no checkpoint */
142 EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */
143 EZFS_VDEV_TOO_BIG, /* a device is too big to be used */
144 EZFS_IOC_NOTSUPPORTED, /* operation not supported by zfs module */
145 EZFS_TOOMANY, /* argument list too long */
146 EZFS_INITIALIZING, /* currently initializing */
147 EZFS_NO_INITIALIZE, /* no active initialize */
148 EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */
149 EZFS_TRIMMING, /* currently trimming */
150 EZFS_NO_TRIM, /* no active trim */
151 EZFS_TRIM_NOTSUP, /* device does not support trim */
152 EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */
153 EZFS_EXPORT_IN_PROGRESS, /* currently exporting the pool */
154 EZFS_REBUILDING, /* resilvering (sequential reconstrution) */
155 EZFS_VDEV_NOTSUP, /* ops not supported for this type of vdev */
156 EZFS_NOT_USER_NAMESPACE, /* a file is not a user namespace */
157 EZFS_CKSUM, /* insufficient replicas */
158 EZFS_RESUME_EXISTS, /* Resume on existing dataset without force */
163 * The following data structures are all part
164 * of the zfs_allow_t data structure which is
165 * used for printing 'allow' permissions.
166 * It is a linked list of zfs_allow_t's which
167 * then contain avl tree's for user/group/sets/...
168 * and each one of the entries in those trees have
169 * avl tree's for the permissions they belong to and
170 * whether they are local,descendent or local+descendent
171 * permissions. The AVL trees are used primarily for
172 * sorting purposes, but also so that we can quickly find
173 * a given user and or permission.
175 typedef struct zfs_perm_node {
177 char z_pname[MAXPATHLEN];
180 typedef struct zfs_allow_node {
182 char z_key[MAXPATHLEN]; /* name, such as joe */
183 avl_tree_t z_localdescend; /* local+descendent perms */
184 avl_tree_t z_local; /* local permissions */
185 avl_tree_t z_descend; /* descendent permissions */
188 typedef struct zfs_allow {
189 struct zfs_allow *z_next;
190 char z_setpoint[MAXPATHLEN];
192 avl_tree_t z_crperms;
195 avl_tree_t z_everyone;
201 typedef struct zfs_handle zfs_handle_t;
202 typedef struct zpool_handle zpool_handle_t;
203 typedef struct libzfs_handle libzfs_handle_t;
205 _LIBZFS_H int zpool_wait(zpool_handle_t *, zpool_wait_activity_t);
206 _LIBZFS_H int zpool_wait_status(zpool_handle_t *, zpool_wait_activity_t,
207 boolean_t *, boolean_t *);
210 * Library initialization
212 _LIBZFS_H libzfs_handle_t *libzfs_init(void);
213 _LIBZFS_H void libzfs_fini(libzfs_handle_t *);
215 _LIBZFS_H libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
216 _LIBZFS_H libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
218 _LIBZFS_H void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
220 _LIBZFS_H void zfs_save_arguments(int argc, char **, char *, int);
221 _LIBZFS_H int zpool_log_history(libzfs_handle_t *, const char *);
223 _LIBZFS_H int libzfs_errno(libzfs_handle_t *);
224 _LIBZFS_H const char *libzfs_error_init(int);
225 _LIBZFS_H const char *libzfs_error_action(libzfs_handle_t *);
226 _LIBZFS_H const char *libzfs_error_description(libzfs_handle_t *);
227 _LIBZFS_H int zfs_standard_error(libzfs_handle_t *, int, const char *);
228 _LIBZFS_H void libzfs_mnttab_init(libzfs_handle_t *);
229 _LIBZFS_H void libzfs_mnttab_fini(libzfs_handle_t *);
230 _LIBZFS_H void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
231 _LIBZFS_H int libzfs_mnttab_find(libzfs_handle_t *, const char *,
233 _LIBZFS_H void libzfs_mnttab_add(libzfs_handle_t *, const char *,
234 const char *, const char *);
235 _LIBZFS_H void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
238 * Basic handle functions
240 _LIBZFS_H zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
241 _LIBZFS_H zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
242 _LIBZFS_H void zpool_close(zpool_handle_t *);
243 _LIBZFS_H const char *zpool_get_name(zpool_handle_t *);
244 _LIBZFS_H int zpool_get_state(zpool_handle_t *);
245 _LIBZFS_H const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
246 _LIBZFS_H const char *zpool_pool_state_to_name(pool_state_t);
247 _LIBZFS_H void zpool_free_handles(libzfs_handle_t *);
250 * Iterate over all active pools in the system.
252 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
253 _LIBZFS_H int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
254 _LIBZFS_H boolean_t zpool_skip_pool(const char *);
257 * Functions to create and destroy pools
259 _LIBZFS_H int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
260 nvlist_t *, nvlist_t *);
261 _LIBZFS_H int zpool_destroy(zpool_handle_t *, const char *);
262 _LIBZFS_H int zpool_add(zpool_handle_t *, nvlist_t *);
264 typedef struct splitflags {
265 /* do not split, but return the config that would be split off */
266 unsigned int dryrun : 1;
268 /* after splitting, import the pool */
269 unsigned int import : 1;
273 typedef struct trimflags {
274 /* requested vdevs are for the entire pool */
277 /* request a secure trim, requires support from device */
280 /* after starting trim, block until trim completes */
283 /* trim at the requested rate in bytes/second */
288 * Functions to manipulate pool and vdev state
290 _LIBZFS_H int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
291 _LIBZFS_H int zpool_initialize(zpool_handle_t *, pool_initialize_func_t,
293 _LIBZFS_H int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t,
295 _LIBZFS_H int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *,
298 _LIBZFS_H int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
299 _LIBZFS_H int zpool_reguid(zpool_handle_t *);
300 _LIBZFS_H int zpool_reopen_one(zpool_handle_t *, void *);
302 _LIBZFS_H int zpool_sync_one(zpool_handle_t *, void *);
304 _LIBZFS_H int zpool_vdev_online(zpool_handle_t *, const char *, int,
306 _LIBZFS_H int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
307 _LIBZFS_H int zpool_vdev_attach(zpool_handle_t *, const char *,
308 const char *, nvlist_t *, int, boolean_t);
309 _LIBZFS_H int zpool_vdev_detach(zpool_handle_t *, const char *);
310 _LIBZFS_H int zpool_vdev_remove(zpool_handle_t *, const char *);
311 _LIBZFS_H int zpool_vdev_remove_cancel(zpool_handle_t *);
312 _LIBZFS_H int zpool_vdev_indirect_size(zpool_handle_t *, const char *,
314 _LIBZFS_H int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **,
315 nvlist_t *, splitflags_t);
316 _LIBZFS_H int zpool_vdev_remove_wanted(zpool_handle_t *, const char *);
318 _LIBZFS_H int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
319 _LIBZFS_H int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
320 _LIBZFS_H int zpool_vdev_clear(zpool_handle_t *, uint64_t);
322 _LIBZFS_H nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
323 boolean_t *, boolean_t *);
324 _LIBZFS_H nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
325 boolean_t *, boolean_t *, boolean_t *);
326 _LIBZFS_H int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *,
328 _LIBZFS_H uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp,
331 _LIBZFS_H const char *zpool_get_state_str(zpool_handle_t *);
334 * Functions to manage pool properties
336 _LIBZFS_H int zpool_set_prop(zpool_handle_t *, const char *, const char *);
337 _LIBZFS_H int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
338 size_t proplen, zprop_source_t *, boolean_t literal);
339 _LIBZFS_H int zpool_get_userprop(zpool_handle_t *, const char *, char *,
340 size_t proplen, zprop_source_t *);
341 _LIBZFS_H uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
343 _LIBZFS_H int zpool_props_refresh(zpool_handle_t *);
345 _LIBZFS_H const char *zpool_prop_to_name(zpool_prop_t);
346 _LIBZFS_H const char *zpool_prop_values(zpool_prop_t);
349 * Functions to manage vdev properties
351 _LIBZFS_H int zpool_get_vdev_prop_value(nvlist_t *, vdev_prop_t, char *, char *,
352 size_t, zprop_source_t *, boolean_t);
353 _LIBZFS_H int zpool_get_vdev_prop(zpool_handle_t *, const char *, vdev_prop_t,
354 char *, char *, size_t, zprop_source_t *, boolean_t);
355 _LIBZFS_H int zpool_get_all_vdev_props(zpool_handle_t *, const char *,
357 _LIBZFS_H int zpool_set_vdev_prop(zpool_handle_t *, const char *, const char *,
360 _LIBZFS_H const char *vdev_prop_to_name(vdev_prop_t);
361 _LIBZFS_H const char *vdev_prop_values(vdev_prop_t);
362 _LIBZFS_H boolean_t vdev_prop_user(const char *name);
363 _LIBZFS_H const char *vdev_prop_column_name(vdev_prop_t);
364 _LIBZFS_H boolean_t vdev_prop_align_right(vdev_prop_t);
367 * Pool health statistics.
371 * The following correspond to faults as defined in the (fault.fs.zfs.*)
372 * event namespace. Each is associated with a corresponding message ID.
373 * This must be kept in sync with the zfs_msgid_table in
374 * lib/libzfs/libzfs_status.c.
376 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
377 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
378 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
379 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
380 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
381 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
382 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
383 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
384 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
385 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
386 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
387 ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */
388 ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */
389 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
390 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
391 ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */
392 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
393 ZPOOL_STATUS_ERRATA, /* informational errata available */
396 * If the pool has unsupported features but can still be opened in
397 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
398 * pool has unsupported features but cannot be opened at all, its
399 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
401 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
402 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
405 * These faults have no corresponding message ID. At the time we are
406 * checking the status, the original reason for the FMA fault (I/O or
407 * checksum errors) has been lost.
409 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
410 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
413 * The following are not faults per se, but still an error possibly
414 * requiring administrative attention. There is no corresponding
417 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
418 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
419 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
420 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */
421 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
422 ZPOOL_STATUS_REBUILDING, /* device being rebuilt */
423 ZPOOL_STATUS_REBUILD_SCRUB, /* recommend scrubbing the pool */
424 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
425 ZPOOL_STATUS_COMPATIBILITY_ERR, /* bad 'compatibility' property */
426 ZPOOL_STATUS_INCOMPATIBLE_FEAT, /* feature set outside compatibility */
429 * Finally, the following indicates a healthy pool.
434 _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, const char **,
436 _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, const char **,
440 * Statistics and configuration functions.
442 _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
443 _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *);
444 _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
445 _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
448 * Import and export functions
450 _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *);
451 _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *);
452 _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
454 _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
456 _LIBZFS_H void zpool_print_unsup_feat(nvlist_t *config);
459 * Miscellaneous pool functions
463 _LIBZFS_H const char *const zfs_history_event_names[];
466 VDEV_NAME_PATH = 1 << 0,
467 VDEV_NAME_GUID = 1 << 1,
468 VDEV_NAME_FOLLOW_LINKS = 1 << 2,
469 VDEV_NAME_TYPE_ID = 1 << 3,
472 _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
474 _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t);
475 _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *,
477 _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned,
479 _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *);
480 _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int);
481 _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t,
483 _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
485 _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
486 _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int,
488 _LIBZFS_H int zpool_checkpoint(zpool_handle_t *);
489 _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *);
490 _LIBZFS_H boolean_t zpool_is_draid_spare(const char *);
493 * Basic handle manipulations. These functions do not create or destroy the
494 * underlying datasets, only the references to them.
496 _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
497 _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
498 _LIBZFS_H void zfs_close(zfs_handle_t *);
499 _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *);
500 _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *);
501 _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *);
502 _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
503 _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *);
506 * Property management functions. Some functions are shared with the kernel,
507 * and are found in sys/fs/zfs.h.
511 * zfs dataset property management
513 _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t);
514 _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t);
515 _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t);
516 _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t);
518 _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
519 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t,
522 _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t);
523 _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *);
524 _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
525 _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
526 zprop_source_t *, char *, size_t, boolean_t);
527 _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
529 _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
530 zprop_source_t *, char *, size_t);
531 _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp,
532 const char *propname, uint64_t *propvalue);
533 _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
534 char *propbuf, int proplen, boolean_t literal);
535 _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
536 uint64_t *propvalue);
537 _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
538 char *propbuf, int proplen, boolean_t literal);
539 _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
540 char *buf, size_t len);
541 _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, const char **);
542 _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
543 _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
544 _LIBZFS_H const char *zfs_prop_values(zfs_prop_t);
545 _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop);
546 _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *);
547 _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *);
548 _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
549 _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
551 _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t,
552 boolean_t *, boolean_t *);
555 * zfs encryption management
557 _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *,
559 _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *,
560 nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *);
561 _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *,
563 _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *);
564 _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *);
565 _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *);
566 _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t);
568 typedef struct zprop_list {
571 struct zprop_list *pl_next;
574 size_t pl_recvd_width;
578 _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
580 _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
581 _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *,
584 #define ZFS_MOUNTPOINT_NONE "none"
585 #define ZFS_MOUNTPOINT_LEGACY "legacy"
587 #define ZFS_FEATURE_DISABLED "disabled"
588 #define ZFS_FEATURE_ENABLED "enabled"
589 #define ZFS_FEATURE_ACTIVE "active"
591 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
592 #define ZFS_UNSUPPORTED_READONLY "readonly"
595 * zpool property management
597 _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **,
598 zfs_type_t, boolean_t);
599 _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
601 _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t);
602 _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t);
603 _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t);
604 _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t);
607 * Functions shared by zfs and zpool property management.
609 _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
610 boolean_t ordered, zfs_type_t type);
611 _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
613 _LIBZFS_H void zprop_free_list(zprop_list_t *);
615 #define ZFS_GET_NCOLS 5
627 * Functions for printing zfs or zpool properties
629 typedef struct vdev_cbdata {
632 unsigned int cb_names_count;
635 typedef struct zprop_get_cbdata {
637 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
638 int cb_colwidths[ZFS_GET_NCOLS + 1];
639 boolean_t cb_scripted;
640 boolean_t cb_literal;
642 zprop_list_t *cb_proplist;
644 vdev_cbdata_t cb_vdevs;
645 } zprop_get_cbdata_t;
647 _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
648 const char *, const char *, zprop_source_t, const char *,
652 * Iterator functions.
654 #define ZFS_ITER_RECURSE (1 << 0)
655 #define ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1)
656 #define ZFS_ITER_PROP_LISTSNAPS (1 << 2)
657 #define ZFS_ITER_DEPTH_LIMIT (1 << 3)
658 #define ZFS_ITER_RECVD_PROPS (1 << 4)
659 #define ZFS_ITER_LITERAL_PROPS (1 << 5)
660 #define ZFS_ITER_SIMPLE (1 << 6)
662 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
663 _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
664 _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
665 _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f,
667 _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
668 _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *,
670 _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *,
672 _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f,
674 _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
676 _LIBZFS_H int zfs_iter_children_v2(zfs_handle_t *, int, zfs_iter_f, void *);
677 _LIBZFS_H int zfs_iter_dependents_v2(zfs_handle_t *, int, boolean_t, zfs_iter_f,
679 _LIBZFS_H int zfs_iter_filesystems_v2(zfs_handle_t *, int, zfs_iter_f, void *);
680 _LIBZFS_H int zfs_iter_snapshots_v2(zfs_handle_t *, int, zfs_iter_f, void *,
682 _LIBZFS_H int zfs_iter_snapshots_sorted_v2(zfs_handle_t *, int, zfs_iter_f,
683 void *, uint64_t, uint64_t);
684 _LIBZFS_H int zfs_iter_snapspec_v2(zfs_handle_t *, int, const char *,
686 _LIBZFS_H int zfs_iter_bookmarks_v2(zfs_handle_t *, int, zfs_iter_f, void *);
687 _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *);
689 typedef struct get_all_cb {
690 zfs_handle_t **cb_handles;
695 _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **,
696 size_t, zfs_iter_f, void *, boolean_t);
697 _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
700 * Functions to create and destroy datasets.
702 _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
704 _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *);
705 _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t);
706 _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
707 _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
708 _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *);
709 _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
710 _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t,
712 _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
714 _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
716 typedef struct renameflags {
717 /* recursive rename */
718 unsigned int recursive : 1;
720 /* don't unmount file systems */
721 unsigned int nounmount : 1;
723 /* force unmount file systems */
724 unsigned int forceunmount : 1;
727 _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t);
729 typedef struct sendflags {
730 /* Amount of extra information to print. */
733 /* recursive send (ie, -R) */
736 /* for recursive send, skip sending missing snapshots */
737 boolean_t skipmissing;
739 /* for incrementals, do all intermediate snapshots */
742 /* if dataset is a clone, do incremental from its origin */
743 boolean_t fromorigin;
745 /* field no longer used, maintained for backwards compatibility */
748 /* send properties (ie, -p) */
751 /* do not send (no-op, ie. -n) */
754 /* parsable verbose output (ie. -P) */
757 /* show progress (ie. -v) */
760 /* show progress as process title (ie. -V) */
761 boolean_t progressastitle;
763 /* large blocks (>128K) are permitted */
764 boolean_t largeblock;
766 /* WRITE_EMBEDDED records of type DATA are permitted */
767 boolean_t embed_data;
769 /* compressed WRITE records are permitted */
772 /* raw encrypted records are permitted */
775 /* only send received properties (ie. -b) */
778 /* include snapshot holds in send stream */
781 /* stream represents a partially received dataset */
785 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
787 _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *,
788 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
789 _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *,
791 _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *);
792 _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
794 _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *);
795 _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
798 _LIBZFS_H int zfs_promote(zfs_handle_t *);
799 _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *,
801 _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
802 _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *,
804 _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **);
805 _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t,
808 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
809 uid_t rid, uint64_t space);
811 _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
812 zfs_userspace_cb_t, void *);
814 _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
815 _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
817 typedef struct recvflags {
818 /* print informational messages (ie, -v was specified) */
821 /* the destination is a prefix, not the exact fs (ie, -d) */
825 * Only the tail of the sent snapshot path is appended to the
826 * destination to determine the received snapshot name (ie, -e).
830 /* do not actually do the recv, just check if it would work (ie, -n) */
833 /* rollback/destroy filesystems as necessary (eg, -F) */
836 /* set "canmount=off" on all modified filesystems */
837 boolean_t canmountoff;
840 * Mark the file systems as "resumable" and do not destroy them if the
841 * receive is interrupted
845 /* byteswap flag is used internally; callers need not specify */
848 /* do not mount file systems as they are extracted (private) */
851 /* Was holds flag set in the compound header? */
854 /* skip receive of snapshot holds */
857 /* mount the filesystem unless nomount is specified */
860 /* force unmount while recv snapshot (private) */
861 boolean_t forceunmount;
863 /* use this recv to check (and heal if needed) an existing snapshot */
867 _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
868 recvflags_t *, int, avl_tree_t *);
870 typedef enum diff_flags {
871 ZFS_DIFF_PARSEABLE = 1 << 0,
872 ZFS_DIFF_TIMESTAMP = 1 << 1,
873 ZFS_DIFF_CLASSIFY = 1 << 2,
874 ZFS_DIFF_NO_MANGLE = 1 << 3
877 _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
881 * Miscellaneous functions.
883 _LIBZFS_H const char *zfs_type_to_name(zfs_type_t);
884 _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *);
885 _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t);
886 _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *,
888 _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t);
889 _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
891 _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *);
892 _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path);
895 * Mount support functions.
897 _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
898 _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **);
899 _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int);
900 _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *);
901 _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int);
902 _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int);
903 _LIBZFS_H int zfs_mount_delegation_check(void);
905 #if defined(__linux__) || defined(__APPLE__)
906 _LIBZFS_H int zfs_parse_mount_options(const char *mntopts,
907 unsigned long *mntflags, unsigned long *zfsflags, int sloppy, char *badopt,
909 _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint,
910 char *mntopts, char *mtabopt);
914 * Share support functions.
916 * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL,
917 * NULL means "all/any known to this libzfs".
919 #define SA_NO_PROTOCOL -1
921 _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where,
922 const enum sa_protocol *proto);
923 _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto);
924 _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint,
925 const enum sa_protocol *proto);
926 _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp,
927 const enum sa_protocol *proto);
928 _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto);
929 _LIBZFS_H void zfs_truncate_shares(const enum sa_protocol *proto);
931 _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
934 * Utility functions to run an external process.
936 #define STDOUT_VERBOSE 0x01
937 #define STDERR_VERBOSE 0x02
938 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
940 _LIBZFS_H int libzfs_run_process(const char *, char **, int);
941 _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[],
943 _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[],
944 char *[], char **[], int *);
946 _LIBZFS_H void libzfs_free_str_array(char **, int);
948 _LIBZFS_H boolean_t libzfs_envvar_is_set(const char *);
951 * Utility functions for zfs version
953 _LIBZFS_H const char *zfs_version_userland(void);
954 _LIBZFS_H char *zfs_version_kernel(void);
955 _LIBZFS_H int zfs_version_print(void);
958 * Given a device or file, determine if it is part of a pool.
960 _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
964 * Label manipulation.
966 _LIBZFS_H int zpool_clear_label(int);
967 _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *);
968 _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **);
971 * Management interfaces for SMB ACL files
974 _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
975 _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
976 _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
977 _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *,
981 * Enable and disable datasets within a pool by mounting/unmounting and
982 * sharing/unsharing them.
984 _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int);
985 _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t);
986 _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t);
987 _LIBZFS_H void zpool_disable_volume_os(const char *);
990 * Parse a features file for -o compatibility
993 ZPOOL_COMPATIBILITY_OK,
994 ZPOOL_COMPATIBILITY_WARNTOKEN,
995 ZPOOL_COMPATIBILITY_BADTOKEN,
996 ZPOOL_COMPATIBILITY_BADFILE,
997 ZPOOL_COMPATIBILITY_NOFILES
998 } zpool_compat_status_t;
1000 _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *,
1001 boolean_t *, char *, size_t);
1006 * Attach/detach the given filesystem to/from the given jail.
1008 _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach);
1011 * Set loader options for next boot.
1013 _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t,
1016 #endif /* __FreeBSD__ */
1021 * Add or delete the given filesystem to/from the given user namespace.
1023 _LIBZFS_H int zfs_userns(zfs_handle_t *zhp, const char *nspath, int attach);
1031 #endif /* _LIBZFS_H */