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