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 #include <sys/avl.h> 39 #include <ucred.h> 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 /* 46 * Miscellaneous ZFS constants 47 */ 48 #define ZFS_MAXNAMELEN MAXNAMELEN 49 #define ZPOOL_MAXNAMELEN MAXNAMELEN 50 #define ZFS_MAXPROPLEN MAXPATHLEN 51 52 /* 53 * libzfs errors 54 */ 55 enum { 56 EZFS_NOMEM = 2000, /* out of memory */ 57 EZFS_BADPROP, /* invalid property value */ 58 EZFS_PROPREADONLY, /* cannot set readonly property */ 59 EZFS_PROPTYPE, /* property does not apply to dataset type */ 60 EZFS_PROPNONINHERIT, /* property is not inheritable */ 61 EZFS_PROPSPACE, /* bad quota or reservation */ 62 EZFS_BADTYPE, /* dataset is not of appropriate type */ 63 EZFS_BUSY, /* pool or dataset is busy */ 64 EZFS_EXISTS, /* pool or dataset already exists */ 65 EZFS_NOENT, /* no such pool or dataset */ 66 EZFS_BADSTREAM, /* bad backup stream */ 67 EZFS_DSREADONLY, /* dataset is readonly */ 68 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 69 EZFS_VOLHASDATA, /* volume already contains data */ 70 EZFS_INVALIDNAME, /* invalid dataset name */ 71 EZFS_BADRESTORE, /* unable to restore to destination */ 72 EZFS_BADBACKUP, /* backup failed */ 73 EZFS_BADTARGET, /* bad attach/detach/replace target */ 74 EZFS_NODEVICE, /* no such device in pool */ 75 EZFS_BADDEV, /* invalid device to add */ 76 EZFS_NOREPLICAS, /* no valid replicas */ 77 EZFS_RESILVERING, /* currently resilvering */ 78 EZFS_BADVERSION, /* unsupported version */ 79 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 80 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 81 EZFS_BADPATH, /* must be an absolute path */ 82 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 83 EZFS_ZONED, /* used improperly in local zone */ 84 EZFS_MOUNTFAILED, /* failed to mount dataset */ 85 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 86 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 87 EZFS_SHARENFSFAILED, /* share(1M) failed */ 88 EZFS_DEVLINKS, /* failed to create zvol links */ 89 EZFS_PERM, /* permission denied */ 90 EZFS_NOSPC, /* out of space */ 91 EZFS_IO, /* I/O error */ 92 EZFS_INTR, /* signal received */ 93 EZFS_ISSPARE, /* device is a hot spare */ 94 EZFS_INVALCONFIG, /* invalid vdev configuration */ 95 EZFS_RECURSIVE, /* recursive dependency */ 96 EZFS_NOHISTORY, /* no history object */ 97 EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 98 EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 99 EZFS_POOLPROPS, /* couldn't retrieve pool props */ 100 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 101 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 102 EZFS_NAMETOOLONG, /* dataset name is too long */ 103 EZFS_OPENFAILED, /* open of device failed */ 104 EZFS_NOCAP, /* couldn't get capacity */ 105 EZFS_LABELFAILED, /* write of label failed */ 106 EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 107 EZFS_BADWHO, /* invalid permission who */ 108 EZFS_BADPERM, /* invalid permission */ 109 EZFS_BADPERMSET, /* invalid permission set name */ 110 EZFS_NODELEGATION, /* delegated administration is disabled */ 111 EZFS_PERMRDONLY, /* pemissions are readonly */ 112 EZFS_UNKNOWN 113 }; 114 115 /* 116 * The following data structures are all part 117 * of the zfs_allow_t data structure which is 118 * used for printing 'allow' permissions. 119 * It is a linked list of zfs_allow_t's which 120 * then contain avl tree's for user/group/sets/... 121 * and each one of the entries in those trees have 122 * avl tree's for the permissions they belong to and 123 * whether they are local,descendent or local+descendent 124 * permissions. The AVL trees are used primarily for 125 * sorting purposes, but also so that we can quickly find 126 * a given user and or permission. 127 */ 128 typedef struct zfs_perm_node { 129 avl_node_t z_node; 130 char z_pname[MAXPATHLEN]; 131 } zfs_perm_node_t; 132 133 typedef struct zfs_allow_node { 134 avl_node_t z_node; 135 char z_key[MAXPATHLEN]; /* name, such as joe */ 136 avl_tree_t z_localdescend; /* local+descendent perms */ 137 avl_tree_t z_local; /* local permissions */ 138 avl_tree_t z_descend; /* descendent permissions */ 139 } zfs_allow_node_t; 140 141 typedef struct zfs_allow { 142 struct zfs_allow *z_next; 143 char z_setpoint[MAXPATHLEN]; 144 avl_tree_t z_sets; 145 avl_tree_t z_crperms; 146 avl_tree_t z_user; 147 avl_tree_t z_group; 148 avl_tree_t z_everyone; 149 } zfs_allow_t; 150 151 /* 152 * Basic handle types 153 */ 154 typedef struct zfs_handle zfs_handle_t; 155 typedef struct zpool_handle zpool_handle_t; 156 typedef struct libzfs_handle libzfs_handle_t; 157 158 /* 159 * Library initialization 160 */ 161 extern libzfs_handle_t *libzfs_init(void); 162 extern void libzfs_fini(libzfs_handle_t *); 163 164 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 165 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 166 167 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 168 169 extern int libzfs_errno(libzfs_handle_t *); 170 extern const char *libzfs_error_action(libzfs_handle_t *); 171 extern const char *libzfs_error_description(libzfs_handle_t *); 172 173 /* 174 * Basic handle functions 175 */ 176 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 177 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 178 extern void zpool_close(zpool_handle_t *); 179 extern const char *zpool_get_name(zpool_handle_t *); 180 extern uint64_t zpool_get_guid(zpool_handle_t *); 181 extern uint64_t zpool_get_space_used(zpool_handle_t *); 182 extern uint64_t zpool_get_space_total(zpool_handle_t *); 183 extern int zpool_get_root(zpool_handle_t *, char *, size_t); 184 extern int zpool_get_state(zpool_handle_t *); 185 extern uint64_t zpool_get_version(zpool_handle_t *); 186 187 /* 188 * Iterate over all active pools in the system. 189 */ 190 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 191 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 192 193 /* 194 * Functions to create and destroy pools 195 */ 196 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 197 const char *); 198 extern int zpool_destroy(zpool_handle_t *); 199 extern int zpool_add(zpool_handle_t *, nvlist_t *); 200 201 /* 202 * Functions to manipulate pool and vdev state 203 */ 204 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 205 extern int zpool_clear(zpool_handle_t *, const char *); 206 207 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 208 vdev_state_t *); 209 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 210 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 211 const char *, nvlist_t *, int); 212 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 213 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 214 215 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 216 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 217 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 218 219 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 220 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 221 222 /* 223 * Functions to manage pool properties 224 */ 225 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 226 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 227 size_t proplen, zfs_source_t *); 228 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t); 229 extern const char *zpool_prop_to_name(zpool_prop_t); 230 extern const char *zpool_prop_values(zpool_prop_t); 231 232 /* 233 * Pool health statistics. 234 */ 235 typedef enum { 236 /* 237 * The following correspond to faults as defined in the (fault.fs.zfs.*) 238 * event namespace. Each is associated with a corresponding message ID. 239 */ 240 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 241 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 242 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 243 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 244 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 245 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 246 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 247 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 248 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 249 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 250 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 251 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 252 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 253 254 /* 255 * The following are not faults per se, but still an error possibly 256 * requiring administrative attention. There is no corresponding 257 * message ID. 258 */ 259 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 260 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 261 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 262 263 /* 264 * Finally, the following indicates a healthy pool. 265 */ 266 ZPOOL_STATUS_OK 267 } zpool_status_t; 268 269 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 270 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 271 272 /* 273 * Statistics and configuration functions. 274 */ 275 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 276 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 277 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 278 279 /* 280 * Import and export functions 281 */ 282 extern int zpool_export(zpool_handle_t *); 283 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 284 const char *); 285 286 /* 287 * Search for pools to import 288 */ 289 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 290 291 /* 292 * Miscellaneous pool functions 293 */ 294 struct zfs_cmd; 295 296 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 297 extern int zpool_upgrade(zpool_handle_t *); 298 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 299 extern void zpool_stage_history(libzfs_handle_t *, int, char **, 300 boolean_t zfs_cmd); 301 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 302 size_t len); 303 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 304 /* 305 * Basic handle manipulations. These functions do not create or destroy the 306 * underlying datasets, only the references to them. 307 */ 308 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 309 extern void zfs_close(zfs_handle_t *); 310 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 311 extern const char *zfs_get_name(const zfs_handle_t *); 312 313 /* 314 * Property management functions. Some functions are shared with the kernel, 315 * and are found in sys/fs/zfs.h. 316 */ 317 extern const char *zfs_prop_to_name(zfs_prop_t); 318 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 319 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 320 zfs_source_t *, char *, size_t, boolean_t); 321 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 322 zfs_source_t *, char *, size_t); 323 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 324 extern const char *zfs_prop_get_string(zfs_handle_t *, zfs_prop_t); 325 extern int zfs_prop_inherit(zfs_handle_t *, const char *); 326 extern const char *zfs_prop_values(zfs_prop_t); 327 extern int zfs_prop_valid_for_type(zfs_prop_t, int); 328 extern const char *zfs_prop_default_string(zfs_prop_t prop); 329 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 330 extern int zfs_prop_is_string(zfs_prop_t prop); 331 extern const char *zfs_prop_column_name(zfs_prop_t); 332 extern boolean_t zfs_prop_align_right(zfs_prop_t); 333 334 typedef struct zfs_proplist { 335 zfs_prop_t pl_prop; 336 char *pl_user_prop; 337 struct zfs_proplist *pl_next; 338 boolean_t pl_all; 339 size_t pl_width; 340 boolean_t pl_fixed; 341 } zfs_proplist_t; 342 343 typedef zfs_proplist_t zpool_proplist_t; 344 345 extern int zfs_get_proplist(libzfs_handle_t *, char *, zfs_proplist_t **); 346 extern int zpool_get_proplist(libzfs_handle_t *, char *, zpool_proplist_t **); 347 extern int zfs_expand_proplist(zfs_handle_t *, zfs_proplist_t **); 348 extern int zpool_expand_proplist(zpool_handle_t *, zpool_proplist_t **); 349 extern void zfs_free_proplist(zfs_proplist_t *); 350 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 351 352 #define ZFS_MOUNTPOINT_NONE "none" 353 #define ZFS_MOUNTPOINT_LEGACY "legacy" 354 355 /* 356 * Functions for printing properties from zfs/zpool 357 */ 358 typedef struct libzfs_get_cbdata { 359 int cb_sources; 360 int cb_columns[4]; 361 int cb_colwidths[5]; 362 boolean_t cb_scripted; 363 boolean_t cb_literal; 364 boolean_t cb_first; 365 zfs_proplist_t *cb_proplist; 366 } libzfs_get_cbdata_t; 367 368 void libzfs_print_one_property(const char *, libzfs_get_cbdata_t *, 369 const char *, const char *, zfs_source_t, const char *); 370 371 #define GET_COL_NAME 1 372 #define GET_COL_PROPERTY 2 373 #define GET_COL_VALUE 3 374 #define GET_COL_SOURCE 4 375 376 /* 377 * Iterator functions. 378 */ 379 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 380 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 381 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 382 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 383 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 384 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 385 386 /* 387 * Functions to create and destroy datasets. 388 */ 389 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 390 nvlist_t *); 391 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 392 extern int zfs_destroy(zfs_handle_t *); 393 extern int zfs_destroy_snaps(zfs_handle_t *, char *); 394 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 395 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t); 396 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 397 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 398 extern int zfs_send(zfs_handle_t *, const char *, int); 399 extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int, 400 boolean_t, int); 401 extern int zfs_promote(zfs_handle_t *); 402 403 /* 404 * Miscellaneous functions. 405 */ 406 extern const char *zfs_type_to_name(zfs_type_t); 407 extern void zfs_refresh_properties(zfs_handle_t *); 408 extern int zfs_name_valid(const char *, zfs_type_t); 409 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 410 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 411 zfs_type_t); 412 413 /* 414 * dataset permission functions. 415 */ 416 extern int zfs_perm_set(zfs_handle_t *, nvlist_t *); 417 extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *); 418 extern int zfs_build_perms(zfs_handle_t *, char *, char *, 419 zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t); 420 extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **); 421 extern void zfs_free_allows(zfs_allow_t *); 422 423 /* 424 * Mount support functions. 425 */ 426 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 427 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 428 extern int zfs_mount(zfs_handle_t *, const char *, int); 429 extern int zfs_unmount(zfs_handle_t *, const char *, int); 430 extern int zfs_unmountall(zfs_handle_t *, int); 431 432 /* 433 * Share support functions. 434 */ 435 extern boolean_t zfs_is_shared(zfs_handle_t *); 436 extern int zfs_share(zfs_handle_t *); 437 extern int zfs_unshare(zfs_handle_t *); 438 439 /* 440 * Protocol-specific share support functions. 441 */ 442 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 443 extern int zfs_share_nfs(zfs_handle_t *); 444 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 445 extern int zfs_unshareall_nfs(zfs_handle_t *); 446 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 447 extern int zfs_share_iscsi(zfs_handle_t *); 448 extern int zfs_unshare_iscsi(zfs_handle_t *); 449 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 450 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, 451 void *, void *, int, boolean_t); 452 453 /* 454 * When dealing with nvlists, verify() is extremely useful 455 */ 456 #ifdef NDEBUG 457 #define verify(EX) ((void)(EX)) 458 #else 459 #define verify(EX) assert(EX) 460 #endif 461 462 /* 463 * Utility function to convert a number to a human-readable form. 464 */ 465 extern void zfs_nicenum(uint64_t, char *, size_t); 466 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 467 468 /* 469 * Pool destroy special. Remove the device information without destroying 470 * the underlying dataset. 471 */ 472 extern int zfs_remove_link(zfs_handle_t *); 473 474 /* 475 * Given a device or file, determine if it is part of a pool. 476 */ 477 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 478 boolean_t *); 479 480 /* 481 * ftyp special. Read the label from a given device. 482 */ 483 extern int zpool_read_label(int, nvlist_t **); 484 485 /* 486 * Create and remove zvol /dev links. 487 */ 488 extern int zpool_create_zvol_links(zpool_handle_t *); 489 extern int zpool_remove_zvol_links(zpool_handle_t *); 490 491 /* 492 * Enable and disable datasets within a pool by mounting/unmounting and 493 * sharing/unsharing them. 494 */ 495 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 496 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 497 498 #ifdef __cplusplus 499 } 500 #endif 501 502 #endif /* _LIBZFS_H */ 503