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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24 */ 25 26 #ifndef _LIBZFS_H 27 #define _LIBZFS_H 28 29 #include <assert.h> 30 #include <libnvpair.h> 31 #include <sys/mnttab.h> 32 #include <sys/param.h> 33 #include <sys/types.h> 34 #include <sys/varargs.h> 35 #include <sys/fs/zfs.h> 36 #include <sys/avl.h> 37 #include <ucred.h> 38 39 #ifdef __cplusplus 40 extern "C" { 41 #endif 42 43 /* 44 * Miscellaneous ZFS constants 45 */ 46 #define ZFS_MAXNAMELEN MAXNAMELEN 47 #define ZPOOL_MAXNAMELEN MAXNAMELEN 48 #define ZFS_MAXPROPLEN MAXPATHLEN 49 #define ZPOOL_MAXPROPLEN MAXPATHLEN 50 51 /* 52 * libzfs errors 53 */ 54 enum { 55 EZFS_NOMEM = 2000, /* out of memory */ 56 EZFS_BADPROP, /* invalid property value */ 57 EZFS_PROPREADONLY, /* cannot set readonly property */ 58 EZFS_PROPTYPE, /* property does not apply to dataset type */ 59 EZFS_PROPNONINHERIT, /* property is not inheritable */ 60 EZFS_PROPSPACE, /* bad quota or reservation */ 61 EZFS_BADTYPE, /* dataset is not of appropriate type */ 62 EZFS_BUSY, /* pool or dataset is busy */ 63 EZFS_EXISTS, /* pool or dataset already exists */ 64 EZFS_NOENT, /* no such pool or dataset */ 65 EZFS_BADSTREAM, /* bad backup stream */ 66 EZFS_DSREADONLY, /* dataset is readonly */ 67 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 68 EZFS_INVALIDNAME, /* invalid dataset name */ 69 EZFS_BADRESTORE, /* unable to restore to destination */ 70 EZFS_BADBACKUP, /* backup failed */ 71 EZFS_BADTARGET, /* bad attach/detach/replace target */ 72 EZFS_NODEVICE, /* no such device in pool */ 73 EZFS_BADDEV, /* invalid device to add */ 74 EZFS_NOREPLICAS, /* no valid replicas */ 75 EZFS_RESILVERING, /* currently resilvering */ 76 EZFS_BADVERSION, /* unsupported version */ 77 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 78 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 79 EZFS_BADPATH, /* must be an absolute path */ 80 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 81 EZFS_ZONED, /* used improperly in local zone */ 82 EZFS_MOUNTFAILED, /* failed to mount dataset */ 83 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 84 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 85 EZFS_SHARENFSFAILED, /* share(1M) failed */ 86 EZFS_PERM, /* permission denied */ 87 EZFS_NOSPC, /* out of space */ 88 EZFS_FAULT, /* bad address */ 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_POOLPROPS, /* couldn't retrieve pool props */ 96 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 97 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 98 EZFS_NAMETOOLONG, /* dataset name is too long */ 99 EZFS_OPENFAILED, /* open of device failed */ 100 EZFS_NOCAP, /* couldn't get capacity */ 101 EZFS_LABELFAILED, /* write of label failed */ 102 EZFS_BADWHO, /* invalid permission who */ 103 EZFS_BADPERM, /* invalid permission */ 104 EZFS_BADPERMSET, /* invalid permission set name */ 105 EZFS_NODELEGATION, /* delegated administration is disabled */ 106 EZFS_PERMRDONLY, /* pemissions are readonly */ 107 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 108 EZFS_SHARESMBFAILED, /* failed to share over smb */ 109 EZFS_BADCACHE, /* bad cache file */ 110 EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 111 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 112 EZFS_NOTSUP, /* ops not supported on this dataset */ 113 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 114 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 115 EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 116 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 117 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 118 EZFS_PIPEFAILED, /* pipe create failed */ 119 EZFS_THREADCREATEFAILED, /* thread create failed */ 120 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 121 EZFS_SCRUBBING, /* currently scrubbing */ 122 EZFS_NO_SCRUB, /* no active scrub */ 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 typedef struct splitflags { 218 /* do not split, but return the config that would be split off */ 219 int dryrun : 1; 220 221 /* after splitting, import the pool */ 222 int import : 1; 223 } splitflags_t; 224 225 /* 226 * Functions to manipulate pool and vdev state 227 */ 228 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t); 229 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 230 231 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 232 vdev_state_t *); 233 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 234 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 235 const char *, nvlist_t *, int); 236 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 237 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 238 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 239 splitflags_t); 240 241 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 242 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 243 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 244 245 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 246 boolean_t *, boolean_t *); 247 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 248 boolean_t *, boolean_t *, boolean_t *); 249 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 250 251 /* 252 * Functions to manage pool properties 253 */ 254 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 255 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 256 size_t proplen, zprop_source_t *); 257 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 258 zprop_source_t *); 259 260 extern const char *zpool_prop_to_name(zpool_prop_t); 261 extern const char *zpool_prop_values(zpool_prop_t); 262 263 /* 264 * Pool health statistics. 265 */ 266 typedef enum { 267 /* 268 * The following correspond to faults as defined in the (fault.fs.zfs.*) 269 * event namespace. Each is associated with a corresponding message ID. 270 */ 271 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 272 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 273 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 274 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 275 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 276 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 277 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 278 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 279 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 280 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 281 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 282 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 283 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 284 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 285 286 /* 287 * These faults have no corresponding message ID. At the time we are 288 * checking the status, the original reason for the FMA fault (I/O or 289 * checksum errors) has been lost. 290 */ 291 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 292 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 293 294 /* 295 * The following are not faults per se, but still an error possibly 296 * requiring administrative attention. There is no corresponding 297 * message ID. 298 */ 299 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 300 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 301 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 302 ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 303 304 /* 305 * Finally, the following indicates a healthy pool. 306 */ 307 ZPOOL_STATUS_OK 308 } zpool_status_t; 309 310 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 311 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 312 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 313 314 /* 315 * Statistics and configuration functions. 316 */ 317 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 318 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 319 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 320 321 /* 322 * Import and export functions 323 */ 324 extern int zpool_export(zpool_handle_t *, boolean_t); 325 extern int zpool_export_force(zpool_handle_t *); 326 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 327 char *altroot); 328 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 329 nvlist_t *, boolean_t); 330 331 /* 332 * Search for pools to import 333 */ 334 335 typedef struct importargs { 336 char **path; /* a list of paths to search */ 337 int paths; /* number of paths to search */ 338 char *poolname; /* name of a pool to find */ 339 uint64_t guid; /* guid of a pool to find */ 340 char *cachefile; /* cachefile to use for import */ 341 int can_be_active : 1; /* can the pool be active? */ 342 int unique : 1; /* does 'poolname' already exist? */ 343 int exists : 1; /* set on return if pool already exists */ 344 } importargs_t; 345 346 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 347 348 /* legacy pool search routines */ 349 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 350 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 351 char *, uint64_t); 352 353 /* 354 * Miscellaneous pool functions 355 */ 356 struct zfs_cmd; 357 358 extern const char *zfs_history_event_names[LOG_END]; 359 360 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 361 boolean_t verbose); 362 extern int zpool_upgrade(zpool_handle_t *, uint64_t); 363 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 364 extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 365 nvlist_t ***, uint_t *); 366 extern void zpool_set_history_str(const char *subcommand, int argc, 367 char **argv, char *history_str); 368 extern int zpool_stage_history(libzfs_handle_t *, const char *); 369 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 370 size_t len); 371 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 372 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 373 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 374 nvlist_t *); 375 376 /* 377 * Basic handle manipulations. These functions do not create or destroy the 378 * underlying datasets, only the references to them. 379 */ 380 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 381 extern void zfs_close(zfs_handle_t *); 382 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 383 extern const char *zfs_get_name(const zfs_handle_t *); 384 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 385 386 /* 387 * Property management functions. Some functions are shared with the kernel, 388 * and are found in sys/fs/zfs.h. 389 */ 390 391 /* 392 * zfs dataset property management 393 */ 394 extern const char *zfs_prop_default_string(zfs_prop_t); 395 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 396 extern const char *zfs_prop_column_name(zfs_prop_t); 397 extern boolean_t zfs_prop_align_right(zfs_prop_t); 398 399 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 400 nvlist_t *, uint64_t, zfs_handle_t *, const char *); 401 402 extern const char *zfs_prop_to_name(zfs_prop_t); 403 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 404 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 405 zprop_source_t *, char *, size_t, boolean_t); 406 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 407 boolean_t); 408 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 409 zprop_source_t *, char *, size_t); 410 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 411 uint64_t *propvalue); 412 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 413 char *propbuf, int proplen, boolean_t literal); 414 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 415 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 416 extern const char *zfs_prop_values(zfs_prop_t); 417 extern int zfs_prop_is_string(zfs_prop_t prop); 418 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 419 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 420 421 typedef struct zprop_list { 422 int pl_prop; 423 char *pl_user_prop; 424 struct zprop_list *pl_next; 425 boolean_t pl_all; 426 size_t pl_width; 427 size_t pl_recvd_width; 428 boolean_t pl_fixed; 429 } zprop_list_t; 430 431 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t); 432 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 433 434 #define ZFS_MOUNTPOINT_NONE "none" 435 #define ZFS_MOUNTPOINT_LEGACY "legacy" 436 437 /* 438 * zpool property management 439 */ 440 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 441 extern const char *zpool_prop_default_string(zpool_prop_t); 442 extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 443 extern const char *zpool_prop_column_name(zpool_prop_t); 444 extern boolean_t zpool_prop_align_right(zpool_prop_t); 445 446 /* 447 * Functions shared by zfs and zpool property management. 448 */ 449 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 450 boolean_t ordered, zfs_type_t type); 451 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 452 zfs_type_t); 453 extern void zprop_free_list(zprop_list_t *); 454 455 #define ZFS_GET_NCOLS 5 456 457 typedef enum { 458 GET_COL_NONE, 459 GET_COL_NAME, 460 GET_COL_PROPERTY, 461 GET_COL_VALUE, 462 GET_COL_RECVD, 463 GET_COL_SOURCE 464 } zfs_get_column_t; 465 466 /* 467 * Functions for printing zfs or zpool properties 468 */ 469 typedef struct zprop_get_cbdata { 470 int cb_sources; 471 zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 472 int cb_colwidths[ZFS_GET_NCOLS + 1]; 473 boolean_t cb_scripted; 474 boolean_t cb_literal; 475 boolean_t cb_first; 476 zprop_list_t *cb_proplist; 477 zfs_type_t cb_type; 478 } zprop_get_cbdata_t; 479 480 void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 481 const char *, const char *, zprop_source_t, const char *, 482 const char *); 483 484 /* 485 * Iterator functions. 486 */ 487 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 488 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 489 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 490 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 491 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 492 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 493 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 494 495 /* 496 * Functions to create and destroy datasets. 497 */ 498 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 499 nvlist_t *); 500 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 501 extern int zfs_destroy(zfs_handle_t *, boolean_t); 502 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 503 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 504 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 505 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 506 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 507 508 typedef struct sendflags { 509 /* print informational messages (ie, -v was specified) */ 510 int verbose : 1; 511 512 /* recursive send (ie, -R) */ 513 int replicate : 1; 514 515 /* for incrementals, do all intermediate snapshots */ 516 int doall : 1; /* (ie, -I) */ 517 518 /* if dataset is a clone, do incremental from its origin */ 519 int fromorigin : 1; 520 521 /* do deduplication */ 522 int dedup : 1; 523 524 /* send properties (ie, -p) */ 525 int props : 1; 526 } sendflags_t; 527 528 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 529 530 extern int zfs_send(zfs_handle_t *zhp, const char *fromsnap, const char *tosnap, 531 sendflags_t flags, int outfd, snapfilter_cb_t filter_func, 532 void *cb_arg, nvlist_t **debugnvp); 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, boolean_t, snapfilter_cb_t, void *); 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 *, boolean_t); 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 int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 624 void *, void *, int, zfs_share_op_t); 625 626 /* 627 * When dealing with nvlists, verify() is extremely useful 628 */ 629 #ifdef NDEBUG 630 #define verify(EX) ((void)(EX)) 631 #else 632 #define verify(EX) assert(EX) 633 #endif 634 635 /* 636 * Utility function to convert a number to a human-readable form. 637 */ 638 extern void zfs_nicenum(uint64_t, char *, size_t); 639 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 640 641 /* 642 * Given a device or file, determine if it is part of a pool. 643 */ 644 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 645 boolean_t *); 646 647 /* 648 * Label manipulation. 649 */ 650 extern int zpool_read_label(int, nvlist_t **); 651 extern int zpool_clear_label(int); 652 653 /* is this zvol valid for use as a dump device? */ 654 extern int zvol_check_dump_config(char *); 655 656 /* 657 * Management interfaces for SMB ACL files 658 */ 659 660 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 661 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 662 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 663 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 664 665 /* 666 * Enable and disable datasets within a pool by mounting/unmounting and 667 * sharing/unsharing them. 668 */ 669 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 670 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 671 672 /* 673 * Mappings between vdev and FRU. 674 */ 675 extern void libzfs_fru_refresh(libzfs_handle_t *); 676 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 677 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 678 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 679 const char *); 680 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 681 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 682 683 #ifdef __cplusplus 684 } 685 #endif 686 687 #endif /* _LIBZFS_H */ 688