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