]>
Commit | Line | Data |
---|---|---|
34dc7c2f BB |
1 | /* |
2 | * CDDL HEADER START | |
3 | * | |
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. | |
7 | * | |
8 | * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE | |
1d3ba0bf | 9 | * or https://opensource.org/licenses/CDDL-1.0. |
34dc7c2f BB |
10 | * See the License for the specific language governing permissions |
11 | * and limitations under the License. | |
12 | * | |
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] | |
18 | * | |
19 | * CDDL HEADER END | |
20 | */ | |
21 | ||
22 | /* | |
428870ff | 23 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
b1e46f86 | 24 | * Copyright (c) 2011, 2024 by Delphix. All rights reserved. |
341166c8 | 25 | * Copyright Joyent, Inc. |
95fd54a1 | 26 | * Copyright (c) 2013 Steven Hartland. All rights reserved. |
39fc0cb5 | 27 | * Copyright (c) 2016, Intel Corporation. |
d21d5b82 | 28 | * Copyright 2016 Nexenta Systems, Inc. |
d3f2cd7e | 29 | * Copyright (c) 2017 Open-E, Inc. All Rights Reserved. |
4c0883fb | 30 | * Copyright (c) 2019 Datto Inc. |
658fb802 | 31 | * Copyright (c) 2021, Colm Buckley <colm@tuatha.org> |
34dc7c2f BB |
32 | */ |
33 | ||
34 | #ifndef _LIBZFS_H | |
739cfb96 | 35 | #define _LIBZFS_H extern __attribute__((visibility("default"))) |
34dc7c2f | 36 | |
34dc7c2f | 37 | #include <assert.h> |
b4d9a82f | 38 | #include <libshare.h> |
34dc7c2f | 39 | #include <libnvpair.h> |
fb5f0bc8 | 40 | #include <sys/mnttab.h> |
34dc7c2f BB |
41 | #include <sys/param.h> |
42 | #include <sys/types.h> | |
34dc7c2f BB |
43 | #include <sys/fs/zfs.h> |
44 | #include <sys/avl.h> | |
9b67f605 | 45 | #include <libzfs_core.h> |
34dc7c2f BB |
46 | |
47 | #ifdef __cplusplus | |
48 | extern "C" { | |
49 | #endif | |
50 | ||
51 | /* | |
52 | * Miscellaneous ZFS constants | |
53 | */ | |
34dc7c2f BB |
54 | #define ZFS_MAXPROPLEN MAXPATHLEN |
55 | #define ZPOOL_MAXPROPLEN MAXPATHLEN | |
56 | ||
57 | /* | |
58 | * libzfs errors | |
59 | */ | |
6f1ffb06 MA |
60 | typedef enum zfs_error { |
61 | EZFS_SUCCESS = 0, /* no error -- success */ | |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
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 */ | |
9a49d3f3 | 82 | EZFS_RESILVERING, /* resilvering (healing reconstruction) */ |
34dc7c2f BB |
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 */ | |
76d04993 RM |
91 | EZFS_UNSHARENFSFAILED, /* failed to unshare over nfs */ |
92 | EZFS_SHARENFSFAILED, /* failed to share over nfs */ | |
34dc7c2f BB |
93 | EZFS_PERM, /* permission denied */ |
94 | EZFS_NOSPC, /* out of space */ | |
428870ff | 95 | EZFS_FAULT, /* bad address */ |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
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 */ | |
b128c09f BB |
118 | EZFS_NOTSUP, /* ops not supported on this dataset */ |
119 | EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ | |
9babb374 | 120 | EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ |
45d1cae3 BB |
121 | EZFS_REFTAG_RELE, /* snapshot release: tag not found */ |
122 | EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ | |
428870ff BB |
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 */ | |
482eeef8 GA |
128 | EZFS_ERRORSCRUBBING, /* currently error scrubbing */ |
129 | EZFS_ERRORSCRUB_PAUSED, /* error scrub currently paused */ | |
428870ff | 130 | EZFS_NO_SCRUB, /* no active scrub */ |
572e2857 BB |
131 | EZFS_DIFF, /* general failure of zfs diff */ |
132 | EZFS_DIFFDATA, /* bad zfs diff data */ | |
133 | EZFS_POOLREADONLY, /* pool is in read-only mode */ | |
0ea05c64 | 134 | EZFS_SCRUB_PAUSED, /* scrub currently paused */ |
482eeef8 | 135 | EZFS_SCRUB_PAUSED_TO_CANCEL, /* scrub currently paused */ |
379ca9cf | 136 | EZFS_ACTIVE_POOL, /* pool is imported on a different system */ |
b5256303 | 137 | EZFS_CRYPTOFAILED, /* failed to setup encryption */ |
a1d477c2 | 138 | EZFS_NO_PENDING, /* cannot cancel, no operation is pending */ |
d2734cce SD |
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 */ | |
b83a0e2d | 144 | EZFS_IOC_NOTSUPPORTED, /* operation not supported by zfs module */ |
619f0976 GW |
145 | EZFS_TOOMANY, /* argument list too long */ |
146 | EZFS_INITIALIZING, /* currently initializing */ | |
147 | EZFS_NO_INITIALIZE, /* no active initialize */ | |
d8d418ff | 148 | EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */ |
1b939560 BB |
149 | EZFS_TRIMMING, /* currently trimming */ |
150 | EZFS_NO_TRIM, /* no active trim */ | |
151 | EZFS_TRIM_NOTSUP, /* device does not support trim */ | |
fa241660 | 152 | EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ |
43a85362 | 153 | EZFS_EXPORT_IN_PROGRESS, /* currently exporting the pool */ |
9a49d3f3 | 154 | EZFS_REBUILDING, /* resilvering (sequential reconstrution) */ |
2a673e76 | 155 | EZFS_VDEV_NOTSUP, /* ops not supported for this type of vdev */ |
4ed5e250 | 156 | EZFS_NOT_USER_NAMESPACE, /* a file is not a user namespace */ |
6c8e9f09 | 157 | EZFS_CKSUM, /* insufficient replicas */ |
3ed9d688 | 158 | EZFS_RESUME_EXISTS, /* Resume on existing dataset without force */ |
71472bf3 | 159 | EZFS_SHAREFAILED, /* filesystem share failed */ |
5caeef02 | 160 | EZFS_RAIDZ_EXPAND_IN_PROGRESS, /* a raidz is currently expanding */ |
b1e46f86 | 161 | EZFS_ASHIFT_MISMATCH, /* can't add vdevs with different ashifts */ |
34dc7c2f | 162 | EZFS_UNKNOWN |
6f1ffb06 | 163 | } zfs_error_t; |
34dc7c2f BB |
164 | |
165 | /* | |
166 | * The following data structures are all part | |
167 | * of the zfs_allow_t data structure which is | |
168 | * used for printing 'allow' permissions. | |
169 | * It is a linked list of zfs_allow_t's which | |
170 | * then contain avl tree's for user/group/sets/... | |
171 | * and each one of the entries in those trees have | |
172 | * avl tree's for the permissions they belong to and | |
173 | * whether they are local,descendent or local+descendent | |
174 | * permissions. The AVL trees are used primarily for | |
175 | * sorting purposes, but also so that we can quickly find | |
176 | * a given user and or permission. | |
177 | */ | |
178 | typedef struct zfs_perm_node { | |
179 | avl_node_t z_node; | |
180 | char z_pname[MAXPATHLEN]; | |
181 | } zfs_perm_node_t; | |
182 | ||
183 | typedef struct zfs_allow_node { | |
184 | avl_node_t z_node; | |
185 | char z_key[MAXPATHLEN]; /* name, such as joe */ | |
186 | avl_tree_t z_localdescend; /* local+descendent perms */ | |
187 | avl_tree_t z_local; /* local permissions */ | |
188 | avl_tree_t z_descend; /* descendent permissions */ | |
189 | } zfs_allow_node_t; | |
190 | ||
191 | typedef struct zfs_allow { | |
192 | struct zfs_allow *z_next; | |
193 | char z_setpoint[MAXPATHLEN]; | |
194 | avl_tree_t z_sets; | |
195 | avl_tree_t z_crperms; | |
196 | avl_tree_t z_user; | |
197 | avl_tree_t z_group; | |
198 | avl_tree_t z_everyone; | |
199 | } zfs_allow_t; | |
200 | ||
201 | /* | |
202 | * Basic handle types | |
203 | */ | |
204 | typedef struct zfs_handle zfs_handle_t; | |
205 | typedef struct zpool_handle zpool_handle_t; | |
206 | typedef struct libzfs_handle libzfs_handle_t; | |
207 | ||
739cfb96 AZ |
208 | _LIBZFS_H int zpool_wait(zpool_handle_t *, zpool_wait_activity_t); |
209 | _LIBZFS_H int zpool_wait_status(zpool_handle_t *, zpool_wait_activity_t, | |
e60e158e JG |
210 | boolean_t *, boolean_t *); |
211 | ||
34dc7c2f BB |
212 | /* |
213 | * Library initialization | |
214 | */ | |
739cfb96 AZ |
215 | _LIBZFS_H libzfs_handle_t *libzfs_init(void); |
216 | _LIBZFS_H void libzfs_fini(libzfs_handle_t *); | |
34dc7c2f | 217 | |
739cfb96 AZ |
218 | _LIBZFS_H libzfs_handle_t *zpool_get_handle(zpool_handle_t *); |
219 | _LIBZFS_H libzfs_handle_t *zfs_get_handle(zfs_handle_t *); | |
34dc7c2f | 220 | |
739cfb96 | 221 | _LIBZFS_H void libzfs_print_on_error(libzfs_handle_t *, boolean_t); |
34dc7c2f | 222 | |
739cfb96 AZ |
223 | _LIBZFS_H void zfs_save_arguments(int argc, char **, char *, int); |
224 | _LIBZFS_H int zpool_log_history(libzfs_handle_t *, const char *); | |
6f1ffb06 | 225 | |
739cfb96 AZ |
226 | _LIBZFS_H int libzfs_errno(libzfs_handle_t *); |
227 | _LIBZFS_H const char *libzfs_error_init(int); | |
228 | _LIBZFS_H const char *libzfs_error_action(libzfs_handle_t *); | |
229 | _LIBZFS_H const char *libzfs_error_description(libzfs_handle_t *); | |
230 | _LIBZFS_H int zfs_standard_error(libzfs_handle_t *, int, const char *); | |
231 | _LIBZFS_H void libzfs_mnttab_init(libzfs_handle_t *); | |
232 | _LIBZFS_H void libzfs_mnttab_fini(libzfs_handle_t *); | |
233 | _LIBZFS_H void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); | |
234 | _LIBZFS_H int libzfs_mnttab_find(libzfs_handle_t *, const char *, | |
fb5f0bc8 | 235 | struct mnttab *); |
739cfb96 | 236 | _LIBZFS_H void libzfs_mnttab_add(libzfs_handle_t *, const char *, |
fb5f0bc8 | 237 | const char *, const char *); |
739cfb96 | 238 | _LIBZFS_H void libzfs_mnttab_remove(libzfs_handle_t *, const char *); |
34dc7c2f BB |
239 | |
240 | /* | |
241 | * Basic handle functions | |
242 | */ | |
739cfb96 AZ |
243 | _LIBZFS_H zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); |
244 | _LIBZFS_H zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); | |
245 | _LIBZFS_H void zpool_close(zpool_handle_t *); | |
246 | _LIBZFS_H const char *zpool_get_name(zpool_handle_t *); | |
247 | _LIBZFS_H int zpool_get_state(zpool_handle_t *); | |
248 | _LIBZFS_H const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); | |
249 | _LIBZFS_H const char *zpool_pool_state_to_name(pool_state_t); | |
250 | _LIBZFS_H void zpool_free_handles(libzfs_handle_t *); | |
34dc7c2f BB |
251 | |
252 | /* | |
253 | * Iterate over all active pools in the system. | |
254 | */ | |
255 | typedef int (*zpool_iter_f)(zpool_handle_t *, void *); | |
739cfb96 AZ |
256 | _LIBZFS_H int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); |
257 | _LIBZFS_H boolean_t zpool_skip_pool(const char *); | |
34dc7c2f BB |
258 | |
259 | /* | |
260 | * Functions to create and destroy pools | |
261 | */ | |
739cfb96 | 262 | _LIBZFS_H int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, |
b128c09f | 263 | nvlist_t *, nvlist_t *); |
739cfb96 | 264 | _LIBZFS_H int zpool_destroy(zpool_handle_t *, const char *); |
b1e46f86 | 265 | _LIBZFS_H int zpool_add(zpool_handle_t *, nvlist_t *, boolean_t check_ashift); |
34dc7c2f | 266 | |
428870ff BB |
267 | typedef struct splitflags { |
268 | /* do not split, but return the config that would be split off */ | |
abb42dc5 | 269 | unsigned int dryrun : 1; |
428870ff BB |
270 | |
271 | /* after splitting, import the pool */ | |
abb42dc5 | 272 | unsigned int import : 1; |
d2f3e292 | 273 | int name_flags; |
428870ff BB |
274 | } splitflags_t; |
275 | ||
1b939560 BB |
276 | typedef struct trimflags { |
277 | /* requested vdevs are for the entire pool */ | |
278 | boolean_t fullpool; | |
279 | ||
280 | /* request a secure trim, requires support from device */ | |
281 | boolean_t secure; | |
282 | ||
2288d419 BB |
283 | /* after starting trim, block until trim completes */ |
284 | boolean_t wait; | |
285 | ||
1b939560 BB |
286 | /* trim at the requested rate in bytes/second */ |
287 | uint64_t rate; | |
288 | } trimflags_t; | |
289 | ||
34dc7c2f BB |
290 | /* |
291 | * Functions to manipulate pool and vdev state | |
292 | */ | |
739cfb96 AZ |
293 | _LIBZFS_H int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); |
294 | _LIBZFS_H int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, | |
619f0976 | 295 | nvlist_t *); |
739cfb96 | 296 | _LIBZFS_H int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t, |
e60e158e | 297 | nvlist_t *); |
739cfb96 | 298 | _LIBZFS_H int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *, |
1b939560 BB |
299 | trimflags_t *); |
300 | ||
739cfb96 AZ |
301 | _LIBZFS_H int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); |
302 | _LIBZFS_H int zpool_reguid(zpool_handle_t *); | |
303 | _LIBZFS_H int zpool_reopen_one(zpool_handle_t *, void *); | |
34dc7c2f | 304 | |
739cfb96 | 305 | _LIBZFS_H int zpool_sync_one(zpool_handle_t *, void *); |
bec1067d | 306 | |
739cfb96 | 307 | _LIBZFS_H int zpool_vdev_online(zpool_handle_t *, const char *, int, |
34dc7c2f | 308 | vdev_state_t *); |
739cfb96 AZ |
309 | _LIBZFS_H int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); |
310 | _LIBZFS_H int zpool_vdev_attach(zpool_handle_t *, const char *, | |
9a49d3f3 | 311 | const char *, nvlist_t *, int, boolean_t); |
739cfb96 AZ |
312 | _LIBZFS_H int zpool_vdev_detach(zpool_handle_t *, const char *); |
313 | _LIBZFS_H int zpool_vdev_remove(zpool_handle_t *, const char *); | |
314 | _LIBZFS_H int zpool_vdev_remove_cancel(zpool_handle_t *); | |
315 | _LIBZFS_H int zpool_vdev_indirect_size(zpool_handle_t *, const char *, | |
316 | uint64_t *); | |
317 | _LIBZFS_H int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, | |
318 | nvlist_t *, splitflags_t); | |
55c12724 | 319 | _LIBZFS_H int zpool_vdev_remove_wanted(zpool_handle_t *, const char *); |
739cfb96 AZ |
320 | |
321 | _LIBZFS_H int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); | |
322 | _LIBZFS_H int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); | |
a9520e6e TH |
323 | _LIBZFS_H int zpool_vdev_set_removed_state(zpool_handle_t *, uint64_t, |
324 | vdev_aux_t); | |
325 | ||
739cfb96 AZ |
326 | _LIBZFS_H int zpool_vdev_clear(zpool_handle_t *, uint64_t); |
327 | ||
328 | _LIBZFS_H nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, | |
b128c09f | 329 | boolean_t *, boolean_t *); |
739cfb96 | 330 | _LIBZFS_H nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, |
9babb374 | 331 | boolean_t *, boolean_t *, boolean_t *); |
739cfb96 AZ |
332 | _LIBZFS_H int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, |
333 | const char *); | |
b53077a9 TH |
334 | _LIBZFS_H int zpool_prepare_disk(zpool_handle_t *zhp, nvlist_t *vdev_nv, |
335 | const char *prepare_str, char **lines[], int *lines_cnt); | |
336 | _LIBZFS_H int zpool_prepare_and_label_disk(libzfs_handle_t *hdl, | |
337 | zpool_handle_t *, const char *, nvlist_t *vdev_nv, const char *prepare_str, | |
338 | char **lines[], int *lines_cnt); | |
339 | _LIBZFS_H char ** zpool_vdev_script_alloc_env(const char *pool_name, | |
340 | const char *vdev_path, const char *vdev_upath, | |
341 | const char *vdev_enc_sysfs_path, const char *opt_key, const char *opt_val); | |
342 | _LIBZFS_H void zpool_vdev_script_free_env(char **env); | |
739cfb96 AZ |
343 | _LIBZFS_H uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, |
344 | const char *path); | |
34dc7c2f | 345 | |
739cfb96 | 346 | _LIBZFS_H const char *zpool_get_state_str(zpool_handle_t *); |
f0ed6c74 | 347 | |
34dc7c2f BB |
348 | /* |
349 | * Functions to manage pool properties | |
350 | */ | |
739cfb96 AZ |
351 | _LIBZFS_H int zpool_set_prop(zpool_handle_t *, const char *, const char *); |
352 | _LIBZFS_H int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, | |
8b921f66 | 353 | size_t proplen, zprop_source_t *, boolean_t literal); |
8eae2d21 AJ |
354 | _LIBZFS_H int zpool_get_userprop(zpool_handle_t *, const char *, char *, |
355 | size_t proplen, zprop_source_t *); | |
739cfb96 | 356 | _LIBZFS_H uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, |
34dc7c2f | 357 | zprop_source_t *); |
739cfb96 | 358 | _LIBZFS_H int zpool_props_refresh(zpool_handle_t *); |
34dc7c2f | 359 | |
739cfb96 AZ |
360 | _LIBZFS_H const char *zpool_prop_to_name(zpool_prop_t); |
361 | _LIBZFS_H const char *zpool_prop_values(zpool_prop_t); | |
34dc7c2f | 362 | |
2a673e76 AJ |
363 | /* |
364 | * Functions to manage vdev properties | |
365 | */ | |
366 | _LIBZFS_H int zpool_get_vdev_prop_value(nvlist_t *, vdev_prop_t, char *, char *, | |
367 | size_t, zprop_source_t *, boolean_t); | |
368 | _LIBZFS_H int zpool_get_vdev_prop(zpool_handle_t *, const char *, vdev_prop_t, | |
369 | char *, char *, size_t, zprop_source_t *, boolean_t); | |
370 | _LIBZFS_H int zpool_get_all_vdev_props(zpool_handle_t *, const char *, | |
371 | nvlist_t **); | |
372 | _LIBZFS_H int zpool_set_vdev_prop(zpool_handle_t *, const char *, const char *, | |
373 | const char *); | |
374 | ||
375 | _LIBZFS_H const char *vdev_prop_to_name(vdev_prop_t); | |
376 | _LIBZFS_H const char *vdev_prop_values(vdev_prop_t); | |
377 | _LIBZFS_H boolean_t vdev_prop_user(const char *name); | |
378 | _LIBZFS_H const char *vdev_prop_column_name(vdev_prop_t); | |
379 | _LIBZFS_H boolean_t vdev_prop_align_right(vdev_prop_t); | |
380 | ||
34dc7c2f BB |
381 | /* |
382 | * Pool health statistics. | |
383 | */ | |
384 | typedef enum { | |
385 | /* | |
386 | * The following correspond to faults as defined in the (fault.fs.zfs.*) | |
387 | * event namespace. Each is associated with a corresponding message ID. | |
5365b074 | 388 | * This must be kept in sync with the zfs_msgid_table in |
389 | * lib/libzfs/libzfs_status.c. | |
34dc7c2f BB |
390 | */ |
391 | ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ | |
392 | ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ | |
393 | ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ | |
394 | ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ | |
395 | ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ | |
396 | ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ | |
397 | ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ | |
398 | ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ | |
399 | ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ | |
400 | ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ | |
401 | ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ | |
379ca9cf OF |
402 | ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ |
403 | ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ | |
b128c09f BB |
404 | ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ |
405 | ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ | |
cec3a0a1 | 406 | ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ |
d164b209 | 407 | ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ |
ffe9d382 | 408 | ZPOOL_STATUS_ERRATA, /* informational errata available */ |
d164b209 | 409 | |
9ae529ec CS |
410 | /* |
411 | * If the pool has unsupported features but can still be opened in | |
412 | * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the | |
413 | * pool has unsupported features but cannot be opened at all, its | |
414 | * status is ZPOOL_STATUS_UNSUP_FEAT_READ. | |
415 | */ | |
416 | ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ | |
417 | ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ | |
418 | ||
d164b209 BB |
419 | /* |
420 | * These faults have no corresponding message ID. At the time we are | |
421 | * checking the status, the original reason for the FMA fault (I/O or | |
422 | * checksum errors) has been lost. | |
423 | */ | |
34dc7c2f BB |
424 | ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ |
425 | ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ | |
426 | ||
427 | /* | |
428 | * The following are not faults per se, but still an error possibly | |
429 | * requiring administrative attention. There is no corresponding | |
430 | * message ID. | |
431 | */ | |
b9b24bb4 CS |
432 | ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ |
433 | ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ | |
34dc7c2f | 434 | ZPOOL_STATUS_RESILVERING, /* device being resilvered */ |
f7c63cda | 435 | ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ |
45d1cae3 | 436 | ZPOOL_STATUS_REMOVED_DEV, /* removed device */ |
9a49d3f3 BB |
437 | ZPOOL_STATUS_REBUILDING, /* device being rebuilt */ |
438 | ZPOOL_STATUS_REBUILD_SCRUB, /* recommend scrubbing the pool */ | |
6fe3498c | 439 | ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */ |
658fb802 | 440 | ZPOOL_STATUS_COMPATIBILITY_ERR, /* bad 'compatibility' property */ |
e086db16 | 441 | ZPOOL_STATUS_INCOMPATIBLE_FEAT, /* feature set outside compatibility */ |
34dc7c2f BB |
442 | |
443 | /* | |
444 | * Finally, the following indicates a healthy pool. | |
445 | */ | |
446 | ZPOOL_STATUS_OK | |
447 | } zpool_status_t; | |
448 | ||
a926aab9 | 449 | _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, const char **, |
ffe9d382 | 450 | zpool_errata_t *); |
a926aab9 | 451 | _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, const char **, |
ffe9d382 | 452 | zpool_errata_t *); |
34dc7c2f BB |
453 | |
454 | /* | |
455 | * Statistics and configuration functions. | |
456 | */ | |
739cfb96 AZ |
457 | _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); |
458 | _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *); | |
459 | _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *); | |
460 | _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **); | |
34dc7c2f BB |
461 | |
462 | /* | |
463 | * Import and export functions | |
464 | */ | |
739cfb96 AZ |
465 | _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *); |
466 | _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *); | |
467 | _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, | |
34dc7c2f | 468 | char *altroot); |
739cfb96 | 469 | _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, |
572e2857 | 470 | nvlist_t *, int); |
739cfb96 | 471 | _LIBZFS_H void zpool_print_unsup_feat(nvlist_t *config); |
34dc7c2f | 472 | |
34dc7c2f BB |
473 | /* |
474 | * Miscellaneous pool functions | |
475 | */ | |
476 | struct zfs_cmd; | |
477 | ||
18168da7 | 478 | _LIBZFS_H const char *const zfs_history_event_names[]; |
428870ff | 479 | |
d2f3e292 RY |
480 | typedef enum { |
481 | VDEV_NAME_PATH = 1 << 0, | |
482 | VDEV_NAME_GUID = 1 << 1, | |
483 | VDEV_NAME_FOLLOW_LINKS = 1 << 2, | |
484 | VDEV_NAME_TYPE_ID = 1 << 3, | |
485 | } vdev_name_t; | |
486 | ||
739cfb96 | 487 | _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, |
d2f3e292 | 488 | int name_flags); |
739cfb96 AZ |
489 | _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t); |
490 | _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *, | |
7125a109 | 491 | boolean_t *); |
739cfb96 | 492 | _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, |
8c7aa0cf | 493 | int); |
739cfb96 AZ |
494 | _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *); |
495 | _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int); | |
496 | _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t, | |
497 | char *, size_t); | |
498 | _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, | |
de4f06c2 | 499 | size_t); |
739cfb96 | 500 | _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); |
739cfb96 | 501 | _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int, |
428870ff | 502 | nvlist_t *); |
739cfb96 AZ |
503 | _LIBZFS_H int zpool_checkpoint(zpool_handle_t *); |
504 | _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *); | |
505 | _LIBZFS_H boolean_t zpool_is_draid_spare(const char *); | |
9babb374 | 506 | |
34dc7c2f BB |
507 | /* |
508 | * Basic handle manipulations. These functions do not create or destroy the | |
509 | * underlying datasets, only the references to them. | |
510 | */ | |
739cfb96 AZ |
511 | _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); |
512 | _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *); | |
513 | _LIBZFS_H void zfs_close(zfs_handle_t *); | |
514 | _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *); | |
515 | _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *); | |
516 | _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *); | |
517 | _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); | |
518 | _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *); | |
34dc7c2f BB |
519 | |
520 | /* | |
521 | * Property management functions. Some functions are shared with the kernel, | |
522 | * and are found in sys/fs/zfs.h. | |
523 | */ | |
524 | ||
525 | /* | |
526 | * zfs dataset property management | |
527 | */ | |
739cfb96 AZ |
528 | _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t); |
529 | _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t); | |
530 | _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t); | |
531 | _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t); | |
34dc7c2f | 532 | |
739cfb96 AZ |
533 | _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, |
534 | nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, | |
535 | const char *); | |
b128c09f | 536 | |
739cfb96 AZ |
537 | _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t); |
538 | _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *); | |
539 | _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); | |
4e16964e | 540 | _LIBZFS_H int zfs_prop_set_list_flags(zfs_handle_t *, nvlist_t *, int); |
739cfb96 | 541 | _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, |
34dc7c2f | 542 | zprop_source_t *, char *, size_t, boolean_t); |
739cfb96 | 543 | _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, |
428870ff | 544 | boolean_t); |
739cfb96 | 545 | _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, |
34dc7c2f | 546 | zprop_source_t *, char *, size_t); |
739cfb96 AZ |
547 | _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp, |
548 | const char *propname, uint64_t *propvalue); | |
549 | _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, | |
9babb374 | 550 | char *propbuf, int proplen, boolean_t literal); |
739cfb96 | 551 | _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, |
330d06f9 | 552 | uint64_t *propvalue); |
739cfb96 | 553 | _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, |
330d06f9 | 554 | char *propbuf, int proplen, boolean_t literal); |
739cfb96 | 555 | _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, |
9ae529ec | 556 | char *buf, size_t len); |
d1807f16 | 557 | _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, const char **); |
739cfb96 AZ |
558 | _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); |
559 | _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); | |
560 | _LIBZFS_H const char *zfs_prop_values(zfs_prop_t); | |
561 | _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop); | |
562 | _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *); | |
563 | _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *); | |
564 | _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *); | |
565 | _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); | |
566 | ||
567 | _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t, | |
5a42ef04 PD |
568 | boolean_t *, boolean_t *); |
569 | ||
b5256303 TC |
570 | /* |
571 | * zfs encryption management | |
572 | */ | |
739cfb96 AZ |
573 | _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, |
574 | char *); | |
575 | _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, | |
576 | nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *); | |
577 | _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, | |
b5256303 | 578 | nvlist_t *); |
0f7a0cc7 AZ |
579 | _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *); |
580 | _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *); | |
739cfb96 AZ |
581 | _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *); |
582 | _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); | |
b5256303 | 583 | |
34dc7c2f BB |
584 | typedef struct zprop_list { |
585 | int pl_prop; | |
586 | char *pl_user_prop; | |
587 | struct zprop_list *pl_next; | |
588 | boolean_t pl_all; | |
589 | size_t pl_width; | |
428870ff | 590 | size_t pl_recvd_width; |
34dc7c2f BB |
591 | boolean_t pl_fixed; |
592 | } zprop_list_t; | |
593 | ||
739cfb96 | 594 | _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, |
54d5378f | 595 | boolean_t); |
739cfb96 | 596 | _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *); |
2a673e76 AJ |
597 | _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *, |
598 | zprop_list_t **); | |
34dc7c2f BB |
599 | |
600 | #define ZFS_MOUNTPOINT_NONE "none" | |
601 | #define ZFS_MOUNTPOINT_LEGACY "legacy" | |
602 | ||
9ae529ec CS |
603 | #define ZFS_FEATURE_DISABLED "disabled" |
604 | #define ZFS_FEATURE_ENABLED "enabled" | |
605 | #define ZFS_FEATURE_ACTIVE "active" | |
606 | ||
607 | #define ZFS_UNSUPPORTED_INACTIVE "inactive" | |
608 | #define ZFS_UNSUPPORTED_READONLY "readonly" | |
609 | ||
34dc7c2f BB |
610 | /* |
611 | * zpool property management | |
612 | */ | |
739cfb96 | 613 | _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **, |
2a673e76 | 614 | zfs_type_t, boolean_t); |
739cfb96 | 615 | _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, |
9ae529ec | 616 | size_t); |
739cfb96 AZ |
617 | _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t); |
618 | _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t); | |
619 | _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t); | |
620 | _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t); | |
34dc7c2f BB |
621 | |
622 | /* | |
623 | * Functions shared by zfs and zpool property management. | |
624 | */ | |
739cfb96 | 625 | _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all, |
34dc7c2f | 626 | boolean_t ordered, zfs_type_t type); |
739cfb96 | 627 | _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, |
34dc7c2f | 628 | zfs_type_t); |
739cfb96 | 629 | _LIBZFS_H void zprop_free_list(zprop_list_t *); |
34dc7c2f | 630 | |
428870ff BB |
631 | #define ZFS_GET_NCOLS 5 |
632 | ||
633 | typedef enum { | |
634 | GET_COL_NONE, | |
635 | GET_COL_NAME, | |
636 | GET_COL_PROPERTY, | |
637 | GET_COL_VALUE, | |
638 | GET_COL_RECVD, | |
639 | GET_COL_SOURCE | |
640 | } zfs_get_column_t; | |
641 | ||
34dc7c2f BB |
642 | /* |
643 | * Functions for printing zfs or zpool properties | |
644 | */ | |
2a673e76 AJ |
645 | typedef struct vdev_cbdata { |
646 | int cb_name_flags; | |
647 | char **cb_names; | |
648 | unsigned int cb_names_count; | |
649 | } vdev_cbdata_t; | |
650 | ||
34dc7c2f BB |
651 | typedef struct zprop_get_cbdata { |
652 | int cb_sources; | |
428870ff BB |
653 | zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; |
654 | int cb_colwidths[ZFS_GET_NCOLS + 1]; | |
34dc7c2f BB |
655 | boolean_t cb_scripted; |
656 | boolean_t cb_literal; | |
657 | boolean_t cb_first; | |
658 | zprop_list_t *cb_proplist; | |
659 | zfs_type_t cb_type; | |
2a673e76 | 660 | vdev_cbdata_t cb_vdevs; |
34dc7c2f BB |
661 | } zprop_get_cbdata_t; |
662 | ||
4e16964e US |
663 | #define ZFS_SET_NOMOUNT 1 |
664 | ||
665 | typedef struct zprop_set_cbdata { | |
666 | int cb_flags; | |
667 | nvlist_t *cb_proplist; | |
668 | } zprop_set_cbdata_t; | |
669 | ||
739cfb96 | 670 | _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *, |
428870ff BB |
671 | const char *, const char *, zprop_source_t, const char *, |
672 | const char *); | |
34dc7c2f BB |
673 | |
674 | /* | |
675 | * Iterator functions. | |
676 | */ | |
dc95911d AJ |
677 | #define ZFS_ITER_RECURSE (1 << 0) |
678 | #define ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1) | |
679 | #define ZFS_ITER_PROP_LISTSNAPS (1 << 2) | |
680 | #define ZFS_ITER_DEPTH_LIMIT (1 << 3) | |
681 | #define ZFS_ITER_RECVD_PROPS (1 << 4) | |
682 | #define ZFS_ITER_LITERAL_PROPS (1 << 5) | |
683 | #define ZFS_ITER_SIMPLE (1 << 6) | |
684 | ||
34dc7c2f | 685 | typedef int (*zfs_iter_f)(zfs_handle_t *, void *); |
739cfb96 | 686 | _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); |
baca06c2 RN |
687 | _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); |
688 | _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, | |
739cfb96 | 689 | void *); |
baca06c2 RN |
690 | _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); |
691 | _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *, | |
4c0883fb | 692 | uint64_t, uint64_t); |
baca06c2 | 693 | _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *, |
4c0883fb | 694 | uint64_t, uint64_t); |
baca06c2 | 695 | _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, |
739cfb96 | 696 | void *); |
baca06c2 RN |
697 | _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); |
698 | ||
699 | _LIBZFS_H int zfs_iter_children_v2(zfs_handle_t *, int, zfs_iter_f, void *); | |
700 | _LIBZFS_H int zfs_iter_dependents_v2(zfs_handle_t *, int, boolean_t, zfs_iter_f, | |
701 | void *); | |
702 | _LIBZFS_H int zfs_iter_filesystems_v2(zfs_handle_t *, int, zfs_iter_f, void *); | |
703 | _LIBZFS_H int zfs_iter_snapshots_v2(zfs_handle_t *, int, zfs_iter_f, void *, | |
704 | uint64_t, uint64_t); | |
705 | _LIBZFS_H int zfs_iter_snapshots_sorted_v2(zfs_handle_t *, int, zfs_iter_f, | |
706 | void *, uint64_t, uint64_t); | |
707 | _LIBZFS_H int zfs_iter_snapspec_v2(zfs_handle_t *, int, const char *, | |
708 | zfs_iter_f, void *); | |
709 | _LIBZFS_H int zfs_iter_bookmarks_v2(zfs_handle_t *, int, zfs_iter_f, void *); | |
739cfb96 | 710 | _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *); |
34dc7c2f | 711 | |
572e2857 BB |
712 | typedef struct get_all_cb { |
713 | zfs_handle_t **cb_handles; | |
714 | size_t cb_alloc; | |
715 | size_t cb_used; | |
572e2857 BB |
716 | } get_all_cb_t; |
717 | ||
739cfb96 AZ |
718 | _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, |
719 | size_t, zfs_iter_f, void *, boolean_t); | |
720 | _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); | |
572e2857 | 721 | |
34dc7c2f BB |
722 | /* |
723 | * Functions to create and destroy datasets. | |
724 | */ | |
739cfb96 | 725 | _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, |
34dc7c2f | 726 | nvlist_t *); |
739cfb96 AZ |
727 | _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *); |
728 | _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t); | |
729 | _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); | |
730 | _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); | |
1d901c3e | 731 | _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *); |
739cfb96 AZ |
732 | _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); |
733 | _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, | |
734 | nvlist_t *); | |
735 | _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, | |
6f1ffb06 | 736 | nvlist_t *props); |
739cfb96 | 737 | _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); |
7b4e2723 RM |
738 | |
739 | typedef struct renameflags { | |
740 | /* recursive rename */ | |
abb42dc5 | 741 | unsigned int recursive : 1; |
7b4e2723 RM |
742 | |
743 | /* don't unmount file systems */ | |
abb42dc5 | 744 | unsigned int nounmount : 1; |
7b4e2723 RM |
745 | |
746 | /* force unmount file systems */ | |
abb42dc5 | 747 | unsigned int forceunmount : 1; |
7b4e2723 RM |
748 | } renameflags_t; |
749 | ||
739cfb96 | 750 | _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t); |
428870ff BB |
751 | |
752 | typedef struct sendflags { | |
30af21b0 PD |
753 | /* Amount of extra information to print. */ |
754 | int verbosity; | |
428870ff BB |
755 | |
756 | /* recursive send (ie, -R) */ | |
330d06f9 | 757 | boolean_t replicate; |
428870ff | 758 | |
099fa7e4 PCG |
759 | /* for recursive send, skip sending missing snapshots */ |
760 | boolean_t skipmissing; | |
761 | ||
428870ff | 762 | /* for incrementals, do all intermediate snapshots */ |
330d06f9 | 763 | boolean_t doall; |
428870ff BB |
764 | |
765 | /* if dataset is a clone, do incremental from its origin */ | |
330d06f9 | 766 | boolean_t fromorigin; |
428870ff | 767 | |
196bee4c MA |
768 | /* field no longer used, maintained for backwards compatibility */ |
769 | boolean_t pad; | |
428870ff BB |
770 | |
771 | /* send properties (ie, -p) */ | |
330d06f9 MA |
772 | boolean_t props; |
773 | ||
774 | /* do not send (no-op, ie. -n) */ | |
775 | boolean_t dryrun; | |
776 | ||
777 | /* parsable verbose output (ie. -P) */ | |
778 | boolean_t parsable; | |
37abac6d BP |
779 | |
780 | /* show progress (ie. -v) */ | |
781 | boolean_t progress; | |
9b67f605 | 782 | |
19d39615 AH |
783 | /* show progress as process title (ie. -V) */ |
784 | boolean_t progressastitle; | |
785 | ||
f1512ee6 MA |
786 | /* large blocks (>128K) are permitted */ |
787 | boolean_t largeblock; | |
788 | ||
9b67f605 MA |
789 | /* WRITE_EMBEDDED records of type DATA are permitted */ |
790 | boolean_t embed_data; | |
2aa34383 DK |
791 | |
792 | /* compressed WRITE records are permitted */ | |
793 | boolean_t compress; | |
b5256303 TC |
794 | |
795 | /* raw encrypted records are permitted */ | |
796 | boolean_t raw; | |
faa97c16 | 797 | |
798 | /* only send received properties (ie. -b) */ | |
799 | boolean_t backup; | |
9c5e88b1 PZ |
800 | |
801 | /* include snapshot holds in send stream */ | |
802 | boolean_t holds; | |
ba0ba69e TC |
803 | |
804 | /* stream represents a partially received dataset */ | |
805 | boolean_t saved; | |
428870ff BB |
806 | } sendflags_t; |
807 | ||
808 | typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); | |
809 | ||
739cfb96 | 810 | _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *, |
330d06f9 | 811 | sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); |
739cfb96 | 812 | _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *, |
30af21b0 | 813 | const char *); |
739cfb96 AZ |
814 | _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *); |
815 | _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, | |
47dfff3b | 816 | const char *); |
739cfb96 AZ |
817 | _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *); |
818 | _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, | |
47dfff3b | 819 | const char *token); |
428870ff | 820 | |
739cfb96 AZ |
821 | _LIBZFS_H int zfs_promote(zfs_handle_t *); |
822 | _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *, | |
95fd54a1 | 823 | boolean_t, int); |
739cfb96 AZ |
824 | _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); |
825 | _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *, | |
826 | boolean_t); | |
827 | _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **); | |
828 | _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, | |
341166c8 | 829 | nvlist_t *); |
34dc7c2f | 830 | |
9babb374 BB |
831 | typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, |
832 | uid_t rid, uint64_t space); | |
833 | ||
739cfb96 | 834 | _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, |
0b7936d5 AS |
835 | zfs_userspace_cb_t, void *); |
836 | ||
739cfb96 AZ |
837 | _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); |
838 | _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); | |
9babb374 | 839 | |
34dc7c2f BB |
840 | typedef struct recvflags { |
841 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 842 | boolean_t verbose; |
34dc7c2f BB |
843 | |
844 | /* the destination is a prefix, not the exact fs (ie, -d) */ | |
330d06f9 | 845 | boolean_t isprefix; |
34dc7c2f | 846 | |
428870ff BB |
847 | /* |
848 | * Only the tail of the sent snapshot path is appended to the | |
849 | * destination to determine the received snapshot name (ie, -e). | |
850 | */ | |
330d06f9 | 851 | boolean_t istail; |
428870ff | 852 | |
34dc7c2f | 853 | /* do not actually do the recv, just check if it would work (ie, -n) */ |
330d06f9 | 854 | boolean_t dryrun; |
34dc7c2f BB |
855 | |
856 | /* rollback/destroy filesystems as necessary (eg, -F) */ | |
330d06f9 | 857 | boolean_t force; |
34dc7c2f BB |
858 | |
859 | /* set "canmount=off" on all modified filesystems */ | |
330d06f9 | 860 | boolean_t canmountoff; |
34dc7c2f | 861 | |
47dfff3b MA |
862 | /* |
863 | * Mark the file systems as "resumable" and do not destroy them if the | |
864 | * receive is interrupted | |
865 | */ | |
866 | boolean_t resumable; | |
867 | ||
34dc7c2f | 868 | /* byteswap flag is used internally; callers need not specify */ |
330d06f9 | 869 | boolean_t byteswap; |
d164b209 BB |
870 | |
871 | /* do not mount file systems as they are extracted (private) */ | |
330d06f9 | 872 | boolean_t nomount; |
9c5e88b1 PZ |
873 | |
874 | /* Was holds flag set in the compound header? */ | |
875 | boolean_t holds; | |
876 | ||
877 | /* skip receive of snapshot holds */ | |
878 | boolean_t skipholds; | |
bb61cc31 TC |
879 | |
880 | /* mount the filesystem unless nomount is specified */ | |
881 | boolean_t domount; | |
a57d3d45 MZ |
882 | |
883 | /* force unmount while recv snapshot (private) */ | |
884 | boolean_t forceunmount; | |
e8cf3a4f AP |
885 | |
886 | /* use this recv to check (and heal if needed) an existing snapshot */ | |
887 | boolean_t heal; | |
34dc7c2f BB |
888 | } recvflags_t; |
889 | ||
739cfb96 | 890 | _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, |
fcff0f35 | 891 | recvflags_t *, int, avl_tree_t *); |
34dc7c2f | 892 | |
572e2857 | 893 | typedef enum diff_flags { |
344bbc82 AZ |
894 | ZFS_DIFF_PARSEABLE = 1 << 0, |
895 | ZFS_DIFF_TIMESTAMP = 1 << 1, | |
896 | ZFS_DIFF_CLASSIFY = 1 << 2, | |
897 | ZFS_DIFF_NO_MANGLE = 1 << 3 | |
572e2857 BB |
898 | } diff_flags_t; |
899 | ||
739cfb96 | 900 | _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, |
572e2857 BB |
901 | int); |
902 | ||
34dc7c2f BB |
903 | /* |
904 | * Miscellaneous functions. | |
905 | */ | |
739cfb96 AZ |
906 | _LIBZFS_H const char *zfs_type_to_name(zfs_type_t); |
907 | _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *); | |
908 | _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t); | |
909 | _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *, | |
b197457c | 910 | zfs_type_t); |
739cfb96 AZ |
911 | _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t); |
912 | _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, | |
34dc7c2f | 913 | zfs_type_t); |
739cfb96 AZ |
914 | _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *); |
915 | _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path); | |
34dc7c2f | 916 | |
34dc7c2f BB |
917 | /* |
918 | * Mount support functions. | |
919 | */ | |
739cfb96 AZ |
920 | _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); |
921 | _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **); | |
922 | _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int); | |
923 | _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *); | |
924 | _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int); | |
925 | _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int); | |
926 | _LIBZFS_H int zfs_mount_delegation_check(void); | |
34dc7c2f | 927 | |
3e8d5e4f | 928 | #if defined(__linux__) || defined(__APPLE__) |
a926aab9 AZ |
929 | _LIBZFS_H int zfs_parse_mount_options(const char *mntopts, |
930 | unsigned long *mntflags, unsigned long *zfsflags, int sloppy, char *badopt, | |
931 | char *mtabopt); | |
739cfb96 | 932 | _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint, |
501a1511 FD |
933 | char *mntopts, char *mtabopt); |
934 | #endif | |
935 | ||
34dc7c2f BB |
936 | /* |
937 | * Share support functions. | |
b4d9a82f AZ |
938 | * |
939 | * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL, | |
940 | * NULL means "all/any known to this libzfs". | |
34dc7c2f | 941 | */ |
b4d9a82f | 942 | #define SA_NO_PROTOCOL -1 |
34dc7c2f | 943 | |
b4d9a82f AZ |
944 | _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where, |
945 | const enum sa_protocol *proto); | |
946 | _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto); | |
947 | _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint, | |
948 | const enum sa_protocol *proto); | |
949 | _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp, | |
950 | const enum sa_protocol *proto); | |
951 | _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto); | |
ede037cd | 952 | _LIBZFS_H void zfs_truncate_shares(const enum sa_protocol *proto); |
34dc7c2f | 953 | |
739cfb96 | 954 | _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); |
34dc7c2f | 955 | |
feb46b92 | 956 | /* |
b4d9a82f | 957 | * Utility functions to run an external process. |
feb46b92 | 958 | */ |
9ac97c2a BB |
959 | #define STDOUT_VERBOSE 0x01 |
960 | #define STDERR_VERBOSE 0x02 | |
d6418de0 | 961 | #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ |
9ac97c2a | 962 | |
739cfb96 AZ |
963 | _LIBZFS_H int libzfs_run_process(const char *, char **, int); |
964 | _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[], | |
4abd7d80 | 965 | char **[], int *); |
739cfb96 AZ |
966 | _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[], |
967 | char *[], char **[], int *); | |
d6418de0 | 968 | |
739cfb96 | 969 | _LIBZFS_H void libzfs_free_str_array(char **, int); |
d6418de0 | 970 | |
a926aab9 | 971 | _LIBZFS_H boolean_t libzfs_envvar_is_set(const char *); |
feb46b92 | 972 | |
50478c6d T |
973 | /* |
974 | * Utility functions for zfs version | |
975 | */ | |
2b4f2fc9 AZ |
976 | _LIBZFS_H const char *zfs_version_userland(void); |
977 | _LIBZFS_H char *zfs_version_kernel(void); | |
739cfb96 | 978 | _LIBZFS_H int zfs_version_print(void); |
50478c6d | 979 | |
34dc7c2f BB |
980 | /* |
981 | * Given a device or file, determine if it is part of a pool. | |
982 | */ | |
739cfb96 | 983 | _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, |
34dc7c2f BB |
984 | boolean_t *); |
985 | ||
986 | /* | |
428870ff | 987 | * Label manipulation. |
34dc7c2f | 988 | */ |
739cfb96 AZ |
989 | _LIBZFS_H int zpool_clear_label(int); |
990 | _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *); | |
991 | _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **); | |
34dc7c2f | 992 | |
9babb374 BB |
993 | /* |
994 | * Management interfaces for SMB ACL files | |
995 | */ | |
996 | ||
739cfb96 AZ |
997 | _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); |
998 | _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); | |
999 | _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); | |
1000 | _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, | |
1001 | char *); | |
9babb374 | 1002 | |
34dc7c2f BB |
1003 | /* |
1004 | * Enable and disable datasets within a pool by mounting/unmounting and | |
1005 | * sharing/unsharing them. | |
1006 | */ | |
739cfb96 AZ |
1007 | _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int); |
1008 | _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t); | |
3e8d5e4f JL |
1009 | _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t); |
1010 | _LIBZFS_H void zpool_disable_volume_os(const char *); | |
34dc7c2f | 1011 | |
658fb802 CB |
1012 | /* |
1013 | * Parse a features file for -o compatibility | |
1014 | */ | |
1015 | typedef enum { | |
1016 | ZPOOL_COMPATIBILITY_OK, | |
e086db16 CB |
1017 | ZPOOL_COMPATIBILITY_WARNTOKEN, |
1018 | ZPOOL_COMPATIBILITY_BADTOKEN, | |
658fb802 | 1019 | ZPOOL_COMPATIBILITY_BADFILE, |
658fb802 CB |
1020 | ZPOOL_COMPATIBILITY_NOFILES |
1021 | } zpool_compat_status_t; | |
1022 | ||
739cfb96 | 1023 | _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *, |
e086db16 | 1024 | boolean_t *, char *, size_t); |
658fb802 | 1025 | |
fb91f036 RM |
1026 | #ifdef __FreeBSD__ |
1027 | ||
1028 | /* | |
1029 | * Attach/detach the given filesystem to/from the given jail. | |
1030 | */ | |
739cfb96 | 1031 | _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach); |
fb91f036 RM |
1032 | |
1033 | /* | |
1034 | * Set loader options for next boot. | |
1035 | */ | |
739cfb96 AZ |
1036 | _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, |
1037 | const char *); | |
fb91f036 RM |
1038 | |
1039 | #endif /* __FreeBSD__ */ | |
1040 | ||
4ed5e250 WA |
1041 | #ifdef __linux__ |
1042 | ||
1043 | /* | |
1044 | * Add or delete the given filesystem to/from the given user namespace. | |
1045 | */ | |
1046 | _LIBZFS_H int zfs_userns(zfs_handle_t *zhp, const char *nspath, int attach); | |
1047 | ||
1048 | #endif | |
1049 | ||
34dc7c2f BB |
1050 | #ifdef __cplusplus |
1051 | } | |
1052 | #endif | |
1053 | ||
1054 | #endif /* _LIBZFS_H */ |