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