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, 2015 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 Datto Inc.
30 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
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
58 * Default device paths
60 #define DISK_ROOT "/dev"
61 #define UDISK_ROOT "/dev/disk"
62 #define ZVOL_ROOT "/dev/zvol"
65 * Default wait time for a device name to be created.
67 #define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */
69 #define IMPORT_ORDER_PREFERRED_1 1
70 #define IMPORT_ORDER_PREFERRED_2 2
71 #define IMPORT_ORDER_SCAN_OFFSET 10
72 #define IMPORT_ORDER_DEFAULT 100
73 #define DEFAULT_IMPORT_PATH_SIZE 9
74 extern char *zpool_default_import_path
[DEFAULT_IMPORT_PATH_SIZE
];
79 typedef enum zfs_error
{
80 EZFS_SUCCESS
= 0, /* no error -- success */
81 EZFS_NOMEM
= 2000, /* out of memory */
82 EZFS_BADPROP
, /* invalid property value */
83 EZFS_PROPREADONLY
, /* cannot set readonly property */
84 EZFS_PROPTYPE
, /* property does not apply to dataset type */
85 EZFS_PROPNONINHERIT
, /* property is not inheritable */
86 EZFS_PROPSPACE
, /* bad quota or reservation */
87 EZFS_BADTYPE
, /* dataset is not of appropriate type */
88 EZFS_BUSY
, /* pool or dataset is busy */
89 EZFS_EXISTS
, /* pool or dataset already exists */
90 EZFS_NOENT
, /* no such pool or dataset */
91 EZFS_BADSTREAM
, /* bad backup stream */
92 EZFS_DSREADONLY
, /* dataset is readonly */
93 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
94 EZFS_INVALIDNAME
, /* invalid dataset name */
95 EZFS_BADRESTORE
, /* unable to restore to destination */
96 EZFS_BADBACKUP
, /* backup failed */
97 EZFS_BADTARGET
, /* bad attach/detach/replace target */
98 EZFS_NODEVICE
, /* no such device in pool */
99 EZFS_BADDEV
, /* invalid device to add */
100 EZFS_NOREPLICAS
, /* no valid replicas */
101 EZFS_RESILVERING
, /* currently resilvering */
102 EZFS_BADVERSION
, /* unsupported version */
103 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
104 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
105 EZFS_BADPATH
, /* must be an absolute path */
106 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
107 EZFS_ZONED
, /* used improperly in local zone */
108 EZFS_MOUNTFAILED
, /* failed to mount dataset */
109 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
110 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
111 EZFS_SHARENFSFAILED
, /* share(1M) failed */
112 EZFS_PERM
, /* permission denied */
113 EZFS_NOSPC
, /* out of space */
114 EZFS_FAULT
, /* bad address */
115 EZFS_IO
, /* I/O error */
116 EZFS_INTR
, /* signal received */
117 EZFS_ISSPARE
, /* device is a hot spare */
118 EZFS_INVALCONFIG
, /* invalid vdev configuration */
119 EZFS_RECURSIVE
, /* recursive dependency */
120 EZFS_NOHISTORY
, /* no history object */
121 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
122 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
123 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
124 EZFS_NAMETOOLONG
, /* dataset name is too long */
125 EZFS_OPENFAILED
, /* open of device failed */
126 EZFS_NOCAP
, /* couldn't get capacity */
127 EZFS_LABELFAILED
, /* write of label failed */
128 EZFS_BADWHO
, /* invalid permission who */
129 EZFS_BADPERM
, /* invalid permission */
130 EZFS_BADPERMSET
, /* invalid permission set name */
131 EZFS_NODELEGATION
, /* delegated administration is disabled */
132 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
133 EZFS_SHARESMBFAILED
, /* failed to share over smb */
134 EZFS_BADCACHE
, /* bad cache file */
135 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
136 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
137 EZFS_NOTSUP
, /* ops not supported on this dataset */
138 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
139 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
140 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
141 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
142 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
143 EZFS_PIPEFAILED
, /* pipe create failed */
144 EZFS_THREADCREATEFAILED
, /* thread create failed */
145 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
146 EZFS_SCRUBBING
, /* currently scrubbing */
147 EZFS_NO_SCRUB
, /* no active scrub */
148 EZFS_DIFF
, /* general failure of zfs diff */
149 EZFS_DIFFDATA
, /* bad zfs diff data */
150 EZFS_POOLREADONLY
, /* pool is in read-only mode */
151 EZFS_SCRUB_PAUSED
, /* scrub currently paused */
152 EZFS_ACTIVE_POOL
, /* pool is imported on a different system */
153 EZFS_CRYPTOFAILED
, /* failed to setup encryption */
158 * The following data structures are all part
159 * of the zfs_allow_t data structure which is
160 * used for printing 'allow' permissions.
161 * It is a linked list of zfs_allow_t's which
162 * then contain avl tree's for user/group/sets/...
163 * and each one of the entries in those trees have
164 * avl tree's for the permissions they belong to and
165 * whether they are local,descendent or local+descendent
166 * permissions. The AVL trees are used primarily for
167 * sorting purposes, but also so that we can quickly find
168 * a given user and or permission.
170 typedef struct zfs_perm_node
{
172 char z_pname
[MAXPATHLEN
];
175 typedef struct zfs_allow_node
{
177 char z_key
[MAXPATHLEN
]; /* name, such as joe */
178 avl_tree_t z_localdescend
; /* local+descendent perms */
179 avl_tree_t z_local
; /* local permissions */
180 avl_tree_t z_descend
; /* descendent permissions */
183 typedef struct zfs_allow
{
184 struct zfs_allow
*z_next
;
185 char z_setpoint
[MAXPATHLEN
];
187 avl_tree_t z_crperms
;
190 avl_tree_t z_everyone
;
196 typedef struct zfs_handle zfs_handle_t
;
197 typedef struct zpool_handle zpool_handle_t
;
198 typedef struct libzfs_handle libzfs_handle_t
;
201 * Library initialization
203 extern libzfs_handle_t
*libzfs_init(void);
204 extern void libzfs_fini(libzfs_handle_t
*);
206 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
207 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
209 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
211 extern void zfs_save_arguments(int argc
, char **, char *, int);
212 extern int zpool_log_history(libzfs_handle_t
*, const char *);
214 extern int libzfs_errno(libzfs_handle_t
*);
215 extern const char *libzfs_error_init(int);
216 extern const char *libzfs_error_action(libzfs_handle_t
*);
217 extern const char *libzfs_error_description(libzfs_handle_t
*);
218 extern int zfs_standard_error(libzfs_handle_t
*, int, const char *);
219 extern void libzfs_mnttab_init(libzfs_handle_t
*);
220 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
221 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
222 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
224 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
225 const char *, const char *);
226 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
229 * Basic handle functions
231 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
232 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
233 extern void zpool_close(zpool_handle_t
*);
234 extern const char *zpool_get_name(zpool_handle_t
*);
235 extern int zpool_get_state(zpool_handle_t
*);
236 extern const char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
237 extern const char *zpool_pool_state_to_name(pool_state_t
);
238 extern void zpool_free_handles(libzfs_handle_t
*);
241 * Iterate over all active pools in the system.
243 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
244 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
245 extern boolean_t
zpool_skip_pool(const char *);
248 * Functions to create and destroy pools
250 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
251 nvlist_t
*, nvlist_t
*);
252 extern int zpool_destroy(zpool_handle_t
*, const char *);
253 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
255 typedef struct splitflags
{
256 /* do not split, but return the config that would be split off */
259 /* after splitting, import the pool */
265 * Functions to manipulate pool and vdev state
267 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
, pool_scrub_cmd_t
);
268 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
269 extern int zpool_reguid(zpool_handle_t
*);
270 extern int zpool_reopen_one(zpool_handle_t
*, void *);
272 extern int zpool_sync_one(zpool_handle_t
*, void *);
274 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
276 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
277 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
278 const char *, nvlist_t
*, int);
279 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
280 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
281 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
284 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
285 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
286 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
288 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
289 boolean_t
*, boolean_t
*);
290 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
291 boolean_t
*, boolean_t
*, boolean_t
*);
292 extern int zpool_label_disk_wait(char *, int);
293 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
294 extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t
*zhp
, const char *path
);
296 int zfs_dev_is_dm(char *dev_name
);
297 int zfs_dev_is_whole_disk(char *dev_name
);
298 char *zfs_get_underlying_path(char *dev_name
);
299 char *zfs_get_enclosure_sysfs_path(char *dev_name
);
302 * Functions to manage pool properties
304 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
305 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
306 size_t proplen
, zprop_source_t
*, boolean_t literal
);
307 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
310 extern const char *zpool_prop_to_name(zpool_prop_t
);
311 extern const char *zpool_prop_values(zpool_prop_t
);
314 * Pool health statistics.
318 * The following correspond to faults as defined in the (fault.fs.zfs.*)
319 * event namespace. Each is associated with a corresponding message ID.
321 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
322 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
323 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
324 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
325 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
326 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
327 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
328 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
329 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
330 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
331 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
332 ZPOOL_STATUS_HOSTID_ACTIVE
, /* currently active on another system */
333 ZPOOL_STATUS_HOSTID_REQUIRED
, /* multihost=on and hostid=0 */
334 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
335 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
336 ZPOOL_STATUS_IO_FAILURE_MMP
, /* failed MMP, failmode not 'panic' */
337 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
338 ZPOOL_STATUS_ERRATA
, /* informational errata available */
341 * If the pool has unsupported features but can still be opened in
342 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
343 * pool has unsupported features but cannot be opened at all, its
344 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
346 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
347 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
350 * These faults have no corresponding message ID. At the time we are
351 * checking the status, the original reason for the FMA fault (I/O or
352 * checksum errors) has been lost.
354 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
355 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
358 * The following are not faults per se, but still an error possibly
359 * requiring administrative attention. There is no corresponding
362 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
363 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
364 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
365 ZPOOL_STATUS_OFFLINE_DEV
, /* device offline */
366 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
369 * Finally, the following indicates a healthy pool.
374 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **,
376 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **,
378 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
381 * Statistics and configuration functions.
383 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
384 extern nvlist_t
*zpool_get_features(zpool_handle_t
*);
385 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
386 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
389 * Import and export functions
391 extern int zpool_export(zpool_handle_t
*, boolean_t
, const char *);
392 extern int zpool_export_force(zpool_handle_t
*, const char *);
393 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
395 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
397 extern void zpool_print_unsup_feat(nvlist_t
*config
);
400 * Search for pools to import
403 typedef struct importargs
{
404 char **path
; /* a list of paths to search */
405 int paths
; /* number of paths to search */
406 char *poolname
; /* name of a pool to find */
407 uint64_t guid
; /* guid of a pool to find */
408 char *cachefile
; /* cachefile to use for import */
409 int can_be_active
: 1; /* can the pool be active? */
410 int unique
: 1; /* does 'poolname' already exist? */
411 int exists
: 1; /* set on return if pool already exists */
412 int scan
: 1; /* prefer scanning to libblkid cache */
415 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
416 extern int zpool_tryimport(libzfs_handle_t
*hdl
, char *target
,
417 nvlist_t
**configp
, importargs_t
*args
);
419 /* legacy pool search routines */
420 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
421 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
425 * Miscellaneous pool functions
429 extern const char *zfs_history_event_names
[];
432 VDEV_NAME_PATH
= 1 << 0,
433 VDEV_NAME_GUID
= 1 << 1,
434 VDEV_NAME_FOLLOW_LINKS
= 1 << 2,
435 VDEV_NAME_TYPE_ID
= 1 << 3,
438 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
440 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
441 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
442 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
443 nvlist_t
***, uint_t
*);
444 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, unsigned,
446 extern int zpool_events_clear(libzfs_handle_t
*, int *);
447 extern int zpool_events_seek(libzfs_handle_t
*, uint64_t, int);
448 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
450 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
451 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
452 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
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
, nvlist_t
*,
481 uint64_t, zfs_handle_t
*, zpool_handle_t
*, boolean_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 getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
503 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
504 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
505 extern const char *zfs_prop_values(zfs_prop_t
);
506 extern int zfs_prop_is_string(zfs_prop_t prop
);
507 extern nvlist_t
*zfs_get_all_props(zfs_handle_t
*);
508 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
509 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
510 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
513 * zfs encryption management
515 extern int zfs_crypto_get_encryption_root(zfs_handle_t
*, boolean_t
*, char *);
516 extern int zfs_crypto_create(libzfs_handle_t
*, char *, nvlist_t
*, nvlist_t
*,
517 uint8_t **, uint_t
*);
518 extern int zfs_crypto_clone_check(libzfs_handle_t
*, zfs_handle_t
*, char *,
520 extern int zfs_crypto_attempt_load_keys(libzfs_handle_t
*, char *);
521 extern int zfs_crypto_load_key(zfs_handle_t
*, boolean_t
, char *);
522 extern int zfs_crypto_unload_key(zfs_handle_t
*);
523 extern int zfs_crypto_rewrap(zfs_handle_t
*, nvlist_t
*, boolean_t
);
525 typedef struct zprop_list
{
528 struct zprop_list
*pl_next
;
531 size_t pl_recvd_width
;
535 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
,
537 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
539 #define ZFS_MOUNTPOINT_NONE "none"
540 #define ZFS_MOUNTPOINT_LEGACY "legacy"
542 #define ZFS_FEATURE_DISABLED "disabled"
543 #define ZFS_FEATURE_ENABLED "enabled"
544 #define ZFS_FEATURE_ACTIVE "active"
546 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
547 #define ZFS_UNSUPPORTED_READONLY "readonly"
550 * zpool property management
552 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
553 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
555 extern const char *zpool_prop_default_string(zpool_prop_t
);
556 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
557 extern const char *zpool_prop_column_name(zpool_prop_t
);
558 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
561 * Functions shared by zfs and zpool property management.
563 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
564 boolean_t ordered
, zfs_type_t type
);
565 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
567 extern void zprop_free_list(zprop_list_t
*);
569 #define ZFS_GET_NCOLS 5
581 * Functions for printing zfs or zpool properties
583 typedef struct zprop_get_cbdata
{
585 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
586 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
587 boolean_t cb_scripted
;
588 boolean_t cb_literal
;
590 zprop_list_t
*cb_proplist
;
592 } zprop_get_cbdata_t
;
594 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
595 const char *, const char *, zprop_source_t
, const char *,
599 * Iterator functions.
601 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
602 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
603 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
604 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
605 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
606 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
607 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
608 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
609 extern int zfs_iter_bookmarks(zfs_handle_t
*, zfs_iter_f
, void *);
611 typedef struct get_all_cb
{
612 zfs_handle_t
**cb_handles
;
615 boolean_t cb_verbose
;
616 int (*cb_getone
)(zfs_handle_t
*, void *);
619 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
620 int libzfs_dataset_cmp(const void *, const void *);
623 * Functions to create and destroy datasets.
625 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
627 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
628 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
629 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
630 extern int zfs_destroy_snaps_nvl(libzfs_handle_t
*, nvlist_t
*, boolean_t
);
631 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
632 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
633 extern int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
635 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
636 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
638 typedef struct sendflags
{
639 /* print informational messages (ie, -v was specified) */
642 /* recursive send (ie, -R) */
645 /* for incrementals, do all intermediate snapshots */
648 /* if dataset is a clone, do incremental from its origin */
649 boolean_t fromorigin
;
651 /* do deduplication */
654 /* send properties (ie, -p) */
657 /* do not send (no-op, ie. -n) */
660 /* parsable verbose output (ie. -P) */
663 /* show progress (ie. -v) */
666 /* large blocks (>128K) are permitted */
667 boolean_t largeblock
;
669 /* WRITE_EMBEDDED records of type DATA are permitted */
670 boolean_t embed_data
;
672 /* compressed WRITE records are permitted */
675 /* raw encrypted records are permitted */
678 /* only send received properties (ie. -b) */
682 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
684 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
685 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
686 extern int zfs_send_one(zfs_handle_t
*, const char *, int, sendflags_t flags
);
687 extern int zfs_send_resume(libzfs_handle_t
*, sendflags_t
*, int outfd
,
689 extern nvlist_t
*zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
,
692 extern int zfs_promote(zfs_handle_t
*);
693 extern int zfs_hold(zfs_handle_t
*, const char *, const char *,
695 extern int zfs_hold_nvl(zfs_handle_t
*, int, nvlist_t
*);
696 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
697 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
698 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
700 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
701 uid_t rid
, uint64_t space
);
703 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
704 zfs_userspace_cb_t
, void *);
706 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
707 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
709 typedef struct recvflags
{
710 /* print informational messages (ie, -v was specified) */
713 /* the destination is a prefix, not the exact fs (ie, -d) */
717 * Only the tail of the sent snapshot path is appended to the
718 * destination to determine the received snapshot name (ie, -e).
722 /* do not actually do the recv, just check if it would work (ie, -n) */
725 /* rollback/destroy filesystems as necessary (eg, -F) */
728 /* set "canmount=off" on all modified filesystems */
729 boolean_t canmountoff
;
732 * Mark the file systems as "resumable" and do not destroy them if the
733 * receive is interrupted
737 /* byteswap flag is used internally; callers need not specify */
740 /* do not mount file systems as they are extracted (private) */
744 extern int zfs_receive(libzfs_handle_t
*, const char *, nvlist_t
*,
745 recvflags_t
*, int, avl_tree_t
*);
747 typedef enum diff_flags
{
748 ZFS_DIFF_PARSEABLE
= 0x1,
749 ZFS_DIFF_TIMESTAMP
= 0x2,
750 ZFS_DIFF_CLASSIFY
= 0x4
753 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
757 * Miscellaneous functions.
759 extern const char *zfs_type_to_name(zfs_type_t
);
760 extern void zfs_refresh_properties(zfs_handle_t
*);
761 extern int zfs_name_valid(const char *, zfs_type_t
);
762 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
763 extern int zfs_parent_name(zfs_handle_t
*, char *, size_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 int zfs_append_partition(char *path
, size_t max_len
);
769 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
770 extern int zfs_strcmp_pathname(char *name
, char *cmp_name
, int wholedisk
);
771 extern int zfs_path_order(char *path
, int *order
);
774 * Mount support functions.
776 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
777 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
778 extern int zfs_mount(zfs_handle_t
*, const char *, int);
779 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
780 extern int zfs_unmountall(zfs_handle_t
*, int);
783 * Share support functions.
785 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
786 extern int zfs_share(zfs_handle_t
*);
787 extern int zfs_unshare(zfs_handle_t
*);
790 * Protocol-specific share support functions.
792 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
793 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
794 extern int zfs_share_nfs(zfs_handle_t
*);
795 extern int zfs_share_smb(zfs_handle_t
*);
796 extern int zfs_shareall(zfs_handle_t
*);
797 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
798 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
799 extern int zfs_unshareall_nfs(zfs_handle_t
*);
800 extern int zfs_unshareall_smb(zfs_handle_t
*);
801 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
802 extern int zfs_unshareall_bytype(zfs_handle_t
*, const char *, const char *);
803 extern int zfs_unshareall(zfs_handle_t
*);
804 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
805 void *, void *, int, zfs_share_op_t
);
808 * Formats for iostat numbers. Examples: "12K", "30ms", "4B", "2321234", "-".
810 * ZFS_NICENUM_1024: Print kilo, mega, tera, peta, exa..
811 * ZFS_NICENUM_BYTES: Print single bytes ("13B"), kilo, mega, tera...
812 * ZFS_NICENUM_TIME: Print nanosecs, microsecs, millisecs, seconds...
813 * ZFS_NICENUM_RAW: Print the raw number without any formatting
814 * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero.
816 enum zfs_nicenum_format
{
817 ZFS_NICENUM_1024
= 0,
818 ZFS_NICENUM_BYTES
= 1,
819 ZFS_NICENUM_TIME
= 2,
821 ZFS_NICENUM_RAWTIME
= 4
825 * Utility function to convert a number to a human-readable form.
827 extern void zfs_nicenum(uint64_t, char *, size_t);
828 extern void zfs_nicenum_format(uint64_t num
, char *buf
, size_t buflen
,
829 enum zfs_nicenum_format type
);
832 extern void zfs_nicetime(uint64_t, char *, size_t);
833 extern void zfs_nicebytes(uint64_t, char *, size_t);
834 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
837 * Utility functions to run an external process.
839 #define STDOUT_VERBOSE 0x01
840 #define STDERR_VERBOSE 0x02
841 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
843 int libzfs_run_process(const char *, char **, int flags
);
844 int libzfs_run_process_get_stdout(const char *path
, char *argv
[], char *env
[],
845 char **lines
[], int *lines_cnt
);
846 int libzfs_run_process_get_stdout_nopath(const char *path
, char *argv
[],
847 char *env
[], char **lines
[], int *lines_cnt
);
849 void libzfs_free_str_array(char **strs
, int count
);
851 int libzfs_envvar_is_set(char *envvar
);
854 * Given a device or file, determine if it is part of a pool.
856 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
860 * Label manipulation.
862 extern int zpool_read_label(int, nvlist_t
**, int *);
863 extern int zpool_clear_label(int);
866 * Management interfaces for SMB ACL files
869 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
870 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
871 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
872 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
875 * Enable and disable datasets within a pool by mounting/unmounting and
876 * sharing/unsharing them.
878 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
879 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
882 * Support for Linux libudev derived persistent device strings
884 extern boolean_t
is_mpath_whole_disk(const char *);
885 extern void update_vdev_config_dev_strs(nvlist_t
*);
886 extern char *zfs_strip_partition(char *);
887 extern char *zfs_strip_partition_path(char *);
892 extern boolean_t
udev_is_mpath(struct udev_device
*dev
);
893 extern int zfs_device_get_devid(struct udev_device
*, char *, size_t);
894 extern int zfs_device_get_physical(struct udev_device
*, char *, size_t);
901 #endif /* _LIBZFS_H */