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