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