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
];
67 EZFS_NOMEM
= 2000, /* out of memory */
68 EZFS_BADPROP
, /* invalid property value */
69 EZFS_PROPREADONLY
, /* cannot set readonly property */
70 EZFS_PROPTYPE
, /* property does not apply to dataset type */
71 EZFS_PROPNONINHERIT
, /* property is not inheritable */
72 EZFS_PROPSPACE
, /* bad quota or reservation */
73 EZFS_BADTYPE
, /* dataset is not of appropriate type */
74 EZFS_BUSY
, /* pool or dataset is busy */
75 EZFS_EXISTS
, /* pool or dataset already exists */
76 EZFS_NOENT
, /* no such pool or dataset */
77 EZFS_BADSTREAM
, /* bad backup stream */
78 EZFS_DSREADONLY
, /* dataset is readonly */
79 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
80 EZFS_INVALIDNAME
, /* invalid dataset name */
81 EZFS_BADRESTORE
, /* unable to restore to destination */
82 EZFS_BADBACKUP
, /* backup failed */
83 EZFS_BADTARGET
, /* bad attach/detach/replace target */
84 EZFS_NODEVICE
, /* no such device in pool */
85 EZFS_BADDEV
, /* invalid device to add */
86 EZFS_NOREPLICAS
, /* no valid replicas */
87 EZFS_RESILVERING
, /* currently resilvering */
88 EZFS_BADVERSION
, /* unsupported version */
89 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
90 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
91 EZFS_BADPATH
, /* must be an absolute path */
92 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
93 EZFS_ZONED
, /* used improperly in local zone */
94 EZFS_MOUNTFAILED
, /* failed to mount dataset */
95 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
96 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
97 EZFS_SHARENFSFAILED
, /* share(1M) failed */
98 EZFS_PERM
, /* permission denied */
99 EZFS_NOSPC
, /* out of space */
100 EZFS_FAULT
, /* bad address */
101 EZFS_IO
, /* I/O error */
102 EZFS_INTR
, /* signal received */
103 EZFS_ISSPARE
, /* device is a hot spare */
104 EZFS_INVALCONFIG
, /* invalid vdev configuration */
105 EZFS_RECURSIVE
, /* recursive dependency */
106 EZFS_NOHISTORY
, /* no history object */
107 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
108 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
109 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
110 EZFS_NAMETOOLONG
, /* dataset name is too long */
111 EZFS_OPENFAILED
, /* open of device failed */
112 EZFS_NOCAP
, /* couldn't get capacity */
113 EZFS_LABELFAILED
, /* write of label failed */
114 EZFS_BADWHO
, /* invalid permission who */
115 EZFS_BADPERM
, /* invalid permission */
116 EZFS_BADPERMSET
, /* invalid permission set name */
117 EZFS_NODELEGATION
, /* delegated administration is disabled */
118 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
119 EZFS_SHARESMBFAILED
, /* failed to share over smb */
120 EZFS_BADCACHE
, /* bad cache file */
121 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
122 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
123 EZFS_NOTSUP
, /* ops not supported on this dataset */
124 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
125 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
126 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
127 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
128 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
129 EZFS_PIPEFAILED
, /* pipe create failed */
130 EZFS_THREADCREATEFAILED
, /* thread create failed */
131 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
132 EZFS_SCRUBBING
, /* currently scrubbing */
133 EZFS_NO_SCRUB
, /* no active scrub */
134 EZFS_DIFF
, /* general failure of zfs diff */
135 EZFS_DIFFDATA
, /* bad zfs diff data */
136 EZFS_POOLREADONLY
, /* pool is in read-only mode */
141 * The following data structures are all part
142 * of the zfs_allow_t data structure which is
143 * used for printing 'allow' permissions.
144 * It is a linked list of zfs_allow_t's which
145 * then contain avl tree's for user/group/sets/...
146 * and each one of the entries in those trees have
147 * avl tree's for the permissions they belong to and
148 * whether they are local,descendent or local+descendent
149 * permissions. The AVL trees are used primarily for
150 * sorting purposes, but also so that we can quickly find
151 * a given user and or permission.
153 typedef struct zfs_perm_node
{
155 char z_pname
[MAXPATHLEN
];
158 typedef struct zfs_allow_node
{
160 char z_key
[MAXPATHLEN
]; /* name, such as joe */
161 avl_tree_t z_localdescend
; /* local+descendent perms */
162 avl_tree_t z_local
; /* local permissions */
163 avl_tree_t z_descend
; /* descendent permissions */
166 typedef struct zfs_allow
{
167 struct zfs_allow
*z_next
;
168 char z_setpoint
[MAXPATHLEN
];
170 avl_tree_t z_crperms
;
173 avl_tree_t z_everyone
;
179 typedef struct zfs_handle zfs_handle_t
;
180 typedef struct zpool_handle zpool_handle_t
;
181 typedef struct libzfs_handle libzfs_handle_t
;
184 * Library initialization
186 extern libzfs_handle_t
*libzfs_init(void);
187 extern void libzfs_fini(libzfs_handle_t
*);
189 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
190 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
192 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
194 extern int libzfs_errno(libzfs_handle_t
*);
195 extern const char *libzfs_error_action(libzfs_handle_t
*);
196 extern const char *libzfs_error_description(libzfs_handle_t
*);
197 extern void libzfs_mnttab_init(libzfs_handle_t
*);
198 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
199 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
200 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
202 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
203 const char *, const char *);
204 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
207 * Basic handle functions
209 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
210 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
211 extern void zpool_close(zpool_handle_t
*);
212 extern const char *zpool_get_name(zpool_handle_t
*);
213 extern int zpool_get_state(zpool_handle_t
*);
214 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
215 extern const char *zpool_pool_state_to_name(pool_state_t
);
216 extern void zpool_free_handles(libzfs_handle_t
*);
219 * Iterate over all active pools in the system.
221 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
222 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
225 * Functions to create and destroy pools
227 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
228 nvlist_t
*, nvlist_t
*);
229 extern int zpool_destroy(zpool_handle_t
*);
230 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
232 typedef struct splitflags
{
233 /* do not split, but return the config that would be split off */
236 /* after splitting, import the pool */
241 * Functions to manipulate pool and vdev state
243 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
);
244 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
245 extern int zpool_reguid(zpool_handle_t
*);
246 extern int zpool_reopen(zpool_handle_t
*);
248 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
250 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
251 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
252 const char *, nvlist_t
*, int);
253 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
254 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
255 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
258 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
259 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
260 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
262 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
263 boolean_t
*, boolean_t
*);
264 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
265 boolean_t
*, boolean_t
*, boolean_t
*);
266 extern int zpool_label_disk_wait(char *, int);
267 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
270 * Functions to manage pool properties
272 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
273 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
274 size_t proplen
, zprop_source_t
*);
275 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
278 extern const char *zpool_prop_to_name(zpool_prop_t
);
279 extern const char *zpool_prop_values(zpool_prop_t
);
282 * Pool health statistics.
286 * The following correspond to faults as defined in the (fault.fs.zfs.*)
287 * event namespace. Each is associated with a corresponding message ID.
289 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
290 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
291 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
292 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
293 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
294 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
295 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
296 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
297 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
298 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
299 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
300 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
301 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
302 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
305 * If the pool has unsupported features but can still be opened in
306 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
307 * pool has unsupported features but cannot be opened at all, its
308 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
310 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
311 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
314 * These faults have no corresponding message ID. At the time we are
315 * checking the status, the original reason for the FMA fault (I/O or
316 * checksum errors) has been lost.
318 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
319 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
322 * The following are not faults per se, but still an error possibly
323 * requiring administrative attention. There is no corresponding
326 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
327 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
328 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
329 ZPOOL_STATUS_OFFLINE_DEV
, /* device online */
330 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
333 * Finally, the following indicates a healthy pool.
338 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **);
339 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **);
340 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
343 * Statistics and configuration functions.
345 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
346 extern nvlist_t
*zpool_get_features(zpool_handle_t
*);
347 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
348 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
351 * Import and export functions
353 extern int zpool_export(zpool_handle_t
*, boolean_t
);
354 extern int zpool_export_force(zpool_handle_t
*);
355 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
357 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
359 extern void zpool_print_unsup_feat(nvlist_t
*config
);
362 * Search for pools to import
365 typedef struct importargs
{
366 char **path
; /* a list of paths to search */
367 int paths
; /* number of paths to search */
368 char *poolname
; /* name of a pool to find */
369 uint64_t guid
; /* guid of a pool to find */
370 char *cachefile
; /* cachefile to use for import */
371 int can_be_active
: 1; /* can the pool be active? */
372 int unique
: 1; /* does 'poolname' already exist? */
373 int exists
: 1; /* set on return if pool already exists */
376 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
378 /* legacy pool search routines */
379 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
380 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
384 * Miscellaneous pool functions
388 extern const char *zfs_history_event_names
[LOG_END
];
390 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
392 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
393 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
394 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
395 nvlist_t
***, uint_t
*);
396 extern void zpool_set_history_str(const char *subcommand
, int argc
,
397 char **argv
, char *history_str
);
398 extern int zpool_stage_history(libzfs_handle_t
*, const char *);
399 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, int, int);
400 extern int zpool_events_clear(libzfs_handle_t
*, int *);
401 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
403 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
404 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
405 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
409 * Basic handle manipulations. These functions do not create or destroy the
410 * underlying datasets, only the references to them.
412 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
413 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
414 extern void zfs_close(zfs_handle_t
*);
415 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
416 extern const char *zfs_get_name(const zfs_handle_t
*);
417 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
420 * Property management functions. Some functions are shared with the kernel,
421 * and are found in sys/fs/zfs.h.
425 * zfs dataset property management
427 extern const char *zfs_prop_default_string(zfs_prop_t
);
428 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
429 extern const char *zfs_prop_column_name(zfs_prop_t
);
430 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
432 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
433 nvlist_t
*, uint64_t, zfs_handle_t
*, const char *);
435 extern const char *zfs_prop_to_name(zfs_prop_t
);
436 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
437 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
438 zprop_source_t
*, char *, size_t, boolean_t
);
439 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
441 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
442 zprop_source_t
*, char *, size_t);
443 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
444 uint64_t *propvalue
);
445 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
446 char *propbuf
, int proplen
, boolean_t literal
);
447 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
448 uint64_t *propvalue
);
449 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
450 char *propbuf
, int proplen
, boolean_t literal
);
451 extern int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
452 char *buf
, size_t len
);
453 extern int zfs_get_snapused_int(zfs_handle_t
*firstsnap
, zfs_handle_t
*lastsnap
,
455 extern uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
456 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
457 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
458 extern const char *zfs_prop_values(zfs_prop_t
);
459 extern int zfs_prop_is_string(zfs_prop_t prop
);
460 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
461 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
462 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
464 typedef struct zprop_list
{
467 struct zprop_list
*pl_next
;
470 size_t pl_recvd_width
;
474 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
);
475 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
477 #define ZFS_MOUNTPOINT_NONE "none"
478 #define ZFS_MOUNTPOINT_LEGACY "legacy"
480 #define ZFS_FEATURE_DISABLED "disabled"
481 #define ZFS_FEATURE_ENABLED "enabled"
482 #define ZFS_FEATURE_ACTIVE "active"
484 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
485 #define ZFS_UNSUPPORTED_READONLY "readonly"
488 * zpool property management
490 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
491 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
493 extern const char *zpool_prop_default_string(zpool_prop_t
);
494 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
495 extern const char *zpool_prop_column_name(zpool_prop_t
);
496 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
499 * Functions shared by zfs and zpool property management.
501 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
502 boolean_t ordered
, zfs_type_t type
);
503 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
505 extern void zprop_free_list(zprop_list_t
*);
507 #define ZFS_GET_NCOLS 5
519 * Functions for printing zfs or zpool properties
521 typedef struct zprop_get_cbdata
{
523 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
524 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
525 boolean_t cb_scripted
;
526 boolean_t cb_literal
;
528 zprop_list_t
*cb_proplist
;
530 } zprop_get_cbdata_t
;
532 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
533 const char *, const char *, zprop_source_t
, const char *,
537 * Iterator functions.
539 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
540 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
541 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
542 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
543 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
544 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
545 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
546 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
548 typedef struct get_all_cb
{
549 zfs_handle_t
**cb_handles
;
552 boolean_t cb_verbose
;
553 int (*cb_getone
)(zfs_handle_t
*, void *);
556 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
557 int libzfs_dataset_cmp(const void *, const void *);
560 * Functions to create and destroy datasets.
562 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
564 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
565 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
566 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
567 extern int zfs_destroy_snaps_nvl(zfs_handle_t
*, nvlist_t
*, boolean_t
);
568 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
569 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
570 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
571 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
573 typedef struct sendflags
{
574 /* print informational messages (ie, -v was specified) */
577 /* recursive send (ie, -R) */
580 /* for incrementals, do all intermediate snapshots */
583 /* if dataset is a clone, do incremental from its origin */
584 boolean_t fromorigin
;
586 /* do deduplication */
589 /* send properties (ie, -p) */
592 /* do not send (no-op, ie. -n) */
595 /* parsable verbose output (ie. -P) */
598 /* show progress (ie. -v) */
602 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
604 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
605 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
607 extern int zfs_promote(zfs_handle_t
*);
608 extern int zfs_hold(zfs_handle_t
*, const char *, const char *, boolean_t
,
609 boolean_t
, boolean_t
, int, uint64_t, uint64_t);
610 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
611 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
612 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
614 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
615 uid_t rid
, uint64_t space
);
617 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
618 zfs_userspace_cb_t
, void *);
620 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
621 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
623 typedef struct recvflags
{
624 /* print informational messages (ie, -v was specified) */
627 /* the destination is a prefix, not the exact fs (ie, -d) */
631 * Only the tail of the sent snapshot path is appended to the
632 * destination to determine the received snapshot name (ie, -e).
636 /* do not actually do the recv, just check if it would work (ie, -n) */
639 /* rollback/destroy filesystems as necessary (eg, -F) */
642 /* set "canmount=off" on all modified filesystems */
643 boolean_t canmountoff
;
645 /* byteswap flag is used internally; callers need not specify */
648 /* do not mount file systems as they are extracted (private) */
652 extern int zfs_receive(libzfs_handle_t
*, const char *, recvflags_t
*,
655 typedef enum diff_flags
{
656 ZFS_DIFF_PARSEABLE
= 0x1,
657 ZFS_DIFF_TIMESTAMP
= 0x2,
658 ZFS_DIFF_CLASSIFY
= 0x4
661 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
665 * Miscellaneous functions.
667 extern const char *zfs_type_to_name(zfs_type_t
);
668 extern void zfs_refresh_properties(zfs_handle_t
*);
669 extern int zfs_name_valid(const char *, zfs_type_t
);
670 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
671 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
673 extern int zfs_spa_version(zfs_handle_t
*, int *);
674 extern int zfs_append_partition(char *path
, size_t max_len
);
675 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
676 extern int zfs_strcmp_pathname(char *name
, char *cmp_name
, int wholedisk
);
679 * Mount support functions.
681 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
682 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
683 extern int zfs_mount(zfs_handle_t
*, const char *, int);
684 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
685 extern int zfs_unmountall(zfs_handle_t
*, int);
688 * Share support functions.
690 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
691 extern int zfs_share(zfs_handle_t
*);
692 extern int zfs_unshare(zfs_handle_t
*);
695 * Protocol-specific share support functions.
697 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
698 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
699 extern int zfs_share_nfs(zfs_handle_t
*);
700 extern int zfs_share_smb(zfs_handle_t
*);
701 extern int zfs_shareall(zfs_handle_t
*);
702 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
703 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
704 extern int zfs_unshareall_nfs(zfs_handle_t
*);
705 extern int zfs_unshareall_smb(zfs_handle_t
*);
706 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
707 extern int zfs_unshareall(zfs_handle_t
*);
708 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
709 void *, void *, int, zfs_share_op_t
);
712 * Utility function to convert a number to a human-readable form.
714 extern void zfs_nicenum(uint64_t, char *, size_t);
715 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
718 * Utility functions to run an external process.
720 #define STDOUT_VERBOSE 0x01
721 #define STDERR_VERBOSE 0x02
723 int libzfs_run_process(const char *, char **, int flags
);
724 int libzfs_load_module(const char *);
727 * Given a device or file, determine if it is part of a pool.
729 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
733 * Label manipulation.
735 extern int zpool_read_label(int, nvlist_t
**);
736 extern int zpool_clear_label(int);
739 * Management interfaces for SMB ACL files
742 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
743 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
744 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
745 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
748 * Enable and disable datasets within a pool by mounting/unmounting and
749 * sharing/unsharing them.
751 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
752 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
755 * Mappings between vdev and FRU.
757 extern void libzfs_fru_refresh(libzfs_handle_t
*);
758 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
759 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
760 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
762 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
763 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
769 #endif /* _LIBZFS_H */