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