libzfs.h revision 441d80aa4f613b6298fc8bd3151f4be02dbf84fc
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
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 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
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 * CDDL HEADER END
b12a1c38fc215cc54fa6014069fd2b8dbb496646lling * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Use is subject to license terms.
fa9e4066f08beec538e775443c5be79dd423fcabahrens#pragma ident "%Z%%M% %I% %E% SMI"
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern "C" {
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Miscellaneous ZFS constants
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle types
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle functions
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern zpool_handle_t *zpool_open_canfail(const char *);
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);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Iterate over all active pools in the system.
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef int (*zpool_iter_f)(zpool_handle_t *, void *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to create and destroy pools
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_create(const char *, nvlist_t *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to manipulate pool and vdev state
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
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 *,
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_vdev_detach(zpool_handle_t *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Pool health statistics.
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef enum {
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 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 */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_VERSION_MISMATCH, /* bad on-disk version */
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 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Finally, the following indicates a healthy pool.
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern zpool_status_t zpool_get_status(zpool_handle_t *, char **msgid);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern zpool_status_t zpool_import_status(nvlist_t *, char **msgid);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Statistics and configuration functions.
088e9d477eee66081e407fbc5a33c4da25f66f6aeschrockextern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **oldconfig);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Import and export functions
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_import(nvlist_t *, const char *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Search for pools to import
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern nvlist_t *zpool_find_import(int argc, char **argv);
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock * Miscellaneous pool functions
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrockextern char *zpool_vdev_name(zpool_handle_t *, nvlist_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle manipulations. These functions do not create or destroy the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * underlying datasets, only the references to them.
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern const char *zfs_get_name(const zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef enum {
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Property management functions. Some functions are shared with the kernel,
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * and are found in sys/fs/zfs.h.
fa9e4066f08beec538e775443c5be79dd423fcabahrensint zfs_prop_set(zfs_handle_t *, zfs_prop_t, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensint zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, zfs_source_t *,
fa9e4066f08beec538e775443c5be79dd423fcabahrens char *, size_t, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensint zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, zfs_source_t *,
fa9e4066f08beec538e775443c5be79dd423fcabahrensuint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrensint zfs_prop_validate(zfs_prop_t, const char *, uint64_t *);
7f7322febbcfe774b7270abc3b191c094bfcc517eschrockconst char *zfs_prop_default_string(zfs_prop_t prop);
07ba041951d9c8107e1fde609b578608d2f08e24eschrockint zfs_get_proplist(char *fields, zfs_prop_t *proplist, int max, int *count,
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Iterator functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_iter_dependents(zfs_handle_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 * Functions to create and destroy datasets.
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_create(const char *, zfs_type_t, const char *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_snapshot(const char *);
b12a1c38fc215cc54fa6014069fd2b8dbb496646llingextern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_backup(zfs_handle_t *, zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_restore(const char *, int, int, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Miscellaneous functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Mount support functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_mount(zfs_handle_t *, const char *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_unmount(zfs_handle_t *, const char *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Share support functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * For clients that need to capture error output.
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_set_error_handler(void (*)(const char *, va_list));
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When dealing with nvlists, verify() is extremely useful
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Utility function to convert a number to a human-readable form.
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_nicestrtonum(const char *, uint64_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Pool destroy special. Remove the device information without destroying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * the underlying dataset.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Given a device or file, determine if it is part of a pool.
46a2abf27af40eda17a3f97e79eda1aef4e3c3c8eschrockextern int zpool_in_use(int fd, pool_state_t *state, char **name);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * ftyp special. Read the label from a given device.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Create and remove zvol /dev links
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zoneadmd hack
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_init(void);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Useful defines
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif /* _LIBZFS_H */