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