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