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) 2012 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 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 /* 48 * Miscellaneous ZFS constants 49 */ 50 #define ZFS_MAXNAMELEN MAXNAMELEN 51 #define ZPOOL_MAXNAMELEN MAXNAMELEN 52 #define ZFS_MAXPROPLEN MAXPATHLEN 53 #define ZPOOL_MAXPROPLEN MAXPATHLEN 54 55 /* 56 * libzfs errors 57 */ 58 typedef enum zfs_error { 59 EZFS_SUCCESS = 0, /* no error -- success */ 60 EZFS_NOMEM = 2000, /* out of memory */ 61 EZFS_BADPROP, /* invalid property value */ 62 EZFS_PROPREADONLY, /* cannot set readonly property */ 63 EZFS_PROPTYPE, /* property does not apply to dataset type */ 64 EZFS_PROPNONINHERIT, /* property is not inheritable */ 65 EZFS_PROPSPACE, /* bad quota or reservation */ 66 EZFS_BADTYPE, /* dataset is not of appropriate type */ 67 EZFS_BUSY, /* pool or dataset is busy */ 68 EZFS_EXISTS, /* pool or dataset already exists */ 69 EZFS_NOENT, /* no such pool or dataset */ 70 EZFS_BADSTREAM, /* bad backup stream */ 71 EZFS_DSREADONLY, /* dataset is readonly */ 72 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 73 EZFS_INVALIDNAME, /* invalid dataset name */ 74 EZFS_BADRESTORE, /* unable to restore to destination */ 75 EZFS_BADBACKUP, /* backup failed */ 76 EZFS_BADTARGET, /* bad attach/detach/replace target */ 77 EZFS_NODEVICE, /* no such device in pool */ 78 EZFS_BADDEV, /* invalid device to add */ 79 EZFS_NOREPLICAS, /* no valid replicas */ 80 EZFS_RESILVERING, /* currently resilvering */ 81 EZFS_BADVERSION, /* unsupported version */ 82 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 83 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 84 EZFS_BADPATH, /* must be an absolute path */ 85 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 86 EZFS_ZONED, /* used improperly in local zone */ 87 EZFS_MOUNTFAILED, /* failed to mount dataset */ 88 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 89 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 90 EZFS_SHARENFSFAILED, /* share(1M) failed */ 91 EZFS_PERM, /* permission denied */ 92 EZFS_NOSPC, /* out of space */ 93 EZFS_FAULT, /* bad address */ 94 EZFS_IO, /* I/O error */ 95 EZFS_INTR, /* signal received */ 96 EZFS_ISSPARE, /* device is a hot spare */ 97 EZFS_INVALCONFIG, /* invalid vdev configuration */ 98 EZFS_RECURSIVE, /* recursive dependency */ 99 EZFS_NOHISTORY, /* no history object */ 100 EZFS_POOLPROPS, /* couldn't retrieve pool props */ 101 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 102 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 103 EZFS_NAMETOOLONG, /* dataset name is too long */ 104 EZFS_OPENFAILED, /* open of device failed */ 105 EZFS_NOCAP, /* couldn't get capacity */ 106 EZFS_LABELFAILED, /* write of label failed */ 107 EZFS_BADWHO, /* invalid permission who */ 108 EZFS_BADPERM, /* invalid permission */ 109 EZFS_BADPERMSET, /* invalid permission set name */ 110 EZFS_NODELEGATION, /* delegated administration is disabled */ 111 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 112 EZFS_SHARESMBFAILED, /* failed to share over smb */ 113 EZFS_BADCACHE, /* bad cache file */ 114 EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 115 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 116 EZFS_NOTSUP, /* ops not supported on this dataset */ 117 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 118 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 119 EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 120 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 121 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 122 EZFS_PIPEFAILED, /* pipe create failed */ 123 EZFS_THREADCREATEFAILED, /* thread create failed */ 124 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 125 EZFS_SCRUBBING, /* currently scrubbing */ 126 EZFS_NO_SCRUB, /* no active scrub */ 127 EZFS_DIFF, /* general failure of zfs diff */ 128 EZFS_DIFFDATA, /* bad zfs diff data */ 129 EZFS_POOLREADONLY, /* pool is in read-only mode */ 130 EZFS_UNKNOWN 131 } zfs_error_t; 132 133 /* 134 * The following data structures are all part 135 * of the zfs_allow_t data structure which is 136 * used for printing 'allow' permissions. 137 * It is a linked list of zfs_allow_t's which 138 * then contain avl tree's for user/group/sets/... 139 * and each one of the entries in those trees have 140 * avl tree's for the permissions they belong to and 141 * whether they are local,descendent or local+descendent 142 * permissions. The AVL trees are used primarily for 143 * sorting purposes, but also so that we can quickly find 144 * a given user and or permission. 145 */ 146 typedef struct zfs_perm_node { 147 avl_node_t z_node; 148 char z_pname[MAXPATHLEN]; 149 } zfs_perm_node_t; 150 151 typedef struct zfs_allow_node { 152 avl_node_t z_node; 153 char z_key[MAXPATHLEN]; /* name, such as joe */ 154 avl_tree_t z_localdescend; /* local+descendent perms */ 155 avl_tree_t z_local; /* local permissions */ 156 avl_tree_t z_descend; /* descendent permissions */ 157 } zfs_allow_node_t; 158 159 typedef struct zfs_allow { 160 struct zfs_allow *z_next; 161 char z_setpoint[MAXPATHLEN]; 162 avl_tree_t z_sets; 163 avl_tree_t z_crperms; 164 avl_tree_t z_user; 165 avl_tree_t z_group; 166 avl_tree_t z_everyone; 167 } zfs_allow_t; 168 169 /* 170 * Basic handle types 171 */ 172 typedef struct zfs_handle zfs_handle_t; 173 typedef struct zpool_handle zpool_handle_t; 174 typedef struct libzfs_handle libzfs_handle_t; 175 176 /* 177 * Library initialization 178 */ 179 extern libzfs_handle_t *libzfs_init(void); 180 extern void libzfs_fini(libzfs_handle_t *); 181 182 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 183 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 184 185 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 186 187 extern void zfs_save_arguments(int argc, char **, char *, int); 188 extern int zpool_log_history(libzfs_handle_t *, const char *); 189 190 extern int libzfs_errno(libzfs_handle_t *); 191 extern const char *libzfs_error_action(libzfs_handle_t *); 192 extern const char *libzfs_error_description(libzfs_handle_t *); 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 *); 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_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 427 zprop_source_t *, char *, size_t, boolean_t); 428 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 429 boolean_t); 430 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 431 zprop_source_t *, char *, size_t); 432 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 433 uint64_t *propvalue); 434 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 435 char *propbuf, int proplen, boolean_t literal); 436 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 437 uint64_t *propvalue); 438 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 439 char *propbuf, int proplen, boolean_t literal); 440 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 441 char *buf, size_t len); 442 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 443 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 444 extern const char *zfs_prop_values(zfs_prop_t); 445 extern int zfs_prop_is_string(zfs_prop_t prop); 446 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 447 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 448 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 449 450 451 typedef struct zprop_list { 452 int pl_prop; 453 char *pl_user_prop; 454 struct zprop_list *pl_next; 455 boolean_t pl_all; 456 size_t pl_width; 457 size_t pl_recvd_width; 458 boolean_t pl_fixed; 459 } zprop_list_t; 460 461 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 462 boolean_t); 463 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 464 465 #define ZFS_MOUNTPOINT_NONE "none" 466 #define ZFS_MOUNTPOINT_LEGACY "legacy" 467 468 #define ZFS_FEATURE_DISABLED "disabled" 469 #define ZFS_FEATURE_ENABLED "enabled" 470 #define ZFS_FEATURE_ACTIVE "active" 471 472 #define ZFS_UNSUPPORTED_INACTIVE "inactive" 473 #define ZFS_UNSUPPORTED_READONLY "readonly" 474 475 /* 476 * zpool property management 477 */ 478 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 479 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 480 size_t); 481 extern const char *zpool_prop_default_string(zpool_prop_t); 482 extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 483 extern const char *zpool_prop_column_name(zpool_prop_t); 484 extern boolean_t zpool_prop_align_right(zpool_prop_t); 485 486 /* 487 * Functions shared by zfs and zpool property management. 488 */ 489 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 490 boolean_t ordered, zfs_type_t type); 491 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 492 zfs_type_t); 493 extern void zprop_free_list(zprop_list_t *); 494 495 #define ZFS_GET_NCOLS 5 496 497 typedef enum { 498 GET_COL_NONE, 499 GET_COL_NAME, 500 GET_COL_PROPERTY, 501 GET_COL_VALUE, 502 GET_COL_RECVD, 503 GET_COL_SOURCE 504 } zfs_get_column_t; 505 506 /* 507 * Functions for printing zfs or zpool properties 508 */ 509 typedef struct zprop_get_cbdata { 510 int cb_sources; 511 zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 512 int cb_colwidths[ZFS_GET_NCOLS + 1]; 513 boolean_t cb_scripted; 514 boolean_t cb_literal; 515 boolean_t cb_first; 516 zprop_list_t *cb_proplist; 517 zfs_type_t cb_type; 518 } zprop_get_cbdata_t; 519 520 void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 521 const char *, const char *, zprop_source_t, const char *, 522 const char *); 523 524 /* 525 * Iterator functions. 526 */ 527 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 528 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 529 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 530 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 531 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 532 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 533 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 534 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); 535 536 typedef struct get_all_cb { 537 zfs_handle_t **cb_handles; 538 size_t cb_alloc; 539 size_t cb_used; 540 boolean_t cb_verbose; 541 int (*cb_getone)(zfs_handle_t *, void *); 542 } get_all_cb_t; 543 544 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 545 int libzfs_dataset_cmp(const void *, const void *); 546 547 /* 548 * Functions to create and destroy datasets. 549 */ 550 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 551 nvlist_t *); 552 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 553 extern int zfs_destroy(zfs_handle_t *, boolean_t); 554 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 555 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 556 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 557 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 558 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 559 nvlist_t *props); 560 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 561 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); 562 563 typedef struct sendflags { 564 /* print informational messages (ie, -v was specified) */ 565 boolean_t verbose; 566 567 /* recursive send (ie, -R) */ 568 boolean_t replicate; 569 570 /* for incrementals, do all intermediate snapshots */ 571 boolean_t doall; 572 573 /* if dataset is a clone, do incremental from its origin */ 574 boolean_t fromorigin; 575 576 /* do deduplication */ 577 boolean_t dedup; 578 579 /* send properties (ie, -p) */ 580 boolean_t props; 581 582 /* do not send (no-op, ie. -n) */ 583 boolean_t dryrun; 584 585 /* parsable verbose output (ie. -P) */ 586 boolean_t parsable; 587 588 /* show progress (ie. -v) */ 589 boolean_t progress; 590 } sendflags_t; 591 592 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 593 594 extern int zfs_send(zfs_handle_t *, const char *, const char *, 595 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 596 597 extern int zfs_promote(zfs_handle_t *); 598 extern int zfs_hold(zfs_handle_t *, const char *, const char *, 599 boolean_t, int); 600 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 601 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 602 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); 603 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); 604 605 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 606 uid_t rid, uint64_t space); 607 608 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 609 zfs_userspace_cb_t, void *); 610 611 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 612 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 613 614 typedef struct recvflags { 615 /* print informational messages (ie, -v was specified) */ 616 boolean_t verbose; 617 618 /* the destination is a prefix, not the exact fs (ie, -d) */ 619 boolean_t isprefix; 620 621 /* 622 * Only the tail of the sent snapshot path is appended to the 623 * destination to determine the received snapshot name (ie, -e). 624 */ 625 boolean_t istail; 626 627 /* do not actually do the recv, just check if it would work (ie, -n) */ 628 boolean_t dryrun; 629 630 /* rollback/destroy filesystems as necessary (eg, -F) */ 631 boolean_t force; 632 633 /* set "canmount=off" on all modified filesystems */ 634 boolean_t canmountoff; 635 636 /* byteswap flag is used internally; callers need not specify */ 637 boolean_t byteswap; 638 639 /* do not mount file systems as they are extracted (private) */ 640 boolean_t nomount; 641 } recvflags_t; 642 643 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *, 644 int, avl_tree_t *); 645 646 typedef enum diff_flags { 647 ZFS_DIFF_PARSEABLE = 0x1, 648 ZFS_DIFF_TIMESTAMP = 0x2, 649 ZFS_DIFF_CLASSIFY = 0x4 650 } diff_flags_t; 651 652 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 653 int); 654 655 /* 656 * Miscellaneous functions. 657 */ 658 extern const char *zfs_type_to_name(zfs_type_t); 659 extern void zfs_refresh_properties(zfs_handle_t *); 660 extern int zfs_name_valid(const char *, zfs_type_t); 661 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 662 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 663 zfs_type_t); 664 extern int zfs_spa_version(zfs_handle_t *, int *); 665 666 /* 667 * Mount support functions. 668 */ 669 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 670 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 671 extern int zfs_mount(zfs_handle_t *, const char *, int); 672 extern int zfs_unmount(zfs_handle_t *, const char *, int); 673 extern int zfs_unmountall(zfs_handle_t *, int); 674 675 /* 676 * Share support functions. 677 */ 678 extern boolean_t zfs_is_shared(zfs_handle_t *); 679 extern int zfs_share(zfs_handle_t *); 680 extern int zfs_unshare(zfs_handle_t *); 681 682 /* 683 * Protocol-specific share support functions. 684 */ 685 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 686 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 687 extern int zfs_share_nfs(zfs_handle_t *); 688 extern int zfs_share_smb(zfs_handle_t *); 689 extern int zfs_shareall(zfs_handle_t *); 690 extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 691 extern int zfs_unshare_smb(zfs_handle_t *, const char *); 692 extern int zfs_unshareall_nfs(zfs_handle_t *); 693 extern int zfs_unshareall_smb(zfs_handle_t *); 694 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 695 extern int zfs_unshareall(zfs_handle_t *); 696 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 697 void *, void *, int, zfs_share_op_t); 698 699 /* 700 * When dealing with nvlists, verify() is extremely useful 701 */ 702 #ifdef NDEBUG 703 #define verify(EX) ((void)(EX)) 704 #else 705 #define verify(EX) assert(EX) 706 #endif 707 708 /* 709 * Utility function to convert a number to a human-readable form. 710 */ 711 extern void zfs_nicenum(uint64_t, char *, size_t); 712 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 713 714 /* 715 * Given a device or file, determine if it is part of a pool. 716 */ 717 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 718 boolean_t *); 719 720 /* 721 * Label manipulation. 722 */ 723 extern int zpool_read_label(int, nvlist_t **); 724 extern int zpool_clear_label(int); 725 726 /* is this zvol valid for use as a dump device? */ 727 extern int zvol_check_dump_config(char *); 728 729 /* 730 * Management interfaces for SMB ACL files 731 */ 732 733 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 734 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 735 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 736 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 737 738 /* 739 * Enable and disable datasets within a pool by mounting/unmounting and 740 * sharing/unsharing them. 741 */ 742 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 743 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 744 745 /* 746 * Mappings between vdev and FRU. 747 */ 748 extern void libzfs_fru_refresh(libzfs_handle_t *); 749 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 750 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 751 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 752 const char *); 753 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 754 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 755 756 #ifdef __cplusplus 757 } 758 #endif 759 760 #endif /* _LIBZFS_H */ 761