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, 2014 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.
34 #include <libnvpair.h>
35 #include <sys/mnttab.h>
36 #include <sys/param.h>
37 #include <sys/types.h>
38 #include <sys/varargs.h>
39 #include <sys/fs/zfs.h>
42 #include <libzfs_core.h>
49 * Miscellaneous ZFS constants
51 #define ZFS_MAXNAMELEN MAXNAMELEN
52 #define ZPOOL_MAXNAMELEN MAXNAMELEN
53 #define ZFS_MAXPROPLEN MAXPATHLEN
54 #define ZPOOL_MAXPROPLEN MAXPATHLEN
57 * Default device paths
59 #define DISK_ROOT "/dev"
60 #define UDISK_ROOT "/dev/disk"
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 7
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 */
254 * Functions to manipulate pool and vdev state
256 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
);
257 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
258 extern int zpool_reguid(zpool_handle_t
*);
259 extern int zpool_reopen(zpool_handle_t
*);
261 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
263 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
264 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
265 const char *, nvlist_t
*, int);
266 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
267 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
268 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
271 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
272 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
273 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
275 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
276 boolean_t
*, boolean_t
*);
277 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
278 boolean_t
*, boolean_t
*, boolean_t
*);
279 extern int zpool_label_disk_wait(char *, int);
280 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
283 * Functions to manage pool properties
285 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
286 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
287 size_t proplen
, zprop_source_t
*);
288 extern int zpool_get_prop_literal(zpool_handle_t
*, zpool_prop_t
, char *,
289 size_t proplen
, zprop_source_t
*, boolean_t literal
);
290 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
293 extern const char *zpool_prop_to_name(zpool_prop_t
);
294 extern const char *zpool_prop_values(zpool_prop_t
);
297 * Pool health statistics.
301 * The following correspond to faults as defined in the (fault.fs.zfs.*)
302 * event namespace. Each is associated with a corresponding message ID.
304 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
305 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
306 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
307 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
308 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
309 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
310 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
311 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
312 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
313 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
314 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
315 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
316 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
317 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
318 ZPOOL_STATUS_ERRATA
, /* informational errata available */
321 * If the pool has unsupported features but can still be opened in
322 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
323 * pool has unsupported features but cannot be opened at all, its
324 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
326 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
327 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
330 * These faults have no corresponding message ID. At the time we are
331 * checking the status, the original reason for the FMA fault (I/O or
332 * checksum errors) has been lost.
334 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
335 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
338 * The following are not faults per se, but still an error possibly
339 * requiring administrative attention. There is no corresponding
342 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
343 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
344 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
345 ZPOOL_STATUS_OFFLINE_DEV
, /* device online */
346 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
349 * Finally, the following indicates a healthy pool.
354 extern unsigned long get_system_hostid(void);
355 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **,
357 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **,
359 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
362 * Statistics and configuration functions.
364 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
365 extern nvlist_t
*zpool_get_features(zpool_handle_t
*);
366 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
367 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
370 * Import and export functions
372 extern int zpool_export(zpool_handle_t
*, boolean_t
, const char *);
373 extern int zpool_export_force(zpool_handle_t
*, const char *);
374 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
376 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
378 extern void zpool_print_unsup_feat(nvlist_t
*config
);
381 * Search for pools to import
384 typedef struct importargs
{
385 char **path
; /* a list of paths to search */
386 int paths
; /* number of paths to search */
387 char *poolname
; /* name of a pool to find */
388 uint64_t guid
; /* guid of a pool to find */
389 char *cachefile
; /* cachefile to use for import */
390 int can_be_active
: 1; /* can the pool be active? */
391 int unique
: 1; /* does 'poolname' already exist? */
392 int exists
: 1; /* set on return if pool already exists */
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
[];
409 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
411 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
412 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
413 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
414 nvlist_t
***, uint_t
*);
415 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, unsigned,
417 extern int zpool_events_clear(libzfs_handle_t
*, int *);
418 extern int zpool_events_seek(libzfs_handle_t
*, uint64_t, int);
419 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
421 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
422 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
423 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
427 * Basic handle manipulations. These functions do not create or destroy the
428 * underlying datasets, only the references to them.
430 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
431 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
432 extern void zfs_close(zfs_handle_t
*);
433 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
434 extern const char *zfs_get_name(const zfs_handle_t
*);
435 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
438 * Property management functions. Some functions are shared with the kernel,
439 * and are found in sys/fs/zfs.h.
443 * zfs dataset property management
445 extern const char *zfs_prop_default_string(zfs_prop_t
);
446 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
447 extern const char *zfs_prop_column_name(zfs_prop_t
);
448 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
450 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
451 nvlist_t
*, uint64_t, zfs_handle_t
*, const char *);
453 extern const char *zfs_prop_to_name(zfs_prop_t
);
454 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
455 extern int zfs_prop_set_list(zfs_handle_t
*, nvlist_t
*);
456 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
457 zprop_source_t
*, char *, size_t, boolean_t
);
458 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
460 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
461 zprop_source_t
*, char *, size_t);
462 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
463 uint64_t *propvalue
);
464 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
465 char *propbuf
, int proplen
, boolean_t literal
);
466 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
467 uint64_t *propvalue
);
468 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
469 char *propbuf
, int proplen
, boolean_t literal
);
470 extern int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
471 char *buf
, size_t len
);
472 extern uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
473 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
474 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
475 extern const char *zfs_prop_values(zfs_prop_t
);
476 extern int zfs_prop_is_string(zfs_prop_t prop
);
477 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
478 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
479 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
481 typedef struct zprop_list
{
484 struct zprop_list
*pl_next
;
487 size_t pl_recvd_width
;
491 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
,
493 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
495 #define ZFS_MOUNTPOINT_NONE "none"
496 #define ZFS_MOUNTPOINT_LEGACY "legacy"
498 #define ZFS_FEATURE_DISABLED "disabled"
499 #define ZFS_FEATURE_ENABLED "enabled"
500 #define ZFS_FEATURE_ACTIVE "active"
502 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
503 #define ZFS_UNSUPPORTED_READONLY "readonly"
506 * zpool property management
508 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
509 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
511 extern const char *zpool_prop_default_string(zpool_prop_t
);
512 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
513 extern const char *zpool_prop_column_name(zpool_prop_t
);
514 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
517 * Functions shared by zfs and zpool property management.
519 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
520 boolean_t ordered
, zfs_type_t type
);
521 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
523 extern void zprop_free_list(zprop_list_t
*);
525 #define ZFS_GET_NCOLS 5
537 * Functions for printing zfs or zpool properties
539 typedef struct zprop_get_cbdata
{
541 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
542 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
543 boolean_t cb_scripted
;
544 boolean_t cb_literal
;
546 zprop_list_t
*cb_proplist
;
548 } zprop_get_cbdata_t
;
550 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
551 const char *, const char *, zprop_source_t
, const char *,
555 * Iterator functions.
557 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
558 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
559 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
560 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
561 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
562 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
563 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
564 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
565 extern int zfs_iter_bookmarks(zfs_handle_t
*, zfs_iter_f
, void *);
567 typedef struct get_all_cb
{
568 zfs_handle_t
**cb_handles
;
571 boolean_t cb_verbose
;
572 int (*cb_getone
)(zfs_handle_t
*, void *);
575 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
576 int libzfs_dataset_cmp(const void *, const void *);
579 * Functions to create and destroy datasets.
581 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
583 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
584 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
585 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
586 extern int zfs_destroy_snaps_nvl(libzfs_handle_t
*, nvlist_t
*, boolean_t
);
587 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
588 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
589 extern int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
591 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
592 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
594 typedef struct sendflags
{
595 /* print informational messages (ie, -v was specified) */
598 /* recursive send (ie, -R) */
601 /* for incrementals, do all intermediate snapshots */
604 /* if dataset is a clone, do incremental from its origin */
605 boolean_t fromorigin
;
607 /* do deduplication */
610 /* send properties (ie, -p) */
613 /* do not send (no-op, ie. -n) */
616 /* parsable verbose output (ie. -P) */
619 /* show progress (ie. -v) */
622 /* large blocks (>128K) are permitted */
623 boolean_t largeblock
;
625 /* WRITE_EMBEDDED records of type DATA are permitted */
626 boolean_t embed_data
;
629 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
631 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
632 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
633 extern int zfs_send_one(zfs_handle_t
*, const char *, int, enum lzc_send_flags
);
635 extern int zfs_promote(zfs_handle_t
*);
636 extern int zfs_hold(zfs_handle_t
*, const char *, const char *,
638 extern int zfs_hold_nvl(zfs_handle_t
*, int, nvlist_t
*);
639 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
640 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
641 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
643 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
644 uid_t rid
, uint64_t space
);
646 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
647 zfs_userspace_cb_t
, void *);
649 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
650 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
652 typedef struct recvflags
{
653 /* print informational messages (ie, -v was specified) */
656 /* the destination is a prefix, not the exact fs (ie, -d) */
660 * Only the tail of the sent snapshot path is appended to the
661 * destination to determine the received snapshot name (ie, -e).
665 /* do not actually do the recv, just check if it would work (ie, -n) */
668 /* rollback/destroy filesystems as necessary (eg, -F) */
671 /* set "canmount=off" on all modified filesystems */
672 boolean_t canmountoff
;
674 /* byteswap flag is used internally; callers need not specify */
677 /* do not mount file systems as they are extracted (private) */
681 extern int zfs_receive(libzfs_handle_t
*, const char *, nvlist_t
*,
682 recvflags_t
*, int, avl_tree_t
*);
684 typedef enum diff_flags
{
685 ZFS_DIFF_PARSEABLE
= 0x1,
686 ZFS_DIFF_TIMESTAMP
= 0x2,
687 ZFS_DIFF_CLASSIFY
= 0x4
690 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
694 * Miscellaneous functions.
696 extern const char *zfs_type_to_name(zfs_type_t
);
697 extern void zfs_refresh_properties(zfs_handle_t
*);
698 extern int zfs_name_valid(const char *, zfs_type_t
);
699 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
700 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
702 extern int zfs_spa_version(zfs_handle_t
*, int *);
703 extern boolean_t
zfs_bookmark_exists(const char *path
);
704 extern int zfs_append_partition(char *path
, size_t max_len
);
705 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
706 extern int zfs_strcmp_pathname(char *name
, char *cmp_name
, int wholedisk
);
709 * Mount support functions.
711 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
712 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
713 extern int zfs_mount(zfs_handle_t
*, const char *, int);
714 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
715 extern int zfs_unmountall(zfs_handle_t
*, int);
718 * Share support functions.
720 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
721 extern int zfs_share(zfs_handle_t
*);
722 extern int zfs_unshare(zfs_handle_t
*);
725 * Protocol-specific share support functions.
727 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
728 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
729 extern int zfs_share_nfs(zfs_handle_t
*);
730 extern int zfs_share_smb(zfs_handle_t
*);
731 extern int zfs_shareall(zfs_handle_t
*);
732 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
733 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
734 extern int zfs_unshareall_nfs(zfs_handle_t
*);
735 extern int zfs_unshareall_smb(zfs_handle_t
*);
736 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
737 extern int zfs_unshareall(zfs_handle_t
*);
738 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
739 void *, void *, int, zfs_share_op_t
);
742 * Utility function to convert a number to a human-readable form.
744 extern void zfs_nicenum(uint64_t, char *, size_t);
745 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
748 * Utility functions to run an external process.
750 #define STDOUT_VERBOSE 0x01
751 #define STDERR_VERBOSE 0x02
753 int libzfs_run_process(const char *, char **, int flags
);
756 * Given a device or file, determine if it is part of a pool.
758 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
762 * Label manipulation.
764 extern int zpool_read_label(int, nvlist_t
**, int *);
765 extern int zpool_clear_label(int);
768 * Management interfaces for SMB ACL files
771 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
772 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
773 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
774 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
777 * Enable and disable datasets within a pool by mounting/unmounting and
778 * sharing/unsharing them.
780 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
781 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
784 * Mappings between vdev and FRU.
786 extern void libzfs_fru_refresh(libzfs_handle_t
*);
787 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
788 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
789 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
791 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
792 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
798 #endif /* _LIBZFS_H */