]>
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 BB |
298 | |
299 | /* | |
300 | * Functions to manage pool properties | |
301 | */ | |
302 | extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); | |
303 | extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, | |
a08ee875 | 304 | size_t proplen, zprop_source_t *, boolean_t literal); |
34dc7c2f BB |
305 | extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, |
306 | zprop_source_t *); | |
307 | ||
308 | extern const char *zpool_prop_to_name(zpool_prop_t); | |
309 | extern const char *zpool_prop_values(zpool_prop_t); | |
310 | ||
311 | /* | |
312 | * Pool health statistics. | |
313 | */ | |
314 | typedef enum { | |
315 | /* | |
316 | * The following correspond to faults as defined in the (fault.fs.zfs.*) | |
317 | * event namespace. Each is associated with a corresponding message ID. | |
318 | */ | |
319 | ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ | |
320 | ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ | |
321 | ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ | |
322 | ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ | |
323 | ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ | |
324 | ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ | |
325 | ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ | |
326 | ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ | |
327 | ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ | |
328 | ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ | |
329 | ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ | |
cae5b340 AX |
330 | ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ |
331 | ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ | |
b128c09f BB |
332 | ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ |
333 | ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ | |
42f7b73b | 334 | ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ |
d164b209 | 335 | ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ |
ea04106b | 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 */ |
cae5b340 | 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 | ||
ea04106b AX |
372 | extern unsigned long get_system_hostid(void); |
373 | extern zpool_status_t zpool_get_status(zpool_handle_t *, char **, | |
374 | zpool_errata_t *); | |
375 | extern zpool_status_t zpool_import_status(nvlist_t *, char **, | |
376 | zpool_errata_t *); | |
428870ff | 377 | extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); |
34dc7c2f BB |
378 | |
379 | /* | |
380 | * Statistics and configuration functions. | |
381 | */ | |
382 | extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); | |
9ae529ec | 383 | extern nvlist_t *zpool_get_features(zpool_handle_t *); |
34dc7c2f BB |
384 | extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); |
385 | extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); | |
386 | ||
387 | /* | |
388 | * Import and export functions | |
389 | */ | |
a08ee875 LG |
390 | extern int zpool_export(zpool_handle_t *, boolean_t, const char *); |
391 | extern int zpool_export_force(zpool_handle_t *, const char *); | |
34dc7c2f BB |
392 | extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, |
393 | char *altroot); | |
394 | extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, | |
572e2857 | 395 | nvlist_t *, int); |
9ae529ec | 396 | extern void zpool_print_unsup_feat(nvlist_t *config); |
34dc7c2f BB |
397 | |
398 | /* | |
399 | * Search for pools to import | |
400 | */ | |
428870ff BB |
401 | |
402 | typedef struct importargs { | |
403 | char **path; /* a list of paths to search */ | |
404 | int paths; /* number of paths to search */ | |
405 | char *poolname; /* name of a pool to find */ | |
406 | uint64_t guid; /* guid of a pool to find */ | |
407 | char *cachefile; /* cachefile to use for import */ | |
408 | int can_be_active : 1; /* can the pool be active? */ | |
409 | int unique : 1; /* does 'poolname' already exist? */ | |
410 | int exists : 1; /* set on return if pool already exists */ | |
cae5b340 | 411 | int scan : 1; /* prefer scanning to libblkid cache */ |
428870ff BB |
412 | } importargs_t; |
413 | ||
414 | extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); | |
cae5b340 AX |
415 | extern int zpool_tryimport(libzfs_handle_t *hdl, char *target, |
416 | nvlist_t **configp, importargs_t *args); | |
428870ff BB |
417 | |
418 | /* legacy pool search routines */ | |
b128c09f | 419 | extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); |
34dc7c2f | 420 | extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, |
b128c09f | 421 | char *, uint64_t); |
34dc7c2f BB |
422 | |
423 | /* | |
424 | * Miscellaneous pool functions | |
425 | */ | |
426 | struct zfs_cmd; | |
427 | ||
a08ee875 | 428 | extern const char *zfs_history_event_names[]; |
428870ff | 429 | |
4e820b5a AX |
430 | typedef enum { |
431 | VDEV_NAME_PATH = 1 << 0, | |
432 | VDEV_NAME_GUID = 1 << 1, | |
433 | VDEV_NAME_FOLLOW_LINKS = 1 << 2, | |
434 | VDEV_NAME_TYPE_ID = 1 << 3, | |
435 | } vdev_name_t; | |
436 | ||
428870ff | 437 | extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, |
4e820b5a | 438 | int name_flags); |
34dc7c2f BB |
439 | extern int zpool_upgrade(zpool_handle_t *, uint64_t); |
440 | extern int zpool_get_history(zpool_handle_t *, nvlist_t **); | |
428870ff BB |
441 | extern int zpool_history_unpack(char *, uint64_t, uint64_t *, |
442 | nvlist_t ***, uint_t *); | |
ea04106b AX |
443 | extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, |
444 | int); | |
26685276 | 445 | extern int zpool_events_clear(libzfs_handle_t *, int *); |
ea04106b | 446 | extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int); |
34dc7c2f BB |
447 | extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, |
448 | size_t len); | |
449 | extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); | |
9babb374 | 450 | extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); |
428870ff BB |
451 | extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, |
452 | nvlist_t *); | |
9babb374 | 453 | |
34dc7c2f BB |
454 | /* |
455 | * Basic handle manipulations. These functions do not create or destroy the | |
456 | * underlying datasets, only the references to them. | |
457 | */ | |
458 | extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); | |
330d06f9 | 459 | extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); |
34dc7c2f BB |
460 | extern void zfs_close(zfs_handle_t *); |
461 | extern zfs_type_t zfs_get_type(const zfs_handle_t *); | |
462 | extern const char *zfs_get_name(const zfs_handle_t *); | |
b128c09f | 463 | extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); |
cae5b340 | 464 | extern const char *zfs_get_pool_name(const zfs_handle_t *); |
34dc7c2f BB |
465 | |
466 | /* | |
467 | * Property management functions. Some functions are shared with the kernel, | |
468 | * and are found in sys/fs/zfs.h. | |
469 | */ | |
470 | ||
471 | /* | |
472 | * zfs dataset property management | |
473 | */ | |
474 | extern const char *zfs_prop_default_string(zfs_prop_t); | |
475 | extern uint64_t zfs_prop_default_numeric(zfs_prop_t); | |
476 | extern const char *zfs_prop_column_name(zfs_prop_t); | |
477 | extern boolean_t zfs_prop_align_right(zfs_prop_t); | |
478 | ||
b128c09f | 479 | extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, |
cae5b340 | 480 | nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *); |
b128c09f | 481 | |
34dc7c2f BB |
482 | extern const char *zfs_prop_to_name(zfs_prop_t); |
483 | extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); | |
cae5b340 | 484 | extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); |
34dc7c2f BB |
485 | extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, |
486 | zprop_source_t *, char *, size_t, boolean_t); | |
428870ff BB |
487 | extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, |
488 | boolean_t); | |
34dc7c2f BB |
489 | extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, |
490 | zprop_source_t *, char *, size_t); | |
9babb374 BB |
491 | extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, |
492 | uint64_t *propvalue); | |
493 | extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, | |
494 | char *propbuf, int proplen, boolean_t literal); | |
330d06f9 MA |
495 | extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, |
496 | uint64_t *propvalue); | |
497 | extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, | |
498 | char *propbuf, int proplen, boolean_t literal); | |
9ae529ec CS |
499 | extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, |
500 | char *buf, size_t len); | |
2cf7f52b | 501 | extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **); |
34dc7c2f | 502 | extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); |
428870ff | 503 | extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); |
34dc7c2f BB |
504 | extern const char *zfs_prop_values(zfs_prop_t); |
505 | extern int zfs_prop_is_string(zfs_prop_t prop); | |
506 | extern nvlist_t *zfs_get_user_props(zfs_handle_t *); | |
428870ff | 507 | extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); |
330d06f9 | 508 | extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); |
34dc7c2f BB |
509 | |
510 | typedef struct zprop_list { | |
511 | int pl_prop; | |
512 | char *pl_user_prop; | |
513 | struct zprop_list *pl_next; | |
514 | boolean_t pl_all; | |
515 | size_t pl_width; | |
428870ff | 516 | size_t pl_recvd_width; |
34dc7c2f BB |
517 | boolean_t pl_fixed; |
518 | } zprop_list_t; | |
519 | ||
a08ee875 LG |
520 | extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, |
521 | boolean_t); | |
9babb374 | 522 | extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); |
34dc7c2f BB |
523 | |
524 | #define ZFS_MOUNTPOINT_NONE "none" | |
525 | #define ZFS_MOUNTPOINT_LEGACY "legacy" | |
526 | ||
9ae529ec CS |
527 | #define ZFS_FEATURE_DISABLED "disabled" |
528 | #define ZFS_FEATURE_ENABLED "enabled" | |
529 | #define ZFS_FEATURE_ACTIVE "active" | |
530 | ||
531 | #define ZFS_UNSUPPORTED_INACTIVE "inactive" | |
532 | #define ZFS_UNSUPPORTED_READONLY "readonly" | |
533 | ||
34dc7c2f BB |
534 | /* |
535 | * zpool property management | |
536 | */ | |
537 | extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); | |
9ae529ec CS |
538 | extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, |
539 | size_t); | |
34dc7c2f BB |
540 | extern const char *zpool_prop_default_string(zpool_prop_t); |
541 | extern uint64_t zpool_prop_default_numeric(zpool_prop_t); | |
542 | extern const char *zpool_prop_column_name(zpool_prop_t); | |
543 | extern boolean_t zpool_prop_align_right(zpool_prop_t); | |
544 | ||
545 | /* | |
546 | * Functions shared by zfs and zpool property management. | |
547 | */ | |
548 | extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, | |
549 | boolean_t ordered, zfs_type_t type); | |
550 | extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, | |
551 | zfs_type_t); | |
552 | extern void zprop_free_list(zprop_list_t *); | |
553 | ||
428870ff BB |
554 | #define ZFS_GET_NCOLS 5 |
555 | ||
556 | typedef enum { | |
557 | GET_COL_NONE, | |
558 | GET_COL_NAME, | |
559 | GET_COL_PROPERTY, | |
560 | GET_COL_VALUE, | |
561 | GET_COL_RECVD, | |
562 | GET_COL_SOURCE | |
563 | } zfs_get_column_t; | |
564 | ||
34dc7c2f BB |
565 | /* |
566 | * Functions for printing zfs or zpool properties | |
567 | */ | |
568 | typedef struct zprop_get_cbdata { | |
569 | int cb_sources; | |
428870ff BB |
570 | zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; |
571 | int cb_colwidths[ZFS_GET_NCOLS + 1]; | |
34dc7c2f BB |
572 | boolean_t cb_scripted; |
573 | boolean_t cb_literal; | |
574 | boolean_t cb_first; | |
575 | zprop_list_t *cb_proplist; | |
576 | zfs_type_t cb_type; | |
577 | } zprop_get_cbdata_t; | |
578 | ||
579 | void zprop_print_one_property(const char *, zprop_get_cbdata_t *, | |
428870ff BB |
580 | const char *, const char *, zprop_source_t, const char *, |
581 | const char *); | |
34dc7c2f BB |
582 | |
583 | /* | |
584 | * Iterator functions. | |
585 | */ | |
586 | typedef int (*zfs_iter_f)(zfs_handle_t *, void *); | |
587 | extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); | |
588 | extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); | |
589 | extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); | |
590 | extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); | |
0cee2406 | 591 | extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); |
428870ff | 592 | extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); |
330d06f9 | 593 | extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); |
ea04106b | 594 | extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); |
34dc7c2f | 595 | |
572e2857 BB |
596 | typedef struct get_all_cb { |
597 | zfs_handle_t **cb_handles; | |
598 | size_t cb_alloc; | |
599 | size_t cb_used; | |
600 | boolean_t cb_verbose; | |
601 | int (*cb_getone)(zfs_handle_t *, void *); | |
602 | } get_all_cb_t; | |
603 | ||
604 | void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); | |
605 | int libzfs_dataset_cmp(const void *, const void *); | |
606 | ||
34dc7c2f BB |
607 | /* |
608 | * Functions to create and destroy datasets. | |
609 | */ | |
610 | extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, | |
611 | nvlist_t *); | |
612 | extern int zfs_create_ancestors(libzfs_handle_t *, const char *); | |
45d1cae3 BB |
613 | extern int zfs_destroy(zfs_handle_t *, boolean_t); |
614 | extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); | |
a08ee875 | 615 | extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); |
34dc7c2f | 616 | extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); |
b128c09f | 617 | extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); |
a08ee875 LG |
618 | extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, |
619 | nvlist_t *props); | |
34dc7c2f | 620 | extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); |
db49968e | 621 | extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); |
428870ff BB |
622 | |
623 | typedef struct sendflags { | |
624 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 625 | boolean_t verbose; |
428870ff BB |
626 | |
627 | /* recursive send (ie, -R) */ | |
330d06f9 | 628 | boolean_t replicate; |
428870ff BB |
629 | |
630 | /* for incrementals, do all intermediate snapshots */ | |
330d06f9 | 631 | boolean_t doall; |
428870ff BB |
632 | |
633 | /* if dataset is a clone, do incremental from its origin */ | |
330d06f9 | 634 | boolean_t fromorigin; |
428870ff BB |
635 | |
636 | /* do deduplication */ | |
330d06f9 | 637 | boolean_t dedup; |
428870ff BB |
638 | |
639 | /* send properties (ie, -p) */ | |
330d06f9 MA |
640 | boolean_t props; |
641 | ||
642 | /* do not send (no-op, ie. -n) */ | |
643 | boolean_t dryrun; | |
644 | ||
645 | /* parsable verbose output (ie. -P) */ | |
646 | boolean_t parsable; | |
37abac6d BP |
647 | |
648 | /* show progress (ie. -v) */ | |
649 | boolean_t progress; | |
ea04106b | 650 | |
e10b0808 AX |
651 | /* large blocks (>128K) are permitted */ |
652 | boolean_t largeblock; | |
653 | ||
ea04106b AX |
654 | /* WRITE_EMBEDDED records of type DATA are permitted */ |
655 | boolean_t embed_data; | |
cae5b340 AX |
656 | |
657 | /* compressed WRITE records are permitted */ | |
658 | boolean_t compress; | |
428870ff BB |
659 | } sendflags_t; |
660 | ||
661 | typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); | |
662 | ||
330d06f9 MA |
663 | extern int zfs_send(zfs_handle_t *, const char *, const char *, |
664 | sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); | |
ea04106b | 665 | extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); |
cae5b340 AX |
666 | extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, |
667 | const char *); | |
668 | extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, | |
669 | const char *token); | |
428870ff | 670 | |
34dc7c2f | 671 | extern int zfs_promote(zfs_handle_t *); |
a08ee875 LG |
672 | extern int zfs_hold(zfs_handle_t *, const char *, const char *, |
673 | boolean_t, int); | |
674 | extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); | |
45d1cae3 | 675 | extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); |
0b7936d5 | 676 | extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); |
428870ff | 677 | extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); |
34dc7c2f | 678 | |
9babb374 BB |
679 | typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, |
680 | uid_t rid, uint64_t space); | |
681 | ||
0b7936d5 AS |
682 | extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, |
683 | zfs_userspace_cb_t, void *); | |
684 | ||
685 | extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); | |
686 | extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); | |
9babb374 | 687 | |
34dc7c2f BB |
688 | typedef struct recvflags { |
689 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 690 | boolean_t verbose; |
34dc7c2f BB |
691 | |
692 | /* the destination is a prefix, not the exact fs (ie, -d) */ | |
330d06f9 | 693 | boolean_t isprefix; |
34dc7c2f | 694 | |
428870ff BB |
695 | /* |
696 | * Only the tail of the sent snapshot path is appended to the | |
697 | * destination to determine the received snapshot name (ie, -e). | |
698 | */ | |
330d06f9 | 699 | boolean_t istail; |
428870ff | 700 | |
34dc7c2f | 701 | /* do not actually do the recv, just check if it would work (ie, -n) */ |
330d06f9 | 702 | boolean_t dryrun; |
34dc7c2f BB |
703 | |
704 | /* rollback/destroy filesystems as necessary (eg, -F) */ | |
330d06f9 | 705 | boolean_t force; |
34dc7c2f BB |
706 | |
707 | /* set "canmount=off" on all modified filesystems */ | |
330d06f9 | 708 | boolean_t canmountoff; |
34dc7c2f | 709 | |
cae5b340 AX |
710 | /* |
711 | * Mark the file systems as "resumable" and do not destroy them if the | |
712 | * receive is interrupted | |
713 | */ | |
714 | boolean_t resumable; | |
715 | ||
34dc7c2f | 716 | /* byteswap flag is used internally; callers need not specify */ |
330d06f9 | 717 | boolean_t byteswap; |
d164b209 BB |
718 | |
719 | /* do not mount file systems as they are extracted (private) */ | |
330d06f9 | 720 | boolean_t nomount; |
34dc7c2f BB |
721 | } recvflags_t; |
722 | ||
cae5b340 AX |
723 | extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, |
724 | recvflags_t *, int, avl_tree_t *); | |
34dc7c2f | 725 | |
572e2857 BB |
726 | typedef enum diff_flags { |
727 | ZFS_DIFF_PARSEABLE = 0x1, | |
728 | ZFS_DIFF_TIMESTAMP = 0x2, | |
729 | ZFS_DIFF_CLASSIFY = 0x4 | |
730 | } diff_flags_t; | |
731 | ||
732 | extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, | |
733 | int); | |
734 | ||
34dc7c2f BB |
735 | /* |
736 | * Miscellaneous functions. | |
737 | */ | |
738 | extern const char *zfs_type_to_name(zfs_type_t); | |
739 | extern void zfs_refresh_properties(zfs_handle_t *); | |
740 | extern int zfs_name_valid(const char *, zfs_type_t); | |
741 | extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); | |
742 | extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, | |
743 | zfs_type_t); | |
744 | extern int zfs_spa_version(zfs_handle_t *, int *); | |
ea04106b | 745 | extern boolean_t zfs_bookmark_exists(const char *path); |
eac47204 | 746 | extern int zfs_append_partition(char *path, size_t max_len); |
79e7242a | 747 | extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen); |
eac47204 | 748 | extern int zfs_strcmp_pathname(char *name, char *cmp_name, int wholedisk); |
cae5b340 | 749 | extern int zfs_path_order(char *path, int *order); |
34dc7c2f | 750 | |
34dc7c2f BB |
751 | /* |
752 | * Mount support functions. | |
753 | */ | |
754 | extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); | |
755 | extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); | |
756 | extern int zfs_mount(zfs_handle_t *, const char *, int); | |
757 | extern int zfs_unmount(zfs_handle_t *, const char *, int); | |
758 | extern int zfs_unmountall(zfs_handle_t *, int); | |
759 | ||
760 | /* | |
761 | * Share support functions. | |
762 | */ | |
763 | extern boolean_t zfs_is_shared(zfs_handle_t *); | |
764 | extern int zfs_share(zfs_handle_t *); | |
765 | extern int zfs_unshare(zfs_handle_t *); | |
766 | ||
767 | /* | |
768 | * Protocol-specific share support functions. | |
769 | */ | |
770 | extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); | |
771 | extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); | |
772 | extern int zfs_share_nfs(zfs_handle_t *); | |
773 | extern int zfs_share_smb(zfs_handle_t *); | |
774 | extern int zfs_shareall(zfs_handle_t *); | |
775 | extern int zfs_unshare_nfs(zfs_handle_t *, const char *); | |
776 | extern int zfs_unshare_smb(zfs_handle_t *, const char *); | |
777 | extern int zfs_unshareall_nfs(zfs_handle_t *); | |
778 | extern int zfs_unshareall_smb(zfs_handle_t *); | |
779 | extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); | |
cae5b340 | 780 | extern int zfs_unshareall_bytype(zfs_handle_t *, const char *, const char *); |
34dc7c2f | 781 | extern int zfs_unshareall(zfs_handle_t *); |
9babb374 | 782 | extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, |
34dc7c2f BB |
783 | void *, void *, int, zfs_share_op_t); |
784 | ||
cae5b340 AX |
785 | /* |
786 | * Formats for iostat numbers. Examples: "12K", "30ms", "4B", "2321234", "-". | |
787 | * | |
788 | * ZFS_NICENUM_1024: Print kilo, mega, tera, peta, exa.. | |
789 | * ZFS_NICENUM_BYTES: Print single bytes ("13B"), kilo, mega, tera... | |
790 | * ZFS_NICENUM_TIME: Print nanosecs, microsecs, millisecs, seconds... | |
791 | * ZFS_NICENUM_RAW: Print the raw number without any formatting | |
792 | * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero. | |
793 | */ | |
794 | enum zfs_nicenum_format { | |
795 | ZFS_NICENUM_1024 = 0, | |
796 | ZFS_NICENUM_BYTES = 1, | |
797 | ZFS_NICENUM_TIME = 2, | |
798 | ZFS_NICENUM_RAW = 3, | |
799 | ZFS_NICENUM_RAWTIME = 4 | |
800 | }; | |
801 | ||
34dc7c2f BB |
802 | /* |
803 | * Utility function to convert a number to a human-readable form. | |
804 | */ | |
805 | extern void zfs_nicenum(uint64_t, char *, size_t); | |
cae5b340 AX |
806 | extern void zfs_nicenum_format(uint64_t num, char *buf, size_t buflen, |
807 | enum zfs_nicenum_format type); | |
808 | ||
809 | ||
810 | extern void zfs_nicetime(uint64_t, char *, size_t); | |
811 | extern void zfs_nicebytes(uint64_t, char *, size_t); | |
34dc7c2f BB |
812 | extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); |
813 | ||
feb46b92 BB |
814 | /* |
815 | * Utility functions to run an external process. | |
816 | */ | |
9ac97c2a BB |
817 | #define STDOUT_VERBOSE 0x01 |
818 | #define STDERR_VERBOSE 0x02 | |
cae5b340 | 819 | #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ |
9ac97c2a BB |
820 | |
821 | int libzfs_run_process(const char *, char **, int flags); | |
cae5b340 AX |
822 | int libzfs_run_process_get_stdout(const char *path, char *argv[], char *env[], |
823 | char **lines[], int *lines_cnt); | |
824 | int libzfs_run_process_get_stdout_nopath(const char *path, char *argv[], | |
825 | char *env[], char **lines[], int *lines_cnt); | |
826 | ||
827 | void libzfs_free_str_array(char **strs, int count); | |
828 | ||
829 | int libzfs_envvar_is_set(char *envvar); | |
feb46b92 | 830 | |
34dc7c2f BB |
831 | /* |
832 | * Given a device or file, determine if it is part of a pool. | |
833 | */ | |
834 | extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, | |
835 | boolean_t *); | |
836 | ||
837 | /* | |
428870ff | 838 | * Label manipulation. |
34dc7c2f | 839 | */ |
ea04106b | 840 | extern int zpool_read_label(int, nvlist_t **, int *); |
428870ff | 841 | extern int zpool_clear_label(int); |
34dc7c2f | 842 | |
9babb374 BB |
843 | /* |
844 | * Management interfaces for SMB ACL files | |
845 | */ | |
846 | ||
847 | int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); | |
848 | int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); | |
849 | int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); | |
850 | int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); | |
851 | ||
34dc7c2f BB |
852 | /* |
853 | * Enable and disable datasets within a pool by mounting/unmounting and | |
854 | * sharing/unsharing them. | |
855 | */ | |
856 | extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); | |
857 | extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); | |
858 | ||
428870ff BB |
859 | /* |
860 | * Mappings between vdev and FRU. | |
861 | */ | |
862 | extern void libzfs_fru_refresh(libzfs_handle_t *); | |
863 | extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); | |
864 | extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); | |
865 | extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, | |
866 | const char *); | |
867 | extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); | |
868 | extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); | |
869 | ||
cae5b340 AX |
870 | /* |
871 | * Support for Linux libudev derived persistent device strings | |
872 | */ | |
873 | extern boolean_t is_mpath_whole_disk(const char *); | |
874 | extern void update_vdev_config_dev_strs(nvlist_t *); | |
875 | extern char *zfs_strip_partition(char *); | |
876 | extern char *zfs_strip_partition_path(char *); | |
877 | ||
878 | #ifdef HAVE_LIBUDEV | |
879 | struct udev_device; | |
880 | ||
881 | extern boolean_t udev_is_mpath(struct udev_device *dev); | |
882 | extern int zfs_device_get_devid(struct udev_device *, char *, size_t); | |
883 | extern int zfs_device_get_physical(struct udev_device *, char *, size_t); | |
884 | #endif | |
885 | ||
34dc7c2f BB |
886 | #ifdef __cplusplus |
887 | } | |
888 | #endif | |
889 | ||
890 | #endif /* _LIBZFS_H */ |