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 2013 Nexenta Systems, Inc. All rights reserved.
28 * Copyright (c) 2016, Intel Corporation.
35 #include <libnvpair.h>
36 #include <sys/mnttab.h>
37 #include <sys/param.h>
38 #include <sys/types.h>
39 #include <sys/varargs.h>
40 #include <sys/fs/zfs.h>
43 #include <libzfs_core.h>
50 * Miscellaneous ZFS constants
52 #define ZFS_MAXPROPLEN MAXPATHLEN
53 #define ZPOOL_MAXPROPLEN MAXPATHLEN
56 * Default device paths
58 #define DISK_ROOT "/dev"
59 #define UDISK_ROOT "/dev/disk"
60 #define ZVOL_ROOT "/dev/zvol"
63 * Default wait time for a device name to be created.
65 #define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */
67 #define DEFAULT_IMPORT_PATH_SIZE 9
68 extern char *zpool_default_import_path
[DEFAULT_IMPORT_PATH_SIZE
];
73 typedef enum zfs_error
{
74 EZFS_SUCCESS
= 0, /* no error -- success */
75 EZFS_NOMEM
= 2000, /* out of memory */
76 EZFS_BADPROP
, /* invalid property value */
77 EZFS_PROPREADONLY
, /* cannot set readonly property */
78 EZFS_PROPTYPE
, /* property does not apply to dataset type */
79 EZFS_PROPNONINHERIT
, /* property is not inheritable */
80 EZFS_PROPSPACE
, /* bad quota or reservation */
81 EZFS_BADTYPE
, /* dataset is not of appropriate type */
82 EZFS_BUSY
, /* pool or dataset is busy */
83 EZFS_EXISTS
, /* pool or dataset already exists */
84 EZFS_NOENT
, /* no such pool or dataset */
85 EZFS_BADSTREAM
, /* bad backup stream */
86 EZFS_DSREADONLY
, /* dataset is readonly */
87 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
88 EZFS_INVALIDNAME
, /* invalid dataset name */
89 EZFS_BADRESTORE
, /* unable to restore to destination */
90 EZFS_BADBACKUP
, /* backup failed */
91 EZFS_BADTARGET
, /* bad attach/detach/replace target */
92 EZFS_NODEVICE
, /* no such device in pool */
93 EZFS_BADDEV
, /* invalid device to add */
94 EZFS_NOREPLICAS
, /* no valid replicas */
95 EZFS_RESILVERING
, /* currently resilvering */
96 EZFS_BADVERSION
, /* unsupported version */
97 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
98 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
99 EZFS_BADPATH
, /* must be an absolute path */
100 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
101 EZFS_ZONED
, /* used improperly in local zone */
102 EZFS_MOUNTFAILED
, /* failed to mount dataset */
103 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
104 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
105 EZFS_SHARENFSFAILED
, /* share(1M) failed */
106 EZFS_PERM
, /* permission denied */
107 EZFS_NOSPC
, /* out of space */
108 EZFS_FAULT
, /* bad address */
109 EZFS_IO
, /* I/O error */
110 EZFS_INTR
, /* signal received */
111 EZFS_ISSPARE
, /* device is a hot spare */
112 EZFS_INVALCONFIG
, /* invalid vdev configuration */
113 EZFS_RECURSIVE
, /* recursive dependency */
114 EZFS_NOHISTORY
, /* no history object */
115 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
116 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
117 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
118 EZFS_NAMETOOLONG
, /* dataset name is too long */
119 EZFS_OPENFAILED
, /* open of device failed */
120 EZFS_NOCAP
, /* couldn't get capacity */
121 EZFS_LABELFAILED
, /* write of label failed */
122 EZFS_BADWHO
, /* invalid permission who */
123 EZFS_BADPERM
, /* invalid permission */
124 EZFS_BADPERMSET
, /* invalid permission set name */
125 EZFS_NODELEGATION
, /* delegated administration is disabled */
126 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
127 EZFS_SHARESMBFAILED
, /* failed to share over smb */
128 EZFS_BADCACHE
, /* bad cache file */
129 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
130 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
131 EZFS_NOTSUP
, /* ops not supported on this dataset */
132 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
133 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
134 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
135 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
136 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
137 EZFS_PIPEFAILED
, /* pipe create failed */
138 EZFS_THREADCREATEFAILED
, /* thread create failed */
139 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
140 EZFS_SCRUBBING
, /* currently scrubbing */
141 EZFS_NO_SCRUB
, /* no active scrub */
142 EZFS_DIFF
, /* general failure of zfs diff */
143 EZFS_DIFFDATA
, /* bad zfs diff data */
144 EZFS_POOLREADONLY
, /* pool is in read-only mode */
149 * The following data structures are all part
150 * of the zfs_allow_t data structure which is
151 * used for printing 'allow' permissions.
152 * It is a linked list of zfs_allow_t's which
153 * then contain avl tree's for user/group/sets/...
154 * and each one of the entries in those trees have
155 * avl tree's for the permissions they belong to and
156 * whether they are local,descendent or local+descendent
157 * permissions. The AVL trees are used primarily for
158 * sorting purposes, but also so that we can quickly find
159 * a given user and or permission.
161 typedef struct zfs_perm_node
{
163 char z_pname
[MAXPATHLEN
];
166 typedef struct zfs_allow_node
{
168 char z_key
[MAXPATHLEN
]; /* name, such as joe */
169 avl_tree_t z_localdescend
; /* local+descendent perms */
170 avl_tree_t z_local
; /* local permissions */
171 avl_tree_t z_descend
; /* descendent permissions */
174 typedef struct zfs_allow
{
175 struct zfs_allow
*z_next
;
176 char z_setpoint
[MAXPATHLEN
];
178 avl_tree_t z_crperms
;
181 avl_tree_t z_everyone
;
187 typedef struct zfs_handle zfs_handle_t
;
188 typedef struct zpool_handle zpool_handle_t
;
189 typedef struct libzfs_handle libzfs_handle_t
;
192 * Library initialization
194 extern libzfs_handle_t
*libzfs_init(void);
195 extern void libzfs_fini(libzfs_handle_t
*);
197 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
198 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
200 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
202 extern void zfs_save_arguments(int argc
, char **, char *, int);
203 extern int zpool_log_history(libzfs_handle_t
*, const char *);
205 extern int libzfs_errno(libzfs_handle_t
*);
206 extern const char *libzfs_error_init(int);
207 extern const char *libzfs_error_action(libzfs_handle_t
*);
208 extern const char *libzfs_error_description(libzfs_handle_t
*);
209 extern int zfs_standard_error(libzfs_handle_t
*, int, const char *);
210 extern void libzfs_mnttab_init(libzfs_handle_t
*);
211 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
212 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
213 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
215 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
216 const char *, const char *);
217 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
220 * Basic handle functions
222 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
223 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
224 extern void zpool_close(zpool_handle_t
*);
225 extern const char *zpool_get_name(zpool_handle_t
*);
226 extern int zpool_get_state(zpool_handle_t
*);
227 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
228 extern const char *zpool_pool_state_to_name(pool_state_t
);
229 extern void zpool_free_handles(libzfs_handle_t
*);
232 * Iterate over all active pools in the system.
234 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
235 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
238 * Functions to create and destroy pools
240 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
241 nvlist_t
*, nvlist_t
*);
242 extern int zpool_destroy(zpool_handle_t
*, const char *);
243 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
245 typedef struct splitflags
{
246 /* do not split, but return the config that would be split off */
249 /* after splitting, import the pool */
255 * Functions to manipulate pool and vdev state
257 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
);
258 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
259 extern int zpool_reguid(zpool_handle_t
*);
260 extern int zpool_reopen(zpool_handle_t
*);
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_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
272 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
273 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
274 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
276 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
277 boolean_t
*, boolean_t
*);
278 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
279 boolean_t
*, boolean_t
*, boolean_t
*);
280 extern int zpool_label_disk_wait(char *, int);
281 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
284 * Functions to manage pool properties
286 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
287 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
288 size_t proplen
, zprop_source_t
*, boolean_t literal
);
289 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
292 extern const char *zpool_prop_to_name(zpool_prop_t
);
293 extern const char *zpool_prop_values(zpool_prop_t
);
296 * Pool health statistics.
300 * The following correspond to faults as defined in the (fault.fs.zfs.*)
301 * event namespace. Each is associated with a corresponding message ID.
303 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
304 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
305 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
306 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
307 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
308 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
309 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
310 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
311 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
312 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
313 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
314 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
315 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
316 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
317 ZPOOL_STATUS_ERRATA
, /* informational errata available */
320 * If the pool has unsupported features but can still be opened in
321 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
322 * pool has unsupported features but cannot be opened at all, its
323 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
325 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
326 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
329 * These faults have no corresponding message ID. At the time we are
330 * checking the status, the original reason for the FMA fault (I/O or
331 * checksum errors) has been lost.
333 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
334 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
337 * The following are not faults per se, but still an error possibly
338 * requiring administrative attention. There is no corresponding
341 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
342 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
343 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
344 ZPOOL_STATUS_OFFLINE_DEV
, /* device offline */
345 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
348 * Finally, the following indicates a healthy pool.
353 extern unsigned long get_system_hostid(void);
354 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **,
356 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **,
358 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
361 * Statistics and configuration functions.
363 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
364 extern nvlist_t
*zpool_get_features(zpool_handle_t
*);
365 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
366 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
369 * Import and export functions
371 extern int zpool_export(zpool_handle_t
*, boolean_t
, const char *);
372 extern int zpool_export_force(zpool_handle_t
*, const char *);
373 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
375 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
377 extern void zpool_print_unsup_feat(nvlist_t
*config
);
380 * Search for pools to import
383 typedef struct importargs
{
384 char **path
; /* a list of paths to search */
385 int paths
; /* number of paths to search */
386 char *poolname
; /* name of a pool to find */
387 uint64_t guid
; /* guid of a pool to find */
388 char *cachefile
; /* cachefile to use for import */
389 int can_be_active
: 1; /* can the pool be active? */
390 int unique
: 1; /* does 'poolname' already exist? */
391 int exists
: 1; /* set on return if pool already exists */
392 int scan
: 1; /* prefer scanning to libblkid cache */
395 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
397 /* legacy pool search routines */
398 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
399 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
403 * Miscellaneous pool functions
407 extern const char *zfs_history_event_names
[];
410 VDEV_NAME_PATH
= 1 << 0,
411 VDEV_NAME_GUID
= 1 << 1,
412 VDEV_NAME_FOLLOW_LINKS
= 1 << 2,
413 VDEV_NAME_TYPE_ID
= 1 << 3,
416 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
418 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
419 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
420 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
421 nvlist_t
***, uint_t
*);
422 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, unsigned,
424 extern int zpool_events_clear(libzfs_handle_t
*, int *);
425 extern int zpool_events_seek(libzfs_handle_t
*, uint64_t, int);
426 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
428 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
429 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
430 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
434 * Basic handle manipulations. These functions do not create or destroy the
435 * underlying datasets, only the references to them.
437 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
438 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
439 extern void zfs_close(zfs_handle_t
*);
440 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
441 extern const char *zfs_get_name(const zfs_handle_t
*);
442 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
445 * Property management functions. Some functions are shared with the kernel,
446 * and are found in sys/fs/zfs.h.
450 * zfs dataset property management
452 extern const char *zfs_prop_default_string(zfs_prop_t
);
453 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
454 extern const char *zfs_prop_column_name(zfs_prop_t
);
455 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
457 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
458 nvlist_t
*, uint64_t, zfs_handle_t
*, zpool_handle_t
*, const char *);
460 extern const char *zfs_prop_to_name(zfs_prop_t
);
461 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
462 extern int zfs_prop_set_list(zfs_handle_t
*, nvlist_t
*);
463 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
464 zprop_source_t
*, char *, size_t, boolean_t
);
465 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
467 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
468 zprop_source_t
*, char *, size_t);
469 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
470 uint64_t *propvalue
);
471 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
472 char *propbuf
, int proplen
, boolean_t literal
);
473 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
474 uint64_t *propvalue
);
475 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
476 char *propbuf
, int proplen
, boolean_t literal
);
477 extern int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
478 char *buf
, size_t len
);
479 extern uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
480 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
481 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
482 extern const char *zfs_prop_values(zfs_prop_t
);
483 extern int zfs_prop_is_string(zfs_prop_t prop
);
484 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
485 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
486 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
488 typedef struct zprop_list
{
491 struct zprop_list
*pl_next
;
494 size_t pl_recvd_width
;
498 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
,
500 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
502 #define ZFS_MOUNTPOINT_NONE "none"
503 #define ZFS_MOUNTPOINT_LEGACY "legacy"
505 #define ZFS_FEATURE_DISABLED "disabled"
506 #define ZFS_FEATURE_ENABLED "enabled"
507 #define ZFS_FEATURE_ACTIVE "active"
509 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
510 #define ZFS_UNSUPPORTED_READONLY "readonly"
513 * zpool property management
515 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
516 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
518 extern const char *zpool_prop_default_string(zpool_prop_t
);
519 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
520 extern const char *zpool_prop_column_name(zpool_prop_t
);
521 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
524 * Functions shared by zfs and zpool property management.
526 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
527 boolean_t ordered
, zfs_type_t type
);
528 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
530 extern void zprop_free_list(zprop_list_t
*);
532 #define ZFS_GET_NCOLS 5
544 * Functions for printing zfs or zpool properties
546 typedef struct zprop_get_cbdata
{
548 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
549 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
550 boolean_t cb_scripted
;
551 boolean_t cb_literal
;
553 zprop_list_t
*cb_proplist
;
555 } zprop_get_cbdata_t
;
557 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
558 const char *, const char *, zprop_source_t
, const char *,
562 * Iterator functions.
564 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
565 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
566 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
567 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
568 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
569 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
570 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
571 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
572 extern int zfs_iter_bookmarks(zfs_handle_t
*, zfs_iter_f
, void *);
574 typedef struct get_all_cb
{
575 zfs_handle_t
**cb_handles
;
578 boolean_t cb_verbose
;
579 int (*cb_getone
)(zfs_handle_t
*, void *);
582 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
583 int libzfs_dataset_cmp(const void *, const void *);
586 * Functions to create and destroy datasets.
588 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
590 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
591 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
592 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
593 extern int zfs_destroy_snaps_nvl(libzfs_handle_t
*, nvlist_t
*, boolean_t
);
594 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
595 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
596 extern int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
598 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
599 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
601 typedef struct sendflags
{
602 /* print informational messages (ie, -v was specified) */
605 /* recursive send (ie, -R) */
608 /* for incrementals, do all intermediate snapshots */
611 /* if dataset is a clone, do incremental from its origin */
612 boolean_t fromorigin
;
614 /* do deduplication */
617 /* send properties (ie, -p) */
620 /* do not send (no-op, ie. -n) */
623 /* parsable verbose output (ie. -P) */
626 /* show progress (ie. -v) */
629 /* large blocks (>128K) are permitted */
630 boolean_t largeblock
;
632 /* WRITE_EMBEDDED records of type DATA are permitted */
633 boolean_t embed_data
;
635 /* compressed WRITE records are permitted */
639 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
641 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
642 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
643 extern int zfs_send_one(zfs_handle_t
*, const char *, int, enum lzc_send_flags
);
644 extern int zfs_send_resume(libzfs_handle_t
*, sendflags_t
*, int outfd
,
646 extern nvlist_t
*zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
,
649 extern int zfs_promote(zfs_handle_t
*);
650 extern int zfs_hold(zfs_handle_t
*, const char *, const char *,
652 extern int zfs_hold_nvl(zfs_handle_t
*, int, nvlist_t
*);
653 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
654 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
655 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
657 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
658 uid_t rid
, uint64_t space
);
660 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
661 zfs_userspace_cb_t
, void *);
663 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
664 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
666 typedef struct recvflags
{
667 /* print informational messages (ie, -v was specified) */
670 /* the destination is a prefix, not the exact fs (ie, -d) */
674 * Only the tail of the sent snapshot path is appended to the
675 * destination to determine the received snapshot name (ie, -e).
679 /* do not actually do the recv, just check if it would work (ie, -n) */
682 /* rollback/destroy filesystems as necessary (eg, -F) */
685 /* set "canmount=off" on all modified filesystems */
686 boolean_t canmountoff
;
689 * Mark the file systems as "resumable" and do not destroy them if the
690 * receive is interrupted
694 /* byteswap flag is used internally; callers need not specify */
697 /* do not mount file systems as they are extracted (private) */
701 extern int zfs_receive(libzfs_handle_t
*, const char *, nvlist_t
*,
702 recvflags_t
*, int, avl_tree_t
*);
704 typedef enum diff_flags
{
705 ZFS_DIFF_PARSEABLE
= 0x1,
706 ZFS_DIFF_TIMESTAMP
= 0x2,
707 ZFS_DIFF_CLASSIFY
= 0x4
710 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
714 * Miscellaneous functions.
716 extern const char *zfs_type_to_name(zfs_type_t
);
717 extern void zfs_refresh_properties(zfs_handle_t
*);
718 extern int zfs_name_valid(const char *, zfs_type_t
);
719 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
720 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
722 extern int zfs_spa_version(zfs_handle_t
*, int *);
723 extern boolean_t
zfs_bookmark_exists(const char *path
);
724 extern int zfs_append_partition(char *path
, size_t max_len
);
725 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
726 extern int zfs_strcmp_pathname(char *name
, char *cmp_name
, int wholedisk
);
729 * Mount support functions.
731 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
732 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
733 extern int zfs_mount(zfs_handle_t
*, const char *, int);
734 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
735 extern int zfs_unmountall(zfs_handle_t
*, int);
738 * Share support functions.
740 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
741 extern int zfs_share(zfs_handle_t
*);
742 extern int zfs_unshare(zfs_handle_t
*);
745 * Protocol-specific share support functions.
747 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
748 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
749 extern int zfs_share_nfs(zfs_handle_t
*);
750 extern int zfs_share_smb(zfs_handle_t
*);
751 extern int zfs_shareall(zfs_handle_t
*);
752 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
753 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
754 extern int zfs_unshareall_nfs(zfs_handle_t
*);
755 extern int zfs_unshareall_smb(zfs_handle_t
*);
756 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
757 extern int zfs_unshareall(zfs_handle_t
*);
758 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
759 void *, void *, int, zfs_share_op_t
);
761 enum zfs_nicenum_format
{
762 ZFS_NICENUM_1024
= 0,
763 ZFS_NICENUM_TIME
= 1,
768 * Utility function to convert a number to a human-readable form.
770 extern void zfs_nicenum(uint64_t, char *, size_t);
771 extern void zfs_nicenum_format(uint64_t num
, char *buf
, size_t buflen
,
772 enum zfs_nicenum_format type
);
775 extern void zfs_nicetime(uint64_t, char *, size_t);
776 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
779 * Utility functions to run an external process.
781 #define STDOUT_VERBOSE 0x01
782 #define STDERR_VERBOSE 0x02
784 int libzfs_run_process(const char *, char **, int flags
);
787 * Given a device or file, determine if it is part of a pool.
789 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
793 * Label manipulation.
795 extern int zpool_read_label(int, nvlist_t
**, int *);
796 extern int zpool_clear_label(int);
799 * Management interfaces for SMB ACL files
802 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
803 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
804 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
805 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
808 * Enable and disable datasets within a pool by mounting/unmounting and
809 * sharing/unsharing them.
811 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
812 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
815 * Mappings between vdev and FRU.
817 extern void libzfs_fru_refresh(libzfs_handle_t
*);
818 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
819 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
820 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
822 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
823 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
826 * Support for Linux libudev derived persistent device strings
828 extern boolean_t
is_mpath_whole_disk(const char *);
829 extern void update_vdev_config_dev_strs(nvlist_t
*);
830 extern char *zfs_strip_partition(libzfs_handle_t
*, char *);
834 extern int zfs_device_get_devid(struct udev_device
*, char *, size_t);
835 extern int zfs_device_get_physical(struct udev_device
*, char *, size_t);
842 #endif /* _LIBZFS_H */