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 */ 34 35 #ifndef _LIBZFS_H 36 #define _LIBZFS_H extern __attribute__((visibility("default"))) 37 38 #include <assert.h> 39 #include <libshare.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 /* 292 * Functions to manipulate pool and vdev state 293 */ 294 _LIBZFS_H int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 295 _LIBZFS_H int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, 296 nvlist_t *); 297 _LIBZFS_H int zpool_initialize_wait(zpool_handle_t *, pool_initialize_func_t, 298 nvlist_t *); 299 _LIBZFS_H int zpool_trim(zpool_handle_t *, pool_trim_func_t, nvlist_t *, 300 trimflags_t *); 301 302 _LIBZFS_H int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 303 _LIBZFS_H int zpool_reguid(zpool_handle_t *); 304 _LIBZFS_H int zpool_set_guid(zpool_handle_t *, const uint64_t *); 305 _LIBZFS_H int zpool_reopen_one(zpool_handle_t *, void *); 306 307 _LIBZFS_H int zpool_sync_one(zpool_handle_t *, void *); 308 309 _LIBZFS_H int zpool_ddt_prune(zpool_handle_t *, zpool_ddt_prune_unit_t, 310 uint64_t); 311 312 _LIBZFS_H int zpool_vdev_online(zpool_handle_t *, const char *, int, 313 vdev_state_t *); 314 _LIBZFS_H int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 315 _LIBZFS_H int zpool_vdev_attach(zpool_handle_t *, const char *, 316 const char *, nvlist_t *, int, boolean_t); 317 _LIBZFS_H int zpool_vdev_detach(zpool_handle_t *, const char *); 318 _LIBZFS_H int zpool_vdev_remove(zpool_handle_t *, const char *); 319 _LIBZFS_H int zpool_vdev_remove_cancel(zpool_handle_t *); 320 _LIBZFS_H int zpool_vdev_indirect_size(zpool_handle_t *, const char *, 321 uint64_t *); 322 _LIBZFS_H int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, 323 nvlist_t *, splitflags_t); 324 _LIBZFS_H int zpool_vdev_remove_wanted(zpool_handle_t *, const char *); 325 326 _LIBZFS_H int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 327 _LIBZFS_H int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 328 _LIBZFS_H int zpool_vdev_set_removed_state(zpool_handle_t *, uint64_t, 329 vdev_aux_t); 330 331 _LIBZFS_H int zpool_vdev_clear(zpool_handle_t *, uint64_t); 332 333 _LIBZFS_H nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 334 boolean_t *, boolean_t *); 335 _LIBZFS_H nvlist_t *zpool_find_parent_vdev(zpool_handle_t *, const char *, 336 boolean_t *, boolean_t *, boolean_t *); 337 _LIBZFS_H nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 338 boolean_t *, boolean_t *, boolean_t *); 339 _LIBZFS_H int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, 340 const char *); 341 _LIBZFS_H int zpool_prepare_disk(zpool_handle_t *zhp, nvlist_t *vdev_nv, 342 const char *prepare_str, char **lines[], int *lines_cnt); 343 _LIBZFS_H int zpool_prepare_and_label_disk(libzfs_handle_t *hdl, 344 zpool_handle_t *, const char *, nvlist_t *vdev_nv, const char *prepare_str, 345 char **lines[], int *lines_cnt); 346 _LIBZFS_H char ** zpool_vdev_script_alloc_env(const char *pool_name, 347 const char *vdev_path, const char *vdev_upath, 348 const char *vdev_enc_sysfs_path, const char *opt_key, const char *opt_val); 349 _LIBZFS_H void zpool_vdev_script_free_env(char **env); 350 _LIBZFS_H uint64_t zpool_vdev_path_to_guid(zpool_handle_t *zhp, 351 const char *path); 352 353 _LIBZFS_H const char *zpool_get_state_str(zpool_handle_t *); 354 355 /* 356 * Functions to manage pool properties 357 */ 358 _LIBZFS_H int zpool_set_prop(zpool_handle_t *, const char *, const char *); 359 _LIBZFS_H int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 360 size_t proplen, zprop_source_t *, boolean_t literal); 361 _LIBZFS_H int zpool_get_userprop(zpool_handle_t *, const char *, char *, 362 size_t proplen, zprop_source_t *); 363 _LIBZFS_H uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 364 zprop_source_t *); 365 _LIBZFS_H int zpool_props_refresh(zpool_handle_t *); 366 367 _LIBZFS_H const char *zpool_prop_to_name(zpool_prop_t); 368 _LIBZFS_H const char *zpool_prop_values(zpool_prop_t); 369 370 /* 371 * Functions to manage vdev properties 372 */ 373 _LIBZFS_H int zpool_get_vdev_prop_value(nvlist_t *, vdev_prop_t, char *, char *, 374 size_t, zprop_source_t *, boolean_t); 375 _LIBZFS_H int zpool_get_vdev_prop(zpool_handle_t *, const char *, vdev_prop_t, 376 char *, char *, size_t, zprop_source_t *, boolean_t); 377 _LIBZFS_H int zpool_get_all_vdev_props(zpool_handle_t *, const char *, 378 nvlist_t **); 379 _LIBZFS_H int zpool_set_vdev_prop(zpool_handle_t *, const char *, const char *, 380 const char *); 381 382 _LIBZFS_H const char *vdev_prop_to_name(vdev_prop_t); 383 _LIBZFS_H const char *vdev_prop_values(vdev_prop_t); 384 _LIBZFS_H boolean_t vdev_prop_user(const char *name); 385 _LIBZFS_H const char *vdev_prop_column_name(vdev_prop_t); 386 _LIBZFS_H boolean_t vdev_prop_align_right(vdev_prop_t); 387 388 /* 389 * Pool health statistics. 390 */ 391 typedef enum { 392 /* 393 * The following correspond to faults as defined in the (fault.fs.zfs.*) 394 * event namespace. Each is associated with a corresponding message ID. 395 * This must be kept in sync with the zfs_msgid_table in 396 * lib/libzfs/libzfs_status.c. 397 */ 398 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 399 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 400 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 401 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 402 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 403 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 404 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 405 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 406 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 407 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 408 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 409 ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ 410 ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ 411 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 412 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 413 ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ 414 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 415 ZPOOL_STATUS_ERRATA, /* informational errata available */ 416 417 /* 418 * If the pool has unsupported features but can still be opened in 419 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 420 * pool has unsupported features but cannot be opened at all, its 421 * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 422 */ 423 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 424 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 425 426 /* 427 * These faults have no corresponding message ID. At the time we are 428 * checking the status, the original reason for the FMA fault (I/O or 429 * checksum errors) has been lost. 430 */ 431 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 432 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 433 434 /* 435 * The following are not faults per se, but still an error possibly 436 * requiring administrative attention. There is no corresponding 437 * message ID. 438 */ 439 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 440 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 441 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 442 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 443 ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 444 ZPOOL_STATUS_REBUILDING, /* device being rebuilt */ 445 ZPOOL_STATUS_REBUILD_SCRUB, /* recommend scrubbing the pool */ 446 ZPOOL_STATUS_NON_NATIVE_ASHIFT, /* (e.g. 512e dev with ashift of 9) */ 447 ZPOOL_STATUS_COMPATIBILITY_ERR, /* bad 'compatibility' property */ 448 ZPOOL_STATUS_INCOMPATIBLE_FEAT, /* feature set outside compatibility */ 449 450 /* 451 * Finally, the following indicates a healthy pool. 452 */ 453 ZPOOL_STATUS_OK 454 } zpool_status_t; 455 456 _LIBZFS_H zpool_status_t zpool_get_status(zpool_handle_t *, const char **, 457 zpool_errata_t *); 458 _LIBZFS_H zpool_status_t zpool_import_status(nvlist_t *, const char **, 459 zpool_errata_t *); 460 461 /* 462 * Statistics and configuration functions. 463 */ 464 _LIBZFS_H nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 465 _LIBZFS_H nvlist_t *zpool_get_features(zpool_handle_t *); 466 _LIBZFS_H int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 467 _LIBZFS_H int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 468 _LIBZFS_H void zpool_add_propname(zpool_handle_t *, const char *); 469 470 /* 471 * Import and export functions 472 */ 473 _LIBZFS_H int zpool_export(zpool_handle_t *, boolean_t, const char *); 474 _LIBZFS_H int zpool_export_force(zpool_handle_t *, const char *); 475 _LIBZFS_H int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 476 char *altroot); 477 _LIBZFS_H int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 478 nvlist_t *, int); 479 _LIBZFS_H void zpool_collect_unsup_feat(nvlist_t *config, char *buf, 480 size_t size); 481 482 /* 483 * Miscellaneous pool functions 484 */ 485 struct zfs_cmd; 486 487 _LIBZFS_H const char *const zfs_history_event_names[]; 488 489 typedef enum { 490 VDEV_NAME_PATH = 1 << 0, 491 VDEV_NAME_GUID = 1 << 1, 492 VDEV_NAME_FOLLOW_LINKS = 1 << 2, 493 VDEV_NAME_TYPE_ID = 1 << 3, 494 } vdev_name_t; 495 496 _LIBZFS_H char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 497 int name_flags); 498 _LIBZFS_H int zpool_upgrade(zpool_handle_t *, uint64_t); 499 _LIBZFS_H int zpool_get_history(zpool_handle_t *, nvlist_t **, uint64_t *, 500 boolean_t *); 501 _LIBZFS_H int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, 502 int); 503 _LIBZFS_H int zpool_events_clear(libzfs_handle_t *, int *); 504 _LIBZFS_H int zpool_events_seek(libzfs_handle_t *, uint64_t, int); 505 _LIBZFS_H void zpool_obj_to_path_ds(zpool_handle_t *, uint64_t, uint64_t, 506 char *, size_t); 507 _LIBZFS_H void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 508 size_t); 509 _LIBZFS_H int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 510 _LIBZFS_H void zpool_explain_recover(libzfs_handle_t *, const char *, int, 511 nvlist_t *, char *, size_t); 512 _LIBZFS_H int zpool_checkpoint(zpool_handle_t *); 513 _LIBZFS_H int zpool_discard_checkpoint(zpool_handle_t *); 514 _LIBZFS_H boolean_t zpool_is_draid_spare(const char *); 515 516 _LIBZFS_H int zpool_prefetch(zpool_handle_t *, zpool_prefetch_type_t); 517 518 /* 519 * Basic handle manipulations. These functions do not create or destroy the 520 * underlying datasets, only the references to them. 521 */ 522 _LIBZFS_H zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 523 _LIBZFS_H zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 524 _LIBZFS_H void zfs_close(zfs_handle_t *); 525 _LIBZFS_H zfs_type_t zfs_get_type(const zfs_handle_t *); 526 _LIBZFS_H zfs_type_t zfs_get_underlying_type(const zfs_handle_t *); 527 _LIBZFS_H const char *zfs_get_name(const zfs_handle_t *); 528 _LIBZFS_H zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 529 _LIBZFS_H const char *zfs_get_pool_name(const zfs_handle_t *); 530 531 /* 532 * Property management functions. Some functions are shared with the kernel, 533 * and are found in sys/fs/zfs.h. 534 */ 535 536 /* 537 * zfs dataset property management 538 */ 539 _LIBZFS_H const char *zfs_prop_default_string(zfs_prop_t); 540 _LIBZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t); 541 _LIBZFS_H const char *zfs_prop_column_name(zfs_prop_t); 542 _LIBZFS_H boolean_t zfs_prop_align_right(zfs_prop_t); 543 544 _LIBZFS_H nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 545 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, 546 const char *); 547 548 _LIBZFS_H const char *zfs_prop_to_name(zfs_prop_t); 549 _LIBZFS_H int zfs_prop_set(zfs_handle_t *, const char *, const char *); 550 _LIBZFS_H int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 551 _LIBZFS_H int zfs_prop_set_list_flags(zfs_handle_t *, nvlist_t *, int); 552 _LIBZFS_H int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 553 zprop_source_t *, char *, size_t, boolean_t); 554 _LIBZFS_H int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 555 boolean_t); 556 _LIBZFS_H int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 557 zprop_source_t *, char *, size_t); 558 _LIBZFS_H int zfs_prop_get_userquota_int(zfs_handle_t *zhp, 559 const char *propname, uint64_t *propvalue); 560 _LIBZFS_H int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 561 char *propbuf, int proplen, boolean_t literal); 562 _LIBZFS_H int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 563 uint64_t *propvalue); 564 _LIBZFS_H int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 565 char *propbuf, int proplen, boolean_t literal); 566 _LIBZFS_H int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 567 char *buf, size_t len); 568 _LIBZFS_H uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, const char **); 569 _LIBZFS_H uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 570 _LIBZFS_H int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 571 _LIBZFS_H const char *zfs_prop_values(zfs_prop_t); 572 _LIBZFS_H int zfs_prop_is_string(zfs_prop_t prop); 573 _LIBZFS_H nvlist_t *zfs_get_all_props(zfs_handle_t *); 574 _LIBZFS_H nvlist_t *zfs_get_user_props(zfs_handle_t *); 575 _LIBZFS_H nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 576 _LIBZFS_H nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 577 578 _LIBZFS_H int zfs_wait_status(zfs_handle_t *, zfs_wait_activity_t, 579 boolean_t *, boolean_t *); 580 581 /* 582 * zfs encryption management 583 */ 584 _LIBZFS_H int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, 585 char *); 586 _LIBZFS_H int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, 587 nvlist_t *, boolean_t stdin_available, uint8_t **, uint_t *); 588 _LIBZFS_H int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, 589 nvlist_t *); 590 _LIBZFS_H int zfs_crypto_attempt_load_keys(libzfs_handle_t *, const char *); 591 _LIBZFS_H int zfs_crypto_load_key(zfs_handle_t *, boolean_t, const char *); 592 _LIBZFS_H int zfs_crypto_unload_key(zfs_handle_t *); 593 _LIBZFS_H int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); 594 595 typedef struct zprop_list { 596 int pl_prop; 597 char *pl_user_prop; 598 struct zprop_list *pl_next; 599 boolean_t pl_all; 600 size_t pl_width; 601 size_t pl_recvd_width; 602 boolean_t pl_fixed; 603 } zprop_list_t; 604 605 _LIBZFS_H int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 606 boolean_t); 607 _LIBZFS_H void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 608 _LIBZFS_H int vdev_expand_proplist(zpool_handle_t *, const char *, 609 zprop_list_t **); 610 611 #define ZFS_MOUNTPOINT_NONE "none" 612 #define ZFS_MOUNTPOINT_LEGACY "legacy" 613 614 #define ZFS_FEATURE_DISABLED "disabled" 615 #define ZFS_FEATURE_ENABLED "enabled" 616 #define ZFS_FEATURE_ACTIVE "active" 617 618 #define ZFS_UNSUPPORTED_INACTIVE "inactive" 619 #define ZFS_UNSUPPORTED_READONLY "readonly" 620 621 /* 622 * zpool property management 623 */ 624 _LIBZFS_H int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **, 625 zfs_type_t, boolean_t); 626 _LIBZFS_H int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 627 size_t); 628 _LIBZFS_H const char *zpool_prop_default_string(zpool_prop_t); 629 _LIBZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t); 630 _LIBZFS_H const char *zpool_prop_column_name(zpool_prop_t); 631 _LIBZFS_H boolean_t zpool_prop_align_right(zpool_prop_t); 632 633 /* 634 * Functions shared by zfs and zpool property management. 635 */ 636 _LIBZFS_H int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 637 boolean_t ordered, zfs_type_t type); 638 _LIBZFS_H int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 639 zfs_type_t); 640 _LIBZFS_H void zprop_free_list(zprop_list_t *); 641 642 _LIBZFS_H void zcmd_print_json(nvlist_t *); 643 644 #define ZFS_GET_NCOLS 5 645 646 typedef enum { 647 GET_COL_NONE, 648 GET_COL_NAME, 649 GET_COL_PROPERTY, 650 GET_COL_VALUE, 651 GET_COL_RECVD, 652 GET_COL_SOURCE 653 } zfs_get_column_t; 654 655 /* 656 * Functions for printing zfs or zpool properties 657 */ 658 typedef struct vdev_cbdata { 659 int cb_name_flags; 660 char **cb_names; 661 unsigned int cb_names_count; 662 } vdev_cbdata_t; 663 664 typedef struct zprop_get_cbdata { 665 int cb_sources; 666 zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 667 int cb_colwidths[ZFS_GET_NCOLS + 1]; 668 boolean_t cb_scripted; 669 boolean_t cb_literal; 670 boolean_t cb_first; 671 boolean_t cb_json; 672 zprop_list_t *cb_proplist; 673 zfs_type_t cb_type; 674 vdev_cbdata_t cb_vdevs; 675 nvlist_t *cb_jsobj; 676 boolean_t cb_json_as_int; 677 boolean_t cb_json_pool_key_guid; 678 } zprop_get_cbdata_t; 679 680 #define ZFS_SET_NOMOUNT 1 681 682 typedef struct zprop_set_cbdata { 683 int cb_flags; 684 nvlist_t *cb_proplist; 685 } zprop_set_cbdata_t; 686 687 _LIBZFS_H void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 688 const char *, const char *, zprop_source_t, const char *, 689 const char *); 690 691 _LIBZFS_H int zprop_nvlist_one_property(const char *, const char *, 692 zprop_source_t, const char *, const char *, nvlist_t *, boolean_t); 693 694 _LIBZFS_H int zprop_collect_property(const char *, zprop_get_cbdata_t *, 695 const char *, const char *, zprop_source_t, const char *, 696 const char *, nvlist_t *); 697 698 /* 699 * Iterator functions. 700 */ 701 #define ZFS_ITER_RECURSE (1 << 0) 702 #define ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1) 703 #define ZFS_ITER_PROP_LISTSNAPS (1 << 2) 704 #define ZFS_ITER_DEPTH_LIMIT (1 << 3) 705 #define ZFS_ITER_RECVD_PROPS (1 << 4) 706 #define ZFS_ITER_LITERAL_PROPS (1 << 5) 707 #define ZFS_ITER_SIMPLE (1 << 6) 708 709 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 710 _LIBZFS_H int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 711 _LIBZFS_H int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 712 _LIBZFS_H int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, 713 void *); 714 _LIBZFS_H int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 715 _LIBZFS_H int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *, 716 uint64_t, uint64_t); 717 _LIBZFS_H int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *, 718 uint64_t, uint64_t); 719 _LIBZFS_H int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, 720 void *); 721 _LIBZFS_H int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 722 723 _LIBZFS_H int zfs_iter_children_v2(zfs_handle_t *, int, zfs_iter_f, void *); 724 _LIBZFS_H int zfs_iter_dependents_v2(zfs_handle_t *, int, boolean_t, zfs_iter_f, 725 void *); 726 _LIBZFS_H int zfs_iter_filesystems_v2(zfs_handle_t *, int, zfs_iter_f, void *); 727 _LIBZFS_H int zfs_iter_snapshots_v2(zfs_handle_t *, int, zfs_iter_f, void *, 728 uint64_t, uint64_t); 729 _LIBZFS_H int zfs_iter_snapshots_sorted_v2(zfs_handle_t *, int, zfs_iter_f, 730 void *, uint64_t, uint64_t); 731 _LIBZFS_H int zfs_iter_snapspec_v2(zfs_handle_t *, int, const char *, 732 zfs_iter_f, void *); 733 _LIBZFS_H int zfs_iter_bookmarks_v2(zfs_handle_t *, int, zfs_iter_f, void *); 734 _LIBZFS_H int zfs_iter_mounted(zfs_handle_t *, zfs_iter_f, void *); 735 736 typedef struct get_all_cb { 737 zfs_handle_t **cb_handles; 738 size_t cb_alloc; 739 size_t cb_used; 740 } get_all_cb_t; 741 742 _LIBZFS_H void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, 743 size_t, zfs_iter_f, void *, uint_t); 744 _LIBZFS_H void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 745 746 /* 747 * Functions to create and destroy datasets. 748 */ 749 _LIBZFS_H int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 750 nvlist_t *); 751 _LIBZFS_H int zfs_create_ancestors(libzfs_handle_t *, const char *); 752 _LIBZFS_H int zfs_destroy(zfs_handle_t *, boolean_t); 753 _LIBZFS_H int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 754 _LIBZFS_H int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 755 _LIBZFS_H int zfs_destroy_snaps_nvl_os(libzfs_handle_t *, nvlist_t *); 756 _LIBZFS_H int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 757 _LIBZFS_H int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, 758 nvlist_t *); 759 _LIBZFS_H int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 760 nvlist_t *props); 761 _LIBZFS_H int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 762 763 typedef struct renameflags { 764 /* recursive rename */ 765 unsigned int recursive : 1; 766 767 /* don't unmount file systems */ 768 unsigned int nounmount : 1; 769 770 /* force unmount file systems */ 771 unsigned int forceunmount : 1; 772 } renameflags_t; 773 774 _LIBZFS_H int zfs_rename(zfs_handle_t *, const char *, renameflags_t); 775 776 typedef struct sendflags { 777 /* Amount of extra information to print. */ 778 int verbosity; 779 780 /* recursive send (ie, -R) */ 781 boolean_t replicate; 782 783 /* for recursive send, skip sending missing snapshots */ 784 boolean_t skipmissing; 785 786 /* for incrementals, do all intermediate snapshots */ 787 boolean_t doall; 788 789 /* if dataset is a clone, do incremental from its origin */ 790 boolean_t fromorigin; 791 792 /* field no longer used, maintained for backwards compatibility */ 793 boolean_t pad; 794 795 /* send properties (ie, -p) */ 796 boolean_t props; 797 798 /* do not send (no-op, ie. -n) */ 799 boolean_t dryrun; 800 801 /* parsable verbose output (ie. -P) */ 802 boolean_t parsable; 803 804 /* show progress (ie. -v) */ 805 boolean_t progress; 806 807 /* show progress as process title (ie. -V) */ 808 boolean_t progressastitle; 809 810 /* large blocks (>128K) are permitted */ 811 boolean_t largeblock; 812 813 /* WRITE_EMBEDDED records of type DATA are permitted */ 814 boolean_t embed_data; 815 816 /* compressed WRITE records are permitted */ 817 boolean_t compress; 818 819 /* raw encrypted records are permitted */ 820 boolean_t raw; 821 822 /* only send received properties (ie. -b) */ 823 boolean_t backup; 824 825 /* include snapshot holds in send stream */ 826 boolean_t holds; 827 828 /* stream represents a partially received dataset */ 829 boolean_t saved; 830 } sendflags_t; 831 832 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 833 834 _LIBZFS_H int zfs_send(zfs_handle_t *, const char *, const char *, 835 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 836 _LIBZFS_H int zfs_send_one(zfs_handle_t *, const char *, int, sendflags_t *, 837 const char *); 838 _LIBZFS_H int zfs_send_progress(zfs_handle_t *, int, uint64_t *, uint64_t *); 839 _LIBZFS_H int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 840 const char *); 841 _LIBZFS_H int zfs_send_saved(zfs_handle_t *, sendflags_t *, int, const char *); 842 _LIBZFS_H nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 843 const char *token); 844 845 _LIBZFS_H int zfs_promote(zfs_handle_t *); 846 _LIBZFS_H int zfs_hold(zfs_handle_t *, const char *, const char *, 847 boolean_t, int); 848 _LIBZFS_H int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 849 _LIBZFS_H int zfs_release(zfs_handle_t *, const char *, const char *, 850 boolean_t); 851 _LIBZFS_H int zfs_get_holds(zfs_handle_t *, nvlist_t **); 852 _LIBZFS_H uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, 853 nvlist_t *); 854 855 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 856 uid_t rid, uint64_t space); 857 858 _LIBZFS_H int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 859 zfs_userspace_cb_t, void *); 860 861 _LIBZFS_H int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 862 _LIBZFS_H int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 863 864 typedef struct recvflags { 865 /* print informational messages (ie, -v was specified) */ 866 boolean_t verbose; 867 868 /* the destination is a prefix, not the exact fs (ie, -d) */ 869 boolean_t isprefix; 870 871 /* 872 * Only the tail of the sent snapshot path is appended to the 873 * destination to determine the received snapshot name (ie, -e). 874 */ 875 boolean_t istail; 876 877 /* do not actually do the recv, just check if it would work (ie, -n) */ 878 boolean_t dryrun; 879 880 /* rollback/destroy filesystems as necessary (eg, -F) */ 881 boolean_t force; 882 883 /* set "canmount=off" on all modified filesystems */ 884 boolean_t canmountoff; 885 886 /* 887 * Mark the file systems as "resumable" and do not destroy them if the 888 * receive is interrupted 889 */ 890 boolean_t resumable; 891 892 /* byteswap flag is used internally; callers need not specify */ 893 boolean_t byteswap; 894 895 /* do not mount file systems as they are extracted (private) */ 896 boolean_t nomount; 897 898 /* Was holds flag set in the compound header? */ 899 boolean_t holds; 900 901 /* skip receive of snapshot holds */ 902 boolean_t skipholds; 903 904 /* mount the filesystem unless nomount is specified */ 905 boolean_t domount; 906 907 /* force unmount while recv snapshot (private) */ 908 boolean_t forceunmount; 909 910 /* use this recv to check (and heal if needed) an existing snapshot */ 911 boolean_t heal; 912 } recvflags_t; 913 914 _LIBZFS_H int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 915 recvflags_t *, int, avl_tree_t *); 916 917 typedef enum diff_flags { 918 ZFS_DIFF_PARSEABLE = 1 << 0, 919 ZFS_DIFF_TIMESTAMP = 1 << 1, 920 ZFS_DIFF_CLASSIFY = 1 << 2, 921 ZFS_DIFF_NO_MANGLE = 1 << 3 922 } diff_flags_t; 923 924 _LIBZFS_H int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 925 int); 926 927 /* 928 * Miscellaneous functions. 929 */ 930 _LIBZFS_H const char *zfs_type_to_name(zfs_type_t); 931 _LIBZFS_H void zfs_refresh_properties(zfs_handle_t *); 932 _LIBZFS_H int zfs_name_valid(const char *, zfs_type_t); 933 _LIBZFS_H zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, const char *, 934 zfs_type_t); 935 _LIBZFS_H int zfs_parent_name(zfs_handle_t *, char *, size_t); 936 _LIBZFS_H boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 937 zfs_type_t); 938 _LIBZFS_H int zfs_spa_version(zfs_handle_t *, int *); 939 _LIBZFS_H boolean_t zfs_bookmark_exists(const char *path); 940 941 /* 942 * Mount support functions. 943 */ 944 _LIBZFS_H boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 945 _LIBZFS_H boolean_t zfs_is_mounted(zfs_handle_t *, char **); 946 _LIBZFS_H int zfs_mount(zfs_handle_t *, const char *, int); 947 _LIBZFS_H int zfs_mount_at(zfs_handle_t *, const char *, int, const char *); 948 _LIBZFS_H int zfs_unmount(zfs_handle_t *, const char *, int); 949 _LIBZFS_H int zfs_unmountall(zfs_handle_t *, int); 950 _LIBZFS_H int zfs_mount_delegation_check(void); 951 952 #if defined(__linux__) || defined(__APPLE__) 953 _LIBZFS_H int zfs_parse_mount_options(const char *mntopts, 954 unsigned long *mntflags, unsigned long *zfsflags, int sloppy, char *badopt, 955 char *mtabopt); 956 _LIBZFS_H void zfs_adjust_mount_options(zfs_handle_t *zhp, const char *mntpoint, 957 char *mntopts, char *mtabopt); 958 #endif 959 960 /* 961 * Share support functions. 962 * 963 * enum sa_protocol * lists are terminated with SA_NO_PROTOCOL, 964 * NULL means "all/any known to this libzfs". 965 */ 966 #define SA_NO_PROTOCOL -1 967 968 _LIBZFS_H boolean_t zfs_is_shared(zfs_handle_t *zhp, char **where, 969 const enum sa_protocol *proto); 970 _LIBZFS_H int zfs_share(zfs_handle_t *zhp, const enum sa_protocol *proto); 971 _LIBZFS_H int zfs_unshare(zfs_handle_t *zhp, const char *mountpoint, 972 const enum sa_protocol *proto); 973 _LIBZFS_H int zfs_unshareall(zfs_handle_t *zhp, 974 const enum sa_protocol *proto); 975 _LIBZFS_H void zfs_commit_shares(const enum sa_protocol *proto); 976 _LIBZFS_H void zfs_truncate_shares(const enum sa_protocol *proto); 977 978 _LIBZFS_H int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 979 980 /* 981 * Utility functions to run an external process. 982 */ 983 #define STDOUT_VERBOSE 0x01 984 #define STDERR_VERBOSE 0x02 985 #define NO_DEFAULT_PATH 0x04 /* Don't use $PATH to lookup the command */ 986 987 _LIBZFS_H int libzfs_run_process(const char *, char **, int); 988 _LIBZFS_H int libzfs_run_process_get_stdout(const char *, char *[], char *[], 989 char **[], int *); 990 _LIBZFS_H int libzfs_run_process_get_stdout_nopath(const char *, char *[], 991 char *[], char **[], int *); 992 993 _LIBZFS_H void libzfs_free_str_array(char **, int); 994 995 _LIBZFS_H boolean_t libzfs_envvar_is_set(const char *); 996 997 /* 998 * Utility functions for zfs version 999 */ 1000 _LIBZFS_H const char *zfs_version_userland(void); 1001 _LIBZFS_H char *zfs_version_kernel(void); 1002 _LIBZFS_H int zfs_version_print(void); 1003 _LIBZFS_H nvlist_t *zfs_version_nvlist(void); 1004 1005 /* 1006 * Given a device or file, determine if it is part of a pool. 1007 */ 1008 _LIBZFS_H int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 1009 boolean_t *); 1010 1011 /* 1012 * Label manipulation. 1013 */ 1014 _LIBZFS_H int zpool_clear_label(int); 1015 _LIBZFS_H int zpool_set_bootenv(zpool_handle_t *, const nvlist_t *); 1016 _LIBZFS_H int zpool_get_bootenv(zpool_handle_t *, nvlist_t **); 1017 1018 /* 1019 * Management interfaces for SMB ACL files 1020 */ 1021 1022 _LIBZFS_H int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 1023 _LIBZFS_H int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 1024 _LIBZFS_H int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 1025 _LIBZFS_H int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, 1026 char *); 1027 1028 /* 1029 * Enable and disable datasets within a pool by mounting/unmounting and 1030 * sharing/unsharing them. 1031 */ 1032 _LIBZFS_H int zpool_enable_datasets(zpool_handle_t *, const char *, int, 1033 uint_t); 1034 _LIBZFS_H int zpool_disable_datasets(zpool_handle_t *, boolean_t); 1035 _LIBZFS_H void zpool_disable_datasets_os(zpool_handle_t *, boolean_t); 1036 _LIBZFS_H void zpool_disable_volume_os(const char *); 1037 1038 /* 1039 * Parse a features file for -o compatibility 1040 */ 1041 typedef enum { 1042 ZPOOL_COMPATIBILITY_OK, 1043 ZPOOL_COMPATIBILITY_WARNTOKEN, 1044 ZPOOL_COMPATIBILITY_BADTOKEN, 1045 ZPOOL_COMPATIBILITY_BADFILE, 1046 ZPOOL_COMPATIBILITY_NOFILES 1047 } zpool_compat_status_t; 1048 1049 _LIBZFS_H zpool_compat_status_t zpool_load_compat(const char *, 1050 boolean_t *, char *, size_t); 1051 1052 #ifdef __FreeBSD__ 1053 1054 /* 1055 * Attach/detach the given filesystem to/from the given jail. 1056 */ 1057 _LIBZFS_H int zfs_jail(zfs_handle_t *zhp, int jailid, int attach); 1058 1059 /* 1060 * Set loader options for next boot. 1061 */ 1062 _LIBZFS_H int zpool_nextboot(libzfs_handle_t *, uint64_t, uint64_t, 1063 const char *); 1064 1065 #endif /* __FreeBSD__ */ 1066 1067 #ifdef __linux__ 1068 1069 /* 1070 * Add or delete the given filesystem to/from the given user namespace. 1071 */ 1072 _LIBZFS_H int zfs_userns(zfs_handle_t *zhp, const char *nspath, int attach); 1073 1074 #endif 1075 1076 #ifdef __cplusplus 1077 } 1078 #endif 1079 1080 #endif /* _LIBZFS_H */ 1081