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