xref: /onnv-gate/usr/src/lib/libzfs/common/libzfs.h (revision 10242)
1789Sahrens /*
2789Sahrens  * CDDL HEADER START
3789Sahrens  *
4789Sahrens  * The contents of this file are subject to the terms of the
51485Slling  * Common Development and Distribution License (the "License").
61485Slling  * You may not use this file except in compliance with the License.
7789Sahrens  *
8789Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9789Sahrens  * or http://www.opensolaris.org/os/licensing.
10789Sahrens  * See the License for the specific language governing permissions
11789Sahrens  * and limitations under the License.
12789Sahrens  *
13789Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14789Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15789Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16789Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17789Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18789Sahrens  *
19789Sahrens  * CDDL HEADER END
20789Sahrens  */
213126Sahl 
22789Sahrens /*
238584SLori.Alt@Sun.COM  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24789Sahrens  * Use is subject to license terms.
25789Sahrens  */
26789Sahrens 
27789Sahrens #ifndef	_LIBZFS_H
28789Sahrens #define	_LIBZFS_H
29789Sahrens 
30789Sahrens #include <assert.h>
31789Sahrens #include <libnvpair.h>
328228SEric.Taylor@Sun.COM #include <sys/mnttab.h>
33789Sahrens #include <sys/param.h>
34789Sahrens #include <sys/types.h>
35789Sahrens #include <sys/varargs.h>
36789Sahrens #include <sys/fs/zfs.h>
374543Smarks #include <sys/avl.h>
384543Smarks #include <ucred.h>
39789Sahrens 
40789Sahrens #ifdef	__cplusplus
41789Sahrens extern "C" {
42789Sahrens #endif
43789Sahrens 
44789Sahrens /*
45789Sahrens  * Miscellaneous ZFS constants
46789Sahrens  */
47789Sahrens #define	ZFS_MAXNAMELEN		MAXNAMELEN
48789Sahrens #define	ZPOOL_MAXNAMELEN	MAXNAMELEN
49789Sahrens #define	ZFS_MAXPROPLEN		MAXPATHLEN
505094Slling #define	ZPOOL_MAXPROPLEN	MAXPATHLEN
51789Sahrens 
52789Sahrens /*
532082Seschrock  * libzfs errors
542082Seschrock  */
552082Seschrock enum {
562082Seschrock 	EZFS_NOMEM = 2000,	/* out of memory */
572082Seschrock 	EZFS_BADPROP,		/* invalid property value */
582082Seschrock 	EZFS_PROPREADONLY,	/* cannot set readonly property */
592082Seschrock 	EZFS_PROPTYPE,		/* property does not apply to dataset type */
602082Seschrock 	EZFS_PROPNONINHERIT,	/* property is not inheritable */
612082Seschrock 	EZFS_PROPSPACE,		/* bad quota or reservation */
622082Seschrock 	EZFS_BADTYPE,		/* dataset is not of appropriate type */
632082Seschrock 	EZFS_BUSY,		/* pool or dataset is busy */
642082Seschrock 	EZFS_EXISTS,		/* pool or dataset already exists */
652082Seschrock 	EZFS_NOENT,		/* no such pool or dataset */
662082Seschrock 	EZFS_BADSTREAM,		/* bad backup stream */
672082Seschrock 	EZFS_DSREADONLY,	/* dataset is readonly */
682082Seschrock 	EZFS_VOLTOOBIG,		/* volume is too large for 32-bit system */
692082Seschrock 	EZFS_VOLHASDATA,	/* volume already contains data */
702082Seschrock 	EZFS_INVALIDNAME,	/* invalid dataset name */
712082Seschrock 	EZFS_BADRESTORE,	/* unable to restore to destination */
722082Seschrock 	EZFS_BADBACKUP,		/* backup failed */
732082Seschrock 	EZFS_BADTARGET,		/* bad attach/detach/replace target */
742082Seschrock 	EZFS_NODEVICE,		/* no such device in pool */
752082Seschrock 	EZFS_BADDEV,		/* invalid device to add */
762082Seschrock 	EZFS_NOREPLICAS,	/* no valid replicas */
772082Seschrock 	EZFS_RESILVERING,	/* currently resilvering */
782082Seschrock 	EZFS_BADVERSION,	/* unsupported version */
792082Seschrock 	EZFS_POOLUNAVAIL,	/* pool is currently unavailable */
802082Seschrock 	EZFS_DEVOVERFLOW,	/* too many devices in one vdev */
812082Seschrock 	EZFS_BADPATH,		/* must be an absolute path */
822082Seschrock 	EZFS_CROSSTARGET,	/* rename or clone across pool or dataset */
832082Seschrock 	EZFS_ZONED,		/* used improperly in local zone */
842082Seschrock 	EZFS_MOUNTFAILED,	/* failed to mount dataset */
852082Seschrock 	EZFS_UMOUNTFAILED,	/* failed to unmount dataset */
863126Sahl 	EZFS_UNSHARENFSFAILED,	/* unshare(1M) failed */
873126Sahl 	EZFS_SHARENFSFAILED,	/* share(1M) failed */
882082Seschrock 	EZFS_DEVLINKS,		/* failed to create zvol links */
892082Seschrock 	EZFS_PERM,		/* permission denied */
902082Seschrock 	EZFS_NOSPC,		/* out of space */
912082Seschrock 	EZFS_IO,		/* I/O error */
922082Seschrock 	EZFS_INTR,		/* signal received */
932082Seschrock 	EZFS_ISSPARE,		/* device is a hot spare */
942082Seschrock 	EZFS_INVALCONFIG,	/* invalid vdev configuration */
952474Seschrock 	EZFS_RECURSIVE,		/* recursive dependency */
962926Sek110237 	EZFS_NOHISTORY,		/* no history object */
973126Sahl 	EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */
983126Sahl 	EZFS_SHAREISCSIFAILED,	/* iscsitgtd failed request to share */
993912Slling 	EZFS_POOLPROPS,		/* couldn't retrieve pool props */
1003912Slling 	EZFS_POOL_NOTSUP,	/* ops not supported for this type of pool */
1013912Slling 	EZFS_POOL_INVALARG,	/* invalid argument for this pool operation */
1023978Smmusante 	EZFS_NAMETOOLONG,	/* dataset name is too long */
1034276Staylor 	EZFS_OPENFAILED,	/* open of device failed */
1044276Staylor 	EZFS_NOCAP,		/* couldn't get capacity */
1054276Staylor 	EZFS_LABELFAILED,	/* write of label failed */
1064543Smarks 	EZFS_ISCSISVCUNAVAIL,	/* iscsi service unavailable */
1074543Smarks 	EZFS_BADWHO,		/* invalid permission who */
1084543Smarks 	EZFS_BADPERM,		/* invalid permission */
1094543Smarks 	EZFS_BADPERMSET,	/* invalid permission set name */
1104543Smarks 	EZFS_NODELEGATION,	/* delegated administration is disabled */
1114543Smarks 	EZFS_PERMRDONLY,	/* pemissions are readonly */
1125331Samw 	EZFS_UNSHARESMBFAILED,	/* failed to unshare over smb */
1135331Samw 	EZFS_SHARESMBFAILED,	/* failed to share over smb */
1145363Seschrock 	EZFS_BADCACHE,		/* bad cache file */
1155450Sbrendan 	EZFS_ISL2CACHE,		/* device is for the level 2 ARC */
1166423Sgw25295 	EZFS_VDEVNOTSUP,	/* unsupported vdev type */
1177042Sgw25295 	EZFS_NOTSUP,		/* ops not supported on this dataset */
1187214Slling 	EZFS_ACTIVE_SPARE,	/* pool has active shared spare devices */
1199701SGeorge.Wilson@Sun.COM 	EZFS_UNPLAYED_LOGS,	/* log device has unplayed logs */
120*10242Schris.kirby@sun.com 	EZFS_REFTAG_RELE,	/* snapshot release: tag not found */
121*10242Schris.kirby@sun.com 	EZFS_REFTAG_HOLD,	/* snapshot hold: tag already exists */
1223912Slling 	EZFS_UNKNOWN
1232082Seschrock };
1242082Seschrock 
1252082Seschrock /*
1264543Smarks  * The following data structures are all part
1274543Smarks  * of the zfs_allow_t data structure which is
1284543Smarks  * used for printing 'allow' permissions.
1294543Smarks  * It is a linked list of zfs_allow_t's which
1304543Smarks  * then contain avl tree's for user/group/sets/...
1314543Smarks  * and each one of the entries in those trees have
1324543Smarks  * avl tree's for the permissions they belong to and
1334543Smarks  * whether they are local,descendent or local+descendent
1344543Smarks  * permissions.  The AVL trees are used primarily for
1354543Smarks  * sorting purposes, but also so that we can quickly find
1364543Smarks  * a given user and or permission.
1374543Smarks  */
1384543Smarks typedef struct zfs_perm_node {
1394543Smarks 	avl_node_t z_node;
1404543Smarks 	char z_pname[MAXPATHLEN];
1414543Smarks } zfs_perm_node_t;
1424543Smarks 
1434543Smarks typedef struct zfs_allow_node {
1444543Smarks 	avl_node_t z_node;
1454543Smarks 	char z_key[MAXPATHLEN];		/* name, such as joe */
1464543Smarks 	avl_tree_t z_localdescend;	/* local+descendent perms */
1474543Smarks 	avl_tree_t z_local;		/* local permissions */
1484543Smarks 	avl_tree_t z_descend;		/* descendent permissions */
1494543Smarks } zfs_allow_node_t;
1504543Smarks 
1514543Smarks typedef struct zfs_allow {
1524543Smarks 	struct zfs_allow *z_next;
1534543Smarks 	char z_setpoint[MAXPATHLEN];
1544543Smarks 	avl_tree_t z_sets;
1554543Smarks 	avl_tree_t z_crperms;
1564543Smarks 	avl_tree_t z_user;
1574543Smarks 	avl_tree_t z_group;
1584543Smarks 	avl_tree_t z_everyone;
1594543Smarks } zfs_allow_t;
1604543Smarks 
1614543Smarks /*
162789Sahrens  * Basic handle types
163789Sahrens  */
164789Sahrens typedef struct zfs_handle zfs_handle_t;
165789Sahrens typedef struct zpool_handle zpool_handle_t;
1662082Seschrock typedef struct libzfs_handle libzfs_handle_t;
1672082Seschrock 
1682082Seschrock /*
1692082Seschrock  * Library initialization
1702082Seschrock  */
1712082Seschrock extern libzfs_handle_t *libzfs_init(void);
1722082Seschrock extern void libzfs_fini(libzfs_handle_t *);
1732082Seschrock 
1742082Seschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
1752082Seschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
1762082Seschrock 
1772082Seschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
1782082Seschrock 
1792082Seschrock extern int libzfs_errno(libzfs_handle_t *);
1802082Seschrock extern const char *libzfs_error_action(libzfs_handle_t *);
1812082Seschrock extern const char *libzfs_error_description(libzfs_handle_t *);
1828228SEric.Taylor@Sun.COM extern void libzfs_mnttab_init(libzfs_handle_t *);
1838228SEric.Taylor@Sun.COM extern void libzfs_mnttab_fini(libzfs_handle_t *);
1848811SEric.Taylor@Sun.COM extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
1858228SEric.Taylor@Sun.COM extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
1868228SEric.Taylor@Sun.COM     struct mnttab *);
1878228SEric.Taylor@Sun.COM extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
1888228SEric.Taylor@Sun.COM     const char *, const char *);
1898228SEric.Taylor@Sun.COM extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
190789Sahrens 
191789Sahrens /*
192789Sahrens  * Basic handle functions
193789Sahrens  */
1942082Seschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
1952082Seschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
196789Sahrens extern void zpool_close(zpool_handle_t *);
197789Sahrens extern const char *zpool_get_name(zpool_handle_t *);
198789Sahrens extern int zpool_get_state(zpool_handle_t *);
1995094Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
2006865Srm160521 extern void zpool_free_handles(libzfs_handle_t *);
201789Sahrens 
202789Sahrens /*
203789Sahrens  * Iterate over all active pools in the system.
204789Sahrens  */
205789Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
2062082Seschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
207789Sahrens 
208789Sahrens /*
209789Sahrens  * Functions to create and destroy pools
210789Sahrens  */
2112082Seschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
2127184Stimh     nvlist_t *, nvlist_t *);
213789Sahrens extern int zpool_destroy(zpool_handle_t *);
214789Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *);
215789Sahrens 
216789Sahrens /*
217789Sahrens  * Functions to manipulate pool and vdev state
218789Sahrens  */
219789Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
2204451Seschrock extern int zpool_clear(zpool_handle_t *, const char *);
221789Sahrens 
2224451Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
2234451Seschrock     vdev_state_t *);
2244451Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
2254451Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *,
2264451Seschrock     const char *, nvlist_t *, int);
227789Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *);
2282082Seschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *);
2294451Seschrock 
2304451Seschrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
2314451Seschrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
2324451Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
2334451Seschrock 
2345450Sbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
2357326SEric.Schrock@Sun.COM     boolean_t *, boolean_t *);
2369816SGeorge.Wilson@Sun.COM extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
2379816SGeorge.Wilson@Sun.COM     boolean_t *, boolean_t *, boolean_t *);
2384276Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
239789Sahrens 
240789Sahrens /*
2413912Slling  * Functions to manage pool properties
2423912Slling  */
2433912Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
2444451Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
2455094Slling     size_t proplen, zprop_source_t *);
2465094Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
2475094Slling     zprop_source_t *);
2485094Slling 
2493912Slling extern const char *zpool_prop_to_name(zpool_prop_t);
2503912Slling extern const char *zpool_prop_values(zpool_prop_t);
2513912Slling 
2523912Slling /*
253789Sahrens  * Pool health statistics.
254789Sahrens  */
255789Sahrens typedef enum {
256789Sahrens 	/*
257789Sahrens 	 * The following correspond to faults as defined in the (fault.fs.zfs.*)
2581003Slling 	 * event namespace.  Each is associated with a corresponding message ID.
259789Sahrens 	 */
260789Sahrens 	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */
261789Sahrens 	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */
262789Sahrens 	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */
263789Sahrens 	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */
2641003Slling 	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */
265789Sahrens 	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */
266789Sahrens 	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */
267789Sahrens 	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */
268789Sahrens 	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */
2691760Seschrock 	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */
2703975Sek110237 	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */
2716523Sek110237 	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */
2726523Sek110237 	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
2738343SEric.Schrock@Sun.COM 	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */
2748343SEric.Schrock@Sun.COM 
2758343SEric.Schrock@Sun.COM 	/*
2768343SEric.Schrock@Sun.COM 	 * These faults have no corresponding message ID.  At the time we are
2778343SEric.Schrock@Sun.COM 	 * checking the status, the original reason for the FMA fault (I/O or
2788343SEric.Schrock@Sun.COM 	 * checksum errors) has been lost.
2798343SEric.Schrock@Sun.COM 	 */
2804451Seschrock 	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */
2814451Seschrock 	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */
282789Sahrens 
283789Sahrens 	/*
284789Sahrens 	 * The following are not faults per se, but still an error possibly
2851003Slling 	 * requiring administrative attention.  There is no corresponding
286789Sahrens 	 * message ID.
287789Sahrens 	 */
2881760Seschrock 	ZPOOL_STATUS_VERSION_OLDER,	/* older on-disk version */
289789Sahrens 	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */
290789Sahrens 	ZPOOL_STATUS_OFFLINE_DEV,	/* device online */
29110151SGeorge.Wilson@Sun.COM 	ZPOOL_STATUS_REMOVED_DEV,	/* removed device */
292789Sahrens 
293789Sahrens 	/*
294789Sahrens 	 * Finally, the following indicates a healthy pool.
295789Sahrens 	 */
296789Sahrens 	ZPOOL_STATUS_OK
297789Sahrens } zpool_status_t;
298789Sahrens 
2991544Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
3001544Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **);
301789Sahrens 
302789Sahrens /*
303789Sahrens  * Statistics and configuration functions.
304789Sahrens  */
3051544Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
3062142Seschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
3073444Sek110237 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
3081544Seschrock 
309789Sahrens /*
310789Sahrens  * Import and export functions
311789Sahrens  */
3127214Slling extern int zpool_export(zpool_handle_t *, boolean_t);
3138211SGeorge.Wilson@Sun.COM extern int zpool_export_force(zpool_handle_t *);
3142082Seschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
3155094Slling     char *altroot);
3165094Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
3176643Seschrock     nvlist_t *, boolean_t);
318789Sahrens 
319789Sahrens /*
320789Sahrens  * Search for pools to import
321789Sahrens  */
3226807Sck153898 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
3235994Sck153898 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
3246957Sck153898     char *, uint64_t);
3256807Sck153898 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **,
3266807Sck153898     char *);
3276807Sck153898 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **,
3286807Sck153898     uint64_t);
3296807Sck153898 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **);
330789Sahrens 
331789Sahrens /*
3321354Seschrock  * Miscellaneous pool functions
3331354Seschrock  */
3344543Smarks struct zfs_cmd;
3354543Smarks 
3362082Seschrock extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
3375094Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t);
3382926Sek110237 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
3394988Sek110237 extern void zpool_set_history_str(const char *subcommand, int argc,
3404988Sek110237     char **argv, char *history_str);
3414988Sek110237 extern int zpool_stage_history(libzfs_handle_t *, const char *);
3423444Sek110237 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
3433444Sek110237     size_t len);
3444543Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
3459160SSherry.Moore@Sun.COM extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
3469160SSherry.Moore@Sun.COM 
3471354Seschrock /*
348789Sahrens  * Basic handle manipulations.  These functions do not create or destroy the
349789Sahrens  * underlying datasets, only the references to them.
350789Sahrens  */
3512082Seschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
352789Sahrens extern void zfs_close(zfs_handle_t *);
353789Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *);
354789Sahrens extern const char *zfs_get_name(const zfs_handle_t *);
3557538SRichard.Morris@Sun.COM extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
356789Sahrens 
357789Sahrens /*
358789Sahrens  * Property management functions.  Some functions are shared with the kernel,
3591003Slling  * and are found in sys/fs/zfs.h.
360789Sahrens  */
3615094Slling 
3625094Slling /*
3635094Slling  * zfs dataset property management
3645094Slling  */
3655094Slling extern const char *zfs_prop_default_string(zfs_prop_t);
3662676Seschrock extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
3672676Seschrock extern const char *zfs_prop_column_name(zfs_prop_t);
3682676Seschrock extern boolean_t zfs_prop_align_right(zfs_prop_t);
3692676Seschrock 
3707184Stimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
3717184Stimh     nvlist_t *, uint64_t, zfs_handle_t *, const char *);
3727184Stimh 
3735094Slling extern const char *zfs_prop_to_name(zfs_prop_t);
3745094Slling extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
3755094Slling extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
3765094Slling     zprop_source_t *, char *, size_t, boolean_t);
3775094Slling extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
3785094Slling     zprop_source_t *, char *, size_t);
3799469SLin.Ling@Sun.COM extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
3809469SLin.Ling@Sun.COM     uint64_t *propvalue);
3819396SMatthew.Ahrens@Sun.COM extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
3829396SMatthew.Ahrens@Sun.COM     char *propbuf, int proplen, boolean_t literal);
3835094Slling extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
3845094Slling extern int zfs_prop_inherit(zfs_handle_t *, const char *);
3855094Slling extern const char *zfs_prop_values(zfs_prop_t);
3865094Slling extern int zfs_prop_is_string(zfs_prop_t prop);
3875094Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
3885094Slling 
3895094Slling typedef struct zprop_list {
3905094Slling 	int		pl_prop;
3912676Seschrock 	char		*pl_user_prop;
3925094Slling 	struct zprop_list *pl_next;
3932676Seschrock 	boolean_t	pl_all;
3942676Seschrock 	size_t		pl_width;
3952676Seschrock 	boolean_t	pl_fixed;
3965094Slling } zprop_list_t;
3973912Slling 
3985094Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **);
3998802SSanjeev.Bagewadi@Sun.COM extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
400789Sahrens 
401789Sahrens #define	ZFS_MOUNTPOINT_NONE	"none"
402789Sahrens #define	ZFS_MOUNTPOINT_LEGACY	"legacy"
403789Sahrens 
404789Sahrens /*
4055094Slling  * zpool property management
4065094Slling  */
4075094Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
4085094Slling extern const char *zpool_prop_default_string(zpool_prop_t);
4095094Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
4105094Slling extern const char *zpool_prop_column_name(zpool_prop_t);
4115094Slling extern boolean_t zpool_prop_align_right(zpool_prop_t);
4125094Slling 
4135094Slling /*
4145094Slling  * Functions shared by zfs and zpool property management.
4153912Slling  */
4165094Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
4175094Slling     boolean_t ordered, zfs_type_t type);
4185094Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
4195094Slling     zfs_type_t);
4205094Slling extern void zprop_free_list(zprop_list_t *);
4215094Slling 
4225094Slling /*
4235094Slling  * Functions for printing zfs or zpool properties
4245094Slling  */
4255094Slling typedef struct zprop_get_cbdata {
4263912Slling 	int cb_sources;
4273912Slling 	int cb_columns[4];
4283912Slling 	int cb_colwidths[5];
4293912Slling 	boolean_t cb_scripted;
4303912Slling 	boolean_t cb_literal;
4313912Slling 	boolean_t cb_first;
4325094Slling 	zprop_list_t *cb_proplist;
4335094Slling 	zfs_type_t cb_type;
4345094Slling } zprop_get_cbdata_t;
4353912Slling 
4365094Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
4375094Slling     const char *, const char *, zprop_source_t, const char *);
4383912Slling 
4393912Slling #define	GET_COL_NAME		1
4403912Slling #define	GET_COL_PROPERTY	2
4413912Slling #define	GET_COL_VALUE		3
4423912Slling #define	GET_COL_SOURCE		4
4433912Slling 
4443912Slling /*
445789Sahrens  * Iterator functions.
446789Sahrens  */
447789Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
4482082Seschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
449789Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
4502474Seschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
4511356Seschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
4521356Seschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
453789Sahrens 
454789Sahrens /*
455789Sahrens  * Functions to create and destroy datasets.
456789Sahrens  */
4572082Seschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
4582676Seschrock     nvlist_t *);
4594490Svb160487 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
460*10242Schris.kirby@sun.com extern int zfs_destroy(zfs_handle_t *, boolean_t);
461*10242Schris.kirby@sun.com extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
4622676Seschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
4637265Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
4645749Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
4654490Svb160487 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
4665367Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *,
4675367Sahrens     boolean_t, boolean_t, boolean_t, boolean_t, int);
4682082Seschrock extern int zfs_promote(zfs_handle_t *);
469*10242Schris.kirby@sun.com extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t);
470*10242Schris.kirby@sun.com extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
471789Sahrens 
4729554SMatthew.Ahrens@Sun.COM typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
4739396SMatthew.Ahrens@Sun.COM     uid_t rid, uint64_t space);
4749396SMatthew.Ahrens@Sun.COM 
4759396SMatthew.Ahrens@Sun.COM extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4769396SMatthew.Ahrens@Sun.COM     zfs_userspace_cb_t func, void *arg);
4779396SMatthew.Ahrens@Sun.COM 
4785367Sahrens typedef struct recvflags {
4795446Sahrens 	/* print informational messages (ie, -v was specified) */
4805501Seschrock 	int verbose : 1;
4815446Sahrens 
4825446Sahrens 	/* the destination is a prefix, not the exact fs (ie, -d) */
4835501Seschrock 	int isprefix : 1;
4845446Sahrens 
4855446Sahrens 	/* do not actually do the recv, just check if it would work (ie, -n) */
4865501Seschrock 	int dryrun : 1;
4875446Sahrens 
4885446Sahrens 	/* rollback/destroy filesystems as necessary (eg, -F) */
4895501Seschrock 	int force : 1;
4905446Sahrens 
4915446Sahrens 	/* set "canmount=off" on all modified filesystems */
4925501Seschrock 	int canmountoff : 1;
4935446Sahrens 
4945446Sahrens 	/* byteswap flag is used internally; callers need not specify */
4955501Seschrock 	int byteswap : 1;
4968584SLori.Alt@Sun.COM 
4978584SLori.Alt@Sun.COM 	/* do not mount file systems as they are extracted (private) */
4988584SLori.Alt@Sun.COM 	int nomount : 1;
4995367Sahrens } recvflags_t;
5005367Sahrens 
5015367Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
5025367Sahrens     int, avl_tree_t *);
5035367Sahrens 
504789Sahrens /*
505789Sahrens  * Miscellaneous functions.
506789Sahrens  */
507789Sahrens extern const char *zfs_type_to_name(zfs_type_t);
508789Sahrens extern void zfs_refresh_properties(zfs_handle_t *);
509789Sahrens extern int zfs_name_valid(const char *, zfs_type_t);
5103635Sck153898 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
5114490Svb160487 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
5124490Svb160487     zfs_type_t);
5135713Srm160521 extern int zfs_spa_version(zfs_handle_t *, int *);
514789Sahrens 
515789Sahrens /*
516789Sahrens  * Mount support functions.
517789Sahrens  */
5183444Sek110237 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
5192082Seschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
520789Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int);
521789Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int);
522789Sahrens extern int zfs_unmountall(zfs_handle_t *, int);
523789Sahrens 
524789Sahrens /*
525789Sahrens  * Share support functions.
526789Sahrens  */
5273126Sahl extern boolean_t zfs_is_shared(zfs_handle_t *);
528789Sahrens extern int zfs_share(zfs_handle_t *);
5293126Sahl extern int zfs_unshare(zfs_handle_t *);
5303126Sahl 
5313126Sahl /*
5324451Seschrock  * Protocol-specific share support functions.
5333126Sahl  */
5343126Sahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
5355331Samw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
5363126Sahl extern int zfs_share_nfs(zfs_handle_t *);
5375331Samw extern int zfs_share_smb(zfs_handle_t *);
5385331Samw extern int zfs_shareall(zfs_handle_t *);
5393126Sahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
5405331Samw extern int zfs_unshare_smb(zfs_handle_t *, const char *);
5413126Sahl extern int zfs_unshareall_nfs(zfs_handle_t *);
5425331Samw extern int zfs_unshareall_smb(zfs_handle_t *);
5435331Samw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
5445331Samw extern int zfs_unshareall(zfs_handle_t *);
5453126Sahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
5463126Sahl extern int zfs_share_iscsi(zfs_handle_t *);
5473126Sahl extern int zfs_unshare_iscsi(zfs_handle_t *);
5484543Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *);
5498845Samw@Sun.COM extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
5505331Samw     void *, void *, int, zfs_share_op_t);
551789Sahrens 
552789Sahrens /*
553789Sahrens  * When dealing with nvlists, verify() is extremely useful
554789Sahrens  */
555789Sahrens #ifdef NDEBUG
556789Sahrens #define	verify(EX)	((void)(EX))
557789Sahrens #else
558789Sahrens #define	verify(EX)	assert(EX)
559789Sahrens #endif
560789Sahrens 
561789Sahrens /*
562789Sahrens  * Utility function to convert a number to a human-readable form.
563789Sahrens  */
564789Sahrens extern void zfs_nicenum(uint64_t, char *, size_t);
5652676Seschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
566789Sahrens 
567789Sahrens /*
568789Sahrens  * Given a device or file, determine if it is part of a pool.
569789Sahrens  */
5702082Seschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
5712082Seschrock     boolean_t *);
572789Sahrens 
573789Sahrens /*
574789Sahrens  * ftyp special.  Read the label from a given device.
575789Sahrens  */
5762082Seschrock extern int zpool_read_label(int, nvlist_t **);
577789Sahrens 
578789Sahrens /*
5793126Sahl  * Create and remove zvol /dev links.
580789Sahrens  */
581789Sahrens extern int zpool_create_zvol_links(zpool_handle_t *);
582789Sahrens extern int zpool_remove_zvol_links(zpool_handle_t *);
583789Sahrens 
5846423Sgw25295 /* is this zvol valid for use as a dump device? */
5856423Sgw25295 extern int zvol_check_dump_config(char *);
5866423Sgw25295 
5872474Seschrock /*
5888845Samw@Sun.COM  * Management interfaces for SMB ACL files
5898845Samw@Sun.COM  */
5908845Samw@Sun.COM 
5918845Samw@Sun.COM int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
5928845Samw@Sun.COM int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
5938845Samw@Sun.COM int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
5948845Samw@Sun.COM int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
5958845Samw@Sun.COM 
5968845Samw@Sun.COM /*
5973126Sahl  * Enable and disable datasets within a pool by mounting/unmounting and
5983126Sahl  * sharing/unsharing them.
5992474Seschrock  */
6003126Sahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
6013126Sahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
6022474Seschrock 
603789Sahrens #ifdef	__cplusplus
604789Sahrens }
605789Sahrens #endif
606789Sahrens 
607789Sahrens #endif	/* _LIBZFS_H */
608