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