1eda14cbcSMatt Macy /* 2eda14cbcSMatt Macy * CDDL HEADER START 3eda14cbcSMatt Macy * 4eda14cbcSMatt Macy * The contents of this file are subject to the terms of the 5eda14cbcSMatt Macy * Common Development and Distribution License (the "License"). 6eda14cbcSMatt Macy * You may not use this file except in compliance with the License. 7eda14cbcSMatt Macy * 8eda14cbcSMatt Macy * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9271171e0SMartin Matuska * or https://opensource.org/licenses/CDDL-1.0. 10eda14cbcSMatt Macy * See the License for the specific language governing permissions 11eda14cbcSMatt Macy * and limitations under the License. 12eda14cbcSMatt Macy * 13eda14cbcSMatt Macy * When distributing Covered Code, include this CDDL HEADER in each 14eda14cbcSMatt Macy * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15eda14cbcSMatt Macy * If applicable, add the following below this CDDL HEADER, with the 16eda14cbcSMatt Macy * fields enclosed by brackets "[]" replaced with your own identifying 17eda14cbcSMatt Macy * information: Portions Copyright [yyyy] [name of copyright owner] 18eda14cbcSMatt Macy * 19eda14cbcSMatt Macy * CDDL HEADER END 20eda14cbcSMatt Macy */ 21eda14cbcSMatt Macy 22eda14cbcSMatt Macy /* 23eda14cbcSMatt Macy * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24c7046f76SMartin Matuska * Copyright (c) 2011, 2022 by Delphix. All rights reserved. 25eda14cbcSMatt Macy * Copyright Joyent, Inc. 26eda14cbcSMatt Macy * Copyright (c) 2013 Steven Hartland. All rights reserved. 27eda14cbcSMatt Macy * Copyright (c) 2016, Intel Corporation. 28eda14cbcSMatt Macy * Copyright 2016 Nexenta Systems, Inc. 29eda14cbcSMatt Macy * Copyright (c) 2017 Open-E, Inc. All Rights Reserved. 30eda14cbcSMatt Macy * Copyright (c) 2019 Datto Inc. 31ee36e25aSMartin Matuska * Copyright (c) 2021, Colm Buckley <colm@tuatha.org> 32eda14cbcSMatt Macy */ 33eda14cbcSMatt Macy 34eda14cbcSMatt Macy #ifndef _LIBZFS_H 3516038816SMartin Matuska #define _LIBZFS_H extern __attribute__((visibility("default"))) 36eda14cbcSMatt Macy 37eda14cbcSMatt Macy #include <assert.h> 38716fd348SMartin Matuska #include <libshare.h> 39eda14cbcSMatt Macy #include <libnvpair.h> 40eda14cbcSMatt Macy #include <sys/mnttab.h> 41eda14cbcSMatt Macy #include <sys/param.h> 42eda14cbcSMatt Macy #include <sys/types.h> 43eda14cbcSMatt Macy #include <sys/fs/zfs.h> 44eda14cbcSMatt Macy #include <sys/avl.h> 45eda14cbcSMatt Macy #include <libzfs_core.h> 46eda14cbcSMatt Macy 47eda14cbcSMatt Macy #ifdef __cplusplus 48eda14cbcSMatt Macy extern "C" { 49eda14cbcSMatt Macy #endif 50eda14cbcSMatt Macy 51eda14cbcSMatt Macy /* 52eda14cbcSMatt Macy * Miscellaneous ZFS constants 53eda14cbcSMatt Macy */ 54eda14cbcSMatt Macy #define ZFS_MAXPROPLEN MAXPATHLEN 55eda14cbcSMatt Macy #define ZPOOL_MAXPROPLEN MAXPATHLEN 56eda14cbcSMatt Macy 57eda14cbcSMatt Macy /* 58eda14cbcSMatt Macy * libzfs errors 59eda14cbcSMatt Macy */ 60eda14cbcSMatt Macy typedef enum zfs_error { 61eda14cbcSMatt Macy EZFS_SUCCESS = 0, /* no error -- success */ 62eda14cbcSMatt Macy EZFS_NOMEM = 2000, /* out of memory */ 63eda14cbcSMatt Macy EZFS_BADPROP, /* invalid property value */ 64eda14cbcSMatt Macy EZFS_PROPREADONLY, /* cannot set readonly property */ 65eda14cbcSMatt Macy EZFS_PROPTYPE, /* property does not apply to dataset type */ 66eda14cbcSMatt Macy EZFS_PROPNONINHERIT, /* property is not inheritable */ 67eda14cbcSMatt Macy EZFS_PROPSPACE, /* bad quota or reservation */ 68eda14cbcSMatt Macy EZFS_BADTYPE, /* dataset is not of appropriate type */ 69eda14cbcSMatt Macy EZFS_BUSY, /* pool or dataset is busy */ 70eda14cbcSMatt Macy EZFS_EXISTS, /* pool or dataset already exists */ 71eda14cbcSMatt Macy EZFS_NOENT, /* no such pool or dataset */ 72eda14cbcSMatt Macy EZFS_BADSTREAM, /* bad backup stream */ 73eda14cbcSMatt Macy EZFS_DSREADONLY, /* dataset is readonly */ 74eda14cbcSMatt Macy EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 75eda14cbcSMatt Macy EZFS_INVALIDNAME, /* invalid dataset name */ 76eda14cbcSMatt Macy EZFS_BADRESTORE, /* unable to restore to destination */ 77eda14cbcSMatt Macy EZFS_BADBACKUP, /* backup failed */ 78eda14cbcSMatt Macy EZFS_BADTARGET, /* bad attach/detach/replace target */ 79eda14cbcSMatt Macy EZFS_NODEVICE, /* no such device in pool */ 80eda14cbcSMatt Macy EZFS_BADDEV, /* invalid device to add */ 81eda14cbcSMatt Macy EZFS_NOREPLICAS, /* no valid replicas */ 82eda14cbcSMatt Macy EZFS_RESILVERING, /* resilvering (healing reconstruction) */ 83eda14cbcSMatt Macy EZFS_BADVERSION, /* unsupported version */ 84eda14cbcSMatt Macy EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 85eda14cbcSMatt Macy EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 86eda14cbcSMatt Macy EZFS_BADPATH, /* must be an absolute path */ 87eda14cbcSMatt Macy EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 88eda14cbcSMatt Macy EZFS_ZONED, /* used improperly in local zone */ 89eda14cbcSMatt Macy EZFS_MOUNTFAILED, /* failed to mount dataset */ 90eda14cbcSMatt Macy EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 917877fdebSMatt Macy EZFS_UNSHARENFSFAILED, /* failed to unshare over nfs */ 927877fdebSMatt Macy EZFS_SHARENFSFAILED, /* failed to share over nfs */ 93eda14cbcSMatt Macy EZFS_PERM, /* permission denied */ 94eda14cbcSMatt Macy EZFS_NOSPC, /* out of space */ 95eda14cbcSMatt Macy EZFS_FAULT, /* bad address */ 96eda14cbcSMatt Macy EZFS_IO, /* I/O error */ 97eda14cbcSMatt Macy EZFS_INTR, /* signal received */ 98eda14cbcSMatt Macy EZFS_ISSPARE, /* device is a hot spare */ 99eda14cbcSMatt Macy EZFS_INVALCONFIG, /* invalid vdev configuration */ 100eda14cbcSMatt Macy EZFS_RECURSIVE, /* recursive dependency */ 101eda14cbcSMatt Macy EZFS_NOHISTORY, /* no history object */ 102eda14cbcSMatt Macy EZFS_POOLPROPS, /* couldn't retrieve pool props */ 103eda14cbcSMatt Macy EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 104eda14cbcSMatt Macy EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 105eda14cbcSMatt Macy EZFS_NAMETOOLONG, /* dataset name is too long */ 106eda14cbcSMatt Macy EZFS_OPENFAILED, /* open of device failed */ 107eda14cbcSMatt Macy EZFS_NOCAP, /* couldn't get capacity */ 108eda14cbcSMatt Macy EZFS_LABELFAILED, /* write of label failed */ 109eda14cbcSMatt Macy EZFS_BADWHO, /* invalid permission who */ 110eda14cbcSMatt Macy EZFS_BADPERM, /* invalid permission */ 111eda14cbcSMatt Macy EZFS_BADPERMSET, /* invalid permission set name */ 112eda14cbcSMatt Macy EZFS_NODELEGATION, /* delegated administration is disabled */ 113eda14cbcSMatt Macy EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 114eda14cbcSMatt Macy EZFS_SHARESMBFAILED, /* failed to share over smb */ 115eda14cbcSMatt Macy EZFS_BADCACHE, /* bad cache file */ 116eda14cbcSMatt Macy EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 117eda14cbcSMatt Macy EZFS_VDEVNOTSUP, /* unsupported vdev type */ 118eda14cbcSMatt Macy EZFS_NOTSUP, /* ops not supported on this dataset */ 119eda14cbcSMatt Macy EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 120eda14cbcSMatt Macy EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 121eda14cbcSMatt Macy EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 122eda14cbcSMatt Macy EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 123eda14cbcSMatt Macy EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 124eda14cbcSMatt Macy EZFS_PIPEFAILED, /* pipe create failed */ 125eda14cbcSMatt Macy EZFS_THREADCREATEFAILED, /* thread create failed */ 126eda14cbcSMatt Macy EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 127eda14cbcSMatt Macy EZFS_SCRUBBING, /* currently scrubbing */ 128c0a83fe0SMartin Matuska EZFS_ERRORSCRUBBING, /* currently error scrubbing */ 129c0a83fe0SMartin Matuska EZFS_ERRORSCRUB_PAUSED, /* error scrub currently paused */ 130eda14cbcSMatt Macy EZFS_NO_SCRUB, /* no active scrub */ 131eda14cbcSMatt Macy EZFS_DIFF, /* general failure of zfs diff */ 132eda14cbcSMatt Macy EZFS_DIFFDATA, /* bad zfs diff data */ 133eda14cbcSMatt Macy EZFS_POOLREADONLY, /* pool is in read-only mode */ 134eda14cbcSMatt Macy EZFS_SCRUB_PAUSED, /* scrub currently paused */ 135c0a83fe0SMartin Matuska EZFS_SCRUB_PAUSED_TO_CANCEL, /* scrub currently paused */ 136eda14cbcSMatt Macy EZFS_ACTIVE_POOL, /* pool is imported on a different system */ 137eda14cbcSMatt Macy EZFS_CRYPTOFAILED, /* failed to setup encryption */ 138eda14cbcSMatt Macy EZFS_NO_PENDING, /* cannot cancel, no operation is pending */ 139eda14cbcSMatt Macy EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */ 140eda14cbcSMatt Macy EZFS_DISCARDING_CHECKPOINT, /* currently discarding a checkpoint */ 141eda14cbcSMatt Macy EZFS_NO_CHECKPOINT, /* pool has no checkpoint */ 142eda14cbcSMatt Macy EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */ 143eda14cbcSMatt Macy EZFS_VDEV_TOO_BIG, /* a device is too big to be used */ 144eda14cbcSMatt Macy EZFS_IOC_NOTSUPPORTED, /* operation not supported by zfs module */ 145eda14cbcSMatt Macy EZFS_TOOMANY, /* argument list too long */ 146eda14cbcSMatt Macy EZFS_INITIALIZING, /* currently initializing */ 147eda14cbcSMatt Macy EZFS_NO_INITIALIZE, /* no active initialize */ 148eda14cbcSMatt Macy EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */ 149eda14cbcSMatt Macy EZFS_TRIMMING, /* currently trimming */ 150eda14cbcSMatt Macy EZFS_NO_TRIM, /* no active trim */ 151eda14cbcSMatt Macy EZFS_TRIM_NOTSUP, /* device does not support trim */ 152eda14cbcSMatt Macy EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ 153eda14cbcSMatt Macy EZFS_EXPORT_IN_PROGRESS, /* currently exporting the pool */ 154eda14cbcSMatt Macy EZFS_REBUILDING, /* resilvering (sequential reconstrution) */ 155681ce946SMartin Matuska EZFS_VDEV_NOTSUP, /* ops not supported for this type of vdev */ 1561f1e2261SMartin Matuska EZFS_NOT_USER_NAMESPACE, /* a file is not a user namespace */ 157c7046f76SMartin Matuska EZFS_CKSUM, /* insufficient replicas */ 158be181ee2SMartin Matuska EZFS_RESUME_EXISTS, /* Resume on existing dataset without force */ 1592ad756a6SMartin Matuska EZFS_SHAREFAILED, /* filesystem share failed */ 160*e716630dSMartin Matuska EZFS_RAIDZ_EXPAND_IN_PROGRESS, /* a raidz is currently expanding */ 161eda14cbcSMatt Macy EZFS_UNKNOWN 162eda14cbcSMatt Macy } zfs_error_t; 163eda14cbcSMatt Macy 164eda14cbcSMatt Macy /* 165eda14cbcSMatt Macy * The following data structures are all part 166eda14cbcSMatt Macy * of the zfs_allow_t data structure which is 167eda14cbcSMatt Macy * used for printing 'allow' permissions. 168eda14cbcSMatt Macy * It is a linked list of zfs_allow_t's which 169eda14cbcSMatt Macy * then contain avl tree's for user/group/sets/... 170eda14cbcSMatt Macy * and each one of the entries in those trees have 171eda14cbcSMatt Macy * avl tree's for the permissions they belong to and 172eda14cbcSMatt Macy * whether they are local,descendent or local+descendent 173eda14cbcSMatt Macy * permissions. The AVL trees are used primarily for 174eda14cbcSMatt Macy * sorting purposes, but also so that we can quickly find 175eda14cbcSMatt Macy * a given user and or permission. 176eda14cbcSMatt Macy */ 177eda14cbcSMatt Macy typedef struct zfs_perm_node { 178eda14cbcSMatt Macy avl_node_t z_node; 179eda14cbcSMatt Macy char z_pname[MAXPATHLEN]; 180eda14cbcSMatt Macy } zfs_perm_node_t; 181eda14cbcSMatt Macy 182eda14cbcSMatt Macy typedef struct zfs_allow_node { 183eda14cbcSMatt Macy avl_node_t z_node; 184eda14cbcSMatt Macy char z_key[MAXPATHLEN]; /* name, such as joe */ 185eda14cbcSMatt Macy avl_tree_t z_localdescend; /* local+descendent perms */ 186eda14cbcSMatt Macy avl_tree_t z_local; /* local permissions */ 187eda14cbcSMatt Macy avl_tree_t z_descend; /* descendent permissions */ 188eda14cbcSMatt Macy } zfs_allow_node_t; 189eda14cbcSMatt Macy 190eda14cbcSMatt Macy typedef struct zfs_allow { 191eda14cbcSMatt Macy struct zfs_allow *z_next; 192eda14cbcSMatt Macy char z_setpoint[MAXPATHLEN]; 193eda14cbcSMatt Macy avl_tree_t z_sets; 194eda14cbcSMatt Macy avl_tree_t z_crperms; 195eda14cbcSMatt Macy avl_tree_t z_user; 196eda14cbcSMatt Macy avl_tree_t z_group; 197eda14cbcSMatt Macy avl_tree_t z_everyone; 198eda14cbcSMatt Macy } zfs_allow_t; 199eda14cbcSMatt Macy 200eda14cbcSMatt Macy /* 201eda14cbcSMatt Macy * Basic handle types 202eda14cbcSMatt Macy */ 203eda14cbcSMatt Macy typedef struct zfs_handle zfs_handle_t; 204eda14cbcSMatt Macy typedef struct zpool_handle zpool_handle_t; 205eda14cbcSMatt Macy typedef struct libzfs_handle libzfs_handle_t; 206eda14cbcSMatt Macy 20716038816SMartin Matuska _LIBZFS_H int zpool_wait(zpool_handle_t *, zpool_wait_activity_t); 20816038816SMartin Matuska _LIBZFS_H int zpool_wait_status(zpool_handle_t *, zpool_wait_activity_t, 209eda14cbcSMatt Macy boolean_t *, boolean_t *); 210eda14cbcSMatt Macy 211eda14cbcSMatt Macy /* 212eda14cbcSMatt Macy * Library initialization 213eda14cbcSMatt Macy */ 21416038816SMartin Matuska _LIBZFS_H libzfs_handle_t *libzfs_init(void); 21516038816SMartin Matuska _LIBZFS_H void libzfs_fini(libzfs_handle_t *); 216eda14cbcSMatt Macy 21716038816SMartin Matuska _LIBZFS_H libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 21816038816SMartin Matuska _LIBZFS_H libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 219eda14cbcSMatt Macy 22016038816SMartin Matuska _LIBZFS_H void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 221eda14cbcSMatt Macy 22216038816SMartin Matuska _LIBZFS_H void zfs_save_arguments(int argc, char **, char *, int); 22316038816SMartin Matuska _LIBZFS_H int zpool_log_history(libzfs_handle_t *, const char *); 224eda14cbcSMatt Macy 22516038816SMartin Matuska _LIBZFS_H int libzfs_errno(libzfs_handle_t *); 22616038816SMartin Matuska _LIBZFS_H const char *libzfs_error_init(int); 22716038816SMartin Matuska _LIBZFS_H const char *libzfs_error_action(libzfs_handle_t *); 22816038816SMartin Matuska _LIBZFS_H const char *libzfs_error_description(libzfs_handle_t *); 22916038816SMartin Matuska _LIBZFS_H int zfs_standard_error(libzfs_handle_t *, int, const char *); 23016038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_init(libzfs_handle_t *); 23116038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_fini(libzfs_handle_t *); 23216038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 23316038816SMartin Matuska _LIBZFS_H int libzfs_mnttab_find(libzfs_handle_t *, const char *, 234eda14cbcSMatt Macy struct mnttab *); 23516038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_add(libzfs_handle_t *, const char *, 236eda14cbcSMatt Macy const char *, const char *); 23716038816SMartin Matuska _LIBZFS_H void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 238eda14cbcSMatt Macy 239eda14cbcSMatt Macy /* 240eda14cbcSMatt Macy * Basic handle functions 241eda14cbcSMatt Macy */ 24216038816SMartin Matuska _LIBZFS_H zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 24316038816SMartin Matuska _LIBZFS_H zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 24416038816SMartin Matuska _LIBZFS_H void zpool_close(zpool_handle_t *); 24516038816SMartin Matuska _LIBZFS_H const char *zpool_get_name(zpool_handle_t *); 24616038816SMartin Matuska _LIBZFS_H int zpool_get_state(zpool_handle_t *); 24716038816SMartin Matuska _LIBZFS_H const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 24816038816SMartin Matuska _LIBZFS_H const char *zpool_pool_state_to_name(pool_state_t); 24916038816SMartin Matuska _LIBZFS_H void zpool_free_handles(libzfs_handle_t *); 250eda14cbcSMatt Macy 251eda14cbcSMatt Macy /* 252eda14cbcSMatt Macy * Iterate over all active pools in the system. 253eda14cbcSMatt Macy */ 254eda14cbcSMatt Macy typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 25516038816SMartin Matuska _LIBZFS_H int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 25616038816SMartin Matuska _LIBZFS_H boolean_t zpool_skip_pool(const char *); 257eda14cbcSMatt Macy 258eda14cbcSMatt Macy /* 259eda14cbcSMatt Macy * Functions to create and destroy pools 260eda14cbcSMatt Macy */ 26116038816SMartin Matuska _LIBZFS_H int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 262eda14cbcSMatt Macy nvlist_t *, nvlist_t *); 26316038816SMartin Matuska _LIBZFS_H int zpool_destroy(zpool_handle_t *, const char *); 26416038816SMartin Matuska _LIBZFS_H int zpool_add(zpool_handle_t *, nvlist_t *); 265eda14cbcSMatt Macy 266eda14cbcSMatt Macy typedef struct splitflags { 267eda14cbcSMatt Macy /* do not split, but return the config that would be split off */ 268dbd5678dSMartin Matuska unsigned int dryrun : 1; 269eda14cbcSMatt Macy 270eda14cbcSMatt Macy /* after splitting, import the pool */ 271dbd5678dSMartin Matuska unsigned int import : 1; 272eda14cbcSMatt Macy int name_flags; 273eda14cbcSMatt Macy } splitflags_t; 274eda14cbcSMatt Macy 275eda14cbcSMatt Macy typedef struct trimflags { 276eda14cbcSMatt Macy /* requested vdevs are for the entire pool */ 277eda14cbcSMatt Macy boolean_t fullpool; 278eda14cbcSMatt Macy 279eda14cbcSMatt Macy /* request a secure trim, requires support from device */ 280eda14cbcSMatt Macy boolean_t secure; 281eda14cbcSMatt Macy 282eda14cbcSMatt Macy /* after starting trim, block until trim completes */ 283eda14cbcSMatt Macy boolean_t wait; 284eda14cbcSMatt Macy 285eda14cbcSMatt Macy /* trim at the requested rate in bytes/second */ 286eda14cbcSMatt Macy uint64_t rate; 287eda14cbcSMatt Macy } trimflags_t; 288eda14cbcSMatt Macy 289eda14cbcSMatt Macy /* 290eda14cbcSMatt Macy * Functions to manipulate pool and vdev state 291eda14cbcSMatt Macy */ 29216038816SMartin Matuska _LIBZFS_H int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 29316038816SMartin Matuska _LIBZFS_H int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, 294eda14cbcSMatt Macy nvlist_t *); 29516038816SMartin Matuska _LIBZFS_H int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t, 296eda14cbcSMatt Macy nvlist_t *); 29716038816SMartin Matuska _LIBZFS_H int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *, 298eda14cbcSMatt Macy trimflags_t *); 299eda14cbcSMatt Macy 30016038816SMartin Matuska _LIBZFS_H int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 30116038816SMartin Matuska _LIBZFS_H int zpool_reguid(zpool_handle_t *); 30216038816SMartin Matuska _LIBZFS_H int zpool_reopen_one(zpool_handle_t *, void *); 303eda14cbcSMatt Macy 30416038816SMartin Matuska _LIBZFS_H int zpool_sync_one(zpool_handle_t *, void *); 305eda14cbcSMatt Macy 30616038816SMartin Matuska _LIBZFS_H int zpool_vdev_online(zpool_handle_t *, const char *, int, 307eda14cbcSMatt Macy vdev_state_t *); 30816038816SMartin Matuska _LIBZFS_H int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 30916038816SMartin Matuska _LIBZFS_H int zpool_vdev_attach(zpool_handle_t *, const char *, 310eda14cbcSMatt Macy const char *, nvlist_t *, int, boolean_t); 31116038816SMartin Matuska _LIBZFS_H int zpool_vdev_detach(zpool_handle_t *, const char *); 31216038816SMartin Matuska _LIBZFS_H int zpool_vdev_remove(zpool_handle_t *, const char *); 31316038816SMartin Matuska _LIBZFS_H int zpool_vdev_remove_cancel(zpool_handle_t *); 31416038816SMartin Matuska _LIBZFS_H int zpool_vdev_indirect_size(zpool_handle_t *, const char *, 31516038816SMartin Matuska uint64_t *); 31616038816SMartin Matuska _LIBZFS_H int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, 31716038816SMartin Matuska nvlist_t *, splitflags_t); 318be181ee2SMartin Matuska _LIBZFS_H int zpool_vdev_remove_wanted(zpool_handle_t *, const char *); 319eda14cbcSMatt Macy 32016038816SMartin Matuska _LIBZFS_H int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 32116038816SMartin Matuska _LIBZFS_H int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 32216038816SMartin Matuska _LIBZFS_H int zpool_vdev_clear(zpool_handle_t *, uint64_t); 323eda14cbcSMatt Macy 32416038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 325eda14cbcSMatt Macy boolean_t *, boolean_t *); 32616038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 327eda14cbcSMatt Macy boolean_t *, boolean_t *, boolean_t *); 32816038816SMartin Matuska _LIBZFS_H int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, 32916038816SMartin Matuska const char *); 330abcdc1b9SMartin Matuska _LIBZFS_H int zpool_prepare_disk(zpool_handle_t *zhp, nvlist_t *vdev_nv, 331abcdc1b9SMartin Matuska const char *prepare_str, char **lines[], int *lines_cnt); 332abcdc1b9SMartin Matuska _LIBZFS_H int zpool_prepare_and_label_disk(libzfs_handle_t *hdl, 333abcdc1b9SMartin Matuska zpool_handle_t *, const char *, nvlist_t *vdev_nv, const char *prepare_str, 334abcdc1b9SMartin Matuska char **lines[], int *lines_cnt); 335abcdc1b9SMartin Matuska _LIBZFS_H char ** zpool_vdev_script_alloc_env(const char *pool_name, 336abcdc1b9SMartin Matuska const char *vdev_path, const char *vdev_upath, 337abcdc1b9SMartin Matuska const char *vdev_enc_sysfs_path, const char *opt_key, const char *opt_val); 338abcdc1b9SMartin Matuska _LIBZFS_H void zpool_vdev_script_free_env(char **env); 33916038816SMartin Matuska _LIBZFS_H uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, 34016038816SMartin Matuska const char *path); 341eda14cbcSMatt Macy 34216038816SMartin Matuska _LIBZFS_H const char *zpool_get_state_str(zpool_handle_t *); 343eda14cbcSMatt Macy 344eda14cbcSMatt Macy /* 345eda14cbcSMatt Macy * Functions to manage pool properties 346eda14cbcSMatt Macy */ 34716038816SMartin Matuska _LIBZFS_H int zpool_set_prop(zpool_handle_t *, const char *, const char *); 34816038816SMartin Matuska _LIBZFS_H int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 349eda14cbcSMatt Macy size_t proplen, zprop_source_t *, boolean_t literal); 350c98ecfceSAllan Jude _LIBZFS_H int zpool_get_userprop(zpool_handle_t *, const char *, char *, 351c98ecfceSAllan Jude size_t proplen, zprop_source_t *); 35216038816SMartin Matuska _LIBZFS_H uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 353eda14cbcSMatt Macy zprop_source_t *); 35416038816SMartin Matuska _LIBZFS_H int zpool_props_refresh(zpool_handle_t *); 355eda14cbcSMatt Macy 35616038816SMartin Matuska _LIBZFS_H const char *zpool_prop_to_name(zpool_prop_t); 35716038816SMartin Matuska _LIBZFS_H const char *zpool_prop_values(zpool_prop_t); 358eda14cbcSMatt Macy 359eda14cbcSMatt Macy /* 360681ce946SMartin Matuska * Functions to manage vdev properties 361681ce946SMartin Matuska */ 362681ce946SMartin Matuska _LIBZFS_H int zpool_get_vdev_prop_value(nvlist_t *, vdev_prop_t, char *, char *, 363681ce946SMartin Matuska size_t, zprop_source_t *, boolean_t); 364681ce946SMartin Matuska _LIBZFS_H int zpool_get_vdev_prop(zpool_handle_t *, const char *, vdev_prop_t, 365681ce946SMartin Matuska char *, char *, size_t, zprop_source_t *, boolean_t); 366681ce946SMartin Matuska _LIBZFS_H int zpool_get_all_vdev_props(zpool_handle_t *, const char *, 367681ce946SMartin Matuska nvlist_t **); 368681ce946SMartin Matuska _LIBZFS_H int zpool_set_vdev_prop(zpool_handle_t *, const char *, const char *, 369681ce946SMartin Matuska const char *); 370681ce946SMartin Matuska 371681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_to_name(vdev_prop_t); 372681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_values(vdev_prop_t); 373681ce946SMartin Matuska _LIBZFS_H boolean_t vdev_prop_user(const char *name); 374681ce946SMartin Matuska _LIBZFS_H const char *vdev_prop_column_name(vdev_prop_t); 375681ce946SMartin Matuska _LIBZFS_H boolean_t vdev_prop_align_right(vdev_prop_t); 376681ce946SMartin Matuska 377681ce946SMartin Matuska /* 378eda14cbcSMatt Macy * Pool health statistics. 379eda14cbcSMatt Macy */ 380eda14cbcSMatt Macy typedef enum { 381eda14cbcSMatt Macy /* 382eda14cbcSMatt Macy * The following correspond to faults as defined in the (fault.fs.zfs.*) 383eda14cbcSMatt Macy * event namespace. Each is associated with a corresponding message ID. 384eda14cbcSMatt Macy * This must be kept in sync with the zfs_msgid_table in 385eda14cbcSMatt Macy * lib/libzfs/libzfs_status.c. 386eda14cbcSMatt Macy */ 387eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 388eda14cbcSMatt Macy ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 389eda14cbcSMatt Macy ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 390eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 391eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 392eda14cbcSMatt Macy ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 393eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 394eda14cbcSMatt Macy ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 395eda14cbcSMatt Macy ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 396eda14cbcSMatt Macy ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 397eda14cbcSMatt Macy ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 398eda14cbcSMatt Macy ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ 399eda14cbcSMatt Macy ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ 400eda14cbcSMatt Macy ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 401eda14cbcSMatt Macy ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 402eda14cbcSMatt Macy ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ 403eda14cbcSMatt Macy ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 404eda14cbcSMatt Macy ZPOOL_STATUS_ERRATA, /* informational errata available */ 405eda14cbcSMatt Macy 406eda14cbcSMatt Macy /* 407eda14cbcSMatt Macy * If the pool has unsupported features but can still be opened in 408eda14cbcSMatt Macy * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 409eda14cbcSMatt Macy * pool has unsupported features but cannot be opened at all, its 410eda14cbcSMatt Macy * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 411eda14cbcSMatt Macy */ 412eda14cbcSMatt Macy ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 413eda14cbcSMatt Macy ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 414eda14cbcSMatt Macy 415eda14cbcSMatt Macy /* 416eda14cbcSMatt Macy * These faults have no corresponding message ID. At the time we are 417eda14cbcSMatt Macy * checking the status, the original reason for the FMA fault (I/O or 418eda14cbcSMatt Macy * checksum errors) has been lost. 419eda14cbcSMatt Macy */ 420eda14cbcSMatt Macy ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 421eda14cbcSMatt Macy ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 422eda14cbcSMatt Macy 423eda14cbcSMatt Macy /* 424eda14cbcSMatt Macy * The following are not faults per se, but still an error possibly 425eda14cbcSMatt Macy * requiring administrative attention. There is no corresponding 426eda14cbcSMatt Macy * message ID. 427eda14cbcSMatt Macy */ 428eda14cbcSMatt Macy ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 429eda14cbcSMatt Macy ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 430eda14cbcSMatt Macy ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 431eda14cbcSMatt Macy ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 432eda14cbcSMatt Macy ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 433eda14cbcSMatt Macy ZPOOL_STATUS_REBUILDING, /* device being rebuilt */ 434eda14cbcSMatt Macy ZPOOL_STATUS_REBUILD_SCRUB, /* recommend scrubbing the pool */ 435eda14cbcSMatt Macy ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */ 436ee36e25aSMartin Matuska ZPOOL_STATUS_COMPATIBILITY_ERR, /* bad 'compatibility' property */ 43716038816SMartin Matuska ZPOOL_STATUS_INCOMPATIBLE_FEAT, /* feature set outside compatibility */ 438eda14cbcSMatt Macy 439eda14cbcSMatt Macy /* 440eda14cbcSMatt Macy * Finally, the following indicates a healthy pool. 441eda14cbcSMatt Macy */ 442eda14cbcSMatt Macy ZPOOL_STATUS_OK 443eda14cbcSMatt Macy } zpool_status_t; 444eda14cbcSMatt Macy 445a0b956f5SMartin Matuska _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, const char **, 446eda14cbcSMatt Macy zpool_errata_t *); 447a0b956f5SMartin Matuska _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, const char **, 448eda14cbcSMatt Macy zpool_errata_t *); 449eda14cbcSMatt Macy 450eda14cbcSMatt Macy /* 451eda14cbcSMatt Macy * Statistics and configuration functions. 452eda14cbcSMatt Macy */ 45316038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 45416038816SMartin Matuska _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *); 45516038816SMartin Matuska _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 45616038816SMartin Matuska _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 457eda14cbcSMatt Macy 458eda14cbcSMatt Macy /* 459eda14cbcSMatt Macy * Import and export functions 460eda14cbcSMatt Macy */ 46116038816SMartin Matuska _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *); 46216038816SMartin Matuska _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *); 46316038816SMartin Matuska _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 464eda14cbcSMatt Macy char *altroot); 46516038816SMartin Matuska _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 466eda14cbcSMatt Macy nvlist_t *, int); 46716038816SMartin Matuska _LIBZFS_H void zpool_print_unsup_feat(nvlist_t *config); 468eda14cbcSMatt Macy 469eda14cbcSMatt Macy /* 470eda14cbcSMatt Macy * Miscellaneous pool functions 471eda14cbcSMatt Macy */ 472eda14cbcSMatt Macy struct zfs_cmd; 473eda14cbcSMatt Macy 474e92ffd9bSMartin Matuska _LIBZFS_H const char *const zfs_history_event_names[]; 475eda14cbcSMatt Macy 476eda14cbcSMatt Macy typedef enum { 477eda14cbcSMatt Macy VDEV_NAME_PATH = 1 << 0, 478eda14cbcSMatt Macy VDEV_NAME_GUID = 1 << 1, 479eda14cbcSMatt Macy VDEV_NAME_FOLLOW_LINKS = 1 << 2, 480eda14cbcSMatt Macy VDEV_NAME_TYPE_ID = 1 << 3, 481eda14cbcSMatt Macy } vdev_name_t; 482eda14cbcSMatt Macy 48316038816SMartin Matuska _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 484eda14cbcSMatt Macy int name_flags); 48516038816SMartin Matuska _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t); 48616038816SMartin Matuska _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *, 487eda14cbcSMatt Macy boolean_t *); 48816038816SMartin Matuska _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, 489eda14cbcSMatt Macy int); 49016038816SMartin Matuska _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *); 49116038816SMartin Matuska _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int); 49216038816SMartin Matuska _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t, 49316038816SMartin Matuska char *, size_t); 49416038816SMartin Matuska _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 495eda14cbcSMatt Macy size_t); 49616038816SMartin Matuska _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 49716038816SMartin Matuska _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int, 498eda14cbcSMatt Macy nvlist_t *); 49916038816SMartin Matuska _LIBZFS_H int zpool_checkpoint(zpool_handle_t *); 50016038816SMartin Matuska _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *); 50116038816SMartin Matuska _LIBZFS_H boolean_t zpool_is_draid_spare(const char *); 502eda14cbcSMatt Macy 503eda14cbcSMatt Macy /* 504eda14cbcSMatt Macy * Basic handle manipulations. These functions do not create or destroy the 505eda14cbcSMatt Macy * underlying datasets, only the references to them. 506eda14cbcSMatt Macy */ 50716038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 50816038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 50916038816SMartin Matuska _LIBZFS_H void zfs_close(zfs_handle_t *); 51016038816SMartin Matuska _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *); 51116038816SMartin Matuska _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *); 51216038816SMartin Matuska _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *); 51316038816SMartin Matuska _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 51416038816SMartin Matuska _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *); 515eda14cbcSMatt Macy 516eda14cbcSMatt Macy /* 517eda14cbcSMatt Macy * Property management functions. Some functions are shared with the kernel, 518eda14cbcSMatt Macy * and are found in sys/fs/zfs.h. 519eda14cbcSMatt Macy */ 520eda14cbcSMatt Macy 521eda14cbcSMatt Macy /* 522eda14cbcSMatt Macy * zfs dataset property management 523eda14cbcSMatt Macy */ 52416038816SMartin Matuska _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t); 52516038816SMartin Matuska _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t); 52616038816SMartin Matuska _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t); 52716038816SMartin Matuska _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t); 528eda14cbcSMatt Macy 52916038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 53016038816SMartin Matuska nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, 53116038816SMartin Matuska const char *); 532eda14cbcSMatt Macy 53316038816SMartin Matuska _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t); 53416038816SMartin Matuska _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *); 53516038816SMartin Matuska _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 536f7f4bd06SMartin Matuska _LIBZFS_H int zfs_prop_set_list_flags(zfs_handle_t *, nvlist_t *, int); 53716038816SMartin Matuska _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 538eda14cbcSMatt Macy zprop_source_t *, char *, size_t, boolean_t); 53916038816SMartin Matuska _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 540eda14cbcSMatt Macy boolean_t); 54116038816SMartin Matuska _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 542eda14cbcSMatt Macy zprop_source_t *, char *, size_t); 54316038816SMartin Matuska _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp, 54416038816SMartin Matuska const char *propname, uint64_t *propvalue); 54516038816SMartin Matuska _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 546eda14cbcSMatt Macy char *propbuf, int proplen, boolean_t literal); 54716038816SMartin Matuska _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 548eda14cbcSMatt Macy uint64_t *propvalue); 54916038816SMartin Matuska _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 550eda14cbcSMatt Macy char *propbuf, int proplen, boolean_t literal); 55116038816SMartin Matuska _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 552eda14cbcSMatt Macy char *buf, size_t len); 5532a58b312SMartin Matuska _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, const char **); 55416038816SMartin Matuska _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 55516038816SMartin Matuska _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 55616038816SMartin Matuska _LIBZFS_H const char *zfs_prop_values(zfs_prop_t); 55716038816SMartin Matuska _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop); 55816038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *); 55916038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *); 56016038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 56116038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 562eda14cbcSMatt Macy 56316038816SMartin Matuska _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t, 564eda14cbcSMatt Macy boolean_t *, boolean_t *); 565eda14cbcSMatt Macy 566eda14cbcSMatt Macy /* 567eda14cbcSMatt Macy * zfs encryption management 568eda14cbcSMatt Macy */ 56916038816SMartin Matuska _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, 57016038816SMartin Matuska char *); 57116038816SMartin Matuska _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, 57216038816SMartin Matuska nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *); 57316038816SMartin Matuska _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, 574eda14cbcSMatt Macy nvlist_t *); 575c03c5b1cSMartin Matuska _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *); 576c03c5b1cSMartin Matuska _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *); 57716038816SMartin Matuska _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *); 57816038816SMartin Matuska _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); 579eda14cbcSMatt Macy 580eda14cbcSMatt Macy typedef struct zprop_list { 581eda14cbcSMatt Macy int pl_prop; 582eda14cbcSMatt Macy char *pl_user_prop; 583eda14cbcSMatt Macy struct zprop_list *pl_next; 584eda14cbcSMatt Macy boolean_t pl_all; 585eda14cbcSMatt Macy size_t pl_width; 586eda14cbcSMatt Macy size_t pl_recvd_width; 587eda14cbcSMatt Macy boolean_t pl_fixed; 588eda14cbcSMatt Macy } zprop_list_t; 589eda14cbcSMatt Macy 59016038816SMartin Matuska _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 591eda14cbcSMatt Macy boolean_t); 59216038816SMartin Matuska _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 593681ce946SMartin Matuska _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *, 594681ce946SMartin Matuska zprop_list_t **); 595eda14cbcSMatt Macy 596eda14cbcSMatt Macy #define ZFS_MOUNTPOINT_NONE "none" 597eda14cbcSMatt Macy #define ZFS_MOUNTPOINT_LEGACY "legacy" 598eda14cbcSMatt Macy 599eda14cbcSMatt Macy #define ZFS_FEATURE_DISABLED "disabled" 600eda14cbcSMatt Macy #define ZFS_FEATURE_ENABLED "enabled" 601eda14cbcSMatt Macy #define ZFS_FEATURE_ACTIVE "active" 602eda14cbcSMatt Macy 603eda14cbcSMatt Macy #define ZFS_UNSUPPORTED_INACTIVE "inactive" 604eda14cbcSMatt Macy #define ZFS_UNSUPPORTED_READONLY "readonly" 605eda14cbcSMatt Macy 606eda14cbcSMatt Macy /* 607eda14cbcSMatt Macy * zpool property management 608eda14cbcSMatt Macy */ 60916038816SMartin Matuska _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **, 610681ce946SMartin Matuska zfs_type_t, boolean_t); 61116038816SMartin Matuska _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 612eda14cbcSMatt Macy size_t); 61316038816SMartin Matuska _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t); 61416038816SMartin Matuska _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t); 61516038816SMartin Matuska _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t); 61616038816SMartin Matuska _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t); 617eda14cbcSMatt Macy 618eda14cbcSMatt Macy /* 619eda14cbcSMatt Macy * Functions shared by zfs and zpool property management. 620eda14cbcSMatt Macy */ 62116038816SMartin Matuska _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 622eda14cbcSMatt Macy boolean_t ordered, zfs_type_t type); 62316038816SMartin Matuska _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 624eda14cbcSMatt Macy zfs_type_t); 62516038816SMartin Matuska _LIBZFS_H void zprop_free_list(zprop_list_t *); 626eda14cbcSMatt Macy 627eda14cbcSMatt Macy #define ZFS_GET_NCOLS 5 628eda14cbcSMatt Macy 629eda14cbcSMatt Macy typedef enum { 630eda14cbcSMatt Macy GET_COL_NONE, 631eda14cbcSMatt Macy GET_COL_NAME, 632eda14cbcSMatt Macy GET_COL_PROPERTY, 633eda14cbcSMatt Macy GET_COL_VALUE, 634eda14cbcSMatt Macy GET_COL_RECVD, 635eda14cbcSMatt Macy GET_COL_SOURCE 636eda14cbcSMatt Macy } zfs_get_column_t; 637eda14cbcSMatt Macy 638eda14cbcSMatt Macy /* 639eda14cbcSMatt Macy * Functions for printing zfs or zpool properties 640eda14cbcSMatt Macy */ 641681ce946SMartin Matuska typedef struct vdev_cbdata { 642681ce946SMartin Matuska int cb_name_flags; 643681ce946SMartin Matuska char **cb_names; 644681ce946SMartin Matuska unsigned int cb_names_count; 645681ce946SMartin Matuska } vdev_cbdata_t; 646681ce946SMartin Matuska 647eda14cbcSMatt Macy typedef struct zprop_get_cbdata { 648eda14cbcSMatt Macy int cb_sources; 649eda14cbcSMatt Macy zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 650eda14cbcSMatt Macy int cb_colwidths[ZFS_GET_NCOLS + 1]; 651eda14cbcSMatt Macy boolean_t cb_scripted; 652eda14cbcSMatt Macy boolean_t cb_literal; 653eda14cbcSMatt Macy boolean_t cb_first; 654eda14cbcSMatt Macy zprop_list_t *cb_proplist; 655eda14cbcSMatt Macy zfs_type_t cb_type; 656681ce946SMartin Matuska vdev_cbdata_t cb_vdevs; 657eda14cbcSMatt Macy } zprop_get_cbdata_t; 658eda14cbcSMatt Macy 659f7f4bd06SMartin Matuska #define ZFS_SET_NOMOUNT 1 660f7f4bd06SMartin Matuska 661f7f4bd06SMartin Matuska typedef struct zprop_set_cbdata { 662f7f4bd06SMartin Matuska int cb_flags; 663f7f4bd06SMartin Matuska nvlist_t *cb_proplist; 664f7f4bd06SMartin Matuska } zprop_set_cbdata_t; 665f7f4bd06SMartin Matuska 66616038816SMartin Matuska _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 667eda14cbcSMatt Macy const char *, const char *, zprop_source_t, const char *, 668eda14cbcSMatt Macy const char *); 669eda14cbcSMatt Macy 670eda14cbcSMatt Macy /* 671eda14cbcSMatt Macy * Iterator functions. 672eda14cbcSMatt Macy */ 67315f0b8c3SMartin Matuska #define ZFS_ITER_RECURSE (1 << 0) 67415f0b8c3SMartin Matuska #define ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1) 67515f0b8c3SMartin Matuska #define ZFS_ITER_PROP_LISTSNAPS (1 << 2) 67615f0b8c3SMartin Matuska #define ZFS_ITER_DEPTH_LIMIT (1 << 3) 67715f0b8c3SMartin Matuska #define ZFS_ITER_RECVD_PROPS (1 << 4) 67815f0b8c3SMartin Matuska #define ZFS_ITER_LITERAL_PROPS (1 << 5) 67915f0b8c3SMartin Matuska #define ZFS_ITER_SIMPLE (1 << 6) 68015f0b8c3SMartin Matuska 681eda14cbcSMatt Macy typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 68216038816SMartin Matuska _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 683d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 684d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, 68516038816SMartin Matuska void *); 686d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 687d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *, 688eda14cbcSMatt Macy uint64_t, uint64_t); 689d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *, 690eda14cbcSMatt Macy uint64_t, uint64_t); 691d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, 69216038816SMartin Matuska void *); 693d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 694d411c1d6SMartin Matuska 695d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_children_v2(zfs_handle_t *, int, zfs_iter_f, void *); 696d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_dependents_v2(zfs_handle_t *, int, boolean_t, zfs_iter_f, 697d411c1d6SMartin Matuska void *); 698d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_filesystems_v2(zfs_handle_t *, int, zfs_iter_f, void *); 699d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_v2(zfs_handle_t *, int, zfs_iter_f, void *, 700d411c1d6SMartin Matuska uint64_t, uint64_t); 701d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapshots_sorted_v2(zfs_handle_t *, int, zfs_iter_f, 702d411c1d6SMartin Matuska void *, uint64_t, uint64_t); 703d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_snapspec_v2(zfs_handle_t *, int, const char *, 704d411c1d6SMartin Matuska zfs_iter_f, void *); 705d411c1d6SMartin Matuska _LIBZFS_H int zfs_iter_bookmarks_v2(zfs_handle_t *, int, zfs_iter_f, void *); 70616038816SMartin Matuska _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *); 707eda14cbcSMatt Macy 708eda14cbcSMatt Macy typedef struct get_all_cb { 709eda14cbcSMatt Macy zfs_handle_t **cb_handles; 710eda14cbcSMatt Macy size_t cb_alloc; 711eda14cbcSMatt Macy size_t cb_used; 712eda14cbcSMatt Macy } get_all_cb_t; 713eda14cbcSMatt Macy 71416038816SMartin Matuska _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, 71516038816SMartin Matuska size_t, zfs_iter_f, void *, boolean_t); 71616038816SMartin Matuska _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 717eda14cbcSMatt Macy 718eda14cbcSMatt Macy /* 719eda14cbcSMatt Macy * Functions to create and destroy datasets. 720eda14cbcSMatt Macy */ 72116038816SMartin Matuska _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 722eda14cbcSMatt Macy nvlist_t *); 72316038816SMartin Matuska _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *); 72416038816SMartin Matuska _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t); 72516038816SMartin Matuska _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 72616038816SMartin Matuska _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 7276ba2210eSMartin Matuska _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *); 72816038816SMartin Matuska _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 72916038816SMartin Matuska _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, 73016038816SMartin Matuska nvlist_t *); 73116038816SMartin Matuska _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 732eda14cbcSMatt Macy nvlist_t *props); 73316038816SMartin Matuska _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 734eac7052fSMatt Macy 735eac7052fSMatt Macy typedef struct renameflags { 736eac7052fSMatt Macy /* recursive rename */ 737dbd5678dSMartin Matuska unsigned int recursive : 1; 738eac7052fSMatt Macy 739eac7052fSMatt Macy /* don't unmount file systems */ 740dbd5678dSMartin Matuska unsigned int nounmount : 1; 741eac7052fSMatt Macy 742eac7052fSMatt Macy /* force unmount file systems */ 743dbd5678dSMartin Matuska unsigned int forceunmount : 1; 744eac7052fSMatt Macy } renameflags_t; 745eac7052fSMatt Macy 74616038816SMartin Matuska _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t); 747eda14cbcSMatt Macy 748eda14cbcSMatt Macy typedef struct sendflags { 749eda14cbcSMatt Macy /* Amount of extra information to print. */ 750eda14cbcSMatt Macy int verbosity; 751eda14cbcSMatt Macy 752eda14cbcSMatt Macy /* recursive send (ie, -R) */ 753eda14cbcSMatt Macy boolean_t replicate; 754eda14cbcSMatt Macy 75516038816SMartin Matuska /* for recursive send, skip sending missing snapshots */ 75616038816SMartin Matuska boolean_t skipmissing; 75716038816SMartin Matuska 758eda14cbcSMatt Macy /* for incrementals, do all intermediate snapshots */ 759eda14cbcSMatt Macy boolean_t doall; 760eda14cbcSMatt Macy 761eda14cbcSMatt Macy /* if dataset is a clone, do incremental from its origin */ 762eda14cbcSMatt Macy boolean_t fromorigin; 763eda14cbcSMatt Macy 764eda14cbcSMatt Macy /* field no longer used, maintained for backwards compatibility */ 765eda14cbcSMatt Macy boolean_t pad; 766eda14cbcSMatt Macy 767eda14cbcSMatt Macy /* send properties (ie, -p) */ 768eda14cbcSMatt Macy boolean_t props; 769eda14cbcSMatt Macy 770eda14cbcSMatt Macy /* do not send (no-op, ie. -n) */ 771eda14cbcSMatt Macy boolean_t dryrun; 772eda14cbcSMatt Macy 773eda14cbcSMatt Macy /* parsable verbose output (ie. -P) */ 774eda14cbcSMatt Macy boolean_t parsable; 775eda14cbcSMatt Macy 776eda14cbcSMatt Macy /* show progress (ie. -v) */ 777eda14cbcSMatt Macy boolean_t progress; 778eda14cbcSMatt Macy 77915f0b8c3SMartin Matuska /* show progress as process title (ie. -V) */ 78015f0b8c3SMartin Matuska boolean_t progressastitle; 78115f0b8c3SMartin Matuska 782eda14cbcSMatt Macy /* large blocks (>128K) are permitted */ 783eda14cbcSMatt Macy boolean_t largeblock; 784eda14cbcSMatt Macy 785eda14cbcSMatt Macy /* WRITE_EMBEDDED records of type DATA are permitted */ 786eda14cbcSMatt Macy boolean_t embed_data; 787eda14cbcSMatt Macy 788eda14cbcSMatt Macy /* compressed WRITE records are permitted */ 789eda14cbcSMatt Macy boolean_t compress; 790eda14cbcSMatt Macy 791eda14cbcSMatt Macy /* raw encrypted records are permitted */ 792eda14cbcSMatt Macy boolean_t raw; 793eda14cbcSMatt Macy 794eda14cbcSMatt Macy /* only send received properties (ie. -b) */ 795eda14cbcSMatt Macy boolean_t backup; 796eda14cbcSMatt Macy 797eda14cbcSMatt Macy /* include snapshot holds in send stream */ 798eda14cbcSMatt Macy boolean_t holds; 799eda14cbcSMatt Macy 800eda14cbcSMatt Macy /* stream represents a partially received dataset */ 801eda14cbcSMatt Macy boolean_t saved; 802eda14cbcSMatt Macy } sendflags_t; 803eda14cbcSMatt Macy 804eda14cbcSMatt Macy typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 805eda14cbcSMatt Macy 80616038816SMartin Matuska _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *, 807eda14cbcSMatt Macy sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 80816038816SMartin Matuska _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *, 809eda14cbcSMatt Macy const char *); 81016038816SMartin Matuska _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *); 81116038816SMartin Matuska _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 812eda14cbcSMatt Macy const char *); 81316038816SMartin Matuska _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *); 81416038816SMartin Matuska _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 815eda14cbcSMatt Macy const char *token); 816eda14cbcSMatt Macy 81716038816SMartin Matuska _LIBZFS_H int zfs_promote(zfs_handle_t *); 81816038816SMartin Matuska _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *, 819eda14cbcSMatt Macy boolean_t, int); 82016038816SMartin Matuska _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 82116038816SMartin Matuska _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *, 82216038816SMartin Matuska boolean_t); 82316038816SMartin Matuska _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **); 82416038816SMartin Matuska _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, 825eda14cbcSMatt Macy nvlist_t *); 826eda14cbcSMatt Macy 827eda14cbcSMatt Macy typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 828eda14cbcSMatt Macy uid_t rid, uint64_t space); 829eda14cbcSMatt Macy 83016038816SMartin Matuska _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 831eda14cbcSMatt Macy zfs_userspace_cb_t, void *); 832eda14cbcSMatt Macy 83316038816SMartin Matuska _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 83416038816SMartin Matuska _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 835eda14cbcSMatt Macy 836eda14cbcSMatt Macy typedef struct recvflags { 837eda14cbcSMatt Macy /* print informational messages (ie, -v was specified) */ 838eda14cbcSMatt Macy boolean_t verbose; 839eda14cbcSMatt Macy 840eda14cbcSMatt Macy /* the destination is a prefix, not the exact fs (ie, -d) */ 841eda14cbcSMatt Macy boolean_t isprefix; 842eda14cbcSMatt Macy 843eda14cbcSMatt Macy /* 844eda14cbcSMatt Macy * Only the tail of the sent snapshot path is appended to the 845eda14cbcSMatt Macy * destination to determine the received snapshot name (ie, -e). 846eda14cbcSMatt Macy */ 847eda14cbcSMatt Macy boolean_t istail; 848eda14cbcSMatt Macy 849eda14cbcSMatt Macy /* do not actually do the recv, just check if it would work (ie, -n) */ 850eda14cbcSMatt Macy boolean_t dryrun; 851eda14cbcSMatt Macy 852eda14cbcSMatt Macy /* rollback/destroy filesystems as necessary (eg, -F) */ 853eda14cbcSMatt Macy boolean_t force; 854eda14cbcSMatt Macy 855eda14cbcSMatt Macy /* set "canmount=off" on all modified filesystems */ 856eda14cbcSMatt Macy boolean_t canmountoff; 857eda14cbcSMatt Macy 858eda14cbcSMatt Macy /* 859eda14cbcSMatt Macy * Mark the file systems as "resumable" and do not destroy them if the 860eda14cbcSMatt Macy * receive is interrupted 861eda14cbcSMatt Macy */ 862eda14cbcSMatt Macy boolean_t resumable; 863eda14cbcSMatt Macy 864eda14cbcSMatt Macy /* byteswap flag is used internally; callers need not specify */ 865eda14cbcSMatt Macy boolean_t byteswap; 866eda14cbcSMatt Macy 867eda14cbcSMatt Macy /* do not mount file systems as they are extracted (private) */ 868eda14cbcSMatt Macy boolean_t nomount; 869eda14cbcSMatt Macy 870eda14cbcSMatt Macy /* Was holds flag set in the compound header? */ 871eda14cbcSMatt Macy boolean_t holds; 872eda14cbcSMatt Macy 873eda14cbcSMatt Macy /* skip receive of snapshot holds */ 874eda14cbcSMatt Macy boolean_t skipholds; 875eda14cbcSMatt Macy 876eda14cbcSMatt Macy /* mount the filesystem unless nomount is specified */ 877eda14cbcSMatt Macy boolean_t domount; 878eda14cbcSMatt Macy 879eda14cbcSMatt Macy /* force unmount while recv snapshot (private) */ 880eda14cbcSMatt Macy boolean_t forceunmount; 881271171e0SMartin Matuska 882271171e0SMartin Matuska /* use this recv to check (and heal if needed) an existing snapshot */ 883271171e0SMartin Matuska boolean_t heal; 884eda14cbcSMatt Macy } recvflags_t; 885eda14cbcSMatt Macy 88616038816SMartin Matuska _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 887eda14cbcSMatt Macy recvflags_t *, int, avl_tree_t *); 888eda14cbcSMatt Macy 889eda14cbcSMatt Macy typedef enum diff_flags { 890681ce946SMartin Matuska ZFS_DIFF_PARSEABLE = 1 << 0, 891681ce946SMartin Matuska ZFS_DIFF_TIMESTAMP = 1 << 1, 892681ce946SMartin Matuska ZFS_DIFF_CLASSIFY = 1 << 2, 893681ce946SMartin Matuska ZFS_DIFF_NO_MANGLE = 1 << 3 894eda14cbcSMatt Macy } diff_flags_t; 895eda14cbcSMatt Macy 89616038816SMartin Matuska _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 897eda14cbcSMatt Macy int); 898eda14cbcSMatt Macy 899eda14cbcSMatt Macy /* 900eda14cbcSMatt Macy * Miscellaneous functions. 901eda14cbcSMatt Macy */ 90216038816SMartin Matuska _LIBZFS_H const char *zfs_type_to_name(zfs_type_t); 90316038816SMartin Matuska _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *); 90416038816SMartin Matuska _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t); 90516038816SMartin Matuska _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *, 906eda14cbcSMatt Macy zfs_type_t); 90716038816SMartin Matuska _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t); 90816038816SMartin Matuska _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 909eda14cbcSMatt Macy zfs_type_t); 91016038816SMartin Matuska _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *); 91116038816SMartin Matuska _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path); 912eda14cbcSMatt Macy 913eda14cbcSMatt Macy /* 914eda14cbcSMatt Macy * Mount support functions. 915eda14cbcSMatt Macy */ 91616038816SMartin Matuska _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 91716038816SMartin Matuska _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **); 91816038816SMartin Matuska _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int); 91916038816SMartin Matuska _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *); 92016038816SMartin Matuska _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int); 92116038816SMartin Matuska _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int); 92216038816SMartin Matuska _LIBZFS_H int zfs_mount_delegation_check(void); 923eda14cbcSMatt Macy 92453b70c86SMartin Matuska #if defined(__linux__) || defined(__APPLE__) 925a0b956f5SMartin Matuska _LIBZFS_H int zfs_parse_mount_options(const char *mntopts, 926a0b956f5SMartin Matuska unsigned long *mntflags, unsigned long *zfsflags, int sloppy, char *badopt, 927a0b956f5SMartin Matuska char *mtabopt); 92816038816SMartin Matuska _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint, 929eda14cbcSMatt Macy char *mntopts, char *mtabopt); 930eda14cbcSMatt Macy #endif 931eda14cbcSMatt Macy 932eda14cbcSMatt Macy /* 933eda14cbcSMatt Macy * Share support functions. 934716fd348SMartin Matuska * 935716fd348SMartin Matuska * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL, 936716fd348SMartin Matuska * NULL means "all/any known to this libzfs". 937eda14cbcSMatt Macy */ 938716fd348SMartin Matuska #define SA_NO_PROTOCOL -1 939eda14cbcSMatt Macy 940716fd348SMartin Matuska _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where, 941716fd348SMartin Matuska const enum sa_protocol *proto); 942716fd348SMartin Matuska _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto); 943716fd348SMartin Matuska _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint, 944716fd348SMartin Matuska const enum sa_protocol *proto); 945716fd348SMartin Matuska _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp, 946716fd348SMartin Matuska const enum sa_protocol *proto); 947716fd348SMartin Matuska _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto); 948c7046f76SMartin Matuska _LIBZFS_H void zfs_truncate_shares(const enum sa_protocol *proto); 949eda14cbcSMatt Macy 95016038816SMartin Matuska _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 951eda14cbcSMatt Macy 952eda14cbcSMatt Macy /* 953716fd348SMartin Matuska * Utility functions to run an external process. 954eda14cbcSMatt Macy */ 955eda14cbcSMatt Macy #define STDOUT_VERBOSE 0x01 956eda14cbcSMatt Macy #define STDERR_VERBOSE 0x02 957eda14cbcSMatt Macy #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ 958eda14cbcSMatt Macy 95916038816SMartin Matuska _LIBZFS_H int libzfs_run_process(const char *, char **, int); 96016038816SMartin Matuska _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[], 961eda14cbcSMatt Macy char **[], int *); 96216038816SMartin Matuska _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[], 96316038816SMartin Matuska char *[], char **[], int *); 964eda14cbcSMatt Macy 96516038816SMartin Matuska _LIBZFS_H void libzfs_free_str_array(char **, int); 966eda14cbcSMatt Macy 967a0b956f5SMartin Matuska _LIBZFS_H boolean_t libzfs_envvar_is_set(const char *); 968eda14cbcSMatt Macy 969eda14cbcSMatt Macy /* 970eda14cbcSMatt Macy * Utility functions for zfs version 971eda14cbcSMatt Macy */ 972e3aa18adSMartin Matuska _LIBZFS_H const char *zfs_version_userland(void); 973e3aa18adSMartin Matuska _LIBZFS_H char *zfs_version_kernel(void); 97416038816SMartin Matuska _LIBZFS_H int zfs_version_print(void); 975eda14cbcSMatt Macy 976eda14cbcSMatt Macy /* 977eda14cbcSMatt Macy * Given a device or file, determine if it is part of a pool. 978eda14cbcSMatt Macy */ 97916038816SMartin Matuska _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 980eda14cbcSMatt Macy boolean_t *); 981eda14cbcSMatt Macy 982eda14cbcSMatt Macy /* 983eda14cbcSMatt Macy * Label manipulation. 984eda14cbcSMatt Macy */ 98516038816SMartin Matuska _LIBZFS_H int zpool_clear_label(int); 98616038816SMartin Matuska _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *); 98716038816SMartin Matuska _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **); 988eda14cbcSMatt Macy 989eda14cbcSMatt Macy /* 990eda14cbcSMatt Macy * Management interfaces for SMB ACL files 991eda14cbcSMatt Macy */ 992eda14cbcSMatt Macy 99316038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 99416038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 99516038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 99616038816SMartin Matuska _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, 99716038816SMartin Matuska char *); 998eda14cbcSMatt Macy 999eda14cbcSMatt Macy /* 1000eda14cbcSMatt Macy * Enable and disable datasets within a pool by mounting/unmounting and 1001eda14cbcSMatt Macy * sharing/unsharing them. 1002eda14cbcSMatt Macy */ 100316038816SMartin Matuska _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int); 100416038816SMartin Matuska _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t); 100553b70c86SMartin Matuska _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t); 100653b70c86SMartin Matuska _LIBZFS_H void zpool_disable_volume_os(const char *); 1007eda14cbcSMatt Macy 1008ee36e25aSMartin Matuska /* 1009ee36e25aSMartin Matuska * Parse a features file for -o compatibility 1010ee36e25aSMartin Matuska */ 1011ee36e25aSMartin Matuska typedef enum { 1012ee36e25aSMartin Matuska ZPOOL_COMPATIBILITY_OK, 101316038816SMartin Matuska ZPOOL_COMPATIBILITY_WARNTOKEN, 101416038816SMartin Matuska ZPOOL_COMPATIBILITY_BADTOKEN, 1015ee36e25aSMartin Matuska ZPOOL_COMPATIBILITY_BADFILE, 1016ee36e25aSMartin Matuska ZPOOL_COMPATIBILITY_NOFILES 1017ee36e25aSMartin Matuska } zpool_compat_status_t; 1018ee36e25aSMartin Matuska 101916038816SMartin Matuska _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *, 102016038816SMartin Matuska boolean_t *, char *, size_t); 1021ee36e25aSMartin Matuska 1022eda14cbcSMatt Macy #ifdef __FreeBSD__ 1023eda14cbcSMatt Macy 1024eda14cbcSMatt Macy /* 1025eda14cbcSMatt Macy * Attach/detach the given filesystem to/from the given jail. 1026eda14cbcSMatt Macy */ 102716038816SMartin Matuska _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach); 1028eda14cbcSMatt Macy 1029eda14cbcSMatt Macy /* 1030eda14cbcSMatt Macy * Set loader options for next boot. 1031eda14cbcSMatt Macy */ 103216038816SMartin Matuska _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, 103316038816SMartin Matuska const char *); 1034eda14cbcSMatt Macy 1035eda14cbcSMatt Macy #endif /* __FreeBSD__ */ 1036eda14cbcSMatt Macy 10371f1e2261SMartin Matuska #ifdef __linux__ 10381f1e2261SMartin Matuska 10391f1e2261SMartin Matuska /* 10401f1e2261SMartin Matuska * Add or delete the given filesystem to/from the given user namespace. 10411f1e2261SMartin Matuska */ 10421f1e2261SMartin Matuska _LIBZFS_H int zfs_userns(zfs_handle_t *zhp, const char *nspath, int attach); 10431f1e2261SMartin Matuska 10441f1e2261SMartin Matuska #endif 10451f1e2261SMartin Matuska 1046eda14cbcSMatt Macy #ifdef __cplusplus 1047eda14cbcSMatt Macy } 1048eda14cbcSMatt Macy #endif 1049eda14cbcSMatt Macy 1050eda14cbcSMatt Macy #endif /* _LIBZFS_H */ 1051