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