libzfs.h revision f3861e1a2ceec23a5b699c24d814b7775a9e0b52
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/*
b12a1c38fc215cc54fa6014069fd2b8dbb496646lling * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Use is subject to license terms.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifndef _LIBZFS_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define _LIBZFS_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#pragma ident "%Z%%M% %I% %E% SMI"
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <assert.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <libnvpair.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/param.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/types.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/varargs.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/fs/zfs.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern "C" {
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Miscellaneous ZFS constants
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_MAXNAMELEN MAXNAMELEN
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZPOOL_MAXNAMELEN MAXNAMELEN
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_MAXPROPLEN MAXPATHLEN
fa9e4066f08beec538e775443c5be79dd423fcabahrens
99653d4ee642c6528e88224f12409a5f23060994eschrock/*
99653d4ee642c6528e88224f12409a5f23060994eschrock * libzfs errors
99653d4ee642c6528e88224f12409a5f23060994eschrock */
99653d4ee642c6528e88224f12409a5f23060994eschrockenum {
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_VOLHASDATA, /* volume already contains data */
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_DEVLINKS, /* failed to create zvol links */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PERM, /* permission denied */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_NOSPC, /* out of space */
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 */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_UNKNOWN /* unknown error */
99653d4ee642c6528e88224f12409a5f23060994eschrock};
99653d4ee642c6528e88224f12409a5f23060994eschrock
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
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 *);
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 uint64_t zpool_get_guid(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern uint64_t zpool_get_space_used(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern uint64_t zpool_get_space_total(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_get_root(zpool_handle_t *, char *, size_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_get_state(zpool_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern uint64_t zpool_get_version(zpool_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 *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to create and destroy pools
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
99653d4ee642c6528e88224f12409a5f23060994eschrock const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_destroy(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_add(zpool_handle_t *, nvlist_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to manipulate pool and vdev state
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_vdev_online(zpool_handle_t *, const char *);
441d80aa4f613b6298fc8bd3151f4be02dbf84fcllingextern int zpool_vdev_offline(zpool_handle_t *, const char *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_vdev_attach(zpool_handle_t *, const char *, const char *,
fa9e4066f08beec538e775443c5be79dd423fcabahrens nvlist_t *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_vdev_detach(zpool_handle_t *, const char *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_vdev_remove(zpool_handle_t *, const char *);
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern int zpool_clear(zpool_handle_t *, const char *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
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 */
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 */
eaca9bbd5f5d1e4e554da4c7108e8a03c8c33481eschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */
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 **);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Statistics and configuration functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
94de1d4cf6ec0a3bf040dcc4b8df107c4ed36b51eschrockextern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern int zpool_get_errlog(zpool_handle_t *, nvlist_t ***, size_t *);
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Import and export functions
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_export(zpool_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
99653d4ee642c6528e88224f12409a5f23060994eschrock const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Search for pools to import
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock/*
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock * Miscellaneous pool functions
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
eaca9bbd5f5d1e4e554da4c7108e8a03c8c33481eschrockextern int zpool_upgrade(zpool_handle_t *);
06eeb2ad640ce72d394ac521094bed7681044408ekextern int zpool_get_history(zpool_handle_t *, nvlist_t **);
06eeb2ad640ce72d394ac521094bed7681044408ekextern void zpool_log_history(libzfs_handle_t *, int, char **, const char *,
06eeb2ad640ce72d394ac521094bed7681044408ek boolean_t, boolean_t);
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock
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);
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 *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef enum {
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZFS_SRC_NONE = 0x1,
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZFS_SRC_DEFAULT = 0x2,
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZFS_SRC_TEMPORARY = 0x4,
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZFS_SRC_LOCAL = 0x8,
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZFS_SRC_INHERITED = 0x10
fa9e4066f08beec538e775443c5be79dd423fcabahrens} zfs_source_t;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_SRC_ALL 0x1f
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Property management functions. Some functions are shared with the kernel,
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * and are found in sys/fs/zfs.h.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_to_name(zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock zfs_source_t *, char *, size_t, boolean_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock zfs_source_t *, char *, size_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_get_string(zfs_handle_t *, zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_inherit(zfs_handle_t *, const char *);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_values(zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_valid_for_type(zfs_prop_t, int);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_default_string(zfs_prop_t prop);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern uint64_t zfs_prop_default_numeric(zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_is_string(zfs_prop_t prop);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_column_name(zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern boolean_t zfs_prop_align_right(zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrocktypedef struct zfs_proplist {
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock zfs_prop_t pl_prop;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock char *pl_user_prop;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock struct zfs_proplist *pl_next;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock boolean_t pl_all;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock size_t pl_width;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock boolean_t pl_fixed;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock} zfs_proplist_t;
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_get_proplist(libzfs_handle_t *, char *, zfs_proplist_t **);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern void zfs_free_proplist(zfs_proplist_t *);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_expand_proplist(zfs_handle_t *, zfs_proplist_t **);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern nvlist_t *zfs_get_user_props(zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_MOUNTPOINT_NONE "none"
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_MOUNTPOINT_LEGACY "legacy"
fa9e4066f08beec538e775443c5be79dd423fcabahrens
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 *);
7f7322febbcfe774b7270abc3b191c094bfcc517eschrockextern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to create and destroy datasets.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock nvlist_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_destroy(zfs_handle_t *);
1d452cf5123cb6ac0a013a4dbd4dcceeb0da314dahrensextern int zfs_destroy_snaps(zfs_handle_t *, char *);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
1d452cf5123cb6ac0a013a4dbd4dcceeb0da314dahrensextern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t);
b12a1c38fc215cc54fa6014069fd2b8dbb496646llingextern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_rename(zfs_handle_t *, const char *);
a2eea2e101e6a163a537dcc6d4e3c4da2a0ea5b2ahrensextern int zfs_send(zfs_handle_t *, const char *);
98579b20de8e05c5117968705a18979f8b75b863ndextern int zfs_receive(libzfs_handle_t *, const char *, int, int, int,
98579b20de8e05c5117968705a18979f8b75b863nd boolean_t);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zfs_promote(zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
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);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_disable(zfs_handle_t *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_enable(zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Mount support functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
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/*
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl * Protocol-specifc share support functions.
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_share_nfs(zfs_handle_t *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_unshare_nfs(zfs_handle_t *, const char *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_unshareall_nfs(zfs_handle_t *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_share_iscsi(zfs_handle_t *);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_unshare_iscsi(zfs_handle_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 * Pool destroy special. Remove the device information without destroying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * the underlying dataset.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_remove_link(zfs_handle_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/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * ftyp special. Read the label from a given device.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_read_label(int, nvlist_t **);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl * Create and remove zvol /dev links.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_create_zvol_links(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_remove_zvol_links(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
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
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif /* _LIBZFS_H */