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