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