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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright (c) 2011, 2020 by Delphix. All rights reserved.
  25  * Copyright Joyent, Inc.
  26  * Copyright (c) 2013 Steven Hartland. All rights reserved.
  27  * Copyright (c) 2016, Intel Corporation.
  28  * Copyright 2016 Nexenta Systems, Inc.
  29  * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
  30  * Copyright (c) 2019 Datto Inc.
  31  * Copyright (c) 2021, Colm Buckley <colm@tuatha.org>
  32  */
  33
  34 #ifndef _LIBZFS_H
  35 #define _LIBZFS_H extern __attribute__((visibility("default")))
  36
  37 #include <assert.h>
  38 #include <libshare.h>
  39 #include <libnvpair.h>
  40 #include <sys/mnttab.h>
  41 #include <sys/param.h>
  42 #include <sys/types.h>
  43 #include <sys/varargs.h>
  44 #include <sys/fs/zfs.h>
  45 #include <sys/avl.h>
  46 #include <ucred.h>
  47 #include <libzfs_core.h>
  48
  49 #ifdef  __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 /*
  54  * Miscellaneous ZFS constants
  55  */
  56 #define ZFS_MAXPROPLEN          MAXPATHLEN
  57 #define ZPOOL_MAXPROPLEN        MAXPATHLEN
  58
  59 /*
  60  * libzfs errors
  61  */
  62 typedef enum zfs_error {
  63         EZFS_SUCCESS = 0,       /* no error -- success */
  64         EZFS_NOMEM = 2000,      /* out of memory */
  65         EZFS_BADPROP,           /* invalid property value */
  66         EZFS_PROPREADONLY,      /* cannot set readonly property */
  67         EZFS_PROPTYPE,          /* property does not apply to dataset type */
  68         EZFS_PROPNONINHERIT,    /* property is not inheritable */
  69         EZFS_PROPSPACE,         /* bad quota or reservation */
  70         EZFS_BADTYPE,           /* dataset is not of appropriate type */
  71         EZFS_BUSY,              /* pool or dataset is busy */
  72         EZFS_EXISTS,            /* pool or dataset already exists */
  73         EZFS_NOENT,             /* no such pool or dataset */
  74         EZFS_BADSTREAM,         /* bad backup stream */
  75         EZFS_DSREADONLY,        /* dataset is readonly */
  76         EZFS_VOLTOOBIG,         /* volume is too large for 32-bit system */
  77         EZFS_INVALIDNAME,       /* invalid dataset name */
  78         EZFS_BADRESTORE,        /* unable to restore to destination */
  79         EZFS_BADBACKUP,         /* backup failed */
  80         EZFS_BADTARGET,         /* bad attach/detach/replace target */
  81         EZFS_NODEVICE,          /* no such device in pool */
  82         EZFS_BADDEV,            /* invalid device to add */
  83         EZFS_NOREPLICAS,        /* no valid replicas */
  84         EZFS_RESILVERING,       /* resilvering (healing reconstruction) */
  85         EZFS_BADVERSION,        /* unsupported version */
  86         EZFS_POOLUNAVAIL,       /* pool is currently unavailable */
  87         EZFS_DEVOVERFLOW,       /* too many devices in one vdev */
  88         EZFS_BADPATH,           /* must be an absolute path */
  89         EZFS_CROSSTARGET,       /* rename or clone across pool or dataset */
  90         EZFS_ZONED,             /* used improperly in local zone */
  91         EZFS_MOUNTFAILED,       /* failed to mount dataset */
  92         EZFS_UMOUNTFAILED,      /* failed to unmount dataset */
  93         EZFS_UNSHARENFSFAILED,  /* failed to unshare over nfs */
  94         EZFS_SHARENFSFAILED,    /* failed to share over nfs */
  95         EZFS_PERM,              /* permission denied */
  96         EZFS_NOSPC,             /* out of space */
  97         EZFS_FAULT,             /* bad address */
  98         EZFS_IO,                /* I/O error */
  99         EZFS_INTR,              /* signal received */
 100         EZFS_ISSPARE,           /* device is a hot spare */
 101         EZFS_INVALCONFIG,       /* invalid vdev configuration */
 102         EZFS_RECURSIVE,         /* recursive dependency */
 103         EZFS_NOHISTORY,         /* no history object */
 104         EZFS_POOLPROPS,         /* couldn't retrieve pool props */
 105         EZFS_POOL_NOTSUP,       /* ops not supported for this type of pool */
 106         EZFS_POOL_INVALARG,     /* invalid argument for this pool operation */
 107         EZFS_NAMETOOLONG,       /* dataset name is too long */
 108         EZFS_OPENFAILED,        /* open of device failed */
 109         EZFS_NOCAP,             /* couldn't get capacity */
 110         EZFS_LABELFAILED,       /* write of label failed */
 111         EZFS_BADWHO,            /* invalid permission who */
 112         EZFS_BADPERM,           /* invalid permission */
 113         EZFS_BADPERMSET,        /* invalid permission set name */
 114         EZFS_NODELEGATION,      /* delegated administration is disabled */
 115         EZFS_UNSHARESMBFAILED,  /* failed to unshare over smb */
 116         EZFS_SHARESMBFAILED,    /* failed to share over smb */
 117         EZFS_BADCACHE,          /* bad cache file */
 118         EZFS_ISL2CACHE,         /* device is for the level 2 ARC */
 119         EZFS_VDEVNOTSUP,        /* unsupported vdev type */
 120         EZFS_NOTSUP,            /* ops not supported on this dataset */
 121         EZFS_ACTIVE_SPARE,      /* pool has active shared spare devices */
 122         EZFS_UNPLAYED_LOGS,     /* log device has unplayed logs */
 123         EZFS_REFTAG_RELE,       /* snapshot release: tag not found */
 124         EZFS_REFTAG_HOLD,       /* snapshot hold: tag already exists */
 125         EZFS_TAGTOOLONG,        /* snapshot hold/rele: tag too long */
 126         EZFS_PIPEFAILED,        /* pipe create failed */
 127         EZFS_THREADCREATEFAILED, /* thread create failed */
 128         EZFS_POSTSPLIT_ONLINE,  /* onlining a disk after splitting it */
 129         EZFS_SCRUBBING,         /* currently scrubbing */
 130         EZFS_NO_SCRUB,          /* no active scrub */
 131         EZFS_DIFF,              /* general failure of zfs diff */
 132         EZFS_DIFFDATA,          /* bad zfs diff data */
 133         EZFS_POOLREADONLY,      /* pool is in read-only mode */
 134         EZFS_SCRUB_PAUSED,      /* scrub currently paused */
 135         EZFS_ACTIVE_POOL,       /* pool is imported on a different system */
 136         EZFS_CRYPTOFAILED,      /* failed to setup encryption */
 137         EZFS_NO_PENDING,        /* cannot cancel, no operation is pending */
 138         EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */
 139         EZFS_DISCARDING_CHECKPOINT,     /* currently discarding a checkpoint */
 140         EZFS_NO_CHECKPOINT,     /* pool has no checkpoint */
 141         EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */
 142         EZFS_VDEV_TOO_BIG,      /* a device is too big to be used */
 143         EZFS_IOC_NOTSUPPORTED,  /* operation not supported by zfs module */
 144         EZFS_TOOMANY,           /* argument list too long */
 145         EZFS_INITIALIZING,      /* currently initializing */
 146         EZFS_NO_INITIALIZE,     /* no active initialize */
 147         EZFS_WRONG_PARENT,      /* invalid parent dataset (e.g ZVOL) */
 148         EZFS_TRIMMING,          /* currently trimming */
 149         EZFS_NO_TRIM,           /* no active trim */
 150         EZFS_TRIM_NOTSUP,       /* device does not support trim */
 151         EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */
 152         EZFS_EXPORT_IN_PROGRESS,        /* currently exporting the pool */
 153         EZFS_REBUILDING,        /* resilvering (sequential reconstrution) */
 154         EZFS_VDEV_NOTSUP,       /* ops not supported for this type of vdev */
 155         EZFS_UNKNOWN
 156 } zfs_error_t;
 157
 158 /*
 159  * The following data structures are all part
 160  * of the zfs_allow_t data structure which is
 161  * used for printing 'allow' permissions.
 162  * It is a linked list of zfs_allow_t's which
 163  * then contain avl tree's for user/group/sets/...
 164  * and each one of the entries in those trees have
 165  * avl tree's for the permissions they belong to and
 166  * whether they are local,descendent or local+descendent
 167  * permissions.  The AVL trees are used primarily for
 168  * sorting purposes, but also so that we can quickly find
 169  * a given user and or permission.
 170  */
 171 typedef struct zfs_perm_node {
 172         avl_node_t z_node;
 173         char z_pname[MAXPATHLEN];
 174 } zfs_perm_node_t;
 175
 176 typedef struct zfs_allow_node {
 177         avl_node_t z_node;
 178         char z_key[MAXPATHLEN];         /* name, such as joe */
 179         avl_tree_t z_localdescend;      /* local+descendent perms */
 180         avl_tree_t z_local;             /* local permissions */
 181         avl_tree_t z_descend;           /* descendent permissions */
 182 } zfs_allow_node_t;
 183
 184 typedef struct zfs_allow {
 185         struct zfs_allow *z_next;
 186         char z_setpoint[MAXPATHLEN];
 187         avl_tree_t z_sets;
 188         avl_tree_t z_crperms;
 189         avl_tree_t z_user;
 190         avl_tree_t z_group;
 191         avl_tree_t z_everyone;
 192 } zfs_allow_t;
 193
 194 /*
 195  * Basic handle types
 196  */
 197 typedef struct zfs_handle zfs_handle_t;
 198 typedef struct zpool_handle zpool_handle_t;
 199 typedef struct libzfs_handle libzfs_handle_t;
 200
 201 _LIBZFS_H int zpool_wait(zpool_handle_t *, zpool_wait_activity_t);
 202 _LIBZFS_H int zpool_wait_status(zpool_handle_t *, zpool_wait_activity_t,
 203     boolean_t *, boolean_t *);
 204
 205 /*
 206  * Library initialization
 207  */
 208 _LIBZFS_H libzfs_handle_t *libzfs_init(void);
 209 _LIBZFS_H void libzfs_fini(libzfs_handle_t *);
 210
 211 _LIBZFS_H libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
 212 _LIBZFS_H libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
 213
 214 _LIBZFS_H void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
 215
 216 _LIBZFS_H void zfs_save_arguments(int argc, char **, char *, int);
 217 _LIBZFS_H int zpool_log_history(libzfs_handle_t *, const char *);
 218
 219 _LIBZFS_H int libzfs_errno(libzfs_handle_t *);
 220 _LIBZFS_H const char *libzfs_error_init(int);
 221 _LIBZFS_H const char *libzfs_error_action(libzfs_handle_t *);
 222 _LIBZFS_H const char *libzfs_error_description(libzfs_handle_t *);
 223 _LIBZFS_H int zfs_standard_error(libzfs_handle_t *, int, const char *);
 224 _LIBZFS_H void libzfs_mnttab_init(libzfs_handle_t *);
 225 _LIBZFS_H void libzfs_mnttab_fini(libzfs_handle_t *);
 226 _LIBZFS_H void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
 227 _LIBZFS_H int libzfs_mnttab_find(libzfs_handle_t *, const char *,
 228     struct mnttab *);
 229 _LIBZFS_H void libzfs_mnttab_add(libzfs_handle_t *, const char *,
 230     const char *, const char *);
 231 _LIBZFS_H void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
 232
 233 /*
 234  * Basic handle functions
 235  */
 236 _LIBZFS_H zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
 237 _LIBZFS_H zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
 238 _LIBZFS_H void zpool_close(zpool_handle_t *);
 239 _LIBZFS_H const char *zpool_get_name(zpool_handle_t *);
 240 _LIBZFS_H int zpool_get_state(zpool_handle_t *);
 241 _LIBZFS_H const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
 242 _LIBZFS_H const char *zpool_pool_state_to_name(pool_state_t);
 243 _LIBZFS_H void zpool_free_handles(libzfs_handle_t *);
 244
 245 /*
 246  * Iterate over all active pools in the system.
 247  */
 248 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
 249 _LIBZFS_H int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
 250 _LIBZFS_H boolean_t zpool_skip_pool(const char *);
 251
 252 /*
 253  * Functions to create and destroy pools
 254  */
 255 _LIBZFS_H int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
 256     nvlist_t *, nvlist_t *);
 257 _LIBZFS_H int zpool_destroy(zpool_handle_t *, const char *);
 258 _LIBZFS_H int zpool_add(zpool_handle_t *, nvlist_t *);
 259
 260 typedef struct splitflags {
 261         /* do not split, but return the config that would be split off */
 262         int dryrun : 1;
 263
 264         /* after splitting, import the pool */
 265         int import : 1;
 266         int name_flags;
 267 } splitflags_t;
 268
 269 typedef struct trimflags {
 270         /* requested vdevs are for the entire pool */
 271         boolean_t fullpool;
 272
 273         /* request a secure trim, requires support from device */
 274         boolean_t secure;
 275
 276         /* after starting trim, block until trim completes */
 277         boolean_t wait;
 278
 279         /* trim at the requested rate in bytes/second */
 280         uint64_t rate;
 281 } trimflags_t;
 282
 283 /*
 284  * Functions to manipulate pool and vdev state
 285  */
 286 _LIBZFS_H int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
 287 _LIBZFS_H int zpool_initialize(zpool_handle_t *, pool_initialize_func_t,
 288     nvlist_t *);
 289 _LIBZFS_H int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t,
 290     nvlist_t *);
 291 _LIBZFS_H int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *,
 292     trimflags_t *);
 293
 294 _LIBZFS_H int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
 295 _LIBZFS_H int zpool_reguid(zpool_handle_t *);
 296 _LIBZFS_H int zpool_reopen_one(zpool_handle_t *, void *);
 297
 298 _LIBZFS_H int zpool_sync_one(zpool_handle_t *, void *);
 299
 300 _LIBZFS_H int zpool_vdev_online(zpool_handle_t *, const char *, int,
 301     vdev_state_t *);
 302 _LIBZFS_H int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
 303 _LIBZFS_H int zpool_vdev_attach(zpool_handle_t *, const char *,
 304     const char *, nvlist_t *, int, boolean_t);
 305 _LIBZFS_H int zpool_vdev_detach(zpool_handle_t *, const char *);
 306 _LIBZFS_H int zpool_vdev_remove(zpool_handle_t *, const char *);
 307 _LIBZFS_H int zpool_vdev_remove_cancel(zpool_handle_t *);
 308 _LIBZFS_H int zpool_vdev_indirect_size(zpool_handle_t *, const char *,
 309     uint64_t *);
 310 _LIBZFS_H int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **,
 311     nvlist_t *, splitflags_t);
 312
 313 _LIBZFS_H int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
 314 _LIBZFS_H int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
 315 _LIBZFS_H int zpool_vdev_clear(zpool_handle_t *, uint64_t);
 316
 317 _LIBZFS_H nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
 318     boolean_t *, boolean_t *);
 319 _LIBZFS_H nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
 320     boolean_t *, boolean_t *, boolean_t *);
 321 _LIBZFS_H int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *,
 322     const char *);
 323 _LIBZFS_H uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp,
 324     const char *path);
 325
 326 _LIBZFS_H const char *zpool_get_state_str(zpool_handle_t *);
 327
 328 /*
 329  * Functions to manage pool properties
 330  */
 331 _LIBZFS_H int zpool_set_prop(zpool_handle_t *, const char *, const char *);
 332 _LIBZFS_H int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
 333     size_t proplen, zprop_source_t *, boolean_t literal);
 334 _LIBZFS_H uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
 335     zprop_source_t *);
 336 _LIBZFS_H int zpool_props_refresh(zpool_handle_t *);
 337
 338 _LIBZFS_H const char *zpool_prop_to_name(zpool_prop_t);
 339 _LIBZFS_H const char *zpool_prop_values(zpool_prop_t);
 340
 341 /*
 342  * Functions to manage vdev properties
 343  */
 344 _LIBZFS_H int zpool_get_vdev_prop_value(nvlist_t *, vdev_prop_t, char *, char *,
 345     size_t, zprop_source_t *, boolean_t);
 346 _LIBZFS_H int zpool_get_vdev_prop(zpool_handle_t *, const char *, vdev_prop_t,
 347     char *, char *, size_t, zprop_source_t *, boolean_t);
 348 _LIBZFS_H int zpool_get_all_vdev_props(zpool_handle_t *, const char *,
 349     nvlist_t **);
 350 _LIBZFS_H int zpool_set_vdev_prop(zpool_handle_t *, const char *, const char *,
 351     const char *);
 352
 353 _LIBZFS_H const char *vdev_prop_to_name(vdev_prop_t);
 354 _LIBZFS_H const char *vdev_prop_values(vdev_prop_t);
 355 _LIBZFS_H boolean_t vdev_prop_user(const char *name);
 356 _LIBZFS_H const char *vdev_prop_column_name(vdev_prop_t);
 357 _LIBZFS_H boolean_t vdev_prop_align_right(vdev_prop_t);
 358
 359 /*
 360  * Pool health statistics.
 361  */
 362 typedef enum {
 363         /*
 364          * The following correspond to faults as defined in the (fault.fs.zfs.*)
 365          * event namespace.  Each is associated with a corresponding message ID.
 366          * This must be kept in sync with the zfs_msgid_table in
 367          * lib/libzfs/libzfs_status.c.
 368          */
 369         ZPOOL_STATUS_CORRUPT_CACHE,     /* corrupt /kernel/drv/zpool.cache */
 370         ZPOOL_STATUS_MISSING_DEV_R,     /* missing device with replicas */
 371         ZPOOL_STATUS_MISSING_DEV_NR,    /* missing device with no replicas */
 372         ZPOOL_STATUS_CORRUPT_LABEL_R,   /* bad device label with replicas */
 373         ZPOOL_STATUS_CORRUPT_LABEL_NR,  /* bad device label with no replicas */
 374         ZPOOL_STATUS_BAD_GUID_SUM,      /* sum of device guids didn't match */
 375         ZPOOL_STATUS_CORRUPT_POOL,      /* pool metadata is corrupted */
 376         ZPOOL_STATUS_CORRUPT_DATA,      /* data errors in user (meta)data */
 377         ZPOOL_STATUS_FAILING_DEV,       /* device experiencing errors */
 378         ZPOOL_STATUS_VERSION_NEWER,     /* newer on-disk version */
 379         ZPOOL_STATUS_HOSTID_MISMATCH,   /* last accessed by another system */
 380         ZPOOL_STATUS_HOSTID_ACTIVE,     /* currently active on another system */
 381         ZPOOL_STATUS_HOSTID_REQUIRED,   /* multihost=on and hostid=0 */
 382         ZPOOL_STATUS_IO_FAILURE_WAIT,   /* failed I/O, failmode 'wait' */
 383         ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
 384         ZPOOL_STATUS_IO_FAILURE_MMP,    /* failed MMP, failmode not 'panic' */
 385         ZPOOL_STATUS_BAD_LOG,           /* cannot read log chain(s) */
 386         ZPOOL_STATUS_ERRATA,            /* informational errata available */
 387
 388         /*
 389          * If the pool has unsupported features but can still be opened in
 390          * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
 391          * pool has unsupported features but cannot be opened at all, its
 392          * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
 393          */
 394         ZPOOL_STATUS_UNSUP_FEAT_READ,   /* unsupported features for read */
 395         ZPOOL_STATUS_UNSUP_FEAT_WRITE,  /* unsupported features for write */
 396
 397         /*
 398          * These faults have no corresponding message ID.  At the time we are
 399          * checking the status, the original reason for the FMA fault (I/O or
 400          * checksum errors) has been lost.
 401          */
 402         ZPOOL_STATUS_FAULTED_DEV_R,     /* faulted device with replicas */
 403         ZPOOL_STATUS_FAULTED_DEV_NR,    /* faulted device with no replicas */
 404
 405         /*
 406          * The following are not faults per se, but still an error possibly
 407          * requiring administrative attention.  There is no corresponding
 408          * message ID.
 409          */
 410         ZPOOL_STATUS_VERSION_OLDER,     /* older legacy on-disk version */
 411         ZPOOL_STATUS_FEAT_DISABLED,     /* supported features are disabled */
 412         ZPOOL_STATUS_RESILVERING,       /* device being resilvered */
 413         ZPOOL_STATUS_OFFLINE_DEV,       /* device offline */
 414         ZPOOL_STATUS_REMOVED_DEV,       /* removed device */
 415         ZPOOL_STATUS_REBUILDING,        /* device being rebuilt */
 416         ZPOOL_STATUS_REBUILD_SCRUB,     /* recommend scrubbing the pool */
 417         ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
 418         ZPOOL_STATUS_COMPATIBILITY_ERR, /* bad 'compatibility' property */
 419         ZPOOL_STATUS_INCOMPATIBLE_FEAT, /* feature set outside compatibility */
 420
 421         /*
 422          * Finally, the following indicates a healthy pool.
 423          */
 424         ZPOOL_STATUS_OK
 425 } zpool_status_t;
 426
 427 _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, char **,
 428     zpool_errata_t *);
 429 _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, char **,
 430     zpool_errata_t *);
 431
 432 /*
 433  * Statistics and configuration functions.
 434  */
 435 _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
 436 _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *);
 437 _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
 438 _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
 439
 440 /*
 441  * Import and export functions
 442  */
 443 _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *);
 444 _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *);
 445 _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
 446     char *altroot);
 447 _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
 448     nvlist_t *, int);
 449 _LIBZFS_H void zpool_print_unsup_feat(nvlist_t *config);
 450
 451 /*
 452  * Miscellaneous pool functions
 453  */
 454 struct zfs_cmd;
 455
 456 _LIBZFS_H const char *const zfs_history_event_names[];
 457
 458 typedef enum {
 459         VDEV_NAME_PATH          = 1 << 0,
 460         VDEV_NAME_GUID          = 1 << 1,
 461         VDEV_NAME_FOLLOW_LINKS  = 1 << 2,
 462         VDEV_NAME_TYPE_ID       = 1 << 3,
 463 } vdev_name_t;
 464
 465 _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
 466     int name_flags);
 467 _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t);
 468 _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *,
 469     boolean_t *);
 470 _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned,
 471     int);
 472 _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *);
 473 _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int);
 474 _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t,
 475     char *, size_t);
 476 _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
 477     size_t);
 478 _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
 479 _LIBZFS_H int zpool_get_physpath(zpool_handle_t *, char *, size_t);
 480 _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int,
 481     nvlist_t *);
 482 _LIBZFS_H int zpool_checkpoint(zpool_handle_t *);
 483 _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *);
 484 _LIBZFS_H boolean_t zpool_is_draid_spare(const char *);
 485
 486 /*
 487  * Basic handle manipulations.  These functions do not create or destroy the
 488  * underlying datasets, only the references to them.
 489  */
 490 _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
 491 _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
 492 _LIBZFS_H void zfs_close(zfs_handle_t *);
 493 _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *);
 494 _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *);
 495 _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *);
 496 _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
 497 _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *);
 498
 499 /*
 500  * Property management functions.  Some functions are shared with the kernel,
 501  * and are found in sys/fs/zfs.h.
 502  */
 503
 504 /*
 505  * zfs dataset property management
 506  */
 507 _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t);
 508 _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t);
 509 _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t);
 510 _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t);
 511
 512 _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
 513     nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t,
 514     const char *);
 515
 516 _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t);
 517 _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *);
 518 _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
 519 _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
 520     zprop_source_t *, char *, size_t, boolean_t);
 521 _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
 522     boolean_t);
 523 _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
 524     zprop_source_t *, char *, size_t);
 525 _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp,
 526     const char *propname, uint64_t *propvalue);
 527 _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
 528     char *propbuf, int proplen, boolean_t literal);
 529 _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
 530     uint64_t *propvalue);
 531 _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
 532     char *propbuf, int proplen, boolean_t literal);
 533 _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
 534     char *buf, size_t len);
 535 _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **);
 536 _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
 537 _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
 538 _LIBZFS_H const char *zfs_prop_values(zfs_prop_t);
 539 _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop);
 540 _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *);
 541 _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *);
 542 _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
 543 _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
 544
 545 _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t,
 546     boolean_t *, boolean_t *);
 547
 548 /*
 549  * zfs encryption management
 550  */
 551 _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *,
 552     char *);
 553 _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *,
 554     nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *);
 555 _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *,
 556     nvlist_t *);
 557 _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *);
 558 _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *);
 559 _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *);
 560 _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t);
 561
 562 typedef struct zprop_list {
 563         int             pl_prop;
 564         char            *pl_user_prop;
 565         struct zprop_list *pl_next;
 566         boolean_t       pl_all;
 567         size_t          pl_width;
 568         size_t          pl_recvd_width;
 569         boolean_t       pl_fixed;
 570 } zprop_list_t;
 571
 572 _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
 573     boolean_t);
 574 _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
 575 _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *,
 576     zprop_list_t **);
 577
 578 #define ZFS_MOUNTPOINT_NONE     "none"
 579 #define ZFS_MOUNTPOINT_LEGACY   "legacy"
 580
 581 #define ZFS_FEATURE_DISABLED    "disabled"
 582 #define ZFS_FEATURE_ENABLED     "enabled"
 583 #define ZFS_FEATURE_ACTIVE      "active"
 584
 585 #define ZFS_UNSUPPORTED_INACTIVE        "inactive"
 586 #define ZFS_UNSUPPORTED_READONLY        "readonly"
 587
 588 /*
 589  * zpool property management
 590  */
 591 _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **,
 592     zfs_type_t, boolean_t);
 593 _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
 594     size_t);
 595 _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t);
 596 _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t);
 597 _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t);
 598 _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t);
 599
 600 /*
 601  * Functions shared by zfs and zpool property management.
 602  */
 603 _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
 604     boolean_t ordered, zfs_type_t type);
 605 _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
 606     zfs_type_t);
 607 _LIBZFS_H void zprop_free_list(zprop_list_t *);
 608
 609 #define ZFS_GET_NCOLS   5
 610
 611 typedef enum {
 612         GET_COL_NONE,
 613         GET_COL_NAME,
 614         GET_COL_PROPERTY,
 615         GET_COL_VALUE,
 616         GET_COL_RECVD,
 617         GET_COL_SOURCE
 618 } zfs_get_column_t;
 619
 620 /*
 621  * Functions for printing zfs or zpool properties
 622  */
 623 typedef struct vdev_cbdata {
 624         int cb_name_flags;
 625         char **cb_names;
 626         unsigned int cb_names_count;
 627 } vdev_cbdata_t;
 628
 629 typedef struct zprop_get_cbdata {
 630         int cb_sources;
 631         zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
 632         int cb_colwidths[ZFS_GET_NCOLS + 1];
 633         boolean_t cb_scripted;
 634         boolean_t cb_literal;
 635         boolean_t cb_first;
 636         zprop_list_t *cb_proplist;
 637         zfs_type_t cb_type;
 638         vdev_cbdata_t cb_vdevs;
 639 } zprop_get_cbdata_t;
 640
 641 _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
 642     const char *, const char *, zprop_source_t, const char *,
 643     const char *);
 644
 645 /*
 646  * Iterator functions.
 647  */
 648 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
 649 _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
 650 _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
 651 _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f,
 652     void *);
 653 _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
 654 _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *,
 655     uint64_t, uint64_t);
 656 _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *,
 657     uint64_t, uint64_t);
 658 _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f,
 659     void *);
 660 _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
 661 _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *);
 662
 663 typedef struct get_all_cb {
 664         zfs_handle_t    **cb_handles;
 665         size_t          cb_alloc;
 666         size_t          cb_used;
 667 } get_all_cb_t;
 668
 669 _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **,
 670     size_t, zfs_iter_f, void *, boolean_t);
 671 _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
 672
 673 /*
 674  * Functions to create and destroy datasets.
 675  */
 676 _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
 677     nvlist_t *);
 678 _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *);
 679 _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t);
 680 _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
 681 _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
 682 _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *);
 683 _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
 684 _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t,
 685     nvlist_t *);
 686 _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
 687     nvlist_t *props);
 688 _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
 689
 690 typedef struct renameflags {
 691         /* recursive rename */
 692         int recursive : 1;
 693
 694         /* don't unmount file systems */
 695         int nounmount : 1;
 696
 697         /* force unmount file systems */
 698         int forceunmount : 1;
 699 } renameflags_t;
 700
 701 _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t);
 702
 703 typedef struct sendflags {
 704         /* Amount of extra information to print. */
 705         int verbosity;
 706
 707         /* recursive send  (ie, -R) */
 708         boolean_t replicate;
 709
 710         /* for recursive send, skip sending missing snapshots */
 711         boolean_t skipmissing;
 712
 713         /* for incrementals, do all intermediate snapshots */
 714         boolean_t doall;
 715
 716         /* if dataset is a clone, do incremental from its origin */
 717         boolean_t fromorigin;
 718
 719         /* field no longer used, maintained for backwards compatibility */
 720         boolean_t pad;
 721
 722         /* send properties (ie, -p) */
 723         boolean_t props;
 724
 725         /* do not send (no-op, ie. -n) */
 726         boolean_t dryrun;
 727
 728         /* parsable verbose output (ie. -P) */
 729         boolean_t parsable;
 730
 731         /* show progress (ie. -v) */
 732         boolean_t progress;
 733
 734         /* large blocks (>128K) are permitted */
 735         boolean_t largeblock;
 736
 737         /* WRITE_EMBEDDED records of type DATA are permitted */
 738         boolean_t embed_data;
 739
 740         /* compressed WRITE records are permitted */
 741         boolean_t compress;
 742
 743         /* raw encrypted records are permitted */
 744         boolean_t raw;
 745
 746         /* only send received properties (ie. -b) */
 747         boolean_t backup;
 748
 749         /* include snapshot holds in send stream */
 750         boolean_t holds;
 751
 752         /* stream represents a partially received dataset */
 753         boolean_t saved;
 754 } sendflags_t;
 755
 756 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
 757
 758 _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *,
 759     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
 760 _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *,
 761     const char *);
 762 _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *);
 763 _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
 764     const char *);
 765 _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *);
 766 _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
 767     const char *token);
 768
 769 _LIBZFS_H int zfs_promote(zfs_handle_t *);
 770 _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *,
 771     boolean_t, int);
 772 _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
 773 _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *,
 774     boolean_t);
 775 _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **);
 776 _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t,
 777     nvlist_t *);
 778
 779 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
 780     uid_t rid, uint64_t space);
 781
 782 _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
 783     zfs_userspace_cb_t, void *);
 784
 785 _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
 786 _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
 787
 788 typedef struct recvflags {
 789         /* print informational messages (ie, -v was specified) */
 790         boolean_t verbose;
 791
 792         /* the destination is a prefix, not the exact fs (ie, -d) */
 793         boolean_t isprefix;
 794
 795         /*
 796          * Only the tail of the sent snapshot path is appended to the
 797          * destination to determine the received snapshot name (ie, -e).
 798          */
 799         boolean_t istail;
 800
 801         /* do not actually do the recv, just check if it would work (ie, -n) */
 802         boolean_t dryrun;
 803
 804         /* rollback/destroy filesystems as necessary (eg, -F) */
 805         boolean_t force;
 806
 807         /* set "canmount=off" on all modified filesystems */
 808         boolean_t canmountoff;
 809
 810         /*
 811          * Mark the file systems as "resumable" and do not destroy them if the
 812          * receive is interrupted
 813          */
 814         boolean_t resumable;
 815
 816         /* byteswap flag is used internally; callers need not specify */
 817         boolean_t byteswap;
 818
 819         /* do not mount file systems as they are extracted (private) */
 820         boolean_t nomount;
 821
 822         /* Was holds flag set in the compound header? */
 823         boolean_t holds;
 824
 825         /* skip receive of snapshot holds */
 826         boolean_t skipholds;
 827
 828         /* mount the filesystem unless nomount is specified */
 829         boolean_t domount;
 830
 831         /* force unmount while recv snapshot (private) */
 832         boolean_t forceunmount;
 833 } recvflags_t;
 834
 835 _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
 836     recvflags_t *, int, avl_tree_t *);
 837
 838 typedef enum diff_flags {
 839         ZFS_DIFF_PARSEABLE = 1 << 0,
 840         ZFS_DIFF_TIMESTAMP = 1 << 1,
 841         ZFS_DIFF_CLASSIFY = 1 << 2,
 842         ZFS_DIFF_NO_MANGLE = 1 << 3
 843 } diff_flags_t;
 844
 845 _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
 846     int);
 847
 848 /*
 849  * Miscellaneous functions.
 850  */
 851 _LIBZFS_H const char *zfs_type_to_name(zfs_type_t);
 852 _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *);
 853 _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t);
 854 _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *,
 855     zfs_type_t);
 856 _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t);
 857 _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
 858     zfs_type_t);
 859 _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *);
 860 _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path);
 861
 862 /*
 863  * Mount support functions.
 864  */
 865 _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
 866 _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **);
 867 _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int);
 868 _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *);
 869 _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int);
 870 _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int);
 871 _LIBZFS_H int zfs_mount_delegation_check(void);
 872
 873 #if defined(__linux__) || defined(__APPLE__)
 874 _LIBZFS_H int zfs_parse_mount_options(char *mntopts, unsigned long *mntflags,
 875     unsigned long *zfsflags, int sloppy, char *badopt, char *mtabopt);
 876 _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint,
 877     char *mntopts, char *mtabopt);
 878 #endif
 879
 880 /*
 881  * Share support functions.
 882  *
 883  * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL,
 884  * NULL means "all/any known to this libzfs".
 885  */
 886 #define SA_NO_PROTOCOL -1
 887
 888 _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where,
 889     const enum sa_protocol *proto);
 890 _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto);
 891 _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint,
 892     const enum sa_protocol *proto);
 893 _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp,
 894     const enum sa_protocol *proto);
 895 _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto);
 896
 897 _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
 898
 899 /*
 900  * Utility functions to run an external process.
 901  */
 902 #define STDOUT_VERBOSE  0x01
 903 #define STDERR_VERBOSE  0x02
 904 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
 905
 906 _LIBZFS_H int libzfs_run_process(const char *, char **, int);
 907 _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[],
 908     char **[], int *);
 909 _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[],
 910     char *[], char **[], int *);
 911
 912 _LIBZFS_H void libzfs_free_str_array(char **, int);
 913
 914 _LIBZFS_H int libzfs_envvar_is_set(char *);
 915
 916 /*
 917  * Utility functions for zfs version
 918  */
 919 _LIBZFS_H void zfs_version_userland(char *, int);
 920 _LIBZFS_H int zfs_version_kernel(char *, int);
 921 _LIBZFS_H int zfs_version_print(void);
 922
 923 /*
 924  * Given a device or file, determine if it is part of a pool.
 925  */
 926 _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
 927     boolean_t *);
 928
 929 /*
 930  * Label manipulation.
 931  */
 932 _LIBZFS_H int zpool_clear_label(int);
 933 _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *);
 934 _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **);
 935
 936 /*
 937  * Management interfaces for SMB ACL files
 938  */
 939
 940 _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
 941 _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
 942 _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
 943 _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *,
 944     char *);
 945
 946 /*
 947  * Enable and disable datasets within a pool by mounting/unmounting and
 948  * sharing/unsharing them.
 949  */
 950 _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int);
 951 _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t);
 952 _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t);
 953 _LIBZFS_H void zpool_disable_volume_os(const char *);
 954
 955 /*
 956  * Parse a features file for -o compatibility
 957  */
 958 typedef enum {
 959         ZPOOL_COMPATIBILITY_OK,
 960         ZPOOL_COMPATIBILITY_WARNTOKEN,
 961         ZPOOL_COMPATIBILITY_BADTOKEN,
 962         ZPOOL_COMPATIBILITY_BADFILE,
 963         ZPOOL_COMPATIBILITY_NOFILES
 964 } zpool_compat_status_t;
 965
 966 _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *,
 967     boolean_t *, char *, size_t);
 968
 969 #ifdef __FreeBSD__
 970
 971 /*
 972  * Attach/detach the given filesystem to/from the given jail.
 973  */
 974 _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach);
 975
 976 /*
 977  * Set loader options for next boot.
 978  */
 979 _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t,
 980     const char *);
 981
 982 #endif /* __FreeBSD__ */
 983
 984 #ifdef  __cplusplus
 985 }
 986 #endif
 987
 988 #endif  /* _LIBZFS_H */