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