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