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 /* 23 * Copyright 2007 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 * libzfs errors 52 */ 53 enum { 54 EZFS_NOMEM = 2000, /* out of memory */ 55 EZFS_BADPROP, /* invalid property value */ 56 EZFS_PROPREADONLY, /* cannot set readonly property */ 57 EZFS_PROPTYPE, /* property does not apply to dataset type */ 58 EZFS_PROPNONINHERIT, /* property is not inheritable */ 59 EZFS_PROPSPACE, /* bad quota or reservation */ 60 EZFS_BADTYPE, /* dataset is not of appropriate type */ 61 EZFS_BUSY, /* pool or dataset is busy */ 62 EZFS_EXISTS, /* pool or dataset already exists */ 63 EZFS_NOENT, /* no such pool or dataset */ 64 EZFS_BADSTREAM, /* bad backup stream */ 65 EZFS_DSREADONLY, /* dataset is readonly */ 66 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 67 EZFS_VOLHASDATA, /* volume already contains data */ 68 EZFS_INVALIDNAME, /* invalid dataset name */ 69 EZFS_BADRESTORE, /* unable to restore to destination */ 70 EZFS_BADBACKUP, /* backup failed */ 71 EZFS_BADTARGET, /* bad attach/detach/replace target */ 72 EZFS_NODEVICE, /* no such device in pool */ 73 EZFS_BADDEV, /* invalid device to add */ 74 EZFS_NOREPLICAS, /* no valid replicas */ 75 EZFS_RESILVERING, /* currently resilvering */ 76 EZFS_BADVERSION, /* unsupported version */ 77 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 78 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 79 EZFS_BADPATH, /* must be an absolute path */ 80 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 81 EZFS_ZONED, /* used improperly in local zone */ 82 EZFS_MOUNTFAILED, /* failed to mount dataset */ 83 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 84 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 85 EZFS_SHARENFSFAILED, /* share(1M) failed */ 86 EZFS_DEVLINKS, /* failed to create zvol links */ 87 EZFS_PERM, /* permission denied */ 88 EZFS_NOSPC, /* out of space */ 89 EZFS_IO, /* I/O error */ 90 EZFS_INTR, /* signal received */ 91 EZFS_ISSPARE, /* device is a hot spare */ 92 EZFS_INVALCONFIG, /* invalid vdev configuration */ 93 EZFS_RECURSIVE, /* recursive dependency */ 94 EZFS_NOHISTORY, /* no history object */ 95 EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 96 EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 97 EZFS_UNKNOWN /* unknown error */ 98 }; 99 100 /* 101 * Basic handle types 102 */ 103 typedef struct zfs_handle zfs_handle_t; 104 typedef struct zpool_handle zpool_handle_t; 105 typedef struct libzfs_handle libzfs_handle_t; 106 107 /* 108 * Library initialization 109 */ 110 extern libzfs_handle_t *libzfs_init(void); 111 extern void libzfs_fini(libzfs_handle_t *); 112 113 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 114 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 115 116 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 117 118 extern int libzfs_errno(libzfs_handle_t *); 119 extern const char *libzfs_error_action(libzfs_handle_t *); 120 extern const char *libzfs_error_description(libzfs_handle_t *); 121 122 /* 123 * Basic handle functions 124 */ 125 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 126 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 127 extern void zpool_close(zpool_handle_t *); 128 extern const char *zpool_get_name(zpool_handle_t *); 129 extern uint64_t zpool_get_guid(zpool_handle_t *); 130 extern uint64_t zpool_get_space_used(zpool_handle_t *); 131 extern uint64_t zpool_get_space_total(zpool_handle_t *); 132 extern int zpool_get_root(zpool_handle_t *, char *, size_t); 133 extern int zpool_get_state(zpool_handle_t *); 134 extern uint64_t zpool_get_version(zpool_handle_t *); 135 136 /* 137 * Iterate over all active pools in the system. 138 */ 139 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 140 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 141 142 /* 143 * Functions to create and destroy pools 144 */ 145 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 146 const char *); 147 extern int zpool_destroy(zpool_handle_t *); 148 extern int zpool_add(zpool_handle_t *, nvlist_t *); 149 150 /* 151 * Functions to manipulate pool and vdev state 152 */ 153 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 154 155 extern int zpool_vdev_online(zpool_handle_t *, const char *); 156 extern int zpool_vdev_offline(zpool_handle_t *, const char *, int); 157 extern int zpool_vdev_attach(zpool_handle_t *, const char *, const char *, 158 nvlist_t *, int); 159 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 160 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 161 extern int zpool_clear(zpool_handle_t *, const char *); 162 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 163 164 /* 165 * Pool health statistics. 166 */ 167 typedef enum { 168 /* 169 * The following correspond to faults as defined in the (fault.fs.zfs.*) 170 * event namespace. Each is associated with a corresponding message ID. 171 */ 172 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 173 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 174 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 175 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 176 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 177 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 178 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 179 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 180 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 181 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 182 183 /* 184 * The following are not faults per se, but still an error possibly 185 * requiring administrative attention. There is no corresponding 186 * message ID. 187 */ 188 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 189 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 190 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 191 192 /* 193 * Finally, the following indicates a healthy pool. 194 */ 195 ZPOOL_STATUS_OK 196 } zpool_status_t; 197 198 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 199 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 200 201 /* 202 * Statistics and configuration functions. 203 */ 204 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 205 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 206 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 207 208 /* 209 * Import and export functions 210 */ 211 extern int zpool_export(zpool_handle_t *); 212 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 213 const char *); 214 215 /* 216 * Search for pools to import 217 */ 218 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 219 220 /* 221 * Miscellaneous pool functions 222 */ 223 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 224 extern int zpool_upgrade(zpool_handle_t *); 225 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 226 extern void zpool_log_history(libzfs_handle_t *, int, char **, const char *, 227 boolean_t, boolean_t); 228 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 229 size_t len); 230 231 /* 232 * Basic handle manipulations. These functions do not create or destroy the 233 * underlying datasets, only the references to them. 234 */ 235 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 236 extern void zfs_close(zfs_handle_t *); 237 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 238 extern const char *zfs_get_name(const zfs_handle_t *); 239 240 typedef enum { 241 ZFS_SRC_NONE = 0x1, 242 ZFS_SRC_DEFAULT = 0x2, 243 ZFS_SRC_TEMPORARY = 0x4, 244 ZFS_SRC_LOCAL = 0x8, 245 ZFS_SRC_INHERITED = 0x10 246 } zfs_source_t; 247 248 #define ZFS_SRC_ALL 0x1f 249 250 /* 251 * Property management functions. Some functions are shared with the kernel, 252 * and are found in sys/fs/zfs.h. 253 */ 254 extern const char *zfs_prop_to_name(zfs_prop_t); 255 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 256 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 257 zfs_source_t *, char *, size_t, boolean_t); 258 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 259 zfs_source_t *, char *, size_t); 260 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 261 extern const char *zfs_prop_get_string(zfs_handle_t *, zfs_prop_t); 262 extern int zfs_prop_inherit(zfs_handle_t *, const char *); 263 extern const char *zfs_prop_values(zfs_prop_t); 264 extern int zfs_prop_valid_for_type(zfs_prop_t, int); 265 extern const char *zfs_prop_default_string(zfs_prop_t prop); 266 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 267 extern int zfs_prop_is_string(zfs_prop_t prop); 268 extern const char *zfs_prop_column_name(zfs_prop_t); 269 extern boolean_t zfs_prop_align_right(zfs_prop_t); 270 271 typedef struct zfs_proplist { 272 zfs_prop_t pl_prop; 273 char *pl_user_prop; 274 struct zfs_proplist *pl_next; 275 boolean_t pl_all; 276 size_t pl_width; 277 boolean_t pl_fixed; 278 } zfs_proplist_t; 279 280 extern int zfs_get_proplist(libzfs_handle_t *, char *, zfs_proplist_t **); 281 extern void zfs_free_proplist(zfs_proplist_t *); 282 extern int zfs_expand_proplist(zfs_handle_t *, zfs_proplist_t **); 283 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 284 285 #define ZFS_MOUNTPOINT_NONE "none" 286 #define ZFS_MOUNTPOINT_LEGACY "legacy" 287 288 /* 289 * Iterator functions. 290 */ 291 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 292 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 293 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 294 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 295 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 296 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 297 298 /* 299 * Functions to create and destroy datasets. 300 */ 301 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 302 nvlist_t *); 303 extern int zfs_destroy(zfs_handle_t *); 304 extern int zfs_destroy_snaps(zfs_handle_t *, char *); 305 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 306 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t); 307 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 308 extern int zfs_rename(zfs_handle_t *, const char *); 309 extern int zfs_send(zfs_handle_t *, const char *); 310 extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int, 311 boolean_t); 312 extern int zfs_promote(zfs_handle_t *); 313 314 /* 315 * Miscellaneous functions. 316 */ 317 extern const char *zfs_type_to_name(zfs_type_t); 318 extern void zfs_refresh_properties(zfs_handle_t *); 319 extern int zfs_name_valid(const char *, zfs_type_t); 320 extern int zfs_disable(zfs_handle_t *); 321 extern int zfs_enable(zfs_handle_t *); 322 323 /* 324 * Mount support functions. 325 */ 326 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 327 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 328 extern int zfs_mount(zfs_handle_t *, const char *, int); 329 extern int zfs_unmount(zfs_handle_t *, const char *, int); 330 extern int zfs_unmountall(zfs_handle_t *, int); 331 332 /* 333 * Share support functions. 334 */ 335 extern boolean_t zfs_is_shared(zfs_handle_t *); 336 extern int zfs_share(zfs_handle_t *); 337 extern int zfs_unshare(zfs_handle_t *); 338 339 /* 340 * Protocol-specifc share support functions. 341 */ 342 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 343 extern int zfs_share_nfs(zfs_handle_t *); 344 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 345 extern int zfs_unshareall_nfs(zfs_handle_t *); 346 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 347 extern int zfs_share_iscsi(zfs_handle_t *); 348 extern int zfs_unshare_iscsi(zfs_handle_t *); 349 350 /* 351 * When dealing with nvlists, verify() is extremely useful 352 */ 353 #ifdef NDEBUG 354 #define verify(EX) ((void)(EX)) 355 #else 356 #define verify(EX) assert(EX) 357 #endif 358 359 /* 360 * Utility function to convert a number to a human-readable form. 361 */ 362 extern void zfs_nicenum(uint64_t, char *, size_t); 363 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 364 365 /* 366 * Pool destroy special. Remove the device information without destroying 367 * the underlying dataset. 368 */ 369 extern int zfs_remove_link(zfs_handle_t *); 370 371 /* 372 * Given a device or file, determine if it is part of a pool. 373 */ 374 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 375 boolean_t *); 376 377 /* 378 * ftyp special. Read the label from a given device. 379 */ 380 extern int zpool_read_label(int, nvlist_t **); 381 382 /* 383 * Create and remove zvol /dev links. 384 */ 385 extern int zpool_create_zvol_links(zpool_handle_t *); 386 extern int zpool_remove_zvol_links(zpool_handle_t *); 387 388 /* 389 * Enable and disable datasets within a pool by mounting/unmounting and 390 * sharing/unsharing them. 391 */ 392 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 393 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 394 395 #ifdef __cplusplus 396 } 397 #endif 398 399 #endif /* _LIBZFS_H */ 400