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_PERMSET_CIRCULAR, /* circular dependency on permset */ 111 EZFS_NODELEGATION, /* delegated administration is disabled */ 112 EZFS_PERMRDONLY, /* pemissions are readonly */ 113 EZFS_UNKNOWN 114 }; 115 116 /* 117 * The following data structures are all part 118 * of the zfs_allow_t data structure which is 119 * used for printing 'allow' permissions. 120 * It is a linked list of zfs_allow_t's which 121 * then contain avl tree's for user/group/sets/... 122 * and each one of the entries in those trees have 123 * avl tree's for the permissions they belong to and 124 * whether they are local,descendent or local+descendent 125 * permissions. The AVL trees are used primarily for 126 * sorting purposes, but also so that we can quickly find 127 * a given user and or permission. 128 */ 129 typedef struct zfs_perm_node { 130 avl_node_t z_node; 131 char z_pname[MAXPATHLEN]; 132 } zfs_perm_node_t; 133 134 typedef struct zfs_allow_node { 135 avl_node_t z_node; 136 char z_key[MAXPATHLEN]; /* name, such as joe */ 137 avl_tree_t z_localdescend; /* local+descendent perms */ 138 avl_tree_t z_local; /* local permissions */ 139 avl_tree_t z_descend; /* descendent permissions */ 140 } zfs_allow_node_t; 141 142 typedef struct zfs_allow { 143 struct zfs_allow *z_next; 144 char z_setpoint[MAXPATHLEN]; 145 avl_tree_t z_sets; 146 avl_tree_t z_crperms; 147 avl_tree_t z_user; 148 avl_tree_t z_group; 149 avl_tree_t z_everyone; 150 } zfs_allow_t; 151 152 /* 153 * Basic handle types 154 */ 155 typedef struct zfs_handle zfs_handle_t; 156 typedef struct zpool_handle zpool_handle_t; 157 typedef struct libzfs_handle libzfs_handle_t; 158 159 /* 160 * Library initialization 161 */ 162 extern libzfs_handle_t *libzfs_init(void); 163 extern void libzfs_fini(libzfs_handle_t *); 164 165 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 166 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 167 168 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 169 170 extern int libzfs_errno(libzfs_handle_t *); 171 extern const char *libzfs_error_action(libzfs_handle_t *); 172 extern const char *libzfs_error_description(libzfs_handle_t *); 173 174 /* 175 * Basic handle functions 176 */ 177 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 178 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 179 extern void zpool_close(zpool_handle_t *); 180 extern const char *zpool_get_name(zpool_handle_t *); 181 extern uint64_t zpool_get_guid(zpool_handle_t *); 182 extern uint64_t zpool_get_space_used(zpool_handle_t *); 183 extern uint64_t zpool_get_space_total(zpool_handle_t *); 184 extern int zpool_get_root(zpool_handle_t *, char *, size_t); 185 extern int zpool_get_state(zpool_handle_t *); 186 extern uint64_t zpool_get_version(zpool_handle_t *); 187 188 /* 189 * Iterate over all active pools in the system. 190 */ 191 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 192 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 193 194 /* 195 * Functions to create and destroy pools 196 */ 197 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 198 const char *); 199 extern int zpool_destroy(zpool_handle_t *); 200 extern int zpool_add(zpool_handle_t *, nvlist_t *); 201 202 /* 203 * Functions to manipulate pool and vdev state 204 */ 205 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 206 extern int zpool_clear(zpool_handle_t *, const char *); 207 208 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 209 vdev_state_t *); 210 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 211 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 212 const char *, nvlist_t *, int); 213 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 214 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 215 216 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 217 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 218 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 219 220 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 221 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 222 223 /* 224 * Functions to manage pool properties 225 */ 226 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 227 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 228 size_t proplen, zfs_source_t *); 229 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t); 230 extern const char *zpool_prop_to_name(zpool_prop_t); 231 extern const char *zpool_prop_values(zpool_prop_t); 232 233 /* 234 * Pool health statistics. 235 */ 236 typedef enum { 237 /* 238 * The following correspond to faults as defined in the (fault.fs.zfs.*) 239 * event namespace. Each is associated with a corresponding message ID. 240 */ 241 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 242 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 243 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 244 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 245 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 246 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 247 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 248 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 249 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 250 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 251 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 252 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 253 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 254 255 /* 256 * The following are not faults per se, but still an error possibly 257 * requiring administrative attention. There is no corresponding 258 * message ID. 259 */ 260 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 261 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 262 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 263 264 /* 265 * Finally, the following indicates a healthy pool. 266 */ 267 ZPOOL_STATUS_OK 268 } zpool_status_t; 269 270 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 271 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 272 273 /* 274 * Statistics and configuration functions. 275 */ 276 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 277 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 278 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 279 280 /* 281 * Import and export functions 282 */ 283 extern int zpool_export(zpool_handle_t *); 284 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 285 const char *); 286 287 /* 288 * Search for pools to import 289 */ 290 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 291 292 /* 293 * Miscellaneous pool functions 294 */ 295 struct zfs_cmd; 296 297 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 298 extern int zpool_upgrade(zpool_handle_t *); 299 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 300 extern void zpool_stage_history(libzfs_handle_t *, int, char **, 301 boolean_t zfs_cmd); 302 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 303 size_t len); 304 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 305 /* 306 * Basic handle manipulations. These functions do not create or destroy the 307 * underlying datasets, only the references to them. 308 */ 309 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 310 extern void zfs_close(zfs_handle_t *); 311 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 312 extern const char *zfs_get_name(const zfs_handle_t *); 313 314 /* 315 * Property management functions. Some functions are shared with the kernel, 316 * and are found in sys/fs/zfs.h. 317 */ 318 extern const char *zfs_prop_to_name(zfs_prop_t); 319 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 320 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 321 zfs_source_t *, char *, size_t, boolean_t); 322 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 323 zfs_source_t *, char *, size_t); 324 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 325 extern const char *zfs_prop_get_string(zfs_handle_t *, zfs_prop_t); 326 extern int zfs_prop_inherit(zfs_handle_t *, const char *); 327 extern const char *zfs_prop_values(zfs_prop_t); 328 extern int zfs_prop_valid_for_type(zfs_prop_t, int); 329 extern const char *zfs_prop_default_string(zfs_prop_t prop); 330 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 331 extern int zfs_prop_is_string(zfs_prop_t prop); 332 extern const char *zfs_prop_column_name(zfs_prop_t); 333 extern boolean_t zfs_prop_align_right(zfs_prop_t); 334 extern void nicebool(int value, char *buf, size_t buflen); 335 336 typedef struct zfs_proplist { 337 zfs_prop_t pl_prop; 338 char *pl_user_prop; 339 struct zfs_proplist *pl_next; 340 boolean_t pl_all; 341 size_t pl_width; 342 boolean_t pl_fixed; 343 } zfs_proplist_t; 344 345 typedef zfs_proplist_t zpool_proplist_t; 346 347 extern int zfs_get_proplist(libzfs_handle_t *, char *, zfs_proplist_t **); 348 extern int zpool_get_proplist(libzfs_handle_t *, char *, zpool_proplist_t **); 349 extern int zfs_expand_proplist(zfs_handle_t *, zfs_proplist_t **); 350 extern int zpool_expand_proplist(zpool_handle_t *, zpool_proplist_t **); 351 extern void zfs_free_proplist(zfs_proplist_t *); 352 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 353 354 #define ZFS_MOUNTPOINT_NONE "none" 355 #define ZFS_MOUNTPOINT_LEGACY "legacy" 356 357 /* 358 * Functions for printing properties from zfs/zpool 359 */ 360 typedef struct libzfs_get_cbdata { 361 int cb_sources; 362 int cb_columns[4]; 363 int cb_colwidths[5]; 364 boolean_t cb_scripted; 365 boolean_t cb_literal; 366 boolean_t cb_first; 367 zfs_proplist_t *cb_proplist; 368 } libzfs_get_cbdata_t; 369 370 void libzfs_print_one_property(const char *, libzfs_get_cbdata_t *, 371 const char *, const char *, zfs_source_t, const char *); 372 373 #define GET_COL_NAME 1 374 #define GET_COL_PROPERTY 2 375 #define GET_COL_VALUE 3 376 #define GET_COL_SOURCE 4 377 378 /* 379 * Iterator functions. 380 */ 381 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 382 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 383 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 384 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 385 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 386 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 387 388 /* 389 * Functions to create and destroy datasets. 390 */ 391 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 392 nvlist_t *); 393 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 394 extern int zfs_destroy(zfs_handle_t *); 395 extern int zfs_destroy_snaps(zfs_handle_t *, char *); 396 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 397 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t); 398 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 399 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 400 extern int zfs_send(zfs_handle_t *, const char *, int); 401 extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int, 402 boolean_t, int); 403 extern int zfs_promote(zfs_handle_t *); 404 405 /* 406 * Miscellaneous functions. 407 */ 408 extern const char *zfs_type_to_name(zfs_type_t); 409 extern void zfs_refresh_properties(zfs_handle_t *); 410 extern int zfs_name_valid(const char *, zfs_type_t); 411 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 412 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 413 zfs_type_t); 414 415 /* 416 * dataset permission functions. 417 */ 418 extern int zfs_perm_set(zfs_handle_t *, nvlist_t *); 419 extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *); 420 extern int zfs_build_perms(zfs_handle_t *, char *, char *, 421 zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t); 422 extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **); 423 extern void zfs_free_allows(zfs_allow_t *); 424 425 /* 426 * Mount support functions. 427 */ 428 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 429 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 430 extern int zfs_mount(zfs_handle_t *, const char *, int); 431 extern int zfs_unmount(zfs_handle_t *, const char *, int); 432 extern int zfs_unmountall(zfs_handle_t *, int); 433 434 /* 435 * Share support functions. 436 */ 437 extern boolean_t zfs_is_shared(zfs_handle_t *); 438 extern int zfs_share(zfs_handle_t *); 439 extern int zfs_unshare(zfs_handle_t *); 440 441 /* 442 * Protocol-specific share support functions. 443 */ 444 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 445 extern int zfs_share_nfs(zfs_handle_t *); 446 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 447 extern int zfs_unshareall_nfs(zfs_handle_t *); 448 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 449 extern int zfs_share_iscsi(zfs_handle_t *); 450 extern int zfs_unshare_iscsi(zfs_handle_t *); 451 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 452 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, 453 void *, void *, int, boolean_t); 454 455 /* 456 * When dealing with nvlists, verify() is extremely useful 457 */ 458 #ifdef NDEBUG 459 #define verify(EX) ((void)(EX)) 460 #else 461 #define verify(EX) assert(EX) 462 #endif 463 464 /* 465 * Utility function to convert a number to a human-readable form. 466 */ 467 extern void zfs_nicenum(uint64_t, char *, size_t); 468 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 469 470 /* 471 * Pool destroy special. Remove the device information without destroying 472 * the underlying dataset. 473 */ 474 extern int zfs_remove_link(zfs_handle_t *); 475 476 /* 477 * Given a device or file, determine if it is part of a pool. 478 */ 479 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 480 boolean_t *); 481 482 /* 483 * ftyp special. Read the label from a given device. 484 */ 485 extern int zpool_read_label(int, nvlist_t **); 486 487 /* 488 * Create and remove zvol /dev links. 489 */ 490 extern int zpool_create_zvol_links(zpool_handle_t *); 491 extern int zpool_remove_zvol_links(zpool_handle_t *); 492 493 /* 494 * Enable and disable datasets within a pool by mounting/unmounting and 495 * sharing/unsharing them. 496 */ 497 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 498 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 499 500 #ifdef __cplusplus 501 } 502 #endif 503 504 #endif /* _LIBZFS_H */ 505