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 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2012 by Delphix. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
33 #include <libnvpair.h>
34 #include <sys/mnttab.h>
35 #include <sys/param.h>
36 #include <sys/types.h>
37 #include <sys/varargs.h>
38 #include <sys/fs/zfs.h>
47 * Miscellaneous ZFS constants
49 #define ZFS_MAXNAMELEN MAXNAMELEN
50 #define ZPOOL_MAXNAMELEN MAXNAMELEN
51 #define ZFS_MAXPROPLEN MAXPATHLEN
52 #define ZPOOL_MAXPROPLEN MAXPATHLEN
55 * Default device paths
57 #define DISK_ROOT "/dev"
58 #define UDISK_ROOT "/dev/disk"
60 #define DEFAULT_IMPORT_PATH_SIZE 7
61 extern char *zpool_default_import_path
[DEFAULT_IMPORT_PATH_SIZE
];
66 typedef enum zfs_error
{
67 EZFS_SUCCESS
= 0, /* no error -- success */
68 EZFS_NOMEM
= 2000, /* out of memory */
69 EZFS_BADPROP
, /* invalid property value */
70 EZFS_PROPREADONLY
, /* cannot set readonly property */
71 EZFS_PROPTYPE
, /* property does not apply to dataset type */
72 EZFS_PROPNONINHERIT
, /* property is not inheritable */
73 EZFS_PROPSPACE
, /* bad quota or reservation */
74 EZFS_BADTYPE
, /* dataset is not of appropriate type */
75 EZFS_BUSY
, /* pool or dataset is busy */
76 EZFS_EXISTS
, /* pool or dataset already exists */
77 EZFS_NOENT
, /* no such pool or dataset */
78 EZFS_BADSTREAM
, /* bad backup stream */
79 EZFS_DSREADONLY
, /* dataset is readonly */
80 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
81 EZFS_INVALIDNAME
, /* invalid dataset name */
82 EZFS_BADRESTORE
, /* unable to restore to destination */
83 EZFS_BADBACKUP
, /* backup failed */
84 EZFS_BADTARGET
, /* bad attach/detach/replace target */
85 EZFS_NODEVICE
, /* no such device in pool */
86 EZFS_BADDEV
, /* invalid device to add */
87 EZFS_NOREPLICAS
, /* no valid replicas */
88 EZFS_RESILVERING
, /* currently resilvering */
89 EZFS_BADVERSION
, /* unsupported version */
90 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
91 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
92 EZFS_BADPATH
, /* must be an absolute path */
93 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
94 EZFS_ZONED
, /* used improperly in local zone */
95 EZFS_MOUNTFAILED
, /* failed to mount dataset */
96 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
97 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
98 EZFS_SHARENFSFAILED
, /* share(1M) failed */
99 EZFS_PERM
, /* permission denied */
100 EZFS_NOSPC
, /* out of space */
101 EZFS_FAULT
, /* bad address */
102 EZFS_IO
, /* I/O error */
103 EZFS_INTR
, /* signal received */
104 EZFS_ISSPARE
, /* device is a hot spare */
105 EZFS_INVALCONFIG
, /* invalid vdev configuration */
106 EZFS_RECURSIVE
, /* recursive dependency */
107 EZFS_NOHISTORY
, /* no history object */
108 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
109 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
110 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
111 EZFS_NAMETOOLONG
, /* dataset name is too long */
112 EZFS_OPENFAILED
, /* open of device failed */
113 EZFS_NOCAP
, /* couldn't get capacity */
114 EZFS_LABELFAILED
, /* write of label failed */
115 EZFS_BADWHO
, /* invalid permission who */
116 EZFS_BADPERM
, /* invalid permission */
117 EZFS_BADPERMSET
, /* invalid permission set name */
118 EZFS_NODELEGATION
, /* delegated administration is disabled */
119 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
120 EZFS_SHARESMBFAILED
, /* failed to share over smb */
121 EZFS_BADCACHE
, /* bad cache file */
122 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
123 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
124 EZFS_NOTSUP
, /* ops not supported on this dataset */
125 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
126 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
127 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
128 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
129 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
130 EZFS_PIPEFAILED
, /* pipe create failed */
131 EZFS_THREADCREATEFAILED
, /* thread create failed */
132 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
133 EZFS_SCRUBBING
, /* currently scrubbing */
134 EZFS_NO_SCRUB
, /* no active scrub */
135 EZFS_DIFF
, /* general failure of zfs diff */
136 EZFS_DIFFDATA
, /* bad zfs diff data */
137 EZFS_POOLREADONLY
, /* pool is in read-only mode */
142 * The following data structures are all part
143 * of the zfs_allow_t data structure which is
144 * used for printing 'allow' permissions.
145 * It is a linked list of zfs_allow_t's which
146 * then contain avl tree's for user/group/sets/...
147 * and each one of the entries in those trees have
148 * avl tree's for the permissions they belong to and
149 * whether they are local,descendent or local+descendent
150 * permissions. The AVL trees are used primarily for
151 * sorting purposes, but also so that we can quickly find
152 * a given user and or permission.
154 typedef struct zfs_perm_node
{
156 char z_pname
[MAXPATHLEN
];
159 typedef struct zfs_allow_node
{
161 char z_key
[MAXPATHLEN
]; /* name, such as joe */
162 avl_tree_t z_localdescend
; /* local+descendent perms */
163 avl_tree_t z_local
; /* local permissions */
164 avl_tree_t z_descend
; /* descendent permissions */
167 typedef struct zfs_allow
{
168 struct zfs_allow
*z_next
;
169 char z_setpoint
[MAXPATHLEN
];
171 avl_tree_t z_crperms
;
174 avl_tree_t z_everyone
;
180 typedef struct zfs_handle zfs_handle_t
;
181 typedef struct zpool_handle zpool_handle_t
;
182 typedef struct libzfs_handle libzfs_handle_t
;
185 * Library initialization
187 extern libzfs_handle_t
*libzfs_init(void);
188 extern void libzfs_fini(libzfs_handle_t
*);
190 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
191 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
193 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
195 extern void zfs_save_arguments(int argc
, char **, char *, int);
196 extern int zpool_log_history(libzfs_handle_t
*, const char *);
198 extern int libzfs_errno(libzfs_handle_t
*);
199 extern const char *libzfs_error_action(libzfs_handle_t
*);
200 extern const char *libzfs_error_description(libzfs_handle_t
*);
201 extern void libzfs_mnttab_init(libzfs_handle_t
*);
202 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
203 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
204 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
206 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
207 const char *, const char *);
208 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
211 * Basic handle functions
213 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
214 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
215 extern void zpool_close(zpool_handle_t
*);
216 extern const char *zpool_get_name(zpool_handle_t
*);
217 extern int zpool_get_state(zpool_handle_t
*);
218 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
219 extern const char *zpool_pool_state_to_name(pool_state_t
);
220 extern void zpool_free_handles(libzfs_handle_t
*);
223 * Iterate over all active pools in the system.
225 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
226 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
229 * Functions to create and destroy pools
231 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
232 nvlist_t
*, nvlist_t
*);
233 extern int zpool_destroy(zpool_handle_t
*, const char *);
234 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
236 typedef struct splitflags
{
237 /* do not split, but return the config that would be split off */
240 /* after splitting, import the pool */
245 * Functions to manipulate pool and vdev state
247 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
);
248 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
249 extern int zpool_reguid(zpool_handle_t
*);
250 extern int zpool_reopen(zpool_handle_t
*);
252 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
254 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
255 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
256 const char *, nvlist_t
*, int);
257 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
258 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
259 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
262 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
263 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
264 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
266 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
267 boolean_t
*, boolean_t
*);
268 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
269 boolean_t
*, boolean_t
*, boolean_t
*);
270 extern int zpool_label_disk_wait(char *, int);
271 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
274 * Functions to manage pool properties
276 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
277 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
278 size_t proplen
, zprop_source_t
*);
279 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
282 extern const char *zpool_prop_to_name(zpool_prop_t
);
283 extern const char *zpool_prop_values(zpool_prop_t
);
286 * Pool health statistics.
290 * The following correspond to faults as defined in the (fault.fs.zfs.*)
291 * event namespace. Each is associated with a corresponding message ID.
293 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
294 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
295 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
296 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
297 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
298 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
299 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
300 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
301 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
302 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
303 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
304 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
305 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
306 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
309 * If the pool has unsupported features but can still be opened in
310 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
311 * pool has unsupported features but cannot be opened at all, its
312 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
314 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
315 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
318 * These faults have no corresponding message ID. At the time we are
319 * checking the status, the original reason for the FMA fault (I/O or
320 * checksum errors) has been lost.
322 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
323 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
326 * The following are not faults per se, but still an error possibly
327 * requiring administrative attention. There is no corresponding
330 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
331 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
332 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
333 ZPOOL_STATUS_OFFLINE_DEV
, /* device online */
334 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
337 * Finally, the following indicates a healthy pool.
342 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **);
343 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **);
344 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
347 * Statistics and configuration functions.
349 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
350 extern nvlist_t
*zpool_get_features(zpool_handle_t
*);
351 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
352 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
355 * Import and export functions
357 extern int zpool_export(zpool_handle_t
*, boolean_t
, const char *);
358 extern int zpool_export_force(zpool_handle_t
*, const char *);
359 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
361 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
363 extern void zpool_print_unsup_feat(nvlist_t
*config
);
366 * Search for pools to import
369 typedef struct importargs
{
370 char **path
; /* a list of paths to search */
371 int paths
; /* number of paths to search */
372 char *poolname
; /* name of a pool to find */
373 uint64_t guid
; /* guid of a pool to find */
374 char *cachefile
; /* cachefile to use for import */
375 int can_be_active
: 1; /* can the pool be active? */
376 int unique
: 1; /* does 'poolname' already exist? */
377 int exists
: 1; /* set on return if pool already exists */
380 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
382 /* legacy pool search routines */
383 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
384 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
388 * Miscellaneous pool functions
392 extern const char *zfs_history_event_names
[];
394 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
396 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
397 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
398 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
399 nvlist_t
***, uint_t
*);
400 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, int, int);
401 extern int zpool_events_clear(libzfs_handle_t
*, int *);
402 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
404 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
405 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
406 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
410 * Basic handle manipulations. These functions do not create or destroy the
411 * underlying datasets, only the references to them.
413 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
414 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
415 extern void zfs_close(zfs_handle_t
*);
416 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
417 extern const char *zfs_get_name(const zfs_handle_t
*);
418 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
421 * Property management functions. Some functions are shared with the kernel,
422 * and are found in sys/fs/zfs.h.
426 * zfs dataset property management
428 extern const char *zfs_prop_default_string(zfs_prop_t
);
429 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
430 extern const char *zfs_prop_column_name(zfs_prop_t
);
431 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
433 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
434 nvlist_t
*, uint64_t, zfs_handle_t
*, const char *);
436 extern const char *zfs_prop_to_name(zfs_prop_t
);
437 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
438 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
439 zprop_source_t
*, char *, size_t, boolean_t
);
440 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
442 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
443 zprop_source_t
*, char *, size_t);
444 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
445 uint64_t *propvalue
);
446 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
447 char *propbuf
, int proplen
, boolean_t literal
);
448 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
449 uint64_t *propvalue
);
450 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
451 char *propbuf
, int proplen
, boolean_t literal
);
452 extern int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
453 char *buf
, size_t len
);
454 extern uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
455 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
456 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
457 extern const char *zfs_prop_values(zfs_prop_t
);
458 extern int zfs_prop_is_string(zfs_prop_t prop
);
459 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
460 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
461 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
463 typedef struct zprop_list
{
466 struct zprop_list
*pl_next
;
469 size_t pl_recvd_width
;
473 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
);
474 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
476 #define ZFS_MOUNTPOINT_NONE "none"
477 #define ZFS_MOUNTPOINT_LEGACY "legacy"
479 #define ZFS_FEATURE_DISABLED "disabled"
480 #define ZFS_FEATURE_ENABLED "enabled"
481 #define ZFS_FEATURE_ACTIVE "active"
483 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
484 #define ZFS_UNSUPPORTED_READONLY "readonly"
487 * zpool property management
489 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
490 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
492 extern const char *zpool_prop_default_string(zpool_prop_t
);
493 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
494 extern const char *zpool_prop_column_name(zpool_prop_t
);
495 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
498 * Functions shared by zfs and zpool property management.
500 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
501 boolean_t ordered
, zfs_type_t type
);
502 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
504 extern void zprop_free_list(zprop_list_t
*);
506 #define ZFS_GET_NCOLS 5
518 * Functions for printing zfs or zpool properties
520 typedef struct zprop_get_cbdata
{
522 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
523 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
524 boolean_t cb_scripted
;
525 boolean_t cb_literal
;
527 zprop_list_t
*cb_proplist
;
529 } zprop_get_cbdata_t
;
531 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
532 const char *, const char *, zprop_source_t
, const char *,
536 * Iterator functions.
538 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
539 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
540 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
541 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
542 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
543 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
544 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
545 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
547 typedef struct get_all_cb
{
548 zfs_handle_t
**cb_handles
;
551 boolean_t cb_verbose
;
552 int (*cb_getone
)(zfs_handle_t
*, void *);
555 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
556 int libzfs_dataset_cmp(const void *, const void *);
559 * Functions to create and destroy datasets.
561 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
563 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
564 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
565 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
566 extern int zfs_destroy_snaps_nvl(zfs_handle_t
*, nvlist_t
*, boolean_t
);
567 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
568 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
569 extern int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
571 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
572 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
574 typedef struct sendflags
{
575 /* print informational messages (ie, -v was specified) */
578 /* recursive send (ie, -R) */
581 /* for incrementals, do all intermediate snapshots */
584 /* if dataset is a clone, do incremental from its origin */
585 boolean_t fromorigin
;
587 /* do deduplication */
590 /* send properties (ie, -p) */
593 /* do not send (no-op, ie. -n) */
596 /* parsable verbose output (ie. -P) */
599 /* show progress (ie. -v) */
603 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
605 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
606 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
608 extern int zfs_promote(zfs_handle_t
*);
609 extern int zfs_hold(zfs_handle_t
*, const char *, const char *, boolean_t
,
610 boolean_t
, boolean_t
, int, uint64_t, uint64_t);
611 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
612 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
613 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
615 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
616 uid_t rid
, uint64_t space
);
618 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
619 zfs_userspace_cb_t
, void *);
621 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
622 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
624 typedef struct recvflags
{
625 /* print informational messages (ie, -v was specified) */
628 /* the destination is a prefix, not the exact fs (ie, -d) */
632 * Only the tail of the sent snapshot path is appended to the
633 * destination to determine the received snapshot name (ie, -e).
637 /* do not actually do the recv, just check if it would work (ie, -n) */
640 /* rollback/destroy filesystems as necessary (eg, -F) */
643 /* set "canmount=off" on all modified filesystems */
644 boolean_t canmountoff
;
646 /* byteswap flag is used internally; callers need not specify */
649 /* do not mount file systems as they are extracted (private) */
653 extern int zfs_receive(libzfs_handle_t
*, const char *, recvflags_t
*,
656 typedef enum diff_flags
{
657 ZFS_DIFF_PARSEABLE
= 0x1,
658 ZFS_DIFF_TIMESTAMP
= 0x2,
659 ZFS_DIFF_CLASSIFY
= 0x4
662 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
666 * Miscellaneous functions.
668 extern const char *zfs_type_to_name(zfs_type_t
);
669 extern void zfs_refresh_properties(zfs_handle_t
*);
670 extern int zfs_name_valid(const char *, zfs_type_t
);
671 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
672 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
674 extern int zfs_spa_version(zfs_handle_t
*, int *);
675 extern int zfs_append_partition(char *path
, size_t max_len
);
676 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
677 extern int zfs_strcmp_pathname(char *name
, char *cmp_name
, int wholedisk
);
680 * Mount support functions.
682 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
683 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
684 extern int zfs_mount(zfs_handle_t
*, const char *, int);
685 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
686 extern int zfs_unmountall(zfs_handle_t
*, int);
689 * Share support functions.
691 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
692 extern int zfs_share(zfs_handle_t
*);
693 extern int zfs_unshare(zfs_handle_t
*);
696 * Protocol-specific share support functions.
698 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
699 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
700 extern int zfs_share_nfs(zfs_handle_t
*);
701 extern int zfs_share_smb(zfs_handle_t
*);
702 extern int zfs_shareall(zfs_handle_t
*);
703 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
704 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
705 extern int zfs_unshareall_nfs(zfs_handle_t
*);
706 extern int zfs_unshareall_smb(zfs_handle_t
*);
707 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
708 extern int zfs_unshareall(zfs_handle_t
*);
709 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
710 void *, void *, int, zfs_share_op_t
);
713 * Utility function to convert a number to a human-readable form.
715 extern void zfs_nicenum(uint64_t, char *, size_t);
716 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
719 * Utility functions to run an external process.
721 #define STDOUT_VERBOSE 0x01
722 #define STDERR_VERBOSE 0x02
724 int libzfs_run_process(const char *, char **, int flags
);
725 int libzfs_load_module(const char *);
728 * Given a device or file, determine if it is part of a pool.
730 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
734 * Label manipulation.
736 extern int zpool_read_label(int, nvlist_t
**);
737 extern int zpool_clear_label(int);
740 * Management interfaces for SMB ACL files
743 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
744 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
745 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
746 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
749 * Enable and disable datasets within a pool by mounting/unmounting and
750 * sharing/unsharing them.
752 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
753 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
756 * Mappings between vdev and FRU.
758 extern void libzfs_fru_refresh(libzfs_handle_t
*);
759 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
760 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
761 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
763 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
764 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
770 #endif /* _LIBZFS_H */