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