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_POOLPROPS, /* couldn't retrieve pool props */ 98 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 99 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 100 EZFS_NAMETOOLONG, /* dataset name is too long */ 101 EZFS_UNKNOWN 102 }; 103 104 /* 105 * Basic handle types 106 */ 107 typedef struct zfs_handle zfs_handle_t; 108 typedef struct zpool_handle zpool_handle_t; 109 typedef struct libzfs_handle libzfs_handle_t; 110 111 /* 112 * Library initialization 113 */ 114 extern libzfs_handle_t *libzfs_init(void); 115 extern void libzfs_fini(libzfs_handle_t *); 116 117 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 118 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 119 120 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 121 122 extern int libzfs_errno(libzfs_handle_t *); 123 extern const char *libzfs_error_action(libzfs_handle_t *); 124 extern const char *libzfs_error_description(libzfs_handle_t *); 125 126 /* 127 * Basic handle functions 128 */ 129 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 130 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 131 extern void zpool_close(zpool_handle_t *); 132 extern const char *zpool_get_name(zpool_handle_t *); 133 extern uint64_t zpool_get_guid(zpool_handle_t *); 134 extern uint64_t zpool_get_space_used(zpool_handle_t *); 135 extern uint64_t zpool_get_space_total(zpool_handle_t *); 136 extern int zpool_get_root(zpool_handle_t *, char *, size_t); 137 extern int zpool_get_state(zpool_handle_t *); 138 extern uint64_t zpool_get_version(zpool_handle_t *); 139 140 /* 141 * Iterate over all active pools in the system. 142 */ 143 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 144 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 145 146 /* 147 * Functions to create and destroy pools 148 */ 149 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 150 const char *); 151 extern int zpool_destroy(zpool_handle_t *); 152 extern int zpool_add(zpool_handle_t *, nvlist_t *); 153 154 /* 155 * Functions to manipulate pool and vdev state 156 */ 157 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 158 159 extern int zpool_vdev_online(zpool_handle_t *, const char *); 160 extern int zpool_vdev_offline(zpool_handle_t *, const char *, int); 161 extern int zpool_vdev_attach(zpool_handle_t *, const char *, const char *, 162 nvlist_t *, int); 163 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 164 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 165 extern int zpool_clear(zpool_handle_t *, const char *); 166 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 167 168 /* 169 * Functions to manage pool properties 170 */ 171 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 172 extern int zpool_get_prop(zpool_handle_t *, zfs_prop_t, char *, 173 size_t proplen, zfs_source_t *); 174 extern const char *zpool_prop_to_name(zpool_prop_t); 175 extern const char *zpool_prop_values(zpool_prop_t); 176 177 /* 178 * Pool health statistics. 179 */ 180 typedef enum { 181 /* 182 * The following correspond to faults as defined in the (fault.fs.zfs.*) 183 * event namespace. Each is associated with a corresponding message ID. 184 */ 185 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 186 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 187 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 188 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 189 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 190 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 191 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 192 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 193 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 194 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 195 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 196 197 /* 198 * The following are not faults per se, but still an error possibly 199 * requiring administrative attention. There is no corresponding 200 * message ID. 201 */ 202 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 203 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 204 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 205 206 /* 207 * Finally, the following indicates a healthy pool. 208 */ 209 ZPOOL_STATUS_OK 210 } zpool_status_t; 211 212 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 213 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 214 215 /* 216 * Statistics and configuration functions. 217 */ 218 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 219 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 220 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 221 222 /* 223 * Import and export functions 224 */ 225 extern int zpool_export(zpool_handle_t *); 226 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 227 const char *); 228 229 /* 230 * Search for pools to import 231 */ 232 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 233 234 /* 235 * Miscellaneous pool functions 236 */ 237 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 238 extern int zpool_upgrade(zpool_handle_t *); 239 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 240 extern void zpool_log_history(libzfs_handle_t *, int, char **, const char *, 241 boolean_t, boolean_t); 242 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 243 size_t len); 244 245 /* 246 * Basic handle manipulations. These functions do not create or destroy the 247 * underlying datasets, only the references to them. 248 */ 249 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 250 extern void zfs_close(zfs_handle_t *); 251 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 252 extern const char *zfs_get_name(const zfs_handle_t *); 253 254 /* 255 * Property management functions. Some functions are shared with the kernel, 256 * and are found in sys/fs/zfs.h. 257 */ 258 extern const char *zfs_prop_to_name(zfs_prop_t); 259 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 260 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 261 zfs_source_t *, char *, size_t, boolean_t); 262 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 263 zfs_source_t *, char *, size_t); 264 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 265 extern const char *zfs_prop_get_string(zfs_handle_t *, zfs_prop_t); 266 extern int zfs_prop_inherit(zfs_handle_t *, const char *); 267 extern const char *zfs_prop_values(zfs_prop_t); 268 extern int zfs_prop_valid_for_type(zfs_prop_t, int); 269 extern const char *zfs_prop_default_string(zfs_prop_t prop); 270 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 271 extern int zfs_prop_is_string(zfs_prop_t prop); 272 extern const char *zfs_prop_column_name(zfs_prop_t); 273 extern boolean_t zfs_prop_align_right(zfs_prop_t); 274 extern void nicebool(int value, char *buf, size_t buflen); 275 276 typedef struct zfs_proplist { 277 zfs_prop_t pl_prop; 278 char *pl_user_prop; 279 struct zfs_proplist *pl_next; 280 boolean_t pl_all; 281 size_t pl_width; 282 boolean_t pl_fixed; 283 } zfs_proplist_t; 284 285 typedef zfs_proplist_t zpool_proplist_t; 286 287 extern int zfs_get_proplist(libzfs_handle_t *, char *, zfs_proplist_t **); 288 extern int zpool_get_proplist(libzfs_handle_t *, char *, zpool_proplist_t **); 289 extern int zfs_expand_proplist(zfs_handle_t *, zfs_proplist_t **); 290 extern int zpool_expand_proplist(zpool_handle_t *, zpool_proplist_t **); 291 extern void zfs_free_proplist(zfs_proplist_t *); 292 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 293 294 #define ZFS_MOUNTPOINT_NONE "none" 295 #define ZFS_MOUNTPOINT_LEGACY "legacy" 296 297 /* 298 * Functions for printing properties from zfs/zpool 299 */ 300 typedef struct libzfs_get_cbdata { 301 int cb_sources; 302 int cb_columns[4]; 303 int cb_colwidths[5]; 304 boolean_t cb_scripted; 305 boolean_t cb_literal; 306 boolean_t cb_first; 307 zfs_proplist_t *cb_proplist; 308 } libzfs_get_cbdata_t; 309 310 void libzfs_print_one_property(const char *, libzfs_get_cbdata_t *, 311 const char *, const char *, zfs_source_t, const char *); 312 313 #define GET_COL_NAME 1 314 #define GET_COL_PROPERTY 2 315 #define GET_COL_VALUE 3 316 #define GET_COL_SOURCE 4 317 318 /* 319 * Iterator functions. 320 */ 321 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 322 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 323 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 324 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 325 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 326 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 327 328 /* 329 * Functions to create and destroy datasets. 330 */ 331 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 332 nvlist_t *); 333 extern int zfs_destroy(zfs_handle_t *); 334 extern int zfs_destroy_snaps(zfs_handle_t *, char *); 335 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 336 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t); 337 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 338 extern int zfs_rename(zfs_handle_t *, const char *, int); 339 extern int zfs_send(zfs_handle_t *, const char *, int); 340 extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int, 341 boolean_t, int); 342 extern int zfs_promote(zfs_handle_t *); 343 344 /* 345 * Miscellaneous functions. 346 */ 347 extern const char *zfs_type_to_name(zfs_type_t); 348 extern void zfs_refresh_properties(zfs_handle_t *); 349 extern int zfs_name_valid(const char *, zfs_type_t); 350 extern int zfs_disable(zfs_handle_t *); 351 extern int zfs_enable(zfs_handle_t *); 352 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 353 354 /* 355 * Mount support functions. 356 */ 357 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 358 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 359 extern int zfs_mount(zfs_handle_t *, const char *, int); 360 extern int zfs_unmount(zfs_handle_t *, const char *, int); 361 extern int zfs_unmountall(zfs_handle_t *, int); 362 363 /* 364 * Share support functions. 365 */ 366 extern boolean_t zfs_is_shared(zfs_handle_t *); 367 extern int zfs_share(zfs_handle_t *); 368 extern int zfs_unshare(zfs_handle_t *); 369 370 /* 371 * Protocol-specifc share support functions. 372 */ 373 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 374 extern int zfs_share_nfs(zfs_handle_t *); 375 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 376 extern int zfs_unshareall_nfs(zfs_handle_t *); 377 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 378 extern int zfs_share_iscsi(zfs_handle_t *); 379 extern int zfs_unshare_iscsi(zfs_handle_t *); 380 381 /* 382 * When dealing with nvlists, verify() is extremely useful 383 */ 384 #ifdef NDEBUG 385 #define verify(EX) ((void)(EX)) 386 #else 387 #define verify(EX) assert(EX) 388 #endif 389 390 /* 391 * Utility function to convert a number to a human-readable form. 392 */ 393 extern void zfs_nicenum(uint64_t, char *, size_t); 394 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 395 396 /* 397 * Pool destroy special. Remove the device information without destroying 398 * the underlying dataset. 399 */ 400 extern int zfs_remove_link(zfs_handle_t *); 401 402 /* 403 * Given a device or file, determine if it is part of a pool. 404 */ 405 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 406 boolean_t *); 407 408 /* 409 * ftyp special. Read the label from a given device. 410 */ 411 extern int zpool_read_label(int, nvlist_t **); 412 413 /* 414 * Create and remove zvol /dev links. 415 */ 416 extern int zpool_create_zvol_links(zpool_handle_t *); 417 extern int zpool_remove_zvol_links(zpool_handle_t *); 418 419 /* 420 * Enable and disable datasets within a pool by mounting/unmounting and 421 * sharing/unsharing them. 422 */ 423 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 424 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 425 426 #ifdef __cplusplus 427 } 428 #endif 429 430 #endif /* _LIBZFS_H */ 431