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