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_FAULT, /* bad address */ 90 EZFS_IO, /* I/O error */ 91 EZFS_INTR, /* signal received */ 92 EZFS_ISSPARE, /* device is a hot spare */ 93 EZFS_INVALCONFIG, /* invalid vdev configuration */ 94 EZFS_RECURSIVE, /* recursive dependency */ 95 EZFS_NOHISTORY, /* no history object */ 96 EZFS_POOLPROPS, /* couldn't retrieve pool props */ 97 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 98 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 99 EZFS_NAMETOOLONG, /* dataset name is too long */ 100 EZFS_OPENFAILED, /* open of device failed */ 101 EZFS_NOCAP, /* couldn't get capacity */ 102 EZFS_LABELFAILED, /* write of label failed */ 103 EZFS_BADWHO, /* invalid permission who */ 104 EZFS_BADPERM, /* invalid permission */ 105 EZFS_BADPERMSET, /* invalid permission set name */ 106 EZFS_NODELEGATION, /* delegated administration is disabled */ 107 EZFS_PERMRDONLY, /* pemissions are readonly */ 108 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 109 EZFS_SHARESMBFAILED, /* failed to share over smb */ 110 EZFS_BADCACHE, /* bad cache file */ 111 EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 112 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 113 EZFS_NOTSUP, /* ops not supported on this dataset */ 114 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 115 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 116 EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 117 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 118 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 119 EZFS_PIPEFAILED, /* pipe create failed */ 120 EZFS_THREADCREATEFAILED, /* thread create failed */ 121 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 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 typedef struct splitflags { 217 /* do not split, but return the config that would be split off */ 218 int dryrun : 1; 219 220 /* after splitting, import the pool */ 221 int import : 1; 222 } splitflags_t; 223 224 /* 225 * Functions to manipulate pool and vdev state 226 */ 227 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 228 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 229 230 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 231 vdev_state_t *); 232 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 233 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 234 const char *, nvlist_t *, int); 235 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 236 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 237 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 238 splitflags_t); 239 240 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 241 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 242 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 243 244 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 245 boolean_t *, boolean_t *); 246 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 247 boolean_t *, boolean_t *, boolean_t *); 248 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 249 250 /* 251 * Functions to manage pool properties 252 */ 253 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 254 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 255 size_t proplen, zprop_source_t *); 256 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 257 zprop_source_t *); 258 259 extern const char *zpool_prop_to_name(zpool_prop_t); 260 extern const char *zpool_prop_values(zpool_prop_t); 261 262 /* 263 * Pool health statistics. 264 */ 265 typedef enum { 266 /* 267 * The following correspond to faults as defined in the (fault.fs.zfs.*) 268 * event namespace. Each is associated with a corresponding message ID. 269 */ 270 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 271 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 272 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 273 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 274 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 275 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 276 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 277 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 278 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 279 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 280 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 281 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 282 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 283 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 284 285 /* 286 * These faults have no corresponding message ID. At the time we are 287 * checking the status, the original reason for the FMA fault (I/O or 288 * checksum errors) has been lost. 289 */ 290 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 291 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 292 293 /* 294 * The following are not faults per se, but still an error possibly 295 * requiring administrative attention. There is no corresponding 296 * message ID. 297 */ 298 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 299 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 300 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 301 ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 302 303 /* 304 * Finally, the following indicates a healthy pool. 305 */ 306 ZPOOL_STATUS_OK 307 } zpool_status_t; 308 309 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 310 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 311 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 312 313 /* 314 * Statistics and configuration functions. 315 */ 316 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 317 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 318 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 319 320 /* 321 * Import and export functions 322 */ 323 extern int zpool_export(zpool_handle_t *, boolean_t); 324 extern int zpool_export_force(zpool_handle_t *); 325 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 326 char *altroot); 327 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 328 nvlist_t *, boolean_t); 329 330 /* 331 * Search for pools to import 332 */ 333 334 typedef struct importargs { 335 char **path; /* a list of paths to search */ 336 int paths; /* number of paths to search */ 337 char *poolname; /* name of a pool to find */ 338 uint64_t guid; /* guid of a pool to find */ 339 char *cachefile; /* cachefile to use for import */ 340 int can_be_active : 1; /* can the pool be active? */ 341 int unique : 1; /* does 'poolname' already exist? */ 342 int exists : 1; /* set on return if pool already exists */ 343 } importargs_t; 344 345 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 346 347 /* legacy pool search routines */ 348 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 349 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 350 char *, uint64_t); 351 352 /* 353 * Miscellaneous pool functions 354 */ 355 struct zfs_cmd; 356 357 extern const char *hist_event_table[LOG_END]; 358 359 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 360 boolean_t verbose); 361 extern int zpool_upgrade(zpool_handle_t *, uint64_t); 362 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 363 extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 364 nvlist_t ***, uint_t *); 365 extern void zpool_set_history_str(const char *subcommand, int argc, 366 char **argv, char *history_str); 367 extern int zpool_stage_history(libzfs_handle_t *, const char *); 368 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 369 size_t len); 370 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 371 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 372 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 373 nvlist_t *); 374 375 /* 376 * Basic handle manipulations. These functions do not create or destroy the 377 * underlying datasets, only the references to them. 378 */ 379 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 380 extern void zfs_close(zfs_handle_t *); 381 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 382 extern const char *zfs_get_name(const zfs_handle_t *); 383 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 384 385 /* 386 * Property management functions. Some functions are shared with the kernel, 387 * and are found in sys/fs/zfs.h. 388 */ 389 390 /* 391 * zfs dataset property management 392 */ 393 extern const char *zfs_prop_default_string(zfs_prop_t); 394 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 395 extern const char *zfs_prop_column_name(zfs_prop_t); 396 extern boolean_t zfs_prop_align_right(zfs_prop_t); 397 398 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 399 nvlist_t *, uint64_t, zfs_handle_t *, const char *); 400 401 extern const char *zfs_prop_to_name(zfs_prop_t); 402 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 403 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 404 zprop_source_t *, char *, size_t, boolean_t); 405 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 406 boolean_t); 407 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 408 zprop_source_t *, char *, size_t); 409 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 410 uint64_t *propvalue); 411 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 412 char *propbuf, int proplen, boolean_t literal); 413 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 414 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 415 extern const char *zfs_prop_values(zfs_prop_t); 416 extern int zfs_prop_is_string(zfs_prop_t prop); 417 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 418 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 419 420 typedef struct zprop_list { 421 int pl_prop; 422 char *pl_user_prop; 423 struct zprop_list *pl_next; 424 boolean_t pl_all; 425 size_t pl_width; 426 size_t pl_recvd_width; 427 boolean_t pl_fixed; 428 } zprop_list_t; 429 430 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t); 431 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 432 433 #define ZFS_MOUNTPOINT_NONE "none" 434 #define ZFS_MOUNTPOINT_LEGACY "legacy" 435 436 /* 437 * zpool property management 438 */ 439 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 440 extern const char *zpool_prop_default_string(zpool_prop_t); 441 extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 442 extern const char *zpool_prop_column_name(zpool_prop_t); 443 extern boolean_t zpool_prop_align_right(zpool_prop_t); 444 445 /* 446 * Functions shared by zfs and zpool property management. 447 */ 448 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 449 boolean_t ordered, zfs_type_t type); 450 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 451 zfs_type_t); 452 extern void zprop_free_list(zprop_list_t *); 453 454 #define ZFS_GET_NCOLS 5 455 456 typedef enum { 457 GET_COL_NONE, 458 GET_COL_NAME, 459 GET_COL_PROPERTY, 460 GET_COL_VALUE, 461 GET_COL_RECVD, 462 GET_COL_SOURCE 463 } zfs_get_column_t; 464 465 /* 466 * Functions for printing zfs or zpool properties 467 */ 468 typedef struct zprop_get_cbdata { 469 int cb_sources; 470 zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 471 int cb_colwidths[ZFS_GET_NCOLS + 1]; 472 boolean_t cb_scripted; 473 boolean_t cb_literal; 474 boolean_t cb_first; 475 zprop_list_t *cb_proplist; 476 zfs_type_t cb_type; 477 } zprop_get_cbdata_t; 478 479 void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 480 const char *, const char *, zprop_source_t, const char *, 481 const char *); 482 483 /* 484 * Iterator functions. 485 */ 486 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 487 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 488 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 489 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 490 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 491 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 492 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 493 494 /* 495 * Functions to create and destroy datasets. 496 */ 497 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 498 nvlist_t *); 499 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 500 extern int zfs_destroy(zfs_handle_t *, boolean_t); 501 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 502 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 503 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 504 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 505 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 506 507 typedef struct sendflags { 508 /* print informational messages (ie, -v was specified) */ 509 int verbose : 1; 510 511 /* recursive send (ie, -R) */ 512 int replicate : 1; 513 514 /* for incrementals, do all intermediate snapshots */ 515 int doall : 1; /* (ie, -I) */ 516 517 /* if dataset is a clone, do incremental from its origin */ 518 int fromorigin : 1; 519 520 /* do deduplication */ 521 int dedup : 1; 522 523 /* send properties (ie, -p) */ 524 int props : 1; 525 } sendflags_t; 526 527 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 528 529 extern int zfs_send(zfs_handle_t *, const char *, const char *, 530 sendflags_t, int, snapfilter_cb_t, void *); 531 532 extern int zfs_promote(zfs_handle_t *); 533 extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t, 534 boolean_t, boolean_t); 535 extern int zfs_hold_range(zfs_handle_t *, const char *, const char *, 536 const char *, boolean_t, boolean_t, snapfilter_cb_t, void *); 537 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 538 extern int zfs_release_range(zfs_handle_t *, const char *, const char *, 539 const char *, boolean_t); 540 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); 541 542 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 543 uid_t rid, uint64_t space); 544 545 extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type, 546 zfs_userspace_cb_t func, void *arg); 547 548 typedef struct recvflags { 549 /* print informational messages (ie, -v was specified) */ 550 int verbose : 1; 551 552 /* the destination is a prefix, not the exact fs (ie, -d) */ 553 int isprefix : 1; 554 555 /* 556 * Only the tail of the sent snapshot path is appended to the 557 * destination to determine the received snapshot name (ie, -e). 558 */ 559 int istail : 1; 560 561 /* do not actually do the recv, just check if it would work (ie, -n) */ 562 int dryrun : 1; 563 564 /* rollback/destroy filesystems as necessary (eg, -F) */ 565 int force : 1; 566 567 /* set "canmount=off" on all modified filesystems */ 568 int canmountoff : 1; 569 570 /* byteswap flag is used internally; callers need not specify */ 571 int byteswap : 1; 572 573 /* do not mount file systems as they are extracted (private) */ 574 int nomount : 1; 575 } recvflags_t; 576 577 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 578 int, avl_tree_t *); 579 580 /* 581 * Miscellaneous functions. 582 */ 583 extern const char *zfs_type_to_name(zfs_type_t); 584 extern void zfs_refresh_properties(zfs_handle_t *); 585 extern int zfs_name_valid(const char *, zfs_type_t); 586 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 587 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 588 zfs_type_t); 589 extern int zfs_spa_version(zfs_handle_t *, int *); 590 591 /* 592 * Mount support functions. 593 */ 594 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 595 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 596 extern int zfs_mount(zfs_handle_t *, const char *, int); 597 extern int zfs_unmount(zfs_handle_t *, const char *, int); 598 extern int zfs_unmountall(zfs_handle_t *, int); 599 600 /* 601 * Share support functions. 602 */ 603 extern boolean_t zfs_is_shared(zfs_handle_t *); 604 extern int zfs_share(zfs_handle_t *); 605 extern int zfs_unshare(zfs_handle_t *); 606 607 /* 608 * Protocol-specific share support functions. 609 */ 610 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 611 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 612 extern int zfs_share_nfs(zfs_handle_t *); 613 extern int zfs_share_smb(zfs_handle_t *); 614 extern int zfs_shareall(zfs_handle_t *); 615 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 616 extern int zfs_unshare_smb(zfs_handle_t *, const char *); 617 extern int zfs_unshareall_nfs(zfs_handle_t *); 618 extern int zfs_unshareall_smb(zfs_handle_t *); 619 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 620 extern int zfs_unshareall(zfs_handle_t *); 621 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 622 void *, void *, int, zfs_share_op_t); 623 624 /* 625 * When dealing with nvlists, verify() is extremely useful 626 */ 627 #ifdef NDEBUG 628 #define verify(EX) ((void)(EX)) 629 #else 630 #define verify(EX) assert(EX) 631 #endif 632 633 /* 634 * Utility function to convert a number to a human-readable form. 635 */ 636 extern void zfs_nicenum(uint64_t, char *, size_t); 637 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 638 639 /* 640 * Given a device or file, determine if it is part of a pool. 641 */ 642 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 643 boolean_t *); 644 645 /* 646 * Label manipulation. 647 */ 648 extern int zpool_read_label(int, nvlist_t **); 649 extern int zpool_clear_label(int); 650 651 /* is this zvol valid for use as a dump device? */ 652 extern int zvol_check_dump_config(char *); 653 654 /* 655 * Management interfaces for SMB ACL files 656 */ 657 658 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 659 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 660 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 661 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 662 663 /* 664 * Enable and disable datasets within a pool by mounting/unmounting and 665 * sharing/unsharing them. 666 */ 667 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 668 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 669 670 /* 671 * Mappings between vdev and FRU. 672 */ 673 extern void libzfs_fru_refresh(libzfs_handle_t *); 674 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 675 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 676 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 677 const char *); 678 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 679 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 680 681 #ifdef __cplusplus 682 } 683 #endif 684 685 #endif /* _LIBZFS_H */ 686