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