]>
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. |
37abac6d | 25 | * Copyright (c) 2012, Joyent, Inc. All rights reserved. |
95fd54a1 | 26 | * Copyright (c) 2013 Steven Hartland. All rights reserved. |
39fc0cb5 | 27 | * Copyright (c) 2016, Intel Corporation. |
d21d5b82 | 28 | * Copyright 2016 Nexenta Systems, Inc. |
bec1067d | 29 | * Copyright (c) 2017 Datto Inc. |
d3f2cd7e | 30 | * Copyright (c) 2017 Open-E, Inc. All Rights Reserved. |
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 | ||
d603ed6c BB |
57 | /* |
58 | * Default device paths | |
59 | */ | |
eac47204 BB |
60 | #define DISK_ROOT "/dev" |
61 | #define UDISK_ROOT "/dev/disk" | |
6bb24f4d | 62 | #define ZVOL_ROOT "/dev/zvol" |
d603ed6c | 63 | |
11cb9d77 BB |
64 | /* |
65 | * Default wait time for a device name to be created. | |
66 | */ | |
67 | #define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */ | |
68 | ||
83bf769d BB |
69 | #define IMPORT_ORDER_PREFERRED_1 1 |
70 | #define IMPORT_ORDER_PREFERRED_2 2 | |
71 | #define IMPORT_ORDER_SCAN_OFFSET 10 | |
72 | #define IMPORT_ORDER_DEFAULT 100 | |
95003f70 | 73 | #define DEFAULT_IMPORT_PATH_SIZE 9 |
eac47204 | 74 | extern char *zpool_default_import_path[DEFAULT_IMPORT_PATH_SIZE]; |
d603ed6c | 75 | |
34dc7c2f BB |
76 | /* |
77 | * libzfs errors | |
78 | */ | |
6f1ffb06 MA |
79 | typedef enum zfs_error { |
80 | EZFS_SUCCESS = 0, /* no error -- success */ | |
34dc7c2f BB |
81 | EZFS_NOMEM = 2000, /* out of memory */ |
82 | EZFS_BADPROP, /* invalid property value */ | |
83 | EZFS_PROPREADONLY, /* cannot set readonly property */ | |
84 | EZFS_PROPTYPE, /* property does not apply to dataset type */ | |
85 | EZFS_PROPNONINHERIT, /* property is not inheritable */ | |
86 | EZFS_PROPSPACE, /* bad quota or reservation */ | |
87 | EZFS_BADTYPE, /* dataset is not of appropriate type */ | |
88 | EZFS_BUSY, /* pool or dataset is busy */ | |
89 | EZFS_EXISTS, /* pool or dataset already exists */ | |
90 | EZFS_NOENT, /* no such pool or dataset */ | |
91 | EZFS_BADSTREAM, /* bad backup stream */ | |
92 | EZFS_DSREADONLY, /* dataset is readonly */ | |
93 | EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ | |
34dc7c2f BB |
94 | EZFS_INVALIDNAME, /* invalid dataset name */ |
95 | EZFS_BADRESTORE, /* unable to restore to destination */ | |
96 | EZFS_BADBACKUP, /* backup failed */ | |
97 | EZFS_BADTARGET, /* bad attach/detach/replace target */ | |
98 | EZFS_NODEVICE, /* no such device in pool */ | |
99 | EZFS_BADDEV, /* invalid device to add */ | |
100 | EZFS_NOREPLICAS, /* no valid replicas */ | |
101 | EZFS_RESILVERING, /* currently resilvering */ | |
102 | EZFS_BADVERSION, /* unsupported version */ | |
103 | EZFS_POOLUNAVAIL, /* pool is currently unavailable */ | |
104 | EZFS_DEVOVERFLOW, /* too many devices in one vdev */ | |
105 | EZFS_BADPATH, /* must be an absolute path */ | |
106 | EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ | |
107 | EZFS_ZONED, /* used improperly in local zone */ | |
108 | EZFS_MOUNTFAILED, /* failed to mount dataset */ | |
109 | EZFS_UMOUNTFAILED, /* failed to unmount dataset */ | |
110 | EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ | |
111 | EZFS_SHARENFSFAILED, /* share(1M) failed */ | |
34dc7c2f BB |
112 | EZFS_PERM, /* permission denied */ |
113 | EZFS_NOSPC, /* out of space */ | |
428870ff | 114 | EZFS_FAULT, /* bad address */ |
34dc7c2f BB |
115 | EZFS_IO, /* I/O error */ |
116 | EZFS_INTR, /* signal received */ | |
117 | EZFS_ISSPARE, /* device is a hot spare */ | |
118 | EZFS_INVALCONFIG, /* invalid vdev configuration */ | |
119 | EZFS_RECURSIVE, /* recursive dependency */ | |
120 | EZFS_NOHISTORY, /* no history object */ | |
34dc7c2f BB |
121 | EZFS_POOLPROPS, /* couldn't retrieve pool props */ |
122 | EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ | |
123 | EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ | |
124 | EZFS_NAMETOOLONG, /* dataset name is too long */ | |
125 | EZFS_OPENFAILED, /* open of device failed */ | |
126 | EZFS_NOCAP, /* couldn't get capacity */ | |
127 | EZFS_LABELFAILED, /* write of label failed */ | |
34dc7c2f BB |
128 | EZFS_BADWHO, /* invalid permission who */ |
129 | EZFS_BADPERM, /* invalid permission */ | |
130 | EZFS_BADPERMSET, /* invalid permission set name */ | |
131 | EZFS_NODELEGATION, /* delegated administration is disabled */ | |
34dc7c2f BB |
132 | EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ |
133 | EZFS_SHARESMBFAILED, /* failed to share over smb */ | |
134 | EZFS_BADCACHE, /* bad cache file */ | |
135 | EZFS_ISL2CACHE, /* device is for the level 2 ARC */ | |
136 | EZFS_VDEVNOTSUP, /* unsupported vdev type */ | |
b128c09f BB |
137 | EZFS_NOTSUP, /* ops not supported on this dataset */ |
138 | EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ | |
9babb374 | 139 | EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ |
45d1cae3 BB |
140 | EZFS_REFTAG_RELE, /* snapshot release: tag not found */ |
141 | EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ | |
428870ff BB |
142 | EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ |
143 | EZFS_PIPEFAILED, /* pipe create failed */ | |
144 | EZFS_THREADCREATEFAILED, /* thread create failed */ | |
145 | EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ | |
146 | EZFS_SCRUBBING, /* currently scrubbing */ | |
147 | EZFS_NO_SCRUB, /* no active scrub */ | |
572e2857 BB |
148 | EZFS_DIFF, /* general failure of zfs diff */ |
149 | EZFS_DIFFDATA, /* bad zfs diff data */ | |
150 | EZFS_POOLREADONLY, /* pool is in read-only mode */ | |
0ea05c64 | 151 | EZFS_SCRUB_PAUSED, /* scrub currently paused */ |
379ca9cf | 152 | EZFS_ACTIVE_POOL, /* pool is imported on a different system */ |
b5256303 | 153 | EZFS_CRYPTOFAILED, /* failed to setup encryption */ |
a1d477c2 | 154 | EZFS_NO_PENDING, /* cannot cancel, no operation is pending */ |
d2734cce SD |
155 | EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */ |
156 | EZFS_DISCARDING_CHECKPOINT, /* currently discarding a checkpoint */ | |
157 | EZFS_NO_CHECKPOINT, /* pool has no checkpoint */ | |
158 | EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */ | |
159 | EZFS_VDEV_TOO_BIG, /* a device is too big to be used */ | |
b83a0e2d | 160 | EZFS_IOC_NOTSUPPORTED, /* operation not supported by zfs module */ |
34dc7c2f | 161 | EZFS_UNKNOWN |
6f1ffb06 | 162 | } zfs_error_t; |
34dc7c2f BB |
163 | |
164 | /* | |
165 | * The following data structures are all part | |
166 | * of the zfs_allow_t data structure which is | |
167 | * used for printing 'allow' permissions. | |
168 | * It is a linked list of zfs_allow_t's which | |
169 | * then contain avl tree's for user/group/sets/... | |
170 | * and each one of the entries in those trees have | |
171 | * avl tree's for the permissions they belong to and | |
172 | * whether they are local,descendent or local+descendent | |
173 | * permissions. The AVL trees are used primarily for | |
174 | * sorting purposes, but also so that we can quickly find | |
175 | * a given user and or permission. | |
176 | */ | |
177 | typedef struct zfs_perm_node { | |
178 | avl_node_t z_node; | |
179 | char z_pname[MAXPATHLEN]; | |
180 | } zfs_perm_node_t; | |
181 | ||
182 | typedef struct zfs_allow_node { | |
183 | avl_node_t z_node; | |
184 | char z_key[MAXPATHLEN]; /* name, such as joe */ | |
185 | avl_tree_t z_localdescend; /* local+descendent perms */ | |
186 | avl_tree_t z_local; /* local permissions */ | |
187 | avl_tree_t z_descend; /* descendent permissions */ | |
188 | } zfs_allow_node_t; | |
189 | ||
190 | typedef struct zfs_allow { | |
191 | struct zfs_allow *z_next; | |
192 | char z_setpoint[MAXPATHLEN]; | |
193 | avl_tree_t z_sets; | |
194 | avl_tree_t z_crperms; | |
195 | avl_tree_t z_user; | |
196 | avl_tree_t z_group; | |
197 | avl_tree_t z_everyone; | |
198 | } zfs_allow_t; | |
199 | ||
200 | /* | |
201 | * Basic handle types | |
202 | */ | |
203 | typedef struct zfs_handle zfs_handle_t; | |
204 | typedef struct zpool_handle zpool_handle_t; | |
205 | typedef struct libzfs_handle libzfs_handle_t; | |
206 | ||
207 | /* | |
208 | * Library initialization | |
209 | */ | |
210 | extern libzfs_handle_t *libzfs_init(void); | |
211 | extern void libzfs_fini(libzfs_handle_t *); | |
212 | ||
213 | extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); | |
214 | extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); | |
215 | ||
216 | extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); | |
217 | ||
6f1ffb06 MA |
218 | extern void zfs_save_arguments(int argc, char **, char *, int); |
219 | extern int zpool_log_history(libzfs_handle_t *, const char *); | |
220 | ||
34dc7c2f | 221 | extern int libzfs_errno(libzfs_handle_t *); |
65037d9b | 222 | extern const char *libzfs_error_init(int); |
34dc7c2f BB |
223 | extern const char *libzfs_error_action(libzfs_handle_t *); |
224 | extern const char *libzfs_error_description(libzfs_handle_t *); | |
da536844 | 225 | extern int zfs_standard_error(libzfs_handle_t *, int, const char *); |
fb5f0bc8 BB |
226 | extern void libzfs_mnttab_init(libzfs_handle_t *); |
227 | extern void libzfs_mnttab_fini(libzfs_handle_t *); | |
9babb374 | 228 | extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); |
fb5f0bc8 BB |
229 | extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, |
230 | struct mnttab *); | |
231 | extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, | |
232 | const char *, const char *); | |
233 | extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); | |
34dc7c2f BB |
234 | |
235 | /* | |
236 | * Basic handle functions | |
237 | */ | |
238 | extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); | |
239 | extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); | |
240 | extern void zpool_close(zpool_handle_t *); | |
241 | extern const char *zpool_get_name(zpool_handle_t *); | |
242 | extern int zpool_get_state(zpool_handle_t *); | |
6b8655ad | 243 | extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); |
131cc95c | 244 | extern const char *zpool_pool_state_to_name(pool_state_t); |
b128c09f | 245 | extern void zpool_free_handles(libzfs_handle_t *); |
34dc7c2f BB |
246 | |
247 | /* | |
248 | * Iterate over all active pools in the system. | |
249 | */ | |
250 | typedef int (*zpool_iter_f)(zpool_handle_t *, void *); | |
251 | extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); | |
d21d5b82 | 252 | extern boolean_t zpool_skip_pool(const char *); |
34dc7c2f BB |
253 | |
254 | /* | |
255 | * Functions to create and destroy pools | |
256 | */ | |
257 | extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, | |
b128c09f | 258 | nvlist_t *, nvlist_t *); |
6f1ffb06 | 259 | extern int zpool_destroy(zpool_handle_t *, const char *); |
34dc7c2f BB |
260 | extern int zpool_add(zpool_handle_t *, nvlist_t *); |
261 | ||
428870ff BB |
262 | typedef struct splitflags { |
263 | /* do not split, but return the config that would be split off */ | |
264 | int dryrun : 1; | |
265 | ||
266 | /* after splitting, import the pool */ | |
267 | int import : 1; | |
d2f3e292 | 268 | int name_flags; |
428870ff BB |
269 | } splitflags_t; |
270 | ||
34dc7c2f BB |
271 | /* |
272 | * Functions to manipulate pool and vdev state | |
273 | */ | |
0ea05c64 | 274 | extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); |
428870ff | 275 | extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); |
3541dc6d | 276 | extern int zpool_reguid(zpool_handle_t *); |
d3f2cd7e | 277 | extern int zpool_reopen_one(zpool_handle_t *, void *); |
34dc7c2f | 278 | |
bec1067d AP |
279 | extern int zpool_sync_one(zpool_handle_t *, void *); |
280 | ||
34dc7c2f BB |
281 | extern int zpool_vdev_online(zpool_handle_t *, const char *, int, |
282 | vdev_state_t *); | |
283 | extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); | |
284 | extern int zpool_vdev_attach(zpool_handle_t *, const char *, | |
285 | const char *, nvlist_t *, int); | |
286 | extern int zpool_vdev_detach(zpool_handle_t *, const char *); | |
287 | extern int zpool_vdev_remove(zpool_handle_t *, const char *); | |
a1d477c2 MA |
288 | extern int zpool_vdev_remove_cancel(zpool_handle_t *); |
289 | extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *); | |
428870ff BB |
290 | extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, |
291 | splitflags_t); | |
34dc7c2f | 292 | |
428870ff BB |
293 | extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); |
294 | extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); | |
34dc7c2f BB |
295 | extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); |
296 | ||
297 | extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, | |
b128c09f | 298 | boolean_t *, boolean_t *); |
9babb374 BB |
299 | extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, |
300 | boolean_t *, boolean_t *, boolean_t *); | |
d603ed6c | 301 | extern int zpool_label_disk_wait(char *, int); |
34dc7c2f | 302 | extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); |
4a283c7f | 303 | extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, const char *path); |
34dc7c2f | 304 | |
1bbd8770 | 305 | int zfs_dev_is_dm(char *dev_name); |
dbb38f66 | 306 | int zfs_dev_is_whole_disk(char *dev_name); |
1bbd8770 TH |
307 | char *zfs_get_underlying_path(char *dev_name); |
308 | char *zfs_get_enclosure_sysfs_path(char *dev_name); | |
6078881a | 309 | |
f0ed6c74 TH |
310 | const char *zpool_get_state_str(zpool_handle_t *); |
311 | ||
34dc7c2f BB |
312 | /* |
313 | * Functions to manage pool properties | |
314 | */ | |
315 | extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); | |
316 | extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, | |
8b921f66 | 317 | size_t proplen, zprop_source_t *, boolean_t literal); |
34dc7c2f BB |
318 | extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, |
319 | zprop_source_t *); | |
320 | ||
321 | extern const char *zpool_prop_to_name(zpool_prop_t); | |
322 | extern const char *zpool_prop_values(zpool_prop_t); | |
323 | ||
324 | /* | |
325 | * Pool health statistics. | |
326 | */ | |
327 | typedef enum { | |
328 | /* | |
329 | * The following correspond to faults as defined in the (fault.fs.zfs.*) | |
330 | * event namespace. Each is associated with a corresponding message ID. | |
331 | */ | |
332 | ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ | |
333 | ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ | |
334 | ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ | |
335 | ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ | |
336 | ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ | |
337 | ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ | |
338 | ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ | |
339 | ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ | |
340 | ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ | |
341 | ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ | |
342 | ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ | |
379ca9cf OF |
343 | ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ |
344 | ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ | |
b128c09f BB |
345 | ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ |
346 | ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ | |
cec3a0a1 | 347 | ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ |
d164b209 | 348 | ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ |
ffe9d382 | 349 | ZPOOL_STATUS_ERRATA, /* informational errata available */ |
d164b209 | 350 | |
9ae529ec CS |
351 | /* |
352 | * If the pool has unsupported features but can still be opened in | |
353 | * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the | |
354 | * pool has unsupported features but cannot be opened at all, its | |
355 | * status is ZPOOL_STATUS_UNSUP_FEAT_READ. | |
356 | */ | |
357 | ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ | |
358 | ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ | |
359 | ||
d164b209 BB |
360 | /* |
361 | * These faults have no corresponding message ID. At the time we are | |
362 | * checking the status, the original reason for the FMA fault (I/O or | |
363 | * checksum errors) has been lost. | |
364 | */ | |
34dc7c2f BB |
365 | ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ |
366 | ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ | |
367 | ||
368 | /* | |
369 | * The following are not faults per se, but still an error possibly | |
370 | * requiring administrative attention. There is no corresponding | |
371 | * message ID. | |
372 | */ | |
b9b24bb4 CS |
373 | ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ |
374 | ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ | |
34dc7c2f | 375 | ZPOOL_STATUS_RESILVERING, /* device being resilvered */ |
f7c63cda | 376 | ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ |
45d1cae3 | 377 | ZPOOL_STATUS_REMOVED_DEV, /* removed device */ |
34dc7c2f BB |
378 | |
379 | /* | |
380 | * Finally, the following indicates a healthy pool. | |
381 | */ | |
382 | ZPOOL_STATUS_OK | |
383 | } zpool_status_t; | |
384 | ||
ffe9d382 BB |
385 | extern zpool_status_t zpool_get_status(zpool_handle_t *, char **, |
386 | zpool_errata_t *); | |
387 | extern zpool_status_t zpool_import_status(nvlist_t *, char **, | |
388 | zpool_errata_t *); | |
428870ff | 389 | extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); |
34dc7c2f BB |
390 | |
391 | /* | |
392 | * Statistics and configuration functions. | |
393 | */ | |
394 | extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); | |
9ae529ec | 395 | extern nvlist_t *zpool_get_features(zpool_handle_t *); |
34dc7c2f BB |
396 | extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); |
397 | extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); | |
398 | ||
399 | /* | |
400 | * Import and export functions | |
401 | */ | |
6f1ffb06 MA |
402 | extern int zpool_export(zpool_handle_t *, boolean_t, const char *); |
403 | extern int zpool_export_force(zpool_handle_t *, const char *); | |
34dc7c2f BB |
404 | extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, |
405 | char *altroot); | |
406 | extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, | |
572e2857 | 407 | nvlist_t *, int); |
9ae529ec | 408 | extern void zpool_print_unsup_feat(nvlist_t *config); |
34dc7c2f BB |
409 | |
410 | /* | |
411 | * Search for pools to import | |
412 | */ | |
428870ff BB |
413 | |
414 | typedef struct importargs { | |
415 | char **path; /* a list of paths to search */ | |
416 | int paths; /* number of paths to search */ | |
417 | char *poolname; /* name of a pool to find */ | |
418 | uint64_t guid; /* guid of a pool to find */ | |
419 | char *cachefile; /* cachefile to use for import */ | |
420 | int can_be_active : 1; /* can the pool be active? */ | |
421 | int unique : 1; /* does 'poolname' already exist? */ | |
422 | int exists : 1; /* set on return if pool already exists */ | |
7d11e37e | 423 | int scan : 1; /* prefer scanning to libblkid cache */ |
8a393be3 | 424 | nvlist_t *policy; /* load policy (max txg, rewind, etc.) */ |
428870ff BB |
425 | } importargs_t; |
426 | ||
427 | extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); | |
379ca9cf OF |
428 | extern int zpool_tryimport(libzfs_handle_t *hdl, char *target, |
429 | nvlist_t **configp, importargs_t *args); | |
428870ff BB |
430 | |
431 | /* legacy pool search routines */ | |
b128c09f | 432 | extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); |
34dc7c2f | 433 | extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, |
b128c09f | 434 | char *, uint64_t); |
34dc7c2f BB |
435 | |
436 | /* | |
437 | * Miscellaneous pool functions | |
438 | */ | |
439 | struct zfs_cmd; | |
440 | ||
6f1ffb06 | 441 | extern const char *zfs_history_event_names[]; |
428870ff | 442 | |
d2f3e292 RY |
443 | typedef enum { |
444 | VDEV_NAME_PATH = 1 << 0, | |
445 | VDEV_NAME_GUID = 1 << 1, | |
446 | VDEV_NAME_FOLLOW_LINKS = 1 << 2, | |
447 | VDEV_NAME_TYPE_ID = 1 << 3, | |
448 | } vdev_name_t; | |
449 | ||
428870ff | 450 | extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, |
d2f3e292 | 451 | int name_flags); |
34dc7c2f BB |
452 | extern int zpool_upgrade(zpool_handle_t *, uint64_t); |
453 | extern int zpool_get_history(zpool_handle_t *, nvlist_t **); | |
428870ff BB |
454 | extern int zpool_history_unpack(char *, uint64_t, uint64_t *, |
455 | nvlist_t ***, uint_t *); | |
8c7aa0cf CD |
456 | extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, |
457 | int); | |
26685276 | 458 | extern int zpool_events_clear(libzfs_handle_t *, int *); |
75e3ff58 | 459 | extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int); |
34dc7c2f BB |
460 | extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, |
461 | size_t len); | |
462 | extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); | |
9babb374 | 463 | extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); |
428870ff BB |
464 | extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, |
465 | nvlist_t *); | |
d2734cce SD |
466 | extern int zpool_checkpoint(zpool_handle_t *); |
467 | extern int zpool_discard_checkpoint(zpool_handle_t *); | |
9babb374 | 468 | |
34dc7c2f BB |
469 | /* |
470 | * Basic handle manipulations. These functions do not create or destroy the | |
471 | * underlying datasets, only the references to them. | |
472 | */ | |
473 | extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); | |
330d06f9 | 474 | extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); |
34dc7c2f BB |
475 | extern void zfs_close(zfs_handle_t *); |
476 | extern zfs_type_t zfs_get_type(const zfs_handle_t *); | |
477 | extern const char *zfs_get_name(const zfs_handle_t *); | |
b128c09f | 478 | extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); |
d21d5b82 | 479 | extern const char *zfs_get_pool_name(const zfs_handle_t *); |
34dc7c2f BB |
480 | |
481 | /* | |
482 | * Property management functions. Some functions are shared with the kernel, | |
483 | * and are found in sys/fs/zfs.h. | |
484 | */ | |
485 | ||
486 | /* | |
487 | * zfs dataset property management | |
488 | */ | |
489 | extern const char *zfs_prop_default_string(zfs_prop_t); | |
490 | extern uint64_t zfs_prop_default_numeric(zfs_prop_t); | |
491 | extern const char *zfs_prop_column_name(zfs_prop_t); | |
492 | extern boolean_t zfs_prop_align_right(zfs_prop_t); | |
493 | ||
b5256303 TC |
494 | extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *, |
495 | uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *); | |
b128c09f | 496 | |
34dc7c2f BB |
497 | extern const char *zfs_prop_to_name(zfs_prop_t); |
498 | extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); | |
23de906c | 499 | extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); |
34dc7c2f BB |
500 | extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, |
501 | zprop_source_t *, char *, size_t, boolean_t); | |
428870ff BB |
502 | extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, |
503 | boolean_t); | |
34dc7c2f BB |
504 | extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, |
505 | zprop_source_t *, char *, size_t); | |
9babb374 BB |
506 | extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, |
507 | uint64_t *propvalue); | |
508 | extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, | |
509 | char *propbuf, int proplen, boolean_t literal); | |
330d06f9 MA |
510 | extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, |
511 | uint64_t *propvalue); | |
512 | extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, | |
513 | char *propbuf, int proplen, boolean_t literal); | |
9ae529ec CS |
514 | extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, |
515 | char *buf, size_t len); | |
2cf7f52b | 516 | extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **); |
34dc7c2f | 517 | extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); |
428870ff | 518 | extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); |
34dc7c2f BB |
519 | extern const char *zfs_prop_values(zfs_prop_t); |
520 | extern int zfs_prop_is_string(zfs_prop_t prop); | |
6044cf59 | 521 | extern nvlist_t *zfs_get_all_props(zfs_handle_t *); |
34dc7c2f | 522 | extern nvlist_t *zfs_get_user_props(zfs_handle_t *); |
428870ff | 523 | extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); |
330d06f9 | 524 | extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); |
34dc7c2f | 525 | |
b5256303 TC |
526 | /* |
527 | * zfs encryption management | |
528 | */ | |
529 | extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *); | |
530 | extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *, | |
d9c460a0 | 531 | boolean_t stdin_available, uint8_t **, uint_t *); |
b5256303 TC |
532 | extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, |
533 | nvlist_t *); | |
534 | extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *); | |
535 | extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *); | |
536 | extern int zfs_crypto_unload_key(zfs_handle_t *); | |
537 | extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); | |
538 | ||
34dc7c2f BB |
539 | typedef struct zprop_list { |
540 | int pl_prop; | |
541 | char *pl_user_prop; | |
542 | struct zprop_list *pl_next; | |
543 | boolean_t pl_all; | |
544 | size_t pl_width; | |
428870ff | 545 | size_t pl_recvd_width; |
34dc7c2f BB |
546 | boolean_t pl_fixed; |
547 | } zprop_list_t; | |
548 | ||
54d5378f YP |
549 | extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, |
550 | boolean_t); | |
9babb374 | 551 | extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); |
34dc7c2f BB |
552 | |
553 | #define ZFS_MOUNTPOINT_NONE "none" | |
554 | #define ZFS_MOUNTPOINT_LEGACY "legacy" | |
555 | ||
9ae529ec CS |
556 | #define ZFS_FEATURE_DISABLED "disabled" |
557 | #define ZFS_FEATURE_ENABLED "enabled" | |
558 | #define ZFS_FEATURE_ACTIVE "active" | |
559 | ||
560 | #define ZFS_UNSUPPORTED_INACTIVE "inactive" | |
561 | #define ZFS_UNSUPPORTED_READONLY "readonly" | |
562 | ||
34dc7c2f BB |
563 | /* |
564 | * zpool property management | |
565 | */ | |
566 | extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); | |
9ae529ec CS |
567 | extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, |
568 | size_t); | |
34dc7c2f BB |
569 | extern const char *zpool_prop_default_string(zpool_prop_t); |
570 | extern uint64_t zpool_prop_default_numeric(zpool_prop_t); | |
571 | extern const char *zpool_prop_column_name(zpool_prop_t); | |
572 | extern boolean_t zpool_prop_align_right(zpool_prop_t); | |
573 | ||
574 | /* | |
575 | * Functions shared by zfs and zpool property management. | |
576 | */ | |
577 | extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, | |
578 | boolean_t ordered, zfs_type_t type); | |
579 | extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, | |
580 | zfs_type_t); | |
581 | extern void zprop_free_list(zprop_list_t *); | |
582 | ||
428870ff BB |
583 | #define ZFS_GET_NCOLS 5 |
584 | ||
585 | typedef enum { | |
586 | GET_COL_NONE, | |
587 | GET_COL_NAME, | |
588 | GET_COL_PROPERTY, | |
589 | GET_COL_VALUE, | |
590 | GET_COL_RECVD, | |
591 | GET_COL_SOURCE | |
592 | } zfs_get_column_t; | |
593 | ||
34dc7c2f BB |
594 | /* |
595 | * Functions for printing zfs or zpool properties | |
596 | */ | |
597 | typedef struct zprop_get_cbdata { | |
598 | int cb_sources; | |
428870ff BB |
599 | zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; |
600 | int cb_colwidths[ZFS_GET_NCOLS + 1]; | |
34dc7c2f BB |
601 | boolean_t cb_scripted; |
602 | boolean_t cb_literal; | |
603 | boolean_t cb_first; | |
604 | zprop_list_t *cb_proplist; | |
605 | zfs_type_t cb_type; | |
606 | } zprop_get_cbdata_t; | |
607 | ||
608 | void zprop_print_one_property(const char *, zprop_get_cbdata_t *, | |
428870ff BB |
609 | const char *, const char *, zprop_source_t, const char *, |
610 | const char *); | |
34dc7c2f BB |
611 | |
612 | /* | |
613 | * Iterator functions. | |
614 | */ | |
615 | typedef int (*zfs_iter_f)(zfs_handle_t *, void *); | |
616 | extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); | |
617 | extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); | |
618 | extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); | |
619 | extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); | |
0cee2406 | 620 | extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); |
428870ff | 621 | extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); |
330d06f9 | 622 | extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); |
da536844 | 623 | extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); |
34dc7c2f | 624 | |
572e2857 BB |
625 | typedef struct get_all_cb { |
626 | zfs_handle_t **cb_handles; | |
627 | size_t cb_alloc; | |
628 | size_t cb_used; | |
629 | boolean_t cb_verbose; | |
630 | int (*cb_getone)(zfs_handle_t *, void *); | |
631 | } get_all_cb_t; | |
632 | ||
633 | void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); | |
634 | int libzfs_dataset_cmp(const void *, const void *); | |
635 | ||
34dc7c2f BB |
636 | /* |
637 | * Functions to create and destroy datasets. | |
638 | */ | |
639 | extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, | |
640 | nvlist_t *); | |
641 | extern int zfs_create_ancestors(libzfs_handle_t *, const char *); | |
45d1cae3 BB |
642 | extern int zfs_destroy(zfs_handle_t *, boolean_t); |
643 | extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); | |
13fe0198 | 644 | extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); |
34dc7c2f | 645 | extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); |
b128c09f | 646 | extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); |
6f1ffb06 MA |
647 | extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, |
648 | nvlist_t *props); | |
34dc7c2f | 649 | extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); |
db49968e | 650 | extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); |
428870ff BB |
651 | |
652 | typedef struct sendflags { | |
653 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 654 | boolean_t verbose; |
428870ff BB |
655 | |
656 | /* recursive send (ie, -R) */ | |
330d06f9 | 657 | boolean_t replicate; |
428870ff BB |
658 | |
659 | /* for incrementals, do all intermediate snapshots */ | |
330d06f9 | 660 | boolean_t doall; |
428870ff BB |
661 | |
662 | /* if dataset is a clone, do incremental from its origin */ | |
330d06f9 | 663 | boolean_t fromorigin; |
428870ff BB |
664 | |
665 | /* do deduplication */ | |
330d06f9 | 666 | boolean_t dedup; |
428870ff BB |
667 | |
668 | /* send properties (ie, -p) */ | |
330d06f9 MA |
669 | boolean_t props; |
670 | ||
671 | /* do not send (no-op, ie. -n) */ | |
672 | boolean_t dryrun; | |
673 | ||
674 | /* parsable verbose output (ie. -P) */ | |
675 | boolean_t parsable; | |
37abac6d BP |
676 | |
677 | /* show progress (ie. -v) */ | |
678 | boolean_t progress; | |
9b67f605 | 679 | |
f1512ee6 MA |
680 | /* large blocks (>128K) are permitted */ |
681 | boolean_t largeblock; | |
682 | ||
9b67f605 MA |
683 | /* WRITE_EMBEDDED records of type DATA are permitted */ |
684 | boolean_t embed_data; | |
2aa34383 DK |
685 | |
686 | /* compressed WRITE records are permitted */ | |
687 | boolean_t compress; | |
b5256303 TC |
688 | |
689 | /* raw encrypted records are permitted */ | |
690 | boolean_t raw; | |
faa97c16 | 691 | |
692 | /* only send received properties (ie. -b) */ | |
693 | boolean_t backup; | |
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 **); | |
835db585 | 700 | extern int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t flags); |
47dfff3b MA |
701 | extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, |
702 | const char *); | |
703 | extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, | |
704 | const char *token); | |
428870ff | 705 | |
34dc7c2f | 706 | extern int zfs_promote(zfs_handle_t *); |
13fe0198 | 707 | extern int zfs_hold(zfs_handle_t *, const char *, const char *, |
95fd54a1 SH |
708 | boolean_t, int); |
709 | extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); | |
45d1cae3 | 710 | extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); |
0b7936d5 | 711 | extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); |
428870ff | 712 | extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); |
34dc7c2f | 713 | |
9babb374 BB |
714 | typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, |
715 | uid_t rid, uint64_t space); | |
716 | ||
0b7936d5 AS |
717 | extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, |
718 | zfs_userspace_cb_t, void *); | |
719 | ||
720 | extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); | |
721 | extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); | |
9babb374 | 722 | |
34dc7c2f BB |
723 | typedef struct recvflags { |
724 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 725 | boolean_t verbose; |
34dc7c2f BB |
726 | |
727 | /* the destination is a prefix, not the exact fs (ie, -d) */ | |
330d06f9 | 728 | boolean_t isprefix; |
34dc7c2f | 729 | |
428870ff BB |
730 | /* |
731 | * Only the tail of the sent snapshot path is appended to the | |
732 | * destination to determine the received snapshot name (ie, -e). | |
733 | */ | |
330d06f9 | 734 | boolean_t istail; |
428870ff | 735 | |
34dc7c2f | 736 | /* do not actually do the recv, just check if it would work (ie, -n) */ |
330d06f9 | 737 | boolean_t dryrun; |
34dc7c2f BB |
738 | |
739 | /* rollback/destroy filesystems as necessary (eg, -F) */ | |
330d06f9 | 740 | boolean_t force; |
34dc7c2f BB |
741 | |
742 | /* set "canmount=off" on all modified filesystems */ | |
330d06f9 | 743 | boolean_t canmountoff; |
34dc7c2f | 744 | |
47dfff3b MA |
745 | /* |
746 | * Mark the file systems as "resumable" and do not destroy them if the | |
747 | * receive is interrupted | |
748 | */ | |
749 | boolean_t resumable; | |
750 | ||
34dc7c2f | 751 | /* byteswap flag is used internally; callers need not specify */ |
330d06f9 | 752 | boolean_t byteswap; |
d164b209 BB |
753 | |
754 | /* do not mount file systems as they are extracted (private) */ | |
330d06f9 | 755 | boolean_t nomount; |
34dc7c2f BB |
756 | } recvflags_t; |
757 | ||
fcff0f35 PD |
758 | extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, |
759 | recvflags_t *, int, avl_tree_t *); | |
34dc7c2f | 760 | |
572e2857 BB |
761 | typedef enum diff_flags { |
762 | ZFS_DIFF_PARSEABLE = 0x1, | |
763 | ZFS_DIFF_TIMESTAMP = 0x2, | |
764 | ZFS_DIFF_CLASSIFY = 0x4 | |
765 | } diff_flags_t; | |
766 | ||
767 | extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, | |
768 | int); | |
769 | ||
34dc7c2f BB |
770 | /* |
771 | * Miscellaneous functions. | |
772 | */ | |
773 | extern const char *zfs_type_to_name(zfs_type_t); | |
774 | extern void zfs_refresh_properties(zfs_handle_t *); | |
775 | extern int zfs_name_valid(const char *, zfs_type_t); | |
776 | extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); | |
b5256303 | 777 | extern int zfs_parent_name(zfs_handle_t *, char *, size_t); |
34dc7c2f BB |
778 | extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, |
779 | zfs_type_t); | |
780 | extern int zfs_spa_version(zfs_handle_t *, int *); | |
da536844 | 781 | extern boolean_t zfs_bookmark_exists(const char *path); |
eac47204 | 782 | extern int zfs_append_partition(char *path, size_t max_len); |
79e7242a | 783 | extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen); |
eac47204 | 784 | extern int zfs_strcmp_pathname(char *name, char *cmp_name, int wholedisk); |
83bf769d | 785 | extern int zfs_path_order(char *path, int *order); |
34dc7c2f | 786 | |
34dc7c2f BB |
787 | /* |
788 | * Mount support functions. | |
789 | */ | |
790 | extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); | |
791 | extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); | |
792 | extern int zfs_mount(zfs_handle_t *, const char *, int); | |
793 | extern int zfs_unmount(zfs_handle_t *, const char *, int); | |
794 | extern int zfs_unmountall(zfs_handle_t *, int); | |
795 | ||
796 | /* | |
797 | * Share support functions. | |
798 | */ | |
799 | extern boolean_t zfs_is_shared(zfs_handle_t *); | |
800 | extern int zfs_share(zfs_handle_t *); | |
801 | extern int zfs_unshare(zfs_handle_t *); | |
802 | ||
803 | /* | |
804 | * Protocol-specific share support functions. | |
805 | */ | |
806 | extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); | |
807 | extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); | |
808 | extern int zfs_share_nfs(zfs_handle_t *); | |
809 | extern int zfs_share_smb(zfs_handle_t *); | |
810 | extern int zfs_shareall(zfs_handle_t *); | |
811 | extern int zfs_unshare_nfs(zfs_handle_t *, const char *); | |
812 | extern int zfs_unshare_smb(zfs_handle_t *, const char *); | |
813 | extern int zfs_unshareall_nfs(zfs_handle_t *); | |
814 | extern int zfs_unshareall_smb(zfs_handle_t *); | |
815 | extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); | |
2f71caf2 | 816 | extern int zfs_unshareall_bytype(zfs_handle_t *, const char *, const char *); |
34dc7c2f | 817 | extern int zfs_unshareall(zfs_handle_t *); |
9babb374 | 818 | extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, |
34dc7c2f BB |
819 | void *, void *, int, zfs_share_op_t); |
820 | ||
29eb4942 TH |
821 | /* |
822 | * Formats for iostat numbers. Examples: "12K", "30ms", "4B", "2321234", "-". | |
823 | * | |
824 | * ZFS_NICENUM_1024: Print kilo, mega, tera, peta, exa.. | |
825 | * ZFS_NICENUM_BYTES: Print single bytes ("13B"), kilo, mega, tera... | |
826 | * ZFS_NICENUM_TIME: Print nanosecs, microsecs, millisecs, seconds... | |
827 | * ZFS_NICENUM_RAW: Print the raw number without any formatting | |
828 | * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero. | |
829 | */ | |
193a37cb TH |
830 | enum zfs_nicenum_format { |
831 | ZFS_NICENUM_1024 = 0, | |
e7fbeb60 | 832 | ZFS_NICENUM_BYTES = 1, |
833 | ZFS_NICENUM_TIME = 2, | |
29eb4942 TH |
834 | ZFS_NICENUM_RAW = 3, |
835 | ZFS_NICENUM_RAWTIME = 4 | |
193a37cb TH |
836 | }; |
837 | ||
34dc7c2f BB |
838 | /* |
839 | * Utility function to convert a number to a human-readable form. | |
840 | */ | |
841 | extern void zfs_nicenum(uint64_t, char *, size_t); | |
193a37cb TH |
842 | extern void zfs_nicenum_format(uint64_t num, char *buf, size_t buflen, |
843 | enum zfs_nicenum_format type); | |
844 | ||
845 | ||
846 | extern void zfs_nicetime(uint64_t, char *, size_t); | |
e7fbeb60 | 847 | extern void zfs_nicebytes(uint64_t, char *, size_t); |
34dc7c2f BB |
848 | extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); |
849 | ||
feb46b92 BB |
850 | /* |
851 | * Utility functions to run an external process. | |
852 | */ | |
9ac97c2a BB |
853 | #define STDOUT_VERBOSE 0x01 |
854 | #define STDERR_VERBOSE 0x02 | |
d6418de0 | 855 | #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ |
9ac97c2a BB |
856 | |
857 | int libzfs_run_process(const char *, char **, int flags); | |
d6418de0 TH |
858 | int libzfs_run_process_get_stdout(const char *path, char *argv[], char *env[], |
859 | char **lines[], int *lines_cnt); | |
860 | int libzfs_run_process_get_stdout_nopath(const char *path, char *argv[], | |
861 | char *env[], char **lines[], int *lines_cnt); | |
862 | ||
863 | void libzfs_free_str_array(char **strs, int count); | |
864 | ||
865 | int libzfs_envvar_is_set(char *envvar); | |
feb46b92 | 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 | */ |
7d90f569 | 876 | extern int zpool_read_label(int, nvlist_t **, int *); |
428870ff | 877 | extern int zpool_clear_label(int); |
34dc7c2f | 878 | |
9babb374 BB |
879 | /* |
880 | * Management interfaces for SMB ACL files | |
881 | */ | |
882 | ||
883 | int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); | |
884 | int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); | |
885 | int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); | |
886 | int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); | |
887 | ||
34dc7c2f BB |
888 | /* |
889 | * Enable and disable datasets within a pool by mounting/unmounting and | |
890 | * sharing/unsharing them. | |
891 | */ | |
892 | extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); | |
893 | extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); | |
894 | ||
39fc0cb5 DB |
895 | /* |
896 | * Support for Linux libudev derived persistent device strings | |
897 | */ | |
898 | extern boolean_t is_mpath_whole_disk(const char *); | |
899 | extern void update_vdev_config_dev_strs(nvlist_t *); | |
6078881a | 900 | extern char *zfs_strip_partition(char *); |
8720e9e7 | 901 | extern char *zfs_strip_partition_path(char *); |
d02ca379 DB |
902 | |
903 | #ifdef HAVE_LIBUDEV | |
904 | struct udev_device; | |
6078881a TH |
905 | |
906 | extern boolean_t udev_is_mpath(struct udev_device *dev); | |
d02ca379 DB |
907 | extern int zfs_device_get_devid(struct udev_device *, char *, size_t); |
908 | extern int zfs_device_get_physical(struct udev_device *, char *, size_t); | |
909 | #endif | |
39fc0cb5 | 910 | |
a1d477c2 MA |
911 | extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *); |
912 | ||
34dc7c2f BB |
913 | #ifdef __cplusplus |
914 | } | |
915 | #endif | |
916 | ||
917 | #endif /* _LIBZFS_H */ |