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