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