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 * Copyright (c) 2014 Integros [integros.com] 29 */ 30 31 #ifndef _LIBZFS_H 32 #define _LIBZFS_H 33 34 #include <assert.h> 35 #include <libnvpair.h> 36 #include <sys/mnttab.h> 37 #include <sys/param.h> 38 #include <sys/types.h> 39 #include <sys/varargs.h> 40 #include <sys/fs/zfs.h> 41 #include <sys/avl.h> 42 #include <ucred.h> 43 #include <libzfs_core.h> 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 /* 50 * Miscellaneous ZFS constants 51 */ 52 #define ZFS_MAXNAMELEN MAXNAMELEN 53 #define ZPOOL_MAXNAMELEN MAXNAMELEN 54 #define ZFS_MAXPROPLEN MAXPATHLEN 55 #define ZPOOL_MAXPROPLEN MAXPATHLEN 56 57 /* 58 * libzfs errors 59 */ 60 typedef enum zfs_error { 61 EZFS_SUCCESS = 0, /* no error -- success */ 62 EZFS_NOMEM = 2000, /* out of memory */ 63 EZFS_BADPROP, /* invalid property value */ 64 EZFS_PROPREADONLY, /* cannot set readonly property */ 65 EZFS_PROPTYPE, /* property does not apply to dataset type */ 66 EZFS_PROPNONINHERIT, /* property is not inheritable */ 67 EZFS_PROPSPACE, /* bad quota or reservation */ 68 EZFS_BADTYPE, /* dataset is not of appropriate type */ 69 EZFS_BUSY, /* pool or dataset is busy */ 70 EZFS_EXISTS, /* pool or dataset already exists */ 71 EZFS_NOENT, /* no such pool or dataset */ 72 EZFS_BADSTREAM, /* bad backup stream */ 73 EZFS_DSREADONLY, /* dataset is readonly */ 74 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 75 EZFS_INVALIDNAME, /* invalid dataset name */ 76 EZFS_BADRESTORE, /* unable to restore to destination */ 77 EZFS_BADBACKUP, /* backup failed */ 78 EZFS_BADTARGET, /* bad attach/detach/replace target */ 79 EZFS_NODEVICE, /* no such device in pool */ 80 EZFS_BADDEV, /* invalid device to add */ 81 EZFS_NOREPLICAS, /* no valid replicas */ 82 EZFS_RESILVERING, /* currently resilvering */ 83 EZFS_BADVERSION, /* unsupported version */ 84 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 85 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 86 EZFS_BADPATH, /* must be an absolute path */ 87 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 88 EZFS_ZONED, /* used improperly in local zone */ 89 EZFS_MOUNTFAILED, /* failed to mount dataset */ 90 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 91 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 92 EZFS_SHARENFSFAILED, /* share(1M) failed */ 93 EZFS_PERM, /* permission denied */ 94 EZFS_NOSPC, /* out of space */ 95 EZFS_FAULT, /* bad address */ 96 EZFS_IO, /* I/O error */ 97 EZFS_INTR, /* signal received */ 98 EZFS_ISSPARE, /* device is a hot spare */ 99 EZFS_INVALCONFIG, /* invalid vdev configuration */ 100 EZFS_RECURSIVE, /* recursive dependency */ 101 EZFS_NOHISTORY, /* no history object */ 102 EZFS_POOLPROPS, /* couldn't retrieve pool props */ 103 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 104 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 105 EZFS_NAMETOOLONG, /* dataset name is too long */ 106 EZFS_OPENFAILED, /* open of device failed */ 107 EZFS_NOCAP, /* couldn't get capacity */ 108 EZFS_LABELFAILED, /* write of label failed */ 109 EZFS_BADWHO, /* invalid permission who */ 110 EZFS_BADPERM, /* invalid permission */ 111 EZFS_BADPERMSET, /* invalid permission set name */ 112 EZFS_NODELEGATION, /* delegated administration is disabled */ 113 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 114 EZFS_SHARESMBFAILED, /* failed to share over smb */ 115 EZFS_BADCACHE, /* bad cache file */ 116 EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 117 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 118 EZFS_NOTSUP, /* ops not supported on this dataset */ 119 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 120 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 121 EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 122 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 123 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 124 EZFS_PIPEFAILED, /* pipe create failed */ 125 EZFS_THREADCREATEFAILED, /* thread create failed */ 126 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 127 EZFS_SCRUBBING, /* currently scrubbing */ 128 EZFS_NO_SCRUB, /* no active scrub */ 129 EZFS_DIFF, /* general failure of zfs diff */ 130 EZFS_DIFFDATA, /* bad zfs diff data */ 131 EZFS_POOLREADONLY, /* pool is in read-only mode */ 132 EZFS_UNKNOWN 133 } zfs_error_t; 134 135 /* 136 * The following data structures are all part 137 * of the zfs_allow_t data structure which is 138 * used for printing 'allow' permissions. 139 * It is a linked list of zfs_allow_t's which 140 * then contain avl tree's for user/group/sets/... 141 * and each one of the entries in those trees have 142 * avl tree's for the permissions they belong to and 143 * whether they are local,descendent or local+descendent 144 * permissions. The AVL trees are used primarily for 145 * sorting purposes, but also so that we can quickly find 146 * a given user and or permission. 147 */ 148 typedef struct zfs_perm_node { 149 avl_node_t z_node; 150 char z_pname[MAXPATHLEN]; 151 } zfs_perm_node_t; 152 153 typedef struct zfs_allow_node { 154 avl_node_t z_node; 155 char z_key[MAXPATHLEN]; /* name, such as joe */ 156 avl_tree_t z_localdescend; /* local+descendent perms */ 157 avl_tree_t z_local; /* local permissions */ 158 avl_tree_t z_descend; /* descendent permissions */ 159 } zfs_allow_node_t; 160 161 typedef struct zfs_allow { 162 struct zfs_allow *z_next; 163 char z_setpoint[MAXPATHLEN]; 164 avl_tree_t z_sets; 165 avl_tree_t z_crperms; 166 avl_tree_t z_user; 167 avl_tree_t z_group; 168 avl_tree_t z_everyone; 169 } zfs_allow_t; 170 171 /* 172 * Basic handle types 173 */ 174 typedef struct zfs_handle zfs_handle_t; 175 typedef struct zpool_handle zpool_handle_t; 176 typedef struct libzfs_handle libzfs_handle_t; 177 178 /* 179 * Library initialization 180 */ 181 extern libzfs_handle_t *libzfs_init(void); 182 extern void libzfs_fini(libzfs_handle_t *); 183 184 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 185 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 186 187 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 188 189 extern void zfs_save_arguments(int argc, char **, char *, int); 190 extern int zpool_log_history(libzfs_handle_t *, const char *); 191 192 extern int libzfs_errno(libzfs_handle_t *); 193 extern const char *libzfs_error_action(libzfs_handle_t *); 194 extern const char *libzfs_error_description(libzfs_handle_t *); 195 extern int zfs_standard_error(libzfs_handle_t *, int, const char *); 196 extern void libzfs_mnttab_init(libzfs_handle_t *); 197 extern void libzfs_mnttab_fini(libzfs_handle_t *); 198 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 199 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 200 struct mnttab *); 201 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 202 const char *, const char *); 203 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 204 205 /* 206 * Basic handle functions 207 */ 208 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 209 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 210 extern void zpool_close(zpool_handle_t *); 211 extern const char *zpool_get_name(zpool_handle_t *); 212 extern int zpool_get_state(zpool_handle_t *); 213 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 214 extern void zpool_free_handles(libzfs_handle_t *); 215 216 /* 217 * Iterate over all active pools in the system. 218 */ 219 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 220 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 221 222 /* 223 * Functions to create and destroy pools 224 */ 225 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 226 nvlist_t *, nvlist_t *); 227 extern int zpool_destroy(zpool_handle_t *, const char *); 228 extern int zpool_add(zpool_handle_t *, nvlist_t *); 229 230 typedef struct splitflags { 231 /* do not split, but return the config that would be split off */ 232 int dryrun : 1; 233 234 /* after splitting, import the pool */ 235 int import : 1; 236 } splitflags_t; 237 238 /* 239 * Functions to manipulate pool and vdev state 240 */ 241 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t); 242 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 243 extern int zpool_reguid(zpool_handle_t *); 244 extern int zpool_reopen(zpool_handle_t *); 245 246 extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 247 vdev_state_t *); 248 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 249 extern int zpool_vdev_attach(zpool_handle_t *, const char *, 250 const char *, nvlist_t *, int); 251 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 252 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 253 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 254 splitflags_t); 255 256 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 257 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 258 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 259 260 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 261 boolean_t *, boolean_t *); 262 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 263 boolean_t *, boolean_t *, boolean_t *); 264 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 265 266 /* 267 * Functions to manage pool properties 268 */ 269 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 270 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 271 size_t proplen, zprop_source_t *, boolean_t); 272 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 273 zprop_source_t *); 274 275 extern const char *zpool_prop_to_name(zpool_prop_t); 276 extern const char *zpool_prop_values(zpool_prop_t); 277 278 /* 279 * Pool health statistics. 280 */ 281 typedef enum { 282 /* 283 * The following correspond to faults as defined in the (fault.fs.zfs.*) 284 * event namespace. Each is associated with a corresponding message ID. 285 */ 286 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 287 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 288 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 289 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 290 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 291 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 292 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 293 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 294 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 295 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 296 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 297 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 298 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 299 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 300 301 /* 302 * If the pool has unsupported features but can still be opened in 303 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 304 * pool has unsupported features but cannot be opened at all, its 305 * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 306 */ 307 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 308 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 309 310 /* 311 * These faults have no corresponding message ID. At the time we are 312 * checking the status, the original reason for the FMA fault (I/O or 313 * checksum errors) has been lost. 314 */ 315 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 316 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 317 318 /* 319 * The following are not faults per se, but still an error possibly 320 * requiring administrative attention. There is no corresponding 321 * message ID. 322 */ 323 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 324 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 325 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 326 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 327 ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 328 329 /* 330 * Finally, the following indicates a healthy pool. 331 */ 332 ZPOOL_STATUS_OK 333 } zpool_status_t; 334 335 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 336 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 337 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 338 339 /* 340 * Statistics and configuration functions. 341 */ 342 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 343 extern nvlist_t *zpool_get_features(zpool_handle_t *); 344 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 345 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 346 347 /* 348 * Import and export functions 349 */ 350 extern int zpool_export(zpool_handle_t *, boolean_t, const char *); 351 extern int zpool_export_force(zpool_handle_t *, const char *); 352 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 353 char *altroot); 354 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 355 nvlist_t *, int); 356 extern void zpool_print_unsup_feat(nvlist_t *config); 357 358 /* 359 * Search for pools to import 360 */ 361 362 typedef struct importargs { 363 char **path; /* a list of paths to search */ 364 int paths; /* number of paths to search */ 365 char *poolname; /* name of a pool to find */ 366 uint64_t guid; /* guid of a pool to find */ 367 char *cachefile; /* cachefile to use for import */ 368 int can_be_active : 1; /* can the pool be active? */ 369 int unique : 1; /* does 'poolname' already exist? */ 370 int exists : 1; /* set on return if pool already exists */ 371 } importargs_t; 372 373 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 374 375 /* legacy pool search routines */ 376 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 377 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 378 char *, uint64_t); 379 380 /* 381 * Miscellaneous pool functions 382 */ 383 struct zfs_cmd; 384 385 extern const char *zfs_history_event_names[]; 386 387 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 388 boolean_t verbose); 389 extern int zpool_upgrade(zpool_handle_t *, uint64_t); 390 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 391 extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 392 nvlist_t ***, uint_t *); 393 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 394 size_t len); 395 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 396 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 397 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 398 nvlist_t *); 399 400 /* 401 * Basic handle manipulations. These functions do not create or destroy the 402 * underlying datasets, only the references to them. 403 */ 404 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 405 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 406 extern void zfs_close(zfs_handle_t *); 407 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 408 extern const char *zfs_get_name(const zfs_handle_t *); 409 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 410 411 /* 412 * Property management functions. Some functions are shared with the kernel, 413 * and are found in sys/fs/zfs.h. 414 */ 415 416 /* 417 * zfs dataset property management 418 */ 419 extern const char *zfs_prop_default_string(zfs_prop_t); 420 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 421 extern const char *zfs_prop_column_name(zfs_prop_t); 422 extern boolean_t zfs_prop_align_right(zfs_prop_t); 423 424 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 425 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *); 426 427 extern const char *zfs_prop_to_name(zfs_prop_t); 428 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 429 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 430 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 431 zprop_source_t *, char *, size_t, boolean_t); 432 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 433 boolean_t); 434 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 435 zprop_source_t *, char *, size_t); 436 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 437 uint64_t *propvalue); 438 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 439 char *propbuf, int proplen, boolean_t literal); 440 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 441 uint64_t *propvalue); 442 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 443 char *propbuf, int proplen, boolean_t literal); 444 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 445 char *buf, size_t len); 446 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 447 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 448 extern const char *zfs_prop_values(zfs_prop_t); 449 extern int zfs_prop_is_string(zfs_prop_t prop); 450 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 451 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 452 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 453 454 455 typedef struct zprop_list { 456 int pl_prop; 457 char *pl_user_prop; 458 struct zprop_list *pl_next; 459 boolean_t pl_all; 460 size_t pl_width; 461 size_t pl_recvd_width; 462 boolean_t pl_fixed; 463 } zprop_list_t; 464 465 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 466 boolean_t); 467 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 468 469 #define ZFS_MOUNTPOINT_NONE "none" 470 #define ZFS_MOUNTPOINT_LEGACY "legacy" 471 472 #define ZFS_FEATURE_DISABLED "disabled" 473 #define ZFS_FEATURE_ENABLED "enabled" 474 #define ZFS_FEATURE_ACTIVE "active" 475 476 #define ZFS_UNSUPPORTED_INACTIVE "inactive" 477 #define ZFS_UNSUPPORTED_READONLY "readonly" 478 479 /* 480 * zpool property management 481 */ 482 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 483 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 484 size_t); 485 extern const char *zpool_prop_default_string(zpool_prop_t); 486 extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 487 extern const char *zpool_prop_column_name(zpool_prop_t); 488 extern boolean_t zpool_prop_align_right(zpool_prop_t); 489 490 /* 491 * Functions shared by zfs and zpool property management. 492 */ 493 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 494 boolean_t ordered, zfs_type_t type); 495 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 496 zfs_type_t); 497 extern void zprop_free_list(zprop_list_t *); 498 499 #define ZFS_GET_NCOLS 5 500 501 typedef enum { 502 GET_COL_NONE, 503 GET_COL_NAME, 504 GET_COL_PROPERTY, 505 GET_COL_VALUE, 506 GET_COL_RECVD, 507 GET_COL_SOURCE 508 } zfs_get_column_t; 509 510 /* 511 * Functions for printing zfs or zpool properties 512 */ 513 typedef struct zprop_get_cbdata { 514 int cb_sources; 515 zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 516 int cb_colwidths[ZFS_GET_NCOLS + 1]; 517 boolean_t cb_scripted; 518 boolean_t cb_literal; 519 boolean_t cb_first; 520 zprop_list_t *cb_proplist; 521 zfs_type_t cb_type; 522 } zprop_get_cbdata_t; 523 524 void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 525 const char *, const char *, zprop_source_t, const char *, 526 const char *); 527 528 /* 529 * Iterator functions. 530 */ 531 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 532 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 533 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 534 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 535 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 536 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 537 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 538 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); 539 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 540 541 typedef struct get_all_cb { 542 zfs_handle_t **cb_handles; 543 size_t cb_alloc; 544 size_t cb_used; 545 boolean_t cb_verbose; 546 int (*cb_getone)(zfs_handle_t *, void *); 547 } get_all_cb_t; 548 549 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 550 int libzfs_dataset_cmp(const void *, const void *); 551 552 /* 553 * Functions to create and destroy datasets. 554 */ 555 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 556 nvlist_t *); 557 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 558 extern int zfs_destroy(zfs_handle_t *, boolean_t); 559 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 560 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 561 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 562 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 563 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 564 nvlist_t *props); 565 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 566 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); 567 568 typedef struct sendflags { 569 /* print informational messages (ie, -v was specified) */ 570 boolean_t verbose; 571 572 /* recursive send (ie, -R) */ 573 boolean_t replicate; 574 575 /* for incrementals, do all intermediate snapshots */ 576 boolean_t doall; 577 578 /* if dataset is a clone, do incremental from its origin */ 579 boolean_t fromorigin; 580 581 /* do deduplication */ 582 boolean_t dedup; 583 584 /* send properties (ie, -p) */ 585 boolean_t props; 586 587 /* do not send (no-op, ie. -n) */ 588 boolean_t dryrun; 589 590 /* parsable verbose output (ie. -P) */ 591 boolean_t parsable; 592 593 /* show progress (ie. -v) */ 594 boolean_t progress; 595 596 /* large blocks (>128K) are permitted */ 597 boolean_t largeblock; 598 599 /* WRITE_EMBEDDED records of type DATA are permitted */ 600 boolean_t embed_data; 601 } sendflags_t; 602 603 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 604 605 extern int zfs_send(zfs_handle_t *, const char *, const char *, 606 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 607 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); 608 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 609 const char *); 610 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 611 const char *token); 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