]>
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 | |
9 | * or http://www.opensolaris.org/os/licensing. | |
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. |
196bee4c | 24 | * Copyright (c) 2011, 2020 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. |
34dc7c2f BB |
31 | */ |
32 | ||
33 | #ifndef _LIBZFS_H | |
34 | #define _LIBZFS_H | |
35 | ||
34dc7c2f BB |
36 | #include <assert.h> |
37 | #include <libnvpair.h> | |
fb5f0bc8 | 38 | #include <sys/mnttab.h> |
34dc7c2f BB |
39 | #include <sys/param.h> |
40 | #include <sys/types.h> | |
41 | #include <sys/varargs.h> | |
42 | #include <sys/fs/zfs.h> | |
43 | #include <sys/avl.h> | |
44 | #include <ucred.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 */ | |
91 | EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ | |
92 | EZFS_SHARENFSFAILED, /* share(1M) failed */ | |
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 */ | |
128 | EZFS_NO_SCRUB, /* no active scrub */ | |
572e2857 BB |
129 | EZFS_DIFF, /* general failure of zfs diff */ |
130 | EZFS_DIFFDATA, /* bad zfs diff data */ | |
131 | EZFS_POOLREADONLY, /* pool is in read-only mode */ | |
0ea05c64 | 132 | EZFS_SCRUB_PAUSED, /* scrub currently paused */ |
379ca9cf | 133 | EZFS_ACTIVE_POOL, /* pool is imported on a different system */ |
b5256303 | 134 | EZFS_CRYPTOFAILED, /* failed to setup encryption */ |
a1d477c2 | 135 | EZFS_NO_PENDING, /* cannot cancel, no operation is pending */ |
d2734cce SD |
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 */ | |
b83a0e2d | 141 | EZFS_IOC_NOTSUPPORTED, /* operation not supported by zfs module */ |
619f0976 GW |
142 | EZFS_TOOMANY, /* argument list too long */ |
143 | EZFS_INITIALIZING, /* currently initializing */ | |
144 | EZFS_NO_INITIALIZE, /* no active initialize */ | |
d8d418ff | 145 | EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */ |
1b939560 BB |
146 | EZFS_TRIMMING, /* currently trimming */ |
147 | EZFS_NO_TRIM, /* no active trim */ | |
148 | EZFS_TRIM_NOTSUP, /* device does not support trim */ | |
fa241660 | 149 | EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ |
43a85362 | 150 | EZFS_EXPORT_IN_PROGRESS, /* currently exporting the pool */ |
9a49d3f3 | 151 | EZFS_REBUILDING, /* resilvering (sequential reconstrution) */ |
34dc7c2f | 152 | EZFS_UNKNOWN |
6f1ffb06 | 153 | } zfs_error_t; |
34dc7c2f BB |
154 | |
155 | /* | |
156 | * The following data structures are all part | |
157 | * of the zfs_allow_t data structure which is | |
158 | * used for printing 'allow' permissions. | |
159 | * It is a linked list of zfs_allow_t's which | |
160 | * then contain avl tree's for user/group/sets/... | |
161 | * and each one of the entries in those trees have | |
162 | * avl tree's for the permissions they belong to and | |
163 | * whether they are local,descendent or local+descendent | |
164 | * permissions. The AVL trees are used primarily for | |
165 | * sorting purposes, but also so that we can quickly find | |
166 | * a given user and or permission. | |
167 | */ | |
168 | typedef struct zfs_perm_node { | |
169 | avl_node_t z_node; | |
170 | char z_pname[MAXPATHLEN]; | |
171 | } zfs_perm_node_t; | |
172 | ||
173 | typedef struct zfs_allow_node { | |
174 | avl_node_t z_node; | |
175 | char z_key[MAXPATHLEN]; /* name, such as joe */ | |
176 | avl_tree_t z_localdescend; /* local+descendent perms */ | |
177 | avl_tree_t z_local; /* local permissions */ | |
178 | avl_tree_t z_descend; /* descendent permissions */ | |
179 | } zfs_allow_node_t; | |
180 | ||
181 | typedef struct zfs_allow { | |
182 | struct zfs_allow *z_next; | |
183 | char z_setpoint[MAXPATHLEN]; | |
184 | avl_tree_t z_sets; | |
185 | avl_tree_t z_crperms; | |
186 | avl_tree_t z_user; | |
187 | avl_tree_t z_group; | |
188 | avl_tree_t z_everyone; | |
189 | } zfs_allow_t; | |
190 | ||
191 | /* | |
192 | * Basic handle types | |
193 | */ | |
194 | typedef struct zfs_handle zfs_handle_t; | |
195 | typedef struct zpool_handle zpool_handle_t; | |
196 | typedef struct libzfs_handle libzfs_handle_t; | |
197 | ||
e60e158e JG |
198 | extern int zpool_wait(zpool_handle_t *, zpool_wait_activity_t); |
199 | extern int zpool_wait_status(zpool_handle_t *, zpool_wait_activity_t, | |
200 | boolean_t *, boolean_t *); | |
201 | ||
34dc7c2f BB |
202 | /* |
203 | * Library initialization | |
204 | */ | |
205 | extern libzfs_handle_t *libzfs_init(void); | |
206 | extern void libzfs_fini(libzfs_handle_t *); | |
207 | ||
208 | extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); | |
209 | extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); | |
210 | ||
211 | extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); | |
212 | ||
6f1ffb06 MA |
213 | extern void zfs_save_arguments(int argc, char **, char *, int); |
214 | extern int zpool_log_history(libzfs_handle_t *, const char *); | |
215 | ||
34dc7c2f | 216 | extern int libzfs_errno(libzfs_handle_t *); |
65037d9b | 217 | extern const char *libzfs_error_init(int); |
34dc7c2f BB |
218 | extern const char *libzfs_error_action(libzfs_handle_t *); |
219 | extern const char *libzfs_error_description(libzfs_handle_t *); | |
da536844 | 220 | extern int zfs_standard_error(libzfs_handle_t *, int, const char *); |
fb5f0bc8 BB |
221 | extern void libzfs_mnttab_init(libzfs_handle_t *); |
222 | extern void libzfs_mnttab_fini(libzfs_handle_t *); | |
9babb374 | 223 | extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); |
fb5f0bc8 BB |
224 | extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, |
225 | struct mnttab *); | |
226 | extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, | |
227 | const char *, const char *); | |
228 | extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); | |
34dc7c2f BB |
229 | |
230 | /* | |
231 | * Basic handle functions | |
232 | */ | |
233 | extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); | |
234 | extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); | |
235 | extern void zpool_close(zpool_handle_t *); | |
236 | extern const char *zpool_get_name(zpool_handle_t *); | |
237 | extern int zpool_get_state(zpool_handle_t *); | |
6b8655ad | 238 | extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); |
131cc95c | 239 | extern const char *zpool_pool_state_to_name(pool_state_t); |
b128c09f | 240 | extern void zpool_free_handles(libzfs_handle_t *); |
34dc7c2f BB |
241 | |
242 | /* | |
243 | * Iterate over all active pools in the system. | |
244 | */ | |
245 | typedef int (*zpool_iter_f)(zpool_handle_t *, void *); | |
246 | extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); | |
d21d5b82 | 247 | extern boolean_t zpool_skip_pool(const char *); |
34dc7c2f BB |
248 | |
249 | /* | |
250 | * Functions to create and destroy pools | |
251 | */ | |
252 | extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, | |
b128c09f | 253 | nvlist_t *, nvlist_t *); |
6f1ffb06 | 254 | extern int zpool_destroy(zpool_handle_t *, const char *); |
34dc7c2f BB |
255 | extern int zpool_add(zpool_handle_t *, nvlist_t *); |
256 | ||
428870ff BB |
257 | typedef struct splitflags { |
258 | /* do not split, but return the config that would be split off */ | |
259 | int dryrun : 1; | |
260 | ||
261 | /* after splitting, import the pool */ | |
262 | int import : 1; | |
d2f3e292 | 263 | int name_flags; |
428870ff BB |
264 | } splitflags_t; |
265 | ||
1b939560 BB |
266 | typedef struct trimflags { |
267 | /* requested vdevs are for the entire pool */ | |
268 | boolean_t fullpool; | |
269 | ||
270 | /* request a secure trim, requires support from device */ | |
271 | boolean_t secure; | |
272 | ||
2288d419 BB |
273 | /* after starting trim, block until trim completes */ |
274 | boolean_t wait; | |
275 | ||
1b939560 BB |
276 | /* trim at the requested rate in bytes/second */ |
277 | uint64_t rate; | |
278 | } trimflags_t; | |
279 | ||
34dc7c2f BB |
280 | /* |
281 | * Functions to manipulate pool and vdev state | |
282 | */ | |
0ea05c64 | 283 | extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); |
619f0976 GW |
284 | extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, |
285 | nvlist_t *); | |
e60e158e JG |
286 | extern int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t, |
287 | nvlist_t *); | |
1b939560 BB |
288 | extern int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *, |
289 | trimflags_t *); | |
290 | ||
428870ff | 291 | extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); |
3541dc6d | 292 | extern int zpool_reguid(zpool_handle_t *); |
d3f2cd7e | 293 | extern int zpool_reopen_one(zpool_handle_t *, void *); |
34dc7c2f | 294 | |
bec1067d AP |
295 | extern int zpool_sync_one(zpool_handle_t *, void *); |
296 | ||
34dc7c2f BB |
297 | extern int zpool_vdev_online(zpool_handle_t *, const char *, int, |
298 | vdev_state_t *); | |
299 | extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); | |
300 | extern int zpool_vdev_attach(zpool_handle_t *, const char *, | |
9a49d3f3 | 301 | const char *, nvlist_t *, int, boolean_t); |
34dc7c2f BB |
302 | extern int zpool_vdev_detach(zpool_handle_t *, const char *); |
303 | extern int zpool_vdev_remove(zpool_handle_t *, const char *); | |
a1d477c2 MA |
304 | extern int zpool_vdev_remove_cancel(zpool_handle_t *); |
305 | extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *); | |
428870ff BB |
306 | extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, |
307 | splitflags_t); | |
34dc7c2f | 308 | |
428870ff BB |
309 | extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); |
310 | extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); | |
34dc7c2f BB |
311 | extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); |
312 | ||
313 | extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, | |
b128c09f | 314 | boolean_t *, boolean_t *); |
9babb374 BB |
315 | extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, |
316 | boolean_t *, boolean_t *, boolean_t *); | |
60265072 | 317 | extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *); |
4a283c7f | 318 | extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, const char *path); |
34dc7c2f | 319 | |
f0ed6c74 TH |
320 | const char *zpool_get_state_str(zpool_handle_t *); |
321 | ||
34dc7c2f BB |
322 | /* |
323 | * Functions to manage pool properties | |
324 | */ | |
325 | extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); | |
326 | extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, | |
8b921f66 | 327 | size_t proplen, zprop_source_t *, boolean_t literal); |
34dc7c2f BB |
328 | extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, |
329 | zprop_source_t *); | |
e60e158e | 330 | extern int zpool_props_refresh(zpool_handle_t *); |
34dc7c2f BB |
331 | |
332 | extern const char *zpool_prop_to_name(zpool_prop_t); | |
333 | extern const char *zpool_prop_values(zpool_prop_t); | |
334 | ||
335 | /* | |
336 | * Pool health statistics. | |
337 | */ | |
338 | typedef enum { | |
339 | /* | |
340 | * The following correspond to faults as defined in the (fault.fs.zfs.*) | |
341 | * event namespace. Each is associated with a corresponding message ID. | |
5365b074 | 342 | * This must be kept in sync with the zfs_msgid_table in |
343 | * lib/libzfs/libzfs_status.c. | |
34dc7c2f BB |
344 | */ |
345 | ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ | |
346 | ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ | |
347 | ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ | |
348 | ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ | |
349 | ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ | |
350 | ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ | |
351 | ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ | |
352 | ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ | |
353 | ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ | |
354 | ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ | |
355 | ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ | |
379ca9cf OF |
356 | ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ |
357 | ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ | |
b128c09f BB |
358 | ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ |
359 | ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ | |
cec3a0a1 | 360 | ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ |
d164b209 | 361 | ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ |
ffe9d382 | 362 | ZPOOL_STATUS_ERRATA, /* informational errata available */ |
d164b209 | 363 | |
9ae529ec CS |
364 | /* |
365 | * If the pool has unsupported features but can still be opened in | |
366 | * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the | |
367 | * pool has unsupported features but cannot be opened at all, its | |
368 | * status is ZPOOL_STATUS_UNSUP_FEAT_READ. | |
369 | */ | |
370 | ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ | |
371 | ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ | |
372 | ||
d164b209 BB |
373 | /* |
374 | * These faults have no corresponding message ID. At the time we are | |
375 | * checking the status, the original reason for the FMA fault (I/O or | |
376 | * checksum errors) has been lost. | |
377 | */ | |
34dc7c2f BB |
378 | ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ |
379 | ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ | |
380 | ||
381 | /* | |
382 | * The following are not faults per se, but still an error possibly | |
383 | * requiring administrative attention. There is no corresponding | |
384 | * message ID. | |
385 | */ | |
b9b24bb4 CS |
386 | ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ |
387 | ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ | |
34dc7c2f | 388 | ZPOOL_STATUS_RESILVERING, /* device being resilvered */ |
f7c63cda | 389 | ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ |
45d1cae3 | 390 | ZPOOL_STATUS_REMOVED_DEV, /* removed device */ |
9a49d3f3 BB |
391 | ZPOOL_STATUS_REBUILDING, /* device being rebuilt */ |
392 | ZPOOL_STATUS_REBUILD_SCRUB, /* recommend scrubbing the pool */ | |
34dc7c2f BB |
393 | |
394 | /* | |
395 | * Finally, the following indicates a healthy pool. | |
396 | */ | |
397 | ZPOOL_STATUS_OK | |
398 | } zpool_status_t; | |
399 | ||
ffe9d382 BB |
400 | extern zpool_status_t zpool_get_status(zpool_handle_t *, char **, |
401 | zpool_errata_t *); | |
402 | extern zpool_status_t zpool_import_status(nvlist_t *, char **, | |
403 | zpool_errata_t *); | |
34dc7c2f BB |
404 | |
405 | /* | |
406 | * Statistics and configuration functions. | |
407 | */ | |
408 | extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); | |
9ae529ec | 409 | extern nvlist_t *zpool_get_features(zpool_handle_t *); |
34dc7c2f BB |
410 | extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); |
411 | extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); | |
412 | ||
413 | /* | |
414 | * Import and export functions | |
415 | */ | |
6f1ffb06 MA |
416 | extern int zpool_export(zpool_handle_t *, boolean_t, const char *); |
417 | extern int zpool_export_force(zpool_handle_t *, const char *); | |
34dc7c2f BB |
418 | extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, |
419 | char *altroot); | |
420 | extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, | |
572e2857 | 421 | nvlist_t *, int); |
9ae529ec | 422 | extern void zpool_print_unsup_feat(nvlist_t *config); |
34dc7c2f | 423 | |
34dc7c2f BB |
424 | /* |
425 | * Miscellaneous pool functions | |
426 | */ | |
427 | struct zfs_cmd; | |
428 | ||
6f1ffb06 | 429 | extern const char *zfs_history_event_names[]; |
428870ff | 430 | |
d2f3e292 RY |
431 | typedef enum { |
432 | VDEV_NAME_PATH = 1 << 0, | |
433 | VDEV_NAME_GUID = 1 << 1, | |
434 | VDEV_NAME_FOLLOW_LINKS = 1 << 2, | |
435 | VDEV_NAME_TYPE_ID = 1 << 3, | |
436 | } vdev_name_t; | |
437 | ||
428870ff | 438 | extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, |
d2f3e292 | 439 | int name_flags); |
34dc7c2f | 440 | extern int zpool_upgrade(zpool_handle_t *, uint64_t); |
7125a109 CC |
441 | extern int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *, |
442 | boolean_t *); | |
8c7aa0cf CD |
443 | extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, |
444 | int); | |
26685276 | 445 | extern int zpool_events_clear(libzfs_handle_t *, int *); |
75e3ff58 | 446 | extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int); |
de4f06c2 PD |
447 | extern void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t, char *, |
448 | size_t); | |
34dc7c2f | 449 | extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, |
de4f06c2 | 450 | size_t); |
34dc7c2f | 451 | extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); |
9babb374 | 452 | extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); |
428870ff BB |
453 | extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, |
454 | nvlist_t *); | |
d2734cce SD |
455 | extern int zpool_checkpoint(zpool_handle_t *); |
456 | extern int zpool_discard_checkpoint(zpool_handle_t *); | |
9babb374 | 457 | |
34dc7c2f BB |
458 | /* |
459 | * Basic handle manipulations. These functions do not create or destroy the | |
460 | * underlying datasets, only the references to them. | |
461 | */ | |
462 | extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); | |
330d06f9 | 463 | extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); |
34dc7c2f BB |
464 | extern void zfs_close(zfs_handle_t *); |
465 | extern zfs_type_t zfs_get_type(const zfs_handle_t *); | |
466 | extern const char *zfs_get_name(const zfs_handle_t *); | |
b128c09f | 467 | extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); |
d21d5b82 | 468 | extern const char *zfs_get_pool_name(const zfs_handle_t *); |
34dc7c2f BB |
469 | |
470 | /* | |
471 | * Property management functions. Some functions are shared with the kernel, | |
472 | * and are found in sys/fs/zfs.h. | |
473 | */ | |
474 | ||
475 | /* | |
476 | * zfs dataset property management | |
477 | */ | |
478 | extern const char *zfs_prop_default_string(zfs_prop_t); | |
479 | extern uint64_t zfs_prop_default_numeric(zfs_prop_t); | |
480 | extern const char *zfs_prop_column_name(zfs_prop_t); | |
481 | extern boolean_t zfs_prop_align_right(zfs_prop_t); | |
482 | ||
b5256303 TC |
483 | extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *, |
484 | uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *); | |
b128c09f | 485 | |
34dc7c2f BB |
486 | extern const char *zfs_prop_to_name(zfs_prop_t); |
487 | extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); | |
23de906c | 488 | extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); |
34dc7c2f BB |
489 | extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, |
490 | zprop_source_t *, char *, size_t, boolean_t); | |
428870ff BB |
491 | extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, |
492 | boolean_t); | |
34dc7c2f BB |
493 | extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, |
494 | zprop_source_t *, char *, size_t); | |
9babb374 BB |
495 | extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, |
496 | uint64_t *propvalue); | |
497 | extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, | |
498 | char *propbuf, int proplen, boolean_t literal); | |
330d06f9 MA |
499 | extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, |
500 | uint64_t *propvalue); | |
501 | extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, | |
502 | char *propbuf, int proplen, boolean_t literal); | |
9ae529ec CS |
503 | extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, |
504 | char *buf, size_t len); | |
2cf7f52b | 505 | extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **); |
34dc7c2f | 506 | extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); |
428870ff | 507 | extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); |
34dc7c2f BB |
508 | extern const char *zfs_prop_values(zfs_prop_t); |
509 | extern int zfs_prop_is_string(zfs_prop_t prop); | |
6044cf59 | 510 | extern nvlist_t *zfs_get_all_props(zfs_handle_t *); |
34dc7c2f | 511 | extern nvlist_t *zfs_get_user_props(zfs_handle_t *); |
428870ff | 512 | extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); |
330d06f9 | 513 | extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); |
34dc7c2f | 514 | |
5a42ef04 PD |
515 | extern int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t, |
516 | boolean_t *, boolean_t *); | |
517 | ||
b5256303 TC |
518 | /* |
519 | * zfs encryption management | |
520 | */ | |
521 | extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *); | |
522 | extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *, | |
d9c460a0 | 523 | boolean_t stdin_available, uint8_t **, uint_t *); |
b5256303 TC |
524 | extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, |
525 | nvlist_t *); | |
526 | extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *); | |
527 | extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *); | |
528 | extern int zfs_crypto_unload_key(zfs_handle_t *); | |
529 | extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); | |
530 | ||
34dc7c2f BB |
531 | typedef struct zprop_list { |
532 | int pl_prop; | |
533 | char *pl_user_prop; | |
534 | struct zprop_list *pl_next; | |
535 | boolean_t pl_all; | |
536 | size_t pl_width; | |
428870ff | 537 | size_t pl_recvd_width; |
34dc7c2f BB |
538 | boolean_t pl_fixed; |
539 | } zprop_list_t; | |
540 | ||
54d5378f YP |
541 | extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, |
542 | boolean_t); | |
9babb374 | 543 | extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); |
34dc7c2f BB |
544 | |
545 | #define ZFS_MOUNTPOINT_NONE "none" | |
546 | #define ZFS_MOUNTPOINT_LEGACY "legacy" | |
547 | ||
9ae529ec CS |
548 | #define ZFS_FEATURE_DISABLED "disabled" |
549 | #define ZFS_FEATURE_ENABLED "enabled" | |
550 | #define ZFS_FEATURE_ACTIVE "active" | |
551 | ||
552 | #define ZFS_UNSUPPORTED_INACTIVE "inactive" | |
553 | #define ZFS_UNSUPPORTED_READONLY "readonly" | |
554 | ||
34dc7c2f BB |
555 | /* |
556 | * zpool property management | |
557 | */ | |
558 | extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); | |
9ae529ec CS |
559 | extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, |
560 | size_t); | |
34dc7c2f BB |
561 | extern const char *zpool_prop_default_string(zpool_prop_t); |
562 | extern uint64_t zpool_prop_default_numeric(zpool_prop_t); | |
563 | extern const char *zpool_prop_column_name(zpool_prop_t); | |
564 | extern boolean_t zpool_prop_align_right(zpool_prop_t); | |
565 | ||
566 | /* | |
567 | * Functions shared by zfs and zpool property management. | |
568 | */ | |
569 | extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, | |
570 | boolean_t ordered, zfs_type_t type); | |
571 | extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, | |
572 | zfs_type_t); | |
573 | extern void zprop_free_list(zprop_list_t *); | |
574 | ||
428870ff BB |
575 | #define ZFS_GET_NCOLS 5 |
576 | ||
577 | typedef enum { | |
578 | GET_COL_NONE, | |
579 | GET_COL_NAME, | |
580 | GET_COL_PROPERTY, | |
581 | GET_COL_VALUE, | |
582 | GET_COL_RECVD, | |
583 | GET_COL_SOURCE | |
584 | } zfs_get_column_t; | |
585 | ||
34dc7c2f BB |
586 | /* |
587 | * Functions for printing zfs or zpool properties | |
588 | */ | |
589 | typedef struct zprop_get_cbdata { | |
590 | int cb_sources; | |
428870ff BB |
591 | zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; |
592 | int cb_colwidths[ZFS_GET_NCOLS + 1]; | |
34dc7c2f BB |
593 | boolean_t cb_scripted; |
594 | boolean_t cb_literal; | |
595 | boolean_t cb_first; | |
596 | zprop_list_t *cb_proplist; | |
597 | zfs_type_t cb_type; | |
598 | } zprop_get_cbdata_t; | |
599 | ||
600 | void zprop_print_one_property(const char *, zprop_get_cbdata_t *, | |
428870ff BB |
601 | const char *, const char *, zprop_source_t, const char *, |
602 | const char *); | |
34dc7c2f BB |
603 | |
604 | /* | |
605 | * Iterator functions. | |
606 | */ | |
607 | typedef int (*zfs_iter_f)(zfs_handle_t *, void *); | |
608 | extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); | |
609 | extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); | |
610 | extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); | |
611 | extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); | |
4c0883fb AP |
612 | extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *, |
613 | uint64_t, uint64_t); | |
614 | extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *, | |
615 | uint64_t, uint64_t); | |
330d06f9 | 616 | extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); |
da536844 | 617 | extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); |
0c6d0936 | 618 | extern int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *); |
34dc7c2f | 619 | |
572e2857 BB |
620 | typedef struct get_all_cb { |
621 | zfs_handle_t **cb_handles; | |
622 | size_t cb_alloc; | |
623 | size_t cb_used; | |
572e2857 BB |
624 | } get_all_cb_t; |
625 | ||
a10d50f9 SR |
626 | void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t, |
627 | zfs_iter_f, void *, boolean_t); | |
572e2857 | 628 | void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); |
572e2857 | 629 | |
34dc7c2f BB |
630 | /* |
631 | * Functions to create and destroy datasets. | |
632 | */ | |
633 | extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, | |
634 | nvlist_t *); | |
635 | extern int zfs_create_ancestors(libzfs_handle_t *, const char *); | |
45d1cae3 BB |
636 | extern int zfs_destroy(zfs_handle_t *, boolean_t); |
637 | extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); | |
13fe0198 | 638 | extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); |
34dc7c2f | 639 | extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); |
b128c09f | 640 | extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); |
6f1ffb06 MA |
641 | extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, |
642 | nvlist_t *props); | |
34dc7c2f | 643 | extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); |
db49968e | 644 | extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); |
428870ff BB |
645 | |
646 | typedef struct sendflags { | |
30af21b0 PD |
647 | /* Amount of extra information to print. */ |
648 | int verbosity; | |
428870ff BB |
649 | |
650 | /* recursive send (ie, -R) */ | |
330d06f9 | 651 | boolean_t replicate; |
428870ff BB |
652 | |
653 | /* for incrementals, do all intermediate snapshots */ | |
330d06f9 | 654 | boolean_t doall; |
428870ff BB |
655 | |
656 | /* if dataset is a clone, do incremental from its origin */ | |
330d06f9 | 657 | boolean_t fromorigin; |
428870ff | 658 | |
196bee4c MA |
659 | /* field no longer used, maintained for backwards compatibility */ |
660 | boolean_t pad; | |
428870ff BB |
661 | |
662 | /* send properties (ie, -p) */ | |
330d06f9 MA |
663 | boolean_t props; |
664 | ||
665 | /* do not send (no-op, ie. -n) */ | |
666 | boolean_t dryrun; | |
667 | ||
668 | /* parsable verbose output (ie. -P) */ | |
669 | boolean_t parsable; | |
37abac6d BP |
670 | |
671 | /* show progress (ie. -v) */ | |
672 | boolean_t progress; | |
9b67f605 | 673 | |
f1512ee6 MA |
674 | /* large blocks (>128K) are permitted */ |
675 | boolean_t largeblock; | |
676 | ||
9b67f605 MA |
677 | /* WRITE_EMBEDDED records of type DATA are permitted */ |
678 | boolean_t embed_data; | |
2aa34383 DK |
679 | |
680 | /* compressed WRITE records are permitted */ | |
681 | boolean_t compress; | |
b5256303 TC |
682 | |
683 | /* raw encrypted records are permitted */ | |
684 | boolean_t raw; | |
faa97c16 | 685 | |
686 | /* only send received properties (ie. -b) */ | |
687 | boolean_t backup; | |
9c5e88b1 PZ |
688 | |
689 | /* include snapshot holds in send stream */ | |
690 | boolean_t holds; | |
ba0ba69e TC |
691 | |
692 | /* stream represents a partially received dataset */ | |
693 | boolean_t saved; | |
428870ff BB |
694 | } sendflags_t; |
695 | ||
696 | typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); | |
697 | ||
330d06f9 MA |
698 | extern int zfs_send(zfs_handle_t *, const char *, const char *, |
699 | sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); | |
30af21b0 PD |
700 | extern int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *, |
701 | const char *); | |
702 | extern int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *); | |
47dfff3b MA |
703 | extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, |
704 | const char *); | |
ba0ba69e | 705 | extern int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *); |
47dfff3b MA |
706 | extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, |
707 | const char *token); | |
428870ff | 708 | |
34dc7c2f | 709 | extern int zfs_promote(zfs_handle_t *); |
13fe0198 | 710 | extern int zfs_hold(zfs_handle_t *, const char *, const char *, |
95fd54a1 SH |
711 | boolean_t, int); |
712 | extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); | |
45d1cae3 | 713 | extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); |
0b7936d5 | 714 | extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); |
341166c8 MG |
715 | extern uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, |
716 | nvlist_t *); | |
34dc7c2f | 717 | |
9babb374 BB |
718 | typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, |
719 | uid_t rid, uint64_t space); | |
720 | ||
0b7936d5 AS |
721 | extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, |
722 | zfs_userspace_cb_t, void *); | |
723 | ||
724 | extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); | |
725 | extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); | |
9babb374 | 726 | |
34dc7c2f BB |
727 | typedef struct recvflags { |
728 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 729 | boolean_t verbose; |
34dc7c2f BB |
730 | |
731 | /* the destination is a prefix, not the exact fs (ie, -d) */ | |
330d06f9 | 732 | boolean_t isprefix; |
34dc7c2f | 733 | |
428870ff BB |
734 | /* |
735 | * Only the tail of the sent snapshot path is appended to the | |
736 | * destination to determine the received snapshot name (ie, -e). | |
737 | */ | |
330d06f9 | 738 | boolean_t istail; |
428870ff | 739 | |
34dc7c2f | 740 | /* do not actually do the recv, just check if it would work (ie, -n) */ |
330d06f9 | 741 | boolean_t dryrun; |
34dc7c2f BB |
742 | |
743 | /* rollback/destroy filesystems as necessary (eg, -F) */ | |
330d06f9 | 744 | boolean_t force; |
34dc7c2f BB |
745 | |
746 | /* set "canmount=off" on all modified filesystems */ | |
330d06f9 | 747 | boolean_t canmountoff; |
34dc7c2f | 748 | |
47dfff3b MA |
749 | /* |
750 | * Mark the file systems as "resumable" and do not destroy them if the | |
751 | * receive is interrupted | |
752 | */ | |
753 | boolean_t resumable; | |
754 | ||
34dc7c2f | 755 | /* byteswap flag is used internally; callers need not specify */ |
330d06f9 | 756 | boolean_t byteswap; |
d164b209 BB |
757 | |
758 | /* do not mount file systems as they are extracted (private) */ | |
330d06f9 | 759 | boolean_t nomount; |
9c5e88b1 PZ |
760 | |
761 | /* Was holds flag set in the compound header? */ | |
762 | boolean_t holds; | |
763 | ||
764 | /* skip receive of snapshot holds */ | |
765 | boolean_t skipholds; | |
bb61cc31 TC |
766 | |
767 | /* mount the filesystem unless nomount is specified */ | |
768 | boolean_t domount; | |
a57d3d45 MZ |
769 | |
770 | /* force unmount while recv snapshot (private) */ | |
771 | boolean_t forceunmount; | |
34dc7c2f BB |
772 | } recvflags_t; |
773 | ||
fcff0f35 PD |
774 | extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, |
775 | recvflags_t *, int, avl_tree_t *); | |
34dc7c2f | 776 | |
572e2857 BB |
777 | typedef enum diff_flags { |
778 | ZFS_DIFF_PARSEABLE = 0x1, | |
779 | ZFS_DIFF_TIMESTAMP = 0x2, | |
780 | ZFS_DIFF_CLASSIFY = 0x4 | |
781 | } diff_flags_t; | |
782 | ||
783 | extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, | |
784 | int); | |
785 | ||
34dc7c2f BB |
786 | /* |
787 | * Miscellaneous functions. | |
788 | */ | |
789 | extern const char *zfs_type_to_name(zfs_type_t); | |
790 | extern void zfs_refresh_properties(zfs_handle_t *); | |
791 | extern int zfs_name_valid(const char *, zfs_type_t); | |
792 | extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); | |
b5256303 | 793 | extern int zfs_parent_name(zfs_handle_t *, char *, size_t); |
34dc7c2f BB |
794 | extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, |
795 | zfs_type_t); | |
796 | extern int zfs_spa_version(zfs_handle_t *, int *); | |
da536844 | 797 | extern boolean_t zfs_bookmark_exists(const char *path); |
34dc7c2f | 798 | |
34dc7c2f BB |
799 | /* |
800 | * Mount support functions. | |
801 | */ | |
802 | extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); | |
803 | extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); | |
804 | extern int zfs_mount(zfs_handle_t *, const char *, int); | |
68a192e4 | 805 | extern int zfs_mount_at(zfs_handle_t *, const char *, int, const char *); |
34dc7c2f BB |
806 | extern int zfs_unmount(zfs_handle_t *, const char *, int); |
807 | extern int zfs_unmountall(zfs_handle_t *, int); | |
808 | ||
501a1511 FD |
809 | #if defined(__linux__) |
810 | extern int zfs_parse_mount_options(char *mntopts, unsigned long *mntflags, | |
811 | unsigned long *zfsflags, int sloppy, char *badopt, char *mtabopt); | |
812 | extern void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint, | |
813 | char *mntopts, char *mtabopt); | |
814 | #endif | |
815 | ||
34dc7c2f BB |
816 | /* |
817 | * Share support functions. | |
818 | */ | |
819 | extern boolean_t zfs_is_shared(zfs_handle_t *); | |
820 | extern int zfs_share(zfs_handle_t *); | |
821 | extern int zfs_unshare(zfs_handle_t *); | |
822 | ||
823 | /* | |
824 | * Protocol-specific share support functions. | |
825 | */ | |
826 | extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); | |
827 | extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); | |
828 | extern int zfs_share_nfs(zfs_handle_t *); | |
829 | extern int zfs_share_smb(zfs_handle_t *); | |
830 | extern int zfs_shareall(zfs_handle_t *); | |
831 | extern int zfs_unshare_nfs(zfs_handle_t *, const char *); | |
832 | extern int zfs_unshare_smb(zfs_handle_t *, const char *); | |
833 | extern int zfs_unshareall_nfs(zfs_handle_t *); | |
834 | extern int zfs_unshareall_smb(zfs_handle_t *); | |
835 | extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); | |
2f71caf2 | 836 | extern int zfs_unshareall_bytype(zfs_handle_t *, const char *, const char *); |
34dc7c2f | 837 | extern int zfs_unshareall(zfs_handle_t *); |
9babb374 | 838 | extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, |
34dc7c2f BB |
839 | void *, void *, int, zfs_share_op_t); |
840 | ||
34dc7c2f BB |
841 | extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); |
842 | ||
feb46b92 BB |
843 | /* |
844 | * Utility functions to run an external process. | |
845 | */ | |
9ac97c2a BB |
846 | #define STDOUT_VERBOSE 0x01 |
847 | #define STDERR_VERBOSE 0x02 | |
d6418de0 | 848 | #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ |
9ac97c2a | 849 | |
4abd7d80 NB |
850 | int libzfs_run_process(const char *, char **, int); |
851 | int libzfs_run_process_get_stdout(const char *, char *[], char *[], | |
852 | char **[], int *); | |
853 | int libzfs_run_process_get_stdout_nopath(const char *, char *[], char *[], | |
854 | char **[], int *); | |
d6418de0 | 855 | |
4abd7d80 | 856 | void libzfs_free_str_array(char **, int); |
d6418de0 | 857 | |
4abd7d80 | 858 | int libzfs_envvar_is_set(char *); |
feb46b92 | 859 | |
50478c6d T |
860 | /* |
861 | * Utility functions for zfs version | |
862 | */ | |
863 | extern void zfs_version_userland(char *, int); | |
864 | extern int zfs_version_kernel(char *, int); | |
865 | extern int zfs_version_print(void); | |
866 | ||
34dc7c2f BB |
867 | /* |
868 | * Given a device or file, determine if it is part of a pool. | |
869 | */ | |
870 | extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, | |
871 | boolean_t *); | |
872 | ||
873 | /* | |
428870ff | 874 | * Label manipulation. |
34dc7c2f | 875 | */ |
428870ff | 876 | extern int zpool_clear_label(int); |
108a454a PD |
877 | extern int zpool_set_bootenv(zpool_handle_t *, const char *); |
878 | extern int zpool_get_bootenv(zpool_handle_t *, char *, size_t, off_t); | |
34dc7c2f | 879 | |
9babb374 BB |
880 | /* |
881 | * Management interfaces for SMB ACL files | |
882 | */ | |
883 | ||
884 | int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); | |
885 | int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); | |
886 | int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); | |
887 | int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); | |
888 | ||
34dc7c2f BB |
889 | /* |
890 | * Enable and disable datasets within a pool by mounting/unmounting and | |
891 | * sharing/unsharing them. | |
892 | */ | |
893 | extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); | |
894 | extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); | |
895 | ||
896 | #ifdef __cplusplus | |
897 | } | |
898 | #endif | |
899 | ||
900 | #endif /* _LIBZFS_H */ |