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