xref: /illumos-gate/usr/src/lib/libzfs/common/libzfs.h (revision 753a6d45)
1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5441d80aaSlling  * Common Development and Distribution License (the "License").
6441d80aaSlling  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21f3861e1aSahl 
22fa9e4066Sahrens /*
2333408eefSLori Alt  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24fa9e4066Sahrens  * Use is subject to license terms.
25fa9e4066Sahrens  */
26fa9e4066Sahrens 
27fa9e4066Sahrens #ifndef	_LIBZFS_H
28fa9e4066Sahrens #define	_LIBZFS_H
29fa9e4066Sahrens 
30fa9e4066Sahrens #include <assert.h>
31fa9e4066Sahrens #include <libnvpair.h>
32ebedde84SEric Taylor #include <sys/mnttab.h>
33fa9e4066Sahrens #include <sys/param.h>
34fa9e4066Sahrens #include <sys/types.h>
35fa9e4066Sahrens #include <sys/varargs.h>
36fa9e4066Sahrens #include <sys/fs/zfs.h>
37ecd6cf80Smarks #include <sys/avl.h>
38ecd6cf80Smarks #include <ucred.h>
39fa9e4066Sahrens 
40fa9e4066Sahrens #ifdef	__cplusplus
41fa9e4066Sahrens extern "C" {
42fa9e4066Sahrens #endif
43fa9e4066Sahrens 
44fa9e4066Sahrens /*
45fa9e4066Sahrens  * Miscellaneous ZFS constants
46fa9e4066Sahrens  */
47fa9e4066Sahrens #define	ZFS_MAXNAMELEN		MAXNAMELEN
48fa9e4066Sahrens #define	ZPOOL_MAXNAMELEN	MAXNAMELEN
49fa9e4066Sahrens #define	ZFS_MAXPROPLEN		MAXPATHLEN
50990b4856Slling #define	ZPOOL_MAXPROPLEN	MAXPATHLEN
51fa9e4066Sahrens 
5299653d4eSeschrock /*
5399653d4eSeschrock  * libzfs errors
5499653d4eSeschrock  */
5599653d4eSeschrock enum {
5699653d4eSeschrock 	EZFS_NOMEM = 2000,	/* out of memory */
5799653d4eSeschrock 	EZFS_BADPROP,		/* invalid property value */
5899653d4eSeschrock 	EZFS_PROPREADONLY,	/* cannot set readonly property */
5999653d4eSeschrock 	EZFS_PROPTYPE,		/* property does not apply to dataset type */
6099653d4eSeschrock 	EZFS_PROPNONINHERIT,	/* property is not inheritable */
6199653d4eSeschrock 	EZFS_PROPSPACE,		/* bad quota or reservation */
6299653d4eSeschrock 	EZFS_BADTYPE,		/* dataset is not of appropriate type */
6399653d4eSeschrock 	EZFS_BUSY,		/* pool or dataset is busy */
6499653d4eSeschrock 	EZFS_EXISTS,		/* pool or dataset already exists */
6599653d4eSeschrock 	EZFS_NOENT,		/* no such pool or dataset */
6699653d4eSeschrock 	EZFS_BADSTREAM,		/* bad backup stream */
6799653d4eSeschrock 	EZFS_DSREADONLY,	/* dataset is readonly */
6899653d4eSeschrock 	EZFS_VOLTOOBIG,		/* volume is too large for 32-bit system */
6999653d4eSeschrock 	EZFS_VOLHASDATA,	/* volume already contains data */
7099653d4eSeschrock 	EZFS_INVALIDNAME,	/* invalid dataset name */
7199653d4eSeschrock 	EZFS_BADRESTORE,	/* unable to restore to destination */
7299653d4eSeschrock 	EZFS_BADBACKUP,		/* backup failed */
7399653d4eSeschrock 	EZFS_BADTARGET,		/* bad attach/detach/replace target */
7499653d4eSeschrock 	EZFS_NODEVICE,		/* no such device in pool */
7599653d4eSeschrock 	EZFS_BADDEV,		/* invalid device to add */
7699653d4eSeschrock 	EZFS_NOREPLICAS,	/* no valid replicas */
7799653d4eSeschrock 	EZFS_RESILVERING,	/* currently resilvering */
7899653d4eSeschrock 	EZFS_BADVERSION,	/* unsupported version */
7999653d4eSeschrock 	EZFS_POOLUNAVAIL,	/* pool is currently unavailable */
8099653d4eSeschrock 	EZFS_DEVOVERFLOW,	/* too many devices in one vdev */
8199653d4eSeschrock 	EZFS_BADPATH,		/* must be an absolute path */
8299653d4eSeschrock 	EZFS_CROSSTARGET,	/* rename or clone across pool or dataset */
8399653d4eSeschrock 	EZFS_ZONED,		/* used improperly in local zone */
8499653d4eSeschrock 	EZFS_MOUNTFAILED,	/* failed to mount dataset */
8599653d4eSeschrock 	EZFS_UMOUNTFAILED,	/* failed to unmount dataset */
86f3861e1aSahl 	EZFS_UNSHARENFSFAILED,	/* unshare(1M) failed */
87f3861e1aSahl 	EZFS_SHARENFSFAILED,	/* share(1M) failed */
8899653d4eSeschrock 	EZFS_DEVLINKS,		/* failed to create zvol links */
8999653d4eSeschrock 	EZFS_PERM,		/* permission denied */
9099653d4eSeschrock 	EZFS_NOSPC,		/* out of space */
9199653d4eSeschrock 	EZFS_IO,		/* I/O error */
9299653d4eSeschrock 	EZFS_INTR,		/* signal received */
9399653d4eSeschrock 	EZFS_ISSPARE,		/* device is a hot spare */
9499653d4eSeschrock 	EZFS_INVALCONFIG,	/* invalid vdev configuration */
953bb79becSeschrock 	EZFS_RECURSIVE,		/* recursive dependency */
9606eeb2adSek 	EZFS_NOHISTORY,		/* no history object */
97f3861e1aSahl 	EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */
98f3861e1aSahl 	EZFS_SHAREISCSIFAILED,	/* iscsitgtd failed request to share */
99b1b8ab34Slling 	EZFS_POOLPROPS,		/* couldn't retrieve pool props */
100b1b8ab34Slling 	EZFS_POOL_NOTSUP,	/* ops not supported for this type of pool */
101b1b8ab34Slling 	EZFS_POOL_INVALARG,	/* invalid argument for this pool operation */
102b7661cccSmmusante 	EZFS_NAMETOOLONG,	/* dataset name is too long */
1038488aeb5Staylor 	EZFS_OPENFAILED,	/* open of device failed */
1048488aeb5Staylor 	EZFS_NOCAP,		/* couldn't get capacity */
1058488aeb5Staylor 	EZFS_LABELFAILED,	/* write of label failed */
106ecd6cf80Smarks 	EZFS_ISCSISVCUNAVAIL,	/* iscsi service unavailable */
107ecd6cf80Smarks 	EZFS_BADWHO,		/* invalid permission who */
108ecd6cf80Smarks 	EZFS_BADPERM,		/* invalid permission */
109ecd6cf80Smarks 	EZFS_BADPERMSET,	/* invalid permission set name */
110ecd6cf80Smarks 	EZFS_NODELEGATION,	/* delegated administration is disabled */
111ecd6cf80Smarks 	EZFS_PERMRDONLY,	/* pemissions are readonly */
112da6c28aaSamw 	EZFS_UNSHARESMBFAILED,	/* failed to unshare over smb */
113da6c28aaSamw 	EZFS_SHARESMBFAILED,	/* failed to share over smb */
1142f8aaab3Seschrock 	EZFS_BADCACHE,		/* bad cache file */
115fa94a07fSbrendan 	EZFS_ISL2CACHE,		/* device is for the level 2 ARC */
116e7cbe64fSgw 	EZFS_VDEVNOTSUP,	/* unsupported vdev type */
11715e6edf1Sgw 	EZFS_NOTSUP,		/* ops not supported on this dataset */
11889a89ebfSlling 	EZFS_ACTIVE_SPARE,	/* pool has active shared spare devices */
119b1b8ab34Slling 	EZFS_UNKNOWN
12099653d4eSeschrock };
12199653d4eSeschrock 
122ecd6cf80Smarks /*
123ecd6cf80Smarks  * The following data structures are all part
124ecd6cf80Smarks  * of the zfs_allow_t data structure which is
125ecd6cf80Smarks  * used for printing 'allow' permissions.
126ecd6cf80Smarks  * It is a linked list of zfs_allow_t's which
127ecd6cf80Smarks  * then contain avl tree's for user/group/sets/...
128ecd6cf80Smarks  * and each one of the entries in those trees have
129ecd6cf80Smarks  * avl tree's for the permissions they belong to and
130ecd6cf80Smarks  * whether they are local,descendent or local+descendent
131ecd6cf80Smarks  * permissions.  The AVL trees are used primarily for
132ecd6cf80Smarks  * sorting purposes, but also so that we can quickly find
133ecd6cf80Smarks  * a given user and or permission.
134ecd6cf80Smarks  */
135ecd6cf80Smarks typedef struct zfs_perm_node {
136ecd6cf80Smarks 	avl_node_t z_node;
137ecd6cf80Smarks 	char z_pname[MAXPATHLEN];
138ecd6cf80Smarks } zfs_perm_node_t;
139ecd6cf80Smarks 
140ecd6cf80Smarks typedef struct zfs_allow_node {
141ecd6cf80Smarks 	avl_node_t z_node;
142ecd6cf80Smarks 	char z_key[MAXPATHLEN];		/* name, such as joe */
143ecd6cf80Smarks 	avl_tree_t z_localdescend;	/* local+descendent perms */
144ecd6cf80Smarks 	avl_tree_t z_local;		/* local permissions */
145ecd6cf80Smarks 	avl_tree_t z_descend;		/* descendent permissions */
146ecd6cf80Smarks } zfs_allow_node_t;
147ecd6cf80Smarks 
148ecd6cf80Smarks typedef struct zfs_allow {
149ecd6cf80Smarks 	struct zfs_allow *z_next;
150ecd6cf80Smarks 	char z_setpoint[MAXPATHLEN];
151ecd6cf80Smarks 	avl_tree_t z_sets;
152ecd6cf80Smarks 	avl_tree_t z_crperms;
153ecd6cf80Smarks 	avl_tree_t z_user;
154ecd6cf80Smarks 	avl_tree_t z_group;
155ecd6cf80Smarks 	avl_tree_t z_everyone;
156ecd6cf80Smarks } zfs_allow_t;
157ecd6cf80Smarks 
158fa9e4066Sahrens /*
159fa9e4066Sahrens  * Basic handle types
160fa9e4066Sahrens  */
161fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t;
162fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t;
16399653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t;
16499653d4eSeschrock 
16599653d4eSeschrock /*
16699653d4eSeschrock  * Library initialization
16799653d4eSeschrock  */
16899653d4eSeschrock extern libzfs_handle_t *libzfs_init(void);
16999653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *);
17099653d4eSeschrock 
17199653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
17299653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
17399653d4eSeschrock 
17499653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
17599653d4eSeschrock 
17699653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *);
17799653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *);
17899653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *);
179ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *);
180ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *);
181b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
182ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
183ebedde84SEric Taylor     struct mnttab *);
184ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
185ebedde84SEric Taylor     const char *, const char *);
186ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
187fa9e4066Sahrens 
188fa9e4066Sahrens /*
189fa9e4066Sahrens  * Basic handle functions
190fa9e4066Sahrens  */
19199653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
19299653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
193fa9e4066Sahrens extern void zpool_close(zpool_handle_t *);
194fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *);
195fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *);
196990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
19729ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *);
198fa9e4066Sahrens 
199fa9e4066Sahrens /*
200fa9e4066Sahrens  * Iterate over all active pools in the system.
201fa9e4066Sahrens  */
202fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
20399653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
204fa9e4066Sahrens 
205fa9e4066Sahrens /*
206fa9e4066Sahrens  * Functions to create and destroy pools
207fa9e4066Sahrens  */
20899653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
2090a48a24eStimh     nvlist_t *, nvlist_t *);
210fa9e4066Sahrens extern int zpool_destroy(zpool_handle_t *);
211fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *);
212fa9e4066Sahrens 
213fa9e4066Sahrens /*
214fa9e4066Sahrens  * Functions to manipulate pool and vdev state
215fa9e4066Sahrens  */
216fa9e4066Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
2173d7072f8Seschrock extern int zpool_clear(zpool_handle_t *, const char *);
218fa9e4066Sahrens 
2193d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
2203d7072f8Seschrock     vdev_state_t *);
2213d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
2223d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *,
2233d7072f8Seschrock     const char *, nvlist_t *, int);
224fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *);
22599653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *);
2263d7072f8Seschrock 
2273d7072f8Seschrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
2283d7072f8Seschrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
2293d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
2303d7072f8Seschrock 
231fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
232ee0eb9f2SEric Schrock     boolean_t *, boolean_t *);
2338488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
234fa9e4066Sahrens 
235b1b8ab34Slling /*
236b1b8ab34Slling  * Functions to manage pool properties
237b1b8ab34Slling  */
238b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
2393d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
240990b4856Slling     size_t proplen, zprop_source_t *);
241990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
242990b4856Slling     zprop_source_t *);
243990b4856Slling 
244b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t);
245b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t);
246b1b8ab34Slling 
247fa9e4066Sahrens /*
248fa9e4066Sahrens  * Pool health statistics.
249fa9e4066Sahrens  */
250fa9e4066Sahrens typedef enum {
251fa9e4066Sahrens 	/*
252fa9e4066Sahrens 	 * The following correspond to faults as defined in the (fault.fs.zfs.*)
253b81d61a6Slling 	 * event namespace.  Each is associated with a corresponding message ID.
254fa9e4066Sahrens 	 */
255fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */
256fa9e4066Sahrens 	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */
257fa9e4066Sahrens 	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */
258fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */
259b81d61a6Slling 	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */
260fa9e4066Sahrens 	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */
261fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */
262fa9e4066Sahrens 	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */
263fa9e4066Sahrens 	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */
264eaca9bbdSeschrock 	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */
26595173954Sek 	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */
26632b87932Sek 	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */
26732b87932Sek 	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
268f67f35c3SEric Schrock 	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */
269f67f35c3SEric Schrock 
270f67f35c3SEric Schrock 	/*
271f67f35c3SEric Schrock 	 * These faults have no corresponding message ID.  At the time we are
272f67f35c3SEric Schrock 	 * checking the status, the original reason for the FMA fault (I/O or
273f67f35c3SEric Schrock 	 * checksum errors) has been lost.
274f67f35c3SEric Schrock 	 */
2753d7072f8Seschrock 	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */
2763d7072f8Seschrock 	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */
277fa9e4066Sahrens 
278fa9e4066Sahrens 	/*
279fa9e4066Sahrens 	 * The following are not faults per se, but still an error possibly
280b81d61a6Slling 	 * requiring administrative attention.  There is no corresponding
281fa9e4066Sahrens 	 * message ID.
282fa9e4066Sahrens 	 */
283eaca9bbdSeschrock 	ZPOOL_STATUS_VERSION_OLDER,	/* older on-disk version */
284fa9e4066Sahrens 	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */
285fa9e4066Sahrens 	ZPOOL_STATUS_OFFLINE_DEV,	/* device online */
286fa9e4066Sahrens 
287fa9e4066Sahrens 	/*
288fa9e4066Sahrens 	 * Finally, the following indicates a healthy pool.
289fa9e4066Sahrens 	 */
290fa9e4066Sahrens 	ZPOOL_STATUS_OK
291fa9e4066Sahrens } zpool_status_t;
292fa9e4066Sahrens 
293ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
294ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **);
295fa9e4066Sahrens 
296fa9e4066Sahrens /*
297fa9e4066Sahrens  * Statistics and configuration functions.
298fa9e4066Sahrens  */
299ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
30094de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
30155434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
302ea8dc4b6Seschrock 
303fa9e4066Sahrens /*
304fa9e4066Sahrens  * Import and export functions
305fa9e4066Sahrens  */
30689a89ebfSlling extern int zpool_export(zpool_handle_t *, boolean_t);
307394ab0cbSGeorge Wilson extern int zpool_export_force(zpool_handle_t *);
30899653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
309990b4856Slling     char *altroot);
310990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
311c5904d13Seschrock     nvlist_t *, boolean_t);
312fa9e4066Sahrens 
313fa9e4066Sahrens /*
314fa9e4066Sahrens  * Search for pools to import
315fa9e4066Sahrens  */
31624e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
3173a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
318e829d913Sck     char *, uint64_t);
31924e697d4Sck extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **,
32024e697d4Sck     char *);
32124e697d4Sck extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **,
32224e697d4Sck     uint64_t);
32324e697d4Sck extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **);
324fa9e4066Sahrens 
325c67d9675Seschrock /*
326c67d9675Seschrock  * Miscellaneous pool functions
327c67d9675Seschrock  */
328ecd6cf80Smarks struct zfs_cmd;
329ecd6cf80Smarks 
33099653d4eSeschrock extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
331990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t);
33206eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
3332a6b87f0Sek extern void zpool_set_history_str(const char *subcommand, int argc,
3342a6b87f0Sek     char **argv, char *history_str);
3352a6b87f0Sek extern int zpool_stage_history(libzfs_handle_t *, const char *);
33655434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
33755434c77Sek     size_t len);
338ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
339*753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
340*753a6d45SSherry Moore 
341fa9e4066Sahrens /*
342fa9e4066Sahrens  * Basic handle manipulations.  These functions do not create or destroy the
343fa9e4066Sahrens  * underlying datasets, only the references to them.
344fa9e4066Sahrens  */
34599653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
346fa9e4066Sahrens extern void zfs_close(zfs_handle_t *);
347fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *);
348fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *);
349d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
350fa9e4066Sahrens 
351fa9e4066Sahrens /*
352fa9e4066Sahrens  * Property management functions.  Some functions are shared with the kernel,
353b81d61a6Slling  * and are found in sys/fs/zfs.h.
354fa9e4066Sahrens  */
355990b4856Slling 
356990b4856Slling /*
357990b4856Slling  * zfs dataset property management
358990b4856Slling  */
359990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t);
360990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
361990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t);
362990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t);
363990b4856Slling 
3640a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
3650a48a24eStimh     nvlist_t *, uint64_t, zfs_handle_t *, const char *);
3660a48a24eStimh 
367e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t);
368e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
369e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
370990b4856Slling     zprop_source_t *, char *, size_t, boolean_t);
371e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
372990b4856Slling     zprop_source_t *, char *, size_t);
373e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
374e9dbad6fSeschrock extern int zfs_prop_inherit(zfs_handle_t *, const char *);
375e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t);
376e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop);
377990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
378e9dbad6fSeschrock 
379990b4856Slling typedef struct zprop_list {
380990b4856Slling 	int		pl_prop;
381e9dbad6fSeschrock 	char		*pl_user_prop;
382990b4856Slling 	struct zprop_list *pl_next;
383e9dbad6fSeschrock 	boolean_t	pl_all;
384e9dbad6fSeschrock 	size_t		pl_width;
385e9dbad6fSeschrock 	boolean_t	pl_fixed;
386990b4856Slling } zprop_list_t;
387e9dbad6fSeschrock 
388990b4856Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **);
3892e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
390fa9e4066Sahrens 
391fa9e4066Sahrens #define	ZFS_MOUNTPOINT_NONE	"none"
392fa9e4066Sahrens #define	ZFS_MOUNTPOINT_LEGACY	"legacy"
393fa9e4066Sahrens 
394b1b8ab34Slling /*
395990b4856Slling  * zpool property management
396990b4856Slling  */
397990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
398990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t);
399990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
400990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t);
401990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t);
402990b4856Slling 
403990b4856Slling /*
404990b4856Slling  * Functions shared by zfs and zpool property management.
405b1b8ab34Slling  */
406990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
407990b4856Slling     boolean_t ordered, zfs_type_t type);
408990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
409990b4856Slling     zfs_type_t);
410990b4856Slling extern void zprop_free_list(zprop_list_t *);
411990b4856Slling 
412990b4856Slling /*
413990b4856Slling  * Functions for printing zfs or zpool properties
414990b4856Slling  */
415990b4856Slling typedef struct zprop_get_cbdata {
416b1b8ab34Slling 	int cb_sources;
417b1b8ab34Slling 	int cb_columns[4];
418b1b8ab34Slling 	int cb_colwidths[5];
419b1b8ab34Slling 	boolean_t cb_scripted;
420b1b8ab34Slling 	boolean_t cb_literal;
421b1b8ab34Slling 	boolean_t cb_first;
422990b4856Slling 	zprop_list_t *cb_proplist;
423990b4856Slling 	zfs_type_t cb_type;
424990b4856Slling } zprop_get_cbdata_t;
425b1b8ab34Slling 
426990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
427990b4856Slling     const char *, const char *, zprop_source_t, const char *);
428b1b8ab34Slling 
429b1b8ab34Slling #define	GET_COL_NAME		1
430b1b8ab34Slling #define	GET_COL_PROPERTY	2
431b1b8ab34Slling #define	GET_COL_VALUE		3
432b1b8ab34Slling #define	GET_COL_SOURCE		4
433b1b8ab34Slling 
434fa9e4066Sahrens /*
435fa9e4066Sahrens  * Iterator functions.
436fa9e4066Sahrens  */
437fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
43899653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
439fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
4403bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
4417f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
4427f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
443fa9e4066Sahrens 
444fa9e4066Sahrens /*
445fa9e4066Sahrens  * Functions to create and destroy datasets.
446fa9e4066Sahrens  */
44799653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
448e9dbad6fSeschrock     nvlist_t *);
4497f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
450fa9e4066Sahrens extern int zfs_destroy(zfs_handle_t *);
4511d452cf5Sahrens extern int zfs_destroy_snaps(zfs_handle_t *, char *);
452e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
453bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
454c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
4557f1f55eaSvb extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
4563cb34c60Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *,
4573cb34c60Sahrens     boolean_t, boolean_t, boolean_t, boolean_t, int);
45899653d4eSeschrock extern int zfs_promote(zfs_handle_t *);
459fa9e4066Sahrens 
4603cb34c60Sahrens typedef struct recvflags {
4614ccbb6e7Sahrens 	/* print informational messages (ie, -v was specified) */
462c6765aabSeschrock 	int verbose : 1;
4634ccbb6e7Sahrens 
4644ccbb6e7Sahrens 	/* the destination is a prefix, not the exact fs (ie, -d) */
465c6765aabSeschrock 	int isprefix : 1;
4664ccbb6e7Sahrens 
4674ccbb6e7Sahrens 	/* do not actually do the recv, just check if it would work (ie, -n) */
468c6765aabSeschrock 	int dryrun : 1;
4694ccbb6e7Sahrens 
4704ccbb6e7Sahrens 	/* rollback/destroy filesystems as necessary (eg, -F) */
471c6765aabSeschrock 	int force : 1;
4724ccbb6e7Sahrens 
4734ccbb6e7Sahrens 	/* set "canmount=off" on all modified filesystems */
474c6765aabSeschrock 	int canmountoff : 1;
4754ccbb6e7Sahrens 
4764ccbb6e7Sahrens 	/* byteswap flag is used internally; callers need not specify */
477c6765aabSeschrock 	int byteswap : 1;
47833408eefSLori Alt 
47933408eefSLori Alt 	/* do not mount file systems as they are extracted (private) */
48033408eefSLori Alt 	int nomount : 1;
4813cb34c60Sahrens } recvflags_t;
4823cb34c60Sahrens 
4833cb34c60Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
4843cb34c60Sahrens     int, avl_tree_t *);
4853cb34c60Sahrens 
486fa9e4066Sahrens /*
487fa9e4066Sahrens  * Miscellaneous functions.
488fa9e4066Sahrens  */
489fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t);
490fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *);
491fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t);
4925aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
4937f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
4947f1f55eaSvb     zfs_type_t);
4957b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *);
496fa9e4066Sahrens 
497ecd6cf80Smarks /*
498ecd6cf80Smarks  * dataset permission functions.
499ecd6cf80Smarks  */
500ecd6cf80Smarks extern int zfs_perm_set(zfs_handle_t *, nvlist_t *);
501ecd6cf80Smarks extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *);
502ecd6cf80Smarks extern int zfs_build_perms(zfs_handle_t *, char *, char *,
503ecd6cf80Smarks     zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t);
504ecd6cf80Smarks extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **);
505ecd6cf80Smarks extern void zfs_free_allows(zfs_allow_t *);
5066949a980Smarks extern void zfs_deleg_permissions(void);
507ecd6cf80Smarks 
508fa9e4066Sahrens /*
509fa9e4066Sahrens  * Mount support functions.
510fa9e4066Sahrens  */
51155434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
51299653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
513fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int);
514fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int);
515fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int);
516fa9e4066Sahrens 
517fa9e4066Sahrens /*
518fa9e4066Sahrens  * Share support functions.
519fa9e4066Sahrens  */
520f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *);
521fa9e4066Sahrens extern int zfs_share(zfs_handle_t *);
522f3861e1aSahl extern int zfs_unshare(zfs_handle_t *);
523f3861e1aSahl 
524f3861e1aSahl /*
5253d7072f8Seschrock  * Protocol-specific share support functions.
526f3861e1aSahl  */
527f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
528da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
529f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *);
530da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *);
531da6c28aaSamw extern int zfs_shareall(zfs_handle_t *);
532f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
533da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *);
534f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *);
535da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *);
536da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
537da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *);
538f3861e1aSahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
539f3861e1aSahl extern int zfs_share_iscsi(zfs_handle_t *);
540f3861e1aSahl extern int zfs_unshare_iscsi(zfs_handle_t *);
541ecd6cf80Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *);
542743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
543da6c28aaSamw     void *, void *, int, zfs_share_op_t);
544fa9e4066Sahrens 
545fa9e4066Sahrens /*
546fa9e4066Sahrens  * When dealing with nvlists, verify() is extremely useful
547fa9e4066Sahrens  */
548fa9e4066Sahrens #ifdef NDEBUG
549fa9e4066Sahrens #define	verify(EX)	((void)(EX))
550fa9e4066Sahrens #else
551fa9e4066Sahrens #define	verify(EX)	assert(EX)
552fa9e4066Sahrens #endif
553fa9e4066Sahrens 
554fa9e4066Sahrens /*
555fa9e4066Sahrens  * Utility function to convert a number to a human-readable form.
556fa9e4066Sahrens  */
557fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t);
558e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
559fa9e4066Sahrens 
560fa9e4066Sahrens /*
561fa9e4066Sahrens  * Given a device or file, determine if it is part of a pool.
562fa9e4066Sahrens  */
56399653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
56499653d4eSeschrock     boolean_t *);
565fa9e4066Sahrens 
566fa9e4066Sahrens /*
567fa9e4066Sahrens  * ftyp special.  Read the label from a given device.
568fa9e4066Sahrens  */
56999653d4eSeschrock extern int zpool_read_label(int, nvlist_t **);
570fa9e4066Sahrens 
571fa9e4066Sahrens /*
572f3861e1aSahl  * Create and remove zvol /dev links.
573fa9e4066Sahrens  */
574fa9e4066Sahrens extern int zpool_create_zvol_links(zpool_handle_t *);
575fa9e4066Sahrens extern int zpool_remove_zvol_links(zpool_handle_t *);
576fa9e4066Sahrens 
577e7cbe64fSgw /* is this zvol valid for use as a dump device? */
578e7cbe64fSgw extern int zvol_check_dump_config(char *);
579e7cbe64fSgw 
580743a77edSAlan Wright /*
581743a77edSAlan Wright  * Management interfaces for SMB ACL files
582743a77edSAlan Wright  */
583743a77edSAlan Wright 
584743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
585743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
586743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
587743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
588743a77edSAlan Wright 
5893bb79becSeschrock /*
590f3861e1aSahl  * Enable and disable datasets within a pool by mounting/unmounting and
591f3861e1aSahl  * sharing/unsharing them.
5923bb79becSeschrock  */
593f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
594f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
5953bb79becSeschrock 
596fa9e4066Sahrens #ifdef	__cplusplus
597fa9e4066Sahrens }
598fa9e4066Sahrens #endif
599fa9e4066Sahrens 
600fa9e4066Sahrens #endif	/* _LIBZFS_H */
601