cddl/contrib/opensolaris/lib/libzfs/common/libzfs.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright (c) 2011 Pawel Jakub Dawidek. All rights reserved.
  25  * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
  26  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
  27  * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
  28  * Copyright (c) 2013 Steven Hartland. All rights reserved.
  29  * Copyright (c) 2014 Integros [integros.com]
  30  * Copyright 2016 Nexenta Systems, Inc.
  31  * Copyright (c) 2017 Datto Inc.
  32  */
  33
  34 #ifndef _LIBZFS_H
  35 #define _LIBZFS_H
  36
  37 #include <assert.h>
  38 #include <libnvpair.h>
  39 #include <sys/mnttab.h>
  40 #include <sys/param.h>
  41 #include <sys/types.h>
  42 #include <sys/varargs.h>
  43 #include <sys/fs/zfs.h>
  44 #include <sys/avl.h>
  45 #include <sys/zfs_ioctl.h>
  46 #include <libzfs_core.h>
  47
  48 #ifdef  __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 /*
  53  * Miscellaneous ZFS constants
  54  */
  55 #define ZFS_MAXPROPLEN          MAXPATHLEN
  56 #define ZPOOL_MAXPROPLEN        MAXPATHLEN
  57
  58 /*
  59  * libzfs errors
  60  */
  61 typedef enum zfs_error {
  62         EZFS_SUCCESS = 0,       /* no error -- success */
  63         EZFS_NOMEM = 2000,      /* out of memory */
  64         EZFS_BADPROP,           /* invalid property value */
  65         EZFS_PROPREADONLY,      /* cannot set readonly property */
  66         EZFS_PROPTYPE,          /* property does not apply to dataset type */
  67         EZFS_PROPNONINHERIT,    /* property is not inheritable */
  68         EZFS_PROPSPACE,         /* bad quota or reservation */
  69         EZFS_BADTYPE,           /* dataset is not of appropriate type */
  70         EZFS_BUSY,              /* pool or dataset is busy */
  71         EZFS_EXISTS,            /* pool or dataset already exists */
  72         EZFS_NOENT,             /* no such pool or dataset */
  73         EZFS_BADSTREAM,         /* bad backup stream */
  74         EZFS_DSREADONLY,        /* dataset is readonly */
  75         EZFS_VOLTOOBIG,         /* volume is too large for 32-bit system */
  76         EZFS_INVALIDNAME,       /* invalid dataset name */
  77         EZFS_BADRESTORE,        /* unable to restore to destination */
  78         EZFS_BADBACKUP,         /* backup failed */
  79         EZFS_BADTARGET,         /* bad attach/detach/replace target */
  80         EZFS_NODEVICE,          /* no such device in pool */
  81         EZFS_BADDEV,            /* invalid device to add */
  82         EZFS_NOREPLICAS,        /* no valid replicas */
  83         EZFS_RESILVERING,       /* currently resilvering */
  84         EZFS_BADVERSION,        /* unsupported version */
  85         EZFS_POOLUNAVAIL,       /* pool is currently unavailable */
  86         EZFS_DEVOVERFLOW,       /* too many devices in one vdev */
  87         EZFS_BADPATH,           /* must be an absolute path */
  88         EZFS_CROSSTARGET,       /* rename or clone across pool or dataset */
  89         EZFS_ZONED,             /* used improperly in local zone */
  90         EZFS_MOUNTFAILED,       /* failed to mount dataset */
  91         EZFS_UMOUNTFAILED,      /* failed to unmount dataset */
  92         EZFS_UNSHARENFSFAILED,  /* unshare(1M) failed */
  93         EZFS_SHARENFSFAILED,    /* share(1M) failed */
  94         EZFS_PERM,              /* permission denied */
  95         EZFS_NOSPC,             /* out of space */
  96         EZFS_FAULT,             /* bad address */
  97         EZFS_IO,                /* I/O error */
  98         EZFS_INTR,              /* signal received */
  99         EZFS_ISSPARE,           /* device is a hot spare */
 100         EZFS_INVALCONFIG,       /* invalid vdev configuration */
 101         EZFS_RECURSIVE,         /* recursive dependency */
 102         EZFS_NOHISTORY,         /* no history object */
 103         EZFS_POOLPROPS,         /* couldn't retrieve pool props */
 104         EZFS_POOL_NOTSUP,       /* ops not supported for this type of pool */
 105         EZFS_POOL_INVALARG,     /* invalid argument for this pool operation */
 106         EZFS_NAMETOOLONG,       /* dataset name is too long */
 107         EZFS_OPENFAILED,        /* open of device failed */
 108         EZFS_NOCAP,             /* couldn't get capacity */
 109         EZFS_LABELFAILED,       /* write of label failed */
 110         EZFS_BADWHO,            /* invalid permission who */
 111         EZFS_BADPERM,           /* invalid permission */
 112         EZFS_BADPERMSET,        /* invalid permission set name */
 113         EZFS_NODELEGATION,      /* delegated administration is disabled */
 114         EZFS_UNSHARESMBFAILED,  /* failed to unshare over smb */
 115         EZFS_SHARESMBFAILED,    /* failed to share over smb */
 116         EZFS_BADCACHE,          /* bad cache file */
 117         EZFS_ISL2CACHE,         /* device is for the level 2 ARC */
 118         EZFS_VDEVNOTSUP,        /* unsupported vdev type */
 119         EZFS_NOTSUP,            /* ops not supported on this dataset */
 120         EZFS_ACTIVE_SPARE,      /* pool has active shared spare devices */
 121         EZFS_UNPLAYED_LOGS,     /* log device has unplayed logs */
 122         EZFS_REFTAG_RELE,       /* snapshot release: tag not found */
 123         EZFS_REFTAG_HOLD,       /* snapshot hold: tag already exists */
 124         EZFS_TAGTOOLONG,        /* snapshot hold/rele: tag too long */
 125         EZFS_PIPEFAILED,        /* pipe create failed */
 126         EZFS_THREADCREATEFAILED, /* thread create failed */
 127         EZFS_POSTSPLIT_ONLINE,  /* onlining a disk after splitting it */
 128         EZFS_SCRUBBING,         /* currently scrubbing */
 129         EZFS_NO_SCRUB,          /* no active scrub */
 130         EZFS_DIFF,              /* general failure of zfs diff */
 131         EZFS_DIFFDATA,          /* bad zfs diff data */
 132         EZFS_POOLREADONLY,      /* pool is in read-only mode */
 133         EZFS_SCRUB_PAUSED,      /* scrub currently paused */
 134         EZFS_NO_PENDING,        /* cannot cancel, no operation is pending */
 135         EZFS_UNKNOWN
 136 } zfs_error_t;
 137
 138 /*
 139  * UEFI boot support parameters. When creating whole disk boot pool,
 140  * zpool create should allow to create EFI System partition for UEFI boot
 141  * program. In case of BIOS, the EFI System partition is not used
 142  * even if it does exist.
 143  */
 144 typedef enum zpool_boot_label {
 145         ZPOOL_NO_BOOT_LABEL = 0,
 146         ZPOOL_CREATE_BOOT_LABEL,
 147         ZPOOL_COPY_BOOT_LABEL
 148 } zpool_boot_label_t;
 149
 150 /*
 151  * The following data structures are all part
 152  * of the zfs_allow_t data structure which is
 153  * used for printing 'allow' permissions.
 154  * It is a linked list of zfs_allow_t's which
 155  * then contain avl tree's for user/group/sets/...
 156  * and each one of the entries in those trees have
 157  * avl tree's for the permissions they belong to and
 158  * whether they are local,descendent or local+descendent
 159  * permissions.  The AVL trees are used primarily for
 160  * sorting purposes, but also so that we can quickly find
 161  * a given user and or permission.
 162  */
 163 typedef struct zfs_perm_node {
 164         avl_node_t z_node;
 165         char z_pname[MAXPATHLEN];
 166 } zfs_perm_node_t;
 167
 168 typedef struct zfs_allow_node {
 169         avl_node_t z_node;
 170         char z_key[MAXPATHLEN];         /* name, such as joe */
 171         avl_tree_t z_localdescend;      /* local+descendent perms */
 172         avl_tree_t z_local;             /* local permissions */
 173         avl_tree_t z_descend;           /* descendent permissions */
 174 } zfs_allow_node_t;
 175
 176 typedef struct zfs_allow {
 177         struct zfs_allow *z_next;
 178         char z_setpoint[MAXPATHLEN];
 179         avl_tree_t z_sets;
 180         avl_tree_t z_crperms;
 181         avl_tree_t z_user;
 182         avl_tree_t z_group;
 183         avl_tree_t z_everyone;
 184 } zfs_allow_t;
 185
 186 /*
 187  * Basic handle types
 188  */
 189 typedef struct zfs_handle zfs_handle_t;
 190 typedef struct zpool_handle zpool_handle_t;
 191 typedef struct libzfs_handle libzfs_handle_t;
 192
 193 /*
 194  * Library initialization
 195  */
 196 extern libzfs_handle_t *libzfs_init(void);
 197 extern void libzfs_fini(libzfs_handle_t *);
 198
 199 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
 200 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
 201
 202 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
 203
 204 extern void zfs_save_arguments(int argc, char **, char *, int);
 205 extern int zpool_log_history(libzfs_handle_t *, const char *);
 206
 207 extern int libzfs_errno(libzfs_handle_t *);
 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 extern int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, const char *);
 232
 233 /*
 234  * Iterate over all active pools in the system.
 235  */
 236 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
 237 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
 238 extern boolean_t zpool_skip_pool(const char *);
 239
 240 /*
 241  * Functions to create and destroy pools
 242  */
 243 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
 244     nvlist_t *, nvlist_t *);
 245 extern int zpool_destroy(zpool_handle_t *, const char *);
 246 extern int zpool_add(zpool_handle_t *, nvlist_t *);
 247
 248 typedef struct splitflags {
 249         /* do not split, but return the config that would be split off */
 250         int dryrun : 1;
 251
 252         /* after splitting, import the pool */
 253         int import : 1;
 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_clear(zpool_handle_t *, const char *, nvlist_t *);
 261 extern int zpool_reguid(zpool_handle_t *);
 262 extern int zpool_reopen(zpool_handle_t *);
 263
 264 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
 265     vdev_state_t *);
 266 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
 267 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
 268     const char *, nvlist_t *, int);
 269 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
 270 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
 271 extern int zpool_vdev_remove_cancel(zpool_handle_t *);
 272 extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *);
 273 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
 274     splitflags_t);
 275
 276 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
 277 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
 278 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
 279
 280 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
 281     boolean_t *, boolean_t *);
 282 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
 283     boolean_t *, boolean_t *, boolean_t *);
 284 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *,
 285     zpool_boot_label_t, uint64_t, int *);
 286
 287 /*
 288  * Functions to manage pool properties
 289  */
 290 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
 291 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
 292     size_t proplen, zprop_source_t *, boolean_t);
 293 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
 294     zprop_source_t *);
 295
 296 extern const char *zpool_prop_to_name(zpool_prop_t);
 297 extern const char *zpool_prop_values(zpool_prop_t);
 298
 299 /*
 300  * Pool health statistics.
 301  */
 302 typedef enum {
 303         /*
 304          * The following correspond to faults as defined in the (fault.fs.zfs.*)
 305          * event namespace.  Each is associated with a corresponding message ID.
 306          */
 307         ZPOOL_STATUS_CORRUPT_CACHE,     /* corrupt /kernel/drv/zpool.cache */
 308         ZPOOL_STATUS_MISSING_DEV_R,     /* missing device with replicas */
 309         ZPOOL_STATUS_MISSING_DEV_NR,    /* missing device with no replicas */
 310         ZPOOL_STATUS_CORRUPT_LABEL_R,   /* bad device label with replicas */
 311         ZPOOL_STATUS_CORRUPT_LABEL_NR,  /* bad device label with no replicas */
 312         ZPOOL_STATUS_BAD_GUID_SUM,      /* sum of device guids didn't match */
 313         ZPOOL_STATUS_CORRUPT_POOL,      /* pool metadata is corrupted */
 314         ZPOOL_STATUS_CORRUPT_DATA,      /* data errors in user (meta)data */
 315         ZPOOL_STATUS_FAILING_DEV,       /* device experiencing errors */
 316         ZPOOL_STATUS_VERSION_NEWER,     /* newer on-disk version */
 317         ZPOOL_STATUS_HOSTID_MISMATCH,   /* last accessed by another system */
 318         ZPOOL_STATUS_IO_FAILURE_WAIT,   /* failed I/O, failmode 'wait' */
 319         ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
 320         ZPOOL_STATUS_BAD_LOG,           /* cannot read log chain(s) */
 321
 322         /*
 323          * If the pool has unsupported features but can still be opened in
 324          * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
 325          * pool has unsupported features but cannot be opened at all, its
 326          * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
 327          */
 328         ZPOOL_STATUS_UNSUP_FEAT_READ,   /* unsupported features for read */
 329         ZPOOL_STATUS_UNSUP_FEAT_WRITE,  /* unsupported features for write */
 330
 331         /*
 332          * These faults have no corresponding message ID.  At the time we are
 333          * checking the status, the original reason for the FMA fault (I/O or
 334          * checksum errors) has been lost.
 335          */
 336         ZPOOL_STATUS_FAULTED_DEV_R,     /* faulted device with replicas */
 337         ZPOOL_STATUS_FAULTED_DEV_NR,    /* faulted device with no replicas */
 338
 339         /*
 340          * The following are not faults per se, but still an error possibly
 341          * requiring administrative attention.  There is no corresponding
 342          * message ID.
 343          */
 344         ZPOOL_STATUS_VERSION_OLDER,     /* older legacy on-disk version */
 345         ZPOOL_STATUS_FEAT_DISABLED,     /* supported features are disabled */
 346         ZPOOL_STATUS_RESILVERING,       /* device being resilvered */
 347         ZPOOL_STATUS_OFFLINE_DEV,       /* device offline */
 348         ZPOOL_STATUS_REMOVED_DEV,       /* removed device */
 349         ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
 350
 351         /*
 352          * Finally, the following indicates a healthy pool.
 353          */
 354         ZPOOL_STATUS_OK
 355 } zpool_status_t;
 356
 357 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
 358 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
 359 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
 360
 361 /*
 362  * Statistics and configuration functions.
 363  */
 364 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
 365 extern nvlist_t *zpool_get_features(zpool_handle_t *);
 366 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
 367 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
 368 extern boolean_t zpool_is_bootable(zpool_handle_t *);
 369
 370 /*
 371  * Import and export functions
 372  */
 373 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
 374 extern int zpool_export_force(zpool_handle_t *, const char *);
 375 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
 376     char *altroot);
 377 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
 378     nvlist_t *, int);
 379 extern void zpool_print_unsup_feat(nvlist_t *config);
 380
 381 /*
 382  * Search for pools to import
 383  */
 384
 385 typedef struct importargs {
 386         char **path;            /* a list of paths to search            */
 387         int paths;              /* number of paths to search            */
 388         char *poolname;         /* name of a pool to find               */
 389         uint64_t guid;          /* guid of a pool to find               */
 390         char *cachefile;        /* cachefile to use for import          */
 391         int can_be_active : 1;  /* can the pool be active?              */
 392         int unique : 1;         /* does 'poolname' already exist?       */
 393         int exists : 1;         /* set on return if pool already exists */
 394 } importargs_t;
 395
 396 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
 397
 398 /* legacy pool search routines */
 399 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
 400 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
 401     char *, uint64_t);
 402
 403 /*
 404  * Miscellaneous pool functions
 405  */
 406 struct zfs_cmd;
 407
 408 extern const char *zfs_history_event_names[];
 409
 410 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
 411     boolean_t verbose);
 412 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
 413 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
 414 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
 415     nvlist_t ***, uint_t *);
 416 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
 417     size_t len);
 418 extern int zfs_ioctl(libzfs_handle_t *, int request, struct zfs_cmd *);
 419 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
 420 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
 421     nvlist_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,
 449     nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_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 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_user_props(zfs_handle_t *);
 475 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
 476 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
 477
 478
 479 typedef struct zprop_list {
 480         int             pl_prop;
 481         char            *pl_user_prop;
 482         struct zprop_list *pl_next;
 483         boolean_t       pl_all;
 484         size_t          pl_width;
 485         size_t          pl_recvd_width;
 486         boolean_t       pl_fixed;
 487 } zprop_list_t;
 488
 489 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
 490     boolean_t);
 491 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
 492
 493 #define ZFS_MOUNTPOINT_NONE     "none"
 494 #define ZFS_MOUNTPOINT_LEGACY   "legacy"
 495
 496 #define ZFS_FEATURE_DISABLED    "disabled"
 497 #define ZFS_FEATURE_ENABLED     "enabled"
 498 #define ZFS_FEATURE_ACTIVE      "active"
 499
 500 #define ZFS_UNSUPPORTED_INACTIVE        "inactive"
 501 #define ZFS_UNSUPPORTED_READONLY        "readonly"
 502
 503 /*
 504  * zpool property management
 505  */
 506 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
 507 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
 508     size_t);
 509 extern const char *zpool_prop_default_string(zpool_prop_t);
 510 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
 511 extern const char *zpool_prop_column_name(zpool_prop_t);
 512 extern boolean_t zpool_prop_align_right(zpool_prop_t);
 513
 514 /*
 515  * Functions shared by zfs and zpool property management.
 516  */
 517 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
 518     boolean_t ordered, zfs_type_t type);
 519 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
 520     zfs_type_t);
 521 extern void zprop_free_list(zprop_list_t *);
 522
 523 #define ZFS_GET_NCOLS   5
 524
 525 typedef enum {
 526         GET_COL_NONE,
 527         GET_COL_NAME,
 528         GET_COL_PROPERTY,
 529         GET_COL_VALUE,
 530         GET_COL_RECVD,
 531         GET_COL_SOURCE
 532 } zfs_get_column_t;
 533
 534 /*
 535  * Functions for printing zfs or zpool properties
 536  */
 537 typedef struct zprop_get_cbdata {
 538         int cb_sources;
 539         zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
 540         int cb_colwidths[ZFS_GET_NCOLS + 1];
 541         boolean_t cb_scripted;
 542         boolean_t cb_literal;
 543         boolean_t cb_first;
 544         zprop_list_t *cb_proplist;
 545         zfs_type_t cb_type;
 546 } zprop_get_cbdata_t;
 547
 548 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
 549     const char *, const char *, zprop_source_t, const char *,
 550     const char *);
 551
 552 /*
 553  * Iterator functions.
 554  */
 555 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
 556 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
 557 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
 558 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 559 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
 560 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 561 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
 562 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
 563 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
 564
 565 typedef struct get_all_cb {
 566         zfs_handle_t    **cb_handles;
 567         size_t          cb_alloc;
 568         size_t          cb_used;
 569         boolean_t       cb_verbose;
 570         int             (*cb_getone)(zfs_handle_t *, void *);
 571 } get_all_cb_t;
 572
 573 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
 574 int libzfs_dataset_cmp(const void *, const void *);
 575
 576 /*
 577  * Functions to create and destroy datasets.
 578  */
 579 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
 580     nvlist_t *);
 581 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
 582 extern int zfs_destroy(zfs_handle_t *, boolean_t);
 583 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
 584 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
 585 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
 586 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
 587 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
 588     nvlist_t *props);
 589 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
 590
 591 typedef struct renameflags {
 592         /* recursive rename */
 593         int recurse : 1;
 594
 595         /* don't unmount file systems */
 596         int nounmount : 1;
 597
 598         /* force unmount file systems */
 599         int forceunmount : 1;
 600 } renameflags_t;
 601
 602 extern int zfs_rename(zfs_handle_t *, const char *, const char *,
 603     renameflags_t flags);
 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 } sendflags_t;
 642
 643 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
 644
 645 extern int zfs_send(zfs_handle_t *, const char *, const char *,
 646     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
 647 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
 648 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
 649     const char *);
 650 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
 651     const char *token);
 652
 653 extern int zfs_promote(zfs_handle_t *);
 654 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
 655     boolean_t, int);
 656 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
 657 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
 658 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
 659 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
 660
 661 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
 662     uid_t rid, uint64_t space);
 663
 664 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
 665     zfs_userspace_cb_t, void *);
 666
 667 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
 668 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
 669
 670 typedef struct recvflags {
 671         /* print informational messages (ie, -v was specified) */
 672         boolean_t verbose;
 673
 674         /* the destination is a prefix, not the exact fs (ie, -d) */
 675         boolean_t isprefix;
 676
 677         /*
 678          * Only the tail of the sent snapshot path is appended to the
 679          * destination to determine the received snapshot name (ie, -e).
 680          */
 681         boolean_t istail;
 682
 683         /* do not actually do the recv, just check if it would work (ie, -n) */
 684         boolean_t dryrun;
 685
 686         /* rollback/destroy filesystems as necessary (eg, -F) */
 687         boolean_t force;
 688
 689         /* set "canmount=off" on all modified filesystems */
 690         boolean_t canmountoff;
 691
 692         /*
 693          * Mark the file systems as "resumable" and do not destroy them if the
 694          * receive is interrupted
 695          */
 696         boolean_t resumable;
 697
 698         /* byteswap flag is used internally; callers need not specify */
 699         boolean_t byteswap;
 700
 701         /* do not mount file systems as they are extracted (private) */
 702         boolean_t nomount;
 703 } recvflags_t;
 704
 705 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
 706     recvflags_t *, int, avl_tree_t *);
 707
 708 typedef enum diff_flags {
 709         ZFS_DIFF_PARSEABLE = 0x1,
 710         ZFS_DIFF_TIMESTAMP = 0x2,
 711         ZFS_DIFF_CLASSIFY = 0x4
 712 } diff_flags_t;
 713
 714 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
 715     int);
 716
 717 /*
 718  * Miscellaneous functions.
 719  */
 720 extern const char *zfs_type_to_name(zfs_type_t);
 721 extern void zfs_refresh_properties(zfs_handle_t *);
 722 extern int zfs_name_valid(const char *, zfs_type_t);
 723 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
 724 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
 725     zfs_type_t);
 726 extern int zfs_spa_version(zfs_handle_t *, int *);
 727 extern boolean_t zfs_bookmark_exists(const char *path);
 728
 729 /*
 730  * Mount support functions.
 731  */
 732 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
 733 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
 734 extern int zfs_mount(zfs_handle_t *, const char *, int);
 735 extern int zfs_unmount(zfs_handle_t *, const char *, int);
 736 extern int zfs_unmountall(zfs_handle_t *, int);
 737
 738 /*
 739  * Share support functions.
 740  */
 741 extern boolean_t zfs_is_shared(zfs_handle_t *);
 742 extern int zfs_share(zfs_handle_t *);
 743 extern int zfs_unshare(zfs_handle_t *);
 744
 745 /*
 746  * Protocol-specific share support functions.
 747  */
 748 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
 749 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
 750 extern int zfs_share_nfs(zfs_handle_t *);
 751 extern int zfs_share_smb(zfs_handle_t *);
 752 extern int zfs_shareall(zfs_handle_t *);
 753 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
 754 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
 755 extern int zfs_unshareall_nfs(zfs_handle_t *);
 756 extern int zfs_unshareall_smb(zfs_handle_t *);
 757 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
 758 extern int zfs_unshareall(zfs_handle_t *);
 759 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
 760     void *, void *, int, zfs_share_op_t);
 761
 762 /*
 763  * FreeBSD-specific jail support function.
 764  */
 765 extern int zfs_jail(zfs_handle_t *, int, int);
 766
 767 /*
 768  * When dealing with nvlists, verify() is extremely useful
 769  */
 770 #ifndef verify
 771 #ifdef NDEBUG
 772 #define verify(EX)      ((void)(EX))
 773 #else
 774 #define verify(EX)      assert(EX)
 775 #endif
 776 #endif
 777
 778 /*
 779  * Utility function to convert a number to a human-readable form.
 780  */
 781 extern void zfs_nicenum(uint64_t, char *, size_t);
 782 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
 783
 784 /*
 785  * Given a device or file, determine if it is part of a pool.
 786  */
 787 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
 788     boolean_t *);
 789
 790 /*
 791  * Label manipulation.
 792  */
 793 extern int zpool_read_label(int, nvlist_t **);
 794 extern int zpool_read_all_labels(int, nvlist_t **);
 795 extern int zpool_clear_label(int);
 796
 797 /* is this zvol valid for use as a dump device? */
 798 extern int zvol_check_dump_config(char *);
 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 /*
 817  * Mappings between vdev and FRU.
 818  */
 819 extern void libzfs_fru_refresh(libzfs_handle_t *);
 820 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
 821 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
 822 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
 823     const char *);
 824 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
 825 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
 826
 827 #ifndef illumos
 828 extern int zmount(const char *, const char *, int, char *, char *, int, char *,
 829     int);
 830 #endif
 831 extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *);
 832
 833 #ifdef  __cplusplus
 834 }
 835 #endif
 836
 837 #endif  /* _LIBZFS_H */