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