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