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