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