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