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