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