libzfs.h revision ea8dc4b6d2251b437950c0056bc626b311c73c27
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _LIBZFS_H
#define _LIBZFS_H
#pragma ident "%Z%%M% %I% %E% SMI"
#include <assert.h>
#include <libnvpair.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Miscellaneous ZFS constants
*/
#define ZFS_MAXNAMELEN MAXNAMELEN
#define ZPOOL_MAXNAMELEN MAXNAMELEN
#define ZFS_MAXPROPLEN MAXPATHLEN
/*
* Basic handle types
*/
typedef struct zfs_handle zfs_handle_t;
typedef struct zpool_handle zpool_handle_t;
/*
* Basic handle functions
*/
extern zpool_handle_t *zpool_open(const char *);
extern zpool_handle_t *zpool_open_canfail(const char *);
extern void zpool_close(zpool_handle_t *);
extern const char *zpool_get_name(zpool_handle_t *);
extern int zpool_get_state(zpool_handle_t *);
/*
* Iterate over all active pools in the system.
*/
typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
extern int zpool_iter(zpool_iter_f, void *);
/*
* Functions to create and destroy pools
*/
extern int zpool_create(const char *, nvlist_t *, const char *);
extern int zpool_destroy(zpool_handle_t *);
/*
* Functions to manipulate pool and vdev state
*/
extern int zpool_vdev_online(zpool_handle_t *, const char *);
extern int zpool_vdev_offline(zpool_handle_t *, const char *, int);
extern int zpool_vdev_attach(zpool_handle_t *, const char *, const char *,
nvlist_t *, int);
extern int zpool_vdev_detach(zpool_handle_t *, const char *);
extern int zpool_clear(zpool_handle_t *, const char *);
/*
* Pool health statistics.
*/
typedef enum {
/*
* The following correspond to faults as defined in the (fault.fs.zfs.*)
* event namespace. Each is associated with a corresponding message ID.
*/
ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
ZPOOL_STATUS_VERSION_MISMATCH, /* bad on-disk version */
/*
* The following are not faults per se, but still an error possibly
* requiring administrative attention. There is no corresponding
* message ID.
*/
ZPOOL_STATUS_RESILVERING, /* device being resilvered */
ZPOOL_STATUS_OFFLINE_DEV, /* device online */
/*
* Finally, the following indicates a healthy pool.
*/
/*
* Statistics and configuration functions.
*/
extern int zpool_refresh_stats(zpool_handle_t *);
#define ZPOOL_ERR_DATASET "dataset"
#define ZPOOL_ERR_OBJECT "object"
#define ZPOOL_ERR_RANGE "range"
/*
* Import and export functions
*/
extern int zpool_export(zpool_handle_t *);
extern int zpool_import(nvlist_t *, const char *, const char *);
/*
* Search for pools to import
*/
extern nvlist_t *zpool_find_import(int, char **);
/*
* Miscellaneous pool functions
*/
/*
* Basic handle manipulations. These functions do not create or destroy the
* underlying datasets, only the references to them.
*/
extern zfs_handle_t *zfs_open(const char *, int);
extern void zfs_close(zfs_handle_t *);
extern const char *zfs_get_name(const zfs_handle_t *);
typedef enum {
ZFS_SRC_NONE = 0x1,
ZFS_SRC_DEFAULT = 0x2,
ZFS_SRC_TEMPORARY = 0x4,
ZFS_SRC_LOCAL = 0x8,
ZFS_SRC_INHERITED = 0x10
} zfs_source_t;
#define ZFS_SRC_ALL 0x1f
/*
* Property management functions. Some functions are shared with the kernel,
*/
const char *zfs_prop_to_name(zfs_prop_t);
char *, size_t, int);
char *, size_t);
const char *zfs_prop_values(zfs_prop_t);
int zfs_prop_valid_for_type(zfs_prop_t, int);
const char *zfs_prop_column_name(zfs_prop_t);
const char *zfs_prop_column_format(zfs_prop_t);
char **badopt);
#define ZFS_MOUNTPOINT_NONE "none"
#define ZFS_MOUNTPOINT_LEGACY "legacy"
/*
* Iterator functions.
*/
typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
extern int zfs_iter_root(zfs_iter_f, void *);
/*
* Functions to create and destroy datasets.
*/
extern int zfs_create(const char *, zfs_type_t, const char *, const char *);
extern int zfs_destroy(zfs_handle_t *);
extern int zfs_clone(zfs_handle_t *, const char *);
extern int zfs_snapshot(const char *);
extern int zfs_rename(zfs_handle_t *, const char *);
extern int zfs_restore(const char *, int, int, int);
/*
* Miscellaneous functions.
*/
extern const char *zfs_type_to_name(zfs_type_t);
extern void zfs_refresh_properties(zfs_handle_t *);
extern int zfs_name_valid(const char *, zfs_type_t);
/*
* Mount support functions.
*/
extern int zfs_is_mounted(zfs_handle_t *, char **);
extern int zfs_mount(zfs_handle_t *, const char *, int);
extern int zfs_unmount(zfs_handle_t *, const char *, int);
extern int zfs_unmountall(zfs_handle_t *, int);
/*
* Share support functions.
*/
extern int zfs_is_shared(zfs_handle_t *, char **);
extern int zfs_share(zfs_handle_t *);
extern int zfs_unshare(zfs_handle_t *, const char *);
extern int zfs_unshareall(zfs_handle_t *);
/*
* For clients that need to capture error output.
*/
extern void zfs_set_error_handler(void (*)(const char *, va_list));
/*
* When dealing with nvlists, verify() is extremely useful
*/
#ifdef NDEBUG
#else
#endif
/*
* Utility function to convert a number to a human-readable form.
*/
extern int zfs_nicestrtonum(const char *, uint64_t *);
/*
* Pool destroy special. Remove the device information without destroying
* the underlying dataset.
*/
extern int zfs_remove_link(zfs_handle_t *);
/*
* Given a device or file, determine if it is part of a pool.
*/
/*
* ftyp special. Read the label from a given device.
*/
/*
* Create and remove zvol /dev links
*/
extern int zpool_create_zvol_links(zpool_handle_t *);
extern int zpool_remove_zvol_links(zpool_handle_t *);
/*
* zoneadmd hack
*/
extern void zfs_init(void);
/*
* Useful defines
*/
#ifndef TRUE
#define TRUE 1
#endif
#ifndef FALSE
#define FALSE 0
#endif
#ifdef __cplusplus
}
#endif
#endif /* _LIBZFS_H */