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