1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5441d80aaSlling * Common Development and Distribution License (the "License"). 6441d80aaSlling * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21f3861e1aSahl 22fa9e4066Sahrens /* 233f9d6ad7SLin Ling * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24e9316f76SJoe Stein * Copyright (c) 2011, 2015 by Delphix. All rights reserved. 254e3c9f44SBill Pijewski * Copyright (c) 2012, Joyent, Inc. All rights reserved. 26a7a845e4SSteven Hartland * Copyright (c) 2013 Steven Hartland. All rights reserved. 2743d68d68SYuri Pankov * Copyright 2013 Nexenta Systems, Inc. All rights reserved. 28*c3d26abcSMatthew Ahrens * Copyright (c) 2014 Integros [integros.com] 29fa9e4066Sahrens */ 30fa9e4066Sahrens 31fa9e4066Sahrens #ifndef _LIBZFS_H 32fa9e4066Sahrens #define _LIBZFS_H 33fa9e4066Sahrens 34fa9e4066Sahrens #include <assert.h> 35fa9e4066Sahrens #include <libnvpair.h> 36ebedde84SEric Taylor #include <sys/mnttab.h> 37fa9e4066Sahrens #include <sys/param.h> 38fa9e4066Sahrens #include <sys/types.h> 39fa9e4066Sahrens #include <sys/varargs.h> 40fa9e4066Sahrens #include <sys/fs/zfs.h> 41ecd6cf80Smarks #include <sys/avl.h> 42ecd6cf80Smarks #include <ucred.h> 435d7b4d43SMatthew Ahrens #include <libzfs_core.h> 44fa9e4066Sahrens 45fa9e4066Sahrens #ifdef __cplusplus 46fa9e4066Sahrens extern "C" { 47fa9e4066Sahrens #endif 48fa9e4066Sahrens 49fa9e4066Sahrens /* 50fa9e4066Sahrens * Miscellaneous ZFS constants 51fa9e4066Sahrens */ 52fa9e4066Sahrens #define ZFS_MAXNAMELEN MAXNAMELEN 53fa9e4066Sahrens #define ZPOOL_MAXNAMELEN MAXNAMELEN 54fa9e4066Sahrens #define ZFS_MAXPROPLEN MAXPATHLEN 55990b4856Slling #define ZPOOL_MAXPROPLEN MAXPATHLEN 56fa9e4066Sahrens 5799653d4eSeschrock /* 5899653d4eSeschrock * libzfs errors 5999653d4eSeschrock */ 604445fffbSMatthew Ahrens typedef enum zfs_error { 614445fffbSMatthew Ahrens EZFS_SUCCESS = 0, /* no error -- success */ 6299653d4eSeschrock EZFS_NOMEM = 2000, /* out of memory */ 6399653d4eSeschrock EZFS_BADPROP, /* invalid property value */ 6499653d4eSeschrock EZFS_PROPREADONLY, /* cannot set readonly property */ 6599653d4eSeschrock EZFS_PROPTYPE, /* property does not apply to dataset type */ 6699653d4eSeschrock EZFS_PROPNONINHERIT, /* property is not inheritable */ 6799653d4eSeschrock EZFS_PROPSPACE, /* bad quota or reservation */ 6899653d4eSeschrock EZFS_BADTYPE, /* dataset is not of appropriate type */ 6999653d4eSeschrock EZFS_BUSY, /* pool or dataset is busy */ 7099653d4eSeschrock EZFS_EXISTS, /* pool or dataset already exists */ 7199653d4eSeschrock EZFS_NOENT, /* no such pool or dataset */ 7299653d4eSeschrock EZFS_BADSTREAM, /* bad backup stream */ 7399653d4eSeschrock EZFS_DSREADONLY, /* dataset is readonly */ 7499653d4eSeschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 7599653d4eSeschrock EZFS_INVALIDNAME, /* invalid dataset name */ 7699653d4eSeschrock EZFS_BADRESTORE, /* unable to restore to destination */ 7799653d4eSeschrock EZFS_BADBACKUP, /* backup failed */ 7899653d4eSeschrock EZFS_BADTARGET, /* bad attach/detach/replace target */ 7999653d4eSeschrock EZFS_NODEVICE, /* no such device in pool */ 8099653d4eSeschrock EZFS_BADDEV, /* invalid device to add */ 8199653d4eSeschrock EZFS_NOREPLICAS, /* no valid replicas */ 8299653d4eSeschrock EZFS_RESILVERING, /* currently resilvering */ 8399653d4eSeschrock EZFS_BADVERSION, /* unsupported version */ 8499653d4eSeschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 8599653d4eSeschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 8699653d4eSeschrock EZFS_BADPATH, /* must be an absolute path */ 8799653d4eSeschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 8899653d4eSeschrock EZFS_ZONED, /* used improperly in local zone */ 8999653d4eSeschrock EZFS_MOUNTFAILED, /* failed to mount dataset */ 9099653d4eSeschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 91f3861e1aSahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 92f3861e1aSahl EZFS_SHARENFSFAILED, /* share(1M) failed */ 9399653d4eSeschrock EZFS_PERM, /* permission denied */ 9499653d4eSeschrock EZFS_NOSPC, /* out of space */ 956e27f868SSam Falkner EZFS_FAULT, /* bad address */ 9699653d4eSeschrock EZFS_IO, /* I/O error */ 9799653d4eSeschrock EZFS_INTR, /* signal received */ 9899653d4eSeschrock EZFS_ISSPARE, /* device is a hot spare */ 9999653d4eSeschrock EZFS_INVALCONFIG, /* invalid vdev configuration */ 1003bb79becSeschrock EZFS_RECURSIVE, /* recursive dependency */ 10106eeb2adSek EZFS_NOHISTORY, /* no history object */ 102b1b8ab34Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 103b1b8ab34Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 104b1b8ab34Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 105b7661cccSmmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 1068488aeb5Staylor EZFS_OPENFAILED, /* open of device failed */ 1078488aeb5Staylor EZFS_NOCAP, /* couldn't get capacity */ 1088488aeb5Staylor EZFS_LABELFAILED, /* write of label failed */ 109ecd6cf80Smarks EZFS_BADWHO, /* invalid permission who */ 110ecd6cf80Smarks EZFS_BADPERM, /* invalid permission */ 111ecd6cf80Smarks EZFS_BADPERMSET, /* invalid permission set name */ 112ecd6cf80Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 113da6c28aaSamw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 114da6c28aaSamw EZFS_SHARESMBFAILED, /* failed to share over smb */ 1152f8aaab3Seschrock EZFS_BADCACHE, /* bad cache file */ 116fa94a07fSbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 117e7cbe64fSgw EZFS_VDEVNOTSUP, /* unsupported vdev type */ 11815e6edf1Sgw EZFS_NOTSUP, /* ops not supported on this dataset */ 11989a89ebfSlling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 120e6ca193dSGeorge Wilson EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 121842727c2SChris Kirby EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 122842727c2SChris Kirby EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 123ca45db41SChris Kirby EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 1249e69d7d0SLori Alt EZFS_PIPEFAILED, /* pipe create failed */ 1259e69d7d0SLori Alt EZFS_THREADCREATEFAILED, /* thread create failed */ 1261195e687SMark J Musante EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 1273f9d6ad7SLin Ling EZFS_SCRUBBING, /* currently scrubbing */ 1283f9d6ad7SLin Ling EZFS_NO_SCRUB, /* no active scrub */ 12999d5e173STim Haley EZFS_DIFF, /* general failure of zfs diff */ 13099d5e173STim Haley EZFS_DIFFDATA, /* bad zfs diff data */ 131f9af39baSGeorge Wilson EZFS_POOLREADONLY, /* pool is in read-only mode */ 132b1b8ab34Slling EZFS_UNKNOWN 1334445fffbSMatthew Ahrens } zfs_error_t; 13499653d4eSeschrock 135ecd6cf80Smarks /* 136ecd6cf80Smarks * The following data structures are all part 137ecd6cf80Smarks * of the zfs_allow_t data structure which is 138ecd6cf80Smarks * used for printing 'allow' permissions. 139ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 140ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 141ecd6cf80Smarks * and each one of the entries in those trees have 142ecd6cf80Smarks * avl tree's for the permissions they belong to and 143ecd6cf80Smarks * whether they are local,descendent or local+descendent 144ecd6cf80Smarks * permissions. The AVL trees are used primarily for 145ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 146ecd6cf80Smarks * a given user and or permission. 147ecd6cf80Smarks */ 148ecd6cf80Smarks typedef struct zfs_perm_node { 149ecd6cf80Smarks avl_node_t z_node; 150ecd6cf80Smarks char z_pname[MAXPATHLEN]; 151ecd6cf80Smarks } zfs_perm_node_t; 152ecd6cf80Smarks 153ecd6cf80Smarks typedef struct zfs_allow_node { 154ecd6cf80Smarks avl_node_t z_node; 155ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 156ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 157ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 158ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 159ecd6cf80Smarks } zfs_allow_node_t; 160ecd6cf80Smarks 161ecd6cf80Smarks typedef struct zfs_allow { 162ecd6cf80Smarks struct zfs_allow *z_next; 163ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 164ecd6cf80Smarks avl_tree_t z_sets; 165ecd6cf80Smarks avl_tree_t z_crperms; 166ecd6cf80Smarks avl_tree_t z_user; 167ecd6cf80Smarks avl_tree_t z_group; 168ecd6cf80Smarks avl_tree_t z_everyone; 169ecd6cf80Smarks } zfs_allow_t; 170ecd6cf80Smarks 171fa9e4066Sahrens /* 172fa9e4066Sahrens * Basic handle types 173fa9e4066Sahrens */ 174fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 175fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 17699653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 17799653d4eSeschrock 17899653d4eSeschrock /* 17999653d4eSeschrock * Library initialization 18099653d4eSeschrock */ 18199653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 18299653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 18399653d4eSeschrock 18499653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 18599653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 18699653d4eSeschrock 18799653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 18899653d4eSeschrock 1894445fffbSMatthew Ahrens extern void zfs_save_arguments(int argc, char **, char *, int); 1904445fffbSMatthew Ahrens extern int zpool_log_history(libzfs_handle_t *, const char *); 1914445fffbSMatthew Ahrens 19299653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 19399653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 19499653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 19578f17100SMatthew Ahrens extern int zfs_standard_error(libzfs_handle_t *, int, const char *); 196ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 197ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 198b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 199ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 200ebedde84SEric Taylor struct mnttab *); 201ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 202ebedde84SEric Taylor const char *, const char *); 203ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 204fa9e4066Sahrens 205fa9e4066Sahrens /* 206fa9e4066Sahrens * Basic handle functions 207fa9e4066Sahrens */ 20899653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 20999653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 210fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 211fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 212fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 213990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 21429ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *); 215fa9e4066Sahrens 216fa9e4066Sahrens /* 217fa9e4066Sahrens * Iterate over all active pools in the system. 218fa9e4066Sahrens */ 219fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 22099653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 221fa9e4066Sahrens 222fa9e4066Sahrens /* 223fa9e4066Sahrens * Functions to create and destroy pools 224fa9e4066Sahrens */ 22599653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2260a48a24eStimh nvlist_t *, nvlist_t *); 2274445fffbSMatthew Ahrens extern int zpool_destroy(zpool_handle_t *, const char *); 228fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 229fa9e4066Sahrens 2301195e687SMark J Musante typedef struct splitflags { 2311195e687SMark J Musante /* do not split, but return the config that would be split off */ 2321195e687SMark J Musante int dryrun : 1; 2331195e687SMark J Musante 2341195e687SMark J Musante /* after splitting, import the pool */ 2351195e687SMark J Musante int import : 1; 2361195e687SMark J Musante } splitflags_t; 2371195e687SMark J Musante 238fa9e4066Sahrens /* 239fa9e4066Sahrens * Functions to manipulate pool and vdev state 240fa9e4066Sahrens */ 2413f9d6ad7SLin Ling extern int zpool_scan(zpool_handle_t *, pool_scan_func_t); 242468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 243e9103aaeSGarrett D'Amore extern int zpool_reguid(zpool_handle_t *); 2444263d13fSGeorge Wilson extern int zpool_reopen(zpool_handle_t *); 245fa9e4066Sahrens 2463d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2473d7072f8Seschrock vdev_state_t *); 2483d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2493d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2503d7072f8Seschrock const char *, nvlist_t *, int); 251fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 25299653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2531195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 2541195e687SMark J Musante splitflags_t); 2553d7072f8Seschrock 256069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 257069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 2583d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2593d7072f8Seschrock 260fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 261ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 262573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 263573ca77eSGeorge Wilson boolean_t *, boolean_t *, boolean_t *); 2648488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 265fa9e4066Sahrens 266b1b8ab34Slling /* 267b1b8ab34Slling * Functions to manage pool properties 268b1b8ab34Slling */ 269b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2703d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 271c58b3526SAdam Stevko size_t proplen, zprop_source_t *, boolean_t); 272990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 273990b4856Slling zprop_source_t *); 274990b4856Slling 275b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 276b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 277b1b8ab34Slling 278fa9e4066Sahrens /* 279fa9e4066Sahrens * Pool health statistics. 280fa9e4066Sahrens */ 281fa9e4066Sahrens typedef enum { 282fa9e4066Sahrens /* 283fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 284b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 285fa9e4066Sahrens */ 286fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 287fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 288fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 289fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 290b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 291fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 292fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 293fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 294fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 295eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 29695173954Sek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 29732b87932Sek ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 29832b87932Sek ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 299f67f35c3SEric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 300f67f35c3SEric Schrock 301ad135b5dSChristopher Siden /* 302ad135b5dSChristopher Siden * If the pool has unsupported features but can still be opened in 303ad135b5dSChristopher Siden * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 304ad135b5dSChristopher Siden * pool has unsupported features but cannot be opened at all, its 305ad135b5dSChristopher Siden * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 306ad135b5dSChristopher Siden */ 307ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 308ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 309ad135b5dSChristopher Siden 310f67f35c3SEric Schrock /* 311f67f35c3SEric Schrock * These faults have no corresponding message ID. At the time we are 312f67f35c3SEric Schrock * checking the status, the original reason for the FMA fault (I/O or 313f67f35c3SEric Schrock * checksum errors) has been lost. 314f67f35c3SEric Schrock */ 3153d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 3163d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 317fa9e4066Sahrens 318fa9e4066Sahrens /* 319fa9e4066Sahrens * The following are not faults per se, but still an error possibly 320b81d61a6Slling * requiring administrative attention. There is no corresponding 321fa9e4066Sahrens * message ID. 322fa9e4066Sahrens */ 32357221772SChristopher Siden ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 32457221772SChristopher Siden ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 325fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 326cb605c4dSGerhard Roethlin ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 327c25309d4SGeorge Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 328fa9e4066Sahrens 329fa9e4066Sahrens /* 330fa9e4066Sahrens * Finally, the following indicates a healthy pool. 331fa9e4066Sahrens */ 332fa9e4066Sahrens ZPOOL_STATUS_OK 333fa9e4066Sahrens } zpool_status_t; 334fa9e4066Sahrens 335ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 336ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 3379eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 338fa9e4066Sahrens 339fa9e4066Sahrens /* 340fa9e4066Sahrens * Statistics and configuration functions. 341fa9e4066Sahrens */ 342ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 343ad135b5dSChristopher Siden extern nvlist_t *zpool_get_features(zpool_handle_t *); 34494de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 34555434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 346ea8dc4b6Seschrock 347fa9e4066Sahrens /* 348fa9e4066Sahrens * Import and export functions 349fa9e4066Sahrens */ 3504445fffbSMatthew Ahrens extern int zpool_export(zpool_handle_t *, boolean_t, const char *); 3514445fffbSMatthew Ahrens extern int zpool_export_force(zpool_handle_t *, const char *); 35299653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 353990b4856Slling char *altroot); 354990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 3554b964adaSGeorge Wilson nvlist_t *, int); 356ad135b5dSChristopher Siden extern void zpool_print_unsup_feat(nvlist_t *config); 357fa9e4066Sahrens 358fa9e4066Sahrens /* 359fa9e4066Sahrens * Search for pools to import 360fa9e4066Sahrens */ 361d41c4376SMark J Musante 362d41c4376SMark J Musante typedef struct importargs { 363d41c4376SMark J Musante char **path; /* a list of paths to search */ 364d41c4376SMark J Musante int paths; /* number of paths to search */ 365d41c4376SMark J Musante char *poolname; /* name of a pool to find */ 366d41c4376SMark J Musante uint64_t guid; /* guid of a pool to find */ 367d41c4376SMark J Musante char *cachefile; /* cachefile to use for import */ 368d41c4376SMark J Musante int can_be_active : 1; /* can the pool be active? */ 369d41c4376SMark J Musante int unique : 1; /* does 'poolname' already exist? */ 370d41c4376SMark J Musante int exists : 1; /* set on return if pool already exists */ 371d41c4376SMark J Musante } importargs_t; 372d41c4376SMark J Musante 373d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 374d41c4376SMark J Musante 375d41c4376SMark J Musante /* legacy pool search routines */ 37624e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3773a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 378e829d913Sck char *, uint64_t); 379fa9e4066Sahrens 380c67d9675Seschrock /* 381c67d9675Seschrock * Miscellaneous pool functions 382c67d9675Seschrock */ 383ecd6cf80Smarks struct zfs_cmd; 384ecd6cf80Smarks 3854445fffbSMatthew Ahrens extern const char *zfs_history_event_names[]; 3868f18d1faSGeorge Wilson 38788ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 38888ecc943SGeorge Wilson boolean_t verbose); 389990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 39006eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 3918f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 3928f18d1faSGeorge Wilson nvlist_t ***, uint_t *); 39355434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 39455434c77Sek size_t len); 395ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 396753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 397468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 398468c413aSTim Haley nvlist_t *); 399753a6d45SSherry Moore 400fa9e4066Sahrens /* 401fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 402fa9e4066Sahrens * underlying datasets, only the references to them. 403fa9e4066Sahrens */ 40499653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 40519b94df9SMatthew Ahrens extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 406fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 407fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 408fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 409d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 410fa9e4066Sahrens 411fa9e4066Sahrens /* 412fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 413b81d61a6Slling * and are found in sys/fs/zfs.h. 414fa9e4066Sahrens */ 415990b4856Slling 416990b4856Slling /* 417990b4856Slling * zfs dataset property management 418990b4856Slling */ 419990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 420990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 421990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t); 422990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t); 423990b4856Slling 4240a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 425e9316f76SJoe Stein nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *); 4260a48a24eStimh 427e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t); 428e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 42930925561SChris Williamson extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 430e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 431990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 43292241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 43392241e0bSTom Erickson boolean_t); 434e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 435990b4856Slling zprop_source_t *, char *, size_t); 436edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 437edea4b55SLin Ling uint64_t *propvalue); 43814843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 43914843421SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 44019b94df9SMatthew Ahrens extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 44119b94df9SMatthew Ahrens uint64_t *propvalue); 44219b94df9SMatthew Ahrens extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 44319b94df9SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 444ad135b5dSChristopher Siden extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 445ad135b5dSChristopher Siden char *buf, size_t len); 446e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 44792241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 448e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t); 449e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop); 450990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 45192241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 45219b94df9SMatthew Ahrens extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 45319b94df9SMatthew Ahrens 454e9dbad6fSeschrock 455990b4856Slling typedef struct zprop_list { 456990b4856Slling int pl_prop; 457e9dbad6fSeschrock char *pl_user_prop; 458990b4856Slling struct zprop_list *pl_next; 459e9dbad6fSeschrock boolean_t pl_all; 460e9dbad6fSeschrock size_t pl_width; 46192241e0bSTom Erickson size_t pl_recvd_width; 462e9dbad6fSeschrock boolean_t pl_fixed; 463990b4856Slling } zprop_list_t; 464e9dbad6fSeschrock 46543d68d68SYuri Pankov extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 46643d68d68SYuri Pankov boolean_t); 4672e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 468fa9e4066Sahrens 469fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 470fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 471fa9e4066Sahrens 472ad135b5dSChristopher Siden #define ZFS_FEATURE_DISABLED "disabled" 473ad135b5dSChristopher Siden #define ZFS_FEATURE_ENABLED "enabled" 474ad135b5dSChristopher Siden #define ZFS_FEATURE_ACTIVE "active" 475ad135b5dSChristopher Siden 476ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_INACTIVE "inactive" 477ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_READONLY "readonly" 478ad135b5dSChristopher Siden 479b1b8ab34Slling /* 480990b4856Slling * zpool property management 481990b4856Slling */ 482990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 483ad135b5dSChristopher Siden extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 484ad135b5dSChristopher Siden size_t); 485990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 486990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 487990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 488990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 489990b4856Slling 490990b4856Slling /* 491990b4856Slling * Functions shared by zfs and zpool property management. 492b1b8ab34Slling */ 493990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 494990b4856Slling boolean_t ordered, zfs_type_t type); 495990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 496990b4856Slling zfs_type_t); 497990b4856Slling extern void zprop_free_list(zprop_list_t *); 498990b4856Slling 49992241e0bSTom Erickson #define ZFS_GET_NCOLS 5 50092241e0bSTom Erickson 50192241e0bSTom Erickson typedef enum { 50292241e0bSTom Erickson GET_COL_NONE, 50392241e0bSTom Erickson GET_COL_NAME, 50492241e0bSTom Erickson GET_COL_PROPERTY, 50592241e0bSTom Erickson GET_COL_VALUE, 50692241e0bSTom Erickson GET_COL_RECVD, 50792241e0bSTom Erickson GET_COL_SOURCE 50892241e0bSTom Erickson } zfs_get_column_t; 50992241e0bSTom Erickson 510990b4856Slling /* 511990b4856Slling * Functions for printing zfs or zpool properties 512990b4856Slling */ 513990b4856Slling typedef struct zprop_get_cbdata { 514b1b8ab34Slling int cb_sources; 51592241e0bSTom Erickson zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 51692241e0bSTom Erickson int cb_colwidths[ZFS_GET_NCOLS + 1]; 517b1b8ab34Slling boolean_t cb_scripted; 518b1b8ab34Slling boolean_t cb_literal; 519b1b8ab34Slling boolean_t cb_first; 520990b4856Slling zprop_list_t *cb_proplist; 521990b4856Slling zfs_type_t cb_type; 522990b4856Slling } zprop_get_cbdata_t; 523b1b8ab34Slling 524990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 52592241e0bSTom Erickson const char *, const char *, zprop_source_t, const char *, 52692241e0bSTom Erickson const char *); 527b1b8ab34Slling 528fa9e4066Sahrens /* 529fa9e4066Sahrens * Iterator functions. 530fa9e4066Sahrens */ 531fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 53299653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 533fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 5343bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 5357f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 5367f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 537ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 53819b94df9SMatthew Ahrens extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); 53978f17100SMatthew Ahrens extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 540fa9e4066Sahrens 5419d9a58e3SEric Taylor typedef struct get_all_cb { 5429d9a58e3SEric Taylor zfs_handle_t **cb_handles; 5439d9a58e3SEric Taylor size_t cb_alloc; 5449d9a58e3SEric Taylor size_t cb_used; 5459d9a58e3SEric Taylor boolean_t cb_verbose; 5469d9a58e3SEric Taylor int (*cb_getone)(zfs_handle_t *, void *); 5479d9a58e3SEric Taylor } get_all_cb_t; 5489d9a58e3SEric Taylor 5499d9a58e3SEric Taylor void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 5509d9a58e3SEric Taylor int libzfs_dataset_cmp(const void *, const void *); 5519d9a58e3SEric Taylor 552fa9e4066Sahrens /* 553fa9e4066Sahrens * Functions to create and destroy datasets. 554fa9e4066Sahrens */ 55599653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 556e9dbad6fSeschrock nvlist_t *); 5577f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 558842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t); 559842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 5603b2aab18SMatthew Ahrens extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 561e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 562bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 5634445fffbSMatthew Ahrens extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 5644445fffbSMatthew Ahrens nvlist_t *props); 565c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 5666a9cb0eaSEric Schrock extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); 5679e69d7d0SLori Alt 5689e69d7d0SLori Alt typedef struct sendflags { 5699e69d7d0SLori Alt /* print informational messages (ie, -v was specified) */ 57019b94df9SMatthew Ahrens boolean_t verbose; 5719e69d7d0SLori Alt 57292241e0bSTom Erickson /* recursive send (ie, -R) */ 57319b94df9SMatthew Ahrens boolean_t replicate; 5749e69d7d0SLori Alt 5759e69d7d0SLori Alt /* for incrementals, do all intermediate snapshots */ 57619b94df9SMatthew Ahrens boolean_t doall; 5779e69d7d0SLori Alt 5789e69d7d0SLori Alt /* if dataset is a clone, do incremental from its origin */ 57919b94df9SMatthew Ahrens boolean_t fromorigin; 5809e69d7d0SLori Alt 5819e69d7d0SLori Alt /* do deduplication */ 58219b94df9SMatthew Ahrens boolean_t dedup; 58392241e0bSTom Erickson 58492241e0bSTom Erickson /* send properties (ie, -p) */ 58519b94df9SMatthew Ahrens boolean_t props; 58619b94df9SMatthew Ahrens 58719b94df9SMatthew Ahrens /* do not send (no-op, ie. -n) */ 58819b94df9SMatthew Ahrens boolean_t dryrun; 58919b94df9SMatthew Ahrens 59019b94df9SMatthew Ahrens /* parsable verbose output (ie. -P) */ 59119b94df9SMatthew Ahrens boolean_t parsable; 5924e3c9f44SBill Pijewski 5934e3c9f44SBill Pijewski /* show progress (ie. -v) */ 5944e3c9f44SBill Pijewski boolean_t progress; 5955d7b4d43SMatthew Ahrens 596b5152584SMatthew Ahrens /* large blocks (>128K) are permitted */ 597b5152584SMatthew Ahrens boolean_t largeblock; 598b5152584SMatthew Ahrens 5995d7b4d43SMatthew Ahrens /* WRITE_EMBEDDED records of type DATA are permitted */ 6005d7b4d43SMatthew Ahrens boolean_t embed_data; 6019e69d7d0SLori Alt } sendflags_t; 6029e69d7d0SLori Alt 6039e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 6049e69d7d0SLori Alt 60519b94df9SMatthew Ahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 60619b94df9SMatthew Ahrens sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 6075d7b4d43SMatthew Ahrens extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); 6089c3fd121SMatthew Ahrens extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 6099c3fd121SMatthew Ahrens const char *); 6109c3fd121SMatthew Ahrens extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 6119c3fd121SMatthew Ahrens const char *token); 6129e69d7d0SLori Alt 61399653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 6143b2aab18SMatthew Ahrens extern int zfs_hold(zfs_handle_t *, const char *, const char *, 615a7a845e4SSteven Hartland boolean_t, int); 616a7a845e4SSteven Hartland extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 617842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 6181af68beaSAlexander Stetsenko extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); 619c1449561SEric Taylor extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); 620fa9e4066Sahrens 6210aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 62214843421SMatthew Ahrens uid_t rid, uint64_t space); 62314843421SMatthew Ahrens 6241af68beaSAlexander Stetsenko extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 6251af68beaSAlexander Stetsenko zfs_userspace_cb_t, void *); 6261af68beaSAlexander Stetsenko 6271af68beaSAlexander Stetsenko extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 6281af68beaSAlexander Stetsenko extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 62914843421SMatthew Ahrens 6303cb34c60Sahrens typedef struct recvflags { 6314ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 63219b94df9SMatthew Ahrens boolean_t verbose; 6334ccbb6e7Sahrens 6344ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 63519b94df9SMatthew Ahrens boolean_t isprefix; 6364ccbb6e7Sahrens 637f64930f5STom Erickson /* 638f64930f5STom Erickson * Only the tail of the sent snapshot path is appended to the 639f64930f5STom Erickson * destination to determine the received snapshot name (ie, -e). 640f64930f5STom Erickson */ 64119b94df9SMatthew Ahrens boolean_t istail; 642f64930f5STom Erickson 6434ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 64419b94df9SMatthew Ahrens boolean_t dryrun; 6454ccbb6e7Sahrens 6464ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 64719b94df9SMatthew Ahrens boolean_t force; 6484ccbb6e7Sahrens 6494ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 65019b94df9SMatthew Ahrens boolean_t canmountoff; 6514ccbb6e7Sahrens 6529c3fd121SMatthew Ahrens /* 6539c3fd121SMatthew Ahrens * Mark the file systems as "resumable" and do not destroy them if the 6549c3fd121SMatthew Ahrens * receive is interrupted 6559c3fd121SMatthew Ahrens */ 6569c3fd121SMatthew Ahrens boolean_t resumable; 6579c3fd121SMatthew Ahrens 6584ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 65919b94df9SMatthew Ahrens boolean_t byteswap; 66033408eefSLori Alt 66133408eefSLori Alt /* do not mount file systems as they are extracted (private) */ 66219b94df9SMatthew Ahrens boolean_t nomount; 6633cb34c60Sahrens } recvflags_t; 6643cb34c60Sahrens 665a2cdcdd2SPaul Dagnelie extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 666a2cdcdd2SPaul Dagnelie recvflags_t *, int, avl_tree_t *); 6673cb34c60Sahrens 66899d5e173STim Haley typedef enum diff_flags { 66999d5e173STim Haley ZFS_DIFF_PARSEABLE = 0x1, 67099d5e173STim Haley ZFS_DIFF_TIMESTAMP = 0x2, 67199d5e173STim Haley ZFS_DIFF_CLASSIFY = 0x4 67299d5e173STim Haley } diff_flags_t; 67399d5e173STim Haley 67499d5e173STim Haley extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 67599d5e173STim Haley int); 67699d5e173STim Haley 677fa9e4066Sahrens /* 678fa9e4066Sahrens * Miscellaneous functions. 679fa9e4066Sahrens */ 680fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 681fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 682fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 6835aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 6847f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 6857f1f55eaSvb zfs_type_t); 6867b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *); 68778f17100SMatthew Ahrens extern boolean_t zfs_bookmark_exists(const char *path); 688fa9e4066Sahrens 689fa9e4066Sahrens /* 690fa9e4066Sahrens * Mount support functions. 691fa9e4066Sahrens */ 69255434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 69399653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 694fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 695fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 696fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 697fa9e4066Sahrens 698fa9e4066Sahrens /* 699fa9e4066Sahrens * Share support functions. 700fa9e4066Sahrens */ 701f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 702fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 703f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 704f3861e1aSahl 705f3861e1aSahl /* 7063d7072f8Seschrock * Protocol-specific share support functions. 707f3861e1aSahl */ 708f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 709da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 710f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 711da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 712da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 713f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 714da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 715f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 716da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 717da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 718da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 719743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 720da6c28aaSamw void *, void *, int, zfs_share_op_t); 721fa9e4066Sahrens 722fa9e4066Sahrens /* 723fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 724fa9e4066Sahrens */ 725fa9e4066Sahrens #ifdef NDEBUG 726fa9e4066Sahrens #define verify(EX) ((void)(EX)) 727fa9e4066Sahrens #else 728fa9e4066Sahrens #define verify(EX) assert(EX) 729fa9e4066Sahrens #endif 730fa9e4066Sahrens 731fa9e4066Sahrens /* 732fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 733fa9e4066Sahrens */ 734fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 735e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 736fa9e4066Sahrens 737fa9e4066Sahrens /* 738fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 739fa9e4066Sahrens */ 74099653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 74199653d4eSeschrock boolean_t *); 742fa9e4066Sahrens 743fa9e4066Sahrens /* 744096d22d4SEric Schrock * Label manipulation. 745fa9e4066Sahrens */ 74699653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 747096d22d4SEric Schrock extern int zpool_clear_label(int); 748fa9e4066Sahrens 749e7cbe64fSgw /* is this zvol valid for use as a dump device? */ 750e7cbe64fSgw extern int zvol_check_dump_config(char *); 751e7cbe64fSgw 752743a77edSAlan Wright /* 753743a77edSAlan Wright * Management interfaces for SMB ACL files 754743a77edSAlan Wright */ 755743a77edSAlan Wright 756743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 757743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 758743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 759743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 760743a77edSAlan Wright 7613bb79becSeschrock /* 762f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 763f3861e1aSahl * sharing/unsharing them. 7643bb79becSeschrock */ 765f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 766f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 7673bb79becSeschrock 768069f55e2SEric Schrock /* 769069f55e2SEric Schrock * Mappings between vdev and FRU. 770069f55e2SEric Schrock */ 771069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *); 772069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 773069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 774069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 775069f55e2SEric Schrock const char *); 776069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 777069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 778069f55e2SEric Schrock 7792bcf0248SMax Grossman extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *); 7802bcf0248SMax Grossman 781fa9e4066Sahrens #ifdef __cplusplus 782fa9e4066Sahrens } 783fa9e4066Sahrens #endif 784fa9e4066Sahrens 785fa9e4066Sahrens #endif /* _LIBZFS_H */ 786