libzfs.h revision 9160:1517e6edbc6f
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 2009 Sun Microsystems, Inc.  All rights reserved.
24 * Use is subject to license terms.
25 */
26
27#ifndef	_LIBZFS_H
28#define	_LIBZFS_H
29
30#include <assert.h>
31#include <libnvpair.h>
32#include <sys/mnttab.h>
33#include <sys/param.h>
34#include <sys/types.h>
35#include <sys/varargs.h>
36#include <sys/fs/zfs.h>
37#include <sys/avl.h>
38#include <ucred.h>
39
40#ifdef	__cplusplus
41extern "C" {
42#endif
43
44/*
45 * Miscellaneous ZFS constants
46 */
47#define	ZFS_MAXNAMELEN		MAXNAMELEN
48#define	ZPOOL_MAXNAMELEN	MAXNAMELEN
49#define	ZFS_MAXPROPLEN		MAXPATHLEN
50#define	ZPOOL_MAXPROPLEN	MAXPATHLEN
51
52/*
53 * libzfs errors
54 */
55enum {
56	EZFS_NOMEM = 2000,	/* out of memory */
57	EZFS_BADPROP,		/* invalid property value */
58	EZFS_PROPREADONLY,	/* cannot set readonly property */
59	EZFS_PROPTYPE,		/* property does not apply to dataset type */
60	EZFS_PROPNONINHERIT,	/* property is not inheritable */
61	EZFS_PROPSPACE,		/* bad quota or reservation */
62	EZFS_BADTYPE,		/* dataset is not of appropriate type */
63	EZFS_BUSY,		/* pool or dataset is busy */
64	EZFS_EXISTS,		/* pool or dataset already exists */
65	EZFS_NOENT,		/* no such pool or dataset */
66	EZFS_BADSTREAM,		/* bad backup stream */
67	EZFS_DSREADONLY,	/* dataset is readonly */
68	EZFS_VOLTOOBIG,		/* volume is too large for 32-bit system */
69	EZFS_VOLHASDATA,	/* volume already contains data */
70	EZFS_INVALIDNAME,	/* invalid dataset name */
71	EZFS_BADRESTORE,	/* unable to restore to destination */
72	EZFS_BADBACKUP,		/* backup failed */
73	EZFS_BADTARGET,		/* bad attach/detach/replace target */
74	EZFS_NODEVICE,		/* no such device in pool */
75	EZFS_BADDEV,		/* invalid device to add */
76	EZFS_NOREPLICAS,	/* no valid replicas */
77	EZFS_RESILVERING,	/* currently resilvering */
78	EZFS_BADVERSION,	/* unsupported version */
79	EZFS_POOLUNAVAIL,	/* pool is currently unavailable */
80	EZFS_DEVOVERFLOW,	/* too many devices in one vdev */
81	EZFS_BADPATH,		/* must be an absolute path */
82	EZFS_CROSSTARGET,	/* rename or clone across pool or dataset */
83	EZFS_ZONED,		/* used improperly in local zone */
84	EZFS_MOUNTFAILED,	/* failed to mount dataset */
85	EZFS_UMOUNTFAILED,	/* failed to unmount dataset */
86	EZFS_UNSHARENFSFAILED,	/* unshare(1M) failed */
87	EZFS_SHARENFSFAILED,	/* share(1M) failed */
88	EZFS_DEVLINKS,		/* failed to create zvol links */
89	EZFS_PERM,		/* permission denied */
90	EZFS_NOSPC,		/* out of space */
91	EZFS_IO,		/* I/O error */
92	EZFS_INTR,		/* signal received */
93	EZFS_ISSPARE,		/* device is a hot spare */
94	EZFS_INVALCONFIG,	/* invalid vdev configuration */
95	EZFS_RECURSIVE,		/* recursive dependency */
96	EZFS_NOHISTORY,		/* no history object */
97	EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */
98	EZFS_SHAREISCSIFAILED,	/* iscsitgtd failed request to share */
99	EZFS_POOLPROPS,		/* couldn't retrieve pool props */
100	EZFS_POOL_NOTSUP,	/* ops not supported for this type of pool */
101	EZFS_POOL_INVALARG,	/* invalid argument for this pool operation */
102	EZFS_NAMETOOLONG,	/* dataset name is too long */
103	EZFS_OPENFAILED,	/* open of device failed */
104	EZFS_NOCAP,		/* couldn't get capacity */
105	EZFS_LABELFAILED,	/* write of label failed */
106	EZFS_ISCSISVCUNAVAIL,	/* iscsi service unavailable */
107	EZFS_BADWHO,		/* invalid permission who */
108	EZFS_BADPERM,		/* invalid permission */
109	EZFS_BADPERMSET,	/* invalid permission set name */
110	EZFS_NODELEGATION,	/* delegated administration is disabled */
111	EZFS_PERMRDONLY,	/* pemissions are readonly */
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_UNKNOWN
120};
121
122/*
123 * The following data structures are all part
124 * of the zfs_allow_t data structure which is
125 * used for printing 'allow' permissions.
126 * It is a linked list of zfs_allow_t's which
127 * then contain avl tree's for user/group/sets/...
128 * and each one of the entries in those trees have
129 * avl tree's for the permissions they belong to and
130 * whether they are local,descendent or local+descendent
131 * permissions.  The AVL trees are used primarily for
132 * sorting purposes, but also so that we can quickly find
133 * a given user and or permission.
134 */
135typedef struct zfs_perm_node {
136	avl_node_t z_node;
137	char z_pname[MAXPATHLEN];
138} zfs_perm_node_t;
139
140typedef struct zfs_allow_node {
141	avl_node_t z_node;
142	char z_key[MAXPATHLEN];		/* name, such as joe */
143	avl_tree_t z_localdescend;	/* local+descendent perms */
144	avl_tree_t z_local;		/* local permissions */
145	avl_tree_t z_descend;		/* descendent permissions */
146} zfs_allow_node_t;
147
148typedef struct zfs_allow {
149	struct zfs_allow *z_next;
150	char z_setpoint[MAXPATHLEN];
151	avl_tree_t z_sets;
152	avl_tree_t z_crperms;
153	avl_tree_t z_user;
154	avl_tree_t z_group;
155	avl_tree_t z_everyone;
156} zfs_allow_t;
157
158/*
159 * Basic handle types
160 */
161typedef struct zfs_handle zfs_handle_t;
162typedef struct zpool_handle zpool_handle_t;
163typedef struct libzfs_handle libzfs_handle_t;
164
165/*
166 * Library initialization
167 */
168extern libzfs_handle_t *libzfs_init(void);
169extern void libzfs_fini(libzfs_handle_t *);
170
171extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
172extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
173
174extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
175
176extern int libzfs_errno(libzfs_handle_t *);
177extern const char *libzfs_error_action(libzfs_handle_t *);
178extern const char *libzfs_error_description(libzfs_handle_t *);
179extern void libzfs_mnttab_init(libzfs_handle_t *);
180extern void libzfs_mnttab_fini(libzfs_handle_t *);
181extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
182extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
183    struct mnttab *);
184extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
185    const char *, const char *);
186extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
187
188/*
189 * Basic handle functions
190 */
191extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
192extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
193extern void zpool_close(zpool_handle_t *);
194extern const char *zpool_get_name(zpool_handle_t *);
195extern int zpool_get_state(zpool_handle_t *);
196extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
197extern void zpool_free_handles(libzfs_handle_t *);
198
199/*
200 * Iterate over all active pools in the system.
201 */
202typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
203extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
204
205/*
206 * Functions to create and destroy pools
207 */
208extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
209    nvlist_t *, nvlist_t *);
210extern int zpool_destroy(zpool_handle_t *);
211extern int zpool_add(zpool_handle_t *, nvlist_t *);
212
213/*
214 * Functions to manipulate pool and vdev state
215 */
216extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
217extern int zpool_clear(zpool_handle_t *, const char *);
218
219extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
220    vdev_state_t *);
221extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
222extern int zpool_vdev_attach(zpool_handle_t *, const char *,
223    const char *, nvlist_t *, int);
224extern int zpool_vdev_detach(zpool_handle_t *, const char *);
225extern int zpool_vdev_remove(zpool_handle_t *, const char *);
226
227extern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
228extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
229extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
230
231extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
232    boolean_t *, boolean_t *);
233extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
234
235/*
236 * Functions to manage pool properties
237 */
238extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
239extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
240    size_t proplen, zprop_source_t *);
241extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
242    zprop_source_t *);
243
244extern const char *zpool_prop_to_name(zpool_prop_t);
245extern const char *zpool_prop_values(zpool_prop_t);
246
247/*
248 * Pool health statistics.
249 */
250typedef enum {
251	/*
252	 * The following correspond to faults as defined in the (fault.fs.zfs.*)
253	 * event namespace.  Each is associated with a corresponding message ID.
254	 */
255	ZPOOL_STATUS_CORRUPT_CACHE,	/* corrupt /kernel/drv/zpool.cache */
256	ZPOOL_STATUS_MISSING_DEV_R,	/* missing device with replicas */
257	ZPOOL_STATUS_MISSING_DEV_NR,	/* missing device with no replicas */
258	ZPOOL_STATUS_CORRUPT_LABEL_R,	/* bad device label with replicas */
259	ZPOOL_STATUS_CORRUPT_LABEL_NR,	/* bad device label with no replicas */
260	ZPOOL_STATUS_BAD_GUID_SUM,	/* sum of device guids didn't match */
261	ZPOOL_STATUS_CORRUPT_POOL,	/* pool metadata is corrupted */
262	ZPOOL_STATUS_CORRUPT_DATA,	/* data errors in user (meta)data */
263	ZPOOL_STATUS_FAILING_DEV,	/* device experiencing errors */
264	ZPOOL_STATUS_VERSION_NEWER,	/* newer on-disk version */
265	ZPOOL_STATUS_HOSTID_MISMATCH,	/* last accessed by another system */
266	ZPOOL_STATUS_IO_FAILURE_WAIT,	/* failed I/O, failmode 'wait' */
267	ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
268	ZPOOL_STATUS_BAD_LOG,		/* cannot read log chain(s) */
269
270	/*
271	 * These faults have no corresponding message ID.  At the time we are
272	 * checking the status, the original reason for the FMA fault (I/O or
273	 * checksum errors) has been lost.
274	 */
275	ZPOOL_STATUS_FAULTED_DEV_R,	/* faulted device with replicas */
276	ZPOOL_STATUS_FAULTED_DEV_NR,	/* faulted device with no replicas */
277
278	/*
279	 * The following are not faults per se, but still an error possibly
280	 * requiring administrative attention.  There is no corresponding
281	 * message ID.
282	 */
283	ZPOOL_STATUS_VERSION_OLDER,	/* older on-disk version */
284	ZPOOL_STATUS_RESILVERING,	/* device being resilvered */
285	ZPOOL_STATUS_OFFLINE_DEV,	/* device online */
286
287	/*
288	 * Finally, the following indicates a healthy pool.
289	 */
290	ZPOOL_STATUS_OK
291} zpool_status_t;
292
293extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
294extern zpool_status_t zpool_import_status(nvlist_t *, char **);
295
296/*
297 * Statistics and configuration functions.
298 */
299extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
300extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
301extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
302
303/*
304 * Import and export functions
305 */
306extern int zpool_export(zpool_handle_t *, boolean_t);
307extern int zpool_export_force(zpool_handle_t *);
308extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
309    char *altroot);
310extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
311    nvlist_t *, boolean_t);
312
313/*
314 * Search for pools to import
315 */
316extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
317extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
318    char *, uint64_t);
319extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **,
320    char *);
321extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **,
322    uint64_t);
323extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **);
324
325/*
326 * Miscellaneous pool functions
327 */
328struct zfs_cmd;
329
330extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
331extern int zpool_upgrade(zpool_handle_t *, uint64_t);
332extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
333extern void zpool_set_history_str(const char *subcommand, int argc,
334    char **argv, char *history_str);
335extern int zpool_stage_history(libzfs_handle_t *, const char *);
336extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
337    size_t len);
338extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
339extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
340
341/*
342 * Basic handle manipulations.  These functions do not create or destroy the
343 * underlying datasets, only the references to them.
344 */
345extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
346extern void zfs_close(zfs_handle_t *);
347extern zfs_type_t zfs_get_type(const zfs_handle_t *);
348extern const char *zfs_get_name(const zfs_handle_t *);
349extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
350
351/*
352 * Property management functions.  Some functions are shared with the kernel,
353 * and are found in sys/fs/zfs.h.
354 */
355
356/*
357 * zfs dataset property management
358 */
359extern const char *zfs_prop_default_string(zfs_prop_t);
360extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
361extern const char *zfs_prop_column_name(zfs_prop_t);
362extern boolean_t zfs_prop_align_right(zfs_prop_t);
363
364extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
365    nvlist_t *, uint64_t, zfs_handle_t *, const char *);
366
367extern const char *zfs_prop_to_name(zfs_prop_t);
368extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
369extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
370    zprop_source_t *, char *, size_t, boolean_t);
371extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
372    zprop_source_t *, char *, size_t);
373extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
374extern int zfs_prop_inherit(zfs_handle_t *, const char *);
375extern const char *zfs_prop_values(zfs_prop_t);
376extern int zfs_prop_is_string(zfs_prop_t prop);
377extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
378
379typedef struct zprop_list {
380	int		pl_prop;
381	char		*pl_user_prop;
382	struct zprop_list *pl_next;
383	boolean_t	pl_all;
384	size_t		pl_width;
385	boolean_t	pl_fixed;
386} zprop_list_t;
387
388extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **);
389extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
390
391#define	ZFS_MOUNTPOINT_NONE	"none"
392#define	ZFS_MOUNTPOINT_LEGACY	"legacy"
393
394/*
395 * zpool property management
396 */
397extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
398extern const char *zpool_prop_default_string(zpool_prop_t);
399extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
400extern const char *zpool_prop_column_name(zpool_prop_t);
401extern boolean_t zpool_prop_align_right(zpool_prop_t);
402
403/*
404 * Functions shared by zfs and zpool property management.
405 */
406extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
407    boolean_t ordered, zfs_type_t type);
408extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
409    zfs_type_t);
410extern void zprop_free_list(zprop_list_t *);
411
412/*
413 * Functions for printing zfs or zpool properties
414 */
415typedef struct zprop_get_cbdata {
416	int cb_sources;
417	int cb_columns[4];
418	int cb_colwidths[5];
419	boolean_t cb_scripted;
420	boolean_t cb_literal;
421	boolean_t cb_first;
422	zprop_list_t *cb_proplist;
423	zfs_type_t cb_type;
424} zprop_get_cbdata_t;
425
426void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
427    const char *, const char *, zprop_source_t, const char *);
428
429#define	GET_COL_NAME		1
430#define	GET_COL_PROPERTY	2
431#define	GET_COL_VALUE		3
432#define	GET_COL_SOURCE		4
433
434/*
435 * Iterator functions.
436 */
437typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
438extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
439extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
440extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
441extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
442extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
443
444/*
445 * Functions to create and destroy datasets.
446 */
447extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
448    nvlist_t *);
449extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
450extern int zfs_destroy(zfs_handle_t *);
451extern int zfs_destroy_snaps(zfs_handle_t *, char *);
452extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
453extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
454extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
455extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
456extern int zfs_send(zfs_handle_t *, const char *, const char *,
457    boolean_t, boolean_t, boolean_t, boolean_t, int);
458extern int zfs_promote(zfs_handle_t *);
459
460typedef struct recvflags {
461	/* print informational messages (ie, -v was specified) */
462	int verbose : 1;
463
464	/* the destination is a prefix, not the exact fs (ie, -d) */
465	int isprefix : 1;
466
467	/* do not actually do the recv, just check if it would work (ie, -n) */
468	int dryrun : 1;
469
470	/* rollback/destroy filesystems as necessary (eg, -F) */
471	int force : 1;
472
473	/* set "canmount=off" on all modified filesystems */
474	int canmountoff : 1;
475
476	/* byteswap flag is used internally; callers need not specify */
477	int byteswap : 1;
478
479	/* do not mount file systems as they are extracted (private) */
480	int nomount : 1;
481} recvflags_t;
482
483extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
484    int, avl_tree_t *);
485
486/*
487 * Miscellaneous functions.
488 */
489extern const char *zfs_type_to_name(zfs_type_t);
490extern void zfs_refresh_properties(zfs_handle_t *);
491extern int zfs_name_valid(const char *, zfs_type_t);
492extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
493extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
494    zfs_type_t);
495extern int zfs_spa_version(zfs_handle_t *, int *);
496
497/*
498 * dataset permission functions.
499 */
500extern int zfs_perm_set(zfs_handle_t *, nvlist_t *);
501extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *);
502extern int zfs_build_perms(zfs_handle_t *, char *, char *,
503    zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t);
504extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **);
505extern void zfs_free_allows(zfs_allow_t *);
506extern void zfs_deleg_permissions(void);
507
508/*
509 * Mount support functions.
510 */
511extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
512extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
513extern int zfs_mount(zfs_handle_t *, const char *, int);
514extern int zfs_unmount(zfs_handle_t *, const char *, int);
515extern int zfs_unmountall(zfs_handle_t *, int);
516
517/*
518 * Share support functions.
519 */
520extern boolean_t zfs_is_shared(zfs_handle_t *);
521extern int zfs_share(zfs_handle_t *);
522extern int zfs_unshare(zfs_handle_t *);
523
524/*
525 * Protocol-specific share support functions.
526 */
527extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
528extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
529extern int zfs_share_nfs(zfs_handle_t *);
530extern int zfs_share_smb(zfs_handle_t *);
531extern int zfs_shareall(zfs_handle_t *);
532extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
533extern int zfs_unshare_smb(zfs_handle_t *, const char *);
534extern int zfs_unshareall_nfs(zfs_handle_t *);
535extern int zfs_unshareall_smb(zfs_handle_t *);
536extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
537extern int zfs_unshareall(zfs_handle_t *);
538extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
539extern int zfs_share_iscsi(zfs_handle_t *);
540extern int zfs_unshare_iscsi(zfs_handle_t *);
541extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *);
542extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
543    void *, void *, int, zfs_share_op_t);
544
545/*
546 * When dealing with nvlists, verify() is extremely useful
547 */
548#ifdef NDEBUG
549#define	verify(EX)	((void)(EX))
550#else
551#define	verify(EX)	assert(EX)
552#endif
553
554/*
555 * Utility function to convert a number to a human-readable form.
556 */
557extern void zfs_nicenum(uint64_t, char *, size_t);
558extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
559
560/*
561 * Given a device or file, determine if it is part of a pool.
562 */
563extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
564    boolean_t *);
565
566/*
567 * ftyp special.  Read the label from a given device.
568 */
569extern int zpool_read_label(int, nvlist_t **);
570
571/*
572 * Create and remove zvol /dev links.
573 */
574extern int zpool_create_zvol_links(zpool_handle_t *);
575extern int zpool_remove_zvol_links(zpool_handle_t *);
576
577/* is this zvol valid for use as a dump device? */
578extern int zvol_check_dump_config(char *);
579
580/*
581 * Management interfaces for SMB ACL files
582 */
583
584int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
585int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
586int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
587int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
588
589/*
590 * Enable and disable datasets within a pool by mounting/unmounting and
591 * sharing/unsharing them.
592 */
593extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
594extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
595
596#ifdef	__cplusplus
597}
598#endif
599
600#endif	/* _LIBZFS_H */
601