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