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, 2015 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_UNKNOWN
 135 } zfs_error_t;
 136
 137 /*
 138  * UEFI boot support parameters. When creating whole disk boot pool,
 139  * zpool create should allow to create EFI System partition for UEFI boot
 140  * program. In case of BIOS, the EFI System partition is not used
 141  * even if it does exist.
 142  */
 143 typedef enum zpool_boot_label {
 144         ZPOOL_NO_BOOT_LABEL = 0,
 145         ZPOOL_CREATE_BOOT_LABEL,
 146         ZPOOL_COPY_BOOT_LABEL
 147 } zpool_boot_label_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_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 extern int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, const char *);
 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 } 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_clear(zpool_handle_t *, const char *, nvlist_t *);
 260 extern int zpool_reguid(zpool_handle_t *);
 261 extern int zpool_reopen(zpool_handle_t *);
 262
 263 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
 264     vdev_state_t *);
 265 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
 266 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
 267     const char *, nvlist_t *, int);
 268 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
 269 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
 270 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
 271     splitflags_t);
 272
 273 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
 274 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
 275 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
 276
 277 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
 278     boolean_t *, boolean_t *);
 279 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
 280     boolean_t *, boolean_t *, boolean_t *);
 281 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *,
 282     zpool_boot_label_t, uint64_t, int *);
 283
 284 /*
 285  * Functions to manage pool properties
 286  */
 287 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
 288 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
 289     size_t proplen, zprop_source_t *, boolean_t);
 290 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
 291     zprop_source_t *);
 292
 293 extern const char *zpool_prop_to_name(zpool_prop_t);
 294 extern const char *zpool_prop_values(zpool_prop_t);
 295
 296 /*
 297  * Pool health statistics.
 298  */
 299 typedef enum {
 300         /*
 301          * The following correspond to faults as defined in the (fault.fs.zfs.*)
 302          * event namespace.  Each is associated with a corresponding message ID.
 303          */
 304         ZPOOL_STATUS_CORRUPT_CACHE,     /* corrupt /kernel/drv/zpool.cache */
 305         ZPOOL_STATUS_MISSING_DEV_R,     /* missing device with replicas */
 306         ZPOOL_STATUS_MISSING_DEV_NR,    /* missing device with no replicas */
 307         ZPOOL_STATUS_CORRUPT_LABEL_R,   /* bad device label with replicas */
 308         ZPOOL_STATUS_CORRUPT_LABEL_NR,  /* bad device label with no replicas */
 309         ZPOOL_STATUS_BAD_GUID_SUM,      /* sum of device guids didn't match */
 310         ZPOOL_STATUS_CORRUPT_POOL,      /* pool metadata is corrupted */
 311         ZPOOL_STATUS_CORRUPT_DATA,      /* data errors in user (meta)data */
 312         ZPOOL_STATUS_FAILING_DEV,       /* device experiencing errors */
 313         ZPOOL_STATUS_VERSION_NEWER,     /* newer on-disk version */
 314         ZPOOL_STATUS_HOSTID_MISMATCH,   /* last accessed by another system */
 315         ZPOOL_STATUS_IO_FAILURE_WAIT,   /* failed I/O, failmode 'wait' */
 316         ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
 317         ZPOOL_STATUS_BAD_LOG,           /* cannot read log chain(s) */
 318
 319         /*
 320          * If the pool has unsupported features but can still be opened in
 321          * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
 322          * pool has unsupported features but cannot be opened at all, its
 323          * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
 324          */
 325         ZPOOL_STATUS_UNSUP_FEAT_READ,   /* unsupported features for read */
 326         ZPOOL_STATUS_UNSUP_FEAT_WRITE,  /* unsupported features for write */
 327
 328         /*
 329          * These faults have no corresponding message ID.  At the time we are
 330          * checking the status, the original reason for the FMA fault (I/O or
 331          * checksum errors) has been lost.
 332          */
 333         ZPOOL_STATUS_FAULTED_DEV_R,     /* faulted device with replicas */
 334         ZPOOL_STATUS_FAULTED_DEV_NR,    /* faulted device with no replicas */
 335
 336         /*
 337          * The following are not faults per se, but still an error possibly
 338          * requiring administrative attention.  There is no corresponding
 339          * message ID.
 340          */
 341         ZPOOL_STATUS_VERSION_OLDER,     /* older legacy on-disk version */
 342         ZPOOL_STATUS_FEAT_DISABLED,     /* supported features are disabled */
 343         ZPOOL_STATUS_RESILVERING,       /* device being resilvered */
 344         ZPOOL_STATUS_OFFLINE_DEV,       /* device offline */
 345         ZPOOL_STATUS_REMOVED_DEV,       /* removed device */
 346         ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */
 347
 348         /*
 349          * Finally, the following indicates a healthy pool.
 350          */
 351         ZPOOL_STATUS_OK
 352 } zpool_status_t;
 353
 354 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
 355 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
 356 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
 357
 358 /*
 359  * Statistics and configuration functions.
 360  */
 361 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
 362 extern nvlist_t *zpool_get_features(zpool_handle_t *);
 363 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
 364 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
 365 extern boolean_t zpool_is_bootable(zpool_handle_t *);
 366
 367 /*
 368  * Import and export functions
 369  */
 370 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
 371 extern int zpool_export_force(zpool_handle_t *, const char *);
 372 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
 373     char *altroot);
 374 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
 375     nvlist_t *, int);
 376 extern void zpool_print_unsup_feat(nvlist_t *config);
 377
 378 /*
 379  * Search for pools to import
 380  */
 381
 382 typedef struct importargs {
 383         char **path;            /* a list of paths to search            */
 384         int paths;              /* number of paths to search            */
 385         char *poolname;         /* name of a pool to find               */
 386         uint64_t guid;          /* guid of a pool to find               */
 387         char *cachefile;        /* cachefile to use for import          */
 388         int can_be_active : 1;  /* can the pool be active?              */
 389         int unique : 1;         /* does 'poolname' already exist?       */
 390         int exists : 1;         /* set on return if pool already exists */
 391 } importargs_t;
 392
 393 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
 394
 395 /* legacy pool search routines */
 396 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
 397 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
 398     char *, uint64_t);
 399
 400 /*
 401  * Miscellaneous pool functions
 402  */
 403 struct zfs_cmd;
 404
 405 extern const char *zfs_history_event_names[];
 406
 407 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
 408     boolean_t verbose);
 409 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
 410 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
 411 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
 412     nvlist_t ***, uint_t *);
 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 request, 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
 420 /*
 421  * Basic handle manipulations.  These functions do not create or destroy the
 422  * underlying datasets, only the references to them.
 423  */
 424 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
 425 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
 426 extern void zfs_close(zfs_handle_t *);
 427 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
 428 extern const char *zfs_get_name(const zfs_handle_t *);
 429 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
 430 extern const char *zfs_get_pool_name(const zfs_handle_t *);
 431
 432 /*
 433  * Property management functions.  Some functions are shared with the kernel,
 434  * and are found in sys/fs/zfs.h.
 435  */
 436
 437 /*
 438  * zfs dataset property management
 439  */
 440 extern const char *zfs_prop_default_string(zfs_prop_t);
 441 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
 442 extern const char *zfs_prop_column_name(zfs_prop_t);
 443 extern boolean_t zfs_prop_align_right(zfs_prop_t);
 444
 445 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
 446     nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
 447
 448 extern const char *zfs_prop_to_name(zfs_prop_t);
 449 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
 450 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
 451 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
 452     zprop_source_t *, char *, size_t, boolean_t);
 453 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
 454     boolean_t);
 455 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
 456     zprop_source_t *, char *, size_t);
 457 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
 458     uint64_t *propvalue);
 459 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
 460     char *propbuf, int proplen, boolean_t literal);
 461 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
 462     uint64_t *propvalue);
 463 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
 464     char *propbuf, int proplen, boolean_t literal);
 465 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
 466     char *buf, size_t len);
 467 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
 468 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
 469 extern const char *zfs_prop_values(zfs_prop_t);
 470 extern int zfs_prop_is_string(zfs_prop_t prop);
 471 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
 472 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
 473 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
 474
 475
 476 typedef struct zprop_list {
 477         int             pl_prop;
 478         char            *pl_user_prop;
 479         struct zprop_list *pl_next;
 480         boolean_t       pl_all;
 481         size_t          pl_width;
 482         size_t          pl_recvd_width;
 483         boolean_t       pl_fixed;
 484 } zprop_list_t;
 485
 486 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
 487     boolean_t);
 488 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
 489
 490 #define ZFS_MOUNTPOINT_NONE     "none"
 491 #define ZFS_MOUNTPOINT_LEGACY   "legacy"
 492
 493 #define ZFS_FEATURE_DISABLED    "disabled"
 494 #define ZFS_FEATURE_ENABLED     "enabled"
 495 #define ZFS_FEATURE_ACTIVE      "active"
 496
 497 #define ZFS_UNSUPPORTED_INACTIVE        "inactive"
 498 #define ZFS_UNSUPPORTED_READONLY        "readonly"
 499
 500 /*
 501  * zpool property management
 502  */
 503 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
 504 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
 505     size_t);
 506 extern const char *zpool_prop_default_string(zpool_prop_t);
 507 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
 508 extern const char *zpool_prop_column_name(zpool_prop_t);
 509 extern boolean_t zpool_prop_align_right(zpool_prop_t);
 510
 511 /*
 512  * Functions shared by zfs and zpool property management.
 513  */
 514 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
 515     boolean_t ordered, zfs_type_t type);
 516 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
 517     zfs_type_t);
 518 extern void zprop_free_list(zprop_list_t *);
 519
 520 #define ZFS_GET_NCOLS   5
 521
 522 typedef enum {
 523         GET_COL_NONE,
 524         GET_COL_NAME,
 525         GET_COL_PROPERTY,
 526         GET_COL_VALUE,
 527         GET_COL_RECVD,
 528         GET_COL_SOURCE
 529 } zfs_get_column_t;
 530
 531 /*
 532  * Functions for printing zfs or zpool properties
 533  */
 534 typedef struct zprop_get_cbdata {
 535         int cb_sources;
 536         zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
 537         int cb_colwidths[ZFS_GET_NCOLS + 1];
 538         boolean_t cb_scripted;
 539         boolean_t cb_literal;
 540         boolean_t cb_first;
 541         zprop_list_t *cb_proplist;
 542         zfs_type_t cb_type;
 543 } zprop_get_cbdata_t;
 544
 545 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
 546     const char *, const char *, zprop_source_t, const char *,
 547     const char *);
 548
 549 /*
 550  * Iterator functions.
 551  */
 552 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
 553 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
 554 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
 555 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 556 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
 557 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 558 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
 559 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
 560 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
 561
 562 typedef struct get_all_cb {
 563         zfs_handle_t    **cb_handles;
 564         size_t          cb_alloc;
 565         size_t          cb_used;
 566         boolean_t       cb_verbose;
 567         int             (*cb_getone)(zfs_handle_t *, void *);
 568 } get_all_cb_t;
 569
 570 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
 571 int libzfs_dataset_cmp(const void *, const void *);
 572
 573 /*
 574  * Functions to create and destroy datasets.
 575  */
 576 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
 577     nvlist_t *);
 578 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
 579 extern int zfs_destroy(zfs_handle_t *, boolean_t);
 580 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
 581 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
 582 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
 583 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
 584 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
 585     nvlist_t *props);
 586 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
 587
 588 typedef struct renameflags {
 589         /* recursive rename */
 590         int recurse : 1;
 591
 592         /* don't unmount file systems */
 593         int nounmount : 1;
 594
 595         /* force unmount file systems */
 596         int forceunmount : 1;
 597 } renameflags_t;
 598
 599 extern int zfs_rename(zfs_handle_t *, const char *, const char *,
 600     renameflags_t flags);
 601
 602 typedef struct sendflags {
 603         /* print informational messages (ie, -v was specified) */
 604         boolean_t verbose;
 605
 606         /* recursive send  (ie, -R) */
 607         boolean_t replicate;
 608
 609         /* for incrementals, do all intermediate snapshots */
 610         boolean_t doall;
 611
 612         /* if dataset is a clone, do incremental from its origin */
 613         boolean_t fromorigin;
 614
 615         /* do deduplication */
 616         boolean_t dedup;
 617
 618         /* send properties (ie, -p) */
 619         boolean_t props;
 620
 621         /* do not send (no-op, ie. -n) */
 622         boolean_t dryrun;
 623
 624         /* parsable verbose output (ie. -P) */
 625         boolean_t parsable;
 626
 627         /* show progress (ie. -v) */
 628         boolean_t progress;
 629
 630         /* large blocks (>128K) are permitted */
 631         boolean_t largeblock;
 632
 633         /* WRITE_EMBEDDED records of type DATA are permitted */
 634         boolean_t embed_data;
 635
 636         /* compressed WRITE records are permitted */
 637         boolean_t compress;
 638 } sendflags_t;
 639
 640 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
 641
 642 extern int zfs_send(zfs_handle_t *, const char *, const char *,
 643     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
 644 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
 645 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
 646     const char *);
 647 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
 648     const char *token);
 649
 650 extern int zfs_promote(zfs_handle_t *);
 651 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
 652     boolean_t, int);
 653 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
 654 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
 655 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
 656 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
 657
 658 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
 659     uid_t rid, uint64_t space);
 660
 661 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
 662     zfs_userspace_cb_t, void *);
 663
 664 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
 665 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
 666
 667 typedef struct recvflags {
 668         /* print informational messages (ie, -v was specified) */
 669         boolean_t verbose;
 670
 671         /* the destination is a prefix, not the exact fs (ie, -d) */
 672         boolean_t isprefix;
 673
 674         /*
 675          * Only the tail of the sent snapshot path is appended to the
 676          * destination to determine the received snapshot name (ie, -e).
 677          */
 678         boolean_t istail;
 679
 680         /* do not actually do the recv, just check if it would work (ie, -n) */
 681         boolean_t dryrun;
 682
 683         /* rollback/destroy filesystems as necessary (eg, -F) */
 684         boolean_t force;
 685
 686         /* set "canmount=off" on all modified filesystems */
 687         boolean_t canmountoff;
 688
 689         /*
 690          * Mark the file systems as "resumable" and do not destroy them if the
 691          * receive is interrupted
 692          */
 693         boolean_t resumable;
 694
 695         /* byteswap flag is used internally; callers need not specify */
 696         boolean_t byteswap;
 697
 698         /* do not mount file systems as they are extracted (private) */
 699         boolean_t nomount;
 700 } recvflags_t;
 701
 702 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
 703     recvflags_t *, int, avl_tree_t *);
 704
 705 typedef enum diff_flags {
 706         ZFS_DIFF_PARSEABLE = 0x1,
 707         ZFS_DIFF_TIMESTAMP = 0x2,
 708         ZFS_DIFF_CLASSIFY = 0x4
 709 } diff_flags_t;
 710
 711 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
 712     int);
 713
 714 /*
 715  * Miscellaneous functions.
 716  */
 717 extern const char *zfs_type_to_name(zfs_type_t);
 718 extern void zfs_refresh_properties(zfs_handle_t *);
 719 extern int zfs_name_valid(const char *, zfs_type_t);
 720 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
 721 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
 722     zfs_type_t);
 723 extern int zfs_spa_version(zfs_handle_t *, int *);
 724 extern boolean_t zfs_bookmark_exists(const char *path);
 725
 726 /*
 727  * Mount support functions.
 728  */
 729 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
 730 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
 731 extern int zfs_mount(zfs_handle_t *, const char *, int);
 732 extern int zfs_unmount(zfs_handle_t *, const char *, int);
 733 extern int zfs_unmountall(zfs_handle_t *, int);
 734
 735 /*
 736  * Share support functions.
 737  */
 738 extern boolean_t zfs_is_shared(zfs_handle_t *);
 739 extern int zfs_share(zfs_handle_t *);
 740 extern int zfs_unshare(zfs_handle_t *);
 741
 742 /*
 743  * Protocol-specific share support functions.
 744  */
 745 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
 746 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
 747 extern int zfs_share_nfs(zfs_handle_t *);
 748 extern int zfs_share_smb(zfs_handle_t *);
 749 extern int zfs_shareall(zfs_handle_t *);
 750 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
 751 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
 752 extern int zfs_unshareall_nfs(zfs_handle_t *);
 753 extern int zfs_unshareall_smb(zfs_handle_t *);
 754 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
 755 extern int zfs_unshareall(zfs_handle_t *);
 756 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
 757     void *, void *, int, zfs_share_op_t);
 758
 759 /*
 760  * FreeBSD-specific jail support function.
 761  */
 762 extern int zfs_jail(zfs_handle_t *, int, int);
 763
 764 /*
 765  * When dealing with nvlists, verify() is extremely useful
 766  */
 767 #ifndef verify
 768 #ifdef NDEBUG
 769 #define verify(EX)      ((void)(EX))
 770 #else
 771 #define verify(EX)      assert(EX)
 772 #endif
 773 #endif
 774
 775 /*
 776  * Utility function to convert a number to a human-readable form.
 777  */
 778 extern void zfs_nicenum(uint64_t, char *, size_t);
 779 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
 780
 781 /*
 782  * Given a device or file, determine if it is part of a pool.
 783  */
 784 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
 785     boolean_t *);
 786
 787 /*
 788  * Label manipulation.
 789  */
 790 extern int zpool_read_label(int, nvlist_t **);
 791 extern int zpool_read_all_labels(int, nvlist_t **);
 792 extern int zpool_clear_label(int);
 793
 794 /* is this zvol valid for use as a dump device? */
 795 extern int zvol_check_dump_config(char *);
 796
 797 /*
 798  * Management interfaces for SMB ACL files
 799  */
 800
 801 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
 802 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
 803 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
 804 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
 805
 806 /*
 807  * Enable and disable datasets within a pool by mounting/unmounting and
 808  * sharing/unsharing them.
 809  */
 810 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
 811 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
 812
 813 /*
 814  * Mappings between vdev and FRU.
 815  */
 816 extern void libzfs_fru_refresh(libzfs_handle_t *);
 817 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
 818 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
 819 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
 820     const char *);
 821 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
 822 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
 823
 824 #ifndef illumos
 825 extern int zmount(const char *, const char *, int, char *, char *, int, char *,
 826     int);
 827 #endif
 828
 829 #ifdef  __cplusplus
 830 }
 831 #endif
 832
 833 #endif  /* _LIBZFS_H */