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