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 (c) 2016, Intel Corporation.
28 * Copyright 2016 Nexenta Systems, Inc.
29 * Copyright (c) 2017 Datto Inc.
36 #include <libnvpair.h>
37 #include <sys/mnttab.h>
38 #include <sys/param.h>
39 #include <sys/types.h>
40 #include <sys/varargs.h>
41 #include <sys/fs/zfs.h>
44 #include <libzfs_core.h>
51 * Miscellaneous ZFS constants
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"
61 #define ZVOL_ROOT "/dev/zvol"
64 * Default wait time for a device name to be created.
66 #define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */
68 #define IMPORT_ORDER_PREFERRED_1 1
69 #define IMPORT_ORDER_PREFERRED_2 2
70 #define IMPORT_ORDER_SCAN_OFFSET 10
71 #define IMPORT_ORDER_DEFAULT 100
72 #define DEFAULT_IMPORT_PATH_SIZE 9
73 extern char *zpool_default_import_path
[DEFAULT_IMPORT_PATH_SIZE
];
78 typedef enum zfs_error
{
79 EZFS_SUCCESS
= 0, /* no error -- success */
80 EZFS_NOMEM
= 2000, /* out of memory */
81 EZFS_BADPROP
, /* invalid property value */
82 EZFS_PROPREADONLY
, /* cannot set readonly property */
83 EZFS_PROPTYPE
, /* property does not apply to dataset type */
84 EZFS_PROPNONINHERIT
, /* property is not inheritable */
85 EZFS_PROPSPACE
, /* bad quota or reservation */
86 EZFS_BADTYPE
, /* dataset is not of appropriate type */
87 EZFS_BUSY
, /* pool or dataset is busy */
88 EZFS_EXISTS
, /* pool or dataset already exists */
89 EZFS_NOENT
, /* no such pool or dataset */
90 EZFS_BADSTREAM
, /* bad backup stream */
91 EZFS_DSREADONLY
, /* dataset is readonly */
92 EZFS_VOLTOOBIG
, /* volume is too large for 32-bit system */
93 EZFS_INVALIDNAME
, /* invalid dataset name */
94 EZFS_BADRESTORE
, /* unable to restore to destination */
95 EZFS_BADBACKUP
, /* backup failed */
96 EZFS_BADTARGET
, /* bad attach/detach/replace target */
97 EZFS_NODEVICE
, /* no such device in pool */
98 EZFS_BADDEV
, /* invalid device to add */
99 EZFS_NOREPLICAS
, /* no valid replicas */
100 EZFS_RESILVERING
, /* currently resilvering */
101 EZFS_BADVERSION
, /* unsupported version */
102 EZFS_POOLUNAVAIL
, /* pool is currently unavailable */
103 EZFS_DEVOVERFLOW
, /* too many devices in one vdev */
104 EZFS_BADPATH
, /* must be an absolute path */
105 EZFS_CROSSTARGET
, /* rename or clone across pool or dataset */
106 EZFS_ZONED
, /* used improperly in local zone */
107 EZFS_MOUNTFAILED
, /* failed to mount dataset */
108 EZFS_UMOUNTFAILED
, /* failed to unmount dataset */
109 EZFS_UNSHARENFSFAILED
, /* unshare(1M) failed */
110 EZFS_SHARENFSFAILED
, /* share(1M) failed */
111 EZFS_PERM
, /* permission denied */
112 EZFS_NOSPC
, /* out of space */
113 EZFS_FAULT
, /* bad address */
114 EZFS_IO
, /* I/O error */
115 EZFS_INTR
, /* signal received */
116 EZFS_ISSPARE
, /* device is a hot spare */
117 EZFS_INVALCONFIG
, /* invalid vdev configuration */
118 EZFS_RECURSIVE
, /* recursive dependency */
119 EZFS_NOHISTORY
, /* no history object */
120 EZFS_POOLPROPS
, /* couldn't retrieve pool props */
121 EZFS_POOL_NOTSUP
, /* ops not supported for this type of pool */
122 EZFS_POOL_INVALARG
, /* invalid argument for this pool operation */
123 EZFS_NAMETOOLONG
, /* dataset name is too long */
124 EZFS_OPENFAILED
, /* open of device failed */
125 EZFS_NOCAP
, /* couldn't get capacity */
126 EZFS_LABELFAILED
, /* write of label failed */
127 EZFS_BADWHO
, /* invalid permission who */
128 EZFS_BADPERM
, /* invalid permission */
129 EZFS_BADPERMSET
, /* invalid permission set name */
130 EZFS_NODELEGATION
, /* delegated administration is disabled */
131 EZFS_UNSHARESMBFAILED
, /* failed to unshare over smb */
132 EZFS_SHARESMBFAILED
, /* failed to share over smb */
133 EZFS_BADCACHE
, /* bad cache file */
134 EZFS_ISL2CACHE
, /* device is for the level 2 ARC */
135 EZFS_VDEVNOTSUP
, /* unsupported vdev type */
136 EZFS_NOTSUP
, /* ops not supported on this dataset */
137 EZFS_ACTIVE_SPARE
, /* pool has active shared spare devices */
138 EZFS_UNPLAYED_LOGS
, /* log device has unplayed logs */
139 EZFS_REFTAG_RELE
, /* snapshot release: tag not found */
140 EZFS_REFTAG_HOLD
, /* snapshot hold: tag already exists */
141 EZFS_TAGTOOLONG
, /* snapshot hold/rele: tag too long */
142 EZFS_PIPEFAILED
, /* pipe create failed */
143 EZFS_THREADCREATEFAILED
, /* thread create failed */
144 EZFS_POSTSPLIT_ONLINE
, /* onlining a disk after splitting it */
145 EZFS_SCRUBBING
, /* currently scrubbing */
146 EZFS_NO_SCRUB
, /* no active scrub */
147 EZFS_DIFF
, /* general failure of zfs diff */
148 EZFS_DIFFDATA
, /* bad zfs diff data */
149 EZFS_POOLREADONLY
, /* pool is in read-only mode */
150 EZFS_SCRUB_PAUSED
, /* scrub currently paused */
151 EZFS_ACTIVE_POOL
, /* pool is imported on a different system */
156 * The following data structures are all part
157 * of the zfs_allow_t data structure which is
158 * used for printing 'allow' permissions.
159 * It is a linked list of zfs_allow_t's which
160 * then contain avl tree's for user/group/sets/...
161 * and each one of the entries in those trees have
162 * avl tree's for the permissions they belong to and
163 * whether they are local,descendent or local+descendent
164 * permissions. The AVL trees are used primarily for
165 * sorting purposes, but also so that we can quickly find
166 * a given user and or permission.
168 typedef struct zfs_perm_node
{
170 char z_pname
[MAXPATHLEN
];
173 typedef struct zfs_allow_node
{
175 char z_key
[MAXPATHLEN
]; /* name, such as joe */
176 avl_tree_t z_localdescend
; /* local+descendent perms */
177 avl_tree_t z_local
; /* local permissions */
178 avl_tree_t z_descend
; /* descendent permissions */
181 typedef struct zfs_allow
{
182 struct zfs_allow
*z_next
;
183 char z_setpoint
[MAXPATHLEN
];
185 avl_tree_t z_crperms
;
188 avl_tree_t z_everyone
;
194 typedef struct zfs_handle zfs_handle_t
;
195 typedef struct zpool_handle zpool_handle_t
;
196 typedef struct libzfs_handle libzfs_handle_t
;
199 * Library initialization
201 extern libzfs_handle_t
*libzfs_init(void);
202 extern void libzfs_fini(libzfs_handle_t
*);
204 extern libzfs_handle_t
*zpool_get_handle(zpool_handle_t
*);
205 extern libzfs_handle_t
*zfs_get_handle(zfs_handle_t
*);
207 extern void libzfs_print_on_error(libzfs_handle_t
*, boolean_t
);
209 extern void zfs_save_arguments(int argc
, char **, char *, int);
210 extern int zpool_log_history(libzfs_handle_t
*, const char *);
212 extern int libzfs_errno(libzfs_handle_t
*);
213 extern const char *libzfs_error_init(int);
214 extern const char *libzfs_error_action(libzfs_handle_t
*);
215 extern const char *libzfs_error_description(libzfs_handle_t
*);
216 extern int zfs_standard_error(libzfs_handle_t
*, int, const char *);
217 extern void libzfs_mnttab_init(libzfs_handle_t
*);
218 extern void libzfs_mnttab_fini(libzfs_handle_t
*);
219 extern void libzfs_mnttab_cache(libzfs_handle_t
*, boolean_t
);
220 extern int libzfs_mnttab_find(libzfs_handle_t
*, const char *,
222 extern void libzfs_mnttab_add(libzfs_handle_t
*, const char *,
223 const char *, const char *);
224 extern void libzfs_mnttab_remove(libzfs_handle_t
*, const char *);
227 * Basic handle functions
229 extern zpool_handle_t
*zpool_open(libzfs_handle_t
*, const char *);
230 extern zpool_handle_t
*zpool_open_canfail(libzfs_handle_t
*, const char *);
231 extern void zpool_close(zpool_handle_t
*);
232 extern const char *zpool_get_name(zpool_handle_t
*);
233 extern int zpool_get_state(zpool_handle_t
*);
234 extern char *zpool_state_to_name(vdev_state_t
, vdev_aux_t
);
235 extern const char *zpool_pool_state_to_name(pool_state_t
);
236 extern void zpool_free_handles(libzfs_handle_t
*);
239 * Iterate over all active pools in the system.
241 typedef int (*zpool_iter_f
)(zpool_handle_t
*, void *);
242 extern int zpool_iter(libzfs_handle_t
*, zpool_iter_f
, void *);
243 extern boolean_t
zpool_skip_pool(const char *);
246 * Functions to create and destroy pools
248 extern int zpool_create(libzfs_handle_t
*, const char *, nvlist_t
*,
249 nvlist_t
*, nvlist_t
*);
250 extern int zpool_destroy(zpool_handle_t
*, const char *);
251 extern int zpool_add(zpool_handle_t
*, nvlist_t
*);
253 typedef struct splitflags
{
254 /* do not split, but return the config that would be split off */
257 /* after splitting, import the pool */
263 * Functions to manipulate pool and vdev state
265 extern int zpool_scan(zpool_handle_t
*, pool_scan_func_t
, pool_scrub_cmd_t
);
266 extern int zpool_clear(zpool_handle_t
*, const char *, nvlist_t
*);
267 extern int zpool_reguid(zpool_handle_t
*);
268 extern int zpool_reopen(zpool_handle_t
*);
270 extern int zpool_sync_one(zpool_handle_t
*, void *);
272 extern int zpool_vdev_online(zpool_handle_t
*, const char *, int,
274 extern int zpool_vdev_offline(zpool_handle_t
*, const char *, boolean_t
);
275 extern int zpool_vdev_attach(zpool_handle_t
*, const char *,
276 const char *, nvlist_t
*, int);
277 extern int zpool_vdev_detach(zpool_handle_t
*, const char *);
278 extern int zpool_vdev_remove(zpool_handle_t
*, const char *);
279 extern int zpool_vdev_split(zpool_handle_t
*, char *, nvlist_t
**, nvlist_t
*,
282 extern int zpool_vdev_fault(zpool_handle_t
*, uint64_t, vdev_aux_t
);
283 extern int zpool_vdev_degrade(zpool_handle_t
*, uint64_t, vdev_aux_t
);
284 extern int zpool_vdev_clear(zpool_handle_t
*, uint64_t);
286 extern nvlist_t
*zpool_find_vdev(zpool_handle_t
*, const char *, boolean_t
*,
287 boolean_t
*, boolean_t
*);
288 extern nvlist_t
*zpool_find_vdev_by_physpath(zpool_handle_t
*, const char *,
289 boolean_t
*, boolean_t
*, boolean_t
*);
290 extern int zpool_label_disk_wait(char *, int);
291 extern int zpool_label_disk(libzfs_handle_t
*, zpool_handle_t
*, char *);
292 extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t
*zhp
, const char *path
);
294 int zfs_dev_is_dm(char *dev_name
);
295 int zfs_dev_is_whole_disk(char *dev_name
);
296 char *zfs_get_underlying_path(char *dev_name
);
297 char *zfs_get_enclosure_sysfs_path(char *dev_name
);
300 * Functions to manage pool properties
302 extern int zpool_set_prop(zpool_handle_t
*, const char *, const char *);
303 extern int zpool_get_prop(zpool_handle_t
*, zpool_prop_t
, char *,
304 size_t proplen
, zprop_source_t
*, boolean_t literal
);
305 extern uint64_t zpool_get_prop_int(zpool_handle_t
*, zpool_prop_t
,
308 extern const char *zpool_prop_to_name(zpool_prop_t
);
309 extern const char *zpool_prop_values(zpool_prop_t
);
312 * Pool health statistics.
316 * The following correspond to faults as defined in the (fault.fs.zfs.*)
317 * event namespace. Each is associated with a corresponding message ID.
319 ZPOOL_STATUS_CORRUPT_CACHE
, /* corrupt /kernel/drv/zpool.cache */
320 ZPOOL_STATUS_MISSING_DEV_R
, /* missing device with replicas */
321 ZPOOL_STATUS_MISSING_DEV_NR
, /* missing device with no replicas */
322 ZPOOL_STATUS_CORRUPT_LABEL_R
, /* bad device label with replicas */
323 ZPOOL_STATUS_CORRUPT_LABEL_NR
, /* bad device label with no replicas */
324 ZPOOL_STATUS_BAD_GUID_SUM
, /* sum of device guids didn't match */
325 ZPOOL_STATUS_CORRUPT_POOL
, /* pool metadata is corrupted */
326 ZPOOL_STATUS_CORRUPT_DATA
, /* data errors in user (meta)data */
327 ZPOOL_STATUS_FAILING_DEV
, /* device experiencing errors */
328 ZPOOL_STATUS_VERSION_NEWER
, /* newer on-disk version */
329 ZPOOL_STATUS_HOSTID_MISMATCH
, /* last accessed by another system */
330 ZPOOL_STATUS_HOSTID_ACTIVE
, /* currently active on another system */
331 ZPOOL_STATUS_HOSTID_REQUIRED
, /* multihost=on and hostid=0 */
332 ZPOOL_STATUS_IO_FAILURE_WAIT
, /* failed I/O, failmode 'wait' */
333 ZPOOL_STATUS_IO_FAILURE_CONTINUE
, /* failed I/O, failmode 'continue' */
334 ZPOOL_STATUS_BAD_LOG
, /* cannot read log chain(s) */
335 ZPOOL_STATUS_ERRATA
, /* informational errata available */
338 * If the pool has unsupported features but can still be opened in
339 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
340 * pool has unsupported features but cannot be opened at all, its
341 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
343 ZPOOL_STATUS_UNSUP_FEAT_READ
, /* unsupported features for read */
344 ZPOOL_STATUS_UNSUP_FEAT_WRITE
, /* unsupported features for write */
347 * These faults have no corresponding message ID. At the time we are
348 * checking the status, the original reason for the FMA fault (I/O or
349 * checksum errors) has been lost.
351 ZPOOL_STATUS_FAULTED_DEV_R
, /* faulted device with replicas */
352 ZPOOL_STATUS_FAULTED_DEV_NR
, /* faulted device with no replicas */
355 * The following are not faults per se, but still an error possibly
356 * requiring administrative attention. There is no corresponding
359 ZPOOL_STATUS_VERSION_OLDER
, /* older legacy on-disk version */
360 ZPOOL_STATUS_FEAT_DISABLED
, /* supported features are disabled */
361 ZPOOL_STATUS_RESILVERING
, /* device being resilvered */
362 ZPOOL_STATUS_OFFLINE_DEV
, /* device offline */
363 ZPOOL_STATUS_REMOVED_DEV
, /* removed device */
366 * Finally, the following indicates a healthy pool.
371 extern unsigned long get_system_hostid(void);
372 extern zpool_status_t
zpool_get_status(zpool_handle_t
*, char **,
374 extern zpool_status_t
zpool_import_status(nvlist_t
*, char **,
376 extern void zpool_dump_ddt(const ddt_stat_t
*dds
, const ddt_histogram_t
*ddh
);
379 * Statistics and configuration functions.
381 extern nvlist_t
*zpool_get_config(zpool_handle_t
*, nvlist_t
**);
382 extern nvlist_t
*zpool_get_features(zpool_handle_t
*);
383 extern int zpool_refresh_stats(zpool_handle_t
*, boolean_t
*);
384 extern int zpool_get_errlog(zpool_handle_t
*, nvlist_t
**);
387 * Import and export functions
389 extern int zpool_export(zpool_handle_t
*, boolean_t
, const char *);
390 extern int zpool_export_force(zpool_handle_t
*, const char *);
391 extern int zpool_import(libzfs_handle_t
*, nvlist_t
*, const char *,
393 extern int zpool_import_props(libzfs_handle_t
*, nvlist_t
*, const char *,
395 extern void zpool_print_unsup_feat(nvlist_t
*config
);
398 * Search for pools to import
401 typedef struct importargs
{
402 char **path
; /* a list of paths to search */
403 int paths
; /* number of paths to search */
404 char *poolname
; /* name of a pool to find */
405 uint64_t guid
; /* guid of a pool to find */
406 char *cachefile
; /* cachefile to use for import */
407 int can_be_active
: 1; /* can the pool be active? */
408 int unique
: 1; /* does 'poolname' already exist? */
409 int exists
: 1; /* set on return if pool already exists */
410 int scan
: 1; /* prefer scanning to libblkid cache */
413 extern nvlist_t
*zpool_search_import(libzfs_handle_t
*, importargs_t
*);
414 extern int zpool_tryimport(libzfs_handle_t
*hdl
, char *target
,
415 nvlist_t
**configp
, importargs_t
*args
);
417 /* legacy pool search routines */
418 extern nvlist_t
*zpool_find_import(libzfs_handle_t
*, int, char **);
419 extern nvlist_t
*zpool_find_import_cached(libzfs_handle_t
*, const char *,
423 * Miscellaneous pool functions
427 extern const char *zfs_history_event_names
[];
430 VDEV_NAME_PATH
= 1 << 0,
431 VDEV_NAME_GUID
= 1 << 1,
432 VDEV_NAME_FOLLOW_LINKS
= 1 << 2,
433 VDEV_NAME_TYPE_ID
= 1 << 3,
436 extern char *zpool_vdev_name(libzfs_handle_t
*, zpool_handle_t
*, nvlist_t
*,
438 extern int zpool_upgrade(zpool_handle_t
*, uint64_t);
439 extern int zpool_get_history(zpool_handle_t
*, nvlist_t
**);
440 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
441 nvlist_t
***, uint_t
*);
442 extern int zpool_events_next(libzfs_handle_t
*, nvlist_t
**, int *, unsigned,
444 extern int zpool_events_clear(libzfs_handle_t
*, int *);
445 extern int zpool_events_seek(libzfs_handle_t
*, uint64_t, int);
446 extern void zpool_obj_to_path(zpool_handle_t
*, uint64_t, uint64_t, char *,
448 extern int zfs_ioctl(libzfs_handle_t
*, int, struct zfs_cmd
*);
449 extern int zpool_get_physpath(zpool_handle_t
*, char *, size_t);
450 extern void zpool_explain_recover(libzfs_handle_t
*, const char *, int,
454 * Basic handle manipulations. These functions do not create or destroy the
455 * underlying datasets, only the references to them.
457 extern zfs_handle_t
*zfs_open(libzfs_handle_t
*, const char *, int);
458 extern zfs_handle_t
*zfs_handle_dup(zfs_handle_t
*);
459 extern void zfs_close(zfs_handle_t
*);
460 extern zfs_type_t
zfs_get_type(const zfs_handle_t
*);
461 extern const char *zfs_get_name(const zfs_handle_t
*);
462 extern zpool_handle_t
*zfs_get_pool_handle(const zfs_handle_t
*);
463 extern const char *zfs_get_pool_name(const zfs_handle_t
*);
466 * Property management functions. Some functions are shared with the kernel,
467 * and are found in sys/fs/zfs.h.
471 * zfs dataset property management
473 extern const char *zfs_prop_default_string(zfs_prop_t
);
474 extern uint64_t zfs_prop_default_numeric(zfs_prop_t
);
475 extern const char *zfs_prop_column_name(zfs_prop_t
);
476 extern boolean_t
zfs_prop_align_right(zfs_prop_t
);
478 extern nvlist_t
*zfs_valid_proplist(libzfs_handle_t
*, zfs_type_t
,
479 nvlist_t
*, uint64_t, zfs_handle_t
*, zpool_handle_t
*, const char *);
481 extern const char *zfs_prop_to_name(zfs_prop_t
);
482 extern int zfs_prop_set(zfs_handle_t
*, const char *, const char *);
483 extern int zfs_prop_set_list(zfs_handle_t
*, nvlist_t
*);
484 extern int zfs_prop_get(zfs_handle_t
*, zfs_prop_t
, char *, size_t,
485 zprop_source_t
*, char *, size_t, boolean_t
);
486 extern int zfs_prop_get_recvd(zfs_handle_t
*, const char *, char *, size_t,
488 extern int zfs_prop_get_numeric(zfs_handle_t
*, zfs_prop_t
, uint64_t *,
489 zprop_source_t
*, char *, size_t);
490 extern int zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
491 uint64_t *propvalue
);
492 extern int zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
493 char *propbuf
, int proplen
, boolean_t literal
);
494 extern int zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
495 uint64_t *propvalue
);
496 extern int zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
497 char *propbuf
, int proplen
, boolean_t literal
);
498 extern int zfs_prop_get_feature(zfs_handle_t
*zhp
, const char *propname
,
499 char *buf
, size_t len
);
500 extern uint64_t getprop_uint64(zfs_handle_t
*, zfs_prop_t
, char **);
501 extern uint64_t zfs_prop_get_int(zfs_handle_t
*, zfs_prop_t
);
502 extern int zfs_prop_inherit(zfs_handle_t
*, const char *, boolean_t
);
503 extern const char *zfs_prop_values(zfs_prop_t
);
504 extern int zfs_prop_is_string(zfs_prop_t prop
);
505 extern nvlist_t
*zfs_get_user_props(zfs_handle_t
*);
506 extern nvlist_t
*zfs_get_recvd_props(zfs_handle_t
*);
507 extern nvlist_t
*zfs_get_clones_nvl(zfs_handle_t
*);
509 typedef struct zprop_list
{
512 struct zprop_list
*pl_next
;
515 size_t pl_recvd_width
;
519 extern int zfs_expand_proplist(zfs_handle_t
*, zprop_list_t
**, boolean_t
,
521 extern void zfs_prune_proplist(zfs_handle_t
*, uint8_t *);
523 #define ZFS_MOUNTPOINT_NONE "none"
524 #define ZFS_MOUNTPOINT_LEGACY "legacy"
526 #define ZFS_FEATURE_DISABLED "disabled"
527 #define ZFS_FEATURE_ENABLED "enabled"
528 #define ZFS_FEATURE_ACTIVE "active"
530 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
531 #define ZFS_UNSUPPORTED_READONLY "readonly"
534 * zpool property management
536 extern int zpool_expand_proplist(zpool_handle_t
*, zprop_list_t
**);
537 extern int zpool_prop_get_feature(zpool_handle_t
*, const char *, char *,
539 extern const char *zpool_prop_default_string(zpool_prop_t
);
540 extern uint64_t zpool_prop_default_numeric(zpool_prop_t
);
541 extern const char *zpool_prop_column_name(zpool_prop_t
);
542 extern boolean_t
zpool_prop_align_right(zpool_prop_t
);
545 * Functions shared by zfs and zpool property management.
547 extern int zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
,
548 boolean_t ordered
, zfs_type_t type
);
549 extern int zprop_get_list(libzfs_handle_t
*, char *, zprop_list_t
**,
551 extern void zprop_free_list(zprop_list_t
*);
553 #define ZFS_GET_NCOLS 5
565 * Functions for printing zfs or zpool properties
567 typedef struct zprop_get_cbdata
{
569 zfs_get_column_t cb_columns
[ZFS_GET_NCOLS
];
570 int cb_colwidths
[ZFS_GET_NCOLS
+ 1];
571 boolean_t cb_scripted
;
572 boolean_t cb_literal
;
574 zprop_list_t
*cb_proplist
;
576 } zprop_get_cbdata_t
;
578 void zprop_print_one_property(const char *, zprop_get_cbdata_t
*,
579 const char *, const char *, zprop_source_t
, const char *,
583 * Iterator functions.
585 typedef int (*zfs_iter_f
)(zfs_handle_t
*, void *);
586 extern int zfs_iter_root(libzfs_handle_t
*, zfs_iter_f
, void *);
587 extern int zfs_iter_children(zfs_handle_t
*, zfs_iter_f
, void *);
588 extern int zfs_iter_dependents(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
589 extern int zfs_iter_filesystems(zfs_handle_t
*, zfs_iter_f
, void *);
590 extern int zfs_iter_snapshots(zfs_handle_t
*, boolean_t
, zfs_iter_f
, void *);
591 extern int zfs_iter_snapshots_sorted(zfs_handle_t
*, zfs_iter_f
, void *);
592 extern int zfs_iter_snapspec(zfs_handle_t
*, const char *, zfs_iter_f
, void *);
593 extern int zfs_iter_bookmarks(zfs_handle_t
*, zfs_iter_f
, void *);
595 typedef struct get_all_cb
{
596 zfs_handle_t
**cb_handles
;
599 boolean_t cb_verbose
;
600 int (*cb_getone
)(zfs_handle_t
*, void *);
603 void libzfs_add_handle(get_all_cb_t
*, zfs_handle_t
*);
604 int libzfs_dataset_cmp(const void *, const void *);
607 * Functions to create and destroy datasets.
609 extern int zfs_create(libzfs_handle_t
*, const char *, zfs_type_t
,
611 extern int zfs_create_ancestors(libzfs_handle_t
*, const char *);
612 extern int zfs_destroy(zfs_handle_t
*, boolean_t
);
613 extern int zfs_destroy_snaps(zfs_handle_t
*, char *, boolean_t
);
614 extern int zfs_destroy_snaps_nvl(libzfs_handle_t
*, nvlist_t
*, boolean_t
);
615 extern int zfs_clone(zfs_handle_t
*, const char *, nvlist_t
*);
616 extern int zfs_snapshot(libzfs_handle_t
*, const char *, boolean_t
, nvlist_t
*);
617 extern int zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
,
619 extern int zfs_rollback(zfs_handle_t
*, zfs_handle_t
*, boolean_t
);
620 extern int zfs_rename(zfs_handle_t
*, const char *, boolean_t
, boolean_t
);
622 typedef struct sendflags
{
623 /* print informational messages (ie, -v was specified) */
626 /* recursive send (ie, -R) */
629 /* for incrementals, do all intermediate snapshots */
632 /* if dataset is a clone, do incremental from its origin */
633 boolean_t fromorigin
;
635 /* do deduplication */
638 /* send properties (ie, -p) */
641 /* do not send (no-op, ie. -n) */
644 /* parsable verbose output (ie. -P) */
647 /* show progress (ie. -v) */
650 /* large blocks (>128K) are permitted */
651 boolean_t largeblock
;
653 /* WRITE_EMBEDDED records of type DATA are permitted */
654 boolean_t embed_data
;
656 /* compressed WRITE records are permitted */
660 typedef boolean_t (snapfilter_cb_t
)(zfs_handle_t
*, void *);
662 extern int zfs_send(zfs_handle_t
*, const char *, const char *,
663 sendflags_t
*, int, snapfilter_cb_t
, void *, nvlist_t
**);
664 extern int zfs_send_one(zfs_handle_t
*, const char *, int, enum lzc_send_flags
);
665 extern int zfs_send_resume(libzfs_handle_t
*, sendflags_t
*, int outfd
,
667 extern nvlist_t
*zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
,
670 extern int zfs_promote(zfs_handle_t
*);
671 extern int zfs_hold(zfs_handle_t
*, const char *, const char *,
673 extern int zfs_hold_nvl(zfs_handle_t
*, int, nvlist_t
*);
674 extern int zfs_release(zfs_handle_t
*, const char *, const char *, boolean_t
);
675 extern int zfs_get_holds(zfs_handle_t
*, nvlist_t
**);
676 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t
*);
678 typedef int (*zfs_userspace_cb_t
)(void *arg
, const char *domain
,
679 uid_t rid
, uint64_t space
);
681 extern int zfs_userspace(zfs_handle_t
*, zfs_userquota_prop_t
,
682 zfs_userspace_cb_t
, void *);
684 extern int zfs_get_fsacl(zfs_handle_t
*, nvlist_t
**);
685 extern int zfs_set_fsacl(zfs_handle_t
*, boolean_t
, nvlist_t
*);
687 typedef struct recvflags
{
688 /* print informational messages (ie, -v was specified) */
691 /* the destination is a prefix, not the exact fs (ie, -d) */
695 * Only the tail of the sent snapshot path is appended to the
696 * destination to determine the received snapshot name (ie, -e).
700 /* do not actually do the recv, just check if it would work (ie, -n) */
703 /* rollback/destroy filesystems as necessary (eg, -F) */
706 /* set "canmount=off" on all modified filesystems */
707 boolean_t canmountoff
;
710 * Mark the file systems as "resumable" and do not destroy them if the
711 * receive is interrupted
715 /* byteswap flag is used internally; callers need not specify */
718 /* do not mount file systems as they are extracted (private) */
722 extern int zfs_receive(libzfs_handle_t
*, const char *, nvlist_t
*,
723 recvflags_t
*, int, avl_tree_t
*);
725 typedef enum diff_flags
{
726 ZFS_DIFF_PARSEABLE
= 0x1,
727 ZFS_DIFF_TIMESTAMP
= 0x2,
728 ZFS_DIFF_CLASSIFY
= 0x4
731 extern int zfs_show_diffs(zfs_handle_t
*, int, const char *, const char *,
735 * Miscellaneous functions.
737 extern const char *zfs_type_to_name(zfs_type_t
);
738 extern void zfs_refresh_properties(zfs_handle_t
*);
739 extern int zfs_name_valid(const char *, zfs_type_t
);
740 extern zfs_handle_t
*zfs_path_to_zhandle(libzfs_handle_t
*, char *, zfs_type_t
);
741 extern boolean_t
zfs_dataset_exists(libzfs_handle_t
*, const char *,
743 extern int zfs_spa_version(zfs_handle_t
*, int *);
744 extern boolean_t
zfs_bookmark_exists(const char *path
);
745 extern int zfs_append_partition(char *path
, size_t max_len
);
746 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
747 extern int zfs_strcmp_pathname(char *name
, char *cmp_name
, int wholedisk
);
748 extern int zfs_path_order(char *path
, int *order
);
751 * Mount support functions.
753 extern boolean_t
is_mounted(libzfs_handle_t
*, const char *special
, char **);
754 extern boolean_t
zfs_is_mounted(zfs_handle_t
*, char **);
755 extern int zfs_mount(zfs_handle_t
*, const char *, int);
756 extern int zfs_unmount(zfs_handle_t
*, const char *, int);
757 extern int zfs_unmountall(zfs_handle_t
*, int);
760 * Share support functions.
762 extern boolean_t
zfs_is_shared(zfs_handle_t
*);
763 extern int zfs_share(zfs_handle_t
*);
764 extern int zfs_unshare(zfs_handle_t
*);
767 * Protocol-specific share support functions.
769 extern boolean_t
zfs_is_shared_nfs(zfs_handle_t
*, char **);
770 extern boolean_t
zfs_is_shared_smb(zfs_handle_t
*, char **);
771 extern int zfs_share_nfs(zfs_handle_t
*);
772 extern int zfs_share_smb(zfs_handle_t
*);
773 extern int zfs_shareall(zfs_handle_t
*);
774 extern int zfs_unshare_nfs(zfs_handle_t
*, const char *);
775 extern int zfs_unshare_smb(zfs_handle_t
*, const char *);
776 extern int zfs_unshareall_nfs(zfs_handle_t
*);
777 extern int zfs_unshareall_smb(zfs_handle_t
*);
778 extern int zfs_unshareall_bypath(zfs_handle_t
*, const char *);
779 extern int zfs_unshareall_bytype(zfs_handle_t
*, const char *, const char *);
780 extern int zfs_unshareall(zfs_handle_t
*);
781 extern int zfs_deleg_share_nfs(libzfs_handle_t
*, char *, char *, char *,
782 void *, void *, int, zfs_share_op_t
);
785 * Formats for iostat numbers. Examples: "12K", "30ms", "4B", "2321234", "-".
787 * ZFS_NICENUM_1024: Print kilo, mega, tera, peta, exa..
788 * ZFS_NICENUM_BYTES: Print single bytes ("13B"), kilo, mega, tera...
789 * ZFS_NICENUM_TIME: Print nanosecs, microsecs, millisecs, seconds...
790 * ZFS_NICENUM_RAW: Print the raw number without any formatting
791 * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero.
793 enum zfs_nicenum_format
{
794 ZFS_NICENUM_1024
= 0,
795 ZFS_NICENUM_BYTES
= 1,
796 ZFS_NICENUM_TIME
= 2,
798 ZFS_NICENUM_RAWTIME
= 4
802 * Utility function to convert a number to a human-readable form.
804 extern void zfs_nicenum(uint64_t, char *, size_t);
805 extern void zfs_nicenum_format(uint64_t num
, char *buf
, size_t buflen
,
806 enum zfs_nicenum_format type
);
809 extern void zfs_nicetime(uint64_t, char *, size_t);
810 extern void zfs_nicebytes(uint64_t, char *, size_t);
811 extern int zfs_nicestrtonum(libzfs_handle_t
*, const char *, uint64_t *);
814 * Utility functions to run an external process.
816 #define STDOUT_VERBOSE 0x01
817 #define STDERR_VERBOSE 0x02
818 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
820 int libzfs_run_process(const char *, char **, int flags
);
821 int libzfs_run_process_get_stdout(const char *path
, char *argv
[], char *env
[],
822 char **lines
[], int *lines_cnt
);
823 int libzfs_run_process_get_stdout_nopath(const char *path
, char *argv
[],
824 char *env
[], char **lines
[], int *lines_cnt
);
826 void libzfs_free_str_array(char **strs
, int count
);
828 int libzfs_envvar_is_set(char *envvar
);
831 * Given a device or file, determine if it is part of a pool.
833 extern int zpool_in_use(libzfs_handle_t
*, int, pool_state_t
*, char **,
837 * Label manipulation.
839 extern int zpool_read_label(int, nvlist_t
**, int *);
840 extern int zpool_clear_label(int);
843 * Management interfaces for SMB ACL files
846 int zfs_smb_acl_add(libzfs_handle_t
*, char *, char *, char *);
847 int zfs_smb_acl_remove(libzfs_handle_t
*, char *, char *, char *);
848 int zfs_smb_acl_purge(libzfs_handle_t
*, char *, char *);
849 int zfs_smb_acl_rename(libzfs_handle_t
*, char *, char *, char *, char *);
852 * Enable and disable datasets within a pool by mounting/unmounting and
853 * sharing/unsharing them.
855 extern int zpool_enable_datasets(zpool_handle_t
*, const char *, int);
856 extern int zpool_disable_datasets(zpool_handle_t
*, boolean_t
);
859 * Mappings between vdev and FRU.
861 extern void libzfs_fru_refresh(libzfs_handle_t
*);
862 extern const char *libzfs_fru_lookup(libzfs_handle_t
*, const char *);
863 extern const char *libzfs_fru_devpath(libzfs_handle_t
*, const char *);
864 extern boolean_t
libzfs_fru_compare(libzfs_handle_t
*, const char *,
866 extern boolean_t
libzfs_fru_notself(libzfs_handle_t
*, const char *);
867 extern int zpool_fru_set(zpool_handle_t
*, uint64_t, const char *);
870 * Support for Linux libudev derived persistent device strings
872 extern boolean_t
is_mpath_whole_disk(const char *);
873 extern void update_vdev_config_dev_strs(nvlist_t
*);
874 extern char *zfs_strip_partition(char *);
875 extern char *zfs_strip_partition_path(char *);
880 extern boolean_t
udev_is_mpath(struct udev_device
*dev
);
881 extern int zfs_device_get_devid(struct udev_device
*, char *, size_t);
882 extern int zfs_device_get_physical(struct udev_device
*, char *, size_t);
889 #endif /* _LIBZFS_H */