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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011, 2018 by Delphix. All rights reserved.
25 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
26 * Copyright (c) 2013 Steven Hartland. All rights reserved.
27 * Copyright (c) 2016, Intel Corporation.
28 * Copyright 2016 Nexenta Systems, Inc.
29 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
30 * Copyright (c) 2018 Datto Inc.
37 #include <libnvpair.h>
38 #include <sys/mnttab.h>
39 #include <sys/param.h>
40 #include <sys/types.h>
41 #include <sys/varargs.h>
42 #include <sys/fs/zfs.h>
45 #include <libzfs_core.h>
52 * Miscellaneous ZFS constants
54 #define ZFS_MAXPROPLEN MAXPATHLEN
55 #define ZPOOL_MAXPROPLEN MAXPATHLEN
60 typedef enum zfs_error {
61 EZFS_SUCCESS = 0, /* no error -- success */
62 EZFS_NOMEM = 2000, /* out of memory */
63 EZFS_BADPROP, /* invalid property value */
64 EZFS_PROPREADONLY, /* cannot set readonly property */
65 EZFS_PROPTYPE, /* property does not apply to dataset type */
66 EZFS_PROPNONINHERIT, /* property is not inheritable */
67 EZFS_PROPSPACE, /* bad quota or reservation */
68 EZFS_BADTYPE, /* dataset is not of appropriate type */
69 EZFS_BUSY, /* pool or dataset is busy */
70 EZFS_EXISTS, /* pool or dataset already exists */
71 EZFS_NOENT, /* no such pool or dataset */
72 EZFS_BADSTREAM, /* bad backup stream */
73 EZFS_DSREADONLY, /* dataset is readonly */
74 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
75 EZFS_INVALIDNAME, /* invalid dataset name */
76 EZFS_BADRESTORE, /* unable to restore to destination */
77 EZFS_BADBACKUP, /* backup failed */
78 EZFS_BADTARGET, /* bad attach/detach/replace target */
79 EZFS_NODEVICE, /* no such device in pool */
80 EZFS_BADDEV, /* invalid device to add */
81 EZFS_NOREPLICAS, /* no valid replicas */
82 EZFS_RESILVERING, /* currently resilvering */
83 EZFS_BADVERSION, /* unsupported version */
84 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
85 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
86 EZFS_BADPATH, /* must be an absolute path */
87 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
88 EZFS_ZONED, /* used improperly in local zone */
89 EZFS_MOUNTFAILED, /* failed to mount dataset */
90 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
91 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
92 EZFS_SHARENFSFAILED, /* share(1M) failed */
93 EZFS_PERM, /* permission denied */
94 EZFS_NOSPC, /* out of space */
95 EZFS_FAULT, /* bad address */
96 EZFS_IO, /* I/O error */
97 EZFS_INTR, /* signal received */
98 EZFS_ISSPARE, /* device is a hot spare */
99 EZFS_INVALCONFIG, /* invalid vdev configuration */
100 EZFS_RECURSIVE, /* recursive dependency */
101 EZFS_NOHISTORY, /* no history object */
102 EZFS_POOLPROPS, /* couldn't retrieve pool props */
103 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
104 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
105 EZFS_NAMETOOLONG, /* dataset name is too long */
106 EZFS_OPENFAILED, /* open of device failed */
107 EZFS_NOCAP, /* couldn't get capacity */
108 EZFS_LABELFAILED, /* write of label failed */
109 EZFS_BADWHO, /* invalid permission who */
110 EZFS_BADPERM, /* invalid permission */
111 EZFS_BADPERMSET, /* invalid permission set name */
112 EZFS_NODELEGATION, /* delegated administration is disabled */
113 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
114 EZFS_SHARESMBFAILED, /* failed to share over smb */
115 EZFS_BADCACHE, /* bad cache file */
116 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
117 EZFS_VDEVNOTSUP, /* unsupported vdev type */
118 EZFS_NOTSUP, /* ops not supported on this dataset */
119 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
120 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
121 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
122 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
123 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
124 EZFS_PIPEFAILED, /* pipe create failed */
125 EZFS_THREADCREATEFAILED, /* thread create failed */
126 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
127 EZFS_SCRUBBING, /* currently scrubbing */
128 EZFS_NO_SCRUB, /* no active scrub */
129 EZFS_DIFF, /* general failure of zfs diff */
130 EZFS_DIFFDATA, /* bad zfs diff data */
131 EZFS_POOLREADONLY, /* pool is in read-only mode */
132 EZFS_SCRUB_PAUSED, /* scrub currently paused */
133 EZFS_ACTIVE_POOL, /* pool is imported on a different system */
134 EZFS_CRYPTOFAILED, /* failed to setup encryption */
135 EZFS_NO_PENDING, /* cannot cancel, no operation is pending */
136 EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */
137 EZFS_DISCARDING_CHECKPOINT, /* currently discarding a checkpoint */
138 EZFS_NO_CHECKPOINT, /* pool has no checkpoint */
139 EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */
140 EZFS_VDEV_TOO_BIG, /* a device is too big to be used */
141 EZFS_IOC_NOTSUPPORTED, /* operation not supported by zfs module */
146 * The following data structures are all part
147 * of the zfs_allow_t data structure which is
148 * used for printing 'allow' permissions.
149 * It is a linked list of zfs_allow_t's which
150 * then contain avl tree's for user/group/sets/...
151 * and each one of the entries in those trees have
152 * avl tree's for the permissions they belong to and
153 * whether they are local,descendent or local+descendent
154 * permissions. The AVL trees are used primarily for
155 * sorting purposes, but also so that we can quickly find
156 * a given user and or permission.
158 typedef struct zfs_perm_node {
160 char z_pname[MAXPATHLEN];
163 typedef struct zfs_allow_node {
165 char z_key[MAXPATHLEN]; /* name, such as joe */
166 avl_tree_t z_localdescend; /* local+descendent perms */
167 avl_tree_t z_local; /* local permissions */
168 avl_tree_t z_descend; /* descendent permissions */
171 typedef struct zfs_allow {
172 struct zfs_allow *z_next;
173 char z_setpoint[MAXPATHLEN];
175 avl_tree_t z_crperms;
178 avl_tree_t z_everyone;
184 typedef struct zfs_handle zfs_handle_t;
185 typedef struct zpool_handle zpool_handle_t;
186 typedef struct libzfs_handle libzfs_handle_t;
189 * Library initialization
191 extern libzfs_handle_t *libzfs_init(void);
192 extern void libzfs_fini(libzfs_handle_t *);
194 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
195 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
197 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
199 extern void zfs_save_arguments(int argc, char **, char *, int);
200 extern int zpool_log_history(libzfs_handle_t *, const char *);
202 extern int libzfs_errno(libzfs_handle_t *);
203 extern const char *libzfs_error_init(int);
204 extern const char *libzfs_error_action(libzfs_handle_t *);
205 extern const char *libzfs_error_description(libzfs_handle_t *);
206 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
207 extern void libzfs_mnttab_init(libzfs_handle_t *);
208 extern void libzfs_mnttab_fini(libzfs_handle_t *);
209 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
210 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
212 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
213 const char *, const char *);
214 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
217 * Basic handle functions
219 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
220 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
221 extern void zpool_close(zpool_handle_t *);
222 extern const char *zpool_get_name(zpool_handle_t *);
223 extern int zpool_get_state(zpool_handle_t *);
224 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
225 extern const char *zpool_pool_state_to_name(pool_state_t);
226 extern void zpool_free_handles(libzfs_handle_t *);
229 * Iterate over all active pools in the system.
231 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
232 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
233 extern boolean_t zpool_skip_pool(const char *);
236 * Functions to create and destroy pools
238 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
239 nvlist_t *, nvlist_t *);
240 extern int zpool_destroy(zpool_handle_t *, const char *);
241 extern int zpool_add(zpool_handle_t *, nvlist_t *);
243 typedef struct splitflags {
244 /* do not split, but return the config that would be split off */
247 /* after splitting, import the pool */
253 * Functions to manipulate pool and vdev state
255 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
256 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
257 extern int zpool_reguid(zpool_handle_t *);
258 extern int zpool_reopen_one(zpool_handle_t *, void *);
260 extern int zpool_sync_one(zpool_handle_t *, void *);
262 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
264 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
265 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
266 const char *, nvlist_t *, int);
267 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
268 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
269 extern int zpool_vdev_remove_cancel(zpool_handle_t *);
270 extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *);
271 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
274 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
275 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
276 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
278 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
279 boolean_t *, boolean_t *);
280 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
281 boolean_t *, boolean_t *, boolean_t *);
282 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
283 extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, const char *path);
285 const char *zpool_get_state_str(zpool_handle_t *);
288 * Functions to manage pool properties
290 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
291 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
292 size_t proplen, zprop_source_t *, boolean_t literal);
293 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
296 extern const char *zpool_prop_to_name(zpool_prop_t);
297 extern const char *zpool_prop_values(zpool_prop_t);
300 * Pool health statistics.
304 * The following correspond to faults as defined in the (fault.fs.zfs.*)
305 * event namespace. Each is associated with a corresponding message ID.
306 * This must be kept in sync with the zfs_msgid_table in
307 * lib/libzfs/libzfs_status.c.
309 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
310 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
311 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
312 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
313 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
314 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
315 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
316 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
317 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
318 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
319 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
320 ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */
321 ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */
322 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
323 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
324 ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */
325 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
326 ZPOOL_STATUS_ERRATA, /* informational errata available */
329 * If the pool has unsupported features but can still be opened in
330 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
331 * pool has unsupported features but cannot be opened at all, its
332 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
334 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
335 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
338 * These faults have no corresponding message ID. At the time we are
339 * checking the status, the original reason for the FMA fault (I/O or
340 * checksum errors) has been lost.
342 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
343 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
346 * The following are not faults per se, but still an error possibly
347 * requiring administrative attention. There is no corresponding
350 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
351 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
352 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
353 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */
354 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
357 * Finally, the following indicates a healthy pool.
362 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **,
364 extern zpool_status_t zpool_import_status(nvlist_t *, char **,
368 * Statistics and configuration functions.
370 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
371 extern nvlist_t *zpool_get_features(zpool_handle_t *);
372 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
373 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
376 * Import and export functions
378 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
379 extern int zpool_export_force(zpool_handle_t *, const char *);
380 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
382 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
384 extern void zpool_print_unsup_feat(nvlist_t *config);
387 * Miscellaneous pool functions
391 extern const char *zfs_history_event_names[];
394 VDEV_NAME_PATH = 1 << 0,
395 VDEV_NAME_GUID = 1 << 1,
396 VDEV_NAME_FOLLOW_LINKS = 1 << 2,
397 VDEV_NAME_TYPE_ID = 1 << 3,
400 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
402 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
403 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
404 extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned,
406 extern int zpool_events_clear(libzfs_handle_t *, int *);
407 extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int);
408 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
410 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
411 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
412 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
414 extern int zpool_checkpoint(zpool_handle_t *);
415 extern int zpool_discard_checkpoint(zpool_handle_t *);
418 * Basic handle manipulations. These functions do not create or destroy the
419 * underlying datasets, only the references to them.
421 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
422 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
423 extern void zfs_close(zfs_handle_t *);
424 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
425 extern const char *zfs_get_name(const zfs_handle_t *);
426 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
427 extern const char *zfs_get_pool_name(const zfs_handle_t *);
430 * Property management functions. Some functions are shared with the kernel,
431 * and are found in sys/fs/zfs.h.
435 * zfs dataset property management
437 extern const char *zfs_prop_default_string(zfs_prop_t);
438 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
439 extern const char *zfs_prop_column_name(zfs_prop_t);
440 extern boolean_t zfs_prop_align_right(zfs_prop_t);
442 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *,
443 uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *);
445 extern const char *zfs_prop_to_name(zfs_prop_t);
446 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
447 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
448 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
449 zprop_source_t *, char *, size_t, boolean_t);
450 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
452 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
453 zprop_source_t *, char *, size_t);
454 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
455 uint64_t *propvalue);
456 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
457 char *propbuf, int proplen, boolean_t literal);
458 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
459 uint64_t *propvalue);
460 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
461 char *propbuf, int proplen, boolean_t literal);
462 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
463 char *buf, size_t len);
464 extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **);
465 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
466 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
467 extern const char *zfs_prop_values(zfs_prop_t);
468 extern int zfs_prop_is_string(zfs_prop_t prop);
469 extern nvlist_t *zfs_get_all_props(zfs_handle_t *);
470 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
471 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
472 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
475 * zfs encryption management
477 extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *);
478 extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *,
479 boolean_t stdin_available, uint8_t **, uint_t *);
480 extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *,
482 extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *);
483 extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *);
484 extern int zfs_crypto_unload_key(zfs_handle_t *);
485 extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t);
487 typedef struct zprop_list {
490 struct zprop_list *pl_next;
493 size_t pl_recvd_width;
497 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
499 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
501 #define ZFS_MOUNTPOINT_NONE "none"
502 #define ZFS_MOUNTPOINT_LEGACY "legacy"
504 #define ZFS_FEATURE_DISABLED "disabled"
505 #define ZFS_FEATURE_ENABLED "enabled"
506 #define ZFS_FEATURE_ACTIVE "active"
508 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
509 #define ZFS_UNSUPPORTED_READONLY "readonly"
512 * zpool property management
514 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
515 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
517 extern const char *zpool_prop_default_string(zpool_prop_t);
518 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
519 extern const char *zpool_prop_column_name(zpool_prop_t);
520 extern boolean_t zpool_prop_align_right(zpool_prop_t);
523 * Functions shared by zfs and zpool property management.
525 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
526 boolean_t ordered, zfs_type_t type);
527 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
529 extern void zprop_free_list(zprop_list_t *);
531 #define ZFS_GET_NCOLS 5
543 * Functions for printing zfs or zpool properties
545 typedef struct zprop_get_cbdata {
547 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
548 int cb_colwidths[ZFS_GET_NCOLS + 1];
549 boolean_t cb_scripted;
550 boolean_t cb_literal;
552 zprop_list_t *cb_proplist;
554 } zprop_get_cbdata_t;
556 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
557 const char *, const char *, zprop_source_t, const char *,
561 * Iterator functions.
563 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
564 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
565 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
566 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
567 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
568 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
569 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
570 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
571 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
572 extern int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *);
574 typedef struct get_all_cb {
575 zfs_handle_t **cb_handles;
580 void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t,
581 zfs_iter_f, void *, boolean_t);
582 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
585 * Functions to create and destroy datasets.
587 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
589 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
590 extern int zfs_destroy(zfs_handle_t *, boolean_t);
591 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
592 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
593 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
594 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
595 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
597 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
598 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
600 typedef struct sendflags {
601 /* print informational messages (ie, -v was specified) */
604 /* recursive send (ie, -R) */
607 /* for incrementals, do all intermediate snapshots */
610 /* if dataset is a clone, do incremental from its origin */
611 boolean_t fromorigin;
613 /* do deduplication */
616 /* send properties (ie, -p) */
619 /* do not send (no-op, ie. -n) */
622 /* parsable verbose output (ie. -P) */
625 /* show progress (ie. -v) */
628 /* large blocks (>128K) are permitted */
629 boolean_t largeblock;
631 /* WRITE_EMBEDDED records of type DATA are permitted */
632 boolean_t embed_data;
634 /* compressed WRITE records are permitted */
637 /* raw encrypted records are permitted */
640 /* only send received properties (ie. -b) */
644 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
646 extern int zfs_send(zfs_handle_t *, const char *, const char *,
647 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
648 extern int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t flags);
649 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
651 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
654 extern int zfs_promote(zfs_handle_t *);
655 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
657 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
658 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
659 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
660 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
662 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
663 uid_t rid, uint64_t space);
665 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
666 zfs_userspace_cb_t, void *);
668 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
669 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
671 typedef struct recvflags {
672 /* print informational messages (ie, -v was specified) */
675 /* the destination is a prefix, not the exact fs (ie, -d) */
679 * Only the tail of the sent snapshot path is appended to the
680 * destination to determine the received snapshot name (ie, -e).
684 /* do not actually do the recv, just check if it would work (ie, -n) */
687 /* rollback/destroy filesystems as necessary (eg, -F) */
690 /* set "canmount=off" on all modified filesystems */
691 boolean_t canmountoff;
694 * Mark the file systems as "resumable" and do not destroy them if the
695 * receive is interrupted
699 /* byteswap flag is used internally; callers need not specify */
702 /* do not mount file systems as they are extracted (private) */
706 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
707 recvflags_t *, int, avl_tree_t *);
709 typedef enum diff_flags {
710 ZFS_DIFF_PARSEABLE = 0x1,
711 ZFS_DIFF_TIMESTAMP = 0x2,
712 ZFS_DIFF_CLASSIFY = 0x4
715 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
719 * Miscellaneous functions.
721 extern const char *zfs_type_to_name(zfs_type_t);
722 extern void zfs_refresh_properties(zfs_handle_t *);
723 extern int zfs_name_valid(const char *, zfs_type_t);
724 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
725 extern int zfs_parent_name(zfs_handle_t *, char *, size_t);
726 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
728 extern int zfs_spa_version(zfs_handle_t *, int *);
729 extern boolean_t zfs_bookmark_exists(const char *path);
732 * Mount support functions.
734 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
735 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
736 extern int zfs_mount(zfs_handle_t *, const char *, int);
737 extern int zfs_unmount(zfs_handle_t *, const char *, int);
738 extern int zfs_unmountall(zfs_handle_t *, int);
741 * Share support functions.
743 extern boolean_t zfs_is_shared(zfs_handle_t *);
744 extern int zfs_share(zfs_handle_t *);
745 extern int zfs_unshare(zfs_handle_t *);
748 * Protocol-specific share support functions.
750 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
751 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
752 extern int zfs_share_nfs(zfs_handle_t *);
753 extern int zfs_share_smb(zfs_handle_t *);
754 extern int zfs_shareall(zfs_handle_t *);
755 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
756 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
757 extern int zfs_unshareall_nfs(zfs_handle_t *);
758 extern int zfs_unshareall_smb(zfs_handle_t *);
759 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
760 extern int zfs_unshareall_bytype(zfs_handle_t *, const char *, const char *);
761 extern int zfs_unshareall(zfs_handle_t *);
762 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
763 void *, void *, int, zfs_share_op_t);
765 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
768 * Utility functions to run an external process.
770 #define STDOUT_VERBOSE 0x01
771 #define STDERR_VERBOSE 0x02
772 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
774 int libzfs_run_process(const char *, char **, int flags);
775 int libzfs_run_process_get_stdout(const char *path, char *argv[], char *env[],
776 char **lines[], int *lines_cnt);
777 int libzfs_run_process_get_stdout_nopath(const char *path, char *argv[],
778 char *env[], char **lines[], int *lines_cnt);
780 void libzfs_free_str_array(char **strs, int count);
782 int libzfs_envvar_is_set(char *envvar);
785 * Given a device or file, determine if it is part of a pool.
787 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
791 * Label manipulation.
793 extern int zpool_clear_label(int);
796 * Management interfaces for SMB ACL files
799 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
800 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
801 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
802 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
805 * Enable and disable datasets within a pool by mounting/unmounting and
806 * sharing/unsharing them.
808 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
809 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
811 extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *);
817 #endif /* _LIBZFS_H */