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