xref: /titanic_50/usr/src/lib/libzfs/common/libzfs.h (revision 05845d98e50affecba99c9109a7cedf74fb0aabb)
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
41 extern "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  */
55 enum {
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  */
135 typedef struct zfs_perm_node {
136 	avl_node_t z_node;
137 	char z_pname[MAXPATHLEN];
138 } zfs_perm_node_t;
139 
140 typedef 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 
148 typedef 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  */
161 typedef struct zfs_handle zfs_handle_t;
162 typedef struct zpool_handle zpool_handle_t;
163 typedef struct libzfs_handle libzfs_handle_t;
164 
165 /*
166  * Library initialization
167  */
168 extern libzfs_handle_t *libzfs_init(void);
169 extern void libzfs_fini(libzfs_handle_t *);
170 
171 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
172 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
173 
174 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
175 
176 extern int libzfs_errno(libzfs_handle_t *);
177 extern const char *libzfs_error_action(libzfs_handle_t *);
178 extern const char *libzfs_error_description(libzfs_handle_t *);
179 extern void libzfs_mnttab_init(libzfs_handle_t *);
180 extern void libzfs_mnttab_fini(libzfs_handle_t *);
181 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
182 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
183     struct mnttab *);
184 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
185     const char *, const char *);
186 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
187 
188 /*
189  * Basic handle functions
190  */
191 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
192 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
193 extern void zpool_close(zpool_handle_t *);
194 extern const char *zpool_get_name(zpool_handle_t *);
195 extern int zpool_get_state(zpool_handle_t *);
196 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
197 extern void zpool_free_handles(libzfs_handle_t *);
198 
199 /*
200  * Iterate over all active pools in the system.
201  */
202 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
203 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
204 
205 /*
206  * Functions to create and destroy pools
207  */
208 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
209     nvlist_t *, nvlist_t *);
210 extern int zpool_destroy(zpool_handle_t *);
211 extern int zpool_add(zpool_handle_t *, nvlist_t *);
212 
213 /*
214  * Functions to manipulate pool and vdev state
215  */
216 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
217 extern int zpool_clear(zpool_handle_t *, const char *);
218 
219 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
220     vdev_state_t *);
221 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
222 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
223     const char *, nvlist_t *, int);
224 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
225 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
226 
227 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
228 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
229 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
230 
231 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
232     boolean_t *, boolean_t *);
233 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
234 
235 /*
236  * Functions to manage pool properties
237  */
238 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
239 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
240     size_t proplen, zprop_source_t *);
241 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
242     zprop_source_t *);
243 
244 extern const char *zpool_prop_to_name(zpool_prop_t);
245 extern const char *zpool_prop_values(zpool_prop_t);
246 
247 /*
248  * Pool health statistics.
249  */
250 typedef 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 
293 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
294 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
295 
296 /*
297  * Statistics and configuration functions.
298  */
299 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
300 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
301 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
302 
303 /*
304  * Import and export functions
305  */
306 extern int zpool_export(zpool_handle_t *, boolean_t);
307 extern int zpool_export_force(zpool_handle_t *);
308 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
309     char *altroot);
310 extern 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  */
316 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
317 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
318     char *, uint64_t);
319 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **,
320     char *);
321 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **,
322     uint64_t);
323 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **);
324 
325 /*
326  * Miscellaneous pool functions
327  */
328 struct zfs_cmd;
329 
330 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
331 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
332 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
333 extern void zpool_set_history_str(const char *subcommand, int argc,
334     char **argv, char *history_str);
335 extern int zpool_stage_history(libzfs_handle_t *, const char *);
336 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
337     size_t len);
338 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
339 extern 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  */
345 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
346 extern void zfs_close(zfs_handle_t *);
347 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
348 extern const char *zfs_get_name(const zfs_handle_t *);
349 extern 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  */
359 extern const char *zfs_prop_default_string(zfs_prop_t);
360 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
361 extern const char *zfs_prop_column_name(zfs_prop_t);
362 extern boolean_t zfs_prop_align_right(zfs_prop_t);
363 
364 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
365     nvlist_t *, uint64_t, zfs_handle_t *, const char *);
366 
367 extern const char *zfs_prop_to_name(zfs_prop_t);
368 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
369 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
370     zprop_source_t *, char *, size_t, boolean_t);
371 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
372     zprop_source_t *, char *, size_t);
373 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
374     char *propbuf, int proplen, boolean_t literal);
375 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
376 extern int zfs_prop_inherit(zfs_handle_t *, const char *);
377 extern const char *zfs_prop_values(zfs_prop_t);
378 extern int zfs_prop_is_string(zfs_prop_t prop);
379 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
380 
381 typedef struct zprop_list {
382 	int		pl_prop;
383 	char		*pl_user_prop;
384 	struct zprop_list *pl_next;
385 	boolean_t	pl_all;
386 	size_t		pl_width;
387 	boolean_t	pl_fixed;
388 } zprop_list_t;
389 
390 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **);
391 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
392 
393 #define	ZFS_MOUNTPOINT_NONE	"none"
394 #define	ZFS_MOUNTPOINT_LEGACY	"legacy"
395 
396 /*
397  * zpool property management
398  */
399 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
400 extern const char *zpool_prop_default_string(zpool_prop_t);
401 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
402 extern const char *zpool_prop_column_name(zpool_prop_t);
403 extern boolean_t zpool_prop_align_right(zpool_prop_t);
404 
405 /*
406  * Functions shared by zfs and zpool property management.
407  */
408 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
409     boolean_t ordered, zfs_type_t type);
410 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
411     zfs_type_t);
412 extern void zprop_free_list(zprop_list_t *);
413 
414 /*
415  * Functions for printing zfs or zpool properties
416  */
417 typedef struct zprop_get_cbdata {
418 	int cb_sources;
419 	int cb_columns[4];
420 	int cb_colwidths[5];
421 	boolean_t cb_scripted;
422 	boolean_t cb_literal;
423 	boolean_t cb_first;
424 	zprop_list_t *cb_proplist;
425 	zfs_type_t cb_type;
426 } zprop_get_cbdata_t;
427 
428 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
429     const char *, const char *, zprop_source_t, const char *);
430 
431 #define	GET_COL_NAME		1
432 #define	GET_COL_PROPERTY	2
433 #define	GET_COL_VALUE		3
434 #define	GET_COL_SOURCE		4
435 
436 /*
437  * Iterator functions.
438  */
439 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
440 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
441 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
442 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
443 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
444 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
445 
446 /*
447  * Functions to create and destroy datasets.
448  */
449 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
450     nvlist_t *);
451 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
452 extern int zfs_destroy(zfs_handle_t *);
453 extern int zfs_destroy_snaps(zfs_handle_t *, char *);
454 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
455 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
456 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
457 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
458 extern int zfs_send(zfs_handle_t *, const char *, const char *,
459     boolean_t, boolean_t, boolean_t, boolean_t, int);
460 extern int zfs_promote(zfs_handle_t *);
461 
462 typedef void (*zfs_userspace_cb_t)(void *arg, const char *domain,
463     uid_t rid, uint64_t space);
464 
465 extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
466     zfs_userspace_cb_t func, void *arg);
467 
468 typedef struct recvflags {
469 	/* print informational messages (ie, -v was specified) */
470 	int verbose : 1;
471 
472 	/* the destination is a prefix, not the exact fs (ie, -d) */
473 	int isprefix : 1;
474 
475 	/* do not actually do the recv, just check if it would work (ie, -n) */
476 	int dryrun : 1;
477 
478 	/* rollback/destroy filesystems as necessary (eg, -F) */
479 	int force : 1;
480 
481 	/* set "canmount=off" on all modified filesystems */
482 	int canmountoff : 1;
483 
484 	/* byteswap flag is used internally; callers need not specify */
485 	int byteswap : 1;
486 
487 	/* do not mount file systems as they are extracted (private) */
488 	int nomount : 1;
489 } recvflags_t;
490 
491 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
492     int, avl_tree_t *);
493 
494 /*
495  * Miscellaneous functions.
496  */
497 extern const char *zfs_type_to_name(zfs_type_t);
498 extern void zfs_refresh_properties(zfs_handle_t *);
499 extern int zfs_name_valid(const char *, zfs_type_t);
500 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
501 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
502     zfs_type_t);
503 extern int zfs_spa_version(zfs_handle_t *, int *);
504 
505 /*
506  * Mount support functions.
507  */
508 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
509 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
510 extern int zfs_mount(zfs_handle_t *, const char *, int);
511 extern int zfs_unmount(zfs_handle_t *, const char *, int);
512 extern int zfs_unmountall(zfs_handle_t *, int);
513 
514 /*
515  * Share support functions.
516  */
517 extern boolean_t zfs_is_shared(zfs_handle_t *);
518 extern int zfs_share(zfs_handle_t *);
519 extern int zfs_unshare(zfs_handle_t *);
520 
521 /*
522  * Protocol-specific share support functions.
523  */
524 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
525 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
526 extern int zfs_share_nfs(zfs_handle_t *);
527 extern int zfs_share_smb(zfs_handle_t *);
528 extern int zfs_shareall(zfs_handle_t *);
529 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
530 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
531 extern int zfs_unshareall_nfs(zfs_handle_t *);
532 extern int zfs_unshareall_smb(zfs_handle_t *);
533 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
534 extern int zfs_unshareall(zfs_handle_t *);
535 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
536 extern int zfs_share_iscsi(zfs_handle_t *);
537 extern int zfs_unshare_iscsi(zfs_handle_t *);
538 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *);
539 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
540     void *, void *, int, zfs_share_op_t);
541 
542 /*
543  * When dealing with nvlists, verify() is extremely useful
544  */
545 #ifdef NDEBUG
546 #define	verify(EX)	((void)(EX))
547 #else
548 #define	verify(EX)	assert(EX)
549 #endif
550 
551 /*
552  * Utility function to convert a number to a human-readable form.
553  */
554 extern void zfs_nicenum(uint64_t, char *, size_t);
555 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
556 
557 /*
558  * Given a device or file, determine if it is part of a pool.
559  */
560 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
561     boolean_t *);
562 
563 /*
564  * ftyp special.  Read the label from a given device.
565  */
566 extern int zpool_read_label(int, nvlist_t **);
567 
568 /*
569  * Create and remove zvol /dev links.
570  */
571 extern int zpool_create_zvol_links(zpool_handle_t *);
572 extern int zpool_remove_zvol_links(zpool_handle_t *);
573 
574 /* is this zvol valid for use as a dump device? */
575 extern int zvol_check_dump_config(char *);
576 
577 /*
578  * Management interfaces for SMB ACL files
579  */
580 
581 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
582 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
583 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
584 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
585 
586 /*
587  * Enable and disable datasets within a pool by mounting/unmounting and
588  * sharing/unsharing them.
589  */
590 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
591 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
592 
593 #ifdef	__cplusplus
594 }
595 #endif
596 
597 #endif	/* _LIBZFS_H */
598