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_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 int zpool_get_state(zpool_handle_t *); 182 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 183 184 /* 185 * Iterate over all active pools in the system. 186 */ 187 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 188 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 189 190 /* 191 * Functions to create and destroy pools 192 */ 193 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 194 nvlist_t *); 195 extern int zpool_destroy(zpool_handle_t *); 196 extern int zpool_add(zpool_handle_t *, nvlist_t *); 197 198 /* 199 * Functions to manipulate pool and vdev state 200 */ 201 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 202 extern int zpool_clear(zpool_handle_t *, const char *); 203 204 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 205 vdev_state_t *); 206 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 207 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 208 const char *, nvlist_t *, int); 209 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 210 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 211 212 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 213 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 214 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 215 216 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 217 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 218 219 /* 220 * Functions to manage pool properties 221 */ 222 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 223 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 224 size_t proplen, zprop_source_t *); 225 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 226 zprop_source_t *); 227 228 extern const char *zpool_prop_to_name(zpool_prop_t); 229 extern const char *zpool_prop_values(zpool_prop_t); 230 231 /* 232 * Pool health statistics. 233 */ 234 typedef enum { 235 /* 236 * The following correspond to faults as defined in the (fault.fs.zfs.*) 237 * event namespace. Each is associated with a corresponding message ID. 238 */ 239 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 240 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 241 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 242 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 243 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 244 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 245 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 246 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 247 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 248 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 249 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 250 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 251 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 252 253 /* 254 * The following are not faults per se, but still an error possibly 255 * requiring administrative attention. There is no corresponding 256 * message ID. 257 */ 258 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 259 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 260 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 261 262 /* 263 * Finally, the following indicates a healthy pool. 264 */ 265 ZPOOL_STATUS_OK 266 } zpool_status_t; 267 268 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 269 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 270 271 /* 272 * Statistics and configuration functions. 273 */ 274 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 275 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 276 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 277 278 /* 279 * Import and export functions 280 */ 281 extern int zpool_export(zpool_handle_t *); 282 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 283 char *altroot); 284 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 285 nvlist_t *); 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 *, uint64_t); 299 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 300 extern void zpool_set_history_str(const char *subcommand, int argc, 301 char **argv, char *history_str); 302 extern int zpool_stage_history(libzfs_handle_t *, const char *); 303 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 304 size_t len); 305 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 306 /* 307 * Basic handle manipulations. These functions do not create or destroy the 308 * underlying datasets, only the references to them. 309 */ 310 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 311 extern void zfs_close(zfs_handle_t *); 312 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 313 extern const char *zfs_get_name(const zfs_handle_t *); 314 315 /* 316 * Property management functions. Some functions are shared with the kernel, 317 * and are found in sys/fs/zfs.h. 318 */ 319 320 /* 321 * zfs dataset property management 322 */ 323 extern int zfs_prop_valid_for_type(zfs_prop_t, int); 324 extern const char *zfs_prop_default_string(zfs_prop_t); 325 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 326 extern const char *zfs_prop_column_name(zfs_prop_t); 327 extern boolean_t zfs_prop_align_right(zfs_prop_t); 328 329 extern const char *zfs_prop_to_name(zfs_prop_t); 330 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 331 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 332 zprop_source_t *, char *, size_t, boolean_t); 333 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 334 zprop_source_t *, char *, size_t); 335 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 336 extern int zfs_prop_inherit(zfs_handle_t *, const char *); 337 extern const char *zfs_prop_values(zfs_prop_t); 338 extern int zfs_prop_is_string(zfs_prop_t prop); 339 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 340 341 typedef struct zprop_list { 342 int pl_prop; 343 char *pl_user_prop; 344 struct zprop_list *pl_next; 345 boolean_t pl_all; 346 size_t pl_width; 347 boolean_t pl_fixed; 348 } zprop_list_t; 349 350 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 351 352 #define ZFS_MOUNTPOINT_NONE "none" 353 #define ZFS_MOUNTPOINT_LEGACY "legacy" 354 355 /* 356 * zpool property management 357 */ 358 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 359 extern const char *zpool_prop_default_string(zpool_prop_t); 360 extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 361 extern const char *zpool_prop_column_name(zpool_prop_t); 362 extern boolean_t zpool_prop_align_right(zpool_prop_t); 363 364 /* 365 * Functions shared by zfs and zpool property management. 366 */ 367 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 368 boolean_t ordered, zfs_type_t type); 369 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 370 zfs_type_t); 371 extern void zprop_free_list(zprop_list_t *); 372 373 /* 374 * Functions for printing zfs or zpool properties 375 */ 376 typedef struct zprop_get_cbdata { 377 int cb_sources; 378 int cb_columns[4]; 379 int cb_colwidths[5]; 380 boolean_t cb_scripted; 381 boolean_t cb_literal; 382 boolean_t cb_first; 383 zprop_list_t *cb_proplist; 384 zfs_type_t cb_type; 385 } zprop_get_cbdata_t; 386 387 void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 388 const char *, const char *, zprop_source_t, const char *); 389 390 #define GET_COL_NAME 1 391 #define GET_COL_PROPERTY 2 392 #define GET_COL_VALUE 3 393 #define GET_COL_SOURCE 4 394 395 /* 396 * Iterator functions. 397 */ 398 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 399 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 400 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 401 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 402 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 403 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 404 405 /* 406 * Functions to create and destroy datasets. 407 */ 408 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 409 nvlist_t *); 410 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 411 extern int zfs_destroy(zfs_handle_t *); 412 extern int zfs_destroy_snaps(zfs_handle_t *, char *); 413 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 414 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t); 415 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 416 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 417 extern int zfs_send(zfs_handle_t *, const char *, int); 418 extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int, 419 boolean_t, int); 420 extern int zfs_promote(zfs_handle_t *); 421 422 /* 423 * Miscellaneous functions. 424 */ 425 extern const char *zfs_type_to_name(zfs_type_t); 426 extern void zfs_refresh_properties(zfs_handle_t *); 427 extern int zfs_name_valid(const char *, zfs_type_t); 428 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 429 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 430 zfs_type_t); 431 432 /* 433 * dataset permission functions. 434 */ 435 extern int zfs_perm_set(zfs_handle_t *, nvlist_t *); 436 extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *); 437 extern int zfs_build_perms(zfs_handle_t *, char *, char *, 438 zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t); 439 extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **); 440 extern void zfs_free_allows(zfs_allow_t *); 441 442 /* 443 * Mount support functions. 444 */ 445 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 446 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 447 extern int zfs_mount(zfs_handle_t *, const char *, int); 448 extern int zfs_unmount(zfs_handle_t *, const char *, int); 449 extern int zfs_unmountall(zfs_handle_t *, int); 450 451 /* 452 * Share support functions. 453 */ 454 extern boolean_t zfs_is_shared(zfs_handle_t *); 455 extern int zfs_share(zfs_handle_t *); 456 extern int zfs_unshare(zfs_handle_t *); 457 458 /* 459 * Protocol-specific share support functions. 460 */ 461 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 462 extern int zfs_share_nfs(zfs_handle_t *); 463 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 464 extern int zfs_unshareall_nfs(zfs_handle_t *); 465 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 466 extern int zfs_share_iscsi(zfs_handle_t *); 467 extern int zfs_unshare_iscsi(zfs_handle_t *); 468 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 469 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, 470 void *, void *, int, boolean_t); 471 472 /* 473 * When dealing with nvlists, verify() is extremely useful 474 */ 475 #ifdef NDEBUG 476 #define verify(EX) ((void)(EX)) 477 #else 478 #define verify(EX) assert(EX) 479 #endif 480 481 /* 482 * Utility function to convert a number to a human-readable form. 483 */ 484 extern void zfs_nicenum(uint64_t, char *, size_t); 485 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 486 487 /* 488 * Given a device or file, determine if it is part of a pool. 489 */ 490 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 491 boolean_t *); 492 493 /* 494 * ftyp special. Read the label from a given device. 495 */ 496 extern int zpool_read_label(int, nvlist_t **); 497 498 /* 499 * Create and remove zvol /dev links. 500 */ 501 extern int zpool_create_zvol_links(zpool_handle_t *); 502 extern int zpool_remove_zvol_links(zpool_handle_t *); 503 504 /* 505 * Enable and disable datasets within a pool by mounting/unmounting and 506 * sharing/unsharing them. 507 */ 508 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 509 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 510 511 #ifdef __cplusplus 512 } 513 #endif 514 515 #endif /* _LIBZFS_H */ 516