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