lib/libzfs/include/libzfs.h

   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 2008 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 int libzfs_mnttab_find(libzfs_handle_t *, const char *,
 182     struct mnttab *);
 183 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
 184     const char *, const char *);
 185 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
 186
 187 /*
 188  * Basic handle functions
 189  */
 190 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
 191 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
 192 extern void zpool_close(zpool_handle_t *);
 193 extern const char *zpool_get_name(zpool_handle_t *);
 194 extern int zpool_get_state(zpool_handle_t *);
 195 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
 196 extern void zpool_free_handles(libzfs_handle_t *);
 197
 198 /*
 199  * Iterate over all active pools in the system.
 200  */
 201 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
 202 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
 203
 204 /*
 205  * Functions to create and destroy pools
 206  */
 207 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
 208     nvlist_t *, nvlist_t *);
 209 extern int zpool_destroy(zpool_handle_t *);
 210 extern int zpool_add(zpool_handle_t *, nvlist_t *);
 211
 212 /*
 213  * Functions to manipulate pool and vdev state
 214  */
 215 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
 216 extern int zpool_clear(zpool_handle_t *, const char *);
 217
 218 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
 219     vdev_state_t *);
 220 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
 221 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
 222     const char *, nvlist_t *, int);
 223 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
 224 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
 225
 226 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
 227 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
 228 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
 229
 230 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
 231     boolean_t *, boolean_t *);
 232 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
 233
 234 /*
 235  * Functions to manage pool properties
 236  */
 237 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
 238 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
 239     size_t proplen, zprop_source_t *);
 240 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
 241     zprop_source_t *);
 242
 243 extern const char *zpool_prop_to_name(zpool_prop_t);
 244 extern const char *zpool_prop_values(zpool_prop_t);
 245
 246 /*
 247  * Pool health statistics.
 248  */
 249 typedef 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 */
 265         ZPOOL_STATUS_IO_FAILURE_WAIT,   /* failed I/O, failmode 'wait' */
 266         ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
 267         ZPOOL_STATUS_FAULTED_DEV_R,     /* faulted device with replicas */
 268         ZPOOL_STATUS_FAULTED_DEV_NR,    /* faulted device with no replicas */
 269         ZPOOL_STATUS_BAD_LOG,           /* cannot read log chain(s) */
 270
 271         /*
 272          * The following are not faults per se, but still an error possibly
 273          * requiring administrative attention.  There is no corresponding
 274          * message ID.
 275          */
 276         ZPOOL_STATUS_VERSION_OLDER,     /* older on-disk version */
 277         ZPOOL_STATUS_RESILVERING,       /* device being resilvered */
 278         ZPOOL_STATUS_OFFLINE_DEV,       /* device online */
 279
 280         /*
 281          * Finally, the following indicates a healthy pool.
 282          */
 283         ZPOOL_STATUS_OK
 284 } zpool_status_t;
 285
 286 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
 287 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
 288
 289 /*
 290  * Statistics and configuration functions.
 291  */
 292 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
 293 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
 294 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
 295
 296 /*
 297  * Import and export functions
 298  */
 299 extern int zpool_export(zpool_handle_t *, boolean_t);
 300 extern int zpool_export_force(zpool_handle_t *);
 301 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
 302     char *altroot);
 303 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
 304     nvlist_t *, boolean_t);
 305
 306 /*
 307  * Search for pools to import
 308  */
 309 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
 310 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
 311     char *, uint64_t);
 312 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **,
 313     char *);
 314 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **,
 315     uint64_t);
 316 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **);
 317
 318 /*
 319  * Miscellaneous pool functions
 320  */
 321 struct zfs_cmd;
 322
 323 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
 324 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
 325 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
 326 extern void zpool_set_history_str(const char *subcommand, int argc,
 327     char **argv, char *history_str);
 328 extern int zpool_stage_history(libzfs_handle_t *, const char *);
 329 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
 330     size_t len);
 331 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
 332 extern int zpool_get_physpath(zpool_handle_t *, char *);
 333 /*
 334  * Basic handle manipulations.  These functions do not create or destroy the
 335  * underlying datasets, only the references to them.
 336  */
 337 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
 338 extern void zfs_close(zfs_handle_t *);
 339 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
 340 extern const char *zfs_get_name(const zfs_handle_t *);
 341 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
 342
 343 /*
 344  * Property management functions.  Some functions are shared with the kernel,
 345  * and are found in sys/fs/zfs.h.
 346  */
 347
 348 /*
 349  * zfs dataset property management
 350  */
 351 extern const char *zfs_prop_default_string(zfs_prop_t);
 352 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
 353 extern const char *zfs_prop_column_name(zfs_prop_t);
 354 extern boolean_t zfs_prop_align_right(zfs_prop_t);
 355
 356 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
 357     nvlist_t *, uint64_t, zfs_handle_t *, const char *);
 358
 359 extern const char *zfs_prop_to_name(zfs_prop_t);
 360 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
 361 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
 362     zprop_source_t *, char *, size_t, boolean_t);
 363 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
 364     zprop_source_t *, char *, size_t);
 365 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
 366 extern int zfs_prop_inherit(zfs_handle_t *, const char *);
 367 extern const char *zfs_prop_values(zfs_prop_t);
 368 extern int zfs_prop_is_string(zfs_prop_t prop);
 369 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
 370
 371 typedef struct zprop_list {
 372         int             pl_prop;
 373         char            *pl_user_prop;
 374         struct zprop_list *pl_next;
 375         boolean_t       pl_all;
 376         size_t          pl_width;
 377         boolean_t       pl_fixed;
 378 } zprop_list_t;
 379
 380 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **);
 381
 382 #define ZFS_MOUNTPOINT_NONE     "none"
 383 #define ZFS_MOUNTPOINT_LEGACY   "legacy"
 384
 385 /*
 386  * zpool property management
 387  */
 388 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
 389 extern const char *zpool_prop_default_string(zpool_prop_t);
 390 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
 391 extern const char *zpool_prop_column_name(zpool_prop_t);
 392 extern boolean_t zpool_prop_align_right(zpool_prop_t);
 393
 394 /*
 395  * Functions shared by zfs and zpool property management.
 396  */
 397 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
 398     boolean_t ordered, zfs_type_t type);
 399 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
 400     zfs_type_t);
 401 extern void zprop_free_list(zprop_list_t *);
 402
 403 /*
 404  * Functions for printing zfs or zpool properties
 405  */
 406 typedef struct zprop_get_cbdata {
 407         int cb_sources;
 408         int cb_columns[4];
 409         int cb_colwidths[5];
 410         boolean_t cb_scripted;
 411         boolean_t cb_literal;
 412         boolean_t cb_first;
 413         zprop_list_t *cb_proplist;
 414         zfs_type_t cb_type;
 415 } zprop_get_cbdata_t;
 416
 417 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
 418     const char *, const char *, zprop_source_t, const char *);
 419
 420 #define GET_COL_NAME            1
 421 #define GET_COL_PROPERTY        2
 422 #define GET_COL_VALUE           3
 423 #define GET_COL_SOURCE          4
 424
 425 /*
 426  * Iterator functions.
 427  */
 428 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
 429 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
 430 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
 431 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 432 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
 433 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
 434
 435 /*
 436  * Functions to create and destroy datasets.
 437  */
 438 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
 439     nvlist_t *);
 440 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
 441 extern int zfs_destroy(zfs_handle_t *);
 442 extern int zfs_destroy_snaps(zfs_handle_t *, char *);
 443 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
 444 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
 445 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
 446 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
 447 extern int zfs_send(zfs_handle_t *, const char *, const char *,
 448     boolean_t, boolean_t, boolean_t, boolean_t, int);
 449 extern int zfs_promote(zfs_handle_t *);
 450
 451 typedef struct recvflags {
 452         /* print informational messages (ie, -v was specified) */
 453         int verbose : 1;
 454
 455         /* the destination is a prefix, not the exact fs (ie, -d) */
 456         int isprefix : 1;
 457
 458         /* do not actually do the recv, just check if it would work (ie, -n) */
 459         int dryrun : 1;
 460
 461         /* rollback/destroy filesystems as necessary (eg, -F) */
 462         int force : 1;
 463
 464         /* set "canmount=off" on all modified filesystems */
 465         int canmountoff : 1;
 466
 467         /* byteswap flag is used internally; callers need not specify */
 468         int byteswap : 1;
 469 } recvflags_t;
 470
 471 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
 472     int, avl_tree_t *);
 473
 474 /*
 475  * Miscellaneous functions.
 476  */
 477 extern const char *zfs_type_to_name(zfs_type_t);
 478 extern void zfs_refresh_properties(zfs_handle_t *);
 479 extern int zfs_name_valid(const char *, zfs_type_t);
 480 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
 481 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
 482     zfs_type_t);
 483 extern int zfs_spa_version(zfs_handle_t *, int *);
 484
 485 /*
 486  * dataset permission functions.
 487  */
 488 extern int zfs_perm_set(zfs_handle_t *, nvlist_t *);
 489 extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *);
 490 extern int zfs_build_perms(zfs_handle_t *, char *, char *,
 491     zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t);
 492 extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **);
 493 extern void zfs_free_allows(zfs_allow_t *);
 494 extern void zfs_deleg_permissions(void);
 495
 496 /*
 497  * Mount support functions.
 498  */
 499 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
 500 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
 501 extern int zfs_mount(zfs_handle_t *, const char *, int);
 502 extern int zfs_unmount(zfs_handle_t *, const char *, int);
 503 extern int zfs_unmountall(zfs_handle_t *, int);
 504
 505 /*
 506  * Share support functions.
 507  */
 508 extern boolean_t zfs_is_shared(zfs_handle_t *);
 509 extern int zfs_share(zfs_handle_t *);
 510 extern int zfs_unshare(zfs_handle_t *);
 511
 512 /*
 513  * Protocol-specific share support functions.
 514  */
 515 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
 516 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
 517 extern int zfs_share_nfs(zfs_handle_t *);
 518 extern int zfs_share_smb(zfs_handle_t *);
 519 extern int zfs_shareall(zfs_handle_t *);
 520 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
 521 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
 522 extern int zfs_unshareall_nfs(zfs_handle_t *);
 523 extern int zfs_unshareall_smb(zfs_handle_t *);
 524 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
 525 extern int zfs_unshareall(zfs_handle_t *);
 526 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
 527 extern int zfs_share_iscsi(zfs_handle_t *);
 528 extern int zfs_unshare_iscsi(zfs_handle_t *);
 529 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *);
 530 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *,
 531     void *, void *, int, zfs_share_op_t);
 532
 533 /*
 534  * When dealing with nvlists, verify() is extremely useful
 535  */
 536 #ifdef NDEBUG
 537 #define verify(EX)      ((void)(EX))
 538 #else
 539 #define verify(EX)      assert(EX)
 540 #endif
 541
 542 /*
 543  * Utility function to convert a number to a human-readable form.
 544  */
 545 extern void zfs_nicenum(uint64_t, char *, size_t);
 546 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
 547
 548 /*
 549  * Given a device or file, determine if it is part of a pool.
 550  */
 551 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
 552     boolean_t *);
 553
 554 /*
 555  * ftyp special.  Read the label from a given device.
 556  */
 557 extern int zpool_read_label(int, nvlist_t **);
 558
 559 /*
 560  * Create and remove zvol /dev links.
 561  */
 562 extern int zpool_create_zvol_links(zpool_handle_t *);
 563 extern int zpool_remove_zvol_links(zpool_handle_t *);
 564
 565 /* is this zvol valid for use as a dump device? */
 566 extern int zvol_check_dump_config(char *);
 567
 568 /*
 569  * Enable and disable datasets within a pool by mounting/unmounting and
 570  * sharing/unsharing them.
 571  */
 572 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
 573 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
 574
 575 #ifdef  __cplusplus
 576 }
 577 #endif
 578
 579 #endif  /* _LIBZFS_H */