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