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