]> git.proxmox.com Git - mirror_zfs.git/blame - lib/libzfs/include/libzfs.h
projects / mirror_zfs.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Rebase master to b108
[mirror_zfs.git] / lib / libzfs / include / libzfs.h
CommitLineData
34dc7c2f
BB		 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/*
d164b209 23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
34dc7c2f
BB		 24 * Use is subject to license terms.
25 */
26
27#ifndef _LIBZFS_H
28#define _LIBZFS_H
29
34dc7c2f
BB		 30#include <assert.h>
31#include <libnvpair.h>
fb5f0bc8 32#include <sys/mnttab.h>
34dc7c2f
BB		 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 */
b128c09f
BB		 117 EZFS_NOTSUP, /* ops not supported on this dataset */
118 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
34dc7c2f
BB		 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 *);
fb5f0bc8
BB		 179extern void libzfs_mnttab_init(libzfs_handle_t *);
180extern void libzfs_mnttab_fini(libzfs_handle_t *);
181extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
182 struct mnttab *);
183extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
184 const char *, const char *);
185extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
34dc7c2f
BB		 186
187/*
188 * Basic handle functions
189 */
190extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
191extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
192extern void zpool_close(zpool_handle_t *);
193extern const char *zpool_get_name(zpool_handle_t *);
194extern int zpool_get_state(zpool_handle_t *);
195extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
b128c09f 196extern void zpool_free_handles(libzfs_handle_t *);
34dc7c2f
BB		 197
198/*
199 * Iterate over all active pools in the system.
200 */
201typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
202extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
203
204/*
205 * Functions to create and destroy pools
206 */
207extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
b128c09f 208 nvlist_t *, nvlist_t *);
34dc7c2f
BB		 209extern int zpool_destroy(zpool_handle_t *);
210extern int zpool_add(zpool_handle_t *, nvlist_t *);
211
212/*
213 * Functions to manipulate pool and vdev state
214 */
215extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
216extern int zpool_clear(zpool_handle_t *, const char *);
217
218extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
219 vdev_state_t *);
220extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
221extern int zpool_vdev_attach(zpool_handle_t *, const char *,
222 const char *, nvlist_t *, int);
223extern int zpool_vdev_detach(zpool_handle_t *, const char *);
224extern int zpool_vdev_remove(zpool_handle_t *, const char *);
225
226extern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
227extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
228extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
229
230extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
b128c09f 231 boolean_t *, boolean_t *);
34dc7c2f
BB		 232extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
233
234/*
235 * Functions to manage pool properties
236 */
237extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
238extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
239 size_t proplen, zprop_source_t *);
240extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
241 zprop_source_t *);
242
243extern const char *zpool_prop_to_name(zpool_prop_t);
244extern const char *zpool_prop_values(zpool_prop_t);
245
246/*
247 * Pool health statistics.
248 */
249typedef enum {
250 /*
251 * The following correspond to faults as defined in the (fault.fs.zfs.*)
252 * event namespace. Each is associated with a corresponding message ID.
253 */
254 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
255 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
256 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
257 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
258 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
259 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
260 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
261 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
262 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
263 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
264 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
b128c09f
BB		 265 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
266 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
d164b209
BB		 267 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
268
269 /*
270 * These faults have no corresponding message ID. At the time we are
271 * checking the status, the original reason for the FMA fault (I/O or
272 * checksum errors) has been lost.
273 */
34dc7c2f
BB		 274 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
275 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
276
277 /*
278 * The following are not faults per se, but still an error possibly
279 * requiring administrative attention. There is no corresponding
280 * message ID.
281 */
282 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */
283 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
284 ZPOOL_STATUS_OFFLINE_DEV, /* device online */
285
286 /*
287 * Finally, the following indicates a healthy pool.
288 */
289 ZPOOL_STATUS_OK
290} zpool_status_t;
291
292extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
293extern zpool_status_t zpool_import_status(nvlist_t *, char **);
294
295/*
296 * Statistics and configuration functions.
297 */
298extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
299extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
300extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
301
302/*
303 * Import and export functions
304 */
b128c09f 305extern int zpool_export(zpool_handle_t *, boolean_t);
fb5f0bc8 306extern int zpool_export_force(zpool_handle_t *);
34dc7c2f
BB		 307extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
308 char *altroot);
309extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
b128c09f 310 nvlist_t *, boolean_t);
34dc7c2f
BB		 311
312/*
313 * Search for pools to import
314 */
b128c09f 315extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
34dc7c2f 316extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
b128c09f
BB		 317 char *, uint64_t);
318extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **,
319 char *);
320extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **,
321 uint64_t);
322extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **);
34dc7c2f
BB		 323
324/*
325 * Miscellaneous pool functions
326 */
327struct zfs_cmd;
328
329extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
330extern int zpool_upgrade(zpool_handle_t *, uint64_t);
331extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
332extern void zpool_set_history_str(const char *subcommand, int argc,
333 char **argv, char *history_str);
334extern int zpool_stage_history(libzfs_handle_t *, const char *);
335extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
336 size_t len);
337extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
b128c09f 338extern int zpool_get_physpath(zpool_handle_t *, char *);
34dc7c2f
BB		 339/*
340 * Basic handle manipulations. These functions do not create or destroy the
341 * underlying datasets, only the references to them.
342 */
343extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
344extern void zfs_close(zfs_handle_t *);
345extern zfs_type_t zfs_get_type(const zfs_handle_t *);
346extern const char *zfs_get_name(const zfs_handle_t *);
b128c09f 347extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
34dc7c2f
BB		 348
349/*
350 * Property management functions. Some functions are shared with the kernel,
351 * and are found in sys/fs/zfs.h.
352 */
353
354/*
355 * zfs dataset property management
356 */
357extern const char *zfs_prop_default_string(zfs_prop_t);
358extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
359extern const char *zfs_prop_column_name(zfs_prop_t);
360extern boolean_t zfs_prop_align_right(zfs_prop_t);
361
b128c09f
BB		 362extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
363 nvlist_t *, uint64_t, zfs_handle_t *, const char *);
364
34dc7c2f
BB		 365extern const char *zfs_prop_to_name(zfs_prop_t);
366extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
367extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
368 zprop_source_t *, char *, size_t, boolean_t);
369extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
370 zprop_source_t *, char *, size_t);
371extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
372extern int zfs_prop_inherit(zfs_handle_t *, const char *);
373extern const char *zfs_prop_values(zfs_prop_t);
374extern int zfs_prop_is_string(zfs_prop_t prop);
375extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
376
377typedef struct zprop_list {
378 int pl_prop;
379 char *pl_user_prop;
380 struct zprop_list *pl_next;
381 boolean_t pl_all;
382 size_t pl_width;
383 boolean_t pl_fixed;
384} zprop_list_t;
385
386extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **);
387
388#define ZFS_MOUNTPOINT_NONE "none"
389#define ZFS_MOUNTPOINT_LEGACY "legacy"
390
391/*
392 * zpool property management
393 */
394extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
395extern const char *zpool_prop_default_string(zpool_prop_t);
396extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
397extern const char *zpool_prop_column_name(zpool_prop_t);
398extern boolean_t zpool_prop_align_right(zpool_prop_t);
399
400/*
401 * Functions shared by zfs and zpool property management.
402 */
403extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
404 boolean_t ordered, zfs_type_t type);
405extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
406 zfs_type_t);
407extern void zprop_free_list(zprop_list_t *);
408
409/*
410 * Functions for printing zfs or zpool properties
411 */
412typedef struct zprop_get_cbdata {
413 int cb_sources;
414 int cb_columns[4];
415 int cb_colwidths[5];
416 boolean_t cb_scripted;
417 boolean_t cb_literal;
418 boolean_t cb_first;
419 zprop_list_t *cb_proplist;
420 zfs_type_t cb_type;
421} zprop_get_cbdata_t;
422
423void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
424 const char *, const char *, zprop_source_t, const char *);
425
426#define GET_COL_NAME 1
427#define GET_COL_PROPERTY 2
428#define GET_COL_VALUE 3
429#define GET_COL_SOURCE 4
430
431/*
432 * Iterator functions.
433 */
434typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
435extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
436extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
437extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
438extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
439extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
440
441/*
442 * Functions to create and destroy datasets.
443 */
444extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
445 nvlist_t *);
446extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
447extern int zfs_destroy(zfs_handle_t *);
448extern int zfs_destroy_snaps(zfs_handle_t *, char *);
449extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
b128c09f 450extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
34dc7c2f
BB		 451extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
452extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
453extern int zfs_send(zfs_handle_t *, const char *, const char *,
454 boolean_t, boolean_t, boolean_t, boolean_t, int);
455extern int zfs_promote(zfs_handle_t *);
456
457typedef struct recvflags {
458 /* print informational messages (ie, -v was specified) */
459 int verbose : 1;
460
461 /* the destination is a prefix, not the exact fs (ie, -d) */
462 int isprefix : 1;
463
464 /* do not actually do the recv, just check if it would work (ie, -n) */
465 int dryrun : 1;
466
467 /* rollback/destroy filesystems as necessary (eg, -F) */
468 int force : 1;
469
470 /* set "canmount=off" on all modified filesystems */
471 int canmountoff : 1;
472
473 /* byteswap flag is used internally; callers need not specify */
474 int byteswap : 1;
d164b209
BB		 475
476 /* do not mount file systems as they are extracted (private) */
477 int nomount : 1;
34dc7c2f
BB		 478} recvflags_t;
479
480extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
481 int, avl_tree_t *);
482
483/*
484 * Miscellaneous functions.
485 */
486extern const char *zfs_type_to_name(zfs_type_t);
487extern void zfs_refresh_properties(zfs_handle_t *);
488extern int zfs_name_valid(const char *, zfs_type_t);
489extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
490extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
491 zfs_type_t);
492extern int zfs_spa_version(zfs_handle_t *, int *);
493
494/*
495 * dataset permission functions.
496 */
497extern int zfs_perm_set(zfs_handle_t *, nvlist_t *);
498extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *);
499extern int zfs_build_perms(zfs_handle_t *, char *, char *,
500 zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t);
501extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **);
502extern void zfs_free_allows(zfs_allow_t *);
503extern void zfs_deleg_permissions(void);
504
505/*
506 * Mount support functions.
507 */
508extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
509extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
510extern int zfs_mount(zfs_handle_t *, const char *, int);
511extern int zfs_unmount(zfs_handle_t *, const char *, int);
512extern int zfs_unmountall(zfs_handle_t *, int);
513
514/*
515 * Share support functions.
516 */
517extern boolean_t zfs_is_shared(zfs_handle_t *);
518extern int zfs_share(zfs_handle_t *);
519extern int zfs_unshare(zfs_handle_t *);
520
521/*
522 * Protocol-specific share support functions.
523 */
524extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
525extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
526extern int zfs_share_nfs(zfs_handle_t *);
527extern int zfs_share_smb(zfs_handle_t *);
528extern int zfs_shareall(zfs_handle_t *);
529extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
530extern int zfs_unshare_smb(zfs_handle_t *, const char *);
531extern int zfs_unshareall_nfs(zfs_handle_t *);
532extern int zfs_unshareall_smb(zfs_handle_t *);
533extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
534extern int zfs_unshareall(zfs_handle_t *);
535extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
536extern int zfs_share_iscsi(zfs_handle_t *);
537extern int zfs_unshare_iscsi(zfs_handle_t *);
538extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *);
539extern int zfs_deleg_share_nfs(libzfs_handle_t *, 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 */
554extern void zfs_nicenum(uint64_t, char *, size_t);
555extern 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 */
560extern 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 */
566extern int zpool_read_label(int, nvlist_t **);
567
568/*
569 * Create and remove zvol /dev links.
570 */
571extern int zpool_create_zvol_links(zpool_handle_t *);
572extern int zpool_remove_zvol_links(zpool_handle_t *);
573
574/* is this zvol valid for use as a dump device? */
575extern int zvol_check_dump_config(char *);
576
577/*
578 * Enable and disable datasets within a pool by mounting/unmounting and
579 * sharing/unsharing them.
580 */
581extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
582extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
583
584#ifdef __cplusplus
585}
586#endif
587
588#endif /* _LIBZFS_H */
ZFS On Linux mirror for PVE