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