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