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 IMPORT_ORDER_PREFERRED_1 1
68 #define IMPORT_ORDER_PREFERRED_2 2
69 #define IMPORT_ORDER_SCAN_OFFSET 10
70 #define IMPORT_ORDER_DEFAULT 100
71 #define DEFAULT_IMPORT_PATH_SIZE 9
72 extern char *zpool_default_import_path
[DEFAULT_IMPORT_PATH_SIZE
];
77 typedef enum zfs_error
{
78 EZFS_SUCCESS
= 0, /* no error -- success */
79 EZFS_NOMEM
= 2000, /* out of memory */
80 EZFS_BADPROP
, /* invalid property value */
81 EZFS_PROPREADONLY
, /* cannot set readonly property */
82 EZFS_PROPTYPE
, /* property does not apply to dataset type */
83 EZFS_PROPNONINHERIT
, /* property is not inheritable */
84 EZFS_PROPSPACE
, /* bad quota or reservation */
85 EZFS_BADTYPE
, /* dataset is not of appropriate type */
86 EZFS_BUSY
, /* pool or dataset is busy */
87 EZFS_EXISTS
, /* pool or dataset already exists */
88 EZFS_NOENT
, /* no such pool or dataset */
89 EZFS_BADSTREAM
, /* bad backup stream */
90 EZFS_DSREADONLY
, /* dataset is readonly */
91 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
92 EZFS_INVALIDNAME
, /* invalid dataset name */
93 EZFS_BADRESTORE
, /* unable to restore to destination */
94 EZFS_BADBACKUP
, /* backup failed */
95 EZFS_BADTARGET
, /* bad attach/detach/replace target */
96 EZFS_NODEVICE
, /* no such device in pool */
97 EZFS_BADDEV
, /* invalid device to add */
98 EZFS_NOREPLICAS
, /* no valid replicas */
99 EZFS_RESILVERING
, /* currently resilvering */
100 EZFS_BADVERSION
, /* unsupported version */
101 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
102 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
103 EZFS_BADPATH
, /* must be an absolute path */
104 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
105 EZFS_ZONED
, /* used improperly in local zone */
106 EZFS_MOUNTFAILED
, /* failed to mount dataset */
107 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
108 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
109 EZFS_SHARENFSFAILED
, /* share(1M) failed */
110 EZFS_PERM
, /* permission denied */
111 EZFS_NOSPC
, /* out of space */
112 EZFS_FAULT
, /* bad address */
113 EZFS_IO
, /* I/O error */
114 EZFS_INTR
, /* signal received */
115 EZFS_ISSPARE
, /* device is a hot spare */
116 EZFS_INVALCONFIG
, /* invalid vdev configuration */
117 EZFS_RECURSIVE
, /* recursive dependency */
118 EZFS_NOHISTORY
, /* no history object */
119 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
120 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
121 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
122 EZFS_NAMETOOLONG
, /* dataset name is too long */
123 EZFS_OPENFAILED
, /* open of device failed */
124 EZFS_NOCAP
, /* couldn't get capacity */
125 EZFS_LABELFAILED
, /* write of label failed */
126 EZFS_BADWHO
, /* invalid permission who */
127 EZFS_BADPERM
, /* invalid permission */
128 EZFS_BADPERMSET
, /* invalid permission set name */
129 EZFS_NODELEGATION
, /* delegated administration is disabled */
130 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
131 EZFS_SHARESMBFAILED
, /* failed to share over smb */
132 EZFS_BADCACHE
, /* bad cache file */
133 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
134 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
135 EZFS_NOTSUP
, /* ops not supported on this dataset */
136 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
137 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
138 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
139 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
140 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
141 EZFS_PIPEFAILED
, /* pipe create failed */
142 EZFS_THREADCREATEFAILED
, /* thread create failed */
143 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
144 EZFS_SCRUBBING
, /* currently scrubbing */
145 EZFS_NO_SCRUB
, /* no active scrub */
146 EZFS_DIFF
, /* general failure of zfs diff */
147 EZFS_DIFFDATA
, /* bad zfs diff data */
148 EZFS_POOLREADONLY
, /* pool is in read-only mode */
153 * The following data structures are all part
154 * of the zfs_allow_t data structure which is
155 * used for printing 'allow' permissions.
156 * It is a linked list of zfs_allow_t's which
157 * then contain avl tree's for user/group/sets/...
158 * and each one of the entries in those trees have
159 * avl tree's for the permissions they belong to and
160 * whether they are local,descendent or local+descendent
161 * permissions. The AVL trees are used primarily for
162 * sorting purposes, but also so that we can quickly find
163 * a given user and or permission.
165 typedef struct zfs_perm_node
{
167 char z_pname
[MAXPATHLEN
];
170 typedef struct zfs_allow_node
{
172 char z_key
[MAXPATHLEN
]; /* name, such as joe */
173 avl_tree_t z_localdescend
; /* local+descendent perms */
174 avl_tree_t z_local
; /* local permissions */
175 avl_tree_t z_descend
; /* descendent permissions */
178 typedef struct zfs_allow
{
179 struct zfs_allow
*z_next
;
180 char z_setpoint
[MAXPATHLEN
];
182 avl_tree_t z_crperms
;
185 avl_tree_t z_everyone
;
191 typedef struct zfs_handle zfs_handle_t
;
192 typedef struct zpool_handle zpool_handle_t
;
193 typedef struct libzfs_handle libzfs_handle_t
;
196 * Library initialization
198 extern libzfs_handle_t
*libzfs_init(void);
199 extern void libzfs_fini(libzfs_handle_t
*);
201 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
202 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
204 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
206 extern void zfs_save_arguments(int argc
, char **, char *, int);
207 extern int zpool_log_history(libzfs_handle_t
*, const char *);
209 extern int libzfs_errno(libzfs_handle_t
*);
210 extern const char *libzfs_error_init(int);
211 extern const char *libzfs_error_action(libzfs_handle_t
*);
212 extern const char *libzfs_error_description(libzfs_handle_t
*);
213 extern int zfs_standard_error(libzfs_handle_t
*, int, const char *);
214 extern void libzfs_mnttab_init(libzfs_handle_t
*);
215 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
216 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
217 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
219 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
220 const char *, const char *);
221 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
224 * Basic handle functions
226 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
227 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
228 extern void zpool_close(zpool_handle_t
*);
229 extern const char *zpool_get_name(zpool_handle_t
*);
230 extern int zpool_get_state(zpool_handle_t
*);
231 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
232 extern const char *zpool_pool_state_to_name(pool_state_t
);
233 extern void zpool_free_handles(libzfs_handle_t
*);
236 * Iterate over all active pools in the system.
238 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
239 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
242 * Functions to create and destroy pools
244 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
245 nvlist_t
*, nvlist_t
*);
246 extern int zpool_destroy(zpool_handle_t
*, const char *);
247 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
249 typedef struct splitflags
{
250 /* do not split, but return the config that would be split off */
253 /* after splitting, import the pool */
259 * Functions to manipulate pool and vdev state
261 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
);
262 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
263 extern int zpool_reguid(zpool_handle_t
*);
264 extern int zpool_reopen(zpool_handle_t
*);
266 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
268 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
269 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
270 const char *, nvlist_t
*, int);
271 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
272 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
273 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
276 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
277 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
278 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
280 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
281 boolean_t
*, boolean_t
*);
282 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
283 boolean_t
*, boolean_t
*, boolean_t
*);
284 extern int zpool_label_disk_wait(char *, int);
285 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
287 int zfs_dev_is_dm(char *dev_name
);
288 char *zfs_get_underlying_path(char *dev_name
);
289 char *zfs_get_enclosure_sysfs_path(char *dev_name
);
292 * Functions to manage pool properties
294 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
295 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
296 size_t proplen
, zprop_source_t
*, boolean_t literal
);
297 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
300 extern const char *zpool_prop_to_name(zpool_prop_t
);
301 extern const char *zpool_prop_values(zpool_prop_t
);
304 * Pool health statistics.
308 * The following correspond to faults as defined in the (fault.fs.zfs.*)
309 * event namespace. Each is associated with a corresponding message ID.
311 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
312 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
313 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
314 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
315 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
316 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
317 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
318 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
319 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
320 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
321 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
322 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
323 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
324 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
325 ZPOOL_STATUS_ERRATA
, /* informational errata available */
328 * If the pool has unsupported features but can still be opened in
329 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
330 * pool has unsupported features but cannot be opened at all, its
331 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
333 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
334 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
337 * These faults have no corresponding message ID. At the time we are
338 * checking the status, the original reason for the FMA fault (I/O or
339 * checksum errors) has been lost.
341 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
342 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
345 * The following are not faults per se, but still an error possibly
346 * requiring administrative attention. There is no corresponding
349 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
350 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
351 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
352 ZPOOL_STATUS_OFFLINE_DEV
, /* device offline */
353 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
356 * Finally, the following indicates a healthy pool.
361 extern unsigned long get_system_hostid(void);
362 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **,
364 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **,
366 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
369 * Statistics and configuration functions.
371 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
372 extern nvlist_t
*zpool_get_features(zpool_handle_t
*);
373 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
374 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
377 * Import and export functions
379 extern int zpool_export(zpool_handle_t
*, boolean_t
, const char *);
380 extern int zpool_export_force(zpool_handle_t
*, const char *);
381 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
383 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
385 extern void zpool_print_unsup_feat(nvlist_t
*config
);
388 * Search for pools to import
391 typedef struct importargs
{
392 char **path
; /* a list of paths to search */
393 int paths
; /* number of paths to search */
394 char *poolname
; /* name of a pool to find */
395 uint64_t guid
; /* guid of a pool to find */
396 char *cachefile
; /* cachefile to use for import */
397 int can_be_active
: 1; /* can the pool be active? */
398 int unique
: 1; /* does 'poolname' already exist? */
399 int exists
: 1; /* set on return if pool already exists */
400 int scan
: 1; /* prefer scanning to libblkid cache */
403 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
405 /* legacy pool search routines */
406 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
407 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
411 * Miscellaneous pool functions
415 extern const char *zfs_history_event_names
[];
418 VDEV_NAME_PATH
= 1 << 0,
419 VDEV_NAME_GUID
= 1 << 1,
420 VDEV_NAME_FOLLOW_LINKS
= 1 << 2,
421 VDEV_NAME_TYPE_ID
= 1 << 3,
424 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
426 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
427 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
428 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
429 nvlist_t
***, uint_t
*);
430 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, unsigned,
432 extern int zpool_events_clear(libzfs_handle_t
*, int *);
433 extern int zpool_events_seek(libzfs_handle_t
*, uint64_t, int);
434 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
436 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
437 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
438 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
442 * Basic handle manipulations. These functions do not create or destroy the
443 * underlying datasets, only the references to them.
445 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
446 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
447 extern void zfs_close(zfs_handle_t
*);
448 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
449 extern const char *zfs_get_name(const zfs_handle_t
*);
450 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
453 * Property management functions. Some functions are shared with the kernel,
454 * and are found in sys/fs/zfs.h.
458 * zfs dataset property management
460 extern const char *zfs_prop_default_string(zfs_prop_t
);
461 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
462 extern const char *zfs_prop_column_name(zfs_prop_t
);
463 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
465 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
466 nvlist_t
*, uint64_t, zfs_handle_t
*, zpool_handle_t
*, const char *);
468 extern const char *zfs_prop_to_name(zfs_prop_t
);
469 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
470 extern int zfs_prop_set_list(zfs_handle_t
*, nvlist_t
*);
471 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
472 zprop_source_t
*, char *, size_t, boolean_t
);
473 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
475 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
476 zprop_source_t
*, char *, size_t);
477 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
478 uint64_t *propvalue
);
479 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
480 char *propbuf
, int proplen
, boolean_t literal
);
481 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
482 uint64_t *propvalue
);
483 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
484 char *propbuf
, int proplen
, boolean_t literal
);
485 extern int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
486 char *buf
, size_t len
);
487 extern uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
488 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
489 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
490 extern const char *zfs_prop_values(zfs_prop_t
);
491 extern int zfs_prop_is_string(zfs_prop_t prop
);
492 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
493 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
494 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
496 typedef struct zprop_list
{
499 struct zprop_list
*pl_next
;
502 size_t pl_recvd_width
;
506 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
,
508 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
510 #define ZFS_MOUNTPOINT_NONE "none"
511 #define ZFS_MOUNTPOINT_LEGACY "legacy"
513 #define ZFS_FEATURE_DISABLED "disabled"
514 #define ZFS_FEATURE_ENABLED "enabled"
515 #define ZFS_FEATURE_ACTIVE "active"
517 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
518 #define ZFS_UNSUPPORTED_READONLY "readonly"
521 * zpool property management
523 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
524 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
526 extern const char *zpool_prop_default_string(zpool_prop_t
);
527 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
528 extern const char *zpool_prop_column_name(zpool_prop_t
);
529 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
532 * Functions shared by zfs and zpool property management.
534 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
535 boolean_t ordered
, zfs_type_t type
);
536 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
538 extern void zprop_free_list(zprop_list_t
*);
540 #define ZFS_GET_NCOLS 5
552 * Functions for printing zfs or zpool properties
554 typedef struct zprop_get_cbdata
{
556 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
557 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
558 boolean_t cb_scripted
;
559 boolean_t cb_literal
;
561 zprop_list_t
*cb_proplist
;
563 } zprop_get_cbdata_t
;
565 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
566 const char *, const char *, zprop_source_t
, const char *,
570 * Iterator functions.
572 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
573 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
574 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
575 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
576 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
577 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
578 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
579 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
580 extern int zfs_iter_bookmarks(zfs_handle_t
*, zfs_iter_f
, void *);
582 typedef struct get_all_cb
{
583 zfs_handle_t
**cb_handles
;
586 boolean_t cb_verbose
;
587 int (*cb_getone
)(zfs_handle_t
*, void *);
590 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
591 int libzfs_dataset_cmp(const void *, const void *);
594 * Functions to create and destroy datasets.
596 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
598 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
599 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
600 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
601 extern int zfs_destroy_snaps_nvl(libzfs_handle_t
*, nvlist_t
*, boolean_t
);
602 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
603 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
604 extern int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
606 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
607 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
609 typedef struct sendflags
{
610 /* print informational messages (ie, -v was specified) */
613 /* recursive send (ie, -R) */
616 /* for incrementals, do all intermediate snapshots */
619 /* if dataset is a clone, do incremental from its origin */
620 boolean_t fromorigin
;
622 /* do deduplication */
625 /* send properties (ie, -p) */
628 /* do not send (no-op, ie. -n) */
631 /* parsable verbose output (ie. -P) */
634 /* show progress (ie. -v) */
637 /* large blocks (>128K) are permitted */
638 boolean_t largeblock
;
640 /* WRITE_EMBEDDED records of type DATA are permitted */
641 boolean_t embed_data
;
643 /* compressed WRITE records are permitted */
647 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
649 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
650 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
651 extern int zfs_send_one(zfs_handle_t
*, const char *, int, enum lzc_send_flags
);
652 extern int zfs_send_resume(libzfs_handle_t
*, sendflags_t
*, int outfd
,
654 extern nvlist_t
*zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
,
657 extern int zfs_promote(zfs_handle_t
*);
658 extern int zfs_hold(zfs_handle_t
*, const char *, const char *,
660 extern int zfs_hold_nvl(zfs_handle_t
*, int, nvlist_t
*);
661 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
662 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
663 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
665 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
666 uid_t rid
, uint64_t space
);
668 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
669 zfs_userspace_cb_t
, void *);
671 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
672 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
674 typedef struct recvflags
{
675 /* print informational messages (ie, -v was specified) */
678 /* the destination is a prefix, not the exact fs (ie, -d) */
682 * Only the tail of the sent snapshot path is appended to the
683 * destination to determine the received snapshot name (ie, -e).
687 /* do not actually do the recv, just check if it would work (ie, -n) */
690 /* rollback/destroy filesystems as necessary (eg, -F) */
693 /* set "canmount=off" on all modified filesystems */
694 boolean_t canmountoff
;
697 * Mark the file systems as "resumable" and do not destroy them if the
698 * receive is interrupted
702 /* byteswap flag is used internally; callers need not specify */
705 /* do not mount file systems as they are extracted (private) */
709 extern int zfs_receive(libzfs_handle_t
*, const char *, nvlist_t
*,
710 recvflags_t
*, int, avl_tree_t
*);
712 typedef enum diff_flags
{
713 ZFS_DIFF_PARSEABLE
= 0x1,
714 ZFS_DIFF_TIMESTAMP
= 0x2,
715 ZFS_DIFF_CLASSIFY
= 0x4
718 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
722 * Miscellaneous functions.
724 extern const char *zfs_type_to_name(zfs_type_t
);
725 extern void zfs_refresh_properties(zfs_handle_t
*);
726 extern int zfs_name_valid(const char *, zfs_type_t
);
727 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
728 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
730 extern int zfs_spa_version(zfs_handle_t
*, int *);
731 extern boolean_t
zfs_bookmark_exists(const char *path
);
732 extern int zfs_append_partition(char *path
, size_t max_len
);
733 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
734 extern int zfs_strcmp_pathname(char *name
, char *cmp_name
, int wholedisk
);
735 extern int zfs_path_order(char *path
, int *order
);
738 * Mount support functions.
740 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
741 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
742 extern int zfs_mount(zfs_handle_t
*, const char *, int);
743 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
744 extern int zfs_unmountall(zfs_handle_t
*, int);
747 * Share support functions.
749 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
750 extern int zfs_share(zfs_handle_t
*);
751 extern int zfs_unshare(zfs_handle_t
*);
754 * Protocol-specific share support functions.
756 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
757 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
758 extern int zfs_share_nfs(zfs_handle_t
*);
759 extern int zfs_share_smb(zfs_handle_t
*);
760 extern int zfs_shareall(zfs_handle_t
*);
761 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
762 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
763 extern int zfs_unshareall_nfs(zfs_handle_t
*);
764 extern int zfs_unshareall_smb(zfs_handle_t
*);
765 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
766 extern int zfs_unshareall_bytype(zfs_handle_t
*, const char *, const char *);
767 extern int zfs_unshareall(zfs_handle_t
*);
768 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
769 void *, void *, int, zfs_share_op_t
);
771 enum zfs_nicenum_format
{
772 ZFS_NICENUM_1024
= 0,
773 ZFS_NICENUM_TIME
= 1,
778 * Utility function to convert a number to a human-readable form.
780 extern void zfs_nicenum(uint64_t, char *, size_t);
781 extern void zfs_nicenum_format(uint64_t num
, char *buf
, size_t buflen
,
782 enum zfs_nicenum_format type
);
785 extern void zfs_nicetime(uint64_t, char *, size_t);
786 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
789 * Utility functions to run an external process.
791 #define STDOUT_VERBOSE 0x01
792 #define STDERR_VERBOSE 0x02
794 int libzfs_run_process(const char *, char **, int flags
);
797 * Given a device or file, determine if it is part of a pool.
799 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
803 * Label manipulation.
805 extern int zpool_read_label(int, nvlist_t
**, int *);
806 extern int zpool_clear_label(int);
809 * Management interfaces for SMB ACL files
812 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
813 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
814 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
815 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
818 * Enable and disable datasets within a pool by mounting/unmounting and
819 * sharing/unsharing them.
821 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
822 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
825 * Mappings between vdev and FRU.
827 extern void libzfs_fru_refresh(libzfs_handle_t
*);
828 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
829 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
830 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
832 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
833 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
836 * Support for Linux libudev derived persistent device strings
838 extern boolean_t
is_mpath_whole_disk(const char *);
839 extern void update_vdev_config_dev_strs(nvlist_t
*);
840 extern char *zfs_strip_partition(char *);
841 extern char *zfs_strip_partition_path(char *);
846 extern boolean_t
udev_is_mpath(struct udev_device
*dev
);
847 extern int zfs_device_get_devid(struct udev_device
*, char *, size_t);
848 extern int zfs_device_get_physical(struct udev_device
*, char *, size_t);
855 #endif /* _LIBZFS_H */