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