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 2009 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 #include <assert.h> 31 #include <libnvpair.h> 32 #include <sys/mnttab.h> 33 #include <sys/param.h> 34 #include <sys/types.h> 35 #include <sys/varargs.h> 36 #include <sys/fs/zfs.h> 37 #include <sys/avl.h> 38 #include <ucred.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* 45 * Miscellaneous ZFS constants 46 */ 47 #define ZFS_MAXNAMELEN MAXNAMELEN 48 #define ZPOOL_MAXNAMELEN MAXNAMELEN 49 #define ZFS_MAXPROPLEN MAXPATHLEN 50 #define ZPOOL_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_INVALIDNAME, /* invalid dataset name */ 70 EZFS_BADRESTORE, /* unable to restore to destination */ 71 EZFS_BADBACKUP, /* backup failed */ 72 EZFS_BADTARGET, /* bad attach/detach/replace target */ 73 EZFS_NODEVICE, /* no such device in pool */ 74 EZFS_BADDEV, /* invalid device to add */ 75 EZFS_NOREPLICAS, /* no valid replicas */ 76 EZFS_RESILVERING, /* currently resilvering */ 77 EZFS_BADVERSION, /* unsupported version */ 78 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 79 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 80 EZFS_BADPATH, /* must be an absolute path */ 81 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 82 EZFS_ZONED, /* used improperly in local zone */ 83 EZFS_MOUNTFAILED, /* failed to mount dataset */ 84 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 85 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 86 EZFS_SHARENFSFAILED, /* share(1M) failed */ 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_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 105 EZFS_BADWHO, /* invalid permission who */ 106 EZFS_BADPERM, /* invalid permission */ 107 EZFS_BADPERMSET, /* invalid permission set name */ 108 EZFS_NODELEGATION, /* delegated administration is disabled */ 109 EZFS_PERMRDONLY, /* pemissions are readonly */ 110 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 111 EZFS_SHARESMBFAILED, /* failed to share over smb */ 112 EZFS_BADCACHE, /* bad cache file */ 113 EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 114 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 115 EZFS_NOTSUP, /* ops not supported on this dataset */ 116 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 117 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 118 EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 119 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 120 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 121 EZFS_UNKNOWN 122 }; 123 124 /* 125 * The following data structures are all part 126 * of the zfs_allow_t data structure which is 127 * used for printing 'allow' permissions. 128 * It is a linked list of zfs_allow_t's which 129 * then contain avl tree's for user/group/sets/... 130 * and each one of the entries in those trees have 131 * avl tree's for the permissions they belong to and 132 * whether they are local,descendent or local+descendent 133 * permissions. The AVL trees are used primarily for 134 * sorting purposes, but also so that we can quickly find 135 * a given user and or permission. 136 */ 137 typedef struct zfs_perm_node { 138 avl_node_t z_node; 139 char z_pname[MAXPATHLEN]; 140 } zfs_perm_node_t; 141 142 typedef struct zfs_allow_node { 143 avl_node_t z_node; 144 char z_key[MAXPATHLEN]; /* name, such as joe */ 145 avl_tree_t z_localdescend; /* local+descendent perms */ 146 avl_tree_t z_local; /* local permissions */ 147 avl_tree_t z_descend; /* descendent permissions */ 148 } zfs_allow_node_t; 149 150 typedef struct zfs_allow { 151 struct zfs_allow *z_next; 152 char z_setpoint[MAXPATHLEN]; 153 avl_tree_t z_sets; 154 avl_tree_t z_crperms; 155 avl_tree_t z_user; 156 avl_tree_t z_group; 157 avl_tree_t z_everyone; 158 } zfs_allow_t; 159 160 /* 161 * Basic handle types 162 */ 163 typedef struct zfs_handle zfs_handle_t; 164 typedef struct zpool_handle zpool_handle_t; 165 typedef struct libzfs_handle libzfs_handle_t; 166 167 /* 168 * Library initialization 169 */ 170 extern libzfs_handle_t *libzfs_init(void); 171 extern void libzfs_fini(libzfs_handle_t *); 172 173 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 174 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 175 176 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 177 178 extern int libzfs_errno(libzfs_handle_t *); 179 extern const char *libzfs_error_action(libzfs_handle_t *); 180 extern const char *libzfs_error_description(libzfs_handle_t *); 181 extern void libzfs_mnttab_init(libzfs_handle_t *); 182 extern void libzfs_mnttab_fini(libzfs_handle_t *); 183 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 184 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 185 struct mnttab *); 186 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 187 const char *, const char *); 188 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 189 190 /* 191 * Basic handle functions 192 */ 193 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 194 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 195 extern void zpool_close(zpool_handle_t *); 196 extern const char *zpool_get_name(zpool_handle_t *); 197 extern int zpool_get_state(zpool_handle_t *); 198 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 199 extern void zpool_free_handles(libzfs_handle_t *); 200 201 /* 202 * Iterate over all active pools in the system. 203 */ 204 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 205 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 206 207 /* 208 * Functions to create and destroy pools 209 */ 210 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 211 nvlist_t *, nvlist_t *); 212 extern int zpool_destroy(zpool_handle_t *); 213 extern int zpool_add(zpool_handle_t *, nvlist_t *); 214 215 /* 216 * Functions to manipulate pool and vdev state 217 */ 218 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 219 extern int zpool_clear(zpool_handle_t *, const char *); 220 221 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 222 vdev_state_t *); 223 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 224 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 225 const char *, nvlist_t *, int); 226 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 227 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 228 229 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 230 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 231 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 232 233 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 234 boolean_t *, boolean_t *); 235 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 236 boolean_t *, boolean_t *, boolean_t *); 237 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 238 239 /* 240 * Functions to manage pool properties 241 */ 242 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 243 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 244 size_t proplen, zprop_source_t *); 245 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 246 zprop_source_t *); 247 248 extern const char *zpool_prop_to_name(zpool_prop_t); 249 extern const char *zpool_prop_values(zpool_prop_t); 250 251 /* 252 * Pool health statistics. 253 */ 254 typedef enum { 255 /* 256 * The following correspond to faults as defined in the (fault.fs.zfs.*) 257 * event namespace. Each is associated with a corresponding message ID. 258 */ 259 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 260 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 261 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 262 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 263 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 264 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 265 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 266 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 267 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 268 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 269 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 270 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 271 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 272 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 273 274 /* 275 * These faults have no corresponding message ID. At the time we are 276 * checking the status, the original reason for the FMA fault (I/O or 277 * checksum errors) has been lost. 278 */ 279 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 280 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 281 282 /* 283 * The following are not faults per se, but still an error possibly 284 * requiring administrative attention. There is no corresponding 285 * message ID. 286 */ 287 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 288 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 289 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 290 ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 291 292 /* 293 * Finally, the following indicates a healthy pool. 294 */ 295 ZPOOL_STATUS_OK 296 } zpool_status_t; 297 298 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 299 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 300 301 /* 302 * Statistics and configuration functions. 303 */ 304 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 305 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 306 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 307 308 /* 309 * Import and export functions 310 */ 311 extern int zpool_export(zpool_handle_t *, boolean_t); 312 extern int zpool_export_force(zpool_handle_t *); 313 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 314 char *altroot); 315 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 316 nvlist_t *, boolean_t); 317 318 /* 319 * Search for pools to import 320 */ 321 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 322 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 323 char *, uint64_t); 324 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **, 325 char *); 326 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **, 327 uint64_t); 328 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **); 329 330 /* 331 * Miscellaneous pool functions 332 */ 333 struct zfs_cmd; 334 335 extern const char *hist_event_table[LOG_END]; 336 337 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 338 boolean_t verbose); 339 extern int zpool_upgrade(zpool_handle_t *, uint64_t); 340 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 341 extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 342 nvlist_t ***, uint_t *); 343 extern void zpool_set_history_str(const char *subcommand, int argc, 344 char **argv, char *history_str); 345 extern int zpool_stage_history(libzfs_handle_t *, const char *); 346 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 347 size_t len); 348 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 349 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 350 351 /* 352 * Basic handle manipulations. These functions do not create or destroy the 353 * underlying datasets, only the references to them. 354 */ 355 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 356 extern void zfs_close(zfs_handle_t *); 357 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 358 extern const char *zfs_get_name(const zfs_handle_t *); 359 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 360 361 /* 362 * Property management functions. Some functions are shared with the kernel, 363 * and are found in sys/fs/zfs.h. 364 */ 365 366 /* 367 * zfs dataset property management 368 */ 369 extern const char *zfs_prop_default_string(zfs_prop_t); 370 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 371 extern const char *zfs_prop_column_name(zfs_prop_t); 372 extern boolean_t zfs_prop_align_right(zfs_prop_t); 373 374 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 375 nvlist_t *, uint64_t, zfs_handle_t *, const char *); 376 377 extern const char *zfs_prop_to_name(zfs_prop_t); 378 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 379 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 380 zprop_source_t *, char *, size_t, boolean_t); 381 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 382 zprop_source_t *, char *, size_t); 383 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 384 uint64_t *propvalue); 385 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 386 char *propbuf, int proplen, boolean_t literal); 387 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 388 extern int zfs_prop_inherit(zfs_handle_t *, const char *); 389 extern const char *zfs_prop_values(zfs_prop_t); 390 extern int zfs_prop_is_string(zfs_prop_t prop); 391 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 392 393 typedef struct zprop_list { 394 int pl_prop; 395 char *pl_user_prop; 396 struct zprop_list *pl_next; 397 boolean_t pl_all; 398 size_t pl_width; 399 boolean_t pl_fixed; 400 } zprop_list_t; 401 402 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 403 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 404 405 #define ZFS_MOUNTPOINT_NONE "none" 406 #define ZFS_MOUNTPOINT_LEGACY "legacy" 407 408 /* 409 * zpool property management 410 */ 411 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 412 extern const char *zpool_prop_default_string(zpool_prop_t); 413 extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 414 extern const char *zpool_prop_column_name(zpool_prop_t); 415 extern boolean_t zpool_prop_align_right(zpool_prop_t); 416 417 /* 418 * Functions shared by zfs and zpool property management. 419 */ 420 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 421 boolean_t ordered, zfs_type_t type); 422 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 423 zfs_type_t); 424 extern void zprop_free_list(zprop_list_t *); 425 426 /* 427 * Functions for printing zfs or zpool properties 428 */ 429 typedef struct zprop_get_cbdata { 430 int cb_sources; 431 int cb_columns[4]; 432 int cb_colwidths[5]; 433 boolean_t cb_scripted; 434 boolean_t cb_literal; 435 boolean_t cb_first; 436 zprop_list_t *cb_proplist; 437 zfs_type_t cb_type; 438 } zprop_get_cbdata_t; 439 440 void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 441 const char *, const char *, zprop_source_t, const char *); 442 443 #define GET_COL_NAME 1 444 #define GET_COL_PROPERTY 2 445 #define GET_COL_VALUE 3 446 #define GET_COL_SOURCE 4 447 448 /* 449 * Iterator functions. 450 */ 451 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 452 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 453 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 454 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 455 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 456 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 457 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 458 459 /* 460 * Functions to create and destroy datasets. 461 */ 462 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 463 nvlist_t *); 464 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 465 extern int zfs_destroy(zfs_handle_t *, boolean_t); 466 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 467 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 468 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 469 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 470 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 471 extern int zfs_send(zfs_handle_t *, const char *, const char *, 472 boolean_t, boolean_t, boolean_t, boolean_t, int); 473 extern int zfs_promote(zfs_handle_t *); 474 extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t, 475 boolean_t); 476 extern int zfs_hold_range(zfs_handle_t *, const char *, const char *, 477 const char *, boolean_t); 478 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 479 extern int zfs_release_range(zfs_handle_t *, const char *, const char *, 480 const char *); 481 482 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 483 uid_t rid, uint64_t space); 484 485 extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type, 486 zfs_userspace_cb_t func, void *arg); 487 488 typedef struct recvflags { 489 /* print informational messages (ie, -v was specified) */ 490 int verbose : 1; 491 492 /* the destination is a prefix, not the exact fs (ie, -d) */ 493 int isprefix : 1; 494 495 /* do not actually do the recv, just check if it would work (ie, -n) */ 496 int dryrun : 1; 497 498 /* rollback/destroy filesystems as necessary (eg, -F) */ 499 int force : 1; 500 501 /* set "canmount=off" on all modified filesystems */ 502 int canmountoff : 1; 503 504 /* byteswap flag is used internally; callers need not specify */ 505 int byteswap : 1; 506 507 /* do not mount file systems as they are extracted (private) */ 508 int nomount : 1; 509 } recvflags_t; 510 511 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 512 int, avl_tree_t *); 513 514 /* 515 * Miscellaneous functions. 516 */ 517 extern const char *zfs_type_to_name(zfs_type_t); 518 extern void zfs_refresh_properties(zfs_handle_t *); 519 extern int zfs_name_valid(const char *, zfs_type_t); 520 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 521 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 522 zfs_type_t); 523 extern int zfs_spa_version(zfs_handle_t *, int *); 524 525 /* 526 * Mount support functions. 527 */ 528 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 529 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 530 extern int zfs_mount(zfs_handle_t *, const char *, int); 531 extern int zfs_unmount(zfs_handle_t *, const char *, int); 532 extern int zfs_unmountall(zfs_handle_t *, int); 533 534 /* 535 * Share support functions. 536 */ 537 extern boolean_t zfs_is_shared(zfs_handle_t *); 538 extern int zfs_share(zfs_handle_t *); 539 extern int zfs_unshare(zfs_handle_t *); 540 541 /* 542 * Protocol-specific share support functions. 543 */ 544 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 545 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 546 extern int zfs_share_nfs(zfs_handle_t *); 547 extern int zfs_share_smb(zfs_handle_t *); 548 extern int zfs_shareall(zfs_handle_t *); 549 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 550 extern int zfs_unshare_smb(zfs_handle_t *, const char *); 551 extern int zfs_unshareall_nfs(zfs_handle_t *); 552 extern int zfs_unshareall_smb(zfs_handle_t *); 553 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 554 extern int zfs_unshareall(zfs_handle_t *); 555 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 556 extern int zfs_share_iscsi(zfs_handle_t *); 557 extern int zfs_unshare_iscsi(zfs_handle_t *); 558 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 559 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 560 void *, void *, int, zfs_share_op_t); 561 562 /* 563 * When dealing with nvlists, verify() is extremely useful 564 */ 565 #ifdef NDEBUG 566 #define verify(EX) ((void)(EX)) 567 #else 568 #define verify(EX) assert(EX) 569 #endif 570 571 /* 572 * Utility function to convert a number to a human-readable form. 573 */ 574 extern void zfs_nicenum(uint64_t, char *, size_t); 575 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 576 577 /* 578 * Given a device or file, determine if it is part of a pool. 579 */ 580 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 581 boolean_t *); 582 583 /* 584 * ftyp special. Read the label from a given device. 585 */ 586 extern int zpool_read_label(int, nvlist_t **); 587 588 /* is this zvol valid for use as a dump device? */ 589 extern int zvol_check_dump_config(char *); 590 591 /* 592 * Management interfaces for SMB ACL files 593 */ 594 595 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 596 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 597 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 598 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 599 600 /* 601 * Enable and disable datasets within a pool by mounting/unmounting and 602 * sharing/unsharing them. 603 */ 604 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 605 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 606 607 /* 608 * Mappings between vdev and FRU. 609 */ 610 extern void libzfs_fru_refresh(libzfs_handle_t *); 611 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 612 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 613 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 614 const char *); 615 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 616 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 617 618 #ifdef __cplusplus 619 } 620 #endif 621 622 #endif /* _LIBZFS_H */ 623