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