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