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_NO_USER_NS_SUPPORT, /* kernel built without CONFIG_USER_NS */ 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_FDOM_R, /* faulted fdomain with replicas */ 448 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 449 450 /* 451 * The following are not faults per se, but still an error possibly 452 * requiring administrative attention. There is no corresponding 453 * message ID. 454 */ 455 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 456 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 457 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 458 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 459 ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 460 ZPOOL_STATUS_REBUILDING, /* device being rebuilt */ 461 ZPOOL_STATUS_REBUILD_SCRUB, /* recommend scrubbing the pool */ 462 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */ 463 ZPOOL_STATUS_COMPATIBILITY_ERR, /* bad 'compatibility' property */ 464 ZPOOL_STATUS_INCOMPATIBLE_FEAT, /* feature set outside compatibility */ 465 466 /* 467 * Finally, the following indicates a healthy pool. 468 */ 469 ZPOOL_STATUS_OK 470 } zpool_status_t; 471 472 _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, const char **, 473 zpool_errata_t *); 474 _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, const char **, 475 zpool_errata_t *); 476 477 /* 478 * Statistics and configuration functions. 479 */ 480 _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 481 _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *); 482 _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 483 _LIBZFS_H void zpool_refresh_stats_from_handle(zpool_handle_t *, 484 zpool_handle_t *); 485 _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 486 _LIBZFS_H void zpool_add_propname(zpool_handle_t *, const char *); 487 488 /* 489 * Import and export functions 490 */ 491 _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *); 492 _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *); 493 _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 494 char *altroot); 495 _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 496 nvlist_t *, int); 497 _LIBZFS_H void zpool_collect_unsup_feat(nvlist_t *config, char *buf, 498 size_t size); 499 500 /* 501 * Miscellaneous pool functions 502 */ 503 struct zfs_cmd; 504 505 _LIBZFS_H const char *const zfs_history_event_names[]; 506 507 typedef enum { 508 VDEV_NAME_PATH = 1 << 0, 509 VDEV_NAME_GUID = 1 << 1, 510 VDEV_NAME_FOLLOW_LINKS = 1 << 2, 511 VDEV_NAME_TYPE_ID = 1 << 3, 512 } vdev_name_t; 513 514 _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 515 int name_flags); 516 _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t); 517 _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *, 518 boolean_t *); 519 _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, 520 int); 521 _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *); 522 _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int); 523 _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t, 524 char *, size_t); 525 _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 526 size_t); 527 _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 528 _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int, 529 nvlist_t *, char *, size_t); 530 _LIBZFS_H int zpool_checkpoint(zpool_handle_t *); 531 _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *); 532 _LIBZFS_H boolean_t zpool_is_draid_spare(const char *); 533 534 _LIBZFS_H int zpool_prefetch(zpool_handle_t *, zpool_prefetch_type_t); 535 536 /* 537 * Basic handle manipulations. These functions do not create or destroy the 538 * underlying datasets, only the references to them. 539 */ 540 _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 541 _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 542 _LIBZFS_H void zfs_close(zfs_handle_t *); 543 _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *); 544 _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *); 545 _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *); 546 _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 547 _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *); 548 549 /* 550 * Property management functions. Some functions are shared with the kernel, 551 * and are found in sys/fs/zfs.h. 552 */ 553 554 /* 555 * zfs dataset property management 556 */ 557 _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t); 558 _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t); 559 _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t); 560 _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t); 561 562 _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 563 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, 564 const char *); 565 566 _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t); 567 _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *); 568 _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 569 _LIBZFS_H int zfs_prop_set_list_flags(zfs_handle_t *, nvlist_t *, int); 570 _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 571 zprop_source_t *, char *, size_t, boolean_t); 572 _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 573 boolean_t); 574 _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 575 zprop_source_t *, char *, size_t); 576 _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp, 577 const char *propname, uint64_t *propvalue); 578 _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 579 char *propbuf, int proplen, boolean_t literal); 580 _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 581 uint64_t *propvalue); 582 _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 583 char *propbuf, int proplen, boolean_t literal); 584 _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 585 char *buf, size_t len); 586 _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, const char **); 587 _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 588 _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 589 _LIBZFS_H const char *zfs_prop_values(zfs_prop_t); 590 _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop); 591 _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *); 592 _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *); 593 _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 594 _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 595 596 _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t, 597 boolean_t *, boolean_t *); 598 599 /* 600 * zfs encryption management 601 */ 602 _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, 603 char *); 604 _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, 605 nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *); 606 _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, 607 nvlist_t *); 608 _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *); 609 _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *); 610 _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *); 611 _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); 612 _LIBZFS_H boolean_t zfs_is_encrypted(zfs_handle_t *); 613 614 typedef struct zprop_list { 615 int pl_prop; 616 char *pl_user_prop; 617 struct zprop_list *pl_next; 618 boolean_t pl_all; 619 size_t pl_width; 620 size_t pl_recvd_width; 621 boolean_t pl_fixed; 622 } zprop_list_t; 623 624 _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 625 boolean_t); 626 _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 627 _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *, 628 zprop_list_t **); 629 630 #define ZFS_MOUNTPOINT_NONE "none" 631 #define ZFS_MOUNTPOINT_LEGACY "legacy" 632 633 #define ZFS_FEATURE_DISABLED "disabled" 634 #define ZFS_FEATURE_ENABLED "enabled" 635 #define ZFS_FEATURE_ACTIVE "active" 636 637 #define ZFS_UNSUPPORTED_INACTIVE "inactive" 638 #define ZFS_UNSUPPORTED_READONLY "readonly" 639 640 /* 641 * zpool property management 642 */ 643 _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **, 644 zfs_type_t, boolean_t); 645 _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 646 size_t); 647 _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t); 648 _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t); 649 _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t); 650 _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t); 651 652 /* 653 * Functions shared by zfs and zpool property management. 654 */ 655 _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 656 boolean_t ordered, zfs_type_t type); 657 _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 658 zfs_type_t); 659 _LIBZFS_H void zprop_free_list(zprop_list_t *); 660 661 _LIBZFS_H void zcmd_print_json(nvlist_t *); 662 663 #define ZFS_GET_NCOLS 5 664 665 typedef enum { 666 GET_COL_NONE, 667 GET_COL_NAME, 668 GET_COL_PROPERTY, 669 GET_COL_VALUE, 670 GET_COL_RECVD, 671 GET_COL_SOURCE 672 } zfs_get_column_t; 673 674 /* 675 * Functions for printing zfs or zpool properties 676 */ 677 typedef struct vdev_cbdata { 678 int cb_name_flags; 679 char **cb_names; 680 unsigned int cb_names_count; 681 } vdev_cbdata_t; 682 683 typedef struct zprop_get_cbdata { 684 int cb_sources; 685 zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 686 int cb_colwidths[ZFS_GET_NCOLS + 1]; 687 boolean_t cb_scripted; 688 boolean_t cb_literal; 689 boolean_t cb_first; 690 boolean_t cb_json; 691 zprop_list_t *cb_proplist; 692 zfs_type_t cb_type; 693 vdev_cbdata_t cb_vdevs; 694 nvlist_t *cb_jsobj; 695 boolean_t cb_json_as_int; 696 boolean_t cb_json_pool_key_guid; 697 } zprop_get_cbdata_t; 698 699 #define ZFS_SET_NOMOUNT 1 700 701 typedef struct zprop_set_cbdata { 702 int cb_flags; 703 nvlist_t *cb_proplist; 704 } zprop_set_cbdata_t; 705 706 _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 707 const char *, const char *, zprop_source_t, const char *, 708 const char *); 709 710 _LIBZFS_H int zprop_nvlist_one_property(const char *, const char *, 711 zprop_source_t, const char *, const char *, nvlist_t *, boolean_t); 712 713 _LIBZFS_H int zprop_collect_property(const char *, zprop_get_cbdata_t *, 714 const char *, const char *, zprop_source_t, const char *, 715 const char *, nvlist_t *); 716 717 /* 718 * Iterator functions. 719 */ 720 #define ZFS_ITER_RECURSE (1 << 0) 721 #define ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1) 722 #define ZFS_ITER_PROP_LISTSNAPS (1 << 2) 723 #define ZFS_ITER_DEPTH_LIMIT (1 << 3) 724 #define ZFS_ITER_RECVD_PROPS (1 << 4) 725 #define ZFS_ITER_LITERAL_PROPS (1 << 5) 726 #define ZFS_ITER_SIMPLE (1 << 6) 727 728 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 729 _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 730 _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 731 _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, 732 void *); 733 _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 734 _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *, 735 uint64_t, uint64_t); 736 _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *, 737 uint64_t, uint64_t); 738 _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, 739 void *); 740 _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 741 742 _LIBZFS_H int zfs_iter_children_v2(zfs_handle_t *, int, zfs_iter_f, void *); 743 _LIBZFS_H int zfs_iter_dependents_v2(zfs_handle_t *, int, boolean_t, zfs_iter_f, 744 void *); 745 _LIBZFS_H int zfs_iter_filesystems_v2(zfs_handle_t *, int, zfs_iter_f, void *); 746 _LIBZFS_H int zfs_iter_snapshots_v2(zfs_handle_t *, int, zfs_iter_f, void *, 747 uint64_t, uint64_t); 748 _LIBZFS_H int zfs_iter_snapshots_sorted_v2(zfs_handle_t *, int, zfs_iter_f, 749 void *, uint64_t, uint64_t); 750 _LIBZFS_H int zfs_iter_snapspec_v2(zfs_handle_t *, int, const char *, 751 zfs_iter_f, void *); 752 _LIBZFS_H int zfs_iter_bookmarks_v2(zfs_handle_t *, int, zfs_iter_f, void *); 753 _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *); 754 755 typedef struct get_all_cb { 756 zfs_handle_t **cb_handles; 757 size_t cb_alloc; 758 size_t cb_used; 759 } get_all_cb_t; 760 761 _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, 762 size_t, zfs_iter_f, void *, uint_t); 763 _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 764 765 /* 766 * Functions to create and destroy datasets. 767 */ 768 _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 769 nvlist_t *); 770 _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *); 771 _LIBZFS_H int zfs_create_ancestors_props(libzfs_handle_t *, const char *, 772 nvlist_t *); 773 _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t); 774 _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 775 _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 776 _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *); 777 _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 778 _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, 779 nvlist_t *); 780 _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 781 nvlist_t *props); 782 _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 783 784 typedef struct renameflags { 785 /* recursive rename */ 786 unsigned int recursive : 1; 787 788 /* don't unmount file systems */ 789 unsigned int nounmount : 1; 790 791 /* force unmount file systems */ 792 unsigned int forceunmount : 1; 793 } renameflags_t; 794 795 _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t); 796 797 typedef struct sendflags { 798 /* Amount of extra information to print. */ 799 int verbosity; 800 801 /* recursive send (ie, -R) */ 802 boolean_t replicate; 803 804 /* for recursive send, skip sending missing snapshots */ 805 boolean_t skipmissing; 806 807 /* for incrementals, do all intermediate snapshots */ 808 boolean_t doall; 809 810 /* if dataset is a clone, do incremental from its origin */ 811 boolean_t fromorigin; 812 813 /* field no longer used, maintained for backwards compatibility */ 814 boolean_t pad; 815 816 /* send properties (ie, -p) */ 817 boolean_t props; 818 819 /* do not send (no-op, ie. -n) */ 820 boolean_t dryrun; 821 822 /* parsable verbose output (ie. -P) */ 823 boolean_t parsable; 824 825 /* show progress (ie. -v) */ 826 boolean_t progress; 827 828 /* show progress as process title (ie. -V) */ 829 boolean_t progressastitle; 830 831 /* large blocks (>128K) are permitted */ 832 boolean_t largeblock; 833 834 /* WRITE_EMBEDDED records of type DATA are permitted */ 835 boolean_t embed_data; 836 837 /* compressed WRITE records are permitted */ 838 boolean_t compress; 839 840 /* raw encrypted records are permitted */ 841 boolean_t raw; 842 843 /* only send received properties (ie. -b) */ 844 boolean_t backup; 845 846 /* include snapshot holds in send stream */ 847 boolean_t holds; 848 849 /* stream represents a partially received dataset */ 850 boolean_t saved; 851 852 /* allow sending datasets with props, without preserving encryption */ 853 boolean_t no_preserve_encryption; 854 } sendflags_t; 855 856 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 857 858 _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *, 859 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 860 _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *, 861 const char *); 862 _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *); 863 _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 864 const char *); 865 _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *); 866 _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 867 const char *token); 868 869 _LIBZFS_H int zfs_promote(zfs_handle_t *); 870 _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *, 871 boolean_t, int); 872 _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 873 _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *, 874 boolean_t); 875 _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **); 876 _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, 877 nvlist_t *); 878 879 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 880 uid_t rid, uint64_t space, uint64_t default_quota); 881 882 _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 883 zfs_userspace_cb_t, void *); 884 885 _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 886 _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 887 888 typedef struct recvflags { 889 /* print informational messages (ie, -v was specified) */ 890 boolean_t verbose; 891 892 /* the destination is a prefix, not the exact fs (ie, -d) */ 893 boolean_t isprefix; 894 895 /* 896 * Only the tail of the sent snapshot path is appended to the 897 * destination to determine the received snapshot name (ie, -e). 898 */ 899 boolean_t istail; 900 901 /* do not actually do the recv, just check if it would work (ie, -n) */ 902 boolean_t dryrun; 903 904 /* rollback/destroy filesystems as necessary (eg, -F) */ 905 boolean_t force; 906 907 /* set "canmount=off" on all modified filesystems */ 908 boolean_t canmountoff; 909 910 /* 911 * Mark the file systems as "resumable" and do not destroy them if the 912 * receive is interrupted 913 */ 914 boolean_t resumable; 915 916 /* byteswap flag is used internally; callers need not specify */ 917 boolean_t byteswap; 918 919 /* do not mount file systems as they are extracted (private) */ 920 boolean_t nomount; 921 922 /* Was holds flag set in the compound header? */ 923 boolean_t holds; 924 925 /* skip receive of snapshot holds */ 926 boolean_t skipholds; 927 928 /* mount the filesystem unless nomount is specified */ 929 boolean_t domount; 930 931 /* force unmount while recv snapshot (private) */ 932 boolean_t forceunmount; 933 934 /* use this recv to check (and heal if needed) an existing snapshot */ 935 boolean_t heal; 936 } recvflags_t; 937 938 _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 939 recvflags_t *, int, avl_tree_t *); 940 941 typedef enum diff_flags { 942 ZFS_DIFF_PARSEABLE = 1 << 0, 943 ZFS_DIFF_TIMESTAMP = 1 << 1, 944 ZFS_DIFF_CLASSIFY = 1 << 2, 945 ZFS_DIFF_NO_MANGLE = 1 << 3 946 } diff_flags_t; 947 948 _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 949 int); 950 951 /* 952 * Miscellaneous functions. 953 */ 954 _LIBZFS_H const char *zfs_type_to_name(zfs_type_t); 955 _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *); 956 _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t); 957 _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *, 958 zfs_type_t); 959 _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t); 960 _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 961 zfs_type_t); 962 _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *); 963 _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path); 964 965 /* 966 * Mount support functions. 967 */ 968 _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 969 _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **); 970 _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int); 971 _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *); 972 _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int); 973 _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int); 974 _LIBZFS_H int zfs_mount_delegation_check(void); 975 976 #if defined(__linux__) || defined(__APPLE__) 977 _LIBZFS_H int zfs_parse_mount_options(const char *mntopts, 978 unsigned long *mntflags, unsigned long *zfsflags, int sloppy, char *badopt, 979 char *mtabopt); 980 _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint, 981 char *mntopts, char *mtabopt); 982 #endif 983 984 /* 985 * Share support functions. 986 * 987 * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL, 988 * NULL means "all/any known to this libzfs". 989 */ 990 #define SA_NO_PROTOCOL -1 991 992 /* available protocols */ 993 enum sa_protocol { 994 SA_PROTOCOL_NFS, 995 SA_PROTOCOL_SMB, /* ABI: add before _COUNT */ 996 SA_PROTOCOL_COUNT, 997 }; 998 999 _LIBZFS_H const char *zfs_share_protocol_name(enum sa_protocol); 1000 1001 _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where, 1002 const enum sa_protocol *proto); 1003 _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto); 1004 _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint, 1005 const enum sa_protocol *proto); 1006 _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp, 1007 const enum sa_protocol *proto); 1008 _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto); 1009 _LIBZFS_H void zfs_truncate_shares(const enum sa_protocol *proto); 1010 1011 _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 1012 1013 /* 1014 * Utility functions to run an external process. 1015 */ 1016 #define STDOUT_VERBOSE 0x01 1017 #define STDERR_VERBOSE 0x02 1018 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ 1019 1020 _LIBZFS_H int libzfs_run_process(const char *, char **, int); 1021 _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[], 1022 char **[], int *); 1023 _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[], 1024 char *[], char **[], int *); 1025 1026 _LIBZFS_H void libzfs_free_str_array(char **, int); 1027 1028 _LIBZFS_H boolean_t libzfs_envvar_is_set(const char *); 1029 1030 /* 1031 * Utility functions for zfs version 1032 */ 1033 _LIBZFS_H const char *zfs_version_userland(void); 1034 _LIBZFS_H char *zfs_version_kernel(void); 1035 _LIBZFS_H int zfs_version_print(void); 1036 _LIBZFS_H nvlist_t *zfs_version_nvlist(void); 1037 1038 /* 1039 * Given a device or file, determine if it is part of a pool. 1040 */ 1041 _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 1042 boolean_t *); 1043 1044 /* 1045 * Label manipulation. 1046 */ 1047 _LIBZFS_H int zpool_clear_label(int); 1048 _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *); 1049 _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **); 1050 1051 /* 1052 * Management interfaces for SMB ACL files 1053 */ 1054 1055 _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 1056 _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 1057 _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 1058 _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, 1059 char *); 1060 1061 /* 1062 * Enable and disable datasets within a pool by mounting/unmounting and 1063 * sharing/unsharing them. 1064 */ 1065 _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int, 1066 uint_t); 1067 _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t); 1068 _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t); 1069 _LIBZFS_H void zpool_disable_volume_os(const char *); 1070 1071 /* 1072 * Parse a features file for -o compatibility 1073 */ 1074 typedef enum { 1075 ZPOOL_COMPATIBILITY_OK, 1076 ZPOOL_COMPATIBILITY_WARNTOKEN, 1077 ZPOOL_COMPATIBILITY_BADTOKEN, 1078 ZPOOL_COMPATIBILITY_BADFILE, 1079 ZPOOL_COMPATIBILITY_NOFILES 1080 } zpool_compat_status_t; 1081 1082 _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *, 1083 boolean_t *, char *, size_t); 1084 1085 #ifdef __FreeBSD__ 1086 1087 /* 1088 * Attach/detach the given filesystem to/from the given jail. 1089 */ 1090 _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach); 1091 1092 /* 1093 * Set loader options for next boot. 1094 */ 1095 _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, 1096 const char *); 1097 1098 #endif /* __FreeBSD__ */ 1099 1100 #ifdef __linux__ 1101 1102 /* 1103 * Add or delete the given filesystem to/from the given user namespace. 1104 */ 1105 _LIBZFS_H int zfs_userns(zfs_handle_t *zhp, const char *nspath, int attach); 1106 1107 #endif 1108 1109 #ifdef __cplusplus 1110 } 1111 #endif 1112 1113 #endif /* _LIBZFS_H */ 1114