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