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 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_UNPLAYED_LOGS,     /* log device has unplayed logs */
 120         EZFS_UNKNOWN
 121 };
 122
 123 /*
 124  * The following data structures are all part
 125  * of the zfs_allow_t data structure which is
 126  * used for printing 'allow' permissions.
 127  * It is a linked list of zfs_allow_t's which
 128  * then contain avl tree's for user/group/sets/...
 129  * and each one of the entries in those trees have
 130  * avl tree's for the permissions they belong to and
 131  * whether they are local,descendent or local+descendent
 132  * permissions.  The AVL trees are used primarily for
 133  * sorting purposes, but also so that we can quickly find
 134  * a given user and or permission.
 135  */
 136 typedef struct zfs_perm_node {
 137         avl_node_t z_node;
 138         char z_pname[MAXPATHLEN];
 139 } zfs_perm_node_t;
 140
 141 typedef struct zfs_allow_node {
 142         avl_node_t z_node;
 143         char z_key[MAXPATHLEN];         /* name, such as joe */
 144         avl_tree_t z_localdescend;      /* local+descendent perms */
 145         avl_tree_t z_local;             /* local permissions */
 146         avl_tree_t z_descend;           /* descendent permissions */
 147 } zfs_allow_node_t;
 148
 149 typedef struct zfs_allow {
 150         struct zfs_allow *z_next;
 151         char z_setpoint[MAXPATHLEN];
 152         avl_tree_t z_sets;
 153         avl_tree_t z_crperms;
 154         avl_tree_t z_user;
 155         avl_tree_t z_group;
 156         avl_tree_t z_everyone;
 157 } zfs_allow_t;
 158
 159 /*
 160  * Basic handle types
 161  */
 162 typedef struct zfs_handle zfs_handle_t;
 163 typedef struct zpool_handle zpool_handle_t;
 164 typedef struct libzfs_handle libzfs_handle_t;
 165
 166 /*
 167  * Library initialization
 168  */
 169 extern libzfs_handle_t *libzfs_init(void);
 170 extern void libzfs_fini(libzfs_handle_t *);
 171
 172 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
 173 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
 174
 175 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
 176
 177 extern int libzfs_errno(libzfs_handle_t *);
 178 extern const char *libzfs_error_action(libzfs_handle_t *);
 179 extern const char *libzfs_error_description(libzfs_handle_t *);
 180 extern void libzfs_mnttab_init(libzfs_handle_t *);
 181 extern void libzfs_mnttab_fini(libzfs_handle_t *);
 182 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
 183 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
 184     struct mnttab *);
 185 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
 186     const char *, const char *);
 187 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
 188
 189 /*
 190  * Basic handle functions
 191  */
 192 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
 193 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
 194 extern void zpool_close(zpool_handle_t *);
 195 extern const char *zpool_get_name(zpool_handle_t *);
 196 extern int zpool_get_state(zpool_handle_t *);
 197 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
 198 extern void zpool_free_handles(libzfs_handle_t *);
 199
 200 /*
 201  * Iterate over all active pools in the system.
 202  */
 203 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
 204 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
 205
 206 /*
 207  * Functions to create and destroy pools
 208  */
 209 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
 210     nvlist_t *, nvlist_t *);
 211 extern int zpool_destroy(zpool_handle_t *);
 212 extern int zpool_add(zpool_handle_t *, nvlist_t *);
 213
 214 /*
 215  * Functions to manipulate pool and vdev state
 216  */
 217 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
 218 extern int zpool_clear(zpool_handle_t *, const char *);
 219
 220 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
 221     vdev_state_t *);
 222 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
 223 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
 224     const char *, nvlist_t *, int);
 225 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
 226 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
 227
 228 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
 229 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
 230 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
 231
 232 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
 233     boolean_t *, boolean_t *);
 234 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
 235     boolean_t *, boolean_t *, boolean_t *);
 236 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
 237
 238 /*
 239  * Functions to manage pool properties
 240  */
 241 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
 242 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
 243     size_t proplen, zprop_source_t *);
 244 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
 245     zprop_source_t *);
 246
 247 extern const char *zpool_prop_to_name(zpool_prop_t);
 248 extern const char *zpool_prop_values(zpool_prop_t);
 249
 250 /*
 251  * Pool health statistics.
 252  */
 253 typedef enum {
 254         /*
 255          * The following correspond to faults as defined in the (fault.fs.zfs.*)
 256          * event namespace.  Each is associated with a corresponding message ID.
 257          */
 258         ZPOOL_STATUS_CORRUPT_CACHE,     /* corrupt /kernel/drv/zpool.cache */
 259         ZPOOL_STATUS_MISSING_DEV_R,     /* missing device with replicas */
 260         ZPOOL_STATUS_MISSING_DEV_NR,    /* missing device with no replicas */
 261         ZPOOL_STATUS_CORRUPT_LABEL_R,   /* bad device label with replicas */
 262         ZPOOL_STATUS_CORRUPT_LABEL_NR,  /* bad device label with no replicas */
 263         ZPOOL_STATUS_BAD_GUID_SUM,      /* sum of device guids didn't match */
 264         ZPOOL_STATUS_CORRUPT_POOL,      /* pool metadata is corrupted */
 265         ZPOOL_STATUS_CORRUPT_DATA,      /* data errors in user (meta)data */
 266         ZPOOL_STATUS_FAILING_DEV,       /* device experiencing errors */
 267         ZPOOL_STATUS_VERSION_NEWER,     /* newer on-disk version */
 268         ZPOOL_STATUS_HOSTID_MISMATCH,   /* last accessed by another system */
 269         ZPOOL_STATUS_IO_FAILURE_WAIT,   /* failed I/O, failmode 'wait' */
 270         ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
 271         ZPOOL_STATUS_BAD_LOG,           /* cannot read log chain(s) */
 272
 273         /*
 274          * These faults have no corresponding message ID.  At the time we are
 275          * checking the status, the original reason for the FMA fault (I/O or
 276          * checksum errors) has been lost.
 277          */
 278         ZPOOL_STATUS_FAULTED_DEV_R,     /* faulted device with replicas */
 279         ZPOOL_STATUS_FAULTED_DEV_NR,    /* faulted device with no replicas */
 280
 281         /*
 282          * The following are not faults per se, but still an error possibly
 283          * requiring administrative attention.  There is no corresponding
 284          * message ID.
 285          */
 286         ZPOOL_STATUS_VERSION_OLDER,     /* older on-disk version */
 287         ZPOOL_STATUS_RESILVERING,       /* device being resilvered */
 288         ZPOOL_STATUS_OFFLINE_DEV,       /* device online */
 289
 290         /*
 291          * Finally, the following indicates a healthy pool.
 292          */
 293         ZPOOL_STATUS_OK
 294 } zpool_status_t;
 295
 296 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
 297 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
 298
 299 /*
 300  * Statistics and configuration functions.
 301  */
 302 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
 303 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
 304 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
 305
 306 /*
 307  * Import and export functions
 308  */
 309 extern int zpool_export(zpool_handle_t *, boolean_t);
 310 extern int zpool_export_force(zpool_handle_t *);
 311 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
 312     char *altroot);
 313 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
 314     nvlist_t *, boolean_t);
 315
 316 /*
 317  * Search for pools to import
 318  */
 319 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
 320 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
 321     char *, uint64_t);
 322 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **,
 323     char *);
 324 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **,
 325     uint64_t);
 326 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **);
 327
 328 /*
 329  * Miscellaneous pool functions
 330  */
 331 struct zfs_cmd;
 332
 333 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
 334 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
 335 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
 336 extern void zpool_set_history_str(const char *subcommand, int argc,
 337     char **argv, char *history_str);
 338 extern int zpool_stage_history(libzfs_handle_t *, const char *);
 339 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
 340     size_t len);
 341 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
 342 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
 343
 344 /*
 345  * Basic handle manipulations.  These functions do not create or destroy the
 346  * underlying datasets, only the references to them.
 347  */
 348 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
 349 extern void zfs_close(zfs_handle_t *);
 350 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
 351 extern const char *zfs_get_name(const zfs_handle_t *);
 352 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
 353
 354 /*
 355  * Property management functions.  Some functions are shared with the kernel,
 356  * and are found in sys/fs/zfs.h.
 357  */
 358
 359 /*
 360  * zfs dataset property management
 361  */
 362 extern const char *zfs_prop_default_string(zfs_prop_t);
 363 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
 364 extern const char *zfs_prop_column_name(zfs_prop_t);
 365 extern boolean_t zfs_prop_align_right(zfs_prop_t);
 366
 367 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
 368     nvlist_t *, uint64_t, zfs_handle_t *, const char *);
 369
 370 extern const char *zfs_prop_to_name(zfs_prop_t);
 371 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
 372 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
 373     zprop_source_t *, char *, size_t, boolean_t);
 374 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
 375     zprop_source_t *, char *, size_t);
 376 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
 377     uint64_t *propvalue);
 378 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
 379     char *propbuf, int proplen, boolean_t literal);
 380 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
 381 extern int zfs_prop_inherit(zfs_handle_t *, const char *);
 382 extern const char *zfs_prop_values(zfs_prop_t);
 383 extern int zfs_prop_is_string(zfs_prop_t prop);
 384 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
 385
 386 typedef struct zprop_list {
 387         int             pl_prop;
 388         char            *pl_user_prop;
 389         struct zprop_list *pl_next;
 390         boolean_t       pl_all;
 391         size_t          pl_width;
 392         boolean_t       pl_fixed;
 393 } zprop_list_t;
 394
 395 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **);
 396 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
 397
 398 #define ZFS_MOUNTPOINT_NONE     "none"
 399 #define ZFS_MOUNTPOINT_LEGACY   "legacy"
 400
 401 /*
 402  * zpool property management
 403  */
 404 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
 405 extern const char *zpool_prop_default_string(zpool_prop_t);
 406 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
 407 extern const char *zpool_prop_column_name(zpool_prop_t);
 408 extern boolean_t zpool_prop_align_right(zpool_prop_t);
 409
 410 /*
 411  * Functions shared by zfs and zpool property management.
 412  */
 413 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
 414     boolean_t ordered, zfs_type_t type);
 415 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
 416     zfs_type_t);
 417 extern void zprop_free_list(zprop_list_t *);
 418
 419 /*
 420  * Functions for printing zfs or zpool properties
 421  */
 422 typedef struct zprop_get_cbdata {
 423         int cb_sources;
 424         int cb_columns[4];
 425         int cb_colwidths[5];
 426         boolean_t cb_scripted;
 427         boolean_t cb_literal;
 428         boolean_t cb_first;
 429         zprop_list_t *cb_proplist;
 430         zfs_type_t cb_type;
 431 } zprop_get_cbdata_t;
 432
 433 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
 434     const char *, const char *, zprop_source_t, const char *);
 435
 436 #define GET_COL_NAME            1
 437 #define GET_COL_PROPERTY        2
 438 #define GET_COL_VALUE           3
 439 #define GET_COL_SOURCE          4
 440
 441 /*
 442  * Iterator functions.
 443  */
 444 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
 445 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
 446 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
 447 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 448 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
 449 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
 450
 451 /*
 452  * Functions to create and destroy datasets.
 453  */
 454 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
 455     nvlist_t *);
 456 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
 457 extern int zfs_destroy(zfs_handle_t *);
 458 extern int zfs_destroy_snaps(zfs_handle_t *, char *);
 459 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
 460 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
 461 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
 462 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
 463 extern int zfs_send(zfs_handle_t *, const char *, const char *,
 464     boolean_t, boolean_t, boolean_t, boolean_t, int);
 465 extern int zfs_promote(zfs_handle_t *);
 466
 467 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
 468     uid_t rid, uint64_t space);
 469
 470 extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
 471     zfs_userspace_cb_t func, void *arg);
 472
 473 typedef struct recvflags {
 474         /* print informational messages (ie, -v was specified) */
 475         int verbose : 1;
 476
 477         /* the destination is a prefix, not the exact fs (ie, -d) */
 478         int isprefix : 1;
 479
 480         /* do not actually do the recv, just check if it would work (ie, -n) */
 481         int dryrun : 1;
 482
 483         /* rollback/destroy filesystems as necessary (eg, -F) */
 484         int force : 1;
 485
 486         /* set "canmount=off" on all modified filesystems */
 487         int canmountoff : 1;
 488
 489         /* byteswap flag is used internally; callers need not specify */
 490         int byteswap : 1;
 491
 492         /* do not mount file systems as they are extracted (private) */
 493         int nomount : 1;
 494 } recvflags_t;
 495
 496 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
 497     int, avl_tree_t *);
 498
 499 /*
 500  * Miscellaneous functions.
 501  */
 502 extern const char *zfs_type_to_name(zfs_type_t);
 503 extern void zfs_refresh_properties(zfs_handle_t *);
 504 extern int zfs_name_valid(const char *, zfs_type_t);
 505 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
 506 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
 507     zfs_type_t);
 508 extern int zfs_spa_version(zfs_handle_t *, int *);
 509
 510 /*
 511  * Mount support functions.
 512  */
 513 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
 514 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
 515 extern int zfs_mount(zfs_handle_t *, const char *, int);
 516 extern int zfs_unmount(zfs_handle_t *, const char *, int);
 517 extern int zfs_unmountall(zfs_handle_t *, int);
 518
 519 /*
 520  * Share support functions.
 521  */
 522 extern boolean_t zfs_is_shared(zfs_handle_t *);
 523 extern int zfs_share(zfs_handle_t *);
 524 extern int zfs_unshare(zfs_handle_t *);
 525
 526 /*
 527  * Protocol-specific share support functions.
 528  */
 529 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
 530 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
 531 extern int zfs_share_nfs(zfs_handle_t *);
 532 extern int zfs_share_smb(zfs_handle_t *);
 533 extern int zfs_shareall(zfs_handle_t *);
 534 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
 535 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
 536 extern int zfs_unshareall_nfs(zfs_handle_t *);
 537 extern int zfs_unshareall_smb(zfs_handle_t *);
 538 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
 539 extern int zfs_unshareall(zfs_handle_t *);
 540 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
 541 extern int zfs_share_iscsi(zfs_handle_t *);
 542 extern int zfs_unshare_iscsi(zfs_handle_t *);
 543 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *);
 544 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
 545     void *, void *, int, zfs_share_op_t);
 546
 547 /*
 548  * When dealing with nvlists, verify() is extremely useful
 549  */
 550 #ifdef NDEBUG
 551 #define verify(EX)      ((void)(EX))
 552 #else
 553 #define verify(EX)      assert(EX)
 554 #endif
 555
 556 /*
 557  * Utility function to convert a number to a human-readable form.
 558  */
 559 extern void zfs_nicenum(uint64_t, char *, size_t);
 560 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
 561
 562 /*
 563  * Given a device or file, determine if it is part of a pool.
 564  */
 565 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
 566     boolean_t *);
 567
 568 /*
 569  * ftyp special.  Read the label from a given device.
 570  */
 571 extern int zpool_read_label(int, nvlist_t **);
 572
 573 /*
 574  * Create and remove zvol /dev links.
 575  */
 576 extern int zpool_create_zvol_links(zpool_handle_t *);
 577 extern int zpool_remove_zvol_links(zpool_handle_t *);
 578
 579 /* is this zvol valid for use as a dump device? */
 580 extern int zvol_check_dump_config(char *);
 581
 582 /*
 583  * Management interfaces for SMB ACL files
 584  */
 585
 586 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
 587 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
 588 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
 589 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
 590
 591 /*
 592  * Enable and disable datasets within a pool by mounting/unmounting and
 593  * sharing/unsharing them.
 594  */
 595 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
 596 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
 597
 598 #ifdef  __cplusplus
 599 }
 600 #endif
 601
 602 #endif  /* _LIBZFS_H */