1*61145dc2SMartin Matuska // SPDX-License-Identifier: CDDL-1.0 2eda14cbcSMatt Macy /* 3eda14cbcSMatt Macy * CDDL HEADER START 4eda14cbcSMatt Macy * 5eda14cbcSMatt Macy * The contents of this file are subject to the terms of the 6eda14cbcSMatt Macy * Common Development and Distribution License (the "License"). 7eda14cbcSMatt Macy * You may not use this file except in compliance with the License. 8eda14cbcSMatt Macy * 9eda14cbcSMatt Macy * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10271171e0SMartin Matuska * or https://opensource.org/licenses/CDDL-1.0. 11eda14cbcSMatt Macy * See the License for the specific language governing permissions 12eda14cbcSMatt Macy * and limitations under the License. 13eda14cbcSMatt Macy * 14eda14cbcSMatt Macy * When distributing Covered Code, include this CDDL HEADER in each 15eda14cbcSMatt Macy * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16eda14cbcSMatt Macy * If applicable, add the following below this CDDL HEADER, with the 17eda14cbcSMatt Macy * fields enclosed by brackets "[]" replaced with your own identifying 18eda14cbcSMatt Macy * information: Portions Copyright [yyyy] [name of copyright owner] 19eda14cbcSMatt Macy * 20eda14cbcSMatt Macy * CDDL HEADER END 21eda14cbcSMatt Macy */ 22eda14cbcSMatt Macy 23eda14cbcSMatt Macy /* 24eda14cbcSMatt Macy * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 25783d3ff6SMartin Matuska * Copyright (c) 2011, 2024 by Delphix. All rights reserved. 26eda14cbcSMatt Macy * Copyright Joyent, Inc. 27eda14cbcSMatt Macy * Copyright (c) 2013 Steven Hartland. All rights reserved. 28eda14cbcSMatt Macy * Copyright (c) 2016, Intel Corporation. 29eda14cbcSMatt Macy * Copyright 2016 Nexenta Systems, Inc. 30eda14cbcSMatt Macy * Copyright (c) 2017 Open-E, Inc. All Rights Reserved. 31eda14cbcSMatt Macy * Copyright (c) 2019 Datto Inc. 32ee36e25aSMartin Matuska * Copyright (c) 2021, Colm Buckley <colm@tuatha.org> 33eda14cbcSMatt Macy */ 34eda14cbcSMatt Macy 35eda14cbcSMatt Macy #ifndef _LIBZFS_H 3616038816SMartin Matuska #define _LIBZFS_H extern __attribute__((visibility("default"))) 37eda14cbcSMatt Macy 38eda14cbcSMatt Macy #include <assert.h> 39716fd348SMartin Matuska #include <libshare.h> 40eda14cbcSMatt Macy #include <libnvpair.h> 41eda14cbcSMatt Macy #include <sys/mnttab.h> 42eda14cbcSMatt Macy #include <sys/param.h> 43eda14cbcSMatt Macy #include <sys/types.h> 44eda14cbcSMatt Macy #include <sys/fs/zfs.h> 45eda14cbcSMatt Macy #include <sys/avl.h> 46eda14cbcSMatt Macy #include <libzfs_core.h> 47eda14cbcSMatt Macy 48eda14cbcSMatt Macy #ifdef __cplusplus 49eda14cbcSMatt Macy extern "C" { 50eda14cbcSMatt Macy #endif 51eda14cbcSMatt Macy 52eda14cbcSMatt Macy /* 53eda14cbcSMatt Macy * Miscellaneous ZFS constants 54eda14cbcSMatt Macy */ 55ce4dcb97SMartin Matuska #define ZFS_MAXPROPLEN ZAP_MAXVALUELEN 56ce4dcb97SMartin Matuska #define ZPOOL_MAXPROPLEN ZAP_MAXVALUELEN 57eda14cbcSMatt Macy 58eda14cbcSMatt Macy /* 59eda14cbcSMatt Macy * libzfs errors 60eda14cbcSMatt Macy */ 61eda14cbcSMatt Macy typedef enum zfs_error { 62eda14cbcSMatt Macy EZFS_SUCCESS = 0, /* no error -- success */ 63eda14cbcSMatt Macy EZFS_NOMEM = 2000, /* out of memory */ 64eda14cbcSMatt Macy EZFS_BADPROP, /* invalid property value */ 65eda14cbcSMatt Macy EZFS_PROPREADONLY, /* cannot set readonly property */ 66eda14cbcSMatt Macy EZFS_PROPTYPE, /* property does not apply to dataset type */ 67eda14cbcSMatt Macy EZFS_PROPNONINHERIT, /* property is not inheritable */ 68eda14cbcSMatt Macy EZFS_PROPSPACE, /* bad quota or reservation */ 69eda14cbcSMatt Macy EZFS_BADTYPE, /* dataset is not of appropriate type */ 70eda14cbcSMatt Macy EZFS_BUSY, /* pool or dataset is busy */ 71eda14cbcSMatt Macy EZFS_EXISTS, /* pool or dataset already exists */ 72eda14cbcSMatt Macy EZFS_NOENT, /* no such pool or dataset */ 73eda14cbcSMatt Macy EZFS_BADSTREAM, /* bad backup stream */ 74eda14cbcSMatt Macy EZFS_DSREADONLY, /* dataset is readonly */ 75eda14cbcSMatt Macy EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 76eda14cbcSMatt Macy EZFS_INVALIDNAME, /* invalid dataset name */ 77eda14cbcSMatt Macy EZFS_BADRESTORE, /* unable to restore to destination */ 78eda14cbcSMatt Macy EZFS_BADBACKUP, /* backup failed */ 79eda14cbcSMatt Macy EZFS_BADTARGET, /* bad attach/detach/replace target */ 80eda14cbcSMatt Macy EZFS_NODEVICE, /* no such device in pool */ 81eda14cbcSMatt Macy EZFS_BADDEV, /* invalid device to add */ 82eda14cbcSMatt Macy EZFS_NOREPLICAS, /* no valid replicas */ 83eda14cbcSMatt Macy EZFS_RESILVERING, /* resilvering (healing reconstruction) */ 84eda14cbcSMatt Macy EZFS_BADVERSION, /* unsupported version */ 85eda14cbcSMatt Macy EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 86eda14cbcSMatt Macy EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 87eda14cbcSMatt Macy EZFS_BADPATH, /* must be an absolute path */ 88eda14cbcSMatt Macy EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 89eda14cbcSMatt Macy EZFS_ZONED, /* used improperly in local zone */ 90eda14cbcSMatt Macy EZFS_MOUNTFAILED, /* failed to mount dataset */ 91eda14cbcSMatt Macy EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 927877fdebSMatt Macy EZFS_UNSHARENFSFAILED, /* failed to unshare over nfs */ 937877fdebSMatt Macy EZFS_SHARENFSFAILED, /* failed to share over nfs */ 94eda14cbcSMatt Macy EZFS_PERM, /* permission denied */ 95eda14cbcSMatt Macy EZFS_NOSPC, /* out of space */ 96eda14cbcSMatt Macy EZFS_FAULT, /* bad address */ 97eda14cbcSMatt Macy EZFS_IO, /* I/O error */ 98eda14cbcSMatt Macy EZFS_INTR, /* signal received */ 99eda14cbcSMatt Macy EZFS_ISSPARE, /* device is a hot spare */ 100eda14cbcSMatt Macy EZFS_INVALCONFIG, /* invalid vdev configuration */ 101eda14cbcSMatt Macy EZFS_RECURSIVE, /* recursive dependency */ 102eda14cbcSMatt Macy EZFS_NOHISTORY, /* no history object */ 103eda14cbcSMatt Macy EZFS_POOLPROPS, /* couldn't retrieve pool props */ 104eda14cbcSMatt Macy EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 105eda14cbcSMatt Macy EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 106eda14cbcSMatt Macy EZFS_NAMETOOLONG, /* dataset name is too long */ 107eda14cbcSMatt Macy EZFS_OPENFAILED, /* open of device failed */ 108eda14cbcSMatt Macy EZFS_NOCAP, /* couldn't get capacity */ 109eda14cbcSMatt Macy EZFS_LABELFAILED, /* write of label failed */ 110eda14cbcSMatt Macy EZFS_BADWHO, /* invalid permission who */ 111eda14cbcSMatt Macy EZFS_BADPERM, /* invalid permission */ 112eda14cbcSMatt Macy EZFS_BADPERMSET, /* invalid permission set name */ 113eda14cbcSMatt Macy EZFS_NODELEGATION, /* delegated administration is disabled */ 114eda14cbcSMatt Macy EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 115eda14cbcSMatt Macy EZFS_SHARESMBFAILED, /* failed to share over smb */ 116eda14cbcSMatt Macy EZFS_BADCACHE, /* bad cache file */ 117eda14cbcSMatt Macy EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 118eda14cbcSMatt Macy EZFS_VDEVNOTSUP, /* unsupported vdev type */ 119eda14cbcSMatt Macy EZFS_NOTSUP, /* ops not supported on this dataset */ 120eda14cbcSMatt Macy EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 121eda14cbcSMatt Macy EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 122eda14cbcSMatt Macy EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 123eda14cbcSMatt Macy EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 124eda14cbcSMatt Macy EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 125eda14cbcSMatt Macy EZFS_PIPEFAILED, /* pipe create failed */ 126eda14cbcSMatt Macy EZFS_THREADCREATEFAILED, /* thread create failed */ 127eda14cbcSMatt Macy EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 128eda14cbcSMatt Macy EZFS_SCRUBBING, /* currently scrubbing */ 129c0a83fe0SMartin Matuska EZFS_ERRORSCRUBBING, /* currently error scrubbing */ 130c0a83fe0SMartin Matuska EZFS_ERRORSCRUB_PAUSED, /* error scrub currently paused */ 131eda14cbcSMatt Macy EZFS_NO_SCRUB, /* no active scrub */ 132eda14cbcSMatt Macy EZFS_DIFF, /* general failure of zfs diff */ 133eda14cbcSMatt Macy EZFS_DIFFDATA, /* bad zfs diff data */ 134eda14cbcSMatt Macy EZFS_POOLREADONLY, /* pool is in read-only mode */ 135eda14cbcSMatt Macy EZFS_SCRUB_PAUSED, /* scrub currently paused */ 136c0a83fe0SMartin Matuska EZFS_SCRUB_PAUSED_TO_CANCEL, /* scrub currently paused */ 137eda14cbcSMatt Macy EZFS_ACTIVE_POOL, /* pool is imported on a different system */ 138eda14cbcSMatt Macy EZFS_CRYPTOFAILED, /* failed to setup encryption */ 139eda14cbcSMatt Macy EZFS_NO_PENDING, /* cannot cancel, no operation is pending */ 140eda14cbcSMatt Macy EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */ 141eda14cbcSMatt Macy EZFS_DISCARDING_CHECKPOINT, /* currently discarding a checkpoint */ 142eda14cbcSMatt Macy EZFS_NO_CHECKPOINT, /* pool has no checkpoint */ 143eda14cbcSMatt Macy EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */ 144eda14cbcSMatt Macy EZFS_VDEV_TOO_BIG, /* a device is too big to be used */ 145eda14cbcSMatt Macy EZFS_IOC_NOTSUPPORTED, /* operation not supported by zfs module */ 146eda14cbcSMatt Macy EZFS_TOOMANY, /* argument list too long */ 147eda14cbcSMatt Macy EZFS_INITIALIZING, /* currently initializing */ 148eda14cbcSMatt Macy EZFS_NO_INITIALIZE, /* no active initialize */ 149eda14cbcSMatt Macy EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */ 150eda14cbcSMatt Macy EZFS_TRIMMING, /* currently trimming */ 151eda14cbcSMatt Macy EZFS_NO_TRIM, /* no active trim */ 152eda14cbcSMatt Macy EZFS_TRIM_NOTSUP, /* device does not support trim */ 153eda14cbcSMatt Macy EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ 154eda14cbcSMatt Macy EZFS_EXPORT_IN_PROGRESS, /* currently exporting the pool */ 155eda14cbcSMatt Macy EZFS_REBUILDING, /* resilvering (sequential reconstrution) */ 156681ce946SMartin Matuska EZFS_VDEV_NOTSUP, /* ops not supported for this type of vdev */ 1571f1e2261SMartin Matuska EZFS_NOT_USER_NAMESPACE, /* a file is not a user namespace */ 158c7046f76SMartin Matuska EZFS_CKSUM, /* insufficient replicas */ 159be181ee2SMartin Matuska EZFS_RESUME_EXISTS, /* Resume on existing dataset without force */ 1602ad756a6SMartin Matuska EZFS_SHAREFAILED, /* filesystem share failed */ 161e716630dSMartin Matuska EZFS_RAIDZ_EXPAND_IN_PROGRESS, /* a raidz is currently expanding */ 162783d3ff6SMartin Matuska EZFS_ASHIFT_MISMATCH, /* can't add vdevs with different ashifts */ 163eda14cbcSMatt Macy EZFS_UNKNOWN 164eda14cbcSMatt Macy } zfs_error_t; 165eda14cbcSMatt Macy 166eda14cbcSMatt Macy /* 167eda14cbcSMatt Macy * The following data structures are all part 168eda14cbcSMatt Macy * of the zfs_allow_t data structure which is 169eda14cbcSMatt Macy * used for printing 'allow' permissions. 170eda14cbcSMatt Macy * It is a linked list of zfs_allow_t's which 171eda14cbcSMatt Macy * then contain avl tree's for user/group/sets/... 172eda14cbcSMatt Macy * and each one of the entries in those trees have 173eda14cbcSMatt Macy * avl tree's for the permissions they belong to and 174eda14cbcSMatt Macy * whether they are local,descendent or local+descendent 175eda14cbcSMatt Macy * permissions. The AVL trees are used primarily for 176eda14cbcSMatt Macy * sorting purposes, but also so that we can quickly find 177eda14cbcSMatt Macy * a given user and or permission. 178eda14cbcSMatt Macy */ 179eda14cbcSMatt Macy typedef struct zfs_perm_node { 180eda14cbcSMatt Macy avl_node_t z_node; 181eda14cbcSMatt Macy char z_pname[MAXPATHLEN]; 182eda14cbcSMatt Macy } zfs_perm_node_t; 183eda14cbcSMatt Macy 184eda14cbcSMatt Macy typedef struct zfs_allow_node { 185eda14cbcSMatt Macy avl_node_t z_node; 186eda14cbcSMatt Macy char z_key[MAXPATHLEN]; /* name, such as joe */ 187eda14cbcSMatt Macy avl_tree_t z_localdescend; /* local+descendent perms */ 188eda14cbcSMatt Macy avl_tree_t z_local; /* local permissions */ 189eda14cbcSMatt Macy avl_tree_t z_descend; /* descendent permissions */ 190eda14cbcSMatt Macy } zfs_allow_node_t; 191eda14cbcSMatt Macy 192eda14cbcSMatt Macy typedef struct zfs_allow { 193eda14cbcSMatt Macy struct zfs_allow *z_next; 194eda14cbcSMatt Macy char z_setpoint[MAXPATHLEN]; 195eda14cbcSMatt Macy avl_tree_t z_sets; 196eda14cbcSMatt Macy avl_tree_t z_crperms; 197eda14cbcSMatt Macy avl_tree_t z_user; 198eda14cbcSMatt Macy avl_tree_t z_group; 199eda14cbcSMatt Macy avl_tree_t z_everyone; 200eda14cbcSMatt Macy } zfs_allow_t; 201eda14cbcSMatt Macy 202eda14cbcSMatt Macy /* 203eda14cbcSMatt Macy * Basic handle types 204eda14cbcSMatt Macy */ 205eda14cbcSMatt Macy typedef struct zfs_handle zfs_handle_t; 206eda14cbcSMatt Macy typedef struct zpool_handle zpool_handle_t; 207eda14cbcSMatt Macy typedef struct libzfs_handle libzfs_handle_t; 208eda14cbcSMatt Macy 20916038816SMartin Matuska _LIBZFS_H int zpool_wait(zpool_handle_t *, zpool_wait_activity_t); 21016038816SMartin Matuska _LIBZFS_H int zpool_wait_status(zpool_handle_t *, zpool_wait_activity_t, 211eda14cbcSMatt Macy boolean_t *, boolean_t *); 212eda14cbcSMatt Macy 213eda14cbcSMatt Macy /* 214eda14cbcSMatt Macy * Library initialization 215eda14cbcSMatt Macy */ 21616038816SMartin Matuska _LIBZFS_H libzfs_handle_t *libzfs_init(void); 21716038816SMartin Matuska _LIBZFS_H void libzfs_fini(libzfs_handle_t *); 218eda14cbcSMatt Macy 21916038816SMartin Matuska _LIBZFS_H libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 22016038816SMartin Matuska _LIBZFS_H libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 221eda14cbcSMatt Macy 22216038816SMartin Matuska _LIBZFS_H void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 223eda14cbcSMatt Macy 22416038816SMartin Matuska _LIBZFS_H void zfs_save_arguments(int argc, char **, char *, int); 22516038816SMartin Matuska _LIBZFS_H int zpool_log_history(libzfs_handle_t *, const char *); 226eda14cbcSMatt Macy 22716038816SMartin Matuska _LIBZFS_H int libzfs_errno(libzfs_handle_t *); 22816038816SMartin Matuska _LIBZFS_H const char *libzfs_error_init(int); 22916038816SMartin Matuska _LIBZFS_H const char *libzfs_error_action(libzfs_handle_t *); 23016038816SMartin Matuska _LIBZFS_H const char *libzfs_error_description(libzfs_handle_t *); 23116038816SMartin Matuska _LIBZFS_H int zfs_standard_error(libzfs_handle_t *, int, const char *); 23216038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_init(libzfs_handle_t *); 23316038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_fini(libzfs_handle_t *); 23416038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 23516038816SMartin Matuska _LIBZFS_H int libzfs_mnttab_find(libzfs_handle_t *, const char *, 236eda14cbcSMatt Macy struct mnttab *); 23716038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_add(libzfs_handle_t *, const char *, 238eda14cbcSMatt Macy const char *, const char *); 23916038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 240eda14cbcSMatt Macy 241eda14cbcSMatt Macy /* 242eda14cbcSMatt Macy * Basic handle functions 243eda14cbcSMatt Macy */ 24416038816SMartin Matuska _LIBZFS_H zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 24516038816SMartin Matuska _LIBZFS_H zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 24616038816SMartin Matuska _LIBZFS_H void zpool_close(zpool_handle_t *); 24716038816SMartin Matuska _LIBZFS_H const char *zpool_get_name(zpool_handle_t *); 24816038816SMartin Matuska _LIBZFS_H int zpool_get_state(zpool_handle_t *); 24916038816SMartin Matuska _LIBZFS_H const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 25016038816SMartin Matuska _LIBZFS_H const char *zpool_pool_state_to_name(pool_state_t); 25116038816SMartin Matuska _LIBZFS_H void zpool_free_handles(libzfs_handle_t *); 252eda14cbcSMatt Macy 253eda14cbcSMatt Macy /* 254eda14cbcSMatt Macy * Iterate over all active pools in the system. 255eda14cbcSMatt Macy */ 256eda14cbcSMatt Macy typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 25716038816SMartin Matuska _LIBZFS_H int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 25816038816SMartin Matuska _LIBZFS_H boolean_t zpool_skip_pool(const char *); 259eda14cbcSMatt Macy 260eda14cbcSMatt Macy /* 261eda14cbcSMatt Macy * Functions to create and destroy pools 262eda14cbcSMatt Macy */ 26316038816SMartin Matuska _LIBZFS_H int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 264eda14cbcSMatt Macy nvlist_t *, nvlist_t *); 26516038816SMartin Matuska _LIBZFS_H int zpool_destroy(zpool_handle_t *, const char *); 266783d3ff6SMartin Matuska _LIBZFS_H int zpool_add(zpool_handle_t *, nvlist_t *, boolean_t check_ashift); 267eda14cbcSMatt Macy 268eda14cbcSMatt Macy typedef struct splitflags { 269eda14cbcSMatt Macy /* do not split, but return the config that would be split off */ 270dbd5678dSMartin Matuska unsigned int dryrun : 1; 271eda14cbcSMatt Macy 272eda14cbcSMatt Macy /* after splitting, import the pool */ 273dbd5678dSMartin Matuska unsigned int import : 1; 274eda14cbcSMatt Macy int name_flags; 275eda14cbcSMatt Macy } splitflags_t; 276eda14cbcSMatt Macy 277eda14cbcSMatt Macy typedef struct trimflags { 278eda14cbcSMatt Macy /* requested vdevs are for the entire pool */ 279eda14cbcSMatt Macy boolean_t fullpool; 280eda14cbcSMatt Macy 281eda14cbcSMatt Macy /* request a secure trim, requires support from device */ 282eda14cbcSMatt Macy boolean_t secure; 283eda14cbcSMatt Macy 284eda14cbcSMatt Macy /* after starting trim, block until trim completes */ 285eda14cbcSMatt Macy boolean_t wait; 286eda14cbcSMatt Macy 287eda14cbcSMatt Macy /* trim at the requested rate in bytes/second */ 288eda14cbcSMatt Macy uint64_t rate; 289eda14cbcSMatt Macy } trimflags_t; 290eda14cbcSMatt Macy 291eda14cbcSMatt Macy /* 292eda14cbcSMatt Macy * Functions to manipulate pool and vdev state 293eda14cbcSMatt Macy */ 29416038816SMartin Matuska _LIBZFS_H int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 29516038816SMartin Matuska _LIBZFS_H int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, 296eda14cbcSMatt Macy nvlist_t *); 29716038816SMartin Matuska _LIBZFS_H int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t, 298eda14cbcSMatt Macy nvlist_t *); 29916038816SMartin Matuska _LIBZFS_H int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *, 300eda14cbcSMatt Macy trimflags_t *); 301eda14cbcSMatt Macy 30216038816SMartin Matuska _LIBZFS_H int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 30316038816SMartin Matuska _LIBZFS_H int zpool_reguid(zpool_handle_t *); 304e2df9bb4SMartin Matuska _LIBZFS_H int zpool_set_guid(zpool_handle_t *, const uint64_t *); 30516038816SMartin Matuska _LIBZFS_H int zpool_reopen_one(zpool_handle_t *, void *); 306eda14cbcSMatt Macy 30716038816SMartin Matuska _LIBZFS_H int zpool_sync_one(zpool_handle_t *, void *); 308eda14cbcSMatt Macy 309e2df9bb4SMartin Matuska _LIBZFS_H int zpool_ddt_prune(zpool_handle_t *, zpool_ddt_prune_unit_t, 310e2df9bb4SMartin Matuska uint64_t); 311e2df9bb4SMartin Matuska 31216038816SMartin Matuska _LIBZFS_H int zpool_vdev_online(zpool_handle_t *, const char *, int, 313eda14cbcSMatt Macy vdev_state_t *); 31416038816SMartin Matuska _LIBZFS_H int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 31516038816SMartin Matuska _LIBZFS_H int zpool_vdev_attach(zpool_handle_t *, const char *, 316eda14cbcSMatt Macy const char *, nvlist_t *, int, boolean_t); 31716038816SMartin Matuska _LIBZFS_H int zpool_vdev_detach(zpool_handle_t *, const char *); 31816038816SMartin Matuska _LIBZFS_H int zpool_vdev_remove(zpool_handle_t *, const char *); 31916038816SMartin Matuska _LIBZFS_H int zpool_vdev_remove_cancel(zpool_handle_t *); 32016038816SMartin Matuska _LIBZFS_H int zpool_vdev_indirect_size(zpool_handle_t *, const char *, 32116038816SMartin Matuska uint64_t *); 32216038816SMartin Matuska _LIBZFS_H int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, 32316038816SMartin Matuska nvlist_t *, splitflags_t); 324be181ee2SMartin Matuska _LIBZFS_H int zpool_vdev_remove_wanted(zpool_handle_t *, const char *); 325eda14cbcSMatt Macy 32616038816SMartin Matuska _LIBZFS_H int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 32716038816SMartin Matuska _LIBZFS_H int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 328b356da80SMartin Matuska _LIBZFS_H int zpool_vdev_set_removed_state(zpool_handle_t *, uint64_t, 329b356da80SMartin Matuska vdev_aux_t); 330b356da80SMartin Matuska 33116038816SMartin Matuska _LIBZFS_H int zpool_vdev_clear(zpool_handle_t *, uint64_t); 332eda14cbcSMatt Macy 33316038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 334eda14cbcSMatt Macy boolean_t *, boolean_t *); 335ce4dcb97SMartin Matuska _LIBZFS_H nvlist_t *zpool_find_parent_vdev(zpool_handle_t *, const char *, 336ce4dcb97SMartin Matuska boolean_t *, boolean_t *, boolean_t *); 33716038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 338eda14cbcSMatt Macy boolean_t *, boolean_t *, boolean_t *); 33916038816SMartin Matuska _LIBZFS_H int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, 34016038816SMartin Matuska const char *); 341abcdc1b9SMartin Matuska _LIBZFS_H int zpool_prepare_disk(zpool_handle_t *zhp, nvlist_t *vdev_nv, 342abcdc1b9SMartin Matuska const char *prepare_str, char **lines[], int *lines_cnt); 343abcdc1b9SMartin Matuska _LIBZFS_H int zpool_prepare_and_label_disk(libzfs_handle_t *hdl, 344abcdc1b9SMartin Matuska zpool_handle_t *, const char *, nvlist_t *vdev_nv, const char *prepare_str, 345abcdc1b9SMartin Matuska char **lines[], int *lines_cnt); 346abcdc1b9SMartin Matuska _LIBZFS_H char ** zpool_vdev_script_alloc_env(const char *pool_name, 347abcdc1b9SMartin Matuska const char *vdev_path, const char *vdev_upath, 348abcdc1b9SMartin Matuska const char *vdev_enc_sysfs_path, const char *opt_key, const char *opt_val); 349abcdc1b9SMartin Matuska _LIBZFS_H void zpool_vdev_script_free_env(char **env); 35016038816SMartin Matuska _LIBZFS_H uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, 35116038816SMartin Matuska const char *path); 352eda14cbcSMatt Macy 35316038816SMartin Matuska _LIBZFS_H const char *zpool_get_state_str(zpool_handle_t *); 354eda14cbcSMatt Macy 355eda14cbcSMatt Macy /* 356eda14cbcSMatt Macy * Functions to manage pool properties 357eda14cbcSMatt Macy */ 35816038816SMartin Matuska _LIBZFS_H int zpool_set_prop(zpool_handle_t *, const char *, const char *); 35916038816SMartin Matuska _LIBZFS_H int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 360eda14cbcSMatt Macy size_t proplen, zprop_source_t *, boolean_t literal); 361c98ecfceSAllan Jude _LIBZFS_H int zpool_get_userprop(zpool_handle_t *, const char *, char *, 362c98ecfceSAllan Jude size_t proplen, zprop_source_t *); 36316038816SMartin Matuska _LIBZFS_H uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 364eda14cbcSMatt Macy zprop_source_t *); 36516038816SMartin Matuska _LIBZFS_H int zpool_props_refresh(zpool_handle_t *); 366eda14cbcSMatt Macy 36716038816SMartin Matuska _LIBZFS_H const char *zpool_prop_to_name(zpool_prop_t); 36816038816SMartin Matuska _LIBZFS_H const char *zpool_prop_values(zpool_prop_t); 369eda14cbcSMatt Macy 370eda14cbcSMatt Macy /* 371681ce946SMartin Matuska * Functions to manage vdev properties 372681ce946SMartin Matuska */ 373681ce946SMartin Matuska _LIBZFS_H int zpool_get_vdev_prop_value(nvlist_t *, vdev_prop_t, char *, char *, 374681ce946SMartin Matuska size_t, zprop_source_t *, boolean_t); 375681ce946SMartin Matuska _LIBZFS_H int zpool_get_vdev_prop(zpool_handle_t *, const char *, vdev_prop_t, 376681ce946SMartin Matuska char *, char *, size_t, zprop_source_t *, boolean_t); 377681ce946SMartin Matuska _LIBZFS_H int zpool_get_all_vdev_props(zpool_handle_t *, const char *, 378681ce946SMartin Matuska nvlist_t **); 379681ce946SMartin Matuska _LIBZFS_H int zpool_set_vdev_prop(zpool_handle_t *, const char *, const char *, 380681ce946SMartin Matuska const char *); 381681ce946SMartin Matuska 382681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_to_name(vdev_prop_t); 383681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_values(vdev_prop_t); 384681ce946SMartin Matuska _LIBZFS_H boolean_t vdev_prop_user(const char *name); 385681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_column_name(vdev_prop_t); 386681ce946SMartin Matuska _LIBZFS_H boolean_t vdev_prop_align_right(vdev_prop_t); 387681ce946SMartin Matuska 388681ce946SMartin Matuska /* 389eda14cbcSMatt Macy * Pool health statistics. 390eda14cbcSMatt Macy */ 391eda14cbcSMatt Macy typedef enum { 392eda14cbcSMatt Macy /* 393eda14cbcSMatt Macy * The following correspond to faults as defined in the (fault.fs.zfs.*) 394eda14cbcSMatt Macy * event namespace. Each is associated with a corresponding message ID. 395eda14cbcSMatt Macy * This must be kept in sync with the zfs_msgid_table in 396eda14cbcSMatt Macy * lib/libzfs/libzfs_status.c. 397eda14cbcSMatt Macy */ 398eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 399eda14cbcSMatt Macy ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 400eda14cbcSMatt Macy ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 401eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 402eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 403eda14cbcSMatt Macy ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 404eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 405eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 406eda14cbcSMatt Macy ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 407eda14cbcSMatt Macy ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 408eda14cbcSMatt Macy ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 409eda14cbcSMatt Macy ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ 410eda14cbcSMatt Macy ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ 411eda14cbcSMatt Macy ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 412eda14cbcSMatt Macy ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 413eda14cbcSMatt Macy ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ 414eda14cbcSMatt Macy ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 415eda14cbcSMatt Macy ZPOOL_STATUS_ERRATA, /* informational errata available */ 416eda14cbcSMatt Macy 417eda14cbcSMatt Macy /* 418eda14cbcSMatt Macy * If the pool has unsupported features but can still be opened in 419eda14cbcSMatt Macy * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 420eda14cbcSMatt Macy * pool has unsupported features but cannot be opened at all, its 421eda14cbcSMatt Macy * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 422eda14cbcSMatt Macy */ 423eda14cbcSMatt Macy ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 424eda14cbcSMatt Macy ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 425eda14cbcSMatt Macy 426eda14cbcSMatt Macy /* 427eda14cbcSMatt Macy * These faults have no corresponding message ID. At the time we are 428eda14cbcSMatt Macy * checking the status, the original reason for the FMA fault (I/O or 429eda14cbcSMatt Macy * checksum errors) has been lost. 430eda14cbcSMatt Macy */ 431eda14cbcSMatt Macy ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 432eda14cbcSMatt Macy ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 433eda14cbcSMatt Macy 434eda14cbcSMatt Macy /* 435eda14cbcSMatt Macy * The following are not faults per se, but still an error possibly 436eda14cbcSMatt Macy * requiring administrative attention. There is no corresponding 437eda14cbcSMatt Macy * message ID. 438eda14cbcSMatt Macy */ 439eda14cbcSMatt Macy ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 440eda14cbcSMatt Macy ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 441eda14cbcSMatt Macy ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 442eda14cbcSMatt Macy ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 443eda14cbcSMatt Macy ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 444eda14cbcSMatt Macy ZPOOL_STATUS_REBUILDING, /* device being rebuilt */ 445eda14cbcSMatt Macy ZPOOL_STATUS_REBUILD_SCRUB, /* recommend scrubbing the pool */ 446eda14cbcSMatt Macy ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */ 447ee36e25aSMartin Matuska ZPOOL_STATUS_COMPATIBILITY_ERR, /* bad 'compatibility' property */ 44816038816SMartin Matuska ZPOOL_STATUS_INCOMPATIBLE_FEAT, /* feature set outside compatibility */ 449eda14cbcSMatt Macy 450eda14cbcSMatt Macy /* 451eda14cbcSMatt Macy * Finally, the following indicates a healthy pool. 452eda14cbcSMatt Macy */ 453eda14cbcSMatt Macy ZPOOL_STATUS_OK 454eda14cbcSMatt Macy } zpool_status_t; 455eda14cbcSMatt Macy 456a0b956f5SMartin Matuska _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, const char **, 457eda14cbcSMatt Macy zpool_errata_t *); 458a0b956f5SMartin Matuska _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, const char **, 459eda14cbcSMatt Macy zpool_errata_t *); 460eda14cbcSMatt Macy 461eda14cbcSMatt Macy /* 462eda14cbcSMatt Macy * Statistics and configuration functions. 463eda14cbcSMatt Macy */ 46416038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 46516038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *); 46616038816SMartin Matuska _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 46716038816SMartin Matuska _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 468ce4dcb97SMartin Matuska _LIBZFS_H void zpool_add_propname(zpool_handle_t *, const char *); 469eda14cbcSMatt Macy 470eda14cbcSMatt Macy /* 471eda14cbcSMatt Macy * Import and export functions 472eda14cbcSMatt Macy */ 47316038816SMartin Matuska _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *); 47416038816SMartin Matuska _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *); 47516038816SMartin Matuska _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 476eda14cbcSMatt Macy char *altroot); 47716038816SMartin Matuska _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 478eda14cbcSMatt Macy nvlist_t *, int); 479ce4dcb97SMartin Matuska _LIBZFS_H void zpool_collect_unsup_feat(nvlist_t *config, char *buf, 480ce4dcb97SMartin Matuska size_t size); 481eda14cbcSMatt Macy 482eda14cbcSMatt Macy /* 483eda14cbcSMatt Macy * Miscellaneous pool functions 484eda14cbcSMatt Macy */ 485eda14cbcSMatt Macy struct zfs_cmd; 486eda14cbcSMatt Macy 487e92ffd9bSMartin Matuska _LIBZFS_H const char *const zfs_history_event_names[]; 488eda14cbcSMatt Macy 489eda14cbcSMatt Macy typedef enum { 490eda14cbcSMatt Macy VDEV_NAME_PATH = 1 << 0, 491eda14cbcSMatt Macy VDEV_NAME_GUID = 1 << 1, 492eda14cbcSMatt Macy VDEV_NAME_FOLLOW_LINKS = 1 << 2, 493eda14cbcSMatt Macy VDEV_NAME_TYPE_ID = 1 << 3, 494eda14cbcSMatt Macy } vdev_name_t; 495eda14cbcSMatt Macy 49616038816SMartin Matuska _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 497eda14cbcSMatt Macy int name_flags); 49816038816SMartin Matuska _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t); 49916038816SMartin Matuska _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *, 500eda14cbcSMatt Macy boolean_t *); 50116038816SMartin Matuska _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, 502eda14cbcSMatt Macy int); 50316038816SMartin Matuska _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *); 50416038816SMartin Matuska _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int); 50516038816SMartin Matuska _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t, 50616038816SMartin Matuska char *, size_t); 50716038816SMartin Matuska _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 508eda14cbcSMatt Macy size_t); 50916038816SMartin Matuska _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 51016038816SMartin Matuska _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int, 511ce4dcb97SMartin Matuska nvlist_t *, char *, size_t); 51216038816SMartin Matuska _LIBZFS_H int zpool_checkpoint(zpool_handle_t *); 51316038816SMartin Matuska _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *); 51416038816SMartin Matuska _LIBZFS_H boolean_t zpool_is_draid_spare(const char *); 515eda14cbcSMatt Macy 516ce4dcb97SMartin Matuska _LIBZFS_H int zpool_prefetch(zpool_handle_t *, zpool_prefetch_type_t); 517ce4dcb97SMartin Matuska 518eda14cbcSMatt Macy /* 519eda14cbcSMatt Macy * Basic handle manipulations. These functions do not create or destroy the 520eda14cbcSMatt Macy * underlying datasets, only the references to them. 521eda14cbcSMatt Macy */ 52216038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 52316038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 52416038816SMartin Matuska _LIBZFS_H void zfs_close(zfs_handle_t *); 52516038816SMartin Matuska _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *); 52616038816SMartin Matuska _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *); 52716038816SMartin Matuska _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *); 52816038816SMartin Matuska _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 52916038816SMartin Matuska _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *); 530eda14cbcSMatt Macy 531eda14cbcSMatt Macy /* 532eda14cbcSMatt Macy * Property management functions. Some functions are shared with the kernel, 533eda14cbcSMatt Macy * and are found in sys/fs/zfs.h. 534eda14cbcSMatt Macy */ 535eda14cbcSMatt Macy 536eda14cbcSMatt Macy /* 537eda14cbcSMatt Macy * zfs dataset property management 538eda14cbcSMatt Macy */ 53916038816SMartin Matuska _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t); 54016038816SMartin Matuska _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t); 54116038816SMartin Matuska _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t); 54216038816SMartin Matuska _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t); 543eda14cbcSMatt Macy 54416038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 54516038816SMartin Matuska nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, 54616038816SMartin Matuska const char *); 547eda14cbcSMatt Macy 54816038816SMartin Matuska _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t); 54916038816SMartin Matuska _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *); 55016038816SMartin Matuska _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 551f7f4bd06SMartin Matuska _LIBZFS_H int zfs_prop_set_list_flags(zfs_handle_t *, nvlist_t *, int); 55216038816SMartin Matuska _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 553eda14cbcSMatt Macy zprop_source_t *, char *, size_t, boolean_t); 55416038816SMartin Matuska _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 555eda14cbcSMatt Macy boolean_t); 55616038816SMartin Matuska _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 557eda14cbcSMatt Macy zprop_source_t *, char *, size_t); 55816038816SMartin Matuska _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp, 55916038816SMartin Matuska const char *propname, uint64_t *propvalue); 56016038816SMartin Matuska _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 561eda14cbcSMatt Macy char *propbuf, int proplen, boolean_t literal); 56216038816SMartin Matuska _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 563eda14cbcSMatt Macy uint64_t *propvalue); 56416038816SMartin Matuska _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 565eda14cbcSMatt Macy char *propbuf, int proplen, boolean_t literal); 56616038816SMartin Matuska _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 567eda14cbcSMatt Macy char *buf, size_t len); 5682a58b312SMartin Matuska _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, const char **); 56916038816SMartin Matuska _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 57016038816SMartin Matuska _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 57116038816SMartin Matuska _LIBZFS_H const char *zfs_prop_values(zfs_prop_t); 57216038816SMartin Matuska _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop); 57316038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *); 57416038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *); 57516038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 57616038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 577eda14cbcSMatt Macy 57816038816SMartin Matuska _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t, 579eda14cbcSMatt Macy boolean_t *, boolean_t *); 580eda14cbcSMatt Macy 581eda14cbcSMatt Macy /* 582eda14cbcSMatt Macy * zfs encryption management 583eda14cbcSMatt Macy */ 58416038816SMartin Matuska _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, 58516038816SMartin Matuska char *); 58616038816SMartin Matuska _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, 58716038816SMartin Matuska nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *); 58816038816SMartin Matuska _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, 589eda14cbcSMatt Macy nvlist_t *); 590c03c5b1cSMartin Matuska _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *); 591c03c5b1cSMartin Matuska _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *); 59216038816SMartin Matuska _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *); 59316038816SMartin Matuska _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); 594eda14cbcSMatt Macy 595eda14cbcSMatt Macy typedef struct zprop_list { 596eda14cbcSMatt Macy int pl_prop; 597eda14cbcSMatt Macy char *pl_user_prop; 598eda14cbcSMatt Macy struct zprop_list *pl_next; 599eda14cbcSMatt Macy boolean_t pl_all; 600eda14cbcSMatt Macy size_t pl_width; 601eda14cbcSMatt Macy size_t pl_recvd_width; 602eda14cbcSMatt Macy boolean_t pl_fixed; 603eda14cbcSMatt Macy } zprop_list_t; 604eda14cbcSMatt Macy 60516038816SMartin Matuska _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 606eda14cbcSMatt Macy boolean_t); 60716038816SMartin Matuska _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 608681ce946SMartin Matuska _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *, 609681ce946SMartin Matuska zprop_list_t **); 610eda14cbcSMatt Macy 611eda14cbcSMatt Macy #define ZFS_MOUNTPOINT_NONE "none" 612eda14cbcSMatt Macy #define ZFS_MOUNTPOINT_LEGACY "legacy" 613eda14cbcSMatt Macy 614eda14cbcSMatt Macy #define ZFS_FEATURE_DISABLED "disabled" 615eda14cbcSMatt Macy #define ZFS_FEATURE_ENABLED "enabled" 616eda14cbcSMatt Macy #define ZFS_FEATURE_ACTIVE "active" 617eda14cbcSMatt Macy 618eda14cbcSMatt Macy #define ZFS_UNSUPPORTED_INACTIVE "inactive" 619eda14cbcSMatt Macy #define ZFS_UNSUPPORTED_READONLY "readonly" 620eda14cbcSMatt Macy 621eda14cbcSMatt Macy /* 622eda14cbcSMatt Macy * zpool property management 623eda14cbcSMatt Macy */ 62416038816SMartin Matuska _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **, 625681ce946SMartin Matuska zfs_type_t, boolean_t); 62616038816SMartin Matuska _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 627eda14cbcSMatt Macy size_t); 62816038816SMartin Matuska _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t); 62916038816SMartin Matuska _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t); 63016038816SMartin Matuska _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t); 63116038816SMartin Matuska _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t); 632eda14cbcSMatt Macy 633eda14cbcSMatt Macy /* 634eda14cbcSMatt Macy * Functions shared by zfs and zpool property management. 635eda14cbcSMatt Macy */ 63616038816SMartin Matuska _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 637eda14cbcSMatt Macy boolean_t ordered, zfs_type_t type); 63816038816SMartin Matuska _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 639eda14cbcSMatt Macy zfs_type_t); 64016038816SMartin Matuska _LIBZFS_H void zprop_free_list(zprop_list_t *); 641eda14cbcSMatt Macy 642ce4dcb97SMartin Matuska _LIBZFS_H void zcmd_print_json(nvlist_t *); 643ce4dcb97SMartin Matuska 644eda14cbcSMatt Macy #define ZFS_GET_NCOLS 5 645eda14cbcSMatt Macy 646eda14cbcSMatt Macy typedef enum { 647eda14cbcSMatt Macy GET_COL_NONE, 648eda14cbcSMatt Macy GET_COL_NAME, 649eda14cbcSMatt Macy GET_COL_PROPERTY, 650eda14cbcSMatt Macy GET_COL_VALUE, 651eda14cbcSMatt Macy GET_COL_RECVD, 652eda14cbcSMatt Macy GET_COL_SOURCE 653eda14cbcSMatt Macy } zfs_get_column_t; 654eda14cbcSMatt Macy 655eda14cbcSMatt Macy /* 656eda14cbcSMatt Macy * Functions for printing zfs or zpool properties 657eda14cbcSMatt Macy */ 658681ce946SMartin Matuska typedef struct vdev_cbdata { 659681ce946SMartin Matuska int cb_name_flags; 660681ce946SMartin Matuska char **cb_names; 661681ce946SMartin Matuska unsigned int cb_names_count; 662681ce946SMartin Matuska } vdev_cbdata_t; 663681ce946SMartin Matuska 664eda14cbcSMatt Macy typedef struct zprop_get_cbdata { 665eda14cbcSMatt Macy int cb_sources; 666eda14cbcSMatt Macy zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 667eda14cbcSMatt Macy int cb_colwidths[ZFS_GET_NCOLS + 1]; 668eda14cbcSMatt Macy boolean_t cb_scripted; 669eda14cbcSMatt Macy boolean_t cb_literal; 670eda14cbcSMatt Macy boolean_t cb_first; 671ce4dcb97SMartin Matuska boolean_t cb_json; 672eda14cbcSMatt Macy zprop_list_t *cb_proplist; 673eda14cbcSMatt Macy zfs_type_t cb_type; 674681ce946SMartin Matuska vdev_cbdata_t cb_vdevs; 675ce4dcb97SMartin Matuska nvlist_t *cb_jsobj; 676ce4dcb97SMartin Matuska boolean_t cb_json_as_int; 677ce4dcb97SMartin Matuska boolean_t cb_json_pool_key_guid; 678eda14cbcSMatt Macy } zprop_get_cbdata_t; 679eda14cbcSMatt Macy 680f7f4bd06SMartin Matuska #define ZFS_SET_NOMOUNT 1 681f7f4bd06SMartin Matuska 682f7f4bd06SMartin Matuska typedef struct zprop_set_cbdata { 683f7f4bd06SMartin Matuska int cb_flags; 684f7f4bd06SMartin Matuska nvlist_t *cb_proplist; 685f7f4bd06SMartin Matuska } zprop_set_cbdata_t; 686f7f4bd06SMartin Matuska 68716038816SMartin Matuska _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 688eda14cbcSMatt Macy const char *, const char *, zprop_source_t, const char *, 689eda14cbcSMatt Macy const char *); 690eda14cbcSMatt Macy 691ce4dcb97SMartin Matuska _LIBZFS_H int zprop_nvlist_one_property(const char *, const char *, 692ce4dcb97SMartin Matuska zprop_source_t, const char *, const char *, nvlist_t *, boolean_t); 693ce4dcb97SMartin Matuska 694ce4dcb97SMartin Matuska _LIBZFS_H int zprop_collect_property(const char *, zprop_get_cbdata_t *, 695ce4dcb97SMartin Matuska const char *, const char *, zprop_source_t, const char *, 696ce4dcb97SMartin Matuska const char *, nvlist_t *); 697ce4dcb97SMartin Matuska 698eda14cbcSMatt Macy /* 699eda14cbcSMatt Macy * Iterator functions. 700eda14cbcSMatt Macy */ 70115f0b8c3SMartin Matuska #define ZFS_ITER_RECURSE (1 << 0) 70215f0b8c3SMartin Matuska #define ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1) 70315f0b8c3SMartin Matuska #define ZFS_ITER_PROP_LISTSNAPS (1 << 2) 70415f0b8c3SMartin Matuska #define ZFS_ITER_DEPTH_LIMIT (1 << 3) 70515f0b8c3SMartin Matuska #define ZFS_ITER_RECVD_PROPS (1 << 4) 70615f0b8c3SMartin Matuska #define ZFS_ITER_LITERAL_PROPS (1 << 5) 70715f0b8c3SMartin Matuska #define ZFS_ITER_SIMPLE (1 << 6) 70815f0b8c3SMartin Matuska 709eda14cbcSMatt Macy typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 71016038816SMartin Matuska _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 711d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 712d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, 71316038816SMartin Matuska void *); 714d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 715d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *, 716eda14cbcSMatt Macy uint64_t, uint64_t); 717d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *, 718eda14cbcSMatt Macy uint64_t, uint64_t); 719d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, 72016038816SMartin Matuska void *); 721d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 722d411c1d6SMartin Matuska 723d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_children_v2(zfs_handle_t *, int, zfs_iter_f, void *); 724d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_dependents_v2(zfs_handle_t *, int, boolean_t, zfs_iter_f, 725d411c1d6SMartin Matuska void *); 726d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_filesystems_v2(zfs_handle_t *, int, zfs_iter_f, void *); 727d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_v2(zfs_handle_t *, int, zfs_iter_f, void *, 728d411c1d6SMartin Matuska uint64_t, uint64_t); 729d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_sorted_v2(zfs_handle_t *, int, zfs_iter_f, 730d411c1d6SMartin Matuska void *, uint64_t, uint64_t); 731d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapspec_v2(zfs_handle_t *, int, const char *, 732d411c1d6SMartin Matuska zfs_iter_f, void *); 733d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_bookmarks_v2(zfs_handle_t *, int, zfs_iter_f, void *); 73416038816SMartin Matuska _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *); 735eda14cbcSMatt Macy 736eda14cbcSMatt Macy typedef struct get_all_cb { 737eda14cbcSMatt Macy zfs_handle_t **cb_handles; 738eda14cbcSMatt Macy size_t cb_alloc; 739eda14cbcSMatt Macy size_t cb_used; 740eda14cbcSMatt Macy } get_all_cb_t; 741eda14cbcSMatt Macy 74216038816SMartin Matuska _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, 743aca928a5SMartin Matuska size_t, zfs_iter_f, void *, uint_t); 74416038816SMartin Matuska _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 745eda14cbcSMatt Macy 746eda14cbcSMatt Macy /* 747eda14cbcSMatt Macy * Functions to create and destroy datasets. 748eda14cbcSMatt Macy */ 74916038816SMartin Matuska _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 750eda14cbcSMatt Macy nvlist_t *); 75116038816SMartin Matuska _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *); 75216038816SMartin Matuska _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t); 75316038816SMartin Matuska _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 75416038816SMartin Matuska _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 7556ba2210eSMartin Matuska _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *); 75616038816SMartin Matuska _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 75716038816SMartin Matuska _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, 75816038816SMartin Matuska nvlist_t *); 75916038816SMartin Matuska _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 760eda14cbcSMatt Macy nvlist_t *props); 76116038816SMartin Matuska _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 762eac7052fSMatt Macy 763eac7052fSMatt Macy typedef struct renameflags { 764eac7052fSMatt Macy /* recursive rename */ 765dbd5678dSMartin Matuska unsigned int recursive : 1; 766eac7052fSMatt Macy 767eac7052fSMatt Macy /* don't unmount file systems */ 768dbd5678dSMartin Matuska unsigned int nounmount : 1; 769eac7052fSMatt Macy 770eac7052fSMatt Macy /* force unmount file systems */ 771dbd5678dSMartin Matuska unsigned int forceunmount : 1; 772eac7052fSMatt Macy } renameflags_t; 773eac7052fSMatt Macy 77416038816SMartin Matuska _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t); 775eda14cbcSMatt Macy 776eda14cbcSMatt Macy typedef struct sendflags { 777eda14cbcSMatt Macy /* Amount of extra information to print. */ 778eda14cbcSMatt Macy int verbosity; 779eda14cbcSMatt Macy 780eda14cbcSMatt Macy /* recursive send (ie, -R) */ 781eda14cbcSMatt Macy boolean_t replicate; 782eda14cbcSMatt Macy 78316038816SMartin Matuska /* for recursive send, skip sending missing snapshots */ 78416038816SMartin Matuska boolean_t skipmissing; 78516038816SMartin Matuska 786eda14cbcSMatt Macy /* for incrementals, do all intermediate snapshots */ 787eda14cbcSMatt Macy boolean_t doall; 788eda14cbcSMatt Macy 789eda14cbcSMatt Macy /* if dataset is a clone, do incremental from its origin */ 790eda14cbcSMatt Macy boolean_t fromorigin; 791eda14cbcSMatt Macy 792eda14cbcSMatt Macy /* field no longer used, maintained for backwards compatibility */ 793eda14cbcSMatt Macy boolean_t pad; 794eda14cbcSMatt Macy 795eda14cbcSMatt Macy /* send properties (ie, -p) */ 796eda14cbcSMatt Macy boolean_t props; 797eda14cbcSMatt Macy 798eda14cbcSMatt Macy /* do not send (no-op, ie. -n) */ 799eda14cbcSMatt Macy boolean_t dryrun; 800eda14cbcSMatt Macy 801eda14cbcSMatt Macy /* parsable verbose output (ie. -P) */ 802eda14cbcSMatt Macy boolean_t parsable; 803eda14cbcSMatt Macy 804eda14cbcSMatt Macy /* show progress (ie. -v) */ 805eda14cbcSMatt Macy boolean_t progress; 806eda14cbcSMatt Macy 80715f0b8c3SMartin Matuska /* show progress as process title (ie. -V) */ 80815f0b8c3SMartin Matuska boolean_t progressastitle; 80915f0b8c3SMartin Matuska 810eda14cbcSMatt Macy /* large blocks (>128K) are permitted */ 811eda14cbcSMatt Macy boolean_t largeblock; 812eda14cbcSMatt Macy 813eda14cbcSMatt Macy /* WRITE_EMBEDDED records of type DATA are permitted */ 814eda14cbcSMatt Macy boolean_t embed_data; 815eda14cbcSMatt Macy 816eda14cbcSMatt Macy /* compressed WRITE records are permitted */ 817eda14cbcSMatt Macy boolean_t compress; 818eda14cbcSMatt Macy 819eda14cbcSMatt Macy /* raw encrypted records are permitted */ 820eda14cbcSMatt Macy boolean_t raw; 821eda14cbcSMatt Macy 822eda14cbcSMatt Macy /* only send received properties (ie. -b) */ 823eda14cbcSMatt Macy boolean_t backup; 824eda14cbcSMatt Macy 825eda14cbcSMatt Macy /* include snapshot holds in send stream */ 826eda14cbcSMatt Macy boolean_t holds; 827eda14cbcSMatt Macy 828eda14cbcSMatt Macy /* stream represents a partially received dataset */ 829eda14cbcSMatt Macy boolean_t saved; 830eda14cbcSMatt Macy } sendflags_t; 831eda14cbcSMatt Macy 832eda14cbcSMatt Macy typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 833eda14cbcSMatt Macy 83416038816SMartin Matuska _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *, 835eda14cbcSMatt Macy sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 83616038816SMartin Matuska _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *, 837eda14cbcSMatt Macy const char *); 83816038816SMartin Matuska _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *); 83916038816SMartin Matuska _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 840eda14cbcSMatt Macy const char *); 84116038816SMartin Matuska _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *); 84216038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 843eda14cbcSMatt Macy const char *token); 844eda14cbcSMatt Macy 84516038816SMartin Matuska _LIBZFS_H int zfs_promote(zfs_handle_t *); 84616038816SMartin Matuska _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *, 847eda14cbcSMatt Macy boolean_t, int); 84816038816SMartin Matuska _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 84916038816SMartin Matuska _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *, 85016038816SMartin Matuska boolean_t); 85116038816SMartin Matuska _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **); 85216038816SMartin Matuska _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, 853eda14cbcSMatt Macy nvlist_t *); 854eda14cbcSMatt Macy 855eda14cbcSMatt Macy typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 856eda14cbcSMatt Macy uid_t rid, uint64_t space); 857eda14cbcSMatt Macy 85816038816SMartin Matuska _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 859eda14cbcSMatt Macy zfs_userspace_cb_t, void *); 860eda14cbcSMatt Macy 86116038816SMartin Matuska _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 86216038816SMartin Matuska _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 863eda14cbcSMatt Macy 864eda14cbcSMatt Macy typedef struct recvflags { 865eda14cbcSMatt Macy /* print informational messages (ie, -v was specified) */ 866eda14cbcSMatt Macy boolean_t verbose; 867eda14cbcSMatt Macy 868eda14cbcSMatt Macy /* the destination is a prefix, not the exact fs (ie, -d) */ 869eda14cbcSMatt Macy boolean_t isprefix; 870eda14cbcSMatt Macy 871eda14cbcSMatt Macy /* 872eda14cbcSMatt Macy * Only the tail of the sent snapshot path is appended to the 873eda14cbcSMatt Macy * destination to determine the received snapshot name (ie, -e). 874eda14cbcSMatt Macy */ 875eda14cbcSMatt Macy boolean_t istail; 876eda14cbcSMatt Macy 877eda14cbcSMatt Macy /* do not actually do the recv, just check if it would work (ie, -n) */ 878eda14cbcSMatt Macy boolean_t dryrun; 879eda14cbcSMatt Macy 880eda14cbcSMatt Macy /* rollback/destroy filesystems as necessary (eg, -F) */ 881eda14cbcSMatt Macy boolean_t force; 882eda14cbcSMatt Macy 883eda14cbcSMatt Macy /* set "canmount=off" on all modified filesystems */ 884eda14cbcSMatt Macy boolean_t canmountoff; 885eda14cbcSMatt Macy 886eda14cbcSMatt Macy /* 887eda14cbcSMatt Macy * Mark the file systems as "resumable" and do not destroy them if the 888eda14cbcSMatt Macy * receive is interrupted 889eda14cbcSMatt Macy */ 890eda14cbcSMatt Macy boolean_t resumable; 891eda14cbcSMatt Macy 892eda14cbcSMatt Macy /* byteswap flag is used internally; callers need not specify */ 893eda14cbcSMatt Macy boolean_t byteswap; 894eda14cbcSMatt Macy 895eda14cbcSMatt Macy /* do not mount file systems as they are extracted (private) */ 896eda14cbcSMatt Macy boolean_t nomount; 897eda14cbcSMatt Macy 898eda14cbcSMatt Macy /* Was holds flag set in the compound header? */ 899eda14cbcSMatt Macy boolean_t holds; 900eda14cbcSMatt Macy 901eda14cbcSMatt Macy /* skip receive of snapshot holds */ 902eda14cbcSMatt Macy boolean_t skipholds; 903eda14cbcSMatt Macy 904eda14cbcSMatt Macy /* mount the filesystem unless nomount is specified */ 905eda14cbcSMatt Macy boolean_t domount; 906eda14cbcSMatt Macy 907eda14cbcSMatt Macy /* force unmount while recv snapshot (private) */ 908eda14cbcSMatt Macy boolean_t forceunmount; 909271171e0SMartin Matuska 910271171e0SMartin Matuska /* use this recv to check (and heal if needed) an existing snapshot */ 911271171e0SMartin Matuska boolean_t heal; 912eda14cbcSMatt Macy } recvflags_t; 913eda14cbcSMatt Macy 91416038816SMartin Matuska _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 915eda14cbcSMatt Macy recvflags_t *, int, avl_tree_t *); 916eda14cbcSMatt Macy 917eda14cbcSMatt Macy typedef enum diff_flags { 918681ce946SMartin Matuska ZFS_DIFF_PARSEABLE = 1 << 0, 919681ce946SMartin Matuska ZFS_DIFF_TIMESTAMP = 1 << 1, 920681ce946SMartin Matuska ZFS_DIFF_CLASSIFY = 1 << 2, 921681ce946SMartin Matuska ZFS_DIFF_NO_MANGLE = 1 << 3 922eda14cbcSMatt Macy } diff_flags_t; 923eda14cbcSMatt Macy 92416038816SMartin Matuska _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 925eda14cbcSMatt Macy int); 926eda14cbcSMatt Macy 927eda14cbcSMatt Macy /* 928eda14cbcSMatt Macy * Miscellaneous functions. 929eda14cbcSMatt Macy */ 93016038816SMartin Matuska _LIBZFS_H const char *zfs_type_to_name(zfs_type_t); 93116038816SMartin Matuska _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *); 93216038816SMartin Matuska _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t); 93316038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *, 934eda14cbcSMatt Macy zfs_type_t); 93516038816SMartin Matuska _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t); 93616038816SMartin Matuska _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 937eda14cbcSMatt Macy zfs_type_t); 93816038816SMartin Matuska _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *); 93916038816SMartin Matuska _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path); 940eda14cbcSMatt Macy 941eda14cbcSMatt Macy /* 942eda14cbcSMatt Macy * Mount support functions. 943eda14cbcSMatt Macy */ 94416038816SMartin Matuska _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 94516038816SMartin Matuska _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **); 94616038816SMartin Matuska _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int); 94716038816SMartin Matuska _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *); 94816038816SMartin Matuska _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int); 94916038816SMartin Matuska _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int); 95016038816SMartin Matuska _LIBZFS_H int zfs_mount_delegation_check(void); 951eda14cbcSMatt Macy 95253b70c86SMartin Matuska #if defined(__linux__) || defined(__APPLE__) 953a0b956f5SMartin Matuska _LIBZFS_H int zfs_parse_mount_options(const char *mntopts, 954a0b956f5SMartin Matuska unsigned long *mntflags, unsigned long *zfsflags, int sloppy, char *badopt, 955a0b956f5SMartin Matuska char *mtabopt); 95616038816SMartin Matuska _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint, 957eda14cbcSMatt Macy char *mntopts, char *mtabopt); 958eda14cbcSMatt Macy #endif 959eda14cbcSMatt Macy 960eda14cbcSMatt Macy /* 961eda14cbcSMatt Macy * Share support functions. 962716fd348SMartin Matuska * 963716fd348SMartin Matuska * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL, 964716fd348SMartin Matuska * NULL means "all/any known to this libzfs". 965eda14cbcSMatt Macy */ 966716fd348SMartin Matuska #define SA_NO_PROTOCOL -1 967eda14cbcSMatt Macy 968716fd348SMartin Matuska _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where, 969716fd348SMartin Matuska const enum sa_protocol *proto); 970716fd348SMartin Matuska _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto); 971716fd348SMartin Matuska _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint, 972716fd348SMartin Matuska const enum sa_protocol *proto); 973716fd348SMartin Matuska _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp, 974716fd348SMartin Matuska const enum sa_protocol *proto); 975716fd348SMartin Matuska _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto); 976c7046f76SMartin Matuska _LIBZFS_H void zfs_truncate_shares(const enum sa_protocol *proto); 977eda14cbcSMatt Macy 97816038816SMartin Matuska _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 979eda14cbcSMatt Macy 980eda14cbcSMatt Macy /* 981716fd348SMartin Matuska * Utility functions to run an external process. 982eda14cbcSMatt Macy */ 983eda14cbcSMatt Macy #define STDOUT_VERBOSE 0x01 984eda14cbcSMatt Macy #define STDERR_VERBOSE 0x02 985eda14cbcSMatt Macy #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ 986eda14cbcSMatt Macy 98716038816SMartin Matuska _LIBZFS_H int libzfs_run_process(const char *, char **, int); 98816038816SMartin Matuska _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[], 989eda14cbcSMatt Macy char **[], int *); 99016038816SMartin Matuska _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[], 99116038816SMartin Matuska char *[], char **[], int *); 992eda14cbcSMatt Macy 99316038816SMartin Matuska _LIBZFS_H void libzfs_free_str_array(char **, int); 994eda14cbcSMatt Macy 995a0b956f5SMartin Matuska _LIBZFS_H boolean_t libzfs_envvar_is_set(const char *); 996eda14cbcSMatt Macy 997eda14cbcSMatt Macy /* 998eda14cbcSMatt Macy * Utility functions for zfs version 999eda14cbcSMatt Macy */ 1000e3aa18adSMartin Matuska _LIBZFS_H const char *zfs_version_userland(void); 1001e3aa18adSMartin Matuska _LIBZFS_H char *zfs_version_kernel(void); 100216038816SMartin Matuska _LIBZFS_H int zfs_version_print(void); 1003ce4dcb97SMartin Matuska _LIBZFS_H nvlist_t *zfs_version_nvlist(void); 1004eda14cbcSMatt Macy 1005eda14cbcSMatt Macy /* 1006eda14cbcSMatt Macy * Given a device or file, determine if it is part of a pool. 1007eda14cbcSMatt Macy */ 100816038816SMartin Matuska _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 1009eda14cbcSMatt Macy boolean_t *); 1010eda14cbcSMatt Macy 1011eda14cbcSMatt Macy /* 1012eda14cbcSMatt Macy * Label manipulation. 1013eda14cbcSMatt Macy */ 101416038816SMartin Matuska _LIBZFS_H int zpool_clear_label(int); 101516038816SMartin Matuska _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *); 101616038816SMartin Matuska _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **); 1017eda14cbcSMatt Macy 1018eda14cbcSMatt Macy /* 1019eda14cbcSMatt Macy * Management interfaces for SMB ACL files 1020eda14cbcSMatt Macy */ 1021eda14cbcSMatt Macy 102216038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 102316038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 102416038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 102516038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, 102616038816SMartin Matuska char *); 1027eda14cbcSMatt Macy 1028eda14cbcSMatt Macy /* 1029eda14cbcSMatt Macy * Enable and disable datasets within a pool by mounting/unmounting and 1030eda14cbcSMatt Macy * sharing/unsharing them. 1031eda14cbcSMatt Macy */ 1032aca928a5SMartin Matuska _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int, 1033aca928a5SMartin Matuska uint_t); 103416038816SMartin Matuska _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t); 103553b70c86SMartin Matuska _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t); 103653b70c86SMartin Matuska _LIBZFS_H void zpool_disable_volume_os(const char *); 1037eda14cbcSMatt Macy 1038ee36e25aSMartin Matuska /* 1039ee36e25aSMartin Matuska * Parse a features file for -o compatibility 1040ee36e25aSMartin Matuska */ 1041ee36e25aSMartin Matuska typedef enum { 1042ee36e25aSMartin Matuska ZPOOL_COMPATIBILITY_OK, 104316038816SMartin Matuska ZPOOL_COMPATIBILITY_WARNTOKEN, 104416038816SMartin Matuska ZPOOL_COMPATIBILITY_BADTOKEN, 1045ee36e25aSMartin Matuska ZPOOL_COMPATIBILITY_BADFILE, 1046ee36e25aSMartin Matuska ZPOOL_COMPATIBILITY_NOFILES 1047ee36e25aSMartin Matuska } zpool_compat_status_t; 1048ee36e25aSMartin Matuska 104916038816SMartin Matuska _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *, 105016038816SMartin Matuska boolean_t *, char *, size_t); 1051ee36e25aSMartin Matuska 1052eda14cbcSMatt Macy #ifdef __FreeBSD__ 1053eda14cbcSMatt Macy 1054eda14cbcSMatt Macy /* 1055eda14cbcSMatt Macy * Attach/detach the given filesystem to/from the given jail. 1056eda14cbcSMatt Macy */ 105716038816SMartin Matuska _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach); 1058eda14cbcSMatt Macy 1059eda14cbcSMatt Macy /* 1060eda14cbcSMatt Macy * Set loader options for next boot. 1061eda14cbcSMatt Macy */ 106216038816SMartin Matuska _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, 106316038816SMartin Matuska const char *); 1064eda14cbcSMatt Macy 1065eda14cbcSMatt Macy #endif /* __FreeBSD__ */ 1066eda14cbcSMatt Macy 10671f1e2261SMartin Matuska #ifdef __linux__ 10681f1e2261SMartin Matuska 10691f1e2261SMartin Matuska /* 10701f1e2261SMartin Matuska * Add or delete the given filesystem to/from the given user namespace. 10711f1e2261SMartin Matuska */ 10721f1e2261SMartin Matuska _LIBZFS_H int zfs_userns(zfs_handle_t *zhp, const char *nspath, int attach); 10731f1e2261SMartin Matuska 10741f1e2261SMartin Matuska #endif 10751f1e2261SMartin Matuska 1076eda14cbcSMatt Macy #ifdef __cplusplus 1077eda14cbcSMatt Macy } 1078eda14cbcSMatt Macy #endif 1079eda14cbcSMatt Macy 1080eda14cbcSMatt Macy #endif /* _LIBZFS_H */ 1081