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 (c) 2011, 2017 by Delphix. All rights reserved.
  25  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
  26  * Copyright (c) 2013 Steven Hartland. All rights reserved.
  27  * Copyright (c) 2016, Intel Corporation.
  28  * Copyright 2016 Nexenta Systems, Inc.
  29  * Copyright (c) 2017 Datto Inc.
  30  * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
  31  */
  32
  33 #ifndef _LIBZFS_H
  34 #define _LIBZFS_H
  35
  36 #include <assert.h>
  37 #include <libnvpair.h>
  38 #include <sys/mnttab.h>
  39 #include <sys/param.h>
  40 #include <sys/types.h>
  41 #include <sys/varargs.h>
  42 #include <sys/fs/zfs.h>
  43 #include <sys/avl.h>
  44 #include <ucred.h>
  45 #include <libzfs_core.h>
  46
  47 #ifdef  __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 /*
  52  * Miscellaneous ZFS constants
  53  */
  54 #define ZFS_MAXPROPLEN          MAXPATHLEN
  55 #define ZPOOL_MAXPROPLEN        MAXPATHLEN
  56
  57 /*
  58  * Default device paths
  59  */
  60 #define DISK_ROOT               "/dev"
  61 #define UDISK_ROOT              "/dev/disk"
  62 #define ZVOL_ROOT               "/dev/zvol"
  63
  64 /*
  65  * Default wait time for a device name to be created.
  66  */
  67 #define DISK_LABEL_WAIT         (30 * 1000)  /* 30 seconds */
  68
  69 #define IMPORT_ORDER_PREFERRED_1        1
  70 #define IMPORT_ORDER_PREFERRED_2        2
  71 #define IMPORT_ORDER_SCAN_OFFSET        10
  72 #define IMPORT_ORDER_DEFAULT            100
  73 #define DEFAULT_IMPORT_PATH_SIZE        9
  74 extern char *zpool_default_import_path[DEFAULT_IMPORT_PATH_SIZE];
  75
  76 /*
  77  * libzfs errors
  78  */
  79 typedef enum zfs_error {
  80         EZFS_SUCCESS = 0,       /* no error -- success */
  81         EZFS_NOMEM = 2000,      /* out of memory */
  82         EZFS_BADPROP,           /* invalid property value */
  83         EZFS_PROPREADONLY,      /* cannot set readonly property */
  84         EZFS_PROPTYPE,          /* property does not apply to dataset type */
  85         EZFS_PROPNONINHERIT,    /* property is not inheritable */
  86         EZFS_PROPSPACE,         /* bad quota or reservation */
  87         EZFS_BADTYPE,           /* dataset is not of appropriate type */
  88         EZFS_BUSY,              /* pool or dataset is busy */
  89         EZFS_EXISTS,            /* pool or dataset already exists */
  90         EZFS_NOENT,             /* no such pool or dataset */
  91         EZFS_BADSTREAM,         /* bad backup stream */
  92         EZFS_DSREADONLY,        /* dataset is readonly */
  93         EZFS_VOLTOOBIG,         /* volume is too large for 32-bit system */
  94         EZFS_INVALIDNAME,       /* invalid dataset name */
  95         EZFS_BADRESTORE,        /* unable to restore to destination */
  96         EZFS_BADBACKUP,         /* backup failed */
  97         EZFS_BADTARGET,         /* bad attach/detach/replace target */
  98         EZFS_NODEVICE,          /* no such device in pool */
  99         EZFS_BADDEV,            /* invalid device to add */
 100         EZFS_NOREPLICAS,        /* no valid replicas */
 101         EZFS_RESILVERING,       /* currently resilvering */
 102         EZFS_BADVERSION,        /* unsupported version */
 103         EZFS_POOLUNAVAIL,       /* pool is currently unavailable */
 104         EZFS_DEVOVERFLOW,       /* too many devices in one vdev */
 105         EZFS_BADPATH,           /* must be an absolute path */
 106         EZFS_CROSSTARGET,       /* rename or clone across pool or dataset */
 107         EZFS_ZONED,             /* used improperly in local zone */
 108         EZFS_MOUNTFAILED,       /* failed to mount dataset */
 109         EZFS_UMOUNTFAILED,      /* failed to unmount dataset */
 110         EZFS_UNSHARENFSFAILED,  /* unshare(1M) failed */
 111         EZFS_SHARENFSFAILED,    /* share(1M) failed */
 112         EZFS_PERM,              /* permission denied */
 113         EZFS_NOSPC,             /* out of space */
 114         EZFS_FAULT,             /* bad address */
 115         EZFS_IO,                /* I/O error */
 116         EZFS_INTR,              /* signal received */
 117         EZFS_ISSPARE,           /* device is a hot spare */
 118         EZFS_INVALCONFIG,       /* invalid vdev configuration */
 119         EZFS_RECURSIVE,         /* recursive dependency */
 120         EZFS_NOHISTORY,         /* no history object */
 121         EZFS_POOLPROPS,         /* couldn't retrieve pool props */
 122         EZFS_POOL_NOTSUP,       /* ops not supported for this type of pool */
 123         EZFS_POOL_INVALARG,     /* invalid argument for this pool operation */
 124         EZFS_NAMETOOLONG,       /* dataset name is too long */
 125         EZFS_OPENFAILED,        /* open of device failed */
 126         EZFS_NOCAP,             /* couldn't get capacity */
 127         EZFS_LABELFAILED,       /* write of label failed */
 128         EZFS_BADWHO,            /* invalid permission who */
 129         EZFS_BADPERM,           /* invalid permission */
 130         EZFS_BADPERMSET,        /* invalid permission set name */
 131         EZFS_NODELEGATION,      /* delegated administration is disabled */
 132         EZFS_UNSHARESMBFAILED,  /* failed to unshare over smb */
 133         EZFS_SHARESMBFAILED,    /* failed to share over smb */
 134         EZFS_BADCACHE,          /* bad cache file */
 135         EZFS_ISL2CACHE,         /* device is for the level 2 ARC */
 136         EZFS_VDEVNOTSUP,        /* unsupported vdev type */
 137         EZFS_NOTSUP,            /* ops not supported on this dataset */
 138         EZFS_ACTIVE_SPARE,      /* pool has active shared spare devices */
 139         EZFS_UNPLAYED_LOGS,     /* log device has unplayed logs */
 140         EZFS_REFTAG_RELE,       /* snapshot release: tag not found */
 141         EZFS_REFTAG_HOLD,       /* snapshot hold: tag already exists */
 142         EZFS_TAGTOOLONG,        /* snapshot hold/rele: tag too long */
 143         EZFS_PIPEFAILED,        /* pipe create failed */
 144         EZFS_THREADCREATEFAILED, /* thread create failed */
 145         EZFS_POSTSPLIT_ONLINE,  /* onlining a disk after splitting it */
 146         EZFS_SCRUBBING,         /* currently scrubbing */
 147         EZFS_NO_SCRUB,          /* no active scrub */
 148         EZFS_DIFF,              /* general failure of zfs diff */
 149         EZFS_DIFFDATA,          /* bad zfs diff data */
 150         EZFS_POOLREADONLY,      /* pool is in read-only mode */
 151         EZFS_SCRUB_PAUSED,      /* scrub currently paused */
 152         EZFS_ACTIVE_POOL,       /* pool is imported on a different system */
 153         EZFS_CRYPTOFAILED,      /* failed to setup encryption */
 154         EZFS_NO_PENDING,        /* cannot cancel, no operation is pending */
 155         EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */
 156         EZFS_DISCARDING_CHECKPOINT,     /* currently discarding a checkpoint */
 157         EZFS_NO_CHECKPOINT,     /* pool has no checkpoint */
 158         EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */
 159         EZFS_VDEV_TOO_BIG,      /* a device is too big to be used */
 160         EZFS_UNKNOWN
 161 } zfs_error_t;
 162
 163 /*
 164  * The following data structures are all part
 165  * of the zfs_allow_t data structure which is
 166  * used for printing 'allow' permissions.
 167  * It is a linked list of zfs_allow_t's which
 168  * then contain avl tree's for user/group/sets/...
 169  * and each one of the entries in those trees have
 170  * avl tree's for the permissions they belong to and
 171  * whether they are local,descendent or local+descendent
 172  * permissions.  The AVL trees are used primarily for
 173  * sorting purposes, but also so that we can quickly find
 174  * a given user and or permission.
 175  */
 176 typedef struct zfs_perm_node {
 177         avl_node_t z_node;
 178         char z_pname[MAXPATHLEN];
 179 } zfs_perm_node_t;
 180
 181 typedef struct zfs_allow_node {
 182         avl_node_t z_node;
 183         char z_key[MAXPATHLEN];         /* name, such as joe */
 184         avl_tree_t z_localdescend;      /* local+descendent perms */
 185         avl_tree_t z_local;             /* local permissions */
 186         avl_tree_t z_descend;           /* descendent permissions */
 187 } zfs_allow_node_t;
 188
 189 typedef struct zfs_allow {
 190         struct zfs_allow *z_next;
 191         char z_setpoint[MAXPATHLEN];
 192         avl_tree_t z_sets;
 193         avl_tree_t z_crperms;
 194         avl_tree_t z_user;
 195         avl_tree_t z_group;
 196         avl_tree_t z_everyone;
 197 } zfs_allow_t;
 198
 199 /*
 200  * Basic handle types
 201  */
 202 typedef struct zfs_handle zfs_handle_t;
 203 typedef struct zpool_handle zpool_handle_t;
 204 typedef struct libzfs_handle libzfs_handle_t;
 205
 206 /*
 207  * Library initialization
 208  */
 209 extern libzfs_handle_t *libzfs_init(void);
 210 extern void libzfs_fini(libzfs_handle_t *);
 211
 212 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
 213 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
 214
 215 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
 216
 217 extern void zfs_save_arguments(int argc, char **, char *, int);
 218 extern int zpool_log_history(libzfs_handle_t *, const char *);
 219
 220 extern int libzfs_errno(libzfs_handle_t *);
 221 extern const char *libzfs_error_init(int);
 222 extern const char *libzfs_error_action(libzfs_handle_t *);
 223 extern const char *libzfs_error_description(libzfs_handle_t *);
 224 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
 225 extern void libzfs_mnttab_init(libzfs_handle_t *);
 226 extern void libzfs_mnttab_fini(libzfs_handle_t *);
 227 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
 228 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
 229     struct mnttab *);
 230 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
 231     const char *, const char *);
 232 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
 233
 234 /*
 235  * Basic handle functions
 236  */
 237 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
 238 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
 239 extern void zpool_close(zpool_handle_t *);
 240 extern const char *zpool_get_name(zpool_handle_t *);
 241 extern int zpool_get_state(zpool_handle_t *);
 242 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
 243 extern const char *zpool_pool_state_to_name(pool_state_t);
 244 extern void zpool_free_handles(libzfs_handle_t *);
 245
 246 /*
 247  * Iterate over all active pools in the system.
 248  */
 249 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
 250 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
 251 extern boolean_t zpool_skip_pool(const char *);
 252
 253 /*
 254  * Functions to create and destroy pools
 255  */
 256 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
 257     nvlist_t *, nvlist_t *);
 258 extern int zpool_destroy(zpool_handle_t *, const char *);
 259 extern int zpool_add(zpool_handle_t *, nvlist_t *);
 260
 261 typedef struct splitflags {
 262         /* do not split, but return the config that would be split off */
 263         int dryrun : 1;
 264
 265         /* after splitting, import the pool */
 266         int import : 1;
 267         int name_flags;
 268 } splitflags_t;
 269
 270 /*
 271  * Functions to manipulate pool and vdev state
 272  */
 273 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
 274 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
 275 extern int zpool_reguid(zpool_handle_t *);
 276 extern int zpool_reopen_one(zpool_handle_t *, void *);
 277
 278 extern int zpool_sync_one(zpool_handle_t *, void *);
 279
 280 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
 281     vdev_state_t *);
 282 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
 283 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
 284     const char *, nvlist_t *, int);
 285 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
 286 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
 287 extern int zpool_vdev_remove_cancel(zpool_handle_t *);
 288 extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *);
 289 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
 290     splitflags_t);
 291
 292 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
 293 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
 294 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
 295
 296 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
 297     boolean_t *, boolean_t *);
 298 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
 299     boolean_t *, boolean_t *, boolean_t *);
 300 extern int zpool_label_disk_wait(char *, int);
 301 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
 302 extern uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, const char *path);
 303
 304 int zfs_dev_is_dm(char *dev_name);
 305 int zfs_dev_is_whole_disk(char *dev_name);
 306 char *zfs_get_underlying_path(char *dev_name);
 307 char *zfs_get_enclosure_sysfs_path(char *dev_name);
 308
 309 const char *zpool_get_state_str(zpool_handle_t *);
 310
 311 /*
 312  * Functions to manage pool properties
 313  */
 314 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
 315 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
 316     size_t proplen, zprop_source_t *, boolean_t literal);
 317 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
 318     zprop_source_t *);
 319
 320 extern const char *zpool_prop_to_name(zpool_prop_t);
 321 extern const char *zpool_prop_values(zpool_prop_t);
 322
 323 /*
 324  * Pool health statistics.
 325  */
 326 typedef enum {
 327         /*
 328          * The following correspond to faults as defined in the (fault.fs.zfs.*)
 329          * event namespace.  Each is associated with a corresponding message ID.
 330          */
 331         ZPOOL_STATUS_CORRUPT_CACHE,     /* corrupt /kernel/drv/zpool.cache */
 332         ZPOOL_STATUS_MISSING_DEV_R,     /* missing device with replicas */
 333         ZPOOL_STATUS_MISSING_DEV_NR,    /* missing device with no replicas */
 334         ZPOOL_STATUS_CORRUPT_LABEL_R,   /* bad device label with replicas */
 335         ZPOOL_STATUS_CORRUPT_LABEL_NR,  /* bad device label with no replicas */
 336         ZPOOL_STATUS_BAD_GUID_SUM,      /* sum of device guids didn't match */
 337         ZPOOL_STATUS_CORRUPT_POOL,      /* pool metadata is corrupted */
 338         ZPOOL_STATUS_CORRUPT_DATA,      /* data errors in user (meta)data */
 339         ZPOOL_STATUS_FAILING_DEV,       /* device experiencing errors */
 340         ZPOOL_STATUS_VERSION_NEWER,     /* newer on-disk version */
 341         ZPOOL_STATUS_HOSTID_MISMATCH,   /* last accessed by another system */
 342         ZPOOL_STATUS_HOSTID_ACTIVE,     /* currently active on another system */
 343         ZPOOL_STATUS_HOSTID_REQUIRED,   /* multihost=on and hostid=0 */
 344         ZPOOL_STATUS_IO_FAILURE_WAIT,   /* failed I/O, failmode 'wait' */
 345         ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
 346         ZPOOL_STATUS_IO_FAILURE_MMP,    /* failed MMP, failmode not 'panic' */
 347         ZPOOL_STATUS_BAD_LOG,           /* cannot read log chain(s) */
 348         ZPOOL_STATUS_ERRATA,            /* informational errata available */
 349
 350         /*
 351          * If the pool has unsupported features but can still be opened in
 352          * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
 353          * pool has unsupported features but cannot be opened at all, its
 354          * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
 355          */
 356         ZPOOL_STATUS_UNSUP_FEAT_READ,   /* unsupported features for read */
 357         ZPOOL_STATUS_UNSUP_FEAT_WRITE,  /* unsupported features for write */
 358
 359         /*
 360          * These faults have no corresponding message ID.  At the time we are
 361          * checking the status, the original reason for the FMA fault (I/O or
 362          * checksum errors) has been lost.
 363          */
 364         ZPOOL_STATUS_FAULTED_DEV_R,     /* faulted device with replicas */
 365         ZPOOL_STATUS_FAULTED_DEV_NR,    /* faulted device with no replicas */
 366
 367         /*
 368          * The following are not faults per se, but still an error possibly
 369          * requiring administrative attention.  There is no corresponding
 370          * message ID.
 371          */
 372         ZPOOL_STATUS_VERSION_OLDER,     /* older legacy on-disk version */
 373         ZPOOL_STATUS_FEAT_DISABLED,     /* supported features are disabled */
 374         ZPOOL_STATUS_RESILVERING,       /* device being resilvered */
 375         ZPOOL_STATUS_OFFLINE_DEV,       /* device offline */
 376         ZPOOL_STATUS_REMOVED_DEV,       /* removed device */
 377
 378         /*
 379          * Finally, the following indicates a healthy pool.
 380          */
 381         ZPOOL_STATUS_OK
 382 } zpool_status_t;
 383
 384 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **,
 385     zpool_errata_t *);
 386 extern zpool_status_t zpool_import_status(nvlist_t *, char **,
 387     zpool_errata_t *);
 388 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
 389
 390 /*
 391  * Statistics and configuration functions.
 392  */
 393 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
 394 extern nvlist_t *zpool_get_features(zpool_handle_t *);
 395 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
 396 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
 397
 398 /*
 399  * Import and export functions
 400  */
 401 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
 402 extern int zpool_export_force(zpool_handle_t *, const char *);
 403 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
 404     char *altroot);
 405 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
 406     nvlist_t *, int);
 407 extern void zpool_print_unsup_feat(nvlist_t *config);
 408
 409 /*
 410  * Search for pools to import
 411  */
 412
 413 typedef struct importargs {
 414         char **path;            /* a list of paths to search            */
 415         int paths;              /* number of paths to search            */
 416         char *poolname;         /* name of a pool to find               */
 417         uint64_t guid;          /* guid of a pool to find               */
 418         char *cachefile;        /* cachefile to use for import          */
 419         int can_be_active : 1;  /* can the pool be active?              */
 420         int unique : 1;         /* does 'poolname' already exist?       */
 421         int exists : 1;         /* set on return if pool already exists */
 422         int scan : 1;           /* prefer scanning to libblkid cache    */
 423         nvlist_t *policy;       /* load policy (max txg, rewind, etc.)  */
 424 } importargs_t;
 425
 426 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
 427 extern int zpool_tryimport(libzfs_handle_t *hdl, char *target,
 428     nvlist_t **configp, importargs_t *args);
 429
 430 /* legacy pool search routines */
 431 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
 432 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
 433     char *, uint64_t);
 434
 435 /*
 436  * Miscellaneous pool functions
 437  */
 438 struct zfs_cmd;
 439
 440 extern const char *zfs_history_event_names[];
 441
 442 typedef enum {
 443         VDEV_NAME_PATH          = 1 << 0,
 444         VDEV_NAME_GUID          = 1 << 1,
 445         VDEV_NAME_FOLLOW_LINKS  = 1 << 2,
 446         VDEV_NAME_TYPE_ID       = 1 << 3,
 447 } vdev_name_t;
 448
 449 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
 450     int name_flags);
 451 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
 452 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
 453 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
 454     nvlist_t ***, uint_t *);
 455 extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned,
 456     int);
 457 extern int zpool_events_clear(libzfs_handle_t *, int *);
 458 extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int);
 459 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
 460     size_t len);
 461 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
 462 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
 463 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
 464     nvlist_t *);
 465 extern int zpool_checkpoint(zpool_handle_t *);
 466 extern int zpool_discard_checkpoint(zpool_handle_t *);
 467
 468 /*
 469  * Basic handle manipulations.  These functions do not create or destroy the
 470  * underlying datasets, only the references to them.
 471  */
 472 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
 473 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
 474 extern void zfs_close(zfs_handle_t *);
 475 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
 476 extern const char *zfs_get_name(const zfs_handle_t *);
 477 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
 478 extern const char *zfs_get_pool_name(const zfs_handle_t *);
 479
 480 /*
 481  * Property management functions.  Some functions are shared with the kernel,
 482  * and are found in sys/fs/zfs.h.
 483  */
 484
 485 /*
 486  * zfs dataset property management
 487  */
 488 extern const char *zfs_prop_default_string(zfs_prop_t);
 489 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
 490 extern const char *zfs_prop_column_name(zfs_prop_t);
 491 extern boolean_t zfs_prop_align_right(zfs_prop_t);
 492
 493 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *,
 494     uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *);
 495
 496 extern const char *zfs_prop_to_name(zfs_prop_t);
 497 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
 498 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
 499 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
 500     zprop_source_t *, char *, size_t, boolean_t);
 501 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
 502     boolean_t);
 503 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
 504     zprop_source_t *, char *, size_t);
 505 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
 506     uint64_t *propvalue);
 507 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
 508     char *propbuf, int proplen, boolean_t literal);
 509 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
 510     uint64_t *propvalue);
 511 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
 512     char *propbuf, int proplen, boolean_t literal);
 513 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
 514     char *buf, size_t len);
 515 extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **);
 516 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
 517 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
 518 extern const char *zfs_prop_values(zfs_prop_t);
 519 extern int zfs_prop_is_string(zfs_prop_t prop);
 520 extern nvlist_t *zfs_get_all_props(zfs_handle_t *);
 521 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
 522 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
 523 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
 524
 525 /*
 526  * zfs encryption management
 527  */
 528 extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *);
 529 extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *,
 530     boolean_t stdin_available, uint8_t **, uint_t *);
 531 extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *,
 532     nvlist_t *);
 533 extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *);
 534 extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *);
 535 extern int zfs_crypto_unload_key(zfs_handle_t *);
 536 extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t);
 537
 538 typedef struct zprop_list {
 539         int             pl_prop;
 540         char            *pl_user_prop;
 541         struct zprop_list *pl_next;
 542         boolean_t       pl_all;
 543         size_t          pl_width;
 544         size_t          pl_recvd_width;
 545         boolean_t       pl_fixed;
 546 } zprop_list_t;
 547
 548 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
 549     boolean_t);
 550 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
 551
 552 #define ZFS_MOUNTPOINT_NONE     "none"
 553 #define ZFS_MOUNTPOINT_LEGACY   "legacy"
 554
 555 #define ZFS_FEATURE_DISABLED    "disabled"
 556 #define ZFS_FEATURE_ENABLED     "enabled"
 557 #define ZFS_FEATURE_ACTIVE      "active"
 558
 559 #define ZFS_UNSUPPORTED_INACTIVE        "inactive"
 560 #define ZFS_UNSUPPORTED_READONLY        "readonly"
 561
 562 /*
 563  * zpool property management
 564  */
 565 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
 566 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
 567     size_t);
 568 extern const char *zpool_prop_default_string(zpool_prop_t);
 569 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
 570 extern const char *zpool_prop_column_name(zpool_prop_t);
 571 extern boolean_t zpool_prop_align_right(zpool_prop_t);
 572
 573 /*
 574  * Functions shared by zfs and zpool property management.
 575  */
 576 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
 577     boolean_t ordered, zfs_type_t type);
 578 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
 579     zfs_type_t);
 580 extern void zprop_free_list(zprop_list_t *);
 581
 582 #define ZFS_GET_NCOLS   5
 583
 584 typedef enum {
 585         GET_COL_NONE,
 586         GET_COL_NAME,
 587         GET_COL_PROPERTY,
 588         GET_COL_VALUE,
 589         GET_COL_RECVD,
 590         GET_COL_SOURCE
 591 } zfs_get_column_t;
 592
 593 /*
 594  * Functions for printing zfs or zpool properties
 595  */
 596 typedef struct zprop_get_cbdata {
 597         int cb_sources;
 598         zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
 599         int cb_colwidths[ZFS_GET_NCOLS + 1];
 600         boolean_t cb_scripted;
 601         boolean_t cb_literal;
 602         boolean_t cb_first;
 603         zprop_list_t *cb_proplist;
 604         zfs_type_t cb_type;
 605 } zprop_get_cbdata_t;
 606
 607 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
 608     const char *, const char *, zprop_source_t, const char *,
 609     const char *);
 610
 611 /*
 612  * Iterator functions.
 613  */
 614 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
 615 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
 616 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
 617 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 618 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
 619 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 620 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
 621 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
 622 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
 623
 624 typedef struct get_all_cb {
 625         zfs_handle_t    **cb_handles;
 626         size_t          cb_alloc;
 627         size_t          cb_used;
 628         boolean_t       cb_verbose;
 629         int             (*cb_getone)(zfs_handle_t *, void *);
 630 } get_all_cb_t;
 631
 632 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
 633 int libzfs_dataset_cmp(const void *, const void *);
 634
 635 /*
 636  * Functions to create and destroy datasets.
 637  */
 638 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
 639     nvlist_t *);
 640 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
 641 extern int zfs_destroy(zfs_handle_t *, boolean_t);
 642 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
 643 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
 644 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
 645 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
 646 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
 647     nvlist_t *props);
 648 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
 649 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
 650
 651 typedef struct sendflags {
 652         /* print informational messages (ie, -v was specified) */
 653         boolean_t verbose;
 654
 655         /* recursive send  (ie, -R) */
 656         boolean_t replicate;
 657
 658         /* for incrementals, do all intermediate snapshots */
 659         boolean_t doall;
 660
 661         /* if dataset is a clone, do incremental from its origin */
 662         boolean_t fromorigin;
 663
 664         /* do deduplication */
 665         boolean_t dedup;
 666
 667         /* send properties (ie, -p) */
 668         boolean_t props;
 669
 670         /* do not send (no-op, ie. -n) */
 671         boolean_t dryrun;
 672
 673         /* parsable verbose output (ie. -P) */
 674         boolean_t parsable;
 675
 676         /* show progress (ie. -v) */
 677         boolean_t progress;
 678
 679         /* large blocks (>128K) are permitted */
 680         boolean_t largeblock;
 681
 682         /* WRITE_EMBEDDED records of type DATA are permitted */
 683         boolean_t embed_data;
 684
 685         /* compressed WRITE records are permitted */
 686         boolean_t compress;
 687
 688         /* raw encrypted records are permitted */
 689         boolean_t raw;
 690
 691         /* only send received properties (ie. -b) */
 692         boolean_t backup;
 693 } sendflags_t;
 694
 695 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
 696
 697 extern int zfs_send(zfs_handle_t *, const char *, const char *,
 698     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
 699 extern int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t flags);
 700 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
 701     const char *);
 702 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
 703     const char *token);
 704
 705 extern int zfs_promote(zfs_handle_t *);
 706 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
 707     boolean_t, int);
 708 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
 709 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
 710 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
 711 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
 712
 713 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
 714     uid_t rid, uint64_t space);
 715
 716 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
 717     zfs_userspace_cb_t, void *);
 718
 719 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
 720 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
 721
 722 typedef struct recvflags {
 723         /* print informational messages (ie, -v was specified) */
 724         boolean_t verbose;
 725
 726         /* the destination is a prefix, not the exact fs (ie, -d) */
 727         boolean_t isprefix;
 728
 729         /*
 730          * Only the tail of the sent snapshot path is appended to the
 731          * destination to determine the received snapshot name (ie, -e).
 732          */
 733         boolean_t istail;
 734
 735         /* do not actually do the recv, just check if it would work (ie, -n) */
 736         boolean_t dryrun;
 737
 738         /* rollback/destroy filesystems as necessary (eg, -F) */
 739         boolean_t force;
 740
 741         /* set "canmount=off" on all modified filesystems */
 742         boolean_t canmountoff;
 743
 744         /*
 745          * Mark the file systems as "resumable" and do not destroy them if the
 746          * receive is interrupted
 747          */
 748         boolean_t resumable;
 749
 750         /* byteswap flag is used internally; callers need not specify */
 751         boolean_t byteswap;
 752
 753         /* do not mount file systems as they are extracted (private) */
 754         boolean_t nomount;
 755 } recvflags_t;
 756
 757 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
 758     recvflags_t *, int, avl_tree_t *);
 759
 760 typedef enum diff_flags {
 761         ZFS_DIFF_PARSEABLE = 0x1,
 762         ZFS_DIFF_TIMESTAMP = 0x2,
 763         ZFS_DIFF_CLASSIFY = 0x4
 764 } diff_flags_t;
 765
 766 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
 767     int);
 768
 769 /*
 770  * Miscellaneous functions.
 771  */
 772 extern const char *zfs_type_to_name(zfs_type_t);
 773 extern void zfs_refresh_properties(zfs_handle_t *);
 774 extern int zfs_name_valid(const char *, zfs_type_t);
 775 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
 776 extern int zfs_parent_name(zfs_handle_t *, char *, size_t);
 777 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
 778     zfs_type_t);
 779 extern int zfs_spa_version(zfs_handle_t *, int *);
 780 extern boolean_t zfs_bookmark_exists(const char *path);
 781 extern int zfs_append_partition(char *path, size_t max_len);
 782 extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen);
 783 extern int zfs_strcmp_pathname(char *name, char *cmp_name, int wholedisk);
 784 extern int zfs_path_order(char *path, int *order);
 785
 786 /*
 787  * Mount support functions.
 788  */
 789 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
 790 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
 791 extern int zfs_mount(zfs_handle_t *, const char *, int);
 792 extern int zfs_unmount(zfs_handle_t *, const char *, int);
 793 extern int zfs_unmountall(zfs_handle_t *, int);
 794
 795 /*
 796  * Share support functions.
 797  */
 798 extern boolean_t zfs_is_shared(zfs_handle_t *);
 799 extern int zfs_share(zfs_handle_t *);
 800 extern int zfs_unshare(zfs_handle_t *);
 801
 802 /*
 803  * Protocol-specific share support functions.
 804  */
 805 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
 806 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
 807 extern int zfs_share_nfs(zfs_handle_t *);
 808 extern int zfs_share_smb(zfs_handle_t *);
 809 extern int zfs_shareall(zfs_handle_t *);
 810 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
 811 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
 812 extern int zfs_unshareall_nfs(zfs_handle_t *);
 813 extern int zfs_unshareall_smb(zfs_handle_t *);
 814 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
 815 extern int zfs_unshareall_bytype(zfs_handle_t *, const char *, const char *);
 816 extern int zfs_unshareall(zfs_handle_t *);
 817 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
 818     void *, void *, int, zfs_share_op_t);
 819
 820 /*
 821  * Formats for iostat numbers.  Examples: "12K", "30ms", "4B", "2321234", "-".
 822  *
 823  * ZFS_NICENUM_1024:    Print kilo, mega, tera, peta, exa..
 824  * ZFS_NICENUM_BYTES:   Print single bytes ("13B"), kilo, mega, tera...
 825  * ZFS_NICENUM_TIME:    Print nanosecs, microsecs, millisecs, seconds...
 826  * ZFS_NICENUM_RAW:     Print the raw number without any formatting
 827  * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero.
 828  */
 829 enum zfs_nicenum_format {
 830         ZFS_NICENUM_1024 = 0,
 831         ZFS_NICENUM_BYTES = 1,
 832         ZFS_NICENUM_TIME = 2,
 833         ZFS_NICENUM_RAW = 3,
 834         ZFS_NICENUM_RAWTIME = 4
 835 };
 836
 837 /*
 838  * Utility function to convert a number to a human-readable form.
 839  */
 840 extern void zfs_nicenum(uint64_t, char *, size_t);
 841 extern void zfs_nicenum_format(uint64_t num, char *buf, size_t buflen,
 842     enum zfs_nicenum_format type);
 843
 844
 845 extern void zfs_nicetime(uint64_t, char *, size_t);
 846 extern void zfs_nicebytes(uint64_t, char *, size_t);
 847 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
 848
 849 /*
 850  * Utility functions to run an external process.
 851  */
 852 #define STDOUT_VERBOSE  0x01
 853 #define STDERR_VERBOSE  0x02
 854 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */
 855
 856 int libzfs_run_process(const char *, char **, int flags);
 857 int libzfs_run_process_get_stdout(const char *path, char *argv[], char *env[],
 858     char **lines[], int *lines_cnt);
 859 int libzfs_run_process_get_stdout_nopath(const char *path, char *argv[],
 860     char *env[], char **lines[], int *lines_cnt);
 861
 862 void libzfs_free_str_array(char **strs, int count);
 863
 864 int libzfs_envvar_is_set(char *envvar);
 865
 866 /*
 867  * Given a device or file, determine if it is part of a pool.
 868  */
 869 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
 870     boolean_t *);
 871
 872 /*
 873  * Label manipulation.
 874  */
 875 extern int zpool_read_label(int, nvlist_t **, int *);
 876 extern int zpool_clear_label(int);
 877
 878 /*
 879  * Management interfaces for SMB ACL files
 880  */
 881
 882 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
 883 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
 884 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
 885 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
 886
 887 /*
 888  * Enable and disable datasets within a pool by mounting/unmounting and
 889  * sharing/unsharing them.
 890  */
 891 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
 892 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
 893
 894 /*
 895  * Support for Linux libudev derived persistent device strings
 896  */
 897 extern boolean_t is_mpath_whole_disk(const char *);
 898 extern void update_vdev_config_dev_strs(nvlist_t *);
 899 extern char *zfs_strip_partition(char *);
 900 extern char *zfs_strip_partition_path(char *);
 901
 902 #ifdef HAVE_LIBUDEV
 903 struct udev_device;
 904
 905 extern boolean_t udev_is_mpath(struct udev_device *dev);
 906 extern int zfs_device_get_devid(struct udev_device *, char *, size_t);
 907 extern int zfs_device_get_physical(struct udev_device *, char *, size_t);
 908 #endif
 909
 910 extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *);
 911
 912 #ifdef  __cplusplus
 913 }
 914 #endif
 915
 916 #endif  /* _LIBZFS_H */