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