fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The contents of this file are subject to the terms of the
441d80aa4f613b6298fc8bd3151f4be02dbf84fclling * Common Development and Distribution License (the "License").
441d80aa4f613b6298fc8bd3151f4be02dbf84fclling * You may not use this file except in compliance with the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * or http://www.opensolaris.org/os/licensing.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When distributing Covered Code, include this CDDL HEADER in each
fa9e4066f08beec538e775443c5be79dd423fcabahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If applicable, add the following below this CDDL HEADER, with the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * fields enclosed by brackets "[]" replaced with your own identifying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * information: Portions Copyright [yyyy] [name of copyright owner]
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
0d8fa8f8eba3ea46bc79d73445009505d1dd5d7dMartin Matuska * Copyright (c) 2011 Pawel Jakub Dawidek. All rights reserved.
e9316f7696401f3e5e263a5939031cb8d5641a88Joe Stein * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
4e3c9f4489a18514e5e8caeb91d4e6db07c98415Bill Pijewski * Copyright (c) 2012, Joyent, Inc. All rights reserved.
a7a845e4bf22fd1b2a284729ccd95c7370a0438cSteven Hartland * Copyright (c) 2013 Steven Hartland. All rights reserved.
c3d26abc9ee97b4f60233556aadeb57e0bd30bb9Matthew Ahrens * Copyright (c) 2014 Integros [integros.com]
8808ac5dae118369991f158b6ab736cb2691ecdeYuri Pankov * Copyright 2016 Nexenta Systems, Inc.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifndef _LIBZFS_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define _LIBZFS_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <assert.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <libnvpair.h>
ebedde844eddf46049b2403f974b50bcba47356eEric Taylor#include <sys/mnttab.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/param.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/types.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/varargs.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/fs/zfs.h>
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks#include <sys/avl.h>
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks#include <ucred.h>
5d7b4d438c4a51eccc95e77a83a437b4d48380ebMatthew Ahrens#include <libzfs_core.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern "C" {
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Miscellaneous ZFS constants
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_MAXPROPLEN MAXPATHLEN
990b4856d0eaada6f8140335733a1b1771ed2746lling#define ZPOOL_MAXPROPLEN MAXPATHLEN
fa9e4066f08beec538e775443c5be79dd423fcabahrens
99653d4ee642c6528e88224f12409a5f23060994eschrock/*
99653d4ee642c6528e88224f12409a5f23060994eschrock * libzfs errors
99653d4ee642c6528e88224f12409a5f23060994eschrock */
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrenstypedef enum zfs_error {
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrens EZFS_SUCCESS = 0, /* no error -- success */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_NOMEM = 2000, /* out of memory */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADPROP, /* invalid property value */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PROPREADONLY, /* cannot set readonly property */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PROPTYPE, /* property does not apply to dataset type */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PROPNONINHERIT, /* property is not inheritable */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PROPSPACE, /* bad quota or reservation */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADTYPE, /* dataset is not of appropriate type */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BUSY, /* pool or dataset is busy */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_EXISTS, /* pool or dataset already exists */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_NOENT, /* no such pool or dataset */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADSTREAM, /* bad backup stream */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_DSREADONLY, /* dataset is readonly */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_INVALIDNAME, /* invalid dataset name */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADRESTORE, /* unable to restore to destination */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADBACKUP, /* backup failed */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADTARGET, /* bad attach/detach/replace target */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_NODEVICE, /* no such device in pool */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADDEV, /* invalid device to add */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_NOREPLICAS, /* no valid replicas */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_RESILVERING, /* currently resilvering */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADVERSION, /* unsupported version */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADPATH, /* must be an absolute path */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_ZONED, /* used improperly in local zone */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_MOUNTFAILED, /* failed to mount dataset */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl EZFS_SHARENFSFAILED, /* share(1M) failed */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PERM, /* permission denied */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_NOSPC, /* out of space */
6e27f86863a47869e7b2514d7445d3ea6fc6cf4aSam Falkner EZFS_FAULT, /* bad address */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_IO, /* I/O error */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_INTR, /* signal received */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_ISSPARE, /* device is a hot spare */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_INVALCONFIG, /* invalid vdev configuration */
3bb79bece53191f2cf27aa61a72ea1784a7ce700eschrock EZFS_RECURSIVE, /* recursive dependency */
06eeb2ad640ce72d394ac521094bed7681044408ek EZFS_NOHISTORY, /* no history object */
b1b8ab34de515a5e83206da22c3d7e563241b021lling EZFS_POOLPROPS, /* couldn't retrieve pool props */
b1b8ab34de515a5e83206da22c3d7e563241b021lling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
b1b8ab34de515a5e83206da22c3d7e563241b021lling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
b7661ccca92e6bf5160f4d5d2601efaeaa1f5161mmusante EZFS_NAMETOOLONG, /* dataset name is too long */
8488aeb5df27784d479c16cde06a9e25cd9a1152taylor EZFS_OPENFAILED, /* open of device failed */
8488aeb5df27784d479c16cde06a9e25cd9a1152taylor EZFS_NOCAP, /* couldn't get capacity */
8488aeb5df27784d479c16cde06a9e25cd9a1152taylor EZFS_LABELFAILED, /* write of label failed */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks EZFS_BADWHO, /* invalid permission who */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks EZFS_BADPERM, /* invalid permission */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks EZFS_BADPERMSET, /* invalid permission set name */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks EZFS_NODELEGATION, /* delegated administration is disabled */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw EZFS_SHARESMBFAILED, /* failed to share over smb */
2f8aaab38e6371ad39ed90a1211ba8921acbb4d5eschrock EZFS_BADCACHE, /* bad cache file */
fa94a07fd0519b8abfd871ad8fe60e6bebe1e2bbbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */
e7cbe64f7a72dae5cb44f100db60ca88f3313c65gw EZFS_VDEVNOTSUP, /* unsupported vdev type */
15e6edf145a9c2bb0e0272cf8debe823bb97529bgw EZFS_NOTSUP, /* ops not supported on this dataset */
89a89ebfd7c3b4056afe2c03e959e22824df777dlling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
e6ca193ded880d478cc39e34ef82d4be36e4445dGeorge Wilson EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
842727c2f41f01b380de4f5e787d905702870f23Chris Kirby EZFS_REFTAG_RELE, /* snapshot release: tag not found */
842727c2f41f01b380de4f5e787d905702870f23Chris Kirby EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
ca45db4129beff691dc46576c328149443788af2Chris Kirby EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt EZFS_PIPEFAILED, /* pipe create failed */
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt EZFS_THREADCREATEFAILED, /* thread create failed */
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling EZFS_SCRUBBING, /* currently scrubbing */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling EZFS_NO_SCRUB, /* no active scrub */
99d5e173470cf967aa87653364ed614299e7b511Tim Haley EZFS_DIFF, /* general failure of zfs diff */
99d5e173470cf967aa87653364ed614299e7b511Tim Haley EZFS_DIFFDATA, /* bad zfs diff data */
f9af39bacaaa0f9dda3b75ff6858b9f3988a39afGeorge Wilson EZFS_POOLREADONLY, /* pool is in read-only mode */
b1b8ab34de515a5e83206da22c3d7e563241b021lling EZFS_UNKNOWN
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrens} zfs_error_t;
99653d4ee642c6528e88224f12409a5f23060994eschrock
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks/*
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * The following data structures are all part
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * of the zfs_allow_t data structure which is
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * used for printing 'allow' permissions.
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * It is a linked list of zfs_allow_t's which
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * then contain avl tree's for user/group/sets/...
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * and each one of the entries in those trees have
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * avl tree's for the permissions they belong to and
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * whether they are local,descendent or local+descendent
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * permissions. The AVL trees are used primarily for
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * sorting purposes, but also so that we can quickly find
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks * a given user and or permission.
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarkstypedef struct zfs_perm_node {
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_node_t z_node;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks char z_pname[MAXPATHLEN];
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks} zfs_perm_node_t;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarkstypedef struct zfs_allow_node {
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_node_t z_node;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks char z_key[MAXPATHLEN]; /* name, such as joe */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_tree_t z_localdescend; /* local+descendent perms */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_tree_t z_local; /* local permissions */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_tree_t z_descend; /* descendent permissions */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks} zfs_allow_node_t;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarkstypedef struct zfs_allow {
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks struct zfs_allow *z_next;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks char z_setpoint[MAXPATHLEN];
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_tree_t z_sets;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_tree_t z_crperms;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_tree_t z_user;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_tree_t z_group;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks avl_tree_t z_everyone;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks} zfs_allow_t;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle types
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef struct zfs_handle zfs_handle_t;
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef struct zpool_handle zpool_handle_t;
99653d4ee642c6528e88224f12409a5f23060994eschrocktypedef struct libzfs_handle libzfs_handle_t;
99653d4ee642c6528e88224f12409a5f23060994eschrock
99653d4ee642c6528e88224f12409a5f23060994eschrock/*
99653d4ee642c6528e88224f12409a5f23060994eschrock * Library initialization
99653d4ee642c6528e88224f12409a5f23060994eschrock */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern libzfs_handle_t *libzfs_init(void);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern void libzfs_fini(libzfs_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrock
99653d4ee642c6528e88224f12409a5f23060994eschrockextern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrock
99653d4ee642c6528e88224f12409a5f23060994eschrockextern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
99653d4ee642c6528e88224f12409a5f23060994eschrock
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrensextern void zfs_save_arguments(int argc, char **, char *, int);
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrensextern int zpool_log_history(libzfs_handle_t *, const char *);
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrens
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int libzfs_errno(libzfs_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern const char *libzfs_error_action(libzfs_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern const char *libzfs_error_description(libzfs_handle_t *);
78f171005391b928aaf1642b3206c534ed644332Matthew Ahrensextern int zfs_standard_error(libzfs_handle_t *, int, const char *);
ebedde844eddf46049b2403f974b50bcba47356eEric Taylorextern void libzfs_mnttab_init(libzfs_handle_t *);
ebedde844eddf46049b2403f974b50bcba47356eEric Taylorextern void libzfs_mnttab_fini(libzfs_handle_t *);
b2634b9c57bbcfa01bb5dec2e196aec32957925fEric Taylorextern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
ebedde844eddf46049b2403f974b50bcba47356eEric Taylorextern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
ebedde844eddf46049b2403f974b50bcba47356eEric Taylor struct mnttab *);
ebedde844eddf46049b2403f974b50bcba47356eEric Taylorextern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
ebedde844eddf46049b2403f974b50bcba47356eEric Taylor const char *, const char *);
ebedde844eddf46049b2403f974b50bcba47356eEric Taylorextern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle functions
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zpool_close(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern const char *zpool_get_name(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_get_state(zpool_handle_t *);
6401734d545a04c18f68b448202f9d9a77216bb9Will Andrewsextern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
6401734d545a04c18f68b448202f9d9a77216bb9Will Andrewsextern const char *zpool_pool_state_to_name(pool_state_t);
29ab75c9a733dad2978c4860efd954b5625e3467rmextern void zpool_free_handles(libzfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Iterate over all active pools in the system.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef int (*zpool_iter_f)(zpool_handle_t *, void *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
8808ac5dae118369991f158b6ab736cb2691ecdeYuri Pankovextern boolean_t zpool_skip_pool(const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to create and destroy pools
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
0a48a24e663a04e34e2ed4e55390ad96f178dbeatimh nvlist_t *, nvlist_t *);
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrensextern int zpool_destroy(zpool_handle_t *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_add(zpool_handle_t *, nvlist_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musantetypedef struct splitflags {
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante /* do not split, but return the config that would be split off */
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante int dryrun : 1;
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante /* after splitting, import the pool */
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante int import : 1;
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante} splitflags_t;
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to manipulate pool and vdev state
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyextern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
e9103aaee0c546d4644791198c54abb03c89969eGarrett D'Amoreextern int zpool_reguid(zpool_handle_t *);
4263d13f00c9691fa14620eff82abef795be0693George Wilsonextern int zpool_reopen(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_online(zpool_handle_t *, const char *, int,
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock vdev_state_t *);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_attach(zpool_handle_t *, const char *,
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock const char *, nvlist_t *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_vdev_detach(zpool_handle_t *, const char *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_vdev_remove(zpool_handle_t *, const char *);
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musanteextern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante splitflags_t);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrockextern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrockextern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock
fa94a07fd0519b8abfd871ad8fe60e6bebe1e2bbbrendanextern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
ee0eb9f2d12b8a03b5a193cd667735c1962e0c7bEric Schrock boolean_t *, boolean_t *);
573ca77e53dd31dcaebef023e7eb41969e6896c1George Wilsonextern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
573ca77e53dd31dcaebef023e7eb41969e6896c1George Wilson boolean_t *, boolean_t *, boolean_t *);
6401734d545a04c18f68b448202f9d9a77216bb9Will Andrewsextern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
b1b8ab34de515a5e83206da22c3d7e563241b021lling/*
b1b8ab34de515a5e83206da22c3d7e563241b021lling * Functions to manage pool properties
b1b8ab34de515a5e83206da22c3d7e563241b021lling */
b1b8ab34de515a5e83206da22c3d7e563241b021llingextern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
c58b352673e88983cd2b8a388a8c7625f35e2f18Adam Stevko size_t proplen, zprop_source_t *, boolean_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
990b4856d0eaada6f8140335733a1b1771ed2746lling zprop_source_t *);
990b4856d0eaada6f8140335733a1b1771ed2746lling
b1b8ab34de515a5e83206da22c3d7e563241b021llingextern const char *zpool_prop_to_name(zpool_prop_t);
b1b8ab34de515a5e83206da22c3d7e563241b021llingextern const char *zpool_prop_values(zpool_prop_t);
b1b8ab34de515a5e83206da22c3d7e563241b021lling
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Pool health statistics.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef enum {
fa9e4066f08beec538e775443c5be79dd423fcabahrens /*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The following correspond to faults as defined in the (fault.fs.zfs.*)
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * event namespace. Each is associated with a corresponding message ID.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
eaca9bbd5f5d1e4e554da4c7108e8a03c8c33481eschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
95173954d2b811ceb583a9012c3b16e1d0dd6438ek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
32b87932f3ef0887d873b7f6d2d1943799b2afc0ek ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
32b87932f3ef0887d873b7f6d2d1943799b2afc0ek ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
f67f35c39aa272d43489ee49625b4965cc83add2Eric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
f67f35c39aa272d43489ee49625b4965cc83add2Eric Schrock
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden /*
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden * If the pool has unsupported features but can still be opened in
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden * pool has unsupported features but cannot be opened at all, its
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden */
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden
f67f35c39aa272d43489ee49625b4965cc83add2Eric Schrock /*
f67f35c39aa272d43489ee49625b4965cc83add2Eric Schrock * These faults have no corresponding message ID. At the time we are
f67f35c39aa272d43489ee49625b4965cc83add2Eric Schrock * checking the status, the original reason for the FMA fault (I/O or
f67f35c39aa272d43489ee49625b4965cc83add2Eric Schrock * checksum errors) has been lost.
f67f35c39aa272d43489ee49625b4965cc83add2Eric Schrock */
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The following are not faults per se, but still an error possibly
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * requiring administrative attention. There is no corresponding
fa9e4066f08beec538e775443c5be79dd423fcabahrens * message ID.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
57221772c3fc05faba04bf48ddff45abf2bbf2bdChristopher Siden ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
57221772c3fc05faba04bf48ddff45abf2bbf2bdChristopher Siden ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */
cb605c4d8ab24b5a900b8b4ca85db65c22d05fadGerhard Roethlin ZPOOL_STATUS_OFFLINE_DEV, /* device offline */
c25309d42d46e04be84e0dbadaf3c9ab3369ad05George Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Finally, the following indicates a healthy pool.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_OK
fa9e4066f08beec538e775443c5be79dd423fcabahrens} zpool_status_t;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern zpool_status_t zpool_import_status(nvlist_t *, char **);
9eb19f4d61679ca0382def038665019234458eddGeorge Wilsonextern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Statistics and configuration functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Sidenextern nvlist_t *zpool_get_features(zpool_handle_t *);
94de1d4cf6ec0a3bf040dcc4b8df107c4ed36b51eschrockextern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
55434c770c89aa1b84474f2559a106803511aba0ekextern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Import and export functions
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrensextern int zpool_export(zpool_handle_t *, boolean_t, const char *);
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrensextern int zpool_export_force(zpool_handle_t *, const char *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
990b4856d0eaada6f8140335733a1b1771ed2746lling char *altroot);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
4b964ada391d44b89d97e7e930e6a9a136e0a2f4George Wilson nvlist_t *, int);
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Sidenextern void zpool_print_unsup_feat(nvlist_t *config);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Search for pools to import
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante
d41c437653d9e16d837cc66844073e1885276ceeMark J Musantetypedef struct importargs {
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante char **path; /* a list of paths to search */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante int paths; /* number of paths to search */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante char *poolname; /* name of a pool to find */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante uint64_t guid; /* guid of a pool to find */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante char *cachefile; /* cachefile to use for import */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante int can_be_active : 1; /* can the pool be active? */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante int unique : 1; /* does 'poolname' already exist? */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante int exists : 1; /* set on return if pool already exists */
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante} importargs_t;
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante
d41c437653d9e16d837cc66844073e1885276ceeMark J Musanteextern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante
d41c437653d9e16d837cc66844073e1885276ceeMark J Musante/* legacy pool search routines */
24e697d414a4df0377b91a2875f029e7b5f97247ckextern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
3a57275a335306e90136ebd00a4689fe0ee72519ckextern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
e829d913cde9eeff0efd355502799863d4f74f69ck char *, uint64_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock/*
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock * Miscellaneous pool functions
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock */
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarksstruct zfs_cmd;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrensextern const char *zfs_history_event_names[];
8f18d1fadf6a0c20fac9ff7259a5368faa3c3bfbGeorge Wilson
88ecc943b4eb72f7c4fbbd8435997b85ef171fc3George Wilsonextern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
88ecc943b4eb72f7c4fbbd8435997b85ef171fc3George Wilson boolean_t verbose);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern int zpool_upgrade(zpool_handle_t *, uint64_t);
06eeb2ad640ce72d394ac521094bed7681044408ekextern int zpool_get_history(zpool_handle_t *, nvlist_t **);
8f18d1fadf6a0c20fac9ff7259a5368faa3c3bfbGeorge Wilsonextern int zpool_history_unpack(char *, uint64_t, uint64_t *,
8f18d1fadf6a0c20fac9ff7259a5368faa3c3bfbGeorge Wilson nvlist_t ***, uint_t *);
55434c770c89aa1b84474f2559a106803511aba0ekextern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
55434c770c89aa1b84474f2559a106803511aba0ek size_t len);
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarksextern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
753a6d457b330b1b29b2d3eefcd0831116ce950dSherry Mooreextern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyextern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
468c413a79615e77179e8d98f22a7e513a8135bdTim Haley nvlist_t *);
753a6d457b330b1b29b2d3eefcd0831116ce950dSherry Moore
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle manipulations. These functions do not create or destroy the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * underlying datasets, only the references to them.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrensextern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_close(zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern zfs_type_t zfs_get_type(const zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern const char *zfs_get_name(const zfs_handle_t *);
d5b5bb256c576fe5ef26e0795bd40abe77f93246Rich Morrisextern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
8808ac5dae118369991f158b6ab736cb2691ecdeYuri Pankovextern const char *zfs_get_pool_name(const zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Property management functions. Some functions are shared with the kernel,
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * and are found in sys/fs/zfs.h.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
990b4856d0eaada6f8140335733a1b1771ed2746lling
990b4856d0eaada6f8140335733a1b1771ed2746lling/*
990b4856d0eaada6f8140335733a1b1771ed2746lling * zfs dataset property management
990b4856d0eaada6f8140335733a1b1771ed2746lling */
990b4856d0eaada6f8140335733a1b1771ed2746llingextern const char *zfs_prop_default_string(zfs_prop_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern uint64_t zfs_prop_default_numeric(zfs_prop_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern const char *zfs_prop_column_name(zfs_prop_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern boolean_t zfs_prop_align_right(zfs_prop_t);
990b4856d0eaada6f8140335733a1b1771ed2746lling
0a48a24e663a04e34e2ed4e55390ad96f178dbeatimhextern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
e9316f7696401f3e5e263a5939031cb8d5641a88Joe Stein nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
0a48a24e663a04e34e2ed4e55390ad96f178dbeatimh
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_to_name(zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
30925561c223021e91d15899cbe75f80e54d8889Chris Williamsonextern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
990b4856d0eaada6f8140335733a1b1771ed2746lling zprop_source_t *, char *, size_t, boolean_t);
92241e0b80813d0b83c08e730a29b9d1831794fcTom Ericksonextern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson boolean_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
990b4856d0eaada6f8140335733a1b1771ed2746lling zprop_source_t *, char *, size_t);
edea4b556f0b07459cdcc780ffcd28a40b374945Lin Lingextern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
edea4b556f0b07459cdcc780ffcd28a40b374945Lin Ling uint64_t *propvalue);
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrensextern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrens char *propbuf, int proplen, boolean_t literal);
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrensextern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens uint64_t *propvalue);
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrensextern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens char *propbuf, int proplen, boolean_t literal);
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Sidenextern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden char *buf, size_t len);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
92241e0b80813d0b83c08e730a29b9d1831794fcTom Ericksonextern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_values(zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_is_string(zfs_prop_t prop);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern nvlist_t *zfs_get_user_props(zfs_handle_t *);
92241e0b80813d0b83c08e730a29b9d1831794fcTom Ericksonextern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrensextern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock
990b4856d0eaada6f8140335733a1b1771ed2746llingtypedef struct zprop_list {
990b4856d0eaada6f8140335733a1b1771ed2746lling int pl_prop;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock char *pl_user_prop;
990b4856d0eaada6f8140335733a1b1771ed2746lling struct zprop_list *pl_next;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock boolean_t pl_all;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock size_t pl_width;
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson size_t pl_recvd_width;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock boolean_t pl_fixed;
990b4856d0eaada6f8140335733a1b1771ed2746lling} zprop_list_t;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock
43d68d68c1ce08fb35026bebfb141af422e7082eYuri Pankovextern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
43d68d68c1ce08fb35026bebfb141af422e7082eYuri Pankov boolean_t);
2e5e9e19867a0d75685f5beb2fe1b0e31491d49bSanjeev Bagewadiextern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_MOUNTPOINT_NONE "none"
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_MOUNTPOINT_LEGACY "legacy"
fa9e4066f08beec538e775443c5be79dd423fcabahrens
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden#define ZFS_FEATURE_DISABLED "disabled"
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden#define ZFS_FEATURE_ENABLED "enabled"
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden#define ZFS_FEATURE_ACTIVE "active"
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden#define ZFS_UNSUPPORTED_INACTIVE "inactive"
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden#define ZFS_UNSUPPORTED_READONLY "readonly"
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden
b1b8ab34de515a5e83206da22c3d7e563241b021lling/*
990b4856d0eaada6f8140335733a1b1771ed2746lling * zpool property management
990b4856d0eaada6f8140335733a1b1771ed2746lling */
990b4856d0eaada6f8140335733a1b1771ed2746llingextern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Sidenextern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden size_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern const char *zpool_prop_default_string(zpool_prop_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern uint64_t zpool_prop_default_numeric(zpool_prop_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern const char *zpool_prop_column_name(zpool_prop_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern boolean_t zpool_prop_align_right(zpool_prop_t);
990b4856d0eaada6f8140335733a1b1771ed2746lling
990b4856d0eaada6f8140335733a1b1771ed2746lling/*
990b4856d0eaada6f8140335733a1b1771ed2746lling * Functions shared by zfs and zpool property management.
b1b8ab34de515a5e83206da22c3d7e563241b021lling */
990b4856d0eaada6f8140335733a1b1771ed2746llingextern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
990b4856d0eaada6f8140335733a1b1771ed2746lling boolean_t ordered, zfs_type_t type);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
990b4856d0eaada6f8140335733a1b1771ed2746lling zfs_type_t);
990b4856d0eaada6f8140335733a1b1771ed2746llingextern void zprop_free_list(zprop_list_t *);
990b4856d0eaada6f8140335733a1b1771ed2746lling
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson#define ZFS_GET_NCOLS 5
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson
92241e0b80813d0b83c08e730a29b9d1831794fcTom Ericksontypedef enum {
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson GET_COL_NONE,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson GET_COL_NAME,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson GET_COL_PROPERTY,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson GET_COL_VALUE,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson GET_COL_RECVD,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson GET_COL_SOURCE
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson} zfs_get_column_t;
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson
990b4856d0eaada6f8140335733a1b1771ed2746lling/*
990b4856d0eaada6f8140335733a1b1771ed2746lling * Functions for printing zfs or zpool properties
990b4856d0eaada6f8140335733a1b1771ed2746lling */
990b4856d0eaada6f8140335733a1b1771ed2746llingtypedef struct zprop_get_cbdata {
b1b8ab34de515a5e83206da22c3d7e563241b021lling int cb_sources;
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson int cb_colwidths[ZFS_GET_NCOLS + 1];
b1b8ab34de515a5e83206da22c3d7e563241b021lling boolean_t cb_scripted;
b1b8ab34de515a5e83206da22c3d7e563241b021lling boolean_t cb_literal;
b1b8ab34de515a5e83206da22c3d7e563241b021lling boolean_t cb_first;
990b4856d0eaada6f8140335733a1b1771ed2746lling zprop_list_t *cb_proplist;
990b4856d0eaada6f8140335733a1b1771ed2746lling zfs_type_t cb_type;
990b4856d0eaada6f8140335733a1b1771ed2746lling} zprop_get_cbdata_t;
b1b8ab34de515a5e83206da22c3d7e563241b021lling
990b4856d0eaada6f8140335733a1b1771ed2746llingvoid zprop_print_one_property(const char *, zprop_get_cbdata_t *,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson const char *, const char *, zprop_source_t, const char *,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson const char *);
b1b8ab34de515a5e83206da22c3d7e563241b021lling
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Iterator functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef int (*zfs_iter_f)(zfs_handle_t *, void *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
3bb79bece53191f2cf27aa61a72ea1784a7ce700eschrockextern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
7f7322febbcfe774b7270abc3b191c094bfcc517eschrockextern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
0d8fa8f8eba3ea46bc79d73445009505d1dd5d7dMartin Matuskaextern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
ca45db4129beff691dc46576c328149443788af2Chris Kirbyextern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrensextern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
78f171005391b928aaf1642b3206c534ed644332Matthew Ahrensextern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylortypedef struct get_all_cb {
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylor zfs_handle_t **cb_handles;
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylor size_t cb_alloc;
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylor size_t cb_used;
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylor boolean_t cb_verbose;
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylor int (*cb_getone)(zfs_handle_t *, void *);
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylor} get_all_cb_t;
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylor
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylorvoid libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylorint libzfs_dataset_cmp(const void *, const void *);
9d9a58e3638ed2e79c339c93e9c52b7150075364Eric Taylor
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to create and destroy datasets.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock nvlist_t *);
7f1f55ea3af0e6153a8ee9316c7f0b8b4f1ba773vbextern int zfs_create_ancestors(libzfs_handle_t *, const char *);
842727c2f41f01b380de4f5e787d905702870f23Chris Kirbyextern int zfs_destroy(zfs_handle_t *, boolean_t);
842727c2f41f01b380de4f5e787d905702870f23Chris Kirbyextern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrensextern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
bb0ade0978a02d3fe0b0165cd4725fdcb593fbfbahrensextern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrensextern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrens nvlist_t *props);
c391e322108d10533bc61ba3ef7099b302214341ahrensextern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
6a9cb0ea17f11529b1bb8ca31944abd37736b99eEric Schrockextern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alttypedef struct sendflags {
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt /* print informational messages (ie, -v was specified) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t verbose;
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson /* recursive send (ie, -R) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t replicate;
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt /* for incrementals, do all intermediate snapshots */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t doall;
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt /* if dataset is a clone, do incremental from its origin */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t fromorigin;
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt /* do deduplication */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t dedup;
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson /* send properties (ie, -p) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t props;
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens /* do not send (no-op, ie. -n) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t dryrun;
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens /* parsable verbose output (ie. -P) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t parsable;
4e3c9f4489a18514e5e8caeb91d4e6db07c98415Bill Pijewski
4e3c9f4489a18514e5e8caeb91d4e6db07c98415Bill Pijewski /* show progress (ie. -v) */
4e3c9f4489a18514e5e8caeb91d4e6db07c98415Bill Pijewski boolean_t progress;
5d7b4d438c4a51eccc95e77a83a437b4d48380ebMatthew Ahrens
b515258426fed6c7311fd3f1dea697cfbd4085c6Matthew Ahrens /* large blocks (>128K) are permitted */
b515258426fed6c7311fd3f1dea697cfbd4085c6Matthew Ahrens boolean_t largeblock;
b515258426fed6c7311fd3f1dea697cfbd4085c6Matthew Ahrens
5d7b4d438c4a51eccc95e77a83a437b4d48380ebMatthew Ahrens /* WRITE_EMBEDDED records of type DATA are permitted */
5d7b4d438c4a51eccc95e77a83a437b4d48380ebMatthew Ahrens boolean_t embed_data;
5602294fda888d923d57a78bafdaf48ae6223deaDan Kimmel
5602294fda888d923d57a78bafdaf48ae6223deaDan Kimmel /* compressed WRITE records are permitted */
5602294fda888d923d57a78bafdaf48ae6223deaDan Kimmel boolean_t compress;
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt} sendflags_t;
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alttypedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrensextern int zfs_send(zfs_handle_t *, const char *, const char *,
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
5d7b4d438c4a51eccc95e77a83a437b4d48380ebMatthew Ahrensextern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrensextern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrens const char *);
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrensextern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrens const char *token);
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zfs_promote(zfs_handle_t *);
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrensextern int zfs_hold(zfs_handle_t *, const char *, const char *,
a7a845e4bf22fd1b2a284729ccd95c7370a0438cSteven Hartland boolean_t, int);
a7a845e4bf22fd1b2a284729ccd95c7370a0438cSteven Hartlandextern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
842727c2f41f01b380de4f5e787d905702870f23Chris Kirbyextern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
1af68beac368dae20a9c5d738cf6b6320cf9d63aAlexander Stetsenkoextern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
c144956179190829a882ff695f7771ba19f65becEric Taylorextern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
0aea4b19873599c9a11db600b90263c7233db953Matthew Ahrenstypedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrens uid_t rid, uint64_t space);
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrens
1af68beac368dae20a9c5d738cf6b6320cf9d63aAlexander Stetsenkoextern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
1af68beac368dae20a9c5d738cf6b6320cf9d63aAlexander Stetsenko zfs_userspace_cb_t, void *);
1af68beac368dae20a9c5d738cf6b6320cf9d63aAlexander Stetsenko
1af68beac368dae20a9c5d738cf6b6320cf9d63aAlexander Stetsenkoextern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
1af68beac368dae20a9c5d738cf6b6320cf9d63aAlexander Stetsenkoextern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrens
3cb34c601f3ef3016f638574f5982e80c3735c71ahrenstypedef struct recvflags {
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens /* print informational messages (ie, -v was specified) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t verbose;
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens /* the destination is a prefix, not the exact fs (ie, -d) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t isprefix;
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens
f64930f5a99dc5cadc013502deedef5a6ef3971fTom Erickson /*
f64930f5a99dc5cadc013502deedef5a6ef3971fTom Erickson * Only the tail of the sent snapshot path is appended to the
f64930f5a99dc5cadc013502deedef5a6ef3971fTom Erickson * destination to determine the received snapshot name (ie, -e).
f64930f5a99dc5cadc013502deedef5a6ef3971fTom Erickson */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t istail;
f64930f5a99dc5cadc013502deedef5a6ef3971fTom Erickson
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens /* do not actually do the recv, just check if it would work (ie, -n) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t dryrun;
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens /* rollback/destroy filesystems as necessary (eg, -F) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t force;
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens /* set "canmount=off" on all modified filesystems */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t canmountoff;
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrens /*
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrens * Mark the file systems as "resumable" and do not destroy them if the
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrens * receive is interrupted
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrens */
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrens boolean_t resumable;
9c3fd1216fa7fb02cfbc78a2518a686d54b48ab8Matthew Ahrens
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens /* byteswap flag is used internally; callers need not specify */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t byteswap;
33408eef27eb2599d62f65cbf4c8a8fb8d5ac541Lori Alt
33408eef27eb2599d62f65cbf4c8a8fb8d5ac541Lori Alt /* do not mount file systems as they are extracted (private) */
19b94df933188a15d4f0d6c568f0bab3f127892eMatthew Ahrens boolean_t nomount;
3cb34c601f3ef3016f638574f5982e80c3735c71ahrens} recvflags_t;
3cb34c601f3ef3016f638574f5982e80c3735c71ahrens
a2cdcdd260232b58202b11a9bfc0103c9449ed52Paul Dagnelieextern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *,
a2cdcdd260232b58202b11a9bfc0103c9449ed52Paul Dagnelie recvflags_t *, int, avl_tree_t *);
3cb34c601f3ef3016f638574f5982e80c3735c71ahrens
99d5e173470cf967aa87653364ed614299e7b511Tim Haleytypedef enum diff_flags {
99d5e173470cf967aa87653364ed614299e7b511Tim Haley ZFS_DIFF_PARSEABLE = 0x1,
99d5e173470cf967aa87653364ed614299e7b511Tim Haley ZFS_DIFF_TIMESTAMP = 0x2,
99d5e173470cf967aa87653364ed614299e7b511Tim Haley ZFS_DIFF_CLASSIFY = 0x4
99d5e173470cf967aa87653364ed614299e7b511Tim Haley} diff_flags_t;
99d5e173470cf967aa87653364ed614299e7b511Tim Haley
99d5e173470cf967aa87653364ed614299e7b511Tim Haleyextern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
99d5e173470cf967aa87653364ed614299e7b511Tim Haley int);
99d5e173470cf967aa87653364ed614299e7b511Tim Haley
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Miscellaneous functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern const char *zfs_type_to_name(zfs_type_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_refresh_properties(zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_name_valid(const char *, zfs_type_t);
5aba80db367b061758a29154d304977d00d8e4f4ckextern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
7f1f55ea3af0e6153a8ee9316c7f0b8b4f1ba773vbextern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
7f1f55ea3af0e6153a8ee9316c7f0b8b4f1ba773vb zfs_type_t);
7b97dc1abb536bd13204496f8ae5a6f2fe9f2fb3rmextern int zfs_spa_version(zfs_handle_t *, int *);
78f171005391b928aaf1642b3206c534ed644332Matthew Ahrensextern boolean_t zfs_bookmark_exists(const char *path);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Mount support functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
55434c770c89aa1b84474f2559a106803511aba0ekextern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_mount(zfs_handle_t *, const char *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_unmount(zfs_handle_t *, const char *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_unmountall(zfs_handle_t *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Share support functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern boolean_t zfs_is_shared(zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_share(zfs_handle_t *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_unshare(zfs_handle_t *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl/*
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock * Protocol-specific share support functions.
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_share_nfs(zfs_handle_t *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int zfs_share_smb(zfs_handle_t *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int zfs_shareall(zfs_handle_t *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_unshare_nfs(zfs_handle_t *, const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int zfs_unshare_smb(zfs_handle_t *, const char *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_unshareall_nfs(zfs_handle_t *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int zfs_unshareall_smb(zfs_handle_t *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int zfs_unshareall(zfs_handle_t *);
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wrightextern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw void *, void *, int, zfs_share_op_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When dealing with nvlists, verify() is extremely useful
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef NDEBUG
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define verify(EX) ((void)(EX))
fa9e4066f08beec538e775443c5be79dd423fcabahrens#else
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define verify(EX) assert(EX)
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Utility function to convert a number to a human-readable form.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_nicenum(uint64_t, char *, size_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Given a device or file, determine if it is part of a pool.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
99653d4ee642c6528e88224f12409a5f23060994eschrock boolean_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
096d22d43da2758693a6df66ce7d9ab54c9d464cEric Schrock * Label manipulation.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_read_label(int, nvlist_t **);
096d22d43da2758693a6df66ce7d9ab54c9d464cEric Schrockextern int zpool_clear_label(int);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
e7cbe64f7a72dae5cb44f100db60ca88f3313c65gw/* is this zvol valid for use as a dump device? */
e7cbe64f7a72dae5cb44f100db60ca88f3313c65gwextern int zvol_check_dump_config(char *);
e7cbe64f7a72dae5cb44f100db60ca88f3313c65gw
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wright/*
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wright * Management interfaces for SMB ACL files
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wright */
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wright
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wrightint zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wrightint zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wrightint zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wrightint zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wright
3bb79bece53191f2cf27aa61a72ea1784a7ce700eschrock/*
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl * Enable and disable datasets within a pool by mounting/unmounting and
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl * sharing/unsharing them.
3bb79bece53191f2cf27aa61a72ea1784a7ce700eschrock */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
3bb79bece53191f2cf27aa61a72ea1784a7ce700eschrock
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrock/*
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrock * Mappings between vdev and FRU.
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrock */
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrockextern void libzfs_fru_refresh(libzfs_handle_t *);
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrockextern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrockextern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrockextern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrock const char *);
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrockextern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrockextern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrock
2bcf0248e992f292c7b814458bcdce2f004925d6Max Grossmanextern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *);
2bcf0248e992f292c7b814458bcdce2f004925d6Max Grossman
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif /* _LIBZFS_H */