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