]>
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. |
cae5b340 | 24 | * Copyright (c) 2011, 2015 by Delphix. All rights reserved. |
37abac6d | 25 | * Copyright (c) 2012, Joyent, Inc. All rights reserved. |
a08ee875 | 26 | * Copyright (c) 2013 Steven Hartland. All rights reserved. |
cae5b340 AX |
27 | * Copyright (c) 2016, Intel Corporation. |
28 | * Copyright 2016 Nexenta Systems, Inc. | |
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> | |
ea04106b | 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" | |
cae5b340 | 61 | #define ZVOL_ROOT "/dev/zvol" |
d603ed6c | 62 | |
a08ee875 LG |
63 | /* |
64 | * Default wait time for a device name to be created. | |
65 | */ | |
66 | #define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */ | |
67 | ||
cae5b340 AX |
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 | |
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 | */ | |
a08ee875 LG |
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 */ | |
cae5b340 AX |
150 | EZFS_SCRUB_PAUSED, /* scrub currently paused */ |
151 | EZFS_ACTIVE_POOL, /* pool is imported on a different system */ | |
34dc7c2f | 152 | EZFS_UNKNOWN |
a08ee875 | 153 | } zfs_error_t; |
34dc7c2f BB |
154 | |
155 | /* | |
156 | * The following data structures are all part | |
157 | * of the zfs_allow_t data structure which is | |
158 | * used for printing 'allow' permissions. | |
159 | * It is a linked list of zfs_allow_t's which | |
160 | * then contain avl tree's for user/group/sets/... | |
161 | * and each one of the entries in those trees have | |
162 | * avl tree's for the permissions they belong to and | |
163 | * whether they are local,descendent or local+descendent | |
164 | * permissions. The AVL trees are used primarily for | |
165 | * sorting purposes, but also so that we can quickly find | |
166 | * a given user and or permission. | |
167 | */ | |
168 | typedef struct zfs_perm_node { | |
169 | avl_node_t z_node; | |
170 | char z_pname[MAXPATHLEN]; | |
171 | } zfs_perm_node_t; | |
172 | ||
173 | typedef struct zfs_allow_node { | |
174 | avl_node_t z_node; | |
175 | char z_key[MAXPATHLEN]; /* name, such as joe */ | |
176 | avl_tree_t z_localdescend; /* local+descendent perms */ | |
177 | avl_tree_t z_local; /* local permissions */ | |
178 | avl_tree_t z_descend; /* descendent permissions */ | |
179 | } zfs_allow_node_t; | |
180 | ||
181 | typedef struct zfs_allow { | |
182 | struct zfs_allow *z_next; | |
183 | char z_setpoint[MAXPATHLEN]; | |
184 | avl_tree_t z_sets; | |
185 | avl_tree_t z_crperms; | |
186 | avl_tree_t z_user; | |
187 | avl_tree_t z_group; | |
188 | avl_tree_t z_everyone; | |
189 | } zfs_allow_t; | |
190 | ||
191 | /* | |
192 | * Basic handle types | |
193 | */ | |
194 | typedef struct zfs_handle zfs_handle_t; | |
195 | typedef struct zpool_handle zpool_handle_t; | |
196 | typedef struct libzfs_handle libzfs_handle_t; | |
197 | ||
198 | /* | |
199 | * Library initialization | |
200 | */ | |
201 | extern libzfs_handle_t *libzfs_init(void); | |
202 | extern void libzfs_fini(libzfs_handle_t *); | |
203 | ||
204 | extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); | |
205 | extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); | |
206 | ||
207 | extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); | |
208 | ||
a08ee875 LG |
209 | extern void zfs_save_arguments(int argc, char **, char *, int); |
210 | extern int zpool_log_history(libzfs_handle_t *, const char *); | |
211 | ||
34dc7c2f | 212 | extern int libzfs_errno(libzfs_handle_t *); |
e10b0808 | 213 | extern const char *libzfs_error_init(int); |
34dc7c2f BB |
214 | extern const char *libzfs_error_action(libzfs_handle_t *); |
215 | extern const char *libzfs_error_description(libzfs_handle_t *); | |
ea04106b | 216 | extern int zfs_standard_error(libzfs_handle_t *, int, const char *); |
fb5f0bc8 BB |
217 | extern void libzfs_mnttab_init(libzfs_handle_t *); |
218 | extern void libzfs_mnttab_fini(libzfs_handle_t *); | |
9babb374 | 219 | extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); |
fb5f0bc8 BB |
220 | extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, |
221 | struct mnttab *); | |
222 | extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, | |
223 | const char *, const char *); | |
224 | extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); | |
34dc7c2f BB |
225 | |
226 | /* | |
227 | * Basic handle functions | |
228 | */ | |
229 | extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); | |
230 | extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); | |
231 | extern void zpool_close(zpool_handle_t *); | |
232 | extern const char *zpool_get_name(zpool_handle_t *); | |
233 | extern int zpool_get_state(zpool_handle_t *); | |
234 | extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); | |
c06d4368 | 235 | extern const char *zpool_pool_state_to_name(pool_state_t); |
b128c09f | 236 | extern void zpool_free_handles(libzfs_handle_t *); |
34dc7c2f BB |
237 | |
238 | /* | |
239 | * Iterate over all active pools in the system. | |
240 | */ | |
241 | typedef int (*zpool_iter_f)(zpool_handle_t *, void *); | |
242 | extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); | |
cae5b340 | 243 | extern boolean_t zpool_skip_pool(const char *); |
34dc7c2f BB |
244 | |
245 | /* | |
246 | * Functions to create and destroy pools | |
247 | */ | |
248 | extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, | |
b128c09f | 249 | nvlist_t *, nvlist_t *); |
a08ee875 | 250 | extern int zpool_destroy(zpool_handle_t *, const char *); |
34dc7c2f BB |
251 | extern int zpool_add(zpool_handle_t *, nvlist_t *); |
252 | ||
428870ff BB |
253 | typedef struct splitflags { |
254 | /* do not split, but return the config that would be split off */ | |
255 | int dryrun : 1; | |
256 | ||
257 | /* after splitting, import the pool */ | |
258 | int import : 1; | |
4e820b5a | 259 | int name_flags; |
428870ff BB |
260 | } splitflags_t; |
261 | ||
34dc7c2f BB |
262 | /* |
263 | * Functions to manipulate pool and vdev state | |
264 | */ | |
cae5b340 | 265 | extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); |
428870ff | 266 | extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); |
3541dc6d | 267 | extern int zpool_reguid(zpool_handle_t *); |
1bd201e7 | 268 | extern int zpool_reopen(zpool_handle_t *); |
34dc7c2f | 269 | |
cae5b340 AX |
270 | extern int zpool_sync_one(zpool_handle_t *, void *); |
271 | ||
34dc7c2f BB |
272 | extern int zpool_vdev_online(zpool_handle_t *, const char *, int, |
273 | vdev_state_t *); | |
274 | extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); | |
275 | extern int zpool_vdev_attach(zpool_handle_t *, const char *, | |
276 | const char *, nvlist_t *, int); | |
277 | extern int zpool_vdev_detach(zpool_handle_t *, const char *); | |
278 | extern int zpool_vdev_remove(zpool_handle_t *, const char *); | |
428870ff BB |
279 | extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, |
280 | splitflags_t); | |
34dc7c2f | 281 | |
428870ff BB |
282 | extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); |
283 | extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); | |
34dc7c2f BB |
284 | extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); |
285 | ||
286 | extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, | |
b128c09f | 287 | boolean_t *, boolean_t *); |
9babb374 BB |
288 | extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, |
289 | boolean_t *, boolean_t *, boolean_t *); | |
d603ed6c | 290 | extern int zpool_label_disk_wait(char *, int); |
34dc7c2f | 291 | extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); |
cae5b340 AX |
292 | extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, const char *path); |
293 | ||
294 | int zfs_dev_is_dm(char *dev_name); | |
295 | int zfs_dev_is_whole_disk(char *dev_name); | |
296 | char *zfs_get_underlying_path(char *dev_name); | |
297 | char *zfs_get_enclosure_sysfs_path(char *dev_name); | |
34dc7c2f | 298 | |
a07c8b41 MZ |
299 | const char *zpool_get_state_str(zpool_handle_t *); |
300 | ||
34dc7c2f BB |
301 | /* |
302 | * Functions to manage pool properties | |
303 | */ | |
304 | extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); | |
305 | extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, | |
a08ee875 | 306 | size_t proplen, zprop_source_t *, boolean_t literal); |
34dc7c2f BB |
307 | extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, |
308 | zprop_source_t *); | |
309 | ||
310 | extern const char *zpool_prop_to_name(zpool_prop_t); | |
311 | extern const char *zpool_prop_values(zpool_prop_t); | |
312 | ||
313 | /* | |
314 | * Pool health statistics. | |
315 | */ | |
316 | typedef enum { | |
317 | /* | |
318 | * The following correspond to faults as defined in the (fault.fs.zfs.*) | |
319 | * event namespace. Each is associated with a corresponding message ID. | |
320 | */ | |
321 | ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ | |
322 | ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ | |
323 | ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ | |
324 | ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ | |
325 | ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ | |
326 | ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ | |
327 | ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ | |
328 | ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ | |
329 | ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ | |
330 | ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ | |
331 | ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ | |
cae5b340 AX |
332 | ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ |
333 | ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ | |
b128c09f BB |
334 | ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ |
335 | ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ | |
42f7b73b | 336 | ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ |
d164b209 | 337 | ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ |
ea04106b | 338 | ZPOOL_STATUS_ERRATA, /* informational errata available */ |
d164b209 | 339 | |
9ae529ec CS |
340 | /* |
341 | * If the pool has unsupported features but can still be opened in | |
342 | * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the | |
343 | * pool has unsupported features but cannot be opened at all, its | |
344 | * status is ZPOOL_STATUS_UNSUP_FEAT_READ. | |
345 | */ | |
346 | ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ | |
347 | ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ | |
348 | ||
d164b209 BB |
349 | /* |
350 | * These faults have no corresponding message ID. At the time we are | |
351 | * checking the status, the original reason for the FMA fault (I/O or | |
352 | * checksum errors) has been lost. | |
353 | */ | |
34dc7c2f BB |
354 | ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ |
355 | ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ | |
356 | ||
357 | /* | |
358 | * The following are not faults per se, but still an error possibly | |
359 | * requiring administrative attention. There is no corresponding | |
360 | * message ID. | |
361 | */ | |
b9b24bb4 CS |
362 | ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ |
363 | ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ | |
34dc7c2f | 364 | ZPOOL_STATUS_RESILVERING, /* device being resilvered */ |
cae5b340 | 365 | ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ |
45d1cae3 | 366 | ZPOOL_STATUS_REMOVED_DEV, /* removed device */ |
34dc7c2f BB |
367 | |
368 | /* | |
369 | * Finally, the following indicates a healthy pool. | |
370 | */ | |
371 | ZPOOL_STATUS_OK | |
372 | } zpool_status_t; | |
373 | ||
ea04106b AX |
374 | extern unsigned long get_system_hostid(void); |
375 | extern zpool_status_t zpool_get_status(zpool_handle_t *, char **, | |
376 | zpool_errata_t *); | |
377 | extern zpool_status_t zpool_import_status(nvlist_t *, char **, | |
378 | zpool_errata_t *); | |
428870ff | 379 | extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); |
34dc7c2f BB |
380 | |
381 | /* | |
382 | * Statistics and configuration functions. | |
383 | */ | |
384 | extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); | |
9ae529ec | 385 | extern nvlist_t *zpool_get_features(zpool_handle_t *); |
34dc7c2f BB |
386 | extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); |
387 | extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); | |
388 | ||
389 | /* | |
390 | * Import and export functions | |
391 | */ | |
a08ee875 LG |
392 | extern int zpool_export(zpool_handle_t *, boolean_t, const char *); |
393 | extern int zpool_export_force(zpool_handle_t *, const char *); | |
34dc7c2f BB |
394 | extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, |
395 | char *altroot); | |
396 | extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, | |
572e2857 | 397 | nvlist_t *, int); |
9ae529ec | 398 | extern void zpool_print_unsup_feat(nvlist_t *config); |
34dc7c2f BB |
399 | |
400 | /* | |
401 | * Search for pools to import | |
402 | */ | |
428870ff BB |
403 | |
404 | typedef struct importargs { | |
405 | char **path; /* a list of paths to search */ | |
406 | int paths; /* number of paths to search */ | |
407 | char *poolname; /* name of a pool to find */ | |
408 | uint64_t guid; /* guid of a pool to find */ | |
409 | char *cachefile; /* cachefile to use for import */ | |
410 | int can_be_active : 1; /* can the pool be active? */ | |
411 | int unique : 1; /* does 'poolname' already exist? */ | |
412 | int exists : 1; /* set on return if pool already exists */ | |
cae5b340 | 413 | int scan : 1; /* prefer scanning to libblkid cache */ |
428870ff BB |
414 | } importargs_t; |
415 | ||
416 | extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); | |
cae5b340 AX |
417 | extern int zpool_tryimport(libzfs_handle_t *hdl, char *target, |
418 | nvlist_t **configp, importargs_t *args); | |
428870ff BB |
419 | |
420 | /* legacy pool search routines */ | |
b128c09f | 421 | extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); |
34dc7c2f | 422 | extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, |
b128c09f | 423 | char *, uint64_t); |
34dc7c2f BB |
424 | |
425 | /* | |
426 | * Miscellaneous pool functions | |
427 | */ | |
428 | struct zfs_cmd; | |
429 | ||
a08ee875 | 430 | extern const char *zfs_history_event_names[]; |
428870ff | 431 | |
4e820b5a AX |
432 | typedef enum { |
433 | VDEV_NAME_PATH = 1 << 0, | |
434 | VDEV_NAME_GUID = 1 << 1, | |
435 | VDEV_NAME_FOLLOW_LINKS = 1 << 2, | |
436 | VDEV_NAME_TYPE_ID = 1 << 3, | |
437 | } vdev_name_t; | |
438 | ||
428870ff | 439 | extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, |
4e820b5a | 440 | int name_flags); |
34dc7c2f BB |
441 | extern int zpool_upgrade(zpool_handle_t *, uint64_t); |
442 | extern int zpool_get_history(zpool_handle_t *, nvlist_t **); | |
428870ff BB |
443 | extern int zpool_history_unpack(char *, uint64_t, uint64_t *, |
444 | nvlist_t ***, uint_t *); | |
ea04106b AX |
445 | extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, |
446 | int); | |
26685276 | 447 | extern int zpool_events_clear(libzfs_handle_t *, int *); |
ea04106b | 448 | extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int); |
34dc7c2f BB |
449 | extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, |
450 | size_t len); | |
451 | extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); | |
9babb374 | 452 | extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); |
428870ff BB |
453 | extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, |
454 | nvlist_t *); | |
9babb374 | 455 | |
34dc7c2f BB |
456 | /* |
457 | * Basic handle manipulations. These functions do not create or destroy the | |
458 | * underlying datasets, only the references to them. | |
459 | */ | |
460 | extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); | |
330d06f9 | 461 | extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); |
34dc7c2f BB |
462 | extern void zfs_close(zfs_handle_t *); |
463 | extern zfs_type_t zfs_get_type(const zfs_handle_t *); | |
464 | extern const char *zfs_get_name(const zfs_handle_t *); | |
b128c09f | 465 | extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); |
cae5b340 | 466 | extern const char *zfs_get_pool_name(const zfs_handle_t *); |
34dc7c2f BB |
467 | |
468 | /* | |
469 | * Property management functions. Some functions are shared with the kernel, | |
470 | * and are found in sys/fs/zfs.h. | |
471 | */ | |
472 | ||
473 | /* | |
474 | * zfs dataset property management | |
475 | */ | |
476 | extern const char *zfs_prop_default_string(zfs_prop_t); | |
477 | extern uint64_t zfs_prop_default_numeric(zfs_prop_t); | |
478 | extern const char *zfs_prop_column_name(zfs_prop_t); | |
479 | extern boolean_t zfs_prop_align_right(zfs_prop_t); | |
480 | ||
b128c09f | 481 | extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, |
cae5b340 | 482 | nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *); |
b128c09f | 483 | |
34dc7c2f BB |
484 | extern const char *zfs_prop_to_name(zfs_prop_t); |
485 | extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); | |
cae5b340 | 486 | extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); |
34dc7c2f BB |
487 | extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, |
488 | zprop_source_t *, char *, size_t, boolean_t); | |
428870ff BB |
489 | extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, |
490 | boolean_t); | |
34dc7c2f BB |
491 | extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, |
492 | zprop_source_t *, char *, size_t); | |
9babb374 BB |
493 | extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, |
494 | uint64_t *propvalue); | |
495 | extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, | |
496 | char *propbuf, int proplen, boolean_t literal); | |
330d06f9 MA |
497 | extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, |
498 | uint64_t *propvalue); | |
499 | extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, | |
500 | char *propbuf, int proplen, boolean_t literal); | |
9ae529ec CS |
501 | extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, |
502 | char *buf, size_t len); | |
2cf7f52b | 503 | extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **); |
34dc7c2f | 504 | extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); |
428870ff | 505 | extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); |
34dc7c2f BB |
506 | extern const char *zfs_prop_values(zfs_prop_t); |
507 | extern int zfs_prop_is_string(zfs_prop_t prop); | |
508 | extern nvlist_t *zfs_get_user_props(zfs_handle_t *); | |
428870ff | 509 | extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); |
330d06f9 | 510 | extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); |
34dc7c2f BB |
511 | |
512 | typedef struct zprop_list { | |
513 | int pl_prop; | |
514 | char *pl_user_prop; | |
515 | struct zprop_list *pl_next; | |
516 | boolean_t pl_all; | |
517 | size_t pl_width; | |
428870ff | 518 | size_t pl_recvd_width; |
34dc7c2f BB |
519 | boolean_t pl_fixed; |
520 | } zprop_list_t; | |
521 | ||
a08ee875 LG |
522 | extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, |
523 | boolean_t); | |
9babb374 | 524 | extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); |
34dc7c2f BB |
525 | |
526 | #define ZFS_MOUNTPOINT_NONE "none" | |
527 | #define ZFS_MOUNTPOINT_LEGACY "legacy" | |
528 | ||
9ae529ec CS |
529 | #define ZFS_FEATURE_DISABLED "disabled" |
530 | #define ZFS_FEATURE_ENABLED "enabled" | |
531 | #define ZFS_FEATURE_ACTIVE "active" | |
532 | ||
533 | #define ZFS_UNSUPPORTED_INACTIVE "inactive" | |
534 | #define ZFS_UNSUPPORTED_READONLY "readonly" | |
535 | ||
34dc7c2f BB |
536 | /* |
537 | * zpool property management | |
538 | */ | |
539 | extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); | |
9ae529ec CS |
540 | extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, |
541 | size_t); | |
34dc7c2f BB |
542 | extern const char *zpool_prop_default_string(zpool_prop_t); |
543 | extern uint64_t zpool_prop_default_numeric(zpool_prop_t); | |
544 | extern const char *zpool_prop_column_name(zpool_prop_t); | |
545 | extern boolean_t zpool_prop_align_right(zpool_prop_t); | |
546 | ||
547 | /* | |
548 | * Functions shared by zfs and zpool property management. | |
549 | */ | |
550 | extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, | |
551 | boolean_t ordered, zfs_type_t type); | |
552 | extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, | |
553 | zfs_type_t); | |
554 | extern void zprop_free_list(zprop_list_t *); | |
555 | ||
428870ff BB |
556 | #define ZFS_GET_NCOLS 5 |
557 | ||
558 | typedef enum { | |
559 | GET_COL_NONE, | |
560 | GET_COL_NAME, | |
561 | GET_COL_PROPERTY, | |
562 | GET_COL_VALUE, | |
563 | GET_COL_RECVD, | |
564 | GET_COL_SOURCE | |
565 | } zfs_get_column_t; | |
566 | ||
34dc7c2f BB |
567 | /* |
568 | * Functions for printing zfs or zpool properties | |
569 | */ | |
570 | typedef struct zprop_get_cbdata { | |
571 | int cb_sources; | |
428870ff BB |
572 | zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; |
573 | int cb_colwidths[ZFS_GET_NCOLS + 1]; | |
34dc7c2f BB |
574 | boolean_t cb_scripted; |
575 | boolean_t cb_literal; | |
576 | boolean_t cb_first; | |
577 | zprop_list_t *cb_proplist; | |
578 | zfs_type_t cb_type; | |
579 | } zprop_get_cbdata_t; | |
580 | ||
581 | void zprop_print_one_property(const char *, zprop_get_cbdata_t *, | |
428870ff BB |
582 | const char *, const char *, zprop_source_t, const char *, |
583 | const char *); | |
34dc7c2f BB |
584 | |
585 | /* | |
586 | * Iterator functions. | |
587 | */ | |
588 | typedef int (*zfs_iter_f)(zfs_handle_t *, void *); | |
589 | extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); | |
590 | extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); | |
591 | extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); | |
592 | extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); | |
0cee2406 | 593 | extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); |
428870ff | 594 | extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); |
330d06f9 | 595 | extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); |
ea04106b | 596 | extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); |
34dc7c2f | 597 | |
572e2857 BB |
598 | typedef struct get_all_cb { |
599 | zfs_handle_t **cb_handles; | |
600 | size_t cb_alloc; | |
601 | size_t cb_used; | |
602 | boolean_t cb_verbose; | |
603 | int (*cb_getone)(zfs_handle_t *, void *); | |
604 | } get_all_cb_t; | |
605 | ||
606 | void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); | |
607 | int libzfs_dataset_cmp(const void *, const void *); | |
608 | ||
34dc7c2f BB |
609 | /* |
610 | * Functions to create and destroy datasets. | |
611 | */ | |
612 | extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, | |
613 | nvlist_t *); | |
614 | extern int zfs_create_ancestors(libzfs_handle_t *, const char *); | |
45d1cae3 BB |
615 | extern int zfs_destroy(zfs_handle_t *, boolean_t); |
616 | extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); | |
a08ee875 | 617 | extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); |
34dc7c2f | 618 | extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); |
b128c09f | 619 | extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); |
a08ee875 LG |
620 | extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, |
621 | nvlist_t *props); | |
34dc7c2f | 622 | extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); |
db49968e | 623 | extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); |
428870ff BB |
624 | |
625 | typedef struct sendflags { | |
626 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 627 | boolean_t verbose; |
428870ff BB |
628 | |
629 | /* recursive send (ie, -R) */ | |
330d06f9 | 630 | boolean_t replicate; |
428870ff BB |
631 | |
632 | /* for incrementals, do all intermediate snapshots */ | |
330d06f9 | 633 | boolean_t doall; |
428870ff BB |
634 | |
635 | /* if dataset is a clone, do incremental from its origin */ | |
330d06f9 | 636 | boolean_t fromorigin; |
428870ff BB |
637 | |
638 | /* do deduplication */ | |
330d06f9 | 639 | boolean_t dedup; |
428870ff BB |
640 | |
641 | /* send properties (ie, -p) */ | |
330d06f9 MA |
642 | boolean_t props; |
643 | ||
644 | /* do not send (no-op, ie. -n) */ | |
645 | boolean_t dryrun; | |
646 | ||
647 | /* parsable verbose output (ie. -P) */ | |
648 | boolean_t parsable; | |
37abac6d BP |
649 | |
650 | /* show progress (ie. -v) */ | |
651 | boolean_t progress; | |
ea04106b | 652 | |
e10b0808 AX |
653 | /* large blocks (>128K) are permitted */ |
654 | boolean_t largeblock; | |
655 | ||
ea04106b AX |
656 | /* WRITE_EMBEDDED records of type DATA are permitted */ |
657 | boolean_t embed_data; | |
cae5b340 AX |
658 | |
659 | /* compressed WRITE records are permitted */ | |
660 | boolean_t compress; | |
428870ff BB |
661 | } sendflags_t; |
662 | ||
663 | typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); | |
664 | ||
330d06f9 MA |
665 | extern int zfs_send(zfs_handle_t *, const char *, const char *, |
666 | sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); | |
ea04106b | 667 | extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); |
cae5b340 AX |
668 | extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, |
669 | const char *); | |
670 | extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, | |
671 | const char *token); | |
428870ff | 672 | |
34dc7c2f | 673 | extern int zfs_promote(zfs_handle_t *); |
a08ee875 LG |
674 | extern int zfs_hold(zfs_handle_t *, const char *, const char *, |
675 | boolean_t, int); | |
676 | extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); | |
45d1cae3 | 677 | extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); |
0b7936d5 | 678 | extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); |
428870ff | 679 | extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); |
34dc7c2f | 680 | |
9babb374 BB |
681 | typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, |
682 | uid_t rid, uint64_t space); | |
683 | ||
0b7936d5 AS |
684 | extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, |
685 | zfs_userspace_cb_t, void *); | |
686 | ||
687 | extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); | |
688 | extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); | |
9babb374 | 689 | |
34dc7c2f BB |
690 | typedef struct recvflags { |
691 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 692 | boolean_t verbose; |
34dc7c2f BB |
693 | |
694 | /* the destination is a prefix, not the exact fs (ie, -d) */ | |
330d06f9 | 695 | boolean_t isprefix; |
34dc7c2f | 696 | |
428870ff BB |
697 | /* |
698 | * Only the tail of the sent snapshot path is appended to the | |
699 | * destination to determine the received snapshot name (ie, -e). | |
700 | */ | |
330d06f9 | 701 | boolean_t istail; |
428870ff | 702 | |
34dc7c2f | 703 | /* do not actually do the recv, just check if it would work (ie, -n) */ |
330d06f9 | 704 | boolean_t dryrun; |
34dc7c2f BB |
705 | |
706 | /* rollback/destroy filesystems as necessary (eg, -F) */ | |
330d06f9 | 707 | boolean_t force; |
34dc7c2f BB |
708 | |
709 | /* set "canmount=off" on all modified filesystems */ | |
330d06f9 | 710 | boolean_t canmountoff; |
34dc7c2f | 711 | |
cae5b340 AX |
712 | /* |
713 | * Mark the file systems as "resumable" and do not destroy them if the | |
714 | * receive is interrupted | |
715 | */ | |
716 | boolean_t resumable; | |
717 | ||
34dc7c2f | 718 | /* byteswap flag is used internally; callers need not specify */ |
330d06f9 | 719 | boolean_t byteswap; |
d164b209 BB |
720 | |
721 | /* do not mount file systems as they are extracted (private) */ | |
330d06f9 | 722 | boolean_t nomount; |
34dc7c2f BB |
723 | } recvflags_t; |
724 | ||
cae5b340 AX |
725 | extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, |
726 | recvflags_t *, int, avl_tree_t *); | |
34dc7c2f | 727 | |
572e2857 BB |
728 | typedef enum diff_flags { |
729 | ZFS_DIFF_PARSEABLE = 0x1, | |
730 | ZFS_DIFF_TIMESTAMP = 0x2, | |
731 | ZFS_DIFF_CLASSIFY = 0x4 | |
732 | } diff_flags_t; | |
733 | ||
734 | extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, | |
735 | int); | |
736 | ||
34dc7c2f BB |
737 | /* |
738 | * Miscellaneous functions. | |
739 | */ | |
740 | extern const char *zfs_type_to_name(zfs_type_t); | |
741 | extern void zfs_refresh_properties(zfs_handle_t *); | |
742 | extern int zfs_name_valid(const char *, zfs_type_t); | |
743 | extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); | |
744 | extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, | |
745 | zfs_type_t); | |
746 | extern int zfs_spa_version(zfs_handle_t *, int *); | |
ea04106b | 747 | extern boolean_t zfs_bookmark_exists(const char *path); |
eac47204 | 748 | extern int zfs_append_partition(char *path, size_t max_len); |
79e7242a | 749 | extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen); |
eac47204 | 750 | extern int zfs_strcmp_pathname(char *name, char *cmp_name, int wholedisk); |
cae5b340 | 751 | extern int zfs_path_order(char *path, int *order); |
34dc7c2f | 752 | |
34dc7c2f BB |
753 | /* |
754 | * Mount support functions. | |
755 | */ | |
756 | extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); | |
757 | extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); | |
758 | extern int zfs_mount(zfs_handle_t *, const char *, int); | |
759 | extern int zfs_unmount(zfs_handle_t *, const char *, int); | |
760 | extern int zfs_unmountall(zfs_handle_t *, int); | |
761 | ||
762 | /* | |
763 | * Share support functions. | |
764 | */ | |
765 | extern boolean_t zfs_is_shared(zfs_handle_t *); | |
766 | extern int zfs_share(zfs_handle_t *); | |
767 | extern int zfs_unshare(zfs_handle_t *); | |
768 | ||
769 | /* | |
770 | * Protocol-specific share support functions. | |
771 | */ | |
772 | extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); | |
773 | extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); | |
774 | extern int zfs_share_nfs(zfs_handle_t *); | |
775 | extern int zfs_share_smb(zfs_handle_t *); | |
776 | extern int zfs_shareall(zfs_handle_t *); | |
777 | extern int zfs_unshare_nfs(zfs_handle_t *, const char *); | |
778 | extern int zfs_unshare_smb(zfs_handle_t *, const char *); | |
779 | extern int zfs_unshareall_nfs(zfs_handle_t *); | |
780 | extern int zfs_unshareall_smb(zfs_handle_t *); | |
781 | extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); | |
cae5b340 | 782 | extern int zfs_unshareall_bytype(zfs_handle_t *, const char *, const char *); |
34dc7c2f | 783 | extern int zfs_unshareall(zfs_handle_t *); |
9babb374 | 784 | extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, |
34dc7c2f BB |
785 | void *, void *, int, zfs_share_op_t); |
786 | ||
cae5b340 AX |
787 | /* |
788 | * Formats for iostat numbers. Examples: "12K", "30ms", "4B", "2321234", "-". | |
789 | * | |
790 | * ZFS_NICENUM_1024: Print kilo, mega, tera, peta, exa.. | |
791 | * ZFS_NICENUM_BYTES: Print single bytes ("13B"), kilo, mega, tera... | |
792 | * ZFS_NICENUM_TIME: Print nanosecs, microsecs, millisecs, seconds... | |
793 | * ZFS_NICENUM_RAW: Print the raw number without any formatting | |
794 | * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero. | |
795 | */ | |
796 | enum zfs_nicenum_format { | |
797 | ZFS_NICENUM_1024 = 0, | |
798 | ZFS_NICENUM_BYTES = 1, | |
799 | ZFS_NICENUM_TIME = 2, | |
800 | ZFS_NICENUM_RAW = 3, | |
801 | ZFS_NICENUM_RAWTIME = 4 | |
802 | }; | |
803 | ||
34dc7c2f BB |
804 | /* |
805 | * Utility function to convert a number to a human-readable form. | |
806 | */ | |
807 | extern void zfs_nicenum(uint64_t, char *, size_t); | |
cae5b340 AX |
808 | extern void zfs_nicenum_format(uint64_t num, char *buf, size_t buflen, |
809 | enum zfs_nicenum_format type); | |
810 | ||
811 | ||
812 | extern void zfs_nicetime(uint64_t, char *, size_t); | |
813 | extern void zfs_nicebytes(uint64_t, char *, size_t); | |
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 | |
cae5b340 | 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); | |
cae5b340 AX |
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 | |
34dc7c2f BB |
833 | /* |
834 | * Given a device or file, determine if it is part of a pool. | |
835 | */ | |
836 | extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, | |
837 | boolean_t *); | |
838 | ||
839 | /* | |
428870ff | 840 | * Label manipulation. |
34dc7c2f | 841 | */ |
ea04106b | 842 | extern int zpool_read_label(int, nvlist_t **, int *); |
428870ff | 843 | extern int zpool_clear_label(int); |
34dc7c2f | 844 | |
9babb374 BB |
845 | /* |
846 | * Management interfaces for SMB ACL files | |
847 | */ | |
848 | ||
849 | int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); | |
850 | int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); | |
851 | int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); | |
852 | int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); | |
853 | ||
34dc7c2f BB |
854 | /* |
855 | * Enable and disable datasets within a pool by mounting/unmounting and | |
856 | * sharing/unsharing them. | |
857 | */ | |
858 | extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); | |
859 | extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); | |
860 | ||
428870ff BB |
861 | /* |
862 | * Mappings between vdev and FRU. | |
863 | */ | |
864 | extern void libzfs_fru_refresh(libzfs_handle_t *); | |
865 | extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); | |
866 | extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); | |
867 | extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, | |
868 | const char *); | |
869 | extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); | |
870 | extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); | |
871 | ||
cae5b340 AX |
872 | /* |
873 | * Support for Linux libudev derived persistent device strings | |
874 | */ | |
875 | extern boolean_t is_mpath_whole_disk(const char *); | |
876 | extern void update_vdev_config_dev_strs(nvlist_t *); | |
877 | extern char *zfs_strip_partition(char *); | |
878 | extern char *zfs_strip_partition_path(char *); | |
879 | ||
880 | #ifdef HAVE_LIBUDEV | |
881 | struct udev_device; | |
882 | ||
883 | extern boolean_t udev_is_mpath(struct udev_device *dev); | |
884 | extern int zfs_device_get_devid(struct udev_device *, char *, size_t); | |
885 | extern int zfs_device_get_physical(struct udev_device *, char *, size_t); | |
886 | #endif | |
887 | ||
34dc7c2f BB |
888 | #ifdef __cplusplus |
889 | } | |
890 | #endif | |
891 | ||
892 | #endif /* _LIBZFS_H */ |