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