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 #define ZPOOL_MAXPROPLEN MAXPATHLEN 52 53 /* 54 * libzfs errors 55 */ 56 enum { 57 EZFS_NOMEM = 2000, /* out of memory */ 58 EZFS_BADPROP, /* invalid property value */ 59 EZFS_PROPREADONLY, /* cannot set readonly property */ 60 EZFS_PROPTYPE, /* property does not apply to dataset type */ 61 EZFS_PROPNONINHERIT, /* property is not inheritable */ 62 EZFS_PROPSPACE, /* bad quota or reservation */ 63 EZFS_BADTYPE, /* dataset is not of appropriate type */ 64 EZFS_BUSY, /* pool or dataset is busy */ 65 EZFS_EXISTS, /* pool or dataset already exists */ 66 EZFS_NOENT, /* no such pool or dataset */ 67 EZFS_BADSTREAM, /* bad backup stream */ 68 EZFS_DSREADONLY, /* dataset is readonly */ 69 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 70 EZFS_VOLHASDATA, /* volume already contains data */ 71 EZFS_INVALIDNAME, /* invalid dataset name */ 72 EZFS_BADRESTORE, /* unable to restore to destination */ 73 EZFS_BADBACKUP, /* backup failed */ 74 EZFS_BADTARGET, /* bad attach/detach/replace target */ 75 EZFS_NODEVICE, /* no such device in pool */ 76 EZFS_BADDEV, /* invalid device to add */ 77 EZFS_NOREPLICAS, /* no valid replicas */ 78 EZFS_RESILVERING, /* currently resilvering */ 79 EZFS_BADVERSION, /* unsupported version */ 80 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 81 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 82 EZFS_BADPATH, /* must be an absolute path */ 83 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 84 EZFS_ZONED, /* used improperly in local zone */ 85 EZFS_MOUNTFAILED, /* failed to mount dataset */ 86 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 87 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 88 EZFS_SHARENFSFAILED, /* share(1M) failed */ 89 EZFS_DEVLINKS, /* failed to create zvol links */ 90 EZFS_PERM, /* permission denied */ 91 EZFS_NOSPC, /* out of space */ 92 EZFS_IO, /* I/O error */ 93 EZFS_INTR, /* signal received */ 94 EZFS_ISSPARE, /* device is a hot spare */ 95 EZFS_INVALCONFIG, /* invalid vdev configuration */ 96 EZFS_RECURSIVE, /* recursive dependency */ 97 EZFS_NOHISTORY, /* no history object */ 98 EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 99 EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 100 EZFS_POOLPROPS, /* couldn't retrieve pool props */ 101 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 102 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 103 EZFS_NAMETOOLONG, /* dataset name is too long */ 104 EZFS_OPENFAILED, /* open of device failed */ 105 EZFS_NOCAP, /* couldn't get capacity */ 106 EZFS_LABELFAILED, /* write of label failed */ 107 EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 108 EZFS_BADWHO, /* invalid permission who */ 109 EZFS_BADPERM, /* invalid permission */ 110 EZFS_BADPERMSET, /* invalid permission set name */ 111 EZFS_NODELEGATION, /* delegated administration is disabled */ 112 EZFS_PERMRDONLY, /* pemissions are readonly */ 113 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 114 EZFS_SHARESMBFAILED, /* failed to share over smb */ 115 EZFS_UNKNOWN 116 }; 117 118 /* 119 * The following data structures are all part 120 * of the zfs_allow_t data structure which is 121 * used for printing 'allow' permissions. 122 * It is a linked list of zfs_allow_t's which 123 * then contain avl tree's for user/group/sets/... 124 * and each one of the entries in those trees have 125 * avl tree's for the permissions they belong to and 126 * whether they are local,descendent or local+descendent 127 * permissions. The AVL trees are used primarily for 128 * sorting purposes, but also so that we can quickly find 129 * a given user and or permission. 130 */ 131 typedef struct zfs_perm_node { 132 avl_node_t z_node; 133 char z_pname[MAXPATHLEN]; 134 } zfs_perm_node_t; 135 136 typedef struct zfs_allow_node { 137 avl_node_t z_node; 138 char z_key[MAXPATHLEN]; /* name, such as joe */ 139 avl_tree_t z_localdescend; /* local+descendent perms */ 140 avl_tree_t z_local; /* local permissions */ 141 avl_tree_t z_descend; /* descendent permissions */ 142 } zfs_allow_node_t; 143 144 typedef struct zfs_allow { 145 struct zfs_allow *z_next; 146 char z_setpoint[MAXPATHLEN]; 147 avl_tree_t z_sets; 148 avl_tree_t z_crperms; 149 avl_tree_t z_user; 150 avl_tree_t z_group; 151 avl_tree_t z_everyone; 152 } zfs_allow_t; 153 154 /* 155 * Basic handle types 156 */ 157 typedef struct zfs_handle zfs_handle_t; 158 typedef struct zpool_handle zpool_handle_t; 159 typedef struct libzfs_handle libzfs_handle_t; 160 161 /* 162 * Library initialization 163 */ 164 extern libzfs_handle_t *libzfs_init(void); 165 extern void libzfs_fini(libzfs_handle_t *); 166 167 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 168 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 169 170 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 171 172 extern int libzfs_errno(libzfs_handle_t *); 173 extern const char *libzfs_error_action(libzfs_handle_t *); 174 extern const char *libzfs_error_description(libzfs_handle_t *); 175 176 /* 177 * Basic handle functions 178 */ 179 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 180 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 181 extern void zpool_close(zpool_handle_t *); 182 extern const char *zpool_get_name(zpool_handle_t *); 183 extern int zpool_get_state(zpool_handle_t *); 184 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 185 186 /* 187 * Iterate over all active pools in the system. 188 */ 189 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 190 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 191 192 /* 193 * Functions to create and destroy pools 194 */ 195 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 196 nvlist_t *); 197 extern int zpool_destroy(zpool_handle_t *); 198 extern int zpool_add(zpool_handle_t *, nvlist_t *); 199 200 /* 201 * Functions to manipulate pool and vdev state 202 */ 203 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 204 extern int zpool_clear(zpool_handle_t *, const char *); 205 206 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 207 vdev_state_t *); 208 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 209 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 210 const char *, nvlist_t *, int); 211 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 212 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 213 214 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 215 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 216 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 217 218 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 219 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 220 221 /* 222 * Functions to manage pool properties 223 */ 224 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 225 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 226 size_t proplen, zprop_source_t *); 227 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 228 zprop_source_t *); 229 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 char *altroot); 286 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 287 nvlist_t *); 288 289 /* 290 * Search for pools to import 291 */ 292 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 293 294 /* 295 * Miscellaneous pool functions 296 */ 297 struct zfs_cmd; 298 299 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 300 extern int zpool_upgrade(zpool_handle_t *, uint64_t); 301 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 302 extern void zpool_set_history_str(const char *subcommand, int argc, 303 char **argv, char *history_str); 304 extern int zpool_stage_history(libzfs_handle_t *, const char *); 305 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 306 size_t len); 307 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 308 /* 309 * Basic handle manipulations. These functions do not create or destroy the 310 * underlying datasets, only the references to them. 311 */ 312 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 313 extern void zfs_close(zfs_handle_t *); 314 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 315 extern const char *zfs_get_name(const zfs_handle_t *); 316 317 /* 318 * Property management functions. Some functions are shared with the kernel, 319 * and are found in sys/fs/zfs.h. 320 */ 321 322 /* 323 * zfs dataset property management 324 */ 325 extern const char *zfs_prop_default_string(zfs_prop_t); 326 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 327 extern const char *zfs_prop_column_name(zfs_prop_t); 328 extern boolean_t zfs_prop_align_right(zfs_prop_t); 329 330 extern const char *zfs_prop_to_name(zfs_prop_t); 331 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 332 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 333 zprop_source_t *, char *, size_t, boolean_t); 334 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 335 zprop_source_t *, char *, size_t); 336 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 337 extern int zfs_prop_inherit(zfs_handle_t *, const char *); 338 extern const char *zfs_prop_values(zfs_prop_t); 339 extern int zfs_prop_is_string(zfs_prop_t prop); 340 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 341 342 typedef struct zprop_list { 343 int pl_prop; 344 char *pl_user_prop; 345 struct zprop_list *pl_next; 346 boolean_t pl_all; 347 size_t pl_width; 348 boolean_t pl_fixed; 349 } zprop_list_t; 350 351 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 352 353 #define ZFS_MOUNTPOINT_NONE "none" 354 #define ZFS_MOUNTPOINT_LEGACY "legacy" 355 356 /* 357 * zpool property management 358 */ 359 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 360 extern const char *zpool_prop_default_string(zpool_prop_t); 361 extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 362 extern const char *zpool_prop_column_name(zpool_prop_t); 363 extern boolean_t zpool_prop_align_right(zpool_prop_t); 364 365 /* 366 * Functions shared by zfs and zpool property management. 367 */ 368 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 369 boolean_t ordered, zfs_type_t type); 370 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 371 zfs_type_t); 372 extern void zprop_free_list(zprop_list_t *); 373 374 /* 375 * Functions for printing zfs or zpool properties 376 */ 377 typedef struct zprop_get_cbdata { 378 int cb_sources; 379 int cb_columns[4]; 380 int cb_colwidths[5]; 381 boolean_t cb_scripted; 382 boolean_t cb_literal; 383 boolean_t cb_first; 384 zprop_list_t *cb_proplist; 385 zfs_type_t cb_type; 386 } zprop_get_cbdata_t; 387 388 void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 389 const char *, const char *, zprop_source_t, const char *); 390 391 #define GET_COL_NAME 1 392 #define GET_COL_PROPERTY 2 393 #define GET_COL_VALUE 3 394 #define GET_COL_SOURCE 4 395 396 /* 397 * Iterator functions. 398 */ 399 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 400 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 401 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 402 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 403 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 404 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 405 406 /* 407 * Functions to create and destroy datasets. 408 */ 409 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 410 nvlist_t *); 411 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 412 extern int zfs_destroy(zfs_handle_t *); 413 extern int zfs_destroy_snaps(zfs_handle_t *, char *); 414 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 415 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t); 416 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 417 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 418 extern int zfs_send(zfs_handle_t *, const char *, int); 419 extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int, 420 boolean_t, int); 421 extern int zfs_promote(zfs_handle_t *); 422 423 /* 424 * Miscellaneous functions. 425 */ 426 extern const char *zfs_type_to_name(zfs_type_t); 427 extern void zfs_refresh_properties(zfs_handle_t *); 428 extern int zfs_name_valid(const char *, zfs_type_t); 429 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 430 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 431 zfs_type_t); 432 433 /* 434 * dataset permission functions. 435 */ 436 extern int zfs_perm_set(zfs_handle_t *, nvlist_t *); 437 extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *); 438 extern int zfs_build_perms(zfs_handle_t *, char *, char *, 439 zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t); 440 extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **); 441 extern void zfs_free_allows(zfs_allow_t *); 442 443 /* 444 * Mount support functions. 445 */ 446 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 447 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 448 extern int zfs_mount(zfs_handle_t *, const char *, int); 449 extern int zfs_unmount(zfs_handle_t *, const char *, int); 450 extern int zfs_unmountall(zfs_handle_t *, int); 451 452 /* 453 * Share support functions. 454 */ 455 extern boolean_t zfs_is_shared(zfs_handle_t *); 456 extern int zfs_share(zfs_handle_t *); 457 extern int zfs_unshare(zfs_handle_t *); 458 459 /* 460 * Protocol-specific share support functions. 461 */ 462 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 463 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 464 extern int zfs_share_nfs(zfs_handle_t *); 465 extern int zfs_share_smb(zfs_handle_t *); 466 extern int zfs_shareall(zfs_handle_t *); 467 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 468 extern int zfs_unshare_smb(zfs_handle_t *, const char *); 469 extern int zfs_unshareall_nfs(zfs_handle_t *); 470 extern int zfs_unshareall_smb(zfs_handle_t *); 471 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 472 extern int zfs_unshareall(zfs_handle_t *); 473 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 474 extern int zfs_share_iscsi(zfs_handle_t *); 475 extern int zfs_unshare_iscsi(zfs_handle_t *); 476 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 477 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, 478 void *, void *, int, zfs_share_op_t); 479 480 /* 481 * When dealing with nvlists, verify() is extremely useful 482 */ 483 #ifdef NDEBUG 484 #define verify(EX) ((void)(EX)) 485 #else 486 #define verify(EX) assert(EX) 487 #endif 488 489 /* 490 * Utility function to convert a number to a human-readable form. 491 */ 492 extern void zfs_nicenum(uint64_t, char *, size_t); 493 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 494 495 /* 496 * Given a device or file, determine if it is part of a pool. 497 */ 498 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 499 boolean_t *); 500 501 /* 502 * ftyp special. Read the label from a given device. 503 */ 504 extern int zpool_read_label(int, nvlist_t **); 505 506 /* 507 * Create and remove zvol /dev links. 508 */ 509 extern int zpool_create_zvol_links(zpool_handle_t *); 510 extern int zpool_remove_zvol_links(zpool_handle_t *); 511 512 /* 513 * Enable and disable datasets within a pool by mounting/unmounting and 514 * sharing/unsharing them. 515 */ 516 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 517 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 518 519 #ifdef __cplusplus 520 } 521 #endif 522 523 #endif /* _LIBZFS_H */ 524