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