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