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