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