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