1 // SPDX-License-Identifier: CDDL-1.0 2 /* 3 * This file and its contents are supplied under the terms of the 4 * Common Development and Distribution License ("CDDL"), version 1.0. 5 * You may only use this file in accordance with the terms of version 6 * 1.0 of the CDDL. 7 * 8 * A full copy of the text of the CDDL should have accompanied this 9 * source. A copy of the CDDL is also available via the Internet at 10 * https://opensource.org/license/CDDL-1.0. 11 */ 12 13 /* 14 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 15 * Copyright (c) 2011, 2024 by Delphix. All rights reserved. 16 * Copyright Joyent, Inc. 17 * Copyright (c) 2013 Steven Hartland. All rights reserved. 18 * Copyright (c) 2016, Intel Corporation. 19 * Copyright 2016 Nexenta Systems, Inc. 20 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved. 21 * Copyright (c) 2019 Datto Inc. 22 * Copyright (c) 2021, Colm Buckley <colm@tuatha.org> 23 * Copyright (c) 2025 Hewlett Packard Enterprise Development LP. 24 * Copyright (c) 2024-2026, Klara, Inc. 25 * Copyright (c) 2026, TrueNAS. 26 */ 27 28 #ifndef _LIBZFS_H 29 #define _LIBZFS_H extern __attribute__((visibility("default"))) 30 31 #include <assert.h> 32 #include <libnvpair.h> 33 #include <sys/mnttab.h> 34 #include <sys/param.h> 35 #include <sys/types.h> 36 #include <sys/fs/zfs.h> 37 #include <sys/avl.h> 38 #include <libzfs_core.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* 45 * Miscellaneous ZFS constants 46 */ 47 #define ZFS_MAXPROPLEN ZAP_MAXVALUELEN 48 #define ZPOOL_MAXPROPLEN ZAP_MAXVALUELEN 49 50 /* 51 * libzfs errors 52 */ 53 typedef enum zfs_error { 54 EZFS_SUCCESS = 0, /* no error -- success */ 55 EZFS_NOMEM = 2000, /* out of memory */ 56 EZFS_BADPROP, /* invalid property value */ 57 EZFS_PROPREADONLY, /* cannot set readonly property */ 58 EZFS_PROPTYPE, /* property does not apply to dataset type */ 59 EZFS_PROPNONINHERIT, /* property is not inheritable */ 60 EZFS_PROPSPACE, /* bad quota or reservation */ 61 EZFS_BADTYPE, /* dataset is not of appropriate type */ 62 EZFS_BUSY, /* pool or dataset is busy */ 63 EZFS_EXISTS, /* pool or dataset already exists */ 64 EZFS_NOENT, /* no such pool or dataset */ 65 EZFS_BADSTREAM, /* bad backup stream */ 66 EZFS_DSREADONLY, /* dataset is readonly */ 67 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 68 EZFS_INVALIDNAME, /* invalid dataset name */ 69 EZFS_BADRESTORE, /* unable to restore to destination */ 70 EZFS_BADBACKUP, /* backup failed */ 71 EZFS_BADTARGET, /* bad attach/detach/replace target */ 72 EZFS_NODEVICE, /* no such device in pool */ 73 EZFS_BADDEV, /* invalid device to add */ 74 EZFS_NOREPLICAS, /* no valid replicas */ 75 EZFS_RESILVERING, /* resilvering (healing reconstruction) */ 76 EZFS_BADVERSION, /* unsupported version */ 77 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 78 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 79 EZFS_BADPATH, /* must be an absolute path */ 80 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 81 EZFS_ZONED, /* used improperly in local zone */ 82 EZFS_MOUNTFAILED, /* failed to mount dataset */ 83 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 84 EZFS_UNSHARENFSFAILED, /* failed to unshare over nfs */ 85 EZFS_SHARENFSFAILED, /* failed to share over nfs */ 86 EZFS_PERM, /* permission denied */ 87 EZFS_NOSPC, /* out of space */ 88 EZFS_FAULT, /* bad address */ 89 EZFS_IO, /* I/O error */ 90 EZFS_INTR, /* signal received */ 91 EZFS_ISSPARE, /* device is a hot spare */ 92 EZFS_INVALCONFIG, /* invalid vdev configuration */ 93 EZFS_RECURSIVE, /* recursive dependency */ 94 EZFS_NOHISTORY, /* no history object */ 95 EZFS_POOLPROPS, /* couldn't retrieve pool props */ 96 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 97 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 98 EZFS_NAMETOOLONG, /* dataset name is too long */ 99 EZFS_OPENFAILED, /* open of device failed */ 100 EZFS_NOCAP, /* couldn't get capacity */ 101 EZFS_LABELFAILED, /* write of label failed */ 102 EZFS_BADWHO, /* invalid permission who */ 103 EZFS_BADPERM, /* invalid permission */ 104 EZFS_BADPERMSET, /* invalid permission set name */ 105 EZFS_NODELEGATION, /* delegated administration is disabled */ 106 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 107 EZFS_SHARESMBFAILED, /* failed to share over smb */ 108 EZFS_BADCACHE, /* bad cache file */ 109 EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 110 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 111 EZFS_NOTSUP, /* ops not supported on this dataset */ 112 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 113 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 114 EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 115 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 116 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 117 EZFS_PIPEFAILED, /* pipe create failed */ 118 EZFS_THREADCREATEFAILED, /* thread create failed */ 119 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 120 EZFS_SCRUBBING, /* currently scrubbing */ 121 EZFS_ERRORSCRUBBING, /* currently error scrubbing */ 122 EZFS_ERRORSCRUB_PAUSED, /* error scrub currently paused */ 123 EZFS_NO_SCRUB, /* no active scrub */ 124 EZFS_DIFF, /* general failure of zfs diff */ 125 EZFS_DIFFDATA, /* bad zfs diff data */ 126 EZFS_POOLREADONLY, /* pool is in read-only mode */ 127 EZFS_SCRUB_PAUSED, /* scrub currently paused */ 128 EZFS_SCRUB_PAUSED_TO_CANCEL, /* scrub currently paused */ 129 EZFS_ACTIVE_POOL, /* pool is imported on a different system */ 130 EZFS_CRYPTOFAILED, /* failed to setup encryption */ 131 EZFS_NO_PENDING, /* cannot cancel, no operation is pending */ 132 EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */ 133 EZFS_DISCARDING_CHECKPOINT, /* currently discarding a checkpoint */ 134 EZFS_NO_CHECKPOINT, /* pool has no checkpoint */ 135 EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */ 136 EZFS_VDEV_TOO_BIG, /* a device is too big to be used */ 137 EZFS_IOC_NOTSUPPORTED, /* operation not supported by zfs module */ 138 EZFS_TOOMANY, /* argument list too long */ 139 EZFS_INITIALIZING, /* currently initializing */ 140 EZFS_NO_INITIALIZE, /* no active initialize */ 141 EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */ 142 EZFS_TRIMMING, /* currently trimming */ 143 EZFS_NO_TRIM, /* no active trim */ 144 EZFS_TRIM_NOTSUP, /* device does not support trim */ 145 EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ 146 EZFS_EXPORT_IN_PROGRESS, /* currently exporting the pool */ 147 EZFS_REBUILDING, /* resilvering (sequential reconstrution) */ 148 EZFS_VDEV_NOTSUP, /* ops not supported for this type of vdev */ 149 EZFS_NOT_USER_NAMESPACE, /* a file is not a user namespace */ 150 EZFS_CKSUM, /* insufficient replicas */ 151 EZFS_RESUME_EXISTS, /* Resume on existing dataset without force */ 152 EZFS_SHAREFAILED, /* filesystem share failed */ 153 EZFS_RAIDZ_EXPAND_IN_PROGRESS, /* a raidz is currently expanding */ 154 EZFS_ASHIFT_MISMATCH, /* can't add vdevs with different ashifts */ 155 EZFS_NO_USER_NS_SUPPORT, /* kernel built without CONFIG_USER_NS */ 156 EZFS_UNKNOWN 157 } zfs_error_t; 158 159 /* 160 * The following data structures are all part 161 * of the zfs_allow_t data structure which is 162 * used for printing 'allow' permissions. 163 * It is a linked list of zfs_allow_t's which 164 * then contain avl tree's for user/group/sets/... 165 * and each one of the entries in those trees have 166 * avl tree's for the permissions they belong to and 167 * whether they are local,descendent or local+descendent 168 * permissions. The AVL trees are used primarily for 169 * sorting purposes, but also so that we can quickly find 170 * a given user and or permission. 171 */ 172 typedef struct zfs_perm_node { 173 avl_node_t z_node; 174 char z_pname[MAXPATHLEN]; 175 } zfs_perm_node_t; 176 177 typedef struct zfs_allow_node { 178 avl_node_t z_node; 179 char z_key[MAXPATHLEN]; /* name, such as joe */ 180 avl_tree_t z_localdescend; /* local+descendent perms */ 181 avl_tree_t z_local; /* local permissions */ 182 avl_tree_t z_descend; /* descendent permissions */ 183 } zfs_allow_node_t; 184 185 typedef struct zfs_allow { 186 struct zfs_allow *z_next; 187 char z_setpoint[MAXPATHLEN]; 188 avl_tree_t z_sets; 189 avl_tree_t z_crperms; 190 avl_tree_t z_user; 191 avl_tree_t z_group; 192 avl_tree_t z_everyone; 193 } zfs_allow_t; 194 195 /* 196 * Basic handle types 197 */ 198 typedef struct zfs_handle zfs_handle_t; 199 typedef struct zpool_handle zpool_handle_t; 200 typedef struct libzfs_handle libzfs_handle_t; 201 202 _LIBZFS_H int zpool_wait(zpool_handle_t *, zpool_wait_activity_t); 203 _LIBZFS_H int zpool_wait_status(zpool_handle_t *, zpool_wait_activity_t, 204 boolean_t *, boolean_t *); 205 206 /* 207 * Library initialization 208 */ 209 _LIBZFS_H libzfs_handle_t *libzfs_init(void); 210 _LIBZFS_H void libzfs_fini(libzfs_handle_t *); 211 212 _LIBZFS_H libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 213 _LIBZFS_H libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 214 215 _LIBZFS_H void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 216 217 _LIBZFS_H void zfs_save_arguments(int argc, char **, char *, int); 218 _LIBZFS_H int zpool_log_history(libzfs_handle_t *, const char *); 219 220 _LIBZFS_H int libzfs_errno(libzfs_handle_t *); 221 _LIBZFS_H const char *libzfs_error_init(int); 222 _LIBZFS_H const char *libzfs_error_action(libzfs_handle_t *); 223 _LIBZFS_H const char *libzfs_error_description(libzfs_handle_t *); 224 _LIBZFS_H int zfs_standard_error(libzfs_handle_t *, int, const char *); 225 _LIBZFS_H void libzfs_mnttab_init(libzfs_handle_t *); 226 _LIBZFS_H void libzfs_mnttab_fini(libzfs_handle_t *); 227 _LIBZFS_H void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 228 _LIBZFS_H int libzfs_mnttab_find(libzfs_handle_t *, const char *, 229 struct mnttab *); 230 _LIBZFS_H void libzfs_mnttab_add(libzfs_handle_t *, const char *, 231 const char *, const char *); 232 _LIBZFS_H void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 233 234 /* 235 * Basic handle functions 236 */ 237 _LIBZFS_H zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 238 _LIBZFS_H zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 239 _LIBZFS_H void zpool_close(zpool_handle_t *); 240 _LIBZFS_H const char *zpool_get_name(zpool_handle_t *); 241 _LIBZFS_H int zpool_get_state(zpool_handle_t *); 242 _LIBZFS_H const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 243 _LIBZFS_H const char *zpool_pool_state_to_name(pool_state_t); 244 _LIBZFS_H void zpool_free_handles(libzfs_handle_t *); 245 246 /* 247 * Iterate over all active pools in the system. 248 */ 249 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 250 _LIBZFS_H int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 251 _LIBZFS_H boolean_t zpool_skip_pool(const char *); 252 253 /* 254 * Functions to create and destroy pools 255 */ 256 _LIBZFS_H int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 257 nvlist_t *, nvlist_t *); 258 _LIBZFS_H int zpool_destroy(zpool_handle_t *, const char *); 259 _LIBZFS_H int zpool_add(zpool_handle_t *, nvlist_t *, boolean_t check_ashift); 260 261 typedef struct splitflags { 262 /* do not split, but return the config that would be split off */ 263 unsigned int dryrun : 1; 264 265 /* after splitting, import the pool */ 266 unsigned int import : 1; 267 int name_flags; 268 } splitflags_t; 269 270 typedef struct trimflags { 271 /* requested vdevs are for the entire pool */ 272 boolean_t fullpool; 273 274 /* request a secure trim, requires support from device */ 275 boolean_t secure; 276 277 /* after starting trim, block until trim completes */ 278 boolean_t wait; 279 280 /* trim at the requested rate in bytes/second */ 281 uint64_t rate; 282 } trimflags_t; 283 284 typedef struct trim_cbdata { 285 trimflags_t trim_flags; 286 pool_trim_func_t cmd_type; 287 } trim_cbdata_t; 288 289 typedef struct initialize_cbdata { 290 boolean_t wait; 291 pool_initialize_func_t cmd_type; 292 uint64_t value; 293 boolean_t value_provided; 294 } initialize_cbdata_t; 295 /* 296 * Functions to manipulate pool and vdev state 297 */ 298 _LIBZFS_H int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 299 _LIBZFS_H int zpool_scan_range(zpool_handle_t *, pool_scan_func_t, 300 pool_scrub_cmd_t, pool_scrub_flags_t, time_t, time_t); 301 _LIBZFS_H int zpool_initialize_one(zpool_handle_t *, void *); 302 _LIBZFS_H int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, 303 nvlist_t *, uint64_t, boolean_t); 304 _LIBZFS_H int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t, 305 nvlist_t *, uint64_t, boolean_t); 306 _LIBZFS_H int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *, 307 trimflags_t *); 308 _LIBZFS_H int zpool_condense(zpool_handle_t *, const char *, const char *); 309 310 _LIBZFS_H int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 311 _LIBZFS_H int zpool_reguid(zpool_handle_t *); 312 _LIBZFS_H int zpool_set_guid(zpool_handle_t *, const uint64_t *); 313 _LIBZFS_H int zpool_reopen_one(zpool_handle_t *, void *); 314 315 _LIBZFS_H void zpool_collect_leaves(zpool_handle_t *, nvlist_t *, nvlist_t *); 316 _LIBZFS_H int zpool_sync_one(zpool_handle_t *, void *); 317 _LIBZFS_H int zpool_trim_one(zpool_handle_t *, void *); 318 319 _LIBZFS_H int zpool_ddt_prune(zpool_handle_t *, zpool_ddt_prune_unit_t, 320 uint64_t); 321 322 _LIBZFS_H int zpool_vdev_online(zpool_handle_t *, const char *, int, 323 vdev_state_t *); 324 _LIBZFS_H int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 325 _LIBZFS_H int zpool_vdev_attach(zpool_handle_t *, const char *, 326 const char *, nvlist_t *, int, boolean_t); 327 _LIBZFS_H int zpool_vdev_detach(zpool_handle_t *, const char *); 328 _LIBZFS_H int zpool_vdev_remove(zpool_handle_t *, const char *); 329 _LIBZFS_H int zpool_vdev_remove_cancel(zpool_handle_t *); 330 _LIBZFS_H int zpool_vdev_indirect_size(zpool_handle_t *, const char *, 331 uint64_t *); 332 _LIBZFS_H int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, 333 nvlist_t *, splitflags_t); 334 _LIBZFS_H int zpool_vdev_remove_wanted(zpool_handle_t *, const char *); 335 336 _LIBZFS_H int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 337 _LIBZFS_H int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 338 _LIBZFS_H int zpool_vdev_set_removed_state(zpool_handle_t *, uint64_t, 339 vdev_aux_t); 340 341 _LIBZFS_H int zpool_vdev_clear(zpool_handle_t *, uint64_t); 342 343 _LIBZFS_H nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 344 boolean_t *, boolean_t *); 345 _LIBZFS_H nvlist_t *zpool_find_parent_vdev(zpool_handle_t *, const char *, 346 boolean_t *, boolean_t *, boolean_t *); 347 _LIBZFS_H nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 348 boolean_t *, boolean_t *, boolean_t *); 349 _LIBZFS_H int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, 350 const char *); 351 _LIBZFS_H int zpool_prepare_disk(zpool_handle_t *zhp, nvlist_t *vdev_nv, 352 const char *prepare_str, char **lines[], int *lines_cnt); 353 _LIBZFS_H int zpool_prepare_and_label_disk(libzfs_handle_t *hdl, 354 zpool_handle_t *, const char *, nvlist_t *vdev_nv, const char *prepare_str, 355 char **lines[], int *lines_cnt); 356 _LIBZFS_H char ** zpool_vdev_script_alloc_env(const char *pool_name, 357 const char *vdev_path, const char *vdev_upath, 358 const char *vdev_enc_sysfs_path, const char *opt_key, const char *opt_val); 359 _LIBZFS_H void zpool_vdev_script_free_env(char **env); 360 _LIBZFS_H uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, 361 const char *path); 362 363 _LIBZFS_H const char *zpool_get_state_str(zpool_handle_t *); 364 365 /* 366 * Functions to manage pool properties 367 */ 368 _LIBZFS_H int zpool_set_prop(zpool_handle_t *, const char *, const char *); 369 _LIBZFS_H int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 370 size_t proplen, zprop_source_t *, boolean_t literal); 371 _LIBZFS_H int zpool_get_userprop(zpool_handle_t *, const char *, char *, 372 size_t proplen, zprop_source_t *); 373 _LIBZFS_H uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 374 zprop_source_t *); 375 _LIBZFS_H int zpool_props_refresh(zpool_handle_t *); 376 377 _LIBZFS_H const char *zpool_prop_to_name(zpool_prop_t); 378 _LIBZFS_H const char *zpool_prop_values(zpool_prop_t); 379 380 /* 381 * Functions to manage vdev properties 382 */ 383 _LIBZFS_H int zpool_get_vdev_prop_value(nvlist_t *, vdev_prop_t, char *, char *, 384 size_t, zprop_source_t *, boolean_t); 385 _LIBZFS_H int zpool_get_vdev_prop(zpool_handle_t *, const char *, vdev_prop_t, 386 char *, char *, size_t, zprop_source_t *, boolean_t); 387 _LIBZFS_H int zpool_get_all_vdev_props(zpool_handle_t *, const char *, 388 nvlist_t **); 389 _LIBZFS_H int zpool_set_vdev_prop(zpool_handle_t *, const char *, const char *, 390 const char *); 391 392 _LIBZFS_H const char *vdev_prop_to_name(vdev_prop_t); 393 _LIBZFS_H const char *vdev_prop_values(vdev_prop_t); 394 _LIBZFS_H boolean_t vdev_prop_user(const char *name); 395 _LIBZFS_H const char *vdev_prop_column_name(vdev_prop_t); 396 _LIBZFS_H boolean_t vdev_prop_align_right(vdev_prop_t); 397 398 /* 399 * Pool health statistics. 400 */ 401 typedef enum { 402 /* 403 * The following correspond to faults as defined in the (fault.fs.zfs.*) 404 * event namespace. Each is associated with a corresponding message ID. 405 * This must be kept in sync with the zfs_msgid_table in 406 * lib/libzfs/libzfs_status.c. 407 */ 408 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 409 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 410 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 411 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 412 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 413 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 414 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 415 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 416 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 417 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 418 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 419 ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ 420 ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ 421 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 422 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 423 ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ 424 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 425 ZPOOL_STATUS_ERRATA, /* informational errata available */ 426 427 /* 428 * If the pool has unsupported features but can still be opened in 429 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 430 * pool has unsupported features but cannot be opened at all, its 431 * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 432 */ 433 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 434 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 435 436 /* 437 * These faults have no corresponding message ID. At the time we are 438 * checking the status, the original reason for the FMA fault (I/O or 439 * checksum errors) has been lost. 440 */ 441 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 442 ZPOOL_STATUS_FAULTED_FDOM_R, /* faulted fdomain with replicas */ 443 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 444 445 /* 446 * The following are not faults per se, but still an error possibly 447 * requiring administrative attention. There is no corresponding 448 * message ID. 449 */ 450 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 451 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 452 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 453 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 454 ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 455 ZPOOL_STATUS_REBUILDING, /* device being rebuilt */ 456 ZPOOL_STATUS_REBUILD_SCRUB, /* recommend scrubbing the pool */ 457 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */ 458 ZPOOL_STATUS_COMPATIBILITY_ERR, /* bad 'compatibility' property */ 459 ZPOOL_STATUS_INCOMPATIBLE_FEAT, /* feature set outside compatibility */ 460 461 /* 462 * Finally, the following indicates a healthy pool. 463 */ 464 ZPOOL_STATUS_OK 465 } zpool_status_t; 466 467 _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, const char **, 468 zpool_errata_t *); 469 _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, const char **, 470 zpool_errata_t *); 471 472 /* 473 * Statistics and configuration functions. 474 */ 475 _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 476 _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *); 477 _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 478 _LIBZFS_H void zpool_refresh_stats_from_handle(zpool_handle_t *, 479 zpool_handle_t *); 480 _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 481 _LIBZFS_H void zpool_add_propname(zpool_handle_t *, const char *); 482 483 /* 484 * Import and export functions 485 */ 486 _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *); 487 _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *); 488 _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 489 char *altroot); 490 _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 491 nvlist_t *, int); 492 _LIBZFS_H void zpool_collect_unsup_feat(nvlist_t *config, char *buf, 493 size_t size); 494 495 /* 496 * Miscellaneous pool functions 497 */ 498 struct zfs_cmd; 499 500 _LIBZFS_H const char *const zfs_history_event_names[]; 501 502 typedef enum { 503 VDEV_NAME_PATH = 1 << 0, 504 VDEV_NAME_GUID = 1 << 1, 505 VDEV_NAME_FOLLOW_LINKS = 1 << 2, 506 VDEV_NAME_TYPE_ID = 1 << 3, 507 } vdev_name_t; 508 509 _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 510 int name_flags); 511 _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t); 512 _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *, 513 boolean_t *); 514 _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, 515 int); 516 _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *); 517 _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int); 518 _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t, 519 char *, size_t); 520 _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 521 size_t); 522 _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 523 _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int, 524 nvlist_t *, char *, size_t); 525 _LIBZFS_H int zpool_checkpoint(zpool_handle_t *); 526 _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *); 527 _LIBZFS_H boolean_t zpool_is_draid_spare(const char *); 528 529 _LIBZFS_H int zpool_prefetch(zpool_handle_t *, zpool_prefetch_type_t); 530 531 /* 532 * Basic handle manipulations. These functions do not create or destroy the 533 * underlying datasets, only the references to them. 534 */ 535 _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 536 _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 537 _LIBZFS_H void zfs_close(zfs_handle_t *); 538 _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *); 539 _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *); 540 _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *); 541 _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 542 _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *); 543 544 /* 545 * Property management functions. Some functions are shared with the kernel, 546 * and are found in sys/fs/zfs.h. 547 */ 548 549 /* 550 * zfs dataset property management 551 */ 552 _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t); 553 _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t); 554 _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t); 555 _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t); 556 557 _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 558 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, 559 const char *); 560 561 _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t); 562 _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *); 563 _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 564 _LIBZFS_H int zfs_prop_set_list_flags(zfs_handle_t *, nvlist_t *, int); 565 _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 566 zprop_source_t *, char *, size_t, boolean_t); 567 _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 568 boolean_t); 569 _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 570 zprop_source_t *, char *, size_t); 571 _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp, 572 const char *propname, uint64_t *propvalue); 573 _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 574 char *propbuf, int proplen, boolean_t literal); 575 _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 576 uint64_t *propvalue); 577 _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 578 char *propbuf, int proplen, boolean_t literal); 579 _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 580 char *buf, size_t len); 581 _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, const char **); 582 _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 583 _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 584 _LIBZFS_H const char *zfs_prop_values(zfs_prop_t); 585 _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop); 586 _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *); 587 _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *); 588 _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 589 _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 590 591 _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t, 592 boolean_t *, boolean_t *); 593 594 /* 595 * zfs encryption management 596 */ 597 _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, 598 char *); 599 _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, 600 nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *); 601 _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, 602 nvlist_t *); 603 _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *); 604 _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *); 605 _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *); 606 _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); 607 _LIBZFS_H boolean_t zfs_is_encrypted(zfs_handle_t *); 608 609 typedef struct zprop_list { 610 int pl_prop; 611 char *pl_user_prop; 612 struct zprop_list *pl_next; 613 boolean_t pl_all; 614 size_t pl_width; 615 size_t pl_recvd_width; 616 boolean_t pl_fixed; 617 } zprop_list_t; 618 619 _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 620 boolean_t); 621 _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 622 _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *, 623 zprop_list_t **); 624 625 #define ZFS_MOUNTPOINT_NONE "none" 626 #define ZFS_MOUNTPOINT_LEGACY "legacy" 627 628 #define ZFS_FEATURE_DISABLED "disabled" 629 #define ZFS_FEATURE_ENABLED "enabled" 630 #define ZFS_FEATURE_ACTIVE "active" 631 632 #define ZFS_UNSUPPORTED_INACTIVE "inactive" 633 #define ZFS_UNSUPPORTED_READONLY "readonly" 634 635 /* 636 * zpool property management 637 */ 638 _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **, 639 zfs_type_t, boolean_t); 640 _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 641 size_t); 642 _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t); 643 _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t); 644 _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t); 645 _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t); 646 647 /* 648 * Functions shared by zfs and zpool property management. 649 */ 650 _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 651 boolean_t ordered, zfs_type_t type); 652 _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 653 zfs_type_t); 654 _LIBZFS_H void zprop_free_list(zprop_list_t *); 655 656 _LIBZFS_H void zcmd_print_json(nvlist_t *); 657 658 #define ZFS_GET_NCOLS 5 659 660 typedef enum { 661 GET_COL_NONE, 662 GET_COL_NAME, 663 GET_COL_PROPERTY, 664 GET_COL_VALUE, 665 GET_COL_RECVD, 666 GET_COL_SOURCE 667 } zfs_get_column_t; 668 669 /* 670 * Functions for printing zfs or zpool properties 671 */ 672 typedef struct vdev_cbdata { 673 int cb_name_flags; 674 char **cb_names; 675 unsigned int cb_names_count; 676 } vdev_cbdata_t; 677 678 typedef struct zprop_get_cbdata { 679 int cb_sources; 680 zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 681 int cb_colwidths[ZFS_GET_NCOLS + 1]; 682 boolean_t cb_scripted; 683 boolean_t cb_literal; 684 boolean_t cb_first; 685 boolean_t cb_json; 686 zprop_list_t *cb_proplist; 687 zfs_type_t cb_type; 688 vdev_cbdata_t cb_vdevs; 689 nvlist_t *cb_jsobj; 690 boolean_t cb_json_as_int; 691 boolean_t cb_json_pool_key_guid; 692 } zprop_get_cbdata_t; 693 694 #define ZFS_SET_NOMOUNT 1 695 696 typedef struct zprop_set_cbdata { 697 int cb_flags; 698 nvlist_t *cb_proplist; 699 } zprop_set_cbdata_t; 700 701 _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 702 const char *, const char *, zprop_source_t, const char *, 703 const char *); 704 705 _LIBZFS_H int zprop_nvlist_one_property(const char *, const char *, 706 zprop_source_t, const char *, const char *, nvlist_t *, boolean_t); 707 708 _LIBZFS_H int zprop_collect_property(const char *, zprop_get_cbdata_t *, 709 const char *, const char *, zprop_source_t, const char *, 710 const char *, nvlist_t *); 711 712 /* 713 * Iterator functions. 714 */ 715 #define ZFS_ITER_RECURSE (1 << 0) 716 #define ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1) 717 #define ZFS_ITER_PROP_LISTSNAPS (1 << 2) 718 #define ZFS_ITER_DEPTH_LIMIT (1 << 3) 719 #define ZFS_ITER_RECVD_PROPS (1 << 4) 720 #define ZFS_ITER_LITERAL_PROPS (1 << 5) 721 #define ZFS_ITER_SIMPLE (1 << 6) 722 723 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 724 _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 725 _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 726 _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, 727 void *); 728 _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 729 _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *, 730 uint64_t, uint64_t); 731 _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *, 732 uint64_t, uint64_t); 733 _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, 734 void *); 735 _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 736 737 _LIBZFS_H int zfs_iter_children_v2(zfs_handle_t *, int, zfs_iter_f, void *); 738 _LIBZFS_H int zfs_iter_dependents_v2(zfs_handle_t *, int, boolean_t, zfs_iter_f, 739 void *); 740 _LIBZFS_H int zfs_iter_filesystems_v2(zfs_handle_t *, int, zfs_iter_f, void *); 741 _LIBZFS_H int zfs_iter_snapshots_v2(zfs_handle_t *, int, zfs_iter_f, void *, 742 uint64_t, uint64_t); 743 _LIBZFS_H int zfs_iter_snapshots_sorted_v2(zfs_handle_t *, int, zfs_iter_f, 744 void *, uint64_t, uint64_t); 745 _LIBZFS_H int zfs_iter_snapspec_v2(zfs_handle_t *, int, const char *, 746 zfs_iter_f, void *); 747 _LIBZFS_H int zfs_iter_bookmarks_v2(zfs_handle_t *, int, zfs_iter_f, void *); 748 _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *); 749 750 typedef struct get_all_cb { 751 zfs_handle_t **cb_handles; 752 size_t cb_alloc; 753 size_t cb_used; 754 } get_all_cb_t; 755 756 _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, 757 size_t, zfs_iter_f, void *, uint_t); 758 _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 759 760 /* 761 * Functions to create and destroy datasets. 762 */ 763 _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 764 nvlist_t *); 765 _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *); 766 _LIBZFS_H int zfs_create_ancestors_props(libzfs_handle_t *, const char *, 767 nvlist_t *); 768 _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t); 769 _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 770 _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 771 _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *); 772 _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 773 _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, 774 nvlist_t *); 775 _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 776 nvlist_t *props); 777 _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 778 779 typedef struct renameflags { 780 /* recursive rename */ 781 unsigned int recursive : 1; 782 783 /* don't unmount file systems */ 784 unsigned int nounmount : 1; 785 786 /* force unmount file systems */ 787 unsigned int forceunmount : 1; 788 } renameflags_t; 789 790 _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t); 791 792 typedef struct sendflags { 793 /* Amount of extra information to print. */ 794 int verbosity; 795 796 /* recursive send (ie, -R) */ 797 boolean_t replicate; 798 799 /* for recursive send, skip sending missing snapshots */ 800 boolean_t skipmissing; 801 802 /* for incrementals, do all intermediate snapshots */ 803 boolean_t doall; 804 805 /* if dataset is a clone, do incremental from its origin */ 806 boolean_t fromorigin; 807 808 /* field no longer used, maintained for backwards compatibility */ 809 boolean_t pad; 810 811 /* send properties (ie, -p) */ 812 boolean_t props; 813 814 /* do not send (no-op, ie. -n) */ 815 boolean_t dryrun; 816 817 /* parsable verbose output (ie. -P) */ 818 boolean_t parsable; 819 820 /* show progress (ie. -v) */ 821 boolean_t progress; 822 823 /* show progress as process title (ie. -V) */ 824 boolean_t progressastitle; 825 826 /* large blocks (>128K) are permitted */ 827 boolean_t largeblock; 828 829 /* WRITE_EMBEDDED records of type DATA are permitted */ 830 boolean_t embed_data; 831 832 /* compressed WRITE records are permitted */ 833 boolean_t compress; 834 835 /* raw encrypted records are permitted */ 836 boolean_t raw; 837 838 /* only send received properties (ie. -b) */ 839 boolean_t backup; 840 841 /* include snapshot holds in send stream */ 842 boolean_t holds; 843 844 /* stream represents a partially received dataset */ 845 boolean_t saved; 846 847 /* allow sending datasets with props, without preserving encryption */ 848 boolean_t no_preserve_encryption; 849 } sendflags_t; 850 851 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 852 853 _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *, 854 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 855 _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *, 856 const char *); 857 _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *); 858 _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 859 const char *); 860 _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *); 861 _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 862 const char *token); 863 864 _LIBZFS_H int zfs_promote(zfs_handle_t *); 865 _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *, 866 boolean_t, int); 867 _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 868 _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *, 869 boolean_t); 870 _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **); 871 _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, 872 nvlist_t *); 873 874 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 875 uid_t rid, uint64_t space, uint64_t default_quota); 876 877 _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 878 zfs_userspace_cb_t, void *); 879 880 _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 881 _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 882 883 typedef struct recvflags { 884 /* print informational messages (ie, -v was specified) */ 885 boolean_t verbose; 886 887 /* the destination is a prefix, not the exact fs (ie, -d) */ 888 boolean_t isprefix; 889 890 /* 891 * Only the tail of the sent snapshot path is appended to the 892 * destination to determine the received snapshot name (ie, -e). 893 */ 894 boolean_t istail; 895 896 /* do not actually do the recv, just check if it would work (ie, -n) */ 897 boolean_t dryrun; 898 899 /* rollback/destroy filesystems as necessary (eg, -F) */ 900 boolean_t force; 901 902 /* set "canmount=off" on all modified filesystems */ 903 boolean_t canmountoff; 904 905 /* 906 * Mark the file systems as "resumable" and do not destroy them if the 907 * receive is interrupted 908 */ 909 boolean_t resumable; 910 911 /* byteswap flag is used internally; callers need not specify */ 912 boolean_t byteswap; 913 914 /* do not mount file systems as they are extracted (private) */ 915 boolean_t nomount; 916 917 /* Was holds flag set in the compound header? */ 918 boolean_t holds; 919 920 /* skip receive of snapshot holds */ 921 boolean_t skipholds; 922 923 /* mount the filesystem unless nomount is specified */ 924 boolean_t domount; 925 926 /* force unmount while recv snapshot (private) */ 927 boolean_t forceunmount; 928 929 /* use this recv to check (and heal if needed) an existing snapshot */ 930 boolean_t heal; 931 } recvflags_t; 932 933 _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 934 recvflags_t *, int, avl_tree_t *); 935 936 typedef enum diff_flags { 937 ZFS_DIFF_PARSEABLE = 1 << 0, 938 ZFS_DIFF_TIMESTAMP = 1 << 1, 939 ZFS_DIFF_CLASSIFY = 1 << 2, 940 ZFS_DIFF_NO_MANGLE = 1 << 3 941 } diff_flags_t; 942 943 _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 944 int); 945 946 /* 947 * Miscellaneous functions. 948 */ 949 _LIBZFS_H const char *zfs_type_to_name(zfs_type_t); 950 _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *); 951 _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t); 952 _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *, 953 zfs_type_t); 954 _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t); 955 _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 956 zfs_type_t); 957 _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *); 958 _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path); 959 960 /* 961 * Mount support functions. 962 */ 963 _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 964 _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **); 965 _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int); 966 _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *); 967 _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int); 968 _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int); 969 _LIBZFS_H int zfs_mount_delegation_check(void); 970 971 #if defined(__linux__) || defined(__APPLE__) 972 _LIBZFS_H int zfs_parse_mount_options(const char *mntopts, 973 unsigned long *mntflags, unsigned long *zfsflags, int sloppy, char *badopt, 974 char *mtabopt); 975 _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint, 976 char *mntopts, char *mtabopt); 977 #endif 978 979 /* 980 * Share support functions. 981 * 982 * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL, 983 * NULL means "all/any known to this libzfs". 984 */ 985 #define SA_NO_PROTOCOL -1 986 987 /* available protocols */ 988 enum sa_protocol { 989 SA_PROTOCOL_NFS, 990 SA_PROTOCOL_SMB, /* ABI: add before _COUNT */ 991 SA_PROTOCOL_COUNT, 992 }; 993 994 _LIBZFS_H const char *zfs_share_protocol_name(enum sa_protocol); 995 996 _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where, 997 const enum sa_protocol *proto); 998 _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto); 999 _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint, 1000 const enum sa_protocol *proto); 1001 _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp, 1002 const enum sa_protocol *proto); 1003 _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto); 1004 _LIBZFS_H void zfs_truncate_shares(const enum sa_protocol *proto); 1005 1006 _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 1007 1008 /* 1009 * Utility functions to run an external process. 1010 */ 1011 #define STDOUT_VERBOSE 0x01 1012 #define STDERR_VERBOSE 0x02 1013 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ 1014 1015 _LIBZFS_H int libzfs_run_process(const char *, char **, int); 1016 _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[], 1017 char **[], int *); 1018 _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[], 1019 char *[], char **[], int *); 1020 1021 _LIBZFS_H void libzfs_free_str_array(char **, int); 1022 1023 _LIBZFS_H boolean_t libzfs_envvar_is_set(const char *); 1024 1025 /* 1026 * Utility functions for zfs version 1027 */ 1028 _LIBZFS_H const char *zfs_version_userland(void); 1029 _LIBZFS_H char *zfs_version_kernel(void); 1030 _LIBZFS_H int zfs_version_print(void); 1031 _LIBZFS_H nvlist_t *zfs_version_nvlist(void); 1032 1033 /* 1034 * Given a device or file, determine if it is part of a pool. 1035 */ 1036 _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 1037 boolean_t *); 1038 1039 /* 1040 * Label manipulation. 1041 */ 1042 _LIBZFS_H int zpool_clear_label(int); 1043 _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *); 1044 _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **); 1045 1046 /* 1047 * Management interfaces for SMB ACL files 1048 */ 1049 1050 _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 1051 _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 1052 _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 1053 _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, 1054 char *); 1055 1056 /* 1057 * Enable and disable datasets within a pool by mounting/unmounting and 1058 * sharing/unsharing them. 1059 */ 1060 _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int, 1061 uint_t); 1062 _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t); 1063 _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t); 1064 _LIBZFS_H void zpool_disable_volume_os(const char *); 1065 1066 /* 1067 * Parse a features file for -o compatibility 1068 */ 1069 typedef enum { 1070 ZPOOL_COMPATIBILITY_OK, 1071 ZPOOL_COMPATIBILITY_WARNTOKEN, 1072 ZPOOL_COMPATIBILITY_BADTOKEN, 1073 ZPOOL_COMPATIBILITY_BADFILE, 1074 ZPOOL_COMPATIBILITY_NOFILES 1075 } zpool_compat_status_t; 1076 1077 _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *, 1078 boolean_t *, char *, size_t); 1079 1080 #ifdef __FreeBSD__ 1081 1082 /* 1083 * Attach/detach the given filesystem to/from the given jail. 1084 */ 1085 _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach); 1086 1087 /* 1088 * Set loader options for next boot. 1089 */ 1090 _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, 1091 const char *); 1092 1093 #endif /* __FreeBSD__ */ 1094 1095 #ifdef __linux__ 1096 1097 /* 1098 * Add or delete the given filesystem to/from the given user namespace. 1099 */ 1100 _LIBZFS_H int zfs_userns(zfs_handle_t *zhp, const char *nspath, int attach); 1101 1102 #endif 1103 1104 #ifdef __cplusplus 1105 } 1106 #endif 1107 1108 #endif /* _LIBZFS_H */ 1109