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