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 Pawel Jakub Dawidek. All rights reserved.
25 * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
26 * Copyright 2019 Joyent, Inc.
27 * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
28 * Copyright (c) 2013 Steven Hartland. All rights reserved.
29 * Copyright (c) 2014 Integros [integros.com]
30 * Copyright 2016 Nexenta Systems, Inc.
31 * Copyright (c) 2019 Datto Inc.
38 #include <libnvpair.h>
39 #include <sys/mnttab.h>
40 #include <sys/param.h>
41 #include <sys/types.h>
42 #include <sys/varargs.h>
43 #include <sys/fs/zfs.h>
45 #include <sys/zfs_ioctl.h>
46 #include <libzfs_core.h>
53 * Miscellaneous ZFS constants
55 #define ZFS_MAXPROPLEN MAXPATHLEN
56 #define ZPOOL_MAXPROPLEN MAXPATHLEN
61 typedef enum zfs_error {
62 EZFS_SUCCESS = 0, /* no error -- success */
63 EZFS_NOMEM = 2000, /* out of memory */
64 EZFS_BADPROP, /* invalid property value */
65 EZFS_PROPREADONLY, /* cannot set readonly property */
66 EZFS_PROPTYPE, /* property does not apply to dataset type */
67 EZFS_PROPNONINHERIT, /* property is not inheritable */
68 EZFS_PROPSPACE, /* bad quota or reservation */
69 EZFS_BADTYPE, /* dataset is not of appropriate type */
70 EZFS_BUSY, /* pool or dataset is busy */
71 EZFS_EXISTS, /* pool or dataset already exists */
72 EZFS_NOENT, /* no such pool or dataset */
73 EZFS_BADSTREAM, /* bad backup stream */
74 EZFS_DSREADONLY, /* dataset is readonly */
75 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
76 EZFS_INVALIDNAME, /* invalid dataset name */
77 EZFS_BADRESTORE, /* unable to restore to destination */
78 EZFS_BADBACKUP, /* backup failed */
79 EZFS_BADTARGET, /* bad attach/detach/replace target */
80 EZFS_NODEVICE, /* no such device in pool */
81 EZFS_BADDEV, /* invalid device to add */
82 EZFS_NOREPLICAS, /* no valid replicas */
83 EZFS_RESILVERING, /* currently resilvering */
84 EZFS_BADVERSION, /* unsupported version */
85 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
86 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
87 EZFS_BADPATH, /* must be an absolute path */
88 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
89 EZFS_ZONED, /* used improperly in local zone */
90 EZFS_MOUNTFAILED, /* failed to mount dataset */
91 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
92 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
93 EZFS_SHARENFSFAILED, /* share(1M) failed */
94 EZFS_PERM, /* permission denied */
95 EZFS_NOSPC, /* out of space */
96 EZFS_FAULT, /* bad address */
97 EZFS_IO, /* I/O error */
98 EZFS_INTR, /* signal received */
99 EZFS_ISSPARE, /* device is a hot spare */
100 EZFS_INVALCONFIG, /* invalid vdev configuration */
101 EZFS_RECURSIVE, /* recursive dependency */
102 EZFS_NOHISTORY, /* no history object */
103 EZFS_POOLPROPS, /* couldn't retrieve pool props */
104 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
105 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
106 EZFS_NAMETOOLONG, /* dataset name is too long */
107 EZFS_OPENFAILED, /* open of device failed */
108 EZFS_NOCAP, /* couldn't get capacity */
109 EZFS_LABELFAILED, /* write of label failed */
110 EZFS_BADWHO, /* invalid permission who */
111 EZFS_BADPERM, /* invalid permission */
112 EZFS_BADPERMSET, /* invalid permission set name */
113 EZFS_NODELEGATION, /* delegated administration is disabled */
114 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
115 EZFS_SHARESMBFAILED, /* failed to share over smb */
116 EZFS_BADCACHE, /* bad cache file */
117 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
118 EZFS_VDEVNOTSUP, /* unsupported vdev type */
119 EZFS_NOTSUP, /* ops not supported on this dataset */
120 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
121 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
122 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
123 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
124 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
125 EZFS_PIPEFAILED, /* pipe create failed */
126 EZFS_THREADCREATEFAILED, /* thread create failed */
127 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
128 EZFS_SCRUBBING, /* currently scrubbing */
129 EZFS_NO_SCRUB, /* no active scrub */
130 EZFS_DIFF, /* general failure of zfs diff */
131 EZFS_DIFFDATA, /* bad zfs diff data */
132 EZFS_POOLREADONLY, /* pool is in read-only mode */
133 EZFS_SCRUB_PAUSED, /* scrub currently paused */
134 EZFS_ACTIVE_POOL, /* pool is imported on a different system */
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_TOOMANY, /* argument list too long */
142 EZFS_INITIALIZING, /* currently initializing */
143 EZFS_NO_INITIALIZE, /* no active initialize */
144 EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */
149 * UEFI boot support parameters. When creating whole disk boot pool,
150 * zpool create should allow to create EFI System partition for UEFI boot
151 * program. In case of BIOS, the EFI System partition is not used
152 * even if it does exist.
154 typedef enum zpool_boot_label {
155 ZPOOL_NO_BOOT_LABEL = 0,
156 ZPOOL_CREATE_BOOT_LABEL,
157 ZPOOL_COPY_BOOT_LABEL
158 } zpool_boot_label_t;
161 * The following data structures are all part
162 * of the zfs_allow_t data structure which is
163 * used for printing 'allow' permissions.
164 * It is a linked list of zfs_allow_t's which
165 * then contain avl tree's for user/group/sets/...
166 * and each one of the entries in those trees have
167 * avl tree's for the permissions they belong to and
168 * whether they are local,descendent or local+descendent
169 * permissions. The AVL trees are used primarily for
170 * sorting purposes, but also so that we can quickly find
171 * a given user and or permission.
173 typedef struct zfs_perm_node {
175 char z_pname[MAXPATHLEN];
178 typedef struct zfs_allow_node {
180 char z_key[MAXPATHLEN]; /* name, such as joe */
181 avl_tree_t z_localdescend; /* local+descendent perms */
182 avl_tree_t z_local; /* local permissions */
183 avl_tree_t z_descend; /* descendent permissions */
186 typedef struct zfs_allow {
187 struct zfs_allow *z_next;
188 char z_setpoint[MAXPATHLEN];
190 avl_tree_t z_crperms;
193 avl_tree_t z_everyone;
199 typedef struct zfs_handle zfs_handle_t;
200 typedef struct zpool_handle zpool_handle_t;
201 typedef struct libzfs_handle libzfs_handle_t;
204 * Library initialization
206 extern libzfs_handle_t *libzfs_init(void);
207 extern void libzfs_fini(libzfs_handle_t *);
209 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
210 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
212 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
214 extern void zfs_save_arguments(int argc, char **, char *, int);
215 extern int zpool_log_history(libzfs_handle_t *, const char *);
217 extern int libzfs_errno(libzfs_handle_t *);
218 extern const char *libzfs_error_action(libzfs_handle_t *);
219 extern const char *libzfs_error_description(libzfs_handle_t *);
220 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
221 extern void libzfs_mnttab_init(libzfs_handle_t *);
222 extern void libzfs_mnttab_fini(libzfs_handle_t *);
223 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
224 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
226 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
227 const char *, const char *);
228 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
231 * Basic handle functions
233 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
234 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
235 extern void zpool_close(zpool_handle_t *);
236 extern const char *zpool_get_name(zpool_handle_t *);
237 extern int zpool_get_state(zpool_handle_t *);
238 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
239 extern const char *zpool_pool_state_to_name(pool_state_t);
240 extern void zpool_free_handles(libzfs_handle_t *);
241 extern int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, const char *);
244 * Iterate over all active pools in the system.
246 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
247 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
248 extern boolean_t zpool_skip_pool(const char *);
251 * Functions to create and destroy pools
253 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
254 nvlist_t *, nvlist_t *);
255 extern int zpool_destroy(zpool_handle_t *, const char *);
256 extern int zpool_add(zpool_handle_t *, nvlist_t *);
258 typedef struct splitflags {
259 /* do not split, but return the config that would be split off */
262 /* after splitting, import the pool */
268 * Functions to manipulate pool and vdev state
270 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
271 extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t,
273 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
274 extern int zpool_reguid(zpool_handle_t *);
275 extern int zpool_reopen(zpool_handle_t *);
277 extern int zpool_sync_one(zpool_handle_t *, void *);
279 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
281 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
282 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
283 const char *, nvlist_t *, int);
284 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
285 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
286 extern int zpool_vdev_remove_cancel(zpool_handle_t *);
287 extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *);
288 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
291 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
292 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
293 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
295 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
296 boolean_t *, boolean_t *);
297 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
298 boolean_t *, boolean_t *, boolean_t *);
299 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *,
300 zpool_boot_label_t, uint64_t, int *);
303 * Functions to manage pool properties
305 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
306 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
307 size_t proplen, zprop_source_t *, boolean_t);
308 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
311 extern const char *zpool_prop_to_name(zpool_prop_t);
312 extern const char *zpool_prop_values(zpool_prop_t);
315 * Pool health statistics.
319 * The following correspond to faults as defined in the (fault.fs.zfs.*)
320 * event namespace. Each is associated with a corresponding message ID.
321 * This must be kept in sync with the zfs_msgid_table in
322 * lib/libzfs/libzfs_status.c.
324 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
325 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
326 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
327 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
328 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
329 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
330 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
331 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
332 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
333 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
334 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
335 ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */
336 ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */
337 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
338 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
339 ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */
340 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
343 * If the pool has unsupported features but can still be opened in
344 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
345 * pool has unsupported features but cannot be opened at all, its
346 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
348 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
349 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
352 * These faults have no corresponding message ID. At the time we are
353 * checking the status, the original reason for the FMA fault (I/O or
354 * checksum errors) has been lost.
356 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
357 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
360 * The following are not faults per se, but still an error possibly
361 * requiring administrative attention. There is no corresponding
364 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
365 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
366 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
367 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */
368 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
369 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
372 * Finally, the following indicates a healthy pool.
377 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
378 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
379 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
382 * Statistics and configuration functions.
384 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
385 extern nvlist_t *zpool_get_features(zpool_handle_t *);
386 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
387 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
388 extern boolean_t zpool_is_bootable(zpool_handle_t *);
391 * Import and export functions
393 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
394 extern int zpool_export_force(zpool_handle_t *, const char *);
395 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
397 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
399 extern void zpool_print_unsup_feat(nvlist_t *config);
402 * Search for pools to import
405 typedef struct importargs {
406 char **path; /* a list of paths to search */
407 int paths; /* number of paths to search */
408 char *poolname; /* name of a pool to find */
409 uint64_t guid; /* guid of a pool to find */
410 char *cachefile; /* cachefile to use for import */
411 int can_be_active : 1; /* can the pool be active? */
412 int unique : 1; /* does 'poolname' already exist? */
413 int exists : 1; /* set on return if pool already exists */
414 nvlist_t *policy; /* load policy (max txg, rewind, etc.) */
417 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
418 extern int zpool_tryimport(libzfs_handle_t *hdl, char *target,
419 nvlist_t **configp, importargs_t *args);
421 /* legacy pool search routines */
422 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
423 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
427 * Miscellaneous pool functions
431 extern const char *zfs_history_event_names[];
434 VDEV_NAME_PATH = 1 << 0,
435 VDEV_NAME_GUID = 1 << 1,
436 VDEV_NAME_FOLLOW_LINKS = 1 << 2,
437 VDEV_NAME_TYPE_ID = 1 << 3,
440 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
442 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
443 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
444 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
445 nvlist_t ***, uint_t *);
446 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
448 extern int zfs_ioctl(libzfs_handle_t *, int request, struct zfs_cmd *);
449 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
450 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
452 extern int zpool_checkpoint(zpool_handle_t *);
453 extern int zpool_discard_checkpoint(zpool_handle_t *);
456 * Basic handle manipulations. These functions do not create or destroy the
457 * underlying datasets, only the references to them.
459 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
460 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
461 extern void zfs_close(zfs_handle_t *);
462 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
463 extern const char *zfs_get_name(const zfs_handle_t *);
464 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
465 extern const char *zfs_get_pool_name(const zfs_handle_t *);
468 * Property management functions. Some functions are shared with the kernel,
469 * and are found in sys/fs/zfs.h.
473 * zfs dataset property management
475 extern const char *zfs_prop_default_string(zfs_prop_t);
476 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
477 extern const char *zfs_prop_column_name(zfs_prop_t);
478 extern boolean_t zfs_prop_align_right(zfs_prop_t);
480 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
481 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
483 extern const char *zfs_prop_to_name(zfs_prop_t);
484 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
485 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
486 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
487 zprop_source_t *, char *, size_t, boolean_t);
488 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
490 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
491 zprop_source_t *, char *, size_t);
492 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
493 uint64_t *propvalue);
494 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
495 char *propbuf, int proplen, boolean_t literal);
496 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
497 uint64_t *propvalue);
498 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
499 char *propbuf, int proplen, boolean_t literal);
500 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
501 char *buf, size_t len);
502 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
503 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
504 extern const char *zfs_prop_values(zfs_prop_t);
505 extern int zfs_prop_is_string(zfs_prop_t prop);
506 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
507 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
508 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
511 typedef struct zprop_list {
514 struct zprop_list *pl_next;
517 size_t pl_recvd_width;
521 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
523 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
525 #define ZFS_MOUNTPOINT_NONE "none"
526 #define ZFS_MOUNTPOINT_LEGACY "legacy"
528 #define ZFS_FEATURE_DISABLED "disabled"
529 #define ZFS_FEATURE_ENABLED "enabled"
530 #define ZFS_FEATURE_ACTIVE "active"
532 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
533 #define ZFS_UNSUPPORTED_READONLY "readonly"
536 * zpool property management
538 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
539 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
541 extern const char *zpool_prop_default_string(zpool_prop_t);
542 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
543 extern const char *zpool_prop_column_name(zpool_prop_t);
544 extern boolean_t zpool_prop_align_right(zpool_prop_t);
547 * Functions shared by zfs and zpool property management.
549 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
550 boolean_t ordered, zfs_type_t type);
551 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
553 extern void zprop_free_list(zprop_list_t *);
555 #define ZFS_GET_NCOLS 5
567 * Functions for printing zfs or zpool properties
569 typedef struct zprop_get_cbdata {
571 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
572 int cb_colwidths[ZFS_GET_NCOLS + 1];
573 boolean_t cb_scripted;
574 boolean_t cb_literal;
576 zprop_list_t *cb_proplist;
578 } zprop_get_cbdata_t;
580 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
581 const char *, const char *, zprop_source_t, const char *,
585 * Iterator functions.
587 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
588 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
589 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
590 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
591 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
592 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *,
594 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *,
596 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
597 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
599 typedef struct get_all_cb {
600 zfs_handle_t **cb_handles;
605 void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t,
606 zfs_iter_f, void*, boolean_t);
608 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
611 * Functions to create and destroy datasets.
613 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
615 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
616 extern int zfs_destroy(zfs_handle_t *, boolean_t);
617 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
618 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
619 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
620 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
621 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
623 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
625 typedef struct renameflags {
626 /* recursive rename */
629 /* don't unmount file systems */
632 /* force unmount file systems */
633 int forceunmount : 1;
636 extern int zfs_rename(zfs_handle_t *, const char *, const char *,
637 renameflags_t flags);
639 typedef struct sendflags {
640 /* print informational messages (ie, -v was specified) */
643 /* recursive send (ie, -R) */
646 /* for incrementals, do all intermediate snapshots */
649 /* if dataset is a clone, do incremental from its origin */
650 boolean_t fromorigin;
652 /* do deduplication */
655 /* send properties (ie, -p) */
658 /* do not send (no-op, ie. -n) */
661 /* parsable verbose output (ie. -P) */
664 /* show progress (ie. -v) */
667 /* large blocks (>128K) are permitted */
668 boolean_t largeblock;
670 /* WRITE_EMBEDDED records of type DATA are permitted */
671 boolean_t embed_data;
673 /* compressed WRITE records are permitted */
676 /* show progress as process title(ie. -V) */
677 boolean_t progressastitle;
680 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
682 extern int zfs_send(zfs_handle_t *, const char *, const char *,
683 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
684 extern int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t flags);
685 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
687 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
690 extern int zfs_promote(zfs_handle_t *);
691 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
693 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
694 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
695 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
696 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
698 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
699 uid_t rid, uint64_t space);
701 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
702 zfs_userspace_cb_t, void *);
704 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
705 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
707 typedef struct recvflags {
708 /* print informational messages (ie, -v was specified) */
711 /* the destination is a prefix, not the exact fs (ie, -d) */
715 * Only the tail of the sent snapshot path is appended to the
716 * destination to determine the received snapshot name (ie, -e).
720 /* do not actually do the recv, just check if it would work (ie, -n) */
723 /* rollback/destroy filesystems as necessary (eg, -F) */
726 /* set "canmount=off" on all modified filesystems */
727 boolean_t canmountoff;
730 * Mark the file systems as "resumable" and do not destroy them if the
731 * receive is interrupted
735 /* byteswap flag is used internally; callers need not specify */
738 /* do not mount file systems as they are extracted (private) */
741 /* force unmount while recv snapshot (private) */
742 boolean_t forceunmount;
745 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
746 recvflags_t *, int, avl_tree_t *);
748 typedef enum diff_flags {
749 ZFS_DIFF_PARSEABLE = 0x1,
750 ZFS_DIFF_TIMESTAMP = 0x2,
751 ZFS_DIFF_CLASSIFY = 0x4
754 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
758 * Miscellaneous functions.
760 extern const char *zfs_type_to_name(zfs_type_t);
761 extern void zfs_refresh_properties(zfs_handle_t *);
762 extern int zfs_name_valid(const char *, zfs_type_t);
763 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
764 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
766 extern int zfs_spa_version(zfs_handle_t *, int *);
767 extern boolean_t zfs_bookmark_exists(const char *path);
768 extern ulong_t get_system_hostid(void);
771 * Mount support functions.
773 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
774 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
775 extern int zfs_mount(zfs_handle_t *, const char *, int);
776 extern int zfs_mount_at(zfs_handle_t *, const char *, int, const char *);
777 extern int zfs_unmount(zfs_handle_t *, const char *, int);
778 extern int zfs_unmountall(zfs_handle_t *, int);
781 * Share support functions.
783 extern boolean_t zfs_is_shared(zfs_handle_t *);
784 extern int zfs_share(zfs_handle_t *);
785 extern int zfs_unshare(zfs_handle_t *);
788 * Protocol-specific share support functions.
790 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
791 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
792 extern int zfs_share_nfs(zfs_handle_t *);
793 extern int zfs_share_smb(zfs_handle_t *);
794 extern int zfs_shareall(zfs_handle_t *);
795 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
796 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
797 extern int zfs_unshareall_nfs(zfs_handle_t *);
798 extern int zfs_unshareall_smb(zfs_handle_t *);
799 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
800 extern int zfs_unshareall(zfs_handle_t *);
801 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
802 void *, void *, int, zfs_share_op_t);
805 * FreeBSD-specific jail support function.
807 extern int zfs_jail(zfs_handle_t *, int, int);
810 * When dealing with nvlists, verify() is extremely useful
814 #define verify(EX) ((void)(EX))
816 #define verify(EX) assert(EX)
821 * Utility function to convert a number to a human-readable form.
823 extern void zfs_nicenum(uint64_t, char *, size_t);
824 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
827 * Given a device or file, determine if it is part of a pool.
829 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
833 * Label manipulation.
835 extern int zpool_read_label(int, nvlist_t **);
836 extern int zpool_read_all_labels(int, nvlist_t **);
837 extern int zpool_clear_label(int);
839 /* is this zvol valid for use as a dump device? */
840 extern int zvol_check_dump_config(char *);
843 * Management interfaces for SMB ACL files
846 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
847 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
848 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
849 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
852 * Enable and disable datasets within a pool by mounting/unmounting and
853 * sharing/unsharing them.
855 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
856 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
859 * Mappings between vdev and FRU.
861 extern void libzfs_fru_refresh(libzfs_handle_t *);
862 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
863 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
864 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
866 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
867 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
870 extern int zmount(const char *, const char *, int, char *, char *, int, char *,
873 extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *);
875 /* Allow consumers to initialize libshare externally for optimal performance */
876 extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *);
878 * For most consumers, zfs_init_libshare_arg is sufficient on its own, and
879 * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called
880 * if the caller has already initialized libshare for one set of zfs handles,
881 * and wishes to share or unshare filesystems outside of that set. In that case,
882 * the caller should uninitialize libshare, and then re-initialize it with the
883 * new handles being shared or unshared.
885 extern void zfs_uninit_libshare(libzfs_handle_t *);
890 #endif /* _LIBZFS_H */