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.
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_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) */
152 EZFS_VDEV_NOTSUP
, /* ops not supported for this type of vdev */
157 * The following data structures are all part
158 * of the zfs_allow_t data structure which is
159 * used for printing 'allow' permissions.
160 * It is a linked list of zfs_allow_t's which
161 * then contain avl tree's for user/group/sets/...
162 * and each one of the entries in those trees have
163 * avl tree's for the permissions they belong to and
164 * whether they are local,descendent or local+descendent
165 * permissions. The AVL trees are used primarily for
166 * sorting purposes, but also so that we can quickly find
167 * a given user and or permission.
169 typedef struct zfs_perm_node
{
171 char z_pname
[MAXPATHLEN
];
174 typedef struct zfs_allow_node
{
176 char z_key
[MAXPATHLEN
]; /* name, such as joe */
177 avl_tree_t z_localdescend
; /* local+descendent perms */
178 avl_tree_t z_local
; /* local permissions */
179 avl_tree_t z_descend
; /* descendent permissions */
182 typedef struct zfs_allow
{
183 struct zfs_allow
*z_next
;
184 char z_setpoint
[MAXPATHLEN
];
186 avl_tree_t z_crperms
;
189 avl_tree_t z_everyone
;
195 typedef struct zfs_handle zfs_handle_t
;
196 typedef struct zpool_handle zpool_handle_t
;
197 typedef struct libzfs_handle libzfs_handle_t
;
199 _LIBZFS_H
int zpool_wait(zpool_handle_t
*, zpool_wait_activity_t
);
200 _LIBZFS_H
int zpool_wait_status(zpool_handle_t
*, zpool_wait_activity_t
,
201 boolean_t
*, boolean_t
*);
204 * Library initialization
206 _LIBZFS_H libzfs_handle_t
*libzfs_init(void);
207 _LIBZFS_H
void libzfs_fini(libzfs_handle_t
*);
209 _LIBZFS_H libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
210 _LIBZFS_H libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
212 _LIBZFS_H
void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
214 _LIBZFS_H
void zfs_save_arguments(int argc
, char **, char *, int);
215 _LIBZFS_H
int zpool_log_history(libzfs_handle_t
*, const char *);
217 _LIBZFS_H
int libzfs_errno(libzfs_handle_t
*);
218 _LIBZFS_H
const char *libzfs_error_init(int);
219 _LIBZFS_H
const char *libzfs_error_action(libzfs_handle_t
*);
220 _LIBZFS_H
const char *libzfs_error_description(libzfs_handle_t
*);
221 _LIBZFS_H
int zfs_standard_error(libzfs_handle_t
*, int, const char *);
222 _LIBZFS_H
void libzfs_mnttab_init(libzfs_handle_t
*);
223 _LIBZFS_H
void libzfs_mnttab_fini(libzfs_handle_t
*);
224 _LIBZFS_H
void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
225 _LIBZFS_H
int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
227 _LIBZFS_H
void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
228 const char *, const char *);
229 _LIBZFS_H
void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
232 * Basic handle functions
234 _LIBZFS_H zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
235 _LIBZFS_H zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
236 _LIBZFS_H
void zpool_close(zpool_handle_t
*);
237 _LIBZFS_H
const char *zpool_get_name(zpool_handle_t
*);
238 _LIBZFS_H
int zpool_get_state(zpool_handle_t
*);
239 _LIBZFS_H
const char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
240 _LIBZFS_H
const char *zpool_pool_state_to_name(pool_state_t
);
241 _LIBZFS_H
void zpool_free_handles(libzfs_handle_t
*);
244 * Iterate over all active pools in the system.
246 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
247 _LIBZFS_H
int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
248 _LIBZFS_H boolean_t
zpool_skip_pool(const char *);
251 * Functions to create and destroy pools
253 _LIBZFS_H
int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
254 nvlist_t
*, nvlist_t
*);
255 _LIBZFS_H
int zpool_destroy(zpool_handle_t
*, const char *);
256 _LIBZFS_H
int zpool_add(zpool_handle_t
*, nvlist_t
*);
258 typedef struct splitflags
{
259 /* do not split, but return the config that would be split off */
262 /* after splitting, import the pool */
267 typedef struct trimflags
{
268 /* requested vdevs are for the entire pool */
271 /* request a secure trim, requires support from device */
274 /* after starting trim, block until trim completes */
277 /* trim at the requested rate in bytes/second */
282 * Functions to manipulate pool and vdev state
284 _LIBZFS_H
int zpool_scan(zpool_handle_t
*, pool_scan_func_t
, pool_scrub_cmd_t
);
285 _LIBZFS_H
int zpool_initialize(zpool_handle_t
*, pool_initialize_func_t
,
287 _LIBZFS_H
int zpool_initialize_wait(zpool_handle_t
*, pool_initialize_func_t
,
289 _LIBZFS_H
int zpool_trim(zpool_handle_t
*, pool_trim_func_t
, nvlist_t
*,
292 _LIBZFS_H
int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
293 _LIBZFS_H
int zpool_reguid(zpool_handle_t
*);
294 _LIBZFS_H
int zpool_reopen_one(zpool_handle_t
*, void *);
296 _LIBZFS_H
int zpool_sync_one(zpool_handle_t
*, void *);
298 _LIBZFS_H
int zpool_vdev_online(zpool_handle_t
*, const char *, int,
300 _LIBZFS_H
int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
301 _LIBZFS_H
int zpool_vdev_attach(zpool_handle_t
*, const char *,
302 const char *, nvlist_t
*, int, boolean_t
);
303 _LIBZFS_H
int zpool_vdev_detach(zpool_handle_t
*, const char *);
304 _LIBZFS_H
int zpool_vdev_remove(zpool_handle_t
*, const char *);
305 _LIBZFS_H
int zpool_vdev_remove_cancel(zpool_handle_t
*);
306 _LIBZFS_H
int zpool_vdev_indirect_size(zpool_handle_t
*, const char *,
308 _LIBZFS_H
int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**,
309 nvlist_t
*, splitflags_t
);
311 _LIBZFS_H
int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
312 _LIBZFS_H
int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
313 _LIBZFS_H
int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
315 _LIBZFS_H nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
316 boolean_t
*, boolean_t
*);
317 _LIBZFS_H nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
318 boolean_t
*, boolean_t
*, boolean_t
*);
319 _LIBZFS_H
int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*,
321 _LIBZFS_H
uint64_t zpool_vdev_path_to_guid(zpool_handle_t
*zhp
,
324 _LIBZFS_H
const char *zpool_get_state_str(zpool_handle_t
*);
327 * Functions to manage pool properties
329 _LIBZFS_H
int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
330 _LIBZFS_H
int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
331 size_t proplen
, zprop_source_t
*, boolean_t literal
);
332 _LIBZFS_H
uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
334 _LIBZFS_H
int zpool_props_refresh(zpool_handle_t
*);
336 _LIBZFS_H
const char *zpool_prop_to_name(zpool_prop_t
);
337 _LIBZFS_H
const char *zpool_prop_values(zpool_prop_t
);
340 * Functions to manage vdev properties
342 _LIBZFS_H
int zpool_get_vdev_prop_value(nvlist_t
*, vdev_prop_t
, char *, char *,
343 size_t, zprop_source_t
*, boolean_t
);
344 _LIBZFS_H
int zpool_get_vdev_prop(zpool_handle_t
*, const char *, vdev_prop_t
,
345 char *, char *, size_t, zprop_source_t
*, boolean_t
);
346 _LIBZFS_H
int zpool_get_all_vdev_props(zpool_handle_t
*, const char *,
348 _LIBZFS_H
int zpool_set_vdev_prop(zpool_handle_t
*, const char *, const char *,
351 _LIBZFS_H
const char *vdev_prop_to_name(vdev_prop_t
);
352 _LIBZFS_H
const char *vdev_prop_values(vdev_prop_t
);
353 _LIBZFS_H boolean_t
vdev_prop_user(const char *name
);
354 _LIBZFS_H
const char *vdev_prop_column_name(vdev_prop_t
);
355 _LIBZFS_H boolean_t
vdev_prop_align_right(vdev_prop_t
);
358 * Pool health statistics.
362 * The following correspond to faults as defined in the (fault.fs.zfs.*)
363 * event namespace. Each is associated with a corresponding message ID.
364 * This must be kept in sync with the zfs_msgid_table in
365 * lib/libzfs/libzfs_status.c.
367 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
368 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
369 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
370 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
371 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
372 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
373 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
374 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
375 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
376 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
377 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
378 ZPOOL_STATUS_HOSTID_ACTIVE
, /* currently active on another system */
379 ZPOOL_STATUS_HOSTID_REQUIRED
, /* multihost=on and hostid=0 */
380 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
381 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
382 ZPOOL_STATUS_IO_FAILURE_MMP
, /* failed MMP, failmode not 'panic' */
383 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
384 ZPOOL_STATUS_ERRATA
, /* informational errata available */
387 * If the pool has unsupported features but can still be opened in
388 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
389 * pool has unsupported features but cannot be opened at all, its
390 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
392 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
393 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
396 * These faults have no corresponding message ID. At the time we are
397 * checking the status, the original reason for the FMA fault (I/O or
398 * checksum errors) has been lost.
400 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
401 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
404 * The following are not faults per se, but still an error possibly
405 * requiring administrative attention. There is no corresponding
408 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
409 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
410 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
411 ZPOOL_STATUS_OFFLINE_DEV
, /* device offline */
412 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
413 ZPOOL_STATUS_REBUILDING
, /* device being rebuilt */
414 ZPOOL_STATUS_REBUILD_SCRUB
, /* recommend scrubbing the pool */
415 ZPOOL_STATUS_NON_NATIVE_ASHIFT
, /* (e.g. 512e dev with ashift of 9) */
416 ZPOOL_STATUS_COMPATIBILITY_ERR
, /* bad 'compatibility' property */
417 ZPOOL_STATUS_INCOMPATIBLE_FEAT
, /* feature set outside compatibility */
420 * Finally, the following indicates a healthy pool.
425 _LIBZFS_H zpool_status_t
zpool_get_status(zpool_handle_t
*, char **,
427 _LIBZFS_H zpool_status_t
zpool_import_status(nvlist_t
*, char **,
431 * Statistics and configuration functions.
433 _LIBZFS_H nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
434 _LIBZFS_H nvlist_t
*zpool_get_features(zpool_handle_t
*);
435 _LIBZFS_H
int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
436 _LIBZFS_H
int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
439 * Import and export functions
441 _LIBZFS_H
int zpool_export(zpool_handle_t
*, boolean_t
, const char *);
442 _LIBZFS_H
int zpool_export_force(zpool_handle_t
*, const char *);
443 _LIBZFS_H
int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
445 _LIBZFS_H
int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
447 _LIBZFS_H
void zpool_print_unsup_feat(nvlist_t
*config
);
450 * Miscellaneous pool functions
454 _LIBZFS_H
const char *const zfs_history_event_names
[];
457 VDEV_NAME_PATH
= 1 << 0,
458 VDEV_NAME_GUID
= 1 << 1,
459 VDEV_NAME_FOLLOW_LINKS
= 1 << 2,
460 VDEV_NAME_TYPE_ID
= 1 << 3,
463 _LIBZFS_H
char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
465 _LIBZFS_H
int zpool_upgrade(zpool_handle_t
*, uint64_t);
466 _LIBZFS_H
int zpool_get_history(zpool_handle_t
*, nvlist_t
**, uint64_t *,
468 _LIBZFS_H
int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, unsigned,
470 _LIBZFS_H
int zpool_events_clear(libzfs_handle_t
*, int *);
471 _LIBZFS_H
int zpool_events_seek(libzfs_handle_t
*, uint64_t, int);
472 _LIBZFS_H
void zpool_obj_to_path_ds(zpool_handle_t
*, uint64_t, uint64_t,
474 _LIBZFS_H
void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
476 _LIBZFS_H
int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
477 _LIBZFS_H
int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
478 _LIBZFS_H
void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
480 _LIBZFS_H
int zpool_checkpoint(zpool_handle_t
*);
481 _LIBZFS_H
int zpool_discard_checkpoint(zpool_handle_t
*);
482 _LIBZFS_H boolean_t
zpool_is_draid_spare(const char *);
485 * Basic handle manipulations. These functions do not create or destroy the
486 * underlying datasets, only the references to them.
488 _LIBZFS_H zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
489 _LIBZFS_H zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
490 _LIBZFS_H
void zfs_close(zfs_handle_t
*);
491 _LIBZFS_H zfs_type_t
zfs_get_type(const zfs_handle_t
*);
492 _LIBZFS_H zfs_type_t
zfs_get_underlying_type(const zfs_handle_t
*);
493 _LIBZFS_H
const char *zfs_get_name(const zfs_handle_t
*);
494 _LIBZFS_H zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
495 _LIBZFS_H
const char *zfs_get_pool_name(const zfs_handle_t
*);
498 * Property management functions. Some functions are shared with the kernel,
499 * and are found in sys/fs/zfs.h.
503 * zfs dataset property management
505 _LIBZFS_H
const char *zfs_prop_default_string(zfs_prop_t
);
506 _LIBZFS_H
uint64_t zfs_prop_default_numeric(zfs_prop_t
);
507 _LIBZFS_H
const char *zfs_prop_column_name(zfs_prop_t
);
508 _LIBZFS_H boolean_t
zfs_prop_align_right(zfs_prop_t
);
510 _LIBZFS_H nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
511 nvlist_t
*, uint64_t, zfs_handle_t
*, zpool_handle_t
*, boolean_t
,
514 _LIBZFS_H
const char *zfs_prop_to_name(zfs_prop_t
);
515 _LIBZFS_H
int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
516 _LIBZFS_H
int zfs_prop_set_list(zfs_handle_t
*, nvlist_t
*);
517 _LIBZFS_H
int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
518 zprop_source_t
*, char *, size_t, boolean_t
);
519 _LIBZFS_H
int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
521 _LIBZFS_H
int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
522 zprop_source_t
*, char *, size_t);
523 _LIBZFS_H
int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
,
524 const char *propname
, uint64_t *propvalue
);
525 _LIBZFS_H
int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
526 char *propbuf
, int proplen
, boolean_t literal
);
527 _LIBZFS_H
int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
528 uint64_t *propvalue
);
529 _LIBZFS_H
int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
530 char *propbuf
, int proplen
, boolean_t literal
);
531 _LIBZFS_H
int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
532 char *buf
, size_t len
);
533 _LIBZFS_H
uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
534 _LIBZFS_H
uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
535 _LIBZFS_H
int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
536 _LIBZFS_H
const char *zfs_prop_values(zfs_prop_t
);
537 _LIBZFS_H
int zfs_prop_is_string(zfs_prop_t prop
);
538 _LIBZFS_H nvlist_t
*zfs_get_all_props(zfs_handle_t
*);
539 _LIBZFS_H nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
540 _LIBZFS_H nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
541 _LIBZFS_H nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
543 _LIBZFS_H
int zfs_wait_status(zfs_handle_t
*, zfs_wait_activity_t
,
544 boolean_t
*, boolean_t
*);
547 * zfs encryption management
549 _LIBZFS_H
int zfs_crypto_get_encryption_root(zfs_handle_t
*, boolean_t
*,
551 _LIBZFS_H
int zfs_crypto_create(libzfs_handle_t
*, char *, nvlist_t
*,
552 nvlist_t
*, boolean_t stdin_available
, uint8_t **, uint_t
*);
553 _LIBZFS_H
int zfs_crypto_clone_check(libzfs_handle_t
*, zfs_handle_t
*, char *,
555 _LIBZFS_H
int zfs_crypto_attempt_load_keys(libzfs_handle_t
*, const char *);
556 _LIBZFS_H
int zfs_crypto_load_key(zfs_handle_t
*, boolean_t
, const char *);
557 _LIBZFS_H
int zfs_crypto_unload_key(zfs_handle_t
*);
558 _LIBZFS_H
int zfs_crypto_rewrap(zfs_handle_t
*, nvlist_t
*, boolean_t
);
560 typedef struct zprop_list
{
563 struct zprop_list
*pl_next
;
566 size_t pl_recvd_width
;
570 _LIBZFS_H
int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
,
572 _LIBZFS_H
void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
573 _LIBZFS_H
int vdev_expand_proplist(zpool_handle_t
*, const char *,
576 #define ZFS_MOUNTPOINT_NONE "none"
577 #define ZFS_MOUNTPOINT_LEGACY "legacy"
579 #define ZFS_FEATURE_DISABLED "disabled"
580 #define ZFS_FEATURE_ENABLED "enabled"
581 #define ZFS_FEATURE_ACTIVE "active"
583 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
584 #define ZFS_UNSUPPORTED_READONLY "readonly"
587 * zpool property management
589 _LIBZFS_H
int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**,
590 zfs_type_t
, boolean_t
);
591 _LIBZFS_H
int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
593 _LIBZFS_H
const char *zpool_prop_default_string(zpool_prop_t
);
594 _LIBZFS_H
uint64_t zpool_prop_default_numeric(zpool_prop_t
);
595 _LIBZFS_H
const char *zpool_prop_column_name(zpool_prop_t
);
596 _LIBZFS_H boolean_t
zpool_prop_align_right(zpool_prop_t
);
599 * Functions shared by zfs and zpool property management.
601 _LIBZFS_H
int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
602 boolean_t ordered
, zfs_type_t type
);
603 _LIBZFS_H
int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
605 _LIBZFS_H
void zprop_free_list(zprop_list_t
*);
607 #define ZFS_GET_NCOLS 5
619 * Functions for printing zfs or zpool properties
621 typedef struct vdev_cbdata
{
624 unsigned int cb_names_count
;
627 typedef struct zprop_get_cbdata
{
629 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
630 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
631 boolean_t cb_scripted
;
632 boolean_t cb_literal
;
634 zprop_list_t
*cb_proplist
;
636 vdev_cbdata_t cb_vdevs
;
637 } zprop_get_cbdata_t
;
639 _LIBZFS_H
void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
640 const char *, const char *, zprop_source_t
, const char *,
644 * Iterator functions.
646 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
647 _LIBZFS_H
int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
648 _LIBZFS_H
int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
649 _LIBZFS_H
int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
,
651 _LIBZFS_H
int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
652 _LIBZFS_H
int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *,
654 _LIBZFS_H
int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *,
656 _LIBZFS_H
int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
,
658 _LIBZFS_H
int zfs_iter_bookmarks(zfs_handle_t
*, zfs_iter_f
, void *);
659 _LIBZFS_H
int zfs_iter_mounted(zfs_handle_t
*, zfs_iter_f
, void *);
661 typedef struct get_all_cb
{
662 zfs_handle_t
**cb_handles
;
667 _LIBZFS_H
void zfs_foreach_mountpoint(libzfs_handle_t
*, zfs_handle_t
**,
668 size_t, zfs_iter_f
, void *, boolean_t
);
669 _LIBZFS_H
void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
672 * Functions to create and destroy datasets.
674 _LIBZFS_H
int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
676 _LIBZFS_H
int zfs_create_ancestors(libzfs_handle_t
*, const char *);
677 _LIBZFS_H
int zfs_destroy(zfs_handle_t
*, boolean_t
);
678 _LIBZFS_H
int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
679 _LIBZFS_H
int zfs_destroy_snaps_nvl(libzfs_handle_t
*, nvlist_t
*, boolean_t
);
680 _LIBZFS_H
int zfs_destroy_snaps_nvl_os(libzfs_handle_t
*, nvlist_t
*);
681 _LIBZFS_H
int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
682 _LIBZFS_H
int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
,
684 _LIBZFS_H
int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
686 _LIBZFS_H
int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
688 typedef struct renameflags
{
689 /* recursive rename */
692 /* don't unmount file systems */
695 /* force unmount file systems */
696 int forceunmount
: 1;
699 _LIBZFS_H
int zfs_rename(zfs_handle_t
*, const char *, renameflags_t
);
701 typedef struct sendflags
{
702 /* Amount of extra information to print. */
705 /* recursive send (ie, -R) */
708 /* for recursive send, skip sending missing snapshots */
709 boolean_t skipmissing
;
711 /* for incrementals, do all intermediate snapshots */
714 /* if dataset is a clone, do incremental from its origin */
715 boolean_t fromorigin
;
717 /* field no longer used, maintained for backwards compatibility */
720 /* send properties (ie, -p) */
723 /* do not send (no-op, ie. -n) */
726 /* parsable verbose output (ie. -P) */
729 /* show progress (ie. -v) */
732 /* large blocks (>128K) are permitted */
733 boolean_t largeblock
;
735 /* WRITE_EMBEDDED records of type DATA are permitted */
736 boolean_t embed_data
;
738 /* compressed WRITE records are permitted */
741 /* raw encrypted records are permitted */
744 /* only send received properties (ie. -b) */
747 /* include snapshot holds in send stream */
750 /* stream represents a partially received dataset */
754 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
756 _LIBZFS_H
int zfs_send(zfs_handle_t
*, const char *, const char *,
757 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
758 _LIBZFS_H
int zfs_send_one(zfs_handle_t
*, const char *, int, sendflags_t
*,
760 _LIBZFS_H
int zfs_send_progress(zfs_handle_t
*, int, uint64_t *, uint64_t *);
761 _LIBZFS_H
int zfs_send_resume(libzfs_handle_t
*, sendflags_t
*, int outfd
,
763 _LIBZFS_H
int zfs_send_saved(zfs_handle_t
*, sendflags_t
*, int, const char *);
764 _LIBZFS_H nvlist_t
*zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
,
767 _LIBZFS_H
int zfs_promote(zfs_handle_t
*);
768 _LIBZFS_H
int zfs_hold(zfs_handle_t
*, const char *, const char *,
770 _LIBZFS_H
int zfs_hold_nvl(zfs_handle_t
*, int, nvlist_t
*);
771 _LIBZFS_H
int zfs_release(zfs_handle_t
*, const char *, const char *,
773 _LIBZFS_H
int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
774 _LIBZFS_H
uint64_t zvol_volsize_to_reservation(zpool_handle_t
*, uint64_t,
777 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
778 uid_t rid
, uint64_t space
);
780 _LIBZFS_H
int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
781 zfs_userspace_cb_t
, void *);
783 _LIBZFS_H
int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
784 _LIBZFS_H
int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
786 typedef struct recvflags
{
787 /* print informational messages (ie, -v was specified) */
790 /* the destination is a prefix, not the exact fs (ie, -d) */
794 * Only the tail of the sent snapshot path is appended to the
795 * destination to determine the received snapshot name (ie, -e).
799 /* do not actually do the recv, just check if it would work (ie, -n) */
802 /* rollback/destroy filesystems as necessary (eg, -F) */
805 /* set "canmount=off" on all modified filesystems */
806 boolean_t canmountoff
;
809 * Mark the file systems as "resumable" and do not destroy them if the
810 * receive is interrupted
814 /* byteswap flag is used internally; callers need not specify */
817 /* do not mount file systems as they are extracted (private) */
820 /* Was holds flag set in the compound header? */
823 /* skip receive of snapshot holds */
826 /* mount the filesystem unless nomount is specified */
829 /* force unmount while recv snapshot (private) */
830 boolean_t forceunmount
;
833 _LIBZFS_H
int zfs_receive(libzfs_handle_t
*, const char *, nvlist_t
*,
834 recvflags_t
*, int, avl_tree_t
*);
836 typedef enum diff_flags
{
837 ZFS_DIFF_PARSEABLE
= 1 << 0,
838 ZFS_DIFF_TIMESTAMP
= 1 << 1,
839 ZFS_DIFF_CLASSIFY
= 1 << 2,
840 ZFS_DIFF_NO_MANGLE
= 1 << 3
843 _LIBZFS_H
int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
847 * Miscellaneous functions.
849 _LIBZFS_H
const char *zfs_type_to_name(zfs_type_t
);
850 _LIBZFS_H
void zfs_refresh_properties(zfs_handle_t
*);
851 _LIBZFS_H
int zfs_name_valid(const char *, zfs_type_t
);
852 _LIBZFS_H zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, const char *,
854 _LIBZFS_H
int zfs_parent_name(zfs_handle_t
*, char *, size_t);
855 _LIBZFS_H boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
857 _LIBZFS_H
int zfs_spa_version(zfs_handle_t
*, int *);
858 _LIBZFS_H boolean_t
zfs_bookmark_exists(const char *path
);
861 * Mount support functions.
863 _LIBZFS_H boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
864 _LIBZFS_H boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
865 _LIBZFS_H
int zfs_mount(zfs_handle_t
*, const char *, int);
866 _LIBZFS_H
int zfs_mount_at(zfs_handle_t
*, const char *, int, const char *);
867 _LIBZFS_H
int zfs_unmount(zfs_handle_t
*, const char *, int);
868 _LIBZFS_H
int zfs_unmountall(zfs_handle_t
*, int);
869 _LIBZFS_H
int zfs_mount_delegation_check(void);
871 #if defined(__linux__) || defined(__APPLE__)
872 _LIBZFS_H
int zfs_parse_mount_options(char *mntopts
, unsigned long *mntflags
,
873 unsigned long *zfsflags
, int sloppy
, char *badopt
, char *mtabopt
);
874 _LIBZFS_H
void zfs_adjust_mount_options(zfs_handle_t
*zhp
, const char *mntpoint
,
875 char *mntopts
, char *mtabopt
);
879 * Share support functions.
881 * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL,
882 * NULL means "all/any known to this libzfs".
884 #define SA_NO_PROTOCOL -1
886 _LIBZFS_H boolean_t
zfs_is_shared(zfs_handle_t
*zhp
, char **where
,
887 const enum sa_protocol
*proto
);
888 _LIBZFS_H
int zfs_share(zfs_handle_t
*zhp
, const enum sa_protocol
*proto
);
889 _LIBZFS_H
int zfs_unshare(zfs_handle_t
*zhp
, const char *mountpoint
,
890 const enum sa_protocol
*proto
);
891 _LIBZFS_H
int zfs_unshareall(zfs_handle_t
*zhp
,
892 const enum sa_protocol
*proto
);
893 _LIBZFS_H
void zfs_commit_shares(const enum sa_protocol
*proto
);
895 _LIBZFS_H
int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
898 * Utility functions to run an external process.
900 #define STDOUT_VERBOSE 0x01
901 #define STDERR_VERBOSE 0x02
902 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
904 _LIBZFS_H
int libzfs_run_process(const char *, char **, int);
905 _LIBZFS_H
int libzfs_run_process_get_stdout(const char *, char *[], char *[],
907 _LIBZFS_H
int libzfs_run_process_get_stdout_nopath(const char *, char *[],
908 char *[], char **[], int *);
910 _LIBZFS_H
void libzfs_free_str_array(char **, int);
912 _LIBZFS_H
int libzfs_envvar_is_set(char *);
915 * Utility functions for zfs version
917 _LIBZFS_H
const char *zfs_version_userland(void);
918 _LIBZFS_H
char *zfs_version_kernel(void);
919 _LIBZFS_H
int zfs_version_print(void);
922 * Given a device or file, determine if it is part of a pool.
924 _LIBZFS_H
int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
928 * Label manipulation.
930 _LIBZFS_H
int zpool_clear_label(int);
931 _LIBZFS_H
int zpool_set_bootenv(zpool_handle_t
*, const nvlist_t
*);
932 _LIBZFS_H
int zpool_get_bootenv(zpool_handle_t
*, nvlist_t
**);
935 * Management interfaces for SMB ACL files
938 _LIBZFS_H
int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
939 _LIBZFS_H
int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
940 _LIBZFS_H
int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
941 _LIBZFS_H
int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *,
945 * Enable and disable datasets within a pool by mounting/unmounting and
946 * sharing/unsharing them.
948 _LIBZFS_H
int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
949 _LIBZFS_H
int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
950 _LIBZFS_H
void zpool_disable_datasets_os(zpool_handle_t
*, boolean_t
);
951 _LIBZFS_H
void zpool_disable_volume_os(const char *);
954 * Parse a features file for -o compatibility
957 ZPOOL_COMPATIBILITY_OK
,
958 ZPOOL_COMPATIBILITY_WARNTOKEN
,
959 ZPOOL_COMPATIBILITY_BADTOKEN
,
960 ZPOOL_COMPATIBILITY_BADFILE
,
961 ZPOOL_COMPATIBILITY_NOFILES
962 } zpool_compat_status_t
;
964 _LIBZFS_H zpool_compat_status_t
zpool_load_compat(const char *,
965 boolean_t
*, char *, size_t);
970 * Attach/detach the given filesystem to/from the given jail.
972 _LIBZFS_H
int zfs_jail(zfs_handle_t
*zhp
, int jailid
, int attach
);
975 * Set loader options for next boot.
977 _LIBZFS_H
int zpool_nextboot(libzfs_handle_t
*, uint64_t, uint64_t,
980 #endif /* __FreeBSD__ */
986 #endif /* _LIBZFS_H */