Deleted Added
sdiff udiff text old ( 307120 ) new ( 307122 )
full compact
libzfs.h (307120) libzfs.h (307122)
1/*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21
22/*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011 Pawel Jakub Dawidek. All rights reserved.
25 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
28 * Copyright (c) 2013 Steven Hartland. All rights reserved.
29 * Copyright (c) 2014 Integros [integros.com]
30 * Copyright 2016 Nexenta Systems, Inc.
31 */
32
33#ifndef _LIBZFS_H
34#define _LIBZFS_H
35
36#include <assert.h>
37#include <libnvpair.h>
38#include <sys/mnttab.h>
39#include <sys/param.h>
40#include <sys/types.h>
41#include <sys/varargs.h>
42#include <sys/fs/zfs.h>
43#include <sys/avl.h>
44#include <sys/zfs_ioctl.h>
45#include <libzfs_core.h>
46
47#ifdef __cplusplus
48extern "C" {
49#endif
50
51/*
52 * Miscellaneous ZFS constants
53 */
1/*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21
22/*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011 Pawel Jakub Dawidek. All rights reserved.
25 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
28 * Copyright (c) 2013 Steven Hartland. All rights reserved.
29 * Copyright (c) 2014 Integros [integros.com]
30 * Copyright 2016 Nexenta Systems, Inc.
31 */
32
33#ifndef _LIBZFS_H
34#define _LIBZFS_H
35
36#include <assert.h>
37#include <libnvpair.h>
38#include <sys/mnttab.h>
39#include <sys/param.h>
40#include <sys/types.h>
41#include <sys/varargs.h>
42#include <sys/fs/zfs.h>
43#include <sys/avl.h>
44#include <sys/zfs_ioctl.h>
45#include <libzfs_core.h>
46
47#ifdef __cplusplus
48extern "C" {
49#endif
50
51/*
52 * Miscellaneous ZFS constants
53 */
54#define ZFS_MAXNAMELEN MAXNAMELEN
55#define ZPOOL_MAXNAMELEN MAXNAMELEN
56#define ZFS_MAXPROPLEN MAXPATHLEN
57#define ZPOOL_MAXPROPLEN MAXPATHLEN
58
59/*
60 * libzfs errors
61 */
62typedef enum zfs_error {
63 EZFS_SUCCESS = 0, /* no error -- success */
64 EZFS_NOMEM = 2000, /* out of memory */
65 EZFS_BADPROP, /* invalid property value */
66 EZFS_PROPREADONLY, /* cannot set readonly property */
67 EZFS_PROPTYPE, /* property does not apply to dataset type */
68 EZFS_PROPNONINHERIT, /* property is not inheritable */
69 EZFS_PROPSPACE, /* bad quota or reservation */
70 EZFS_BADTYPE, /* dataset is not of appropriate type */
71 EZFS_BUSY, /* pool or dataset is busy */
72 EZFS_EXISTS, /* pool or dataset already exists */
73 EZFS_NOENT, /* no such pool or dataset */
74 EZFS_BADSTREAM, /* bad backup stream */
75 EZFS_DSREADONLY, /* dataset is readonly */
76 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
77 EZFS_INVALIDNAME, /* invalid dataset name */
78 EZFS_BADRESTORE, /* unable to restore to destination */
79 EZFS_BADBACKUP, /* backup failed */
80 EZFS_BADTARGET, /* bad attach/detach/replace target */
81 EZFS_NODEVICE, /* no such device in pool */
82 EZFS_BADDEV, /* invalid device to add */
83 EZFS_NOREPLICAS, /* no valid replicas */
84 EZFS_RESILVERING, /* currently resilvering */
85 EZFS_BADVERSION, /* unsupported version */
86 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
87 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
88 EZFS_BADPATH, /* must be an absolute path */
89 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
90 EZFS_ZONED, /* used improperly in local zone */
91 EZFS_MOUNTFAILED, /* failed to mount dataset */
92 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
93 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
94 EZFS_SHARENFSFAILED, /* share(1M) failed */
95 EZFS_PERM, /* permission denied */
96 EZFS_NOSPC, /* out of space */
97 EZFS_FAULT, /* bad address */
98 EZFS_IO, /* I/O error */
99 EZFS_INTR, /* signal received */
100 EZFS_ISSPARE, /* device is a hot spare */
101 EZFS_INVALCONFIG, /* invalid vdev configuration */
102 EZFS_RECURSIVE, /* recursive dependency */
103 EZFS_NOHISTORY, /* no history object */
104 EZFS_POOLPROPS, /* couldn't retrieve pool props */
105 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
106 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
107 EZFS_NAMETOOLONG, /* dataset name is too long */
108 EZFS_OPENFAILED, /* open of device failed */
109 EZFS_NOCAP, /* couldn't get capacity */
110 EZFS_LABELFAILED, /* write of label failed */
111 EZFS_BADWHO, /* invalid permission who */
112 EZFS_BADPERM, /* invalid permission */
113 EZFS_BADPERMSET, /* invalid permission set name */
114 EZFS_NODELEGATION, /* delegated administration is disabled */
115 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
116 EZFS_SHARESMBFAILED, /* failed to share over smb */
117 EZFS_BADCACHE, /* bad cache file */
118 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
119 EZFS_VDEVNOTSUP, /* unsupported vdev type */
120 EZFS_NOTSUP, /* ops not supported on this dataset */
121 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
122 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
123 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
124 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
125 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
126 EZFS_PIPEFAILED, /* pipe create failed */
127 EZFS_THREADCREATEFAILED, /* thread create failed */
128 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
129 EZFS_SCRUBBING, /* currently scrubbing */
130 EZFS_NO_SCRUB, /* no active scrub */
131 EZFS_DIFF, /* general failure of zfs diff */
132 EZFS_DIFFDATA, /* bad zfs diff data */
133 EZFS_POOLREADONLY, /* pool is in read-only mode */
134 EZFS_UNKNOWN
135} zfs_error_t;
136
137/*
138 * The following data structures are all part
139 * of the zfs_allow_t data structure which is
140 * used for printing 'allow' permissions.
141 * It is a linked list of zfs_allow_t's which
142 * then contain avl tree's for user/group/sets/...
143 * and each one of the entries in those trees have
144 * avl tree's for the permissions they belong to and
145 * whether they are local,descendent or local+descendent
146 * permissions. The AVL trees are used primarily for
147 * sorting purposes, but also so that we can quickly find
148 * a given user and or permission.
149 */
150typedef struct zfs_perm_node {
151 avl_node_t z_node;
152 char z_pname[MAXPATHLEN];
153} zfs_perm_node_t;
154
155typedef struct zfs_allow_node {
156 avl_node_t z_node;
157 char z_key[MAXPATHLEN]; /* name, such as joe */
158 avl_tree_t z_localdescend; /* local+descendent perms */
159 avl_tree_t z_local; /* local permissions */
160 avl_tree_t z_descend; /* descendent permissions */
161} zfs_allow_node_t;
162
163typedef struct zfs_allow {
164 struct zfs_allow *z_next;
165 char z_setpoint[MAXPATHLEN];
166 avl_tree_t z_sets;
167 avl_tree_t z_crperms;
168 avl_tree_t z_user;
169 avl_tree_t z_group;
170 avl_tree_t z_everyone;
171} zfs_allow_t;
172
173/*
174 * Basic handle types
175 */
176typedef struct zfs_handle zfs_handle_t;
177typedef struct zpool_handle zpool_handle_t;
178typedef struct libzfs_handle libzfs_handle_t;
179
180/*
181 * Library initialization
182 */
183extern libzfs_handle_t *libzfs_init(void);
184extern void libzfs_fini(libzfs_handle_t *);
185
186extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
187extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
188
189extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
190
191extern void zfs_save_arguments(int argc, char **, char *, int);
192extern int zpool_log_history(libzfs_handle_t *, const char *);
193
194extern int libzfs_errno(libzfs_handle_t *);
195extern const char *libzfs_error_action(libzfs_handle_t *);
196extern const char *libzfs_error_description(libzfs_handle_t *);
197extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
198extern void libzfs_mnttab_init(libzfs_handle_t *);
199extern void libzfs_mnttab_fini(libzfs_handle_t *);
200extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
201extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
202 struct mnttab *);
203extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
204 const char *, const char *);
205extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
206
207/*
208 * Basic handle functions
209 */
210extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
211extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
212extern void zpool_close(zpool_handle_t *);
213extern const char *zpool_get_name(zpool_handle_t *);
214extern int zpool_get_state(zpool_handle_t *);
215extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
216extern const char *zpool_pool_state_to_name(pool_state_t);
217extern void zpool_free_handles(libzfs_handle_t *);
218
219/*
220 * Iterate over all active pools in the system.
221 */
222typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
223extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
224extern boolean_t zpool_skip_pool(const char *);
225
226/*
227 * Functions to create and destroy pools
228 */
229extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
230 nvlist_t *, nvlist_t *);
231extern int zpool_destroy(zpool_handle_t *, const char *);
232extern int zpool_add(zpool_handle_t *, nvlist_t *);
233
234typedef struct splitflags {
235 /* do not split, but return the config that would be split off */
236 int dryrun : 1;
237
238 /* after splitting, import the pool */
239 int import : 1;
240} splitflags_t;
241
242/*
243 * Functions to manipulate pool and vdev state
244 */
245extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
246extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
247extern int zpool_reguid(zpool_handle_t *);
248extern int zpool_reopen(zpool_handle_t *);
249
250extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
251 vdev_state_t *);
252extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
253extern int zpool_vdev_attach(zpool_handle_t *, const char *,
254 const char *, nvlist_t *, int);
255extern int zpool_vdev_detach(zpool_handle_t *, const char *);
256extern int zpool_vdev_remove(zpool_handle_t *, const char *);
257extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
258 splitflags_t);
259
260extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
261extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
262extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
263
264extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
265 boolean_t *, boolean_t *);
266extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
267 boolean_t *, boolean_t *, boolean_t *);
268extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *);
269
270/*
271 * Functions to manage pool properties
272 */
273extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
274extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
275 size_t proplen, zprop_source_t *, boolean_t);
276extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
277 zprop_source_t *);
278
279extern const char *zpool_prop_to_name(zpool_prop_t);
280extern const char *zpool_prop_values(zpool_prop_t);
281
282/*
283 * Pool health statistics.
284 */
285typedef enum {
286 /*
287 * The following correspond to faults as defined in the (fault.fs.zfs.*)
288 * event namespace. Each is associated with a corresponding message ID.
289 */
290 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
291 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
292 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
293 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
294 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
295 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
296 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
297 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
298 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
299 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
300 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
301 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
302 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
303 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
304
305 /*
306 * If the pool has unsupported features but can still be opened in
307 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
308 * pool has unsupported features but cannot be opened at all, its
309 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
310 */
311 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
312 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
313
314 /*
315 * These faults have no corresponding message ID. At the time we are
316 * checking the status, the original reason for the FMA fault (I/O or
317 * checksum errors) has been lost.
318 */
319 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
320 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
321
322 /*
323 * The following are not faults per se, but still an error possibly
324 * requiring administrative attention. There is no corresponding
325 * message ID.
326 */
327 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
328 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
329 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
330 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */
331 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
332 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
333
334 /*
335 * Finally, the following indicates a healthy pool.
336 */
337 ZPOOL_STATUS_OK
338} zpool_status_t;
339
340extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
341extern zpool_status_t zpool_import_status(nvlist_t *, char **);
342extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
343
344/*
345 * Statistics and configuration functions.
346 */
347extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
348extern nvlist_t *zpool_get_features(zpool_handle_t *);
349extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
350extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
351
352/*
353 * Import and export functions
354 */
355extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
356extern int zpool_export_force(zpool_handle_t *, const char *);
357extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
358 char *altroot);
359extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
360 nvlist_t *, int);
361extern void zpool_print_unsup_feat(nvlist_t *config);
362
363/*
364 * Search for pools to import
365 */
366
367typedef struct importargs {
368 char **path; /* a list of paths to search */
369 int paths; /* number of paths to search */
370 char *poolname; /* name of a pool to find */
371 uint64_t guid; /* guid of a pool to find */
372 char *cachefile; /* cachefile to use for import */
373 int can_be_active : 1; /* can the pool be active? */
374 int unique : 1; /* does 'poolname' already exist? */
375 int exists : 1; /* set on return if pool already exists */
376} importargs_t;
377
378extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
379
380/* legacy pool search routines */
381extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
382extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
383 char *, uint64_t);
384
385/*
386 * Miscellaneous pool functions
387 */
388struct zfs_cmd;
389
390extern const char *zfs_history_event_names[];
391
392extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
393 boolean_t verbose);
394extern int zpool_upgrade(zpool_handle_t *, uint64_t);
395extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
396extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
397 nvlist_t ***, uint_t *);
398extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
399 size_t len);
400extern int zfs_ioctl(libzfs_handle_t *, int request, struct zfs_cmd *);
401extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
402extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
403 nvlist_t *);
404
405/*
406 * Basic handle manipulations. These functions do not create or destroy the
407 * underlying datasets, only the references to them.
408 */
409extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
410extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
411extern void zfs_close(zfs_handle_t *);
412extern zfs_type_t zfs_get_type(const zfs_handle_t *);
413extern const char *zfs_get_name(const zfs_handle_t *);
414extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
415extern const char *zfs_get_pool_name(const zfs_handle_t *);
416
417/*
418 * Property management functions. Some functions are shared with the kernel,
419 * and are found in sys/fs/zfs.h.
420 */
421
422/*
423 * zfs dataset property management
424 */
425extern const char *zfs_prop_default_string(zfs_prop_t);
426extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
427extern const char *zfs_prop_column_name(zfs_prop_t);
428extern boolean_t zfs_prop_align_right(zfs_prop_t);
429
430extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
431 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
432
433extern const char *zfs_prop_to_name(zfs_prop_t);
434extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
435extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
436extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
437 zprop_source_t *, char *, size_t, boolean_t);
438extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
439 boolean_t);
440extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
441 zprop_source_t *, char *, size_t);
442extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
443 uint64_t *propvalue);
444extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
445 char *propbuf, int proplen, boolean_t literal);
446extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
447 uint64_t *propvalue);
448extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
449 char *propbuf, int proplen, boolean_t literal);
450extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
451 char *buf, size_t len);
452extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
453extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
454extern const char *zfs_prop_values(zfs_prop_t);
455extern int zfs_prop_is_string(zfs_prop_t prop);
456extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
457extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
458extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
459
460
461typedef struct zprop_list {
462 int pl_prop;
463 char *pl_user_prop;
464 struct zprop_list *pl_next;
465 boolean_t pl_all;
466 size_t pl_width;
467 size_t pl_recvd_width;
468 boolean_t pl_fixed;
469} zprop_list_t;
470
471extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
472 boolean_t);
473extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
474
475#define ZFS_MOUNTPOINT_NONE "none"
476#define ZFS_MOUNTPOINT_LEGACY "legacy"
477
478#define ZFS_FEATURE_DISABLED "disabled"
479#define ZFS_FEATURE_ENABLED "enabled"
480#define ZFS_FEATURE_ACTIVE "active"
481
482#define ZFS_UNSUPPORTED_INACTIVE "inactive"
483#define ZFS_UNSUPPORTED_READONLY "readonly"
484
485/*
486 * zpool property management
487 */
488extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
489extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
490 size_t);
491extern const char *zpool_prop_default_string(zpool_prop_t);
492extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
493extern const char *zpool_prop_column_name(zpool_prop_t);
494extern boolean_t zpool_prop_align_right(zpool_prop_t);
495
496/*
497 * Functions shared by zfs and zpool property management.
498 */
499extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
500 boolean_t ordered, zfs_type_t type);
501extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
502 zfs_type_t);
503extern void zprop_free_list(zprop_list_t *);
504
505#define ZFS_GET_NCOLS 5
506
507typedef enum {
508 GET_COL_NONE,
509 GET_COL_NAME,
510 GET_COL_PROPERTY,
511 GET_COL_VALUE,
512 GET_COL_RECVD,
513 GET_COL_SOURCE
514} zfs_get_column_t;
515
516/*
517 * Functions for printing zfs or zpool properties
518 */
519typedef struct zprop_get_cbdata {
520 int cb_sources;
521 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
522 int cb_colwidths[ZFS_GET_NCOLS + 1];
523 boolean_t cb_scripted;
524 boolean_t cb_literal;
525 boolean_t cb_first;
526 zprop_list_t *cb_proplist;
527 zfs_type_t cb_type;
528} zprop_get_cbdata_t;
529
530void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
531 const char *, const char *, zprop_source_t, const char *,
532 const char *);
533
534/*
535 * Iterator functions.
536 */
537typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
538extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
539extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
540extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
541extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
542extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
543extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
544extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
545extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
546
547typedef struct get_all_cb {
548 zfs_handle_t **cb_handles;
549 size_t cb_alloc;
550 size_t cb_used;
551 boolean_t cb_verbose;
552 int (*cb_getone)(zfs_handle_t *, void *);
553} get_all_cb_t;
554
555void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
556int libzfs_dataset_cmp(const void *, const void *);
557
558/*
559 * Functions to create and destroy datasets.
560 */
561extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
562 nvlist_t *);
563extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
564extern int zfs_destroy(zfs_handle_t *, boolean_t);
565extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
566extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
567extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
568extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
569extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
570 nvlist_t *props);
571extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
572
573typedef struct renameflags {
574 /* recursive rename */
575 int recurse : 1;
576
577 /* don't unmount file systems */
578 int nounmount : 1;
579
580 /* force unmount file systems */
581 int forceunmount : 1;
582} renameflags_t;
583
584extern int zfs_rename(zfs_handle_t *, const char *, const char *,
585 renameflags_t flags);
586
587typedef struct sendflags {
588 /* print informational messages (ie, -v was specified) */
589 boolean_t verbose;
590
591 /* recursive send (ie, -R) */
592 boolean_t replicate;
593
594 /* for incrementals, do all intermediate snapshots */
595 boolean_t doall;
596
597 /* if dataset is a clone, do incremental from its origin */
598 boolean_t fromorigin;
599
600 /* do deduplication */
601 boolean_t dedup;
602
603 /* send properties (ie, -p) */
604 boolean_t props;
605
606 /* do not send (no-op, ie. -n) */
607 boolean_t dryrun;
608
609 /* parsable verbose output (ie. -P) */
610 boolean_t parsable;
611
612 /* show progress (ie. -v) */
613 boolean_t progress;
614
615 /* large blocks (>128K) are permitted */
616 boolean_t largeblock;
617
618 /* WRITE_EMBEDDED records of type DATA are permitted */
619 boolean_t embed_data;
620} sendflags_t;
621
622typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
623
624extern int zfs_send(zfs_handle_t *, const char *, const char *,
625 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
626extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
627extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
628 const char *);
629extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
630 const char *token);
631
632extern int zfs_promote(zfs_handle_t *);
633extern int zfs_hold(zfs_handle_t *, const char *, const char *,
634 boolean_t, int);
635extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
636extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
637extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
638extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
639
640typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
641 uid_t rid, uint64_t space);
642
643extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
644 zfs_userspace_cb_t, void *);
645
646extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
647extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
648
649typedef struct recvflags {
650 /* print informational messages (ie, -v was specified) */
651 boolean_t verbose;
652
653 /* the destination is a prefix, not the exact fs (ie, -d) */
654 boolean_t isprefix;
655
656 /*
657 * Only the tail of the sent snapshot path is appended to the
658 * destination to determine the received snapshot name (ie, -e).
659 */
660 boolean_t istail;
661
662 /* do not actually do the recv, just check if it would work (ie, -n) */
663 boolean_t dryrun;
664
665 /* rollback/destroy filesystems as necessary (eg, -F) */
666 boolean_t force;
667
668 /* set "canmount=off" on all modified filesystems */
669 boolean_t canmountoff;
670
671 /*
672 * Mark the file systems as "resumable" and do not destroy them if the
673 * receive is interrupted
674 */
675 boolean_t resumable;
676
677 /* byteswap flag is used internally; callers need not specify */
678 boolean_t byteswap;
679
680 /* do not mount file systems as they are extracted (private) */
681 boolean_t nomount;
682} recvflags_t;
683
684extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
685 recvflags_t *, int, avl_tree_t *);
686
687typedef enum diff_flags {
688 ZFS_DIFF_PARSEABLE = 0x1,
689 ZFS_DIFF_TIMESTAMP = 0x2,
690 ZFS_DIFF_CLASSIFY = 0x4
691} diff_flags_t;
692
693extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
694 int);
695
696/*
697 * Miscellaneous functions.
698 */
699extern const char *zfs_type_to_name(zfs_type_t);
700extern void zfs_refresh_properties(zfs_handle_t *);
701extern int zfs_name_valid(const char *, zfs_type_t);
702extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
703extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
704 zfs_type_t);
705extern int zfs_spa_version(zfs_handle_t *, int *);
706extern boolean_t zfs_bookmark_exists(const char *path);
707
708/*
709 * Mount support functions.
710 */
711extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
712extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
713extern int zfs_mount(zfs_handle_t *, const char *, int);
714extern int zfs_unmount(zfs_handle_t *, const char *, int);
715extern int zfs_unmountall(zfs_handle_t *, int);
716
717/*
718 * Share support functions.
719 */
720extern boolean_t zfs_is_shared(zfs_handle_t *);
721extern int zfs_share(zfs_handle_t *);
722extern int zfs_unshare(zfs_handle_t *);
723
724/*
725 * Protocol-specific share support functions.
726 */
727extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
728extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
729extern int zfs_share_nfs(zfs_handle_t *);
730extern int zfs_share_smb(zfs_handle_t *);
731extern int zfs_shareall(zfs_handle_t *);
732extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
733extern int zfs_unshare_smb(zfs_handle_t *, const char *);
734extern int zfs_unshareall_nfs(zfs_handle_t *);
735extern int zfs_unshareall_smb(zfs_handle_t *);
736extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
737extern int zfs_unshareall(zfs_handle_t *);
738extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
739 void *, void *, int, zfs_share_op_t);
740
741/*
742 * FreeBSD-specific jail support function.
743 */
744extern int zfs_jail(zfs_handle_t *, int, int);
745
746/*
747 * When dealing with nvlists, verify() is extremely useful
748 */
749#ifndef verify
750#ifdef NDEBUG
751#define verify(EX) ((void)(EX))
752#else
753#define verify(EX) assert(EX)
754#endif
755#endif
756
757/*
758 * Utility function to convert a number to a human-readable form.
759 */
760extern void zfs_nicenum(uint64_t, char *, size_t);
761extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
762
763/*
764 * Given a device or file, determine if it is part of a pool.
765 */
766extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
767 boolean_t *);
768
769/*
770 * Label manipulation.
771 */
772extern int zpool_read_label(int, nvlist_t **);
773extern int zpool_clear_label(int);
774
775/* is this zvol valid for use as a dump device? */
776extern int zvol_check_dump_config(char *);
777
778/*
779 * Management interfaces for SMB ACL files
780 */
781
782int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
783int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
784int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
785int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
786
787/*
788 * Enable and disable datasets within a pool by mounting/unmounting and
789 * sharing/unsharing them.
790 */
791extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
792extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
793
794/*
795 * Mappings between vdev and FRU.
796 */
797extern void libzfs_fru_refresh(libzfs_handle_t *);
798extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
799extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
800extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
801 const char *);
802extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
803extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
804
805#ifndef illumos
806extern int zmount(const char *, const char *, int, char *, char *, int, char *,
807 int);
808#endif
809
810#ifdef __cplusplus
811}
812#endif
813
814#endif /* _LIBZFS_H */
54#define ZFS_MAXPROPLEN MAXPATHLEN
55#define ZPOOL_MAXPROPLEN MAXPATHLEN
56
57/*
58 * libzfs errors
59 */
60typedef enum zfs_error {
61 EZFS_SUCCESS = 0, /* no error -- success */
62 EZFS_NOMEM = 2000, /* out of memory */
63 EZFS_BADPROP, /* invalid property value */
64 EZFS_PROPREADONLY, /* cannot set readonly property */
65 EZFS_PROPTYPE, /* property does not apply to dataset type */
66 EZFS_PROPNONINHERIT, /* property is not inheritable */
67 EZFS_PROPSPACE, /* bad quota or reservation */
68 EZFS_BADTYPE, /* dataset is not of appropriate type */
69 EZFS_BUSY, /* pool or dataset is busy */
70 EZFS_EXISTS, /* pool or dataset already exists */
71 EZFS_NOENT, /* no such pool or dataset */
72 EZFS_BADSTREAM, /* bad backup stream */
73 EZFS_DSREADONLY, /* dataset is readonly */
74 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
75 EZFS_INVALIDNAME, /* invalid dataset name */
76 EZFS_BADRESTORE, /* unable to restore to destination */
77 EZFS_BADBACKUP, /* backup failed */
78 EZFS_BADTARGET, /* bad attach/detach/replace target */
79 EZFS_NODEVICE, /* no such device in pool */
80 EZFS_BADDEV, /* invalid device to add */
81 EZFS_NOREPLICAS, /* no valid replicas */
82 EZFS_RESILVERING, /* currently resilvering */
83 EZFS_BADVERSION, /* unsupported version */
84 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
85 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
86 EZFS_BADPATH, /* must be an absolute path */
87 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
88 EZFS_ZONED, /* used improperly in local zone */
89 EZFS_MOUNTFAILED, /* failed to mount dataset */
90 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
91 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
92 EZFS_SHARENFSFAILED, /* share(1M) failed */
93 EZFS_PERM, /* permission denied */
94 EZFS_NOSPC, /* out of space */
95 EZFS_FAULT, /* bad address */
96 EZFS_IO, /* I/O error */
97 EZFS_INTR, /* signal received */
98 EZFS_ISSPARE, /* device is a hot spare */
99 EZFS_INVALCONFIG, /* invalid vdev configuration */
100 EZFS_RECURSIVE, /* recursive dependency */
101 EZFS_NOHISTORY, /* no history object */
102 EZFS_POOLPROPS, /* couldn't retrieve pool props */
103 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
104 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
105 EZFS_NAMETOOLONG, /* dataset name is too long */
106 EZFS_OPENFAILED, /* open of device failed */
107 EZFS_NOCAP, /* couldn't get capacity */
108 EZFS_LABELFAILED, /* write of label failed */
109 EZFS_BADWHO, /* invalid permission who */
110 EZFS_BADPERM, /* invalid permission */
111 EZFS_BADPERMSET, /* invalid permission set name */
112 EZFS_NODELEGATION, /* delegated administration is disabled */
113 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
114 EZFS_SHARESMBFAILED, /* failed to share over smb */
115 EZFS_BADCACHE, /* bad cache file */
116 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
117 EZFS_VDEVNOTSUP, /* unsupported vdev type */
118 EZFS_NOTSUP, /* ops not supported on this dataset */
119 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
120 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
121 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
122 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
123 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
124 EZFS_PIPEFAILED, /* pipe create failed */
125 EZFS_THREADCREATEFAILED, /* thread create failed */
126 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
127 EZFS_SCRUBBING, /* currently scrubbing */
128 EZFS_NO_SCRUB, /* no active scrub */
129 EZFS_DIFF, /* general failure of zfs diff */
130 EZFS_DIFFDATA, /* bad zfs diff data */
131 EZFS_POOLREADONLY, /* pool is in read-only mode */
132 EZFS_UNKNOWN
133} zfs_error_t;
134
135/*
136 * The following data structures are all part
137 * of the zfs_allow_t data structure which is
138 * used for printing 'allow' permissions.
139 * It is a linked list of zfs_allow_t's which
140 * then contain avl tree's for user/group/sets/...
141 * and each one of the entries in those trees have
142 * avl tree's for the permissions they belong to and
143 * whether they are local,descendent or local+descendent
144 * permissions. The AVL trees are used primarily for
145 * sorting purposes, but also so that we can quickly find
146 * a given user and or permission.
147 */
148typedef struct zfs_perm_node {
149 avl_node_t z_node;
150 char z_pname[MAXPATHLEN];
151} zfs_perm_node_t;
152
153typedef struct zfs_allow_node {
154 avl_node_t z_node;
155 char z_key[MAXPATHLEN]; /* name, such as joe */
156 avl_tree_t z_localdescend; /* local+descendent perms */
157 avl_tree_t z_local; /* local permissions */
158 avl_tree_t z_descend; /* descendent permissions */
159} zfs_allow_node_t;
160
161typedef struct zfs_allow {
162 struct zfs_allow *z_next;
163 char z_setpoint[MAXPATHLEN];
164 avl_tree_t z_sets;
165 avl_tree_t z_crperms;
166 avl_tree_t z_user;
167 avl_tree_t z_group;
168 avl_tree_t z_everyone;
169} zfs_allow_t;
170
171/*
172 * Basic handle types
173 */
174typedef struct zfs_handle zfs_handle_t;
175typedef struct zpool_handle zpool_handle_t;
176typedef struct libzfs_handle libzfs_handle_t;
177
178/*
179 * Library initialization
180 */
181extern libzfs_handle_t *libzfs_init(void);
182extern void libzfs_fini(libzfs_handle_t *);
183
184extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
185extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
186
187extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
188
189extern void zfs_save_arguments(int argc, char **, char *, int);
190extern int zpool_log_history(libzfs_handle_t *, const char *);
191
192extern int libzfs_errno(libzfs_handle_t *);
193extern const char *libzfs_error_action(libzfs_handle_t *);
194extern const char *libzfs_error_description(libzfs_handle_t *);
195extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
196extern void libzfs_mnttab_init(libzfs_handle_t *);
197extern void libzfs_mnttab_fini(libzfs_handle_t *);
198extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
199extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
200 struct mnttab *);
201extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
202 const char *, const char *);
203extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
204
205/*
206 * Basic handle functions
207 */
208extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
209extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
210extern void zpool_close(zpool_handle_t *);
211extern const char *zpool_get_name(zpool_handle_t *);
212extern int zpool_get_state(zpool_handle_t *);
213extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
214extern const char *zpool_pool_state_to_name(pool_state_t);
215extern void zpool_free_handles(libzfs_handle_t *);
216
217/*
218 * Iterate over all active pools in the system.
219 */
220typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
221extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
222extern boolean_t zpool_skip_pool(const char *);
223
224/*
225 * Functions to create and destroy pools
226 */
227extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
228 nvlist_t *, nvlist_t *);
229extern int zpool_destroy(zpool_handle_t *, const char *);
230extern int zpool_add(zpool_handle_t *, nvlist_t *);
231
232typedef struct splitflags {
233 /* do not split, but return the config that would be split off */
234 int dryrun : 1;
235
236 /* after splitting, import the pool */
237 int import : 1;
238} splitflags_t;
239
240/*
241 * Functions to manipulate pool and vdev state
242 */
243extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
244extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
245extern int zpool_reguid(zpool_handle_t *);
246extern int zpool_reopen(zpool_handle_t *);
247
248extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
249 vdev_state_t *);
250extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
251extern int zpool_vdev_attach(zpool_handle_t *, const char *,
252 const char *, nvlist_t *, int);
253extern int zpool_vdev_detach(zpool_handle_t *, const char *);
254extern int zpool_vdev_remove(zpool_handle_t *, const char *);
255extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
256 splitflags_t);
257
258extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
259extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
260extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
261
262extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
263 boolean_t *, boolean_t *);
264extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
265 boolean_t *, boolean_t *, boolean_t *);
266extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *);
267
268/*
269 * Functions to manage pool properties
270 */
271extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
272extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
273 size_t proplen, zprop_source_t *, boolean_t);
274extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
275 zprop_source_t *);
276
277extern const char *zpool_prop_to_name(zpool_prop_t);
278extern const char *zpool_prop_values(zpool_prop_t);
279
280/*
281 * Pool health statistics.
282 */
283typedef enum {
284 /*
285 * The following correspond to faults as defined in the (fault.fs.zfs.*)
286 * event namespace. Each is associated with a corresponding message ID.
287 */
288 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
289 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
290 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
291 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
292 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
293 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
294 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
295 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
296 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
297 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
298 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
299 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
300 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
301 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
302
303 /*
304 * If the pool has unsupported features but can still be opened in
305 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
306 * pool has unsupported features but cannot be opened at all, its
307 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
308 */
309 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
310 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
311
312 /*
313 * These faults have no corresponding message ID. At the time we are
314 * checking the status, the original reason for the FMA fault (I/O or
315 * checksum errors) has been lost.
316 */
317 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
318 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
319
320 /*
321 * The following are not faults per se, but still an error possibly
322 * requiring administrative attention. There is no corresponding
323 * message ID.
324 */
325 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
326 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
327 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
328 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */
329 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
330 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
331
332 /*
333 * Finally, the following indicates a healthy pool.
334 */
335 ZPOOL_STATUS_OK
336} zpool_status_t;
337
338extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
339extern zpool_status_t zpool_import_status(nvlist_t *, char **);
340extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
341
342/*
343 * Statistics and configuration functions.
344 */
345extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
346extern nvlist_t *zpool_get_features(zpool_handle_t *);
347extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
348extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
349
350/*
351 * Import and export functions
352 */
353extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
354extern int zpool_export_force(zpool_handle_t *, const char *);
355extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
356 char *altroot);
357extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
358 nvlist_t *, int);
359extern void zpool_print_unsup_feat(nvlist_t *config);
360
361/*
362 * Search for pools to import
363 */
364
365typedef 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 */
374} importargs_t;
375
376extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
377
378/* legacy pool search routines */
379extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
380extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
381 char *, uint64_t);
382
383/*
384 * Miscellaneous pool functions
385 */
386struct zfs_cmd;
387
388extern const char *zfs_history_event_names[];
389
390extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
391 boolean_t verbose);
392extern int zpool_upgrade(zpool_handle_t *, uint64_t);
393extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
394extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
395 nvlist_t ***, uint_t *);
396extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
397 size_t len);
398extern int zfs_ioctl(libzfs_handle_t *, int request, struct zfs_cmd *);
399extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
400extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
401 nvlist_t *);
402
403/*
404 * Basic handle manipulations. These functions do not create or destroy the
405 * underlying datasets, only the references to them.
406 */
407extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
408extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
409extern void zfs_close(zfs_handle_t *);
410extern zfs_type_t zfs_get_type(const zfs_handle_t *);
411extern const char *zfs_get_name(const zfs_handle_t *);
412extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
413extern const char *zfs_get_pool_name(const zfs_handle_t *);
414
415/*
416 * Property management functions. Some functions are shared with the kernel,
417 * and are found in sys/fs/zfs.h.
418 */
419
420/*
421 * zfs dataset property management
422 */
423extern const char *zfs_prop_default_string(zfs_prop_t);
424extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
425extern const char *zfs_prop_column_name(zfs_prop_t);
426extern boolean_t zfs_prop_align_right(zfs_prop_t);
427
428extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
429 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
430
431extern const char *zfs_prop_to_name(zfs_prop_t);
432extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
433extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
434extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
435 zprop_source_t *, char *, size_t, boolean_t);
436extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
437 boolean_t);
438extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
439 zprop_source_t *, char *, size_t);
440extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
441 uint64_t *propvalue);
442extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
443 char *propbuf, int proplen, boolean_t literal);
444extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
445 uint64_t *propvalue);
446extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
447 char *propbuf, int proplen, boolean_t literal);
448extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
449 char *buf, size_t len);
450extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
451extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
452extern const char *zfs_prop_values(zfs_prop_t);
453extern int zfs_prop_is_string(zfs_prop_t prop);
454extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
455extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
456extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
457
458
459typedef struct zprop_list {
460 int pl_prop;
461 char *pl_user_prop;
462 struct zprop_list *pl_next;
463 boolean_t pl_all;
464 size_t pl_width;
465 size_t pl_recvd_width;
466 boolean_t pl_fixed;
467} zprop_list_t;
468
469extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
470 boolean_t);
471extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
472
473#define ZFS_MOUNTPOINT_NONE "none"
474#define ZFS_MOUNTPOINT_LEGACY "legacy"
475
476#define ZFS_FEATURE_DISABLED "disabled"
477#define ZFS_FEATURE_ENABLED "enabled"
478#define ZFS_FEATURE_ACTIVE "active"
479
480#define ZFS_UNSUPPORTED_INACTIVE "inactive"
481#define ZFS_UNSUPPORTED_READONLY "readonly"
482
483/*
484 * zpool property management
485 */
486extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
487extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
488 size_t);
489extern const char *zpool_prop_default_string(zpool_prop_t);
490extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
491extern const char *zpool_prop_column_name(zpool_prop_t);
492extern boolean_t zpool_prop_align_right(zpool_prop_t);
493
494/*
495 * Functions shared by zfs and zpool property management.
496 */
497extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
498 boolean_t ordered, zfs_type_t type);
499extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
500 zfs_type_t);
501extern void zprop_free_list(zprop_list_t *);
502
503#define ZFS_GET_NCOLS 5
504
505typedef enum {
506 GET_COL_NONE,
507 GET_COL_NAME,
508 GET_COL_PROPERTY,
509 GET_COL_VALUE,
510 GET_COL_RECVD,
511 GET_COL_SOURCE
512} zfs_get_column_t;
513
514/*
515 * Functions for printing zfs or zpool properties
516 */
517typedef struct zprop_get_cbdata {
518 int cb_sources;
519 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
520 int cb_colwidths[ZFS_GET_NCOLS + 1];
521 boolean_t cb_scripted;
522 boolean_t cb_literal;
523 boolean_t cb_first;
524 zprop_list_t *cb_proplist;
525 zfs_type_t cb_type;
526} zprop_get_cbdata_t;
527
528void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
529 const char *, const char *, zprop_source_t, const char *,
530 const char *);
531
532/*
533 * Iterator functions.
534 */
535typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
536extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
537extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
538extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
539extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
540extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
541extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
542extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
543extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
544
545typedef struct get_all_cb {
546 zfs_handle_t **cb_handles;
547 size_t cb_alloc;
548 size_t cb_used;
549 boolean_t cb_verbose;
550 int (*cb_getone)(zfs_handle_t *, void *);
551} get_all_cb_t;
552
553void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
554int libzfs_dataset_cmp(const void *, const void *);
555
556/*
557 * Functions to create and destroy datasets.
558 */
559extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
560 nvlist_t *);
561extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
562extern int zfs_destroy(zfs_handle_t *, boolean_t);
563extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
564extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
565extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
566extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
567extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
568 nvlist_t *props);
569extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
570
571typedef struct renameflags {
572 /* recursive rename */
573 int recurse : 1;
574
575 /* don't unmount file systems */
576 int nounmount : 1;
577
578 /* force unmount file systems */
579 int forceunmount : 1;
580} renameflags_t;
581
582extern int zfs_rename(zfs_handle_t *, const char *, const char *,
583 renameflags_t flags);
584
585typedef struct sendflags {
586 /* print informational messages (ie, -v was specified) */
587 boolean_t verbose;
588
589 /* recursive send (ie, -R) */
590 boolean_t replicate;
591
592 /* for incrementals, do all intermediate snapshots */
593 boolean_t doall;
594
595 /* if dataset is a clone, do incremental from its origin */
596 boolean_t fromorigin;
597
598 /* do deduplication */
599 boolean_t dedup;
600
601 /* send properties (ie, -p) */
602 boolean_t props;
603
604 /* do not send (no-op, ie. -n) */
605 boolean_t dryrun;
606
607 /* parsable verbose output (ie. -P) */
608 boolean_t parsable;
609
610 /* show progress (ie. -v) */
611 boolean_t progress;
612
613 /* large blocks (>128K) are permitted */
614 boolean_t largeblock;
615
616 /* WRITE_EMBEDDED records of type DATA are permitted */
617 boolean_t embed_data;
618} sendflags_t;
619
620typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
621
622extern int zfs_send(zfs_handle_t *, const char *, const char *,
623 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
624extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
625extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
626 const char *);
627extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
628 const char *token);
629
630extern int zfs_promote(zfs_handle_t *);
631extern int zfs_hold(zfs_handle_t *, const char *, const char *,
632 boolean_t, int);
633extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
634extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
635extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
636extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
637
638typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
639 uid_t rid, uint64_t space);
640
641extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
642 zfs_userspace_cb_t, void *);
643
644extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
645extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
646
647typedef struct recvflags {
648 /* print informational messages (ie, -v was specified) */
649 boolean_t verbose;
650
651 /* the destination is a prefix, not the exact fs (ie, -d) */
652 boolean_t isprefix;
653
654 /*
655 * Only the tail of the sent snapshot path is appended to the
656 * destination to determine the received snapshot name (ie, -e).
657 */
658 boolean_t istail;
659
660 /* do not actually do the recv, just check if it would work (ie, -n) */
661 boolean_t dryrun;
662
663 /* rollback/destroy filesystems as necessary (eg, -F) */
664 boolean_t force;
665
666 /* set "canmount=off" on all modified filesystems */
667 boolean_t canmountoff;
668
669 /*
670 * Mark the file systems as "resumable" and do not destroy them if the
671 * receive is interrupted
672 */
673 boolean_t resumable;
674
675 /* byteswap flag is used internally; callers need not specify */
676 boolean_t byteswap;
677
678 /* do not mount file systems as they are extracted (private) */
679 boolean_t nomount;
680} recvflags_t;
681
682extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
683 recvflags_t *, int, avl_tree_t *);
684
685typedef enum diff_flags {
686 ZFS_DIFF_PARSEABLE = 0x1,
687 ZFS_DIFF_TIMESTAMP = 0x2,
688 ZFS_DIFF_CLASSIFY = 0x4
689} diff_flags_t;
690
691extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
692 int);
693
694/*
695 * Miscellaneous functions.
696 */
697extern const char *zfs_type_to_name(zfs_type_t);
698extern void zfs_refresh_properties(zfs_handle_t *);
699extern int zfs_name_valid(const char *, zfs_type_t);
700extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
701extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
702 zfs_type_t);
703extern int zfs_spa_version(zfs_handle_t *, int *);
704extern boolean_t zfs_bookmark_exists(const char *path);
705
706/*
707 * Mount support functions.
708 */
709extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
710extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
711extern int zfs_mount(zfs_handle_t *, const char *, int);
712extern int zfs_unmount(zfs_handle_t *, const char *, int);
713extern int zfs_unmountall(zfs_handle_t *, int);
714
715/*
716 * Share support functions.
717 */
718extern boolean_t zfs_is_shared(zfs_handle_t *);
719extern int zfs_share(zfs_handle_t *);
720extern int zfs_unshare(zfs_handle_t *);
721
722/*
723 * Protocol-specific share support functions.
724 */
725extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
726extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
727extern int zfs_share_nfs(zfs_handle_t *);
728extern int zfs_share_smb(zfs_handle_t *);
729extern int zfs_shareall(zfs_handle_t *);
730extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
731extern int zfs_unshare_smb(zfs_handle_t *, const char *);
732extern int zfs_unshareall_nfs(zfs_handle_t *);
733extern int zfs_unshareall_smb(zfs_handle_t *);
734extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
735extern int zfs_unshareall(zfs_handle_t *);
736extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
737 void *, void *, int, zfs_share_op_t);
738
739/*
740 * FreeBSD-specific jail support function.
741 */
742extern int zfs_jail(zfs_handle_t *, int, int);
743
744/*
745 * When dealing with nvlists, verify() is extremely useful
746 */
747#ifndef verify
748#ifdef NDEBUG
749#define verify(EX) ((void)(EX))
750#else
751#define verify(EX) assert(EX)
752#endif
753#endif
754
755/*
756 * Utility function to convert a number to a human-readable form.
757 */
758extern void zfs_nicenum(uint64_t, char *, size_t);
759extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
760
761/*
762 * Given a device or file, determine if it is part of a pool.
763 */
764extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
765 boolean_t *);
766
767/*
768 * Label manipulation.
769 */
770extern int zpool_read_label(int, nvlist_t **);
771extern int zpool_clear_label(int);
772
773/* is this zvol valid for use as a dump device? */
774extern int zvol_check_dump_config(char *);
775
776/*
777 * Management interfaces for SMB ACL files
778 */
779
780int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
781int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
782int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
783int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
784
785/*
786 * Enable and disable datasets within a pool by mounting/unmounting and
787 * sharing/unsharing them.
788 */
789extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
790extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
791
792/*
793 * Mappings between vdev and FRU.
794 */
795extern void libzfs_fru_refresh(libzfs_handle_t *);
796extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
797extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
798extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
799 const char *);
800extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
801extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
802
803#ifndef illumos
804extern int zmount(const char *, const char *, int, char *, char *, int, char *,
805 int);
806#endif
807
808#ifdef __cplusplus
809}
810#endif
811
812#endif /* _LIBZFS_H */