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