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, 2018 by Delphix. All rights reserved.
  25  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
  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) 2018 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,       /* currently resilvering */
  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_UNKNOWN
 147 } zfs_error_t;
 148
 149 /*
 150  * The following data structures are all part
 151  * of the zfs_allow_t data structure which is
 152  * used for printing 'allow' permissions.
 153  * It is a linked list of zfs_allow_t's which
 154  * then contain avl tree's for user/group/sets/...
 155  * and each one of the entries in those trees have
 156  * avl tree's for the permissions they belong to and
 157  * whether they are local,descendent or local+descendent
 158  * permissions.  The AVL trees are used primarily for
 159  * sorting purposes, but also so that we can quickly find
 160  * a given user and or permission.
 161  */
 162 typedef struct zfs_perm_node {
 163         avl_node_t z_node;
 164         char z_pname[MAXPATHLEN];
 165 } zfs_perm_node_t;
 166
 167 typedef struct zfs_allow_node {
 168         avl_node_t z_node;
 169         char z_key[MAXPATHLEN];         /* name, such as joe */
 170         avl_tree_t z_localdescend;      /* local+descendent perms */
 171         avl_tree_t z_local;             /* local permissions */
 172         avl_tree_t z_descend;           /* descendent permissions */
 173 } zfs_allow_node_t;
 174
 175 typedef struct zfs_allow {
 176         struct zfs_allow *z_next;
 177         char z_setpoint[MAXPATHLEN];
 178         avl_tree_t z_sets;
 179         avl_tree_t z_crperms;
 180         avl_tree_t z_user;
 181         avl_tree_t z_group;
 182         avl_tree_t z_everyone;
 183 } zfs_allow_t;
 184
 185 /*
 186  * Basic handle types
 187  */
 188 typedef struct zfs_handle zfs_handle_t;
 189 typedef struct zpool_handle zpool_handle_t;
 190 typedef struct libzfs_handle libzfs_handle_t;
 191
 192 /*
 193  * Library initialization
 194  */
 195 extern libzfs_handle_t *libzfs_init(void);
 196 extern void libzfs_fini(libzfs_handle_t *);
 197
 198 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
 199 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
 200
 201 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
 202
 203 extern void zfs_save_arguments(int argc, char **, char *, int);
 204 extern int zpool_log_history(libzfs_handle_t *, const char *);
 205
 206 extern int libzfs_errno(libzfs_handle_t *);
 207 extern const char *libzfs_error_init(int);
 208 extern const char *libzfs_error_action(libzfs_handle_t *);
 209 extern const char *libzfs_error_description(libzfs_handle_t *);
 210 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
 211 extern void libzfs_mnttab_init(libzfs_handle_t *);
 212 extern void libzfs_mnttab_fini(libzfs_handle_t *);
 213 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
 214 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
 215     struct mnttab *);
 216 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
 217     const char *, const char *);
 218 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
 219
 220 /*
 221  * Basic handle functions
 222  */
 223 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
 224 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
 225 extern void zpool_close(zpool_handle_t *);
 226 extern const char *zpool_get_name(zpool_handle_t *);
 227 extern int zpool_get_state(zpool_handle_t *);
 228 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
 229 extern const char *zpool_pool_state_to_name(pool_state_t);
 230 extern void zpool_free_handles(libzfs_handle_t *);
 231
 232 /*
 233  * Iterate over all active pools in the system.
 234  */
 235 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
 236 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
 237 extern boolean_t zpool_skip_pool(const char *);
 238
 239 /*
 240  * Functions to create and destroy pools
 241  */
 242 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
 243     nvlist_t *, nvlist_t *);
 244 extern int zpool_destroy(zpool_handle_t *, const char *);
 245 extern int zpool_add(zpool_handle_t *, nvlist_t *);
 246
 247 typedef struct splitflags {
 248         /* do not split, but return the config that would be split off */
 249         int dryrun : 1;
 250
 251         /* after splitting, import the pool */
 252         int import : 1;
 253         int name_flags;
 254 } splitflags_t;
 255
 256 /*
 257  * Functions to manipulate pool and vdev state
 258  */
 259 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
 260 extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t,
 261     nvlist_t *);
 262 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
 263 extern int zpool_reguid(zpool_handle_t *);
 264 extern int zpool_reopen_one(zpool_handle_t *, void *);
 265
 266 extern int zpool_sync_one(zpool_handle_t *, void *);
 267
 268 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
 269     vdev_state_t *);
 270 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
 271 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
 272     const char *, nvlist_t *, int);
 273 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
 274 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
 275 extern int zpool_vdev_remove_cancel(zpool_handle_t *);
 276 extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *);
 277 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
 278     splitflags_t);
 279
 280 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
 281 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
 282 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
 283
 284 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
 285     boolean_t *, boolean_t *);
 286 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
 287     boolean_t *, boolean_t *, boolean_t *);
 288 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
 289 extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, const char *path);
 290
 291 const char *zpool_get_state_str(zpool_handle_t *);
 292
 293 /*
 294  * Functions to manage pool properties
 295  */
 296 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
 297 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
 298     size_t proplen, zprop_source_t *, boolean_t literal);
 299 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
 300     zprop_source_t *);
 301
 302 extern const char *zpool_prop_to_name(zpool_prop_t);
 303 extern const char *zpool_prop_values(zpool_prop_t);
 304
 305 /*
 306  * Pool health statistics.
 307  */
 308 typedef enum {
 309         /*
 310          * The following correspond to faults as defined in the (fault.fs.zfs.*)
 311          * event namespace.  Each is associated with a corresponding message ID.
 312          * This must be kept in sync with the zfs_msgid_table in
 313          * lib/libzfs/libzfs_status.c.
 314          */
 315         ZPOOL_STATUS_CORRUPT_CACHE,     /* corrupt /kernel/drv/zpool.cache */
 316         ZPOOL_STATUS_MISSING_DEV_R,     /* missing device with replicas */
 317         ZPOOL_STATUS_MISSING_DEV_NR,    /* missing device with no replicas */
 318         ZPOOL_STATUS_CORRUPT_LABEL_R,   /* bad device label with replicas */
 319         ZPOOL_STATUS_CORRUPT_LABEL_NR,  /* bad device label with no replicas */
 320         ZPOOL_STATUS_BAD_GUID_SUM,      /* sum of device guids didn't match */
 321         ZPOOL_STATUS_CORRUPT_POOL,      /* pool metadata is corrupted */
 322         ZPOOL_STATUS_CORRUPT_DATA,      /* data errors in user (meta)data */
 323         ZPOOL_STATUS_FAILING_DEV,       /* device experiencing errors */
 324         ZPOOL_STATUS_VERSION_NEWER,     /* newer on-disk version */
 325         ZPOOL_STATUS_HOSTID_MISMATCH,   /* last accessed by another system */
 326         ZPOOL_STATUS_HOSTID_ACTIVE,     /* currently active on another system */
 327         ZPOOL_STATUS_HOSTID_REQUIRED,   /* multihost=on and hostid=0 */
 328         ZPOOL_STATUS_IO_FAILURE_WAIT,   /* failed I/O, failmode 'wait' */
 329         ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
 330         ZPOOL_STATUS_IO_FAILURE_MMP,    /* failed MMP, failmode not 'panic' */
 331         ZPOOL_STATUS_BAD_LOG,           /* cannot read log chain(s) */
 332         ZPOOL_STATUS_ERRATA,            /* informational errata available */
 333
 334         /*
 335          * If the pool has unsupported features but can still be opened in
 336          * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
 337          * pool has unsupported features but cannot be opened at all, its
 338          * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
 339          */
 340         ZPOOL_STATUS_UNSUP_FEAT_READ,   /* unsupported features for read */
 341         ZPOOL_STATUS_UNSUP_FEAT_WRITE,  /* unsupported features for write */
 342
 343         /*
 344          * These faults have no corresponding message ID.  At the time we are
 345          * checking the status, the original reason for the FMA fault (I/O or
 346          * checksum errors) has been lost.
 347          */
 348         ZPOOL_STATUS_FAULTED_DEV_R,     /* faulted device with replicas */
 349         ZPOOL_STATUS_FAULTED_DEV_NR,    /* faulted device with no replicas */
 350
 351         /*
 352          * The following are not faults per se, but still an error possibly
 353          * requiring administrative attention.  There is no corresponding
 354          * message ID.
 355          */
 356         ZPOOL_STATUS_VERSION_OLDER,     /* older legacy on-disk version */
 357         ZPOOL_STATUS_FEAT_DISABLED,     /* supported features are disabled */
 358         ZPOOL_STATUS_RESILVERING,       /* device being resilvered */
 359         ZPOOL_STATUS_OFFLINE_DEV,       /* device offline */
 360         ZPOOL_STATUS_REMOVED_DEV,       /* removed device */
 361
 362         /*
 363          * Finally, the following indicates a healthy pool.
 364          */
 365         ZPOOL_STATUS_OK
 366 } zpool_status_t;
 367
 368 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **,
 369     zpool_errata_t *);
 370 extern zpool_status_t zpool_import_status(nvlist_t *, char **,
 371     zpool_errata_t *);
 372
 373 /*
 374  * Statistics and configuration functions.
 375  */
 376 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
 377 extern nvlist_t *zpool_get_features(zpool_handle_t *);
 378 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
 379 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
 380
 381 /*
 382  * Import and export functions
 383  */
 384 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
 385 extern int zpool_export_force(zpool_handle_t *, const char *);
 386 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
 387     char *altroot);
 388 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
 389     nvlist_t *, int);
 390 extern void zpool_print_unsup_feat(nvlist_t *config);
 391
 392 /*
 393  * Miscellaneous pool functions
 394  */
 395 struct zfs_cmd;
 396
 397 extern const char *zfs_history_event_names[];
 398
 399 typedef enum {
 400         VDEV_NAME_PATH          = 1 << 0,
 401         VDEV_NAME_GUID          = 1 << 1,
 402         VDEV_NAME_FOLLOW_LINKS  = 1 << 2,
 403         VDEV_NAME_TYPE_ID       = 1 << 3,
 404 } vdev_name_t;
 405
 406 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
 407     int name_flags);
 408 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
 409 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
 410 extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned,
 411     int);
 412 extern int zpool_events_clear(libzfs_handle_t *, int *);
 413 extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int);
 414 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
 415     size_t len);
 416 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
 417 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
 418 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
 419     nvlist_t *);
 420 extern int zpool_checkpoint(zpool_handle_t *);
 421 extern int zpool_discard_checkpoint(zpool_handle_t *);
 422
 423 /*
 424  * Basic handle manipulations.  These functions do not create or destroy the
 425  * underlying datasets, only the references to them.
 426  */
 427 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
 428 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
 429 extern void zfs_close(zfs_handle_t *);
 430 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
 431 extern const char *zfs_get_name(const zfs_handle_t *);
 432 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
 433 extern const char *zfs_get_pool_name(const zfs_handle_t *);
 434
 435 /*
 436  * Property management functions.  Some functions are shared with the kernel,
 437  * and are found in sys/fs/zfs.h.
 438  */
 439
 440 /*
 441  * zfs dataset property management
 442  */
 443 extern const char *zfs_prop_default_string(zfs_prop_t);
 444 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
 445 extern const char *zfs_prop_column_name(zfs_prop_t);
 446 extern boolean_t zfs_prop_align_right(zfs_prop_t);
 447
 448 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *,
 449     uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *);
 450
 451 extern const char *zfs_prop_to_name(zfs_prop_t);
 452 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
 453 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
 454 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
 455     zprop_source_t *, char *, size_t, boolean_t);
 456 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
 457     boolean_t);
 458 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
 459     zprop_source_t *, char *, size_t);
 460 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
 461     uint64_t *propvalue);
 462 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
 463     char *propbuf, int proplen, boolean_t literal);
 464 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
 465     uint64_t *propvalue);
 466 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
 467     char *propbuf, int proplen, boolean_t literal);
 468 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
 469     char *buf, size_t len);
 470 extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **);
 471 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
 472 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
 473 extern const char *zfs_prop_values(zfs_prop_t);
 474 extern int zfs_prop_is_string(zfs_prop_t prop);
 475 extern nvlist_t *zfs_get_all_props(zfs_handle_t *);
 476 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
 477 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
 478 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
 479
 480 /*
 481  * zfs encryption management
 482  */
 483 extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *);
 484 extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *,
 485     boolean_t stdin_available, uint8_t **, uint_t *);
 486 extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *,
 487     nvlist_t *);
 488 extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *);
 489 extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *);
 490 extern int zfs_crypto_unload_key(zfs_handle_t *);
 491 extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t);
 492
 493 typedef struct zprop_list {
 494         int             pl_prop;
 495         char            *pl_user_prop;
 496         struct zprop_list *pl_next;
 497         boolean_t       pl_all;
 498         size_t          pl_width;
 499         size_t          pl_recvd_width;
 500         boolean_t       pl_fixed;
 501 } zprop_list_t;
 502
 503 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
 504     boolean_t);
 505 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
 506
 507 #define ZFS_MOUNTPOINT_NONE     "none"
 508 #define ZFS_MOUNTPOINT_LEGACY   "legacy"
 509
 510 #define ZFS_FEATURE_DISABLED    "disabled"
 511 #define ZFS_FEATURE_ENABLED     "enabled"
 512 #define ZFS_FEATURE_ACTIVE      "active"
 513
 514 #define ZFS_UNSUPPORTED_INACTIVE        "inactive"
 515 #define ZFS_UNSUPPORTED_READONLY        "readonly"
 516
 517 /*
 518  * zpool property management
 519  */
 520 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
 521 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
 522     size_t);
 523 extern const char *zpool_prop_default_string(zpool_prop_t);
 524 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
 525 extern const char *zpool_prop_column_name(zpool_prop_t);
 526 extern boolean_t zpool_prop_align_right(zpool_prop_t);
 527
 528 /*
 529  * Functions shared by zfs and zpool property management.
 530  */
 531 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
 532     boolean_t ordered, zfs_type_t type);
 533 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
 534     zfs_type_t);
 535 extern void zprop_free_list(zprop_list_t *);
 536
 537 #define ZFS_GET_NCOLS   5
 538
 539 typedef enum {
 540         GET_COL_NONE,
 541         GET_COL_NAME,
 542         GET_COL_PROPERTY,
 543         GET_COL_VALUE,
 544         GET_COL_RECVD,
 545         GET_COL_SOURCE
 546 } zfs_get_column_t;
 547
 548 /*
 549  * Functions for printing zfs or zpool properties
 550  */
 551 typedef struct zprop_get_cbdata {
 552         int cb_sources;
 553         zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
 554         int cb_colwidths[ZFS_GET_NCOLS + 1];
 555         boolean_t cb_scripted;
 556         boolean_t cb_literal;
 557         boolean_t cb_first;
 558         zprop_list_t *cb_proplist;
 559         zfs_type_t cb_type;
 560 } zprop_get_cbdata_t;
 561
 562 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
 563     const char *, const char *, zprop_source_t, const char *,
 564     const char *);
 565
 566 /*
 567  * Iterator functions.
 568  */
 569 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
 570 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
 571 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
 572 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 573 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
 574 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 575 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
 576 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
 577 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
 578 extern int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *);
 579
 580 typedef struct get_all_cb {
 581         zfs_handle_t    **cb_handles;
 582         size_t          cb_alloc;
 583         size_t          cb_used;
 584 } get_all_cb_t;
 585
 586 void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t,
 587     zfs_iter_f, void *, boolean_t);
 588 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
 589
 590 /*
 591  * Functions to create and destroy datasets.
 592  */
 593 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
 594     nvlist_t *);
 595 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
 596 extern int zfs_destroy(zfs_handle_t *, boolean_t);
 597 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
 598 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
 599 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
 600 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
 601 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
 602     nvlist_t *props);
 603 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
 604 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
 605
 606 typedef struct sendflags {
 607         /* print informational messages (ie, -v was specified) */
 608         boolean_t verbose;
 609
 610         /* recursive send  (ie, -R) */
 611         boolean_t replicate;
 612
 613         /* for incrementals, do all intermediate snapshots */
 614         boolean_t doall;
 615
 616         /* if dataset is a clone, do incremental from its origin */
 617         boolean_t fromorigin;
 618
 619         /* do deduplication */
 620         boolean_t dedup;
 621
 622         /* send properties (ie, -p) */
 623         boolean_t props;
 624
 625         /* do not send (no-op, ie. -n) */
 626         boolean_t dryrun;
 627
 628         /* parsable verbose output (ie. -P) */
 629         boolean_t parsable;
 630
 631         /* show progress (ie. -v) */
 632         boolean_t progress;
 633
 634         /* large blocks (>128K) are permitted */
 635         boolean_t largeblock;
 636
 637         /* WRITE_EMBEDDED records of type DATA are permitted */
 638         boolean_t embed_data;
 639
 640         /* compressed WRITE records are permitted */
 641         boolean_t compress;
 642
 643         /* raw encrypted records are permitted */
 644         boolean_t raw;
 645
 646         /* only send received properties (ie. -b) */
 647         boolean_t backup;
 648
 649         /* include snapshot holds in send stream */
 650         boolean_t holds;
 651 } sendflags_t;
 652
 653 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
 654
 655 extern int zfs_send(zfs_handle_t *, const char *, const char *,
 656     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
 657 extern int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t flags);
 658 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
 659     const char *);
 660 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
 661     const char *token);
 662
 663 extern int zfs_promote(zfs_handle_t *);
 664 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
 665     boolean_t, int);
 666 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
 667 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
 668 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
 669 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
 670
 671 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
 672     uid_t rid, uint64_t space);
 673
 674 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
 675     zfs_userspace_cb_t, void *);
 676
 677 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
 678 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
 679
 680 typedef struct recvflags {
 681         /* print informational messages (ie, -v was specified) */
 682         boolean_t verbose;
 683
 684         /* the destination is a prefix, not the exact fs (ie, -d) */
 685         boolean_t isprefix;
 686
 687         /*
 688          * Only the tail of the sent snapshot path is appended to the
 689          * destination to determine the received snapshot name (ie, -e).
 690          */
 691         boolean_t istail;
 692
 693         /* do not actually do the recv, just check if it would work (ie, -n) */
 694         boolean_t dryrun;
 695
 696         /* rollback/destroy filesystems as necessary (eg, -F) */
 697         boolean_t force;
 698
 699         /* set "canmount=off" on all modified filesystems */
 700         boolean_t canmountoff;
 701
 702         /*
 703          * Mark the file systems as "resumable" and do not destroy them if the
 704          * receive is interrupted
 705          */
 706         boolean_t resumable;
 707
 708         /* byteswap flag is used internally; callers need not specify */
 709         boolean_t byteswap;
 710
 711         /* do not mount file systems as they are extracted (private) */
 712         boolean_t nomount;
 713
 714         /* Was holds flag set in the compound header? */
 715         boolean_t holds;
 716
 717         /* skip receive of snapshot holds */
 718         boolean_t skipholds;
 719 } recvflags_t;
 720
 721 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
 722     recvflags_t *, int, avl_tree_t *);
 723
 724 typedef enum diff_flags {
 725         ZFS_DIFF_PARSEABLE = 0x1,
 726         ZFS_DIFF_TIMESTAMP = 0x2,
 727         ZFS_DIFF_CLASSIFY = 0x4
 728 } diff_flags_t;
 729
 730 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
 731     int);
 732
 733 /*
 734  * Miscellaneous functions.
 735  */
 736 extern const char *zfs_type_to_name(zfs_type_t);
 737 extern void zfs_refresh_properties(zfs_handle_t *);
 738 extern int zfs_name_valid(const char *, zfs_type_t);
 739 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
 740 extern int zfs_parent_name(zfs_handle_t *, char *, size_t);
 741 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
 742     zfs_type_t);
 743 extern int zfs_spa_version(zfs_handle_t *, int *);
 744 extern boolean_t zfs_bookmark_exists(const char *path);
 745
 746 /*
 747  * Mount support functions.
 748  */
 749 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
 750 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
 751 extern int zfs_mount(zfs_handle_t *, const char *, int);
 752 extern int zfs_unmount(zfs_handle_t *, const char *, int);
 753 extern int zfs_unmountall(zfs_handle_t *, int);
 754
 755 /*
 756  * Share support functions.
 757  */
 758 extern boolean_t zfs_is_shared(zfs_handle_t *);
 759 extern int zfs_share(zfs_handle_t *);
 760 extern int zfs_unshare(zfs_handle_t *);
 761
 762 /*
 763  * Protocol-specific share support functions.
 764  */
 765 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
 766 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
 767 extern int zfs_share_nfs(zfs_handle_t *);
 768 extern int zfs_share_smb(zfs_handle_t *);
 769 extern int zfs_shareall(zfs_handle_t *);
 770 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
 771 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
 772 extern int zfs_unshareall_nfs(zfs_handle_t *);
 773 extern int zfs_unshareall_smb(zfs_handle_t *);
 774 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
 775 extern int zfs_unshareall_bytype(zfs_handle_t *, const char *, const char *);
 776 extern int zfs_unshareall(zfs_handle_t *);
 777 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
 778     void *, void *, int, zfs_share_op_t);
 779
 780 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
 781
 782 /*
 783  * Utility functions to run an external process.
 784  */
 785 #define STDOUT_VERBOSE  0x01
 786 #define STDERR_VERBOSE  0x02
 787 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
 788
 789 int libzfs_run_process(const char *, char **, int flags);
 790 int libzfs_run_process_get_stdout(const char *path, char *argv[], char *env[],
 791     char **lines[], int *lines_cnt);
 792 int libzfs_run_process_get_stdout_nopath(const char *path, char *argv[],
 793     char *env[], char **lines[], int *lines_cnt);
 794
 795 void libzfs_free_str_array(char **strs, int count);
 796
 797 int libzfs_envvar_is_set(char *envvar);
 798
 799 /*
 800  * Given a device or file, determine if it is part of a pool.
 801  */
 802 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
 803     boolean_t *);
 804
 805 /*
 806  * Label manipulation.
 807  */
 808 extern int zpool_clear_label(int);
 809
 810 /*
 811  * Management interfaces for SMB ACL files
 812  */
 813
 814 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
 815 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
 816 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
 817 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
 818
 819 /*
 820  * Enable and disable datasets within a pool by mounting/unmounting and
 821  * sharing/unsharing them.
 822  */
 823 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
 824 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
 825
 826 extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *);
 827
 828 #ifdef  __cplusplus
 829 }
 830 #endif
 831
 832 #endif  /* _LIBZFS_H */