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