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 /* 23*3f9d6ad7SLin Ling * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24fa9e4066Sahrens */ 25fa9e4066Sahrens 26fa9e4066Sahrens #ifndef _LIBZFS_H 27fa9e4066Sahrens #define _LIBZFS_H 28fa9e4066Sahrens 29fa9e4066Sahrens #include <assert.h> 30fa9e4066Sahrens #include <libnvpair.h> 31ebedde84SEric Taylor #include <sys/mnttab.h> 32fa9e4066Sahrens #include <sys/param.h> 33fa9e4066Sahrens #include <sys/types.h> 34fa9e4066Sahrens #include <sys/varargs.h> 35fa9e4066Sahrens #include <sys/fs/zfs.h> 36ecd6cf80Smarks #include <sys/avl.h> 37ecd6cf80Smarks #include <ucred.h> 38fa9e4066Sahrens 39fa9e4066Sahrens #ifdef __cplusplus 40fa9e4066Sahrens extern "C" { 41fa9e4066Sahrens #endif 42fa9e4066Sahrens 43fa9e4066Sahrens /* 44fa9e4066Sahrens * Miscellaneous ZFS constants 45fa9e4066Sahrens */ 46fa9e4066Sahrens #define ZFS_MAXNAMELEN MAXNAMELEN 47fa9e4066Sahrens #define ZPOOL_MAXNAMELEN MAXNAMELEN 48fa9e4066Sahrens #define ZFS_MAXPROPLEN MAXPATHLEN 49990b4856Slling #define ZPOOL_MAXPROPLEN MAXPATHLEN 50fa9e4066Sahrens 5199653d4eSeschrock /* 5299653d4eSeschrock * libzfs errors 5399653d4eSeschrock */ 5499653d4eSeschrock enum { 5599653d4eSeschrock EZFS_NOMEM = 2000, /* out of memory */ 5699653d4eSeschrock EZFS_BADPROP, /* invalid property value */ 5799653d4eSeschrock EZFS_PROPREADONLY, /* cannot set readonly property */ 5899653d4eSeschrock EZFS_PROPTYPE, /* property does not apply to dataset type */ 5999653d4eSeschrock EZFS_PROPNONINHERIT, /* property is not inheritable */ 6099653d4eSeschrock EZFS_PROPSPACE, /* bad quota or reservation */ 6199653d4eSeschrock EZFS_BADTYPE, /* dataset is not of appropriate type */ 6299653d4eSeschrock EZFS_BUSY, /* pool or dataset is busy */ 6399653d4eSeschrock EZFS_EXISTS, /* pool or dataset already exists */ 6499653d4eSeschrock EZFS_NOENT, /* no such pool or dataset */ 6599653d4eSeschrock EZFS_BADSTREAM, /* bad backup stream */ 6699653d4eSeschrock EZFS_DSREADONLY, /* dataset is readonly */ 6799653d4eSeschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 6899653d4eSeschrock EZFS_INVALIDNAME, /* invalid dataset name */ 6999653d4eSeschrock EZFS_BADRESTORE, /* unable to restore to destination */ 7099653d4eSeschrock EZFS_BADBACKUP, /* backup failed */ 7199653d4eSeschrock EZFS_BADTARGET, /* bad attach/detach/replace target */ 7299653d4eSeschrock EZFS_NODEVICE, /* no such device in pool */ 7399653d4eSeschrock EZFS_BADDEV, /* invalid device to add */ 7499653d4eSeschrock EZFS_NOREPLICAS, /* no valid replicas */ 7599653d4eSeschrock EZFS_RESILVERING, /* currently resilvering */ 7699653d4eSeschrock EZFS_BADVERSION, /* unsupported version */ 7799653d4eSeschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 7899653d4eSeschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 7999653d4eSeschrock EZFS_BADPATH, /* must be an absolute path */ 8099653d4eSeschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 8199653d4eSeschrock EZFS_ZONED, /* used improperly in local zone */ 8299653d4eSeschrock EZFS_MOUNTFAILED, /* failed to mount dataset */ 8399653d4eSeschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 84f3861e1aSahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 85f3861e1aSahl EZFS_SHARENFSFAILED, /* share(1M) failed */ 8699653d4eSeschrock EZFS_PERM, /* permission denied */ 8799653d4eSeschrock EZFS_NOSPC, /* out of space */ 886e27f868SSam Falkner EZFS_FAULT, /* bad address */ 8999653d4eSeschrock EZFS_IO, /* I/O error */ 9099653d4eSeschrock EZFS_INTR, /* signal received */ 9199653d4eSeschrock EZFS_ISSPARE, /* device is a hot spare */ 9299653d4eSeschrock EZFS_INVALCONFIG, /* invalid vdev configuration */ 933bb79becSeschrock EZFS_RECURSIVE, /* recursive dependency */ 9406eeb2adSek EZFS_NOHISTORY, /* no history object */ 95b1b8ab34Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 96b1b8ab34Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 97b1b8ab34Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 98b7661cccSmmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 998488aeb5Staylor EZFS_OPENFAILED, /* open of device failed */ 1008488aeb5Staylor EZFS_NOCAP, /* couldn't get capacity */ 1018488aeb5Staylor EZFS_LABELFAILED, /* write of label failed */ 102ecd6cf80Smarks EZFS_BADWHO, /* invalid permission who */ 103ecd6cf80Smarks EZFS_BADPERM, /* invalid permission */ 104ecd6cf80Smarks EZFS_BADPERMSET, /* invalid permission set name */ 105ecd6cf80Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 106ecd6cf80Smarks EZFS_PERMRDONLY, /* pemissions are readonly */ 107da6c28aaSamw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 108da6c28aaSamw EZFS_SHARESMBFAILED, /* failed to share over smb */ 1092f8aaab3Seschrock EZFS_BADCACHE, /* bad cache file */ 110fa94a07fSbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 111e7cbe64fSgw EZFS_VDEVNOTSUP, /* unsupported vdev type */ 11215e6edf1Sgw EZFS_NOTSUP, /* ops not supported on this dataset */ 11389a89ebfSlling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 114e6ca193dSGeorge Wilson EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 115842727c2SChris Kirby EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 116842727c2SChris Kirby EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 117ca45db41SChris Kirby EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 1189e69d7d0SLori Alt EZFS_PIPEFAILED, /* pipe create failed */ 1199e69d7d0SLori Alt EZFS_THREADCREATEFAILED, /* thread create failed */ 1201195e687SMark J Musante EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 121*3f9d6ad7SLin Ling EZFS_SCRUBBING, /* currently scrubbing */ 122*3f9d6ad7SLin Ling EZFS_NO_SCRUB, /* no active scrub */ 123b1b8ab34Slling EZFS_UNKNOWN 12499653d4eSeschrock }; 12599653d4eSeschrock 126ecd6cf80Smarks /* 127ecd6cf80Smarks * The following data structures are all part 128ecd6cf80Smarks * of the zfs_allow_t data structure which is 129ecd6cf80Smarks * used for printing 'allow' permissions. 130ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 131ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 132ecd6cf80Smarks * and each one of the entries in those trees have 133ecd6cf80Smarks * avl tree's for the permissions they belong to and 134ecd6cf80Smarks * whether they are local,descendent or local+descendent 135ecd6cf80Smarks * permissions. The AVL trees are used primarily for 136ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 137ecd6cf80Smarks * a given user and or permission. 138ecd6cf80Smarks */ 139ecd6cf80Smarks typedef struct zfs_perm_node { 140ecd6cf80Smarks avl_node_t z_node; 141ecd6cf80Smarks char z_pname[MAXPATHLEN]; 142ecd6cf80Smarks } zfs_perm_node_t; 143ecd6cf80Smarks 144ecd6cf80Smarks typedef struct zfs_allow_node { 145ecd6cf80Smarks avl_node_t z_node; 146ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 147ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 148ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 149ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 150ecd6cf80Smarks } zfs_allow_node_t; 151ecd6cf80Smarks 152ecd6cf80Smarks typedef struct zfs_allow { 153ecd6cf80Smarks struct zfs_allow *z_next; 154ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 155ecd6cf80Smarks avl_tree_t z_sets; 156ecd6cf80Smarks avl_tree_t z_crperms; 157ecd6cf80Smarks avl_tree_t z_user; 158ecd6cf80Smarks avl_tree_t z_group; 159ecd6cf80Smarks avl_tree_t z_everyone; 160ecd6cf80Smarks } zfs_allow_t; 161ecd6cf80Smarks 162fa9e4066Sahrens /* 163fa9e4066Sahrens * Basic handle types 164fa9e4066Sahrens */ 165fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 166fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 16799653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 16899653d4eSeschrock 16999653d4eSeschrock /* 17099653d4eSeschrock * Library initialization 17199653d4eSeschrock */ 17299653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 17399653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 17499653d4eSeschrock 17599653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 17699653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 17799653d4eSeschrock 17899653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 17999653d4eSeschrock 18099653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 18199653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 18299653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 183ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 184ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 185b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 186ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 187ebedde84SEric Taylor struct mnttab *); 188ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 189ebedde84SEric Taylor const char *, const char *); 190ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 191fa9e4066Sahrens 192fa9e4066Sahrens /* 193fa9e4066Sahrens * Basic handle functions 194fa9e4066Sahrens */ 19599653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 19699653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 197fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 198fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 199fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 200990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 20129ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *); 202fa9e4066Sahrens 203fa9e4066Sahrens /* 204fa9e4066Sahrens * Iterate over all active pools in the system. 205fa9e4066Sahrens */ 206fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 20799653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 208fa9e4066Sahrens 209fa9e4066Sahrens /* 210fa9e4066Sahrens * Functions to create and destroy pools 211fa9e4066Sahrens */ 21299653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2130a48a24eStimh nvlist_t *, nvlist_t *); 214fa9e4066Sahrens extern int zpool_destroy(zpool_handle_t *); 215fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 216fa9e4066Sahrens 2171195e687SMark J Musante typedef struct splitflags { 2181195e687SMark J Musante /* do not split, but return the config that would be split off */ 2191195e687SMark J Musante int dryrun : 1; 2201195e687SMark J Musante 2211195e687SMark J Musante /* after splitting, import the pool */ 2221195e687SMark J Musante int import : 1; 2231195e687SMark J Musante } splitflags_t; 2241195e687SMark J Musante 225fa9e4066Sahrens /* 226fa9e4066Sahrens * Functions to manipulate pool and vdev state 227fa9e4066Sahrens */ 228*3f9d6ad7SLin Ling extern int zpool_scan(zpool_handle_t *, pool_scan_func_t); 229468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 230fa9e4066Sahrens 2313d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2323d7072f8Seschrock vdev_state_t *); 2333d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2343d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2353d7072f8Seschrock const char *, nvlist_t *, int); 236fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 23799653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2381195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 2391195e687SMark J Musante splitflags_t); 2403d7072f8Seschrock 241069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 242069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 2433d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2443d7072f8Seschrock 245fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 246ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 247573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 248573ca77eSGeorge Wilson boolean_t *, boolean_t *, boolean_t *); 2498488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 250fa9e4066Sahrens 251b1b8ab34Slling /* 252b1b8ab34Slling * Functions to manage pool properties 253b1b8ab34Slling */ 254b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2553d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 256990b4856Slling size_t proplen, zprop_source_t *); 257990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 258990b4856Slling zprop_source_t *); 259990b4856Slling 260b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 261b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 262b1b8ab34Slling 263fa9e4066Sahrens /* 264fa9e4066Sahrens * Pool health statistics. 265fa9e4066Sahrens */ 266fa9e4066Sahrens typedef enum { 267fa9e4066Sahrens /* 268fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 269b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 270fa9e4066Sahrens */ 271fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 272fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 273fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 274fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 275b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 276fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 277fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 278fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 279fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 280eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 28195173954Sek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 28232b87932Sek ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 28332b87932Sek ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 284f67f35c3SEric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 285f67f35c3SEric Schrock 286f67f35c3SEric Schrock /* 287f67f35c3SEric Schrock * These faults have no corresponding message ID. At the time we are 288f67f35c3SEric Schrock * checking the status, the original reason for the FMA fault (I/O or 289f67f35c3SEric Schrock * checksum errors) has been lost. 290f67f35c3SEric Schrock */ 2913d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2923d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 293fa9e4066Sahrens 294fa9e4066Sahrens /* 295fa9e4066Sahrens * The following are not faults per se, but still an error possibly 296b81d61a6Slling * requiring administrative attention. There is no corresponding 297fa9e4066Sahrens * message ID. 298fa9e4066Sahrens */ 299eaca9bbdSeschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 300fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 301fa9e4066Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 302c25309d4SGeorge Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 303fa9e4066Sahrens 304fa9e4066Sahrens /* 305fa9e4066Sahrens * Finally, the following indicates a healthy pool. 306fa9e4066Sahrens */ 307fa9e4066Sahrens ZPOOL_STATUS_OK 308fa9e4066Sahrens } zpool_status_t; 309fa9e4066Sahrens 310ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 311ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 3129eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 313fa9e4066Sahrens 314fa9e4066Sahrens /* 315fa9e4066Sahrens * Statistics and configuration functions. 316fa9e4066Sahrens */ 317ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 31894de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 31955434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 320ea8dc4b6Seschrock 321fa9e4066Sahrens /* 322fa9e4066Sahrens * Import and export functions 323fa9e4066Sahrens */ 32489a89ebfSlling extern int zpool_export(zpool_handle_t *, boolean_t); 325394ab0cbSGeorge Wilson extern int zpool_export_force(zpool_handle_t *); 32699653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 327990b4856Slling char *altroot); 328990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 329c5904d13Seschrock nvlist_t *, boolean_t); 330fa9e4066Sahrens 331fa9e4066Sahrens /* 332fa9e4066Sahrens * Search for pools to import 333fa9e4066Sahrens */ 334d41c4376SMark J Musante 335d41c4376SMark J Musante typedef struct importargs { 336d41c4376SMark J Musante char **path; /* a list of paths to search */ 337d41c4376SMark J Musante int paths; /* number of paths to search */ 338d41c4376SMark J Musante char *poolname; /* name of a pool to find */ 339d41c4376SMark J Musante uint64_t guid; /* guid of a pool to find */ 340d41c4376SMark J Musante char *cachefile; /* cachefile to use for import */ 341d41c4376SMark J Musante int can_be_active : 1; /* can the pool be active? */ 342d41c4376SMark J Musante int unique : 1; /* does 'poolname' already exist? */ 343d41c4376SMark J Musante int exists : 1; /* set on return if pool already exists */ 344d41c4376SMark J Musante } importargs_t; 345d41c4376SMark J Musante 346d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 347d41c4376SMark J Musante 348d41c4376SMark J Musante /* legacy pool search routines */ 34924e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3503a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 351e829d913Sck char *, uint64_t); 352fa9e4066Sahrens 353c67d9675Seschrock /* 354c67d9675Seschrock * Miscellaneous pool functions 355c67d9675Seschrock */ 356ecd6cf80Smarks struct zfs_cmd; 357ecd6cf80Smarks 358*3f9d6ad7SLin Ling extern const char *zfs_history_event_names[LOG_END]; 3598f18d1faSGeorge Wilson 36088ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 36188ecc943SGeorge Wilson boolean_t verbose); 362990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 36306eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 3648f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 3658f18d1faSGeorge Wilson nvlist_t ***, uint_t *); 3662a6b87f0Sek extern void zpool_set_history_str(const char *subcommand, int argc, 3672a6b87f0Sek char **argv, char *history_str); 3682a6b87f0Sek extern int zpool_stage_history(libzfs_handle_t *, const char *); 36955434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 37055434c77Sek size_t len); 371ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 372753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 373468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 374468c413aSTim Haley nvlist_t *); 375753a6d45SSherry Moore 376fa9e4066Sahrens /* 377fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 378fa9e4066Sahrens * underlying datasets, only the references to them. 379fa9e4066Sahrens */ 38099653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 381fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 382fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 383fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 384d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 385fa9e4066Sahrens 386fa9e4066Sahrens /* 387fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 388b81d61a6Slling * and are found in sys/fs/zfs.h. 389fa9e4066Sahrens */ 390990b4856Slling 391990b4856Slling /* 392990b4856Slling * zfs dataset property management 393990b4856Slling */ 394990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 395990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 396990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t); 397990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t); 398990b4856Slling 3990a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 4000a48a24eStimh nvlist_t *, uint64_t, zfs_handle_t *, const char *); 4010a48a24eStimh 402e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t); 403e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 404e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 405990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 40692241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 40792241e0bSTom Erickson boolean_t); 408e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 409990b4856Slling zprop_source_t *, char *, size_t); 410edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 411edea4b55SLin Ling uint64_t *propvalue); 41214843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 41314843421SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 414e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 41592241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 416e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t); 417e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop); 418990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 41992241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 420e9dbad6fSeschrock 421990b4856Slling typedef struct zprop_list { 422990b4856Slling int pl_prop; 423e9dbad6fSeschrock char *pl_user_prop; 424990b4856Slling struct zprop_list *pl_next; 425e9dbad6fSeschrock boolean_t pl_all; 426e9dbad6fSeschrock size_t pl_width; 42792241e0bSTom Erickson size_t pl_recvd_width; 428e9dbad6fSeschrock boolean_t pl_fixed; 429990b4856Slling } zprop_list_t; 430e9dbad6fSeschrock 43192241e0bSTom Erickson extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t); 4322e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 433fa9e4066Sahrens 434fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 435fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 436fa9e4066Sahrens 437b1b8ab34Slling /* 438990b4856Slling * zpool property management 439990b4856Slling */ 440990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 441990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 442990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 443990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 444990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 445990b4856Slling 446990b4856Slling /* 447990b4856Slling * Functions shared by zfs and zpool property management. 448b1b8ab34Slling */ 449990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 450990b4856Slling boolean_t ordered, zfs_type_t type); 451990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 452990b4856Slling zfs_type_t); 453990b4856Slling extern void zprop_free_list(zprop_list_t *); 454990b4856Slling 45592241e0bSTom Erickson #define ZFS_GET_NCOLS 5 45692241e0bSTom Erickson 45792241e0bSTom Erickson typedef enum { 45892241e0bSTom Erickson GET_COL_NONE, 45992241e0bSTom Erickson GET_COL_NAME, 46092241e0bSTom Erickson GET_COL_PROPERTY, 46192241e0bSTom Erickson GET_COL_VALUE, 46292241e0bSTom Erickson GET_COL_RECVD, 46392241e0bSTom Erickson GET_COL_SOURCE 46492241e0bSTom Erickson } zfs_get_column_t; 46592241e0bSTom Erickson 466990b4856Slling /* 467990b4856Slling * Functions for printing zfs or zpool properties 468990b4856Slling */ 469990b4856Slling typedef struct zprop_get_cbdata { 470b1b8ab34Slling int cb_sources; 47192241e0bSTom Erickson zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 47292241e0bSTom Erickson int cb_colwidths[ZFS_GET_NCOLS + 1]; 473b1b8ab34Slling boolean_t cb_scripted; 474b1b8ab34Slling boolean_t cb_literal; 475b1b8ab34Slling boolean_t cb_first; 476990b4856Slling zprop_list_t *cb_proplist; 477990b4856Slling zfs_type_t cb_type; 478990b4856Slling } zprop_get_cbdata_t; 479b1b8ab34Slling 480990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 48192241e0bSTom Erickson const char *, const char *, zprop_source_t, const char *, 48292241e0bSTom Erickson const char *); 483b1b8ab34Slling 484fa9e4066Sahrens /* 485fa9e4066Sahrens * Iterator functions. 486fa9e4066Sahrens */ 487fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 48899653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 489fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4903bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4917f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4927f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 493ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 494fa9e4066Sahrens 495fa9e4066Sahrens /* 496fa9e4066Sahrens * Functions to create and destroy datasets. 497fa9e4066Sahrens */ 49899653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 499e9dbad6fSeschrock nvlist_t *); 5007f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 501842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t); 502842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 503e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 504bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 505c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 5067f1f55eaSvb extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 5079e69d7d0SLori Alt 5089e69d7d0SLori Alt typedef struct sendflags { 5099e69d7d0SLori Alt /* print informational messages (ie, -v was specified) */ 5109e69d7d0SLori Alt int verbose : 1; 5119e69d7d0SLori Alt 51292241e0bSTom Erickson /* recursive send (ie, -R) */ 5139e69d7d0SLori Alt int replicate : 1; 5149e69d7d0SLori Alt 5159e69d7d0SLori Alt /* for incrementals, do all intermediate snapshots */ 51692241e0bSTom Erickson int doall : 1; /* (ie, -I) */ 5179e69d7d0SLori Alt 5189e69d7d0SLori Alt /* if dataset is a clone, do incremental from its origin */ 5199e69d7d0SLori Alt int fromorigin : 1; 5209e69d7d0SLori Alt 5219e69d7d0SLori Alt /* do deduplication */ 5229e69d7d0SLori Alt int dedup : 1; 52392241e0bSTom Erickson 52492241e0bSTom Erickson /* send properties (ie, -p) */ 52592241e0bSTom Erickson int props : 1; 5269e69d7d0SLori Alt } sendflags_t; 5279e69d7d0SLori Alt 5289e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 5299e69d7d0SLori Alt 530*3f9d6ad7SLin Ling extern int zfs_send(zfs_handle_t *zhp, const char *fromsnap, const char *tosnap, 531*3f9d6ad7SLin Ling sendflags_t flags, int outfd, snapfilter_cb_t filter_func, 532*3f9d6ad7SLin Ling void *cb_arg, nvlist_t **debugnvp); 5339e69d7d0SLori Alt 53499653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 535ca45db41SChris Kirby extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t, 536818119b8SChris Kirby boolean_t, boolean_t); 537ca45db41SChris Kirby extern int zfs_hold_range(zfs_handle_t *, const char *, const char *, 53854a91118SChris Kirby const char *, boolean_t, boolean_t, snapfilter_cb_t, void *); 539842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 540ca45db41SChris Kirby extern int zfs_release_range(zfs_handle_t *, const char *, const char *, 541620252bcSChris Kirby const char *, boolean_t); 542c1449561SEric Taylor extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); 543fa9e4066Sahrens 5440aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 54514843421SMatthew Ahrens uid_t rid, uint64_t space); 54614843421SMatthew Ahrens 54714843421SMatthew Ahrens extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type, 54814843421SMatthew Ahrens zfs_userspace_cb_t func, void *arg); 54914843421SMatthew Ahrens 5503cb34c60Sahrens typedef struct recvflags { 5514ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 552c6765aabSeschrock int verbose : 1; 5534ccbb6e7Sahrens 5544ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 555c6765aabSeschrock int isprefix : 1; 5564ccbb6e7Sahrens 557f64930f5STom Erickson /* 558f64930f5STom Erickson * Only the tail of the sent snapshot path is appended to the 559f64930f5STom Erickson * destination to determine the received snapshot name (ie, -e). 560f64930f5STom Erickson */ 561f64930f5STom Erickson int istail : 1; 562f64930f5STom Erickson 5634ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 564c6765aabSeschrock int dryrun : 1; 5654ccbb6e7Sahrens 5664ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 567c6765aabSeschrock int force : 1; 5684ccbb6e7Sahrens 5694ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 570c6765aabSeschrock int canmountoff : 1; 5714ccbb6e7Sahrens 5724ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 573c6765aabSeschrock int byteswap : 1; 57433408eefSLori Alt 57533408eefSLori Alt /* do not mount file systems as they are extracted (private) */ 57633408eefSLori Alt int nomount : 1; 5773cb34c60Sahrens } recvflags_t; 5783cb34c60Sahrens 5793cb34c60Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 5803cb34c60Sahrens int, avl_tree_t *); 5813cb34c60Sahrens 582fa9e4066Sahrens /* 583fa9e4066Sahrens * Miscellaneous functions. 584fa9e4066Sahrens */ 585fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 586fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 587fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 5885aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 5897f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 5907f1f55eaSvb zfs_type_t); 5917b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *); 592fa9e4066Sahrens 593fa9e4066Sahrens /* 594fa9e4066Sahrens * Mount support functions. 595fa9e4066Sahrens */ 59655434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 59799653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 598fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 599fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 600fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 601fa9e4066Sahrens 602fa9e4066Sahrens /* 603fa9e4066Sahrens * Share support functions. 604fa9e4066Sahrens */ 605f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 606fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 607f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 608f3861e1aSahl 609f3861e1aSahl /* 6103d7072f8Seschrock * Protocol-specific share support functions. 611f3861e1aSahl */ 612f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 613da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 614f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 615da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 616da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 617f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 618da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 619f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 620da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 621da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 622da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 623743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 624da6c28aaSamw void *, void *, int, zfs_share_op_t); 625fa9e4066Sahrens 626fa9e4066Sahrens /* 627fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 628fa9e4066Sahrens */ 629fa9e4066Sahrens #ifdef NDEBUG 630fa9e4066Sahrens #define verify(EX) ((void)(EX)) 631fa9e4066Sahrens #else 632fa9e4066Sahrens #define verify(EX) assert(EX) 633fa9e4066Sahrens #endif 634fa9e4066Sahrens 635fa9e4066Sahrens /* 636fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 637fa9e4066Sahrens */ 638fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 639e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 640fa9e4066Sahrens 641fa9e4066Sahrens /* 642fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 643fa9e4066Sahrens */ 64499653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 64599653d4eSeschrock boolean_t *); 646fa9e4066Sahrens 647fa9e4066Sahrens /* 648096d22d4SEric Schrock * Label manipulation. 649fa9e4066Sahrens */ 65099653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 651096d22d4SEric Schrock extern int zpool_clear_label(int); 652fa9e4066Sahrens 653e7cbe64fSgw /* is this zvol valid for use as a dump device? */ 654e7cbe64fSgw extern int zvol_check_dump_config(char *); 655e7cbe64fSgw 656743a77edSAlan Wright /* 657743a77edSAlan Wright * Management interfaces for SMB ACL files 658743a77edSAlan Wright */ 659743a77edSAlan Wright 660743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 661743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 662743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 663743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 664743a77edSAlan Wright 6653bb79becSeschrock /* 666f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 667f3861e1aSahl * sharing/unsharing them. 6683bb79becSeschrock */ 669f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 670f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 6713bb79becSeschrock 672069f55e2SEric Schrock /* 673069f55e2SEric Schrock * Mappings between vdev and FRU. 674069f55e2SEric Schrock */ 675069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *); 676069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 677069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 678069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 679069f55e2SEric Schrock const char *); 680069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 681069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 682069f55e2SEric Schrock 683fa9e4066Sahrens #ifdef __cplusplus 684fa9e4066Sahrens } 685fa9e4066Sahrens #endif 686fa9e4066Sahrens 687fa9e4066Sahrens #endif /* _LIBZFS_H */ 688