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