diff options
Diffstat (limited to 'usr/src/lib/libzfs/common/libzfs.h')
| -rw-r--r-- | usr/src/lib/libzfs/common/libzfs.h | 298 |
1 files changed, 298 insertions, 0 deletions
diff --git a/usr/src/lib/libzfs/common/libzfs.h b/usr/src/lib/libzfs/common/libzfs.h new file mode 100644 index 0000000000..a9caff662c --- /dev/null +++ b/usr/src/lib/libzfs/common/libzfs.h @@ -0,0 +1,298 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (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 + * or http://www.opensolaris.org/os/licensing. + * 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 2005 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> +#include <sys/param.h> +#include <sys/types.h> +#include <sys/varargs.h> +#include <sys/fs/zfs.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 uint64_t zpool_get_guid(zpool_handle_t *); +extern uint64_t zpool_get_space_used(zpool_handle_t *); +extern uint64_t zpool_get_space_total(zpool_handle_t *); +extern int zpool_get_root(zpool_handle_t *, char *, size_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 *); +extern int zpool_add(zpool_handle_t *, nvlist_t *); + +/* + * Functions to manipulate pool and vdev state + */ +extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); + +extern int zpool_vdev_online(zpool_handle_t *, const char *); +extern int zpool_vdev_offline(zpool_handle_t *, const char *); +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 *); + +/* + * Pool health statistics. + */ +typedef enum { + /* + * The following correspond to faults as defined in the (fault.fs.zfs.*) + * event namespace. Each is associated with a correponding 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 lable 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 adminsitrative 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. + */ + ZPOOL_STATUS_OK +} zpool_status_t; + +extern zpool_status_t zpool_get_status(zpool_handle_t *, char **msgid); +extern zpool_status_t zpool_import_status(nvlist_t *, char **msgid); + +/* + * Statistics and configuration functions. + */ +extern nvlist_t *zpool_get_config(zpool_handle_t *); +extern int zpool_refresh_stats(zpool_handle_t *, + nvlist_t **oldconfig, nvlist_t **newconfig); + +/* + * 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 argc, char **argv); + +/* + * 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 zfs_type_t zfs_get_type(const 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, + * and are found in fs/zfs.h. + */ +const char *zfs_prop_to_name(zfs_prop_t); +int zfs_prop_set(zfs_handle_t *, zfs_prop_t, const char *); +int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, zfs_source_t *, + char *, size_t, int); +int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, zfs_source_t *, + char *, size_t); +uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); +int zfs_prop_validate(zfs_prop_t, const char *, uint64_t *); +int zfs_prop_inheritable(zfs_prop_t); +int zfs_prop_inherit(zfs_handle_t *, zfs_prop_t); +const char *zfs_prop_values(zfs_prop_t); +int zfs_prop_valid_for_type(zfs_prop_t, int); +void zfs_prop_default_string(zfs_prop_t prop, char *buf, size_t buflen); +uint64_t zfs_prop_default_numeric(zfs_prop_t); +int zfs_prop_is_string(zfs_prop_t prop); +const char *zfs_prop_column_name(zfs_prop_t); +const char *zfs_prop_column_format(zfs_prop_t); +char ** zfs_prop_column_subopts(void); +char ** zfs_prop_column_short_subopts(void); + +#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 *); +extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); +extern int zfs_iter_dependents(zfs_handle_t *, 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_rollback(zfs_handle_t *); +extern int zfs_rename(zfs_handle_t *, const char *); +extern int zfs_backup(zfs_handle_t *, zfs_handle_t *); +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 +#define verify(EX) ((void)(EX)) +#else +#define verify(EX) assert(EX) +#endif + +/* + * Utility function to convert a number to a human-readable form. + */ +extern void zfs_nicenum(uint64_t, char *, size_t); +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. + */ +extern int zpool_in_use(int fd, char **state, + char **name); + +/* + * ftyp special. Read the label from a given device. + */ +extern nvlist_t *zpool_read_label(int fd); + +/* + * 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 */ |