granicus.if.org Git - zfs/blob - 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) 2013 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  */
  29
  30 #ifndef _LIBZFS_H
  31 #define _LIBZFS_H
  32
  33 #include <assert.h>
  34 #include <libnvpair.h>
  35 #include <sys/mnttab.h>
  36 #include <sys/param.h>
  37 #include <sys/types.h>
  38 #include <sys/varargs.h>
  39 #include <sys/fs/zfs.h>
  40 #include <sys/avl.h>
  41 #include <ucred.h>
  42 #include <libzfs_core.h>
  43
  44 #ifdef  __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /*
  49  * Miscellaneous ZFS constants
  50  */
  51 #define ZFS_MAXNAMELEN          MAXNAMELEN
  52 #define ZPOOL_MAXNAMELEN        MAXNAMELEN
  53 #define ZFS_MAXPROPLEN          MAXPATHLEN
  54 #define ZPOOL_MAXPROPLEN        MAXPATHLEN
  55
  56 /*
  57  * Default device paths
  58  */
  59 #define DISK_ROOT               "/dev"
  60 #define UDISK_ROOT              "/dev/disk"
  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        7
  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_action(libzfs_handle_t *);
 207 extern const char *libzfs_error_description(libzfs_handle_t *);
 208 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
 209 extern void libzfs_mnttab_init(libzfs_handle_t *);
 210 extern void libzfs_mnttab_fini(libzfs_handle_t *);
 211 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
 212 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
 213     struct mnttab *);
 214 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
 215     const char *, const char *);
 216 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
 217
 218 /*
 219  * Basic handle functions
 220  */
 221 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
 222 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
 223 extern void zpool_close(zpool_handle_t *);
 224 extern const char *zpool_get_name(zpool_handle_t *);
 225 extern int zpool_get_state(zpool_handle_t *);
 226 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
 227 extern const char *zpool_pool_state_to_name(pool_state_t);
 228 extern void zpool_free_handles(libzfs_handle_t *);
 229
 230 /*
 231  * Iterate over all active pools in the system.
 232  */
 233 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
 234 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
 235
 236 /*
 237  * Functions to create and destroy pools
 238  */
 239 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
 240     nvlist_t *, nvlist_t *);
 241 extern int zpool_destroy(zpool_handle_t *, const char *);
 242 extern int zpool_add(zpool_handle_t *, nvlist_t *);
 243
 244 typedef struct splitflags {
 245         /* do not split, but return the config that would be split off */
 246         int dryrun : 1;
 247
 248         /* after splitting, import the pool */
 249         int import : 1;
 250 } splitflags_t;
 251
 252 /*
 253  * Functions to manipulate pool and vdev state
 254  */
 255 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
 256 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
 257 extern int zpool_reguid(zpool_handle_t *);
 258 extern int zpool_reopen(zpool_handle_t *);
 259
 260 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
 261     vdev_state_t *);
 262 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
 263 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
 264     const char *, nvlist_t *, int);
 265 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
 266 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
 267 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
 268     splitflags_t);
 269
 270 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
 271 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
 272 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
 273
 274 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
 275     boolean_t *, boolean_t *);
 276 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
 277     boolean_t *, boolean_t *, boolean_t *);
 278 extern int zpool_label_disk_wait(char *, int);
 279 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
 280
 281 /*
 282  * Functions to manage pool properties
 283  */
 284 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
 285 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
 286     size_t proplen, zprop_source_t *);
 287 extern int zpool_get_prop_literal(zpool_handle_t *, zpool_prop_t, char *,
 288     size_t proplen, zprop_source_t *, boolean_t literal);
 289 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
 290     zprop_source_t *);
 291
 292 extern const char *zpool_prop_to_name(zpool_prop_t);
 293 extern const char *zpool_prop_values(zpool_prop_t);
 294
 295 /*
 296  * Pool health statistics.
 297  */
 298 typedef enum {
 299         /*
 300          * The following correspond to faults as defined in the (fault.fs.zfs.*)
 301          * event namespace.  Each is associated with a corresponding message ID.
 302          */
 303         ZPOOL_STATUS_CORRUPT_CACHE,     /* corrupt /kernel/drv/zpool.cache */
 304         ZPOOL_STATUS_MISSING_DEV_R,     /* missing device with replicas */
 305         ZPOOL_STATUS_MISSING_DEV_NR,    /* missing device with no replicas */
 306         ZPOOL_STATUS_CORRUPT_LABEL_R,   /* bad device label with replicas */
 307         ZPOOL_STATUS_CORRUPT_LABEL_NR,  /* bad device label with no replicas */
 308         ZPOOL_STATUS_BAD_GUID_SUM,      /* sum of device guids didn't match */
 309         ZPOOL_STATUS_CORRUPT_POOL,      /* pool metadata is corrupted */
 310         ZPOOL_STATUS_CORRUPT_DATA,      /* data errors in user (meta)data */
 311         ZPOOL_STATUS_FAILING_DEV,       /* device experiencing errors */
 312         ZPOOL_STATUS_VERSION_NEWER,     /* newer on-disk version */
 313         ZPOOL_STATUS_HOSTID_MISMATCH,   /* last accessed by another system */
 314         ZPOOL_STATUS_IO_FAILURE_WAIT,   /* failed I/O, failmode 'wait' */
 315         ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
 316         ZPOOL_STATUS_BAD_LOG,           /* cannot read log chain(s) */
 317         ZPOOL_STATUS_ERRATA,            /* informational errata available */
 318
 319         /*
 320          * If the pool has unsupported features but can still be opened in
 321          * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
 322          * pool has unsupported features but cannot be opened at all, its
 323          * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
 324          */
 325         ZPOOL_STATUS_UNSUP_FEAT_READ,   /* unsupported features for read */
 326         ZPOOL_STATUS_UNSUP_FEAT_WRITE,  /* unsupported features for write */
 327
 328         /*
 329          * These faults have no corresponding message ID.  At the time we are
 330          * checking the status, the original reason for the FMA fault (I/O or
 331          * checksum errors) has been lost.
 332          */
 333         ZPOOL_STATUS_FAULTED_DEV_R,     /* faulted device with replicas */
 334         ZPOOL_STATUS_FAULTED_DEV_NR,    /* faulted device with no replicas */
 335
 336         /*
 337          * The following are not faults per se, but still an error possibly
 338          * requiring administrative attention.  There is no corresponding
 339          * message ID.
 340          */
 341         ZPOOL_STATUS_VERSION_OLDER,     /* older legacy on-disk version */
 342         ZPOOL_STATUS_FEAT_DISABLED,     /* supported features are disabled */
 343         ZPOOL_STATUS_RESILVERING,       /* device being resilvered */
 344         ZPOOL_STATUS_OFFLINE_DEV,       /* device online */
 345         ZPOOL_STATUS_REMOVED_DEV,       /* removed device */
 346
 347         /*
 348          * Finally, the following indicates a healthy pool.
 349          */
 350         ZPOOL_STATUS_OK
 351 } zpool_status_t;
 352
 353 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **,
 354     zpool_errata_t *);
 355 extern zpool_status_t zpool_import_status(nvlist_t *, char **,
 356     zpool_errata_t *);
 357 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
 358
 359 /*
 360  * Statistics and configuration functions.
 361  */
 362 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
 363 extern nvlist_t *zpool_get_features(zpool_handle_t *);
 364 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
 365 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
 366
 367 /*
 368  * Import and export functions
 369  */
 370 extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
 371 extern int zpool_export_force(zpool_handle_t *, const char *);
 372 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
 373     char *altroot);
 374 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
 375     nvlist_t *, int);
 376 extern void zpool_print_unsup_feat(nvlist_t *config);
 377
 378 /*
 379  * Search for pools to import
 380  */
 381
 382 typedef struct importargs {
 383         char **path;            /* a list of paths to search            */
 384         int paths;              /* number of paths to search            */
 385         char *poolname;         /* name of a pool to find               */
 386         uint64_t guid;          /* guid of a pool to find               */
 387         char *cachefile;        /* cachefile to use for import          */
 388         int can_be_active : 1;  /* can the pool be active?              */
 389         int unique : 1;         /* does 'poolname' already exist?       */
 390         int exists : 1;         /* set on return if pool already exists */
 391 } importargs_t;
 392
 393 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
 394
 395 /* legacy pool search routines */
 396 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
 397 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
 398     char *, uint64_t);
 399
 400 /*
 401  * Miscellaneous pool functions
 402  */
 403 struct zfs_cmd;
 404
 405 extern const char *zfs_history_event_names[];
 406
 407 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
 408     boolean_t verbose);
 409 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
 410 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
 411 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
 412     nvlist_t ***, uint_t *);
 413 extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned,
 414     int);
 415 extern int zpool_events_clear(libzfs_handle_t *, int *);
 416 extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int);
 417 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
 418     size_t len);
 419 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
 420 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
 421 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
 422     nvlist_t *);
 423
 424 /*
 425  * Basic handle manipulations.  These functions do not create or destroy the
 426  * underlying datasets, only the references to them.
 427  */
 428 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
 429 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
 430 extern void zfs_close(zfs_handle_t *);
 431 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
 432 extern const char *zfs_get_name(const zfs_handle_t *);
 433 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
 434
 435 /*
 436  * Property management functions.  Some functions are shared with the kernel,
 437  * and are found in sys/fs/zfs.h.
 438  */
 439
 440 /*
 441  * zfs dataset property management
 442  */
 443 extern const char *zfs_prop_default_string(zfs_prop_t);
 444 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
 445 extern const char *zfs_prop_column_name(zfs_prop_t);
 446 extern boolean_t zfs_prop_align_right(zfs_prop_t);
 447
 448 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
 449     nvlist_t *, uint64_t, zfs_handle_t *, const char *);
 450
 451 extern const char *zfs_prop_to_name(zfs_prop_t);
 452 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
 453 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
 454     zprop_source_t *, char *, size_t, boolean_t);
 455 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
 456     boolean_t);
 457 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
 458     zprop_source_t *, char *, size_t);
 459 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
 460     uint64_t *propvalue);
 461 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
 462     char *propbuf, int proplen, boolean_t literal);
 463 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
 464     uint64_t *propvalue);
 465 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
 466     char *propbuf, int proplen, boolean_t literal);
 467 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
 468     char *buf, size_t len);
 469 extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **);
 470 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
 471 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
 472 extern const char *zfs_prop_values(zfs_prop_t);
 473 extern int zfs_prop_is_string(zfs_prop_t prop);
 474 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
 475 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
 476 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
 477
 478 typedef struct zprop_list {
 479         int             pl_prop;
 480         char            *pl_user_prop;
 481         struct zprop_list *pl_next;
 482         boolean_t       pl_all;
 483         size_t          pl_width;
 484         size_t          pl_recvd_width;
 485         boolean_t       pl_fixed;
 486 } zprop_list_t;
 487
 488 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
 489     boolean_t);
 490 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
 491
 492 #define ZFS_MOUNTPOINT_NONE     "none"
 493 #define ZFS_MOUNTPOINT_LEGACY   "legacy"
 494
 495 #define ZFS_FEATURE_DISABLED    "disabled"
 496 #define ZFS_FEATURE_ENABLED     "enabled"
 497 #define ZFS_FEATURE_ACTIVE      "active"
 498
 499 #define ZFS_UNSUPPORTED_INACTIVE        "inactive"
 500 #define ZFS_UNSUPPORTED_READONLY        "readonly"
 501
 502 /*
 503  * zpool property management
 504  */
 505 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
 506 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
 507     size_t);
 508 extern const char *zpool_prop_default_string(zpool_prop_t);
 509 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
 510 extern const char *zpool_prop_column_name(zpool_prop_t);
 511 extern boolean_t zpool_prop_align_right(zpool_prop_t);
 512
 513 /*
 514  * Functions shared by zfs and zpool property management.
 515  */
 516 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
 517     boolean_t ordered, zfs_type_t type);
 518 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
 519     zfs_type_t);
 520 extern void zprop_free_list(zprop_list_t *);
 521
 522 #define ZFS_GET_NCOLS   5
 523
 524 typedef enum {
 525         GET_COL_NONE,
 526         GET_COL_NAME,
 527         GET_COL_PROPERTY,
 528         GET_COL_VALUE,
 529         GET_COL_RECVD,
 530         GET_COL_SOURCE
 531 } zfs_get_column_t;
 532
 533 /*
 534  * Functions for printing zfs or zpool properties
 535  */
 536 typedef struct zprop_get_cbdata {
 537         int cb_sources;
 538         zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
 539         int cb_colwidths[ZFS_GET_NCOLS + 1];
 540         boolean_t cb_scripted;
 541         boolean_t cb_literal;
 542         boolean_t cb_first;
 543         zprop_list_t *cb_proplist;
 544         zfs_type_t cb_type;
 545 } zprop_get_cbdata_t;
 546
 547 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
 548     const char *, const char *, zprop_source_t, const char *,
 549     const char *);
 550
 551 /*
 552  * Iterator functions.
 553  */
 554 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
 555 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
 556 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
 557 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 558 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
 559 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
 560 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
 561 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
 562 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
 563
 564 typedef struct get_all_cb {
 565         zfs_handle_t    **cb_handles;
 566         size_t          cb_alloc;
 567         size_t          cb_used;
 568         boolean_t       cb_verbose;
 569         int             (*cb_getone)(zfs_handle_t *, void *);
 570 } get_all_cb_t;
 571
 572 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
 573 int libzfs_dataset_cmp(const void *, const void *);
 574
 575 /*
 576  * Functions to create and destroy datasets.
 577  */
 578 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
 579     nvlist_t *);
 580 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
 581 extern int zfs_destroy(zfs_handle_t *, boolean_t);
 582 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
 583 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
 584 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
 585 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
 586 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
 587     nvlist_t *props);
 588 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
 589 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
 590
 591 typedef struct sendflags {
 592         /* print informational messages (ie, -v was specified) */
 593         boolean_t verbose;
 594
 595         /* recursive send  (ie, -R) */
 596         boolean_t replicate;
 597
 598         /* for incrementals, do all intermediate snapshots */
 599         boolean_t doall;
 600
 601         /* if dataset is a clone, do incremental from its origin */
 602         boolean_t fromorigin;
 603
 604         /* do deduplication */
 605         boolean_t dedup;
 606
 607         /* send properties (ie, -p) */
 608         boolean_t props;
 609
 610         /* do not send (no-op, ie. -n) */
 611         boolean_t dryrun;
 612
 613         /* parsable verbose output (ie. -P) */
 614         boolean_t parsable;
 615
 616         /* show progress (ie. -v) */
 617         boolean_t progress;
 618
 619         /* WRITE_EMBEDDED records of type DATA are permitted */
 620         boolean_t embed_data;
 621 } sendflags_t;
 622
 623 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
 624
 625 extern int zfs_send(zfs_handle_t *, const char *, const char *,
 626     sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
 627 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
 628
 629 extern int zfs_promote(zfs_handle_t *);
 630 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
 631     boolean_t, int);
 632 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
 633 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
 634 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
 635 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
 636
 637 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
 638     uid_t rid, uint64_t space);
 639
 640 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
 641     zfs_userspace_cb_t, void *);
 642
 643 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
 644 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
 645
 646 typedef struct recvflags {
 647         /* print informational messages (ie, -v was specified) */
 648         boolean_t verbose;
 649
 650         /* the destination is a prefix, not the exact fs (ie, -d) */
 651         boolean_t isprefix;
 652
 653         /*
 654          * Only the tail of the sent snapshot path is appended to the
 655          * destination to determine the received snapshot name (ie, -e).
 656          */
 657         boolean_t istail;
 658
 659         /* do not actually do the recv, just check if it would work (ie, -n) */
 660         boolean_t dryrun;
 661
 662         /* rollback/destroy filesystems as necessary (eg, -F) */
 663         boolean_t force;
 664
 665         /* set "canmount=off" on all modified filesystems */
 666         boolean_t canmountoff;
 667
 668         /* byteswap flag is used internally; callers need not specify */
 669         boolean_t byteswap;
 670
 671         /* do not mount file systems as they are extracted (private) */
 672         boolean_t nomount;
 673 } recvflags_t;
 674
 675 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *,
 676     int, avl_tree_t *);
 677
 678 typedef enum diff_flags {
 679         ZFS_DIFF_PARSEABLE = 0x1,
 680         ZFS_DIFF_TIMESTAMP = 0x2,
 681         ZFS_DIFF_CLASSIFY = 0x4
 682 } diff_flags_t;
 683
 684 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
 685     int);
 686
 687 /*
 688  * Miscellaneous functions.
 689  */
 690 extern const char *zfs_type_to_name(zfs_type_t);
 691 extern void zfs_refresh_properties(zfs_handle_t *);
 692 extern int zfs_name_valid(const char *, zfs_type_t);
 693 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
 694 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
 695     zfs_type_t);
 696 extern int zfs_spa_version(zfs_handle_t *, int *);
 697 extern boolean_t zfs_bookmark_exists(const char *path);
 698 extern int zfs_append_partition(char *path, size_t max_len);
 699 extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen);
 700 extern int zfs_strcmp_pathname(char *name, char *cmp_name, int wholedisk);
 701
 702 /*
 703  * Mount support functions.
 704  */
 705 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
 706 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
 707 extern int zfs_mount(zfs_handle_t *, const char *, int);
 708 extern int zfs_unmount(zfs_handle_t *, const char *, int);
 709 extern int zfs_unmountall(zfs_handle_t *, int);
 710
 711 /*
 712  * Share support functions.
 713  */
 714 extern boolean_t zfs_is_shared(zfs_handle_t *);
 715 extern int zfs_share(zfs_handle_t *);
 716 extern int zfs_unshare(zfs_handle_t *);
 717
 718 /*
 719  * Protocol-specific share support functions.
 720  */
 721 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
 722 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
 723 extern int zfs_share_nfs(zfs_handle_t *);
 724 extern int zfs_share_smb(zfs_handle_t *);
 725 extern int zfs_shareall(zfs_handle_t *);
 726 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
 727 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
 728 extern int zfs_unshareall_nfs(zfs_handle_t *);
 729 extern int zfs_unshareall_smb(zfs_handle_t *);
 730 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
 731 extern int zfs_unshareall(zfs_handle_t *);
 732 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
 733     void *, void *, int, zfs_share_op_t);
 734
 735 /*
 736  * Utility function to convert a number to a human-readable form.
 737  */
 738 extern void zfs_nicenum(uint64_t, char *, size_t);
 739 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
 740
 741 /*
 742  * Utility functions to run an external process.
 743  */
 744 #define STDOUT_VERBOSE  0x01
 745 #define STDERR_VERBOSE  0x02
 746
 747 int libzfs_run_process(const char *, char **, int flags);
 748 int libzfs_load_module(const char *);
 749
 750 /*
 751  * Given a device or file, determine if it is part of a pool.
 752  */
 753 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
 754     boolean_t *);
 755
 756 /*
 757  * Label manipulation.
 758  */
 759 extern int zpool_read_label(int, nvlist_t **);
 760 extern int zpool_clear_label(int);
 761
 762 /*
 763  * Management interfaces for SMB ACL files
 764  */
 765
 766 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
 767 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
 768 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
 769 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
 770
 771 /*
 772  * Enable and disable datasets within a pool by mounting/unmounting and
 773  * sharing/unsharing them.
 774  */
 775 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
 776 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
 777
 778 /*
 779  * Mappings between vdev and FRU.
 780  */
 781 extern void libzfs_fru_refresh(libzfs_handle_t *);
 782 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
 783 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
 784 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
 785     const char *);
 786 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
 787 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
 788
 789 #ifdef  __cplusplus
 790 }
 791 #endif
 792
 793 #endif  /* _LIBZFS_H */