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