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