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