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 Pawel Jakub Dawidek. All rights reserved. 25 * Copyright (c) 2011, 2017 by Delphix. All rights reserved. 26 * Copyright 2019 Joyent, Inc. 27 * Copyright (c) 2013 Steven Hartland. All rights reserved. 28 * Copyright (c) 2014 Integros [integros.com] 29 * Copyright 2016 Nexenta Systems, Inc. 30 * Copyright (c) 2017 Datto Inc. 31 */ 32 33 #ifndef _LIBZFS_H 34 #define _LIBZFS_H 35 36 #include <assert.h> 37 #include <libnvpair.h> 38 #include <sys/mnttab.h> 39 #include <sys/param.h> 40 #include <sys/types.h> 41 #include <sys/varargs.h> 42 #include <sys/fs/zfs.h> 43 #include <sys/avl.h> 44 #include <ucred.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, /* currently resilvering */ 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, /* unshare(1M) failed */ 92 EZFS_SHARENFSFAILED, /* share(1M) failed */ 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_NO_PENDING, /* cannot cancel, no operation is pending */ 135 EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */ 136 EZFS_DISCARDING_CHECKPOINT, /* currently discarding a checkpoint */ 137 EZFS_NO_CHECKPOINT, /* pool has no checkpoint */ 138 EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */ 139 EZFS_VDEV_TOO_BIG, /* a device is too big to be used */ 140 EZFS_TOOMANY, /* argument list too long */ 141 EZFS_INITIALIZING, /* currently initializing */ 142 EZFS_NO_INITIALIZE, /* no active initialize */ 143 EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */ 144 EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ 145 EZFS_CRYPTOFAILED, /* failed to setup encryption */ 146 EZFS_UNKNOWN 147 } zfs_error_t; 148 149 /* 150 * UEFI boot support parameters. When creating whole disk boot pool, 151 * zpool create should allow to create EFI System partition for UEFI boot 152 * program. In case of BIOS, the EFI System partition is not used 153 * even if it does exist. 154 */ 155 typedef enum zpool_boot_label { 156 ZPOOL_NO_BOOT_LABEL = 0, 157 ZPOOL_CREATE_BOOT_LABEL, 158 ZPOOL_COPY_BOOT_LABEL 159 } zpool_boot_label_t; 160 161 /* 162 * The following data structures are all part 163 * of the zfs_allow_t data structure which is 164 * used for printing 'allow' permissions. 165 * It is a linked list of zfs_allow_t's which 166 * then contain avl tree's for user/group/sets/... 167 * and each one of the entries in those trees have 168 * avl tree's for the permissions they belong to and 169 * whether they are local,descendent or local+descendent 170 * permissions. The AVL trees are used primarily for 171 * sorting purposes, but also so that we can quickly find 172 * a given user and or permission. 173 */ 174 typedef struct zfs_perm_node { 175 avl_node_t z_node; 176 char z_pname[MAXPATHLEN]; 177 } zfs_perm_node_t; 178 179 typedef struct zfs_allow_node { 180 avl_node_t z_node; 181 char z_key[MAXPATHLEN]; /* name, such as joe */ 182 avl_tree_t z_localdescend; /* local+descendent perms */ 183 avl_tree_t z_local; /* local permissions */ 184 avl_tree_t z_descend; /* descendent permissions */ 185 } zfs_allow_node_t; 186 187 typedef struct zfs_allow { 188 struct zfs_allow *z_next; 189 char z_setpoint[MAXPATHLEN]; 190 avl_tree_t z_sets; 191 avl_tree_t z_crperms; 192 avl_tree_t z_user; 193 avl_tree_t z_group; 194 avl_tree_t z_everyone; 195 } zfs_allow_t; 196 197 /* 198 * Basic handle types 199 */ 200 typedef struct zfs_handle zfs_handle_t; 201 typedef struct zpool_handle zpool_handle_t; 202 typedef struct libzfs_handle libzfs_handle_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_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 /* 268 * Functions to manipulate pool and vdev state 269 */ 270 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 271 extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, 272 nvlist_t *); 273 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 274 extern int zpool_reguid(zpool_handle_t *); 275 extern int zpool_reopen(zpool_handle_t *); 276 277 extern int zpool_sync_one(zpool_handle_t *, void *); 278 279 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 280 vdev_state_t *); 281 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 282 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 283 const char *, nvlist_t *, int); 284 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 285 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 286 extern int zpool_vdev_remove_cancel(zpool_handle_t *); 287 extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *); 288 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 289 splitflags_t); 290 291 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 292 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 293 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 294 295 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 296 boolean_t *, boolean_t *); 297 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 298 boolean_t *, boolean_t *, boolean_t *); 299 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *, 300 zpool_boot_label_t, uint64_t, int *); 301 302 /* 303 * Functions to manage pool properties 304 */ 305 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 306 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 307 size_t proplen, zprop_source_t *, boolean_t); 308 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 309 zprop_source_t *); 310 311 extern const char *zpool_prop_to_name(zpool_prop_t); 312 extern const char *zpool_prop_values(zpool_prop_t); 313 314 /* 315 * Pool health statistics. 316 */ 317 typedef enum { 318 /* 319 * The following correspond to faults as defined in the (fault.fs.zfs.*) 320 * event namespace. Each is associated with a corresponding message ID. 321 * This must be kept in sync with the zfs_msgid_table in 322 * lib/libzfs/libzfs_status.c. 323 */ 324 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 325 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 326 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 327 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 328 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 329 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 330 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 331 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 332 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 333 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 334 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 335 ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ 336 ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ 337 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 338 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 339 ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ 340 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 341 ZPOOL_STATUS_ERRATA, /* informational errata available */ 342 343 /* 344 * If the pool has unsupported features but can still be opened in 345 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 346 * pool has unsupported features but cannot be opened at all, its 347 * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 348 */ 349 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 350 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 351 352 /* 353 * These faults have no corresponding message ID. At the time we are 354 * checking the status, the original reason for the FMA fault (I/O or 355 * checksum errors) has been lost. 356 */ 357 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 358 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 359 360 /* 361 * The following are not faults per se, but still an error possibly 362 * requiring administrative attention. There is no corresponding 363 * message ID. 364 */ 365 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 366 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 367 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 368 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 369 ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 370 371 /* 372 * Finally, the following indicates a healthy pool. 373 */ 374 ZPOOL_STATUS_OK 375 } zpool_status_t; 376 377 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **, 378 zpool_errata_t *); 379 extern zpool_status_t zpool_import_status(nvlist_t *, char **, 380 zpool_errata_t *); 381 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 382 383 /* 384 * Statistics and configuration functions. 385 */ 386 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 387 extern nvlist_t *zpool_get_features(zpool_handle_t *); 388 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 389 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 390 extern boolean_t zpool_is_bootable(zpool_handle_t *); 391 392 /* 393 * Import and export functions 394 */ 395 extern int zpool_export(zpool_handle_t *, boolean_t, const char *); 396 extern int zpool_export_force(zpool_handle_t *, const char *); 397 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 398 char *altroot); 399 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 400 nvlist_t *, int); 401 extern void zpool_print_unsup_feat(nvlist_t *config); 402 403 /* 404 * Search for pools to import 405 */ 406 407 typedef struct importargs { 408 char **path; /* a list of paths to search */ 409 int paths; /* number of paths to search */ 410 char *poolname; /* name of a pool to find */ 411 uint64_t guid; /* guid of a pool to find */ 412 char *cachefile; /* cachefile to use for import */ 413 int can_be_active : 1; /* can the pool be active? */ 414 int unique : 1; /* does 'poolname' already exist? */ 415 int exists : 1; /* set on return if pool already exists */ 416 nvlist_t *policy; /* load policy (max txg, rewind, etc.) */ 417 } importargs_t; 418 419 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 420 extern int zpool_tryimport(libzfs_handle_t *hdl, char *target, 421 nvlist_t **configp, importargs_t *args); 422 423 /* legacy pool search routines */ 424 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 425 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 426 char *, uint64_t); 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 **); 446 extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 447 nvlist_t ***, uint_t *); 448 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 449 size_t len); 450 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 451 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 452 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 453 nvlist_t *); 454 extern int zpool_checkpoint(zpool_handle_t *); 455 extern int zpool_discard_checkpoint(zpool_handle_t *); 456 457 /* 458 * Basic handle manipulations. These functions do not create or destroy the 459 * underlying datasets, only the references to them. 460 */ 461 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 462 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 463 extern void zfs_close(zfs_handle_t *); 464 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 465 extern const char *zfs_get_name(const zfs_handle_t *); 466 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 467 extern const char *zfs_get_pool_name(const zfs_handle_t *); 468 469 /* 470 * Property management functions. Some functions are shared with the kernel, 471 * and are found in sys/fs/zfs.h. 472 */ 473 474 /* 475 * zfs dataset property management 476 */ 477 extern const char *zfs_prop_default_string(zfs_prop_t); 478 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 479 extern const char *zfs_prop_column_name(zfs_prop_t); 480 extern boolean_t zfs_prop_align_right(zfs_prop_t); 481 482 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *, 483 uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *); 484 485 extern const char *zfs_prop_to_name(zfs_prop_t); 486 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 487 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 488 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 489 zprop_source_t *, char *, size_t, boolean_t); 490 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 491 boolean_t); 492 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 493 zprop_source_t *, char *, size_t); 494 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 495 uint64_t *propvalue); 496 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 497 char *propbuf, int proplen, boolean_t literal); 498 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 499 uint64_t *propvalue); 500 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 501 char *propbuf, int proplen, boolean_t literal); 502 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 503 char *buf, size_t len); 504 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 505 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 506 extern const char *zfs_prop_values(zfs_prop_t); 507 extern int zfs_prop_is_string(zfs_prop_t prop); 508 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 509 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 510 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 511 512 513 /* 514 * zfs encryption management 515 */ 516 extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *); 517 extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *, 518 boolean_t stdin_available, uint8_t **, uint_t *); 519 extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, 520 nvlist_t *); 521 extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *); 522 extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *); 523 extern int zfs_crypto_unload_key(zfs_handle_t *); 524 extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); 525 526 typedef struct zprop_list { 527 int pl_prop; 528 char *pl_user_prop; 529 struct zprop_list *pl_next; 530 boolean_t pl_all; 531 size_t pl_width; 532 size_t pl_recvd_width; 533 boolean_t pl_fixed; 534 } zprop_list_t; 535 536 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 537 boolean_t); 538 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 539 540 #define ZFS_MOUNTPOINT_NONE "none" 541 #define ZFS_MOUNTPOINT_LEGACY "legacy" 542 543 #define ZFS_FEATURE_DISABLED "disabled" 544 #define ZFS_FEATURE_ENABLED "enabled" 545 #define ZFS_FEATURE_ACTIVE "active" 546 547 #define ZFS_UNSUPPORTED_INACTIVE "inactive" 548 #define ZFS_UNSUPPORTED_READONLY "readonly" 549 550 /* 551 * zpool property management 552 */ 553 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 554 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 555 size_t); 556 extern const char *zpool_prop_default_string(zpool_prop_t); 557 extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 558 extern const char *zpool_prop_column_name(zpool_prop_t); 559 extern boolean_t zpool_prop_align_right(zpool_prop_t); 560 561 /* 562 * Functions shared by zfs and zpool property management. 563 */ 564 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 565 boolean_t ordered, zfs_type_t type); 566 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 567 zfs_type_t); 568 extern void zprop_free_list(zprop_list_t *); 569 570 #define ZFS_GET_NCOLS 5 571 572 typedef enum { 573 GET_COL_NONE, 574 GET_COL_NAME, 575 GET_COL_PROPERTY, 576 GET_COL_VALUE, 577 GET_COL_RECVD, 578 GET_COL_SOURCE 579 } zfs_get_column_t; 580 581 /* 582 * Functions for printing zfs or zpool properties 583 */ 584 typedef struct zprop_get_cbdata { 585 int cb_sources; 586 zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 587 int cb_colwidths[ZFS_GET_NCOLS + 1]; 588 boolean_t cb_scripted; 589 boolean_t cb_literal; 590 boolean_t cb_first; 591 zprop_list_t *cb_proplist; 592 zfs_type_t cb_type; 593 } zprop_get_cbdata_t; 594 595 void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 596 const char *, const char *, zprop_source_t, const char *, 597 const char *); 598 599 /* 600 * Iterator functions. 601 */ 602 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 603 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 604 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 605 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 606 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 607 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 608 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 609 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); 610 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 611 612 typedef struct get_all_cb { 613 zfs_handle_t **cb_handles; 614 size_t cb_alloc; 615 size_t cb_used; 616 } get_all_cb_t; 617 618 void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t, 619 zfs_iter_f, void *, boolean_t); 620 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 621 622 /* 623 * Functions to create and destroy datasets. 624 */ 625 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 626 nvlist_t *); 627 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 628 extern int zfs_destroy(zfs_handle_t *, boolean_t); 629 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 630 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 631 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 632 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 633 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 634 nvlist_t *props); 635 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 636 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); 637 638 typedef struct sendflags { 639 /* print informational messages (ie, -v was specified) */ 640 boolean_t verbose; 641 642 /* recursive send (ie, -R) */ 643 boolean_t replicate; 644 645 /* for incrementals, do all intermediate snapshots */ 646 boolean_t doall; 647 648 /* if dataset is a clone, do incremental from its origin */ 649 boolean_t fromorigin; 650 651 /* do deduplication */ 652 boolean_t dedup; 653 654 /* send properties (ie, -p) */ 655 boolean_t props; 656 657 /* do not send (no-op, ie. -n) */ 658 boolean_t dryrun; 659 660 /* parsable verbose output (ie. -P) */ 661 boolean_t parsable; 662 663 /* show progress (ie. -v) */ 664 boolean_t progress; 665 666 /* large blocks (>128K) are permitted */ 667 boolean_t largeblock; 668 669 /* WRITE_EMBEDDED records of type DATA are permitted */ 670 boolean_t embed_data; 671 672 /* compressed WRITE records are permitted */ 673 boolean_t compress; 674 675 /* raw encrypted records are permitted */ 676 boolean_t raw; 677 678 /* only send received properties (ie. -b) */ 679 boolean_t backup; 680 681 /* include snapshot holds in send stream */ 682 boolean_t holds; 683 } sendflags_t; 684 685 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 686 687 extern int zfs_send(zfs_handle_t *, const char *, const char *, 688 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 689 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); 690 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 691 const char *); 692 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 693 const char *token); 694 695 extern int zfs_promote(zfs_handle_t *); 696 extern int zfs_hold(zfs_handle_t *, const char *, const char *, 697 boolean_t, int); 698 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 699 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 700 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); 701 extern uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, 702 nvlist_t *); 703 704 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 705 uid_t rid, uint64_t space); 706 707 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 708 zfs_userspace_cb_t, void *); 709 710 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 711 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 712 713 typedef struct recvflags { 714 /* print informational messages (ie, -v was specified) */ 715 boolean_t verbose; 716 717 /* the destination is a prefix, not the exact fs (ie, -d) */ 718 boolean_t isprefix; 719 720 /* 721 * Only the tail of the sent snapshot path is appended to the 722 * destination to determine the received snapshot name (ie, -e). 723 */ 724 boolean_t istail; 725 726 /* do not actually do the recv, just check if it would work (ie, -n) */ 727 boolean_t dryrun; 728 729 /* rollback/destroy filesystems as necessary (eg, -F) */ 730 boolean_t force; 731 732 /* set "canmount=off" on all modified filesystems */ 733 boolean_t canmountoff; 734 735 /* 736 * Mark the file systems as "resumable" and do not destroy them if the 737 * receive is interrupted 738 */ 739 boolean_t resumable; 740 741 /* byteswap flag is used internally; callers need not specify */ 742 boolean_t byteswap; 743 744 /* do not mount file systems as they are extracted (private) */ 745 boolean_t nomount; 746 747 /* Was holds flag set in the compound header? */ 748 boolean_t holds; 749 750 /* skip receive of snapshot holds */ 751 boolean_t skipholds; 752 } recvflags_t; 753 754 extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 755 recvflags_t *, int, avl_tree_t *); 756 757 typedef enum diff_flags { 758 ZFS_DIFF_PARSEABLE = 0x1, 759 ZFS_DIFF_TIMESTAMP = 0x2, 760 ZFS_DIFF_CLASSIFY = 0x4 761 } diff_flags_t; 762 763 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 764 int); 765 766 /* 767 * Miscellaneous functions. 768 */ 769 extern const char *zfs_type_to_name(zfs_type_t); 770 extern void zfs_refresh_properties(zfs_handle_t *); 771 extern int zfs_name_valid(const char *, zfs_type_t); 772 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 773 extern int zfs_parent_name(zfs_handle_t *, char *, size_t); 774 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 775 zfs_type_t); 776 extern int zfs_spa_version(zfs_handle_t *, int *); 777 extern boolean_t zfs_bookmark_exists(const char *path); 778 extern ulong_t get_system_hostid(void); 779 780 /* 781 * Mount support functions. 782 */ 783 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 784 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 785 extern int zfs_mount(zfs_handle_t *, const char *, int); 786 extern int zfs_unmount(zfs_handle_t *, const char *, int); 787 extern int zfs_unmountall(zfs_handle_t *, int); 788 789 /* 790 * Share support functions. 791 */ 792 extern boolean_t zfs_is_shared(zfs_handle_t *); 793 extern int zfs_share(zfs_handle_t *); 794 extern int zfs_unshare(zfs_handle_t *); 795 796 /* 797 * Protocol-specific share support functions. 798 */ 799 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 800 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 801 extern int zfs_share_nfs(zfs_handle_t *); 802 extern int zfs_share_smb(zfs_handle_t *); 803 extern int zfs_shareall(zfs_handle_t *); 804 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 805 extern int zfs_unshare_smb(zfs_handle_t *, const char *); 806 extern int zfs_unshareall_nfs(zfs_handle_t *); 807 extern int zfs_unshareall_smb(zfs_handle_t *); 808 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 809 extern int zfs_unshareall(zfs_handle_t *); 810 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 811 void *, void *, int, zfs_share_op_t); 812 813 /* 814 * When dealing with nvlists, verify() is extremely useful 815 */ 816 #ifdef NDEBUG 817 #define verify(EX) ((void)(EX)) 818 #else 819 #define verify(EX) assert(EX) 820 #endif 821 822 /* 823 * Utility function to convert a number to a human-readable form. 824 */ 825 extern void zfs_nicenum(uint64_t, char *, size_t); 826 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 827 828 /* 829 * Given a device or file, determine if it is part of a pool. 830 */ 831 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 832 boolean_t *); 833 834 /* 835 * Label manipulation. 836 */ 837 extern int zpool_read_label(int, nvlist_t **); 838 extern int zpool_clear_label(int); 839 840 /* is this zvol valid for use as a dump device? */ 841 extern int zvol_check_dump_config(char *); 842 843 /* 844 * Management interfaces for SMB ACL files 845 */ 846 847 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 848 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 849 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 850 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 851 852 /* 853 * Enable and disable datasets within a pool by mounting/unmounting and 854 * sharing/unsharing them. 855 */ 856 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 857 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 858 859 /* 860 * Mappings between vdev and FRU. 861 */ 862 extern void libzfs_fru_refresh(libzfs_handle_t *); 863 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 864 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 865 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 866 const char *); 867 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 868 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 869 870 extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *); 871 extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *); 872 873 /* Allow consumers to initialize libshare externally for optimal performance */ 874 extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *); 875 /* 876 * For most consumers, zfs_init_libshare_arg is sufficient on its own, and 877 * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called 878 * if the caller has already initialized libshare for one set of zfs handles, 879 * and wishes to share or unshare filesystems outside of that set. In that case, 880 * the caller should uninitialize libshare, and then re-initialize it with the 881 * new handles being shared or unshared. 882 */ 883 extern void zfs_uninit_libshare(libzfs_handle_t *); 884 #ifdef __cplusplus 885 } 886 #endif 887 888 #endif /* _LIBZFS_H */ 889