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