1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5fa9e4066Sahrens * Common Development and Distribution License, Version 1.0 only 6fa9e4066Sahrens * (the "License"). You may not use this file except in compliance 7fa9e4066Sahrens * with the License. 8fa9e4066Sahrens * 9fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 11fa9e4066Sahrens * See the License for the specific language governing permissions 12fa9e4066Sahrens * and limitations under the License. 13fa9e4066Sahrens * 14fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 15fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 17fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 18fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 19fa9e4066Sahrens * 20fa9e4066Sahrens * CDDL HEADER END 21fa9e4066Sahrens */ 22fa9e4066Sahrens /* 23fa9e4066Sahrens * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24fa9e4066Sahrens * Use is subject to license terms. 25fa9e4066Sahrens */ 26fa9e4066Sahrens 27fa9e4066Sahrens #ifndef _LIBZFS_H 28fa9e4066Sahrens #define _LIBZFS_H 29fa9e4066Sahrens 30fa9e4066Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 31fa9e4066Sahrens 32fa9e4066Sahrens #include <assert.h> 33fa9e4066Sahrens #include <libnvpair.h> 34fa9e4066Sahrens #include <sys/param.h> 35fa9e4066Sahrens #include <sys/types.h> 36fa9e4066Sahrens #include <sys/varargs.h> 37fa9e4066Sahrens #include <sys/fs/zfs.h> 38fa9e4066Sahrens 39fa9e4066Sahrens #ifdef __cplusplus 40fa9e4066Sahrens extern "C" { 41fa9e4066Sahrens #endif 42fa9e4066Sahrens 43fa9e4066Sahrens /* 44fa9e4066Sahrens * Miscellaneous ZFS constants 45fa9e4066Sahrens */ 46fa9e4066Sahrens #define ZFS_MAXNAMELEN MAXNAMELEN 47fa9e4066Sahrens #define ZPOOL_MAXNAMELEN MAXNAMELEN 48fa9e4066Sahrens #define ZFS_MAXPROPLEN MAXPATHLEN 49fa9e4066Sahrens 50fa9e4066Sahrens /* 51fa9e4066Sahrens * Basic handle types 52fa9e4066Sahrens */ 53fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 54fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 55fa9e4066Sahrens 56fa9e4066Sahrens /* 57fa9e4066Sahrens * Basic handle functions 58fa9e4066Sahrens */ 59fa9e4066Sahrens extern zpool_handle_t *zpool_open(const char *); 60fa9e4066Sahrens extern zpool_handle_t *zpool_open_canfail(const char *); 61fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 62fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 63fa9e4066Sahrens extern uint64_t zpool_get_guid(zpool_handle_t *); 64fa9e4066Sahrens extern uint64_t zpool_get_space_used(zpool_handle_t *); 65fa9e4066Sahrens extern uint64_t zpool_get_space_total(zpool_handle_t *); 66fa9e4066Sahrens extern int zpool_get_root(zpool_handle_t *, char *, size_t); 67fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 68fa9e4066Sahrens 69fa9e4066Sahrens /* 70fa9e4066Sahrens * Iterate over all active pools in the system. 71fa9e4066Sahrens */ 72fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 73fa9e4066Sahrens extern int zpool_iter(zpool_iter_f, void *); 74fa9e4066Sahrens 75fa9e4066Sahrens /* 76fa9e4066Sahrens * Functions to create and destroy pools 77fa9e4066Sahrens */ 78fa9e4066Sahrens extern int zpool_create(const char *, nvlist_t *, const char *); 79fa9e4066Sahrens extern int zpool_destroy(zpool_handle_t *); 80fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 81fa9e4066Sahrens 82fa9e4066Sahrens /* 83fa9e4066Sahrens * Functions to manipulate pool and vdev state 84fa9e4066Sahrens */ 85fa9e4066Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 86fa9e4066Sahrens 87fa9e4066Sahrens extern int zpool_vdev_online(zpool_handle_t *, const char *); 88fa9e4066Sahrens extern int zpool_vdev_offline(zpool_handle_t *, const char *); 89fa9e4066Sahrens extern int zpool_vdev_attach(zpool_handle_t *, const char *, const char *, 90fa9e4066Sahrens nvlist_t *, int); 91fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 92fa9e4066Sahrens 93fa9e4066Sahrens /* 94fa9e4066Sahrens * Pool health statistics. 95fa9e4066Sahrens */ 96fa9e4066Sahrens typedef enum { 97fa9e4066Sahrens /* 98fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 99*b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 100fa9e4066Sahrens */ 101fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 102fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 103fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 104fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 105*b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 106fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 107fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 108fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 109fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 110fa9e4066Sahrens ZPOOL_STATUS_VERSION_MISMATCH, /* bad on-disk version */ 111fa9e4066Sahrens 112fa9e4066Sahrens /* 113fa9e4066Sahrens * The following are not faults per se, but still an error possibly 114*b81d61a6Slling * requiring administrative attention. There is no corresponding 115fa9e4066Sahrens * message ID. 116fa9e4066Sahrens */ 117fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 118fa9e4066Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 119fa9e4066Sahrens 120fa9e4066Sahrens /* 121fa9e4066Sahrens * Finally, the following indicates a healthy pool. 122fa9e4066Sahrens */ 123fa9e4066Sahrens ZPOOL_STATUS_OK 124fa9e4066Sahrens } zpool_status_t; 125fa9e4066Sahrens 126fa9e4066Sahrens extern zpool_status_t zpool_get_status(zpool_handle_t *, char **msgid); 127fa9e4066Sahrens extern zpool_status_t zpool_import_status(nvlist_t *, char **msgid); 128fa9e4066Sahrens 129fa9e4066Sahrens /* 130fa9e4066Sahrens * Statistics and configuration functions. 131fa9e4066Sahrens */ 132088e9d47Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **oldconfig); 133088e9d47Seschrock extern int zpool_refresh_stats(zpool_handle_t *); 134fa9e4066Sahrens 135fa9e4066Sahrens /* 136fa9e4066Sahrens * Import and export functions 137fa9e4066Sahrens */ 138fa9e4066Sahrens extern int zpool_export(zpool_handle_t *); 139fa9e4066Sahrens extern int zpool_import(nvlist_t *, const char *, const char *); 140fa9e4066Sahrens 141fa9e4066Sahrens /* 142fa9e4066Sahrens * Search for pools to import 143fa9e4066Sahrens */ 144fa9e4066Sahrens extern nvlist_t *zpool_find_import(int argc, char **argv); 145fa9e4066Sahrens 146fa9e4066Sahrens /* 147fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 148fa9e4066Sahrens * underlying datasets, only the references to them. 149fa9e4066Sahrens */ 150fa9e4066Sahrens extern zfs_handle_t *zfs_open(const char *, int); 151fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 152fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 153fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 154fa9e4066Sahrens 155fa9e4066Sahrens typedef enum { 156fa9e4066Sahrens ZFS_SRC_NONE = 0x1, 157fa9e4066Sahrens ZFS_SRC_DEFAULT = 0x2, 158fa9e4066Sahrens ZFS_SRC_TEMPORARY = 0x4, 159fa9e4066Sahrens ZFS_SRC_LOCAL = 0x8, 160fa9e4066Sahrens ZFS_SRC_INHERITED = 0x10 161fa9e4066Sahrens } zfs_source_t; 162fa9e4066Sahrens 163fa9e4066Sahrens #define ZFS_SRC_ALL 0x1f 164fa9e4066Sahrens 165fa9e4066Sahrens /* 166fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 167*b81d61a6Slling * and are found in sys/fs/zfs.h. 168fa9e4066Sahrens */ 169fa9e4066Sahrens const char *zfs_prop_to_name(zfs_prop_t); 170fa9e4066Sahrens int zfs_prop_set(zfs_handle_t *, zfs_prop_t, const char *); 171fa9e4066Sahrens int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, zfs_source_t *, 172fa9e4066Sahrens char *, size_t, int); 173fa9e4066Sahrens int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, zfs_source_t *, 174fa9e4066Sahrens char *, size_t); 175fa9e4066Sahrens uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 176fa9e4066Sahrens int zfs_prop_validate(zfs_prop_t, const char *, uint64_t *); 177fa9e4066Sahrens int zfs_prop_inheritable(zfs_prop_t); 178fa9e4066Sahrens int zfs_prop_inherit(zfs_handle_t *, zfs_prop_t); 179fa9e4066Sahrens const char *zfs_prop_values(zfs_prop_t); 180fa9e4066Sahrens int zfs_prop_valid_for_type(zfs_prop_t, int); 181fa9e4066Sahrens void zfs_prop_default_string(zfs_prop_t prop, char *buf, size_t buflen); 182fa9e4066Sahrens uint64_t zfs_prop_default_numeric(zfs_prop_t); 183fa9e4066Sahrens int zfs_prop_is_string(zfs_prop_t prop); 184fa9e4066Sahrens const char *zfs_prop_column_name(zfs_prop_t); 185fa9e4066Sahrens const char *zfs_prop_column_format(zfs_prop_t); 18607ba0419Seschrock int zfs_get_proplist(char *fields, zfs_prop_t *proplist, int max, int *count, 18707ba0419Seschrock char **badopt); 188fa9e4066Sahrens 189fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 190fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 191fa9e4066Sahrens 192fa9e4066Sahrens /* 193fa9e4066Sahrens * Iterator functions. 194fa9e4066Sahrens */ 195fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 196fa9e4066Sahrens extern int zfs_iter_root(zfs_iter_f, void *); 197fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 198fa9e4066Sahrens extern int zfs_iter_dependents(zfs_handle_t *, zfs_iter_f, void *); 199fa9e4066Sahrens 200fa9e4066Sahrens /* 201fa9e4066Sahrens * Functions to create and destroy datasets. 202fa9e4066Sahrens */ 203fa9e4066Sahrens extern int zfs_create(const char *, zfs_type_t, const char *, const char *); 204fa9e4066Sahrens extern int zfs_destroy(zfs_handle_t *); 205fa9e4066Sahrens extern int zfs_clone(zfs_handle_t *, const char *); 206fa9e4066Sahrens extern int zfs_snapshot(const char *); 207fa9e4066Sahrens extern int zfs_rollback(zfs_handle_t *); 208fa9e4066Sahrens extern int zfs_rename(zfs_handle_t *, const char *); 209fa9e4066Sahrens extern int zfs_backup(zfs_handle_t *, zfs_handle_t *); 210fa9e4066Sahrens extern int zfs_restore(const char *, int, int, int); 211fa9e4066Sahrens 212fa9e4066Sahrens /* 213fa9e4066Sahrens * Miscellaneous functions. 214fa9e4066Sahrens */ 215fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 216fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 217fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 218fa9e4066Sahrens 219fa9e4066Sahrens /* 220fa9e4066Sahrens * Mount support functions. 221fa9e4066Sahrens */ 222fa9e4066Sahrens extern int zfs_is_mounted(zfs_handle_t *, char **); 223fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 224fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 225fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 226fa9e4066Sahrens 227fa9e4066Sahrens /* 228fa9e4066Sahrens * Share support functions. 229fa9e4066Sahrens */ 230fa9e4066Sahrens extern int zfs_is_shared(zfs_handle_t *, char **); 231fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 232fa9e4066Sahrens extern int zfs_unshare(zfs_handle_t *, const char *); 233fa9e4066Sahrens extern int zfs_unshareall(zfs_handle_t *); 234fa9e4066Sahrens 235fa9e4066Sahrens /* 236fa9e4066Sahrens * For clients that need to capture error output. 237fa9e4066Sahrens */ 238fa9e4066Sahrens extern void zfs_set_error_handler(void (*)(const char *, va_list)); 239fa9e4066Sahrens 240fa9e4066Sahrens /* 241fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 242fa9e4066Sahrens */ 243fa9e4066Sahrens #ifdef NDEBUG 244fa9e4066Sahrens #define verify(EX) ((void)(EX)) 245fa9e4066Sahrens #else 246fa9e4066Sahrens #define verify(EX) assert(EX) 247fa9e4066Sahrens #endif 248fa9e4066Sahrens 249fa9e4066Sahrens /* 250fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 251fa9e4066Sahrens */ 252fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 253fa9e4066Sahrens extern int zfs_nicestrtonum(const char *, uint64_t *); 254fa9e4066Sahrens 255fa9e4066Sahrens /* 256fa9e4066Sahrens * Pool destroy special. Remove the device information without destroying 257fa9e4066Sahrens * the underlying dataset. 258fa9e4066Sahrens */ 259fa9e4066Sahrens extern int zfs_remove_link(zfs_handle_t *); 260fa9e4066Sahrens 261fa9e4066Sahrens /* 262fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 263fa9e4066Sahrens */ 264fa9e4066Sahrens extern int zpool_in_use(int fd, char **state, 265fa9e4066Sahrens char **name); 266fa9e4066Sahrens 267fa9e4066Sahrens /* 268fa9e4066Sahrens * ftyp special. Read the label from a given device. 269fa9e4066Sahrens */ 270fa9e4066Sahrens extern nvlist_t *zpool_read_label(int fd); 271fa9e4066Sahrens 272fa9e4066Sahrens /* 273fa9e4066Sahrens * Create and remove zvol /dev links 274fa9e4066Sahrens */ 275fa9e4066Sahrens extern int zpool_create_zvol_links(zpool_handle_t *); 276fa9e4066Sahrens extern int zpool_remove_zvol_links(zpool_handle_t *); 277fa9e4066Sahrens 278fa9e4066Sahrens /* 279fa9e4066Sahrens * zoneadmd hack 280fa9e4066Sahrens */ 281fa9e4066Sahrens extern void zfs_init(void); 282fa9e4066Sahrens 283fa9e4066Sahrens /* 284fa9e4066Sahrens * Useful defines 285fa9e4066Sahrens */ 286fa9e4066Sahrens #ifndef TRUE 287fa9e4066Sahrens #define TRUE 1 288fa9e4066Sahrens #endif 289fa9e4066Sahrens #ifndef FALSE 290fa9e4066Sahrens #define FALSE 0 291fa9e4066Sahrens #endif 292fa9e4066Sahrens 293fa9e4066Sahrens #ifdef __cplusplus 294fa9e4066Sahrens } 295fa9e4066Sahrens #endif 296fa9e4066Sahrens 297fa9e4066Sahrens #endif /* _LIBZFS_H */ 298