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