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