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 /* 23818119b8SChris Kirby * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 24fa9e4066Sahrens * Use is subject to license terms. 25fa9e4066Sahrens */ 26fa9e4066Sahrens 27fa9e4066Sahrens #ifndef _LIBZFS_H 28fa9e4066Sahrens #define _LIBZFS_H 29fa9e4066Sahrens 30fa9e4066Sahrens #include <assert.h> 31fa9e4066Sahrens #include <libnvpair.h> 32ebedde84SEric Taylor #include <sys/mnttab.h> 33fa9e4066Sahrens #include <sys/param.h> 34fa9e4066Sahrens #include <sys/types.h> 35fa9e4066Sahrens #include <sys/varargs.h> 36fa9e4066Sahrens #include <sys/fs/zfs.h> 37ecd6cf80Smarks #include <sys/avl.h> 38ecd6cf80Smarks #include <ucred.h> 39fa9e4066Sahrens 40fa9e4066Sahrens #ifdef __cplusplus 41fa9e4066Sahrens extern "C" { 42fa9e4066Sahrens #endif 43fa9e4066Sahrens 44fa9e4066Sahrens /* 45fa9e4066Sahrens * Miscellaneous ZFS constants 46fa9e4066Sahrens */ 47fa9e4066Sahrens #define ZFS_MAXNAMELEN MAXNAMELEN 48fa9e4066Sahrens #define ZPOOL_MAXNAMELEN MAXNAMELEN 49fa9e4066Sahrens #define ZFS_MAXPROPLEN MAXPATHLEN 50990b4856Slling #define ZPOOL_MAXPROPLEN MAXPATHLEN 51fa9e4066Sahrens 52fa9e4066Sahrens /* 5399653d4eSeschrock * libzfs errors 5499653d4eSeschrock */ 5599653d4eSeschrock enum { 5699653d4eSeschrock EZFS_NOMEM = 2000, /* out of memory */ 5799653d4eSeschrock EZFS_BADPROP, /* invalid property value */ 5899653d4eSeschrock EZFS_PROPREADONLY, /* cannot set readonly property */ 5999653d4eSeschrock EZFS_PROPTYPE, /* property does not apply to dataset type */ 6099653d4eSeschrock EZFS_PROPNONINHERIT, /* property is not inheritable */ 6199653d4eSeschrock EZFS_PROPSPACE, /* bad quota or reservation */ 6299653d4eSeschrock EZFS_BADTYPE, /* dataset is not of appropriate type */ 6399653d4eSeschrock EZFS_BUSY, /* pool or dataset is busy */ 6499653d4eSeschrock EZFS_EXISTS, /* pool or dataset already exists */ 6599653d4eSeschrock EZFS_NOENT, /* no such pool or dataset */ 6699653d4eSeschrock EZFS_BADSTREAM, /* bad backup stream */ 6799653d4eSeschrock EZFS_DSREADONLY, /* dataset is readonly */ 6899653d4eSeschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 6999653d4eSeschrock EZFS_INVALIDNAME, /* invalid dataset name */ 7099653d4eSeschrock EZFS_BADRESTORE, /* unable to restore to destination */ 7199653d4eSeschrock EZFS_BADBACKUP, /* backup failed */ 7299653d4eSeschrock EZFS_BADTARGET, /* bad attach/detach/replace target */ 7399653d4eSeschrock EZFS_NODEVICE, /* no such device in pool */ 7499653d4eSeschrock EZFS_BADDEV, /* invalid device to add */ 7599653d4eSeschrock EZFS_NOREPLICAS, /* no valid replicas */ 7699653d4eSeschrock EZFS_RESILVERING, /* currently resilvering */ 7799653d4eSeschrock EZFS_BADVERSION, /* unsupported version */ 7899653d4eSeschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 7999653d4eSeschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 8099653d4eSeschrock EZFS_BADPATH, /* must be an absolute path */ 8199653d4eSeschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 8299653d4eSeschrock EZFS_ZONED, /* used improperly in local zone */ 8399653d4eSeschrock EZFS_MOUNTFAILED, /* failed to mount dataset */ 8499653d4eSeschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 85f3861e1aSahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 86f3861e1aSahl EZFS_SHARENFSFAILED, /* share(1M) failed */ 8799653d4eSeschrock EZFS_PERM, /* permission denied */ 8899653d4eSeschrock EZFS_NOSPC, /* out of space */ 89*6e27f868SSam Falkner EZFS_FAULT, /* bad address */ 9099653d4eSeschrock EZFS_IO, /* I/O error */ 9199653d4eSeschrock EZFS_INTR, /* signal received */ 9299653d4eSeschrock EZFS_ISSPARE, /* device is a hot spare */ 9399653d4eSeschrock EZFS_INVALCONFIG, /* invalid vdev configuration */ 943bb79becSeschrock EZFS_RECURSIVE, /* recursive dependency */ 9506eeb2adSek110237 EZFS_NOHISTORY, /* no history object */ 96f3861e1aSahl EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 97f3861e1aSahl EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 98b1b8ab34Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 99b1b8ab34Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 100b1b8ab34Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 101b7661cccSmmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 1028488aeb5Staylor EZFS_OPENFAILED, /* open of device failed */ 1038488aeb5Staylor EZFS_NOCAP, /* couldn't get capacity */ 1048488aeb5Staylor EZFS_LABELFAILED, /* write of label failed */ 105ecd6cf80Smarks EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 106ecd6cf80Smarks EZFS_BADWHO, /* invalid permission who */ 107ecd6cf80Smarks EZFS_BADPERM, /* invalid permission */ 108ecd6cf80Smarks EZFS_BADPERMSET, /* invalid permission set name */ 109ecd6cf80Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 110ecd6cf80Smarks EZFS_PERMRDONLY, /* pemissions are readonly */ 111da6c28aaSamw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 112da6c28aaSamw EZFS_SHARESMBFAILED, /* failed to share over smb */ 1132f8aaab3Seschrock EZFS_BADCACHE, /* bad cache file */ 114fa94a07fSbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 115e7cbe64fSgw25295 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 11615e6edf1Sgw25295 EZFS_NOTSUP, /* ops not supported on this dataset */ 11789a89ebfSlling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 118e6ca193dSGeorge Wilson EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 119842727c2SChris Kirby EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 120842727c2SChris Kirby EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 121ca45db41SChris Kirby EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 1229e69d7d0SLori Alt EZFS_PIPEFAILED, /* pipe create failed */ 1239e69d7d0SLori Alt EZFS_THREADCREATEFAILED, /* thread create failed */ 1241195e687SMark J Musante EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 125b1b8ab34Slling EZFS_UNKNOWN 12699653d4eSeschrock }; 12799653d4eSeschrock 12899653d4eSeschrock /* 129ecd6cf80Smarks * The following data structures are all part 130ecd6cf80Smarks * of the zfs_allow_t data structure which is 131ecd6cf80Smarks * used for printing 'allow' permissions. 132ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 133ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 134ecd6cf80Smarks * and each one of the entries in those trees have 135ecd6cf80Smarks * avl tree's for the permissions they belong to and 136ecd6cf80Smarks * whether they are local,descendent or local+descendent 137ecd6cf80Smarks * permissions. The AVL trees are used primarily for 138ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 139ecd6cf80Smarks * a given user and or permission. 140ecd6cf80Smarks */ 141ecd6cf80Smarks typedef struct zfs_perm_node { 142ecd6cf80Smarks avl_node_t z_node; 143ecd6cf80Smarks char z_pname[MAXPATHLEN]; 144ecd6cf80Smarks } zfs_perm_node_t; 145ecd6cf80Smarks 146ecd6cf80Smarks typedef struct zfs_allow_node { 147ecd6cf80Smarks avl_node_t z_node; 148ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 149ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 150ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 151ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 152ecd6cf80Smarks } zfs_allow_node_t; 153ecd6cf80Smarks 154ecd6cf80Smarks typedef struct zfs_allow { 155ecd6cf80Smarks struct zfs_allow *z_next; 156ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 157ecd6cf80Smarks avl_tree_t z_sets; 158ecd6cf80Smarks avl_tree_t z_crperms; 159ecd6cf80Smarks avl_tree_t z_user; 160ecd6cf80Smarks avl_tree_t z_group; 161ecd6cf80Smarks avl_tree_t z_everyone; 162ecd6cf80Smarks } zfs_allow_t; 163ecd6cf80Smarks 164ecd6cf80Smarks /* 165fa9e4066Sahrens * Basic handle types 166fa9e4066Sahrens */ 167fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 168fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 16999653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 17099653d4eSeschrock 17199653d4eSeschrock /* 17299653d4eSeschrock * Library initialization 17399653d4eSeschrock */ 17499653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 17599653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 17699653d4eSeschrock 17799653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 17899653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 17999653d4eSeschrock 18099653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 18199653d4eSeschrock 18299653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 18399653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 18499653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 185ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 186ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 187b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 188ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 189ebedde84SEric Taylor struct mnttab *); 190ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 191ebedde84SEric Taylor const char *, const char *); 192ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 193fa9e4066Sahrens 194fa9e4066Sahrens /* 195fa9e4066Sahrens * Basic handle functions 196fa9e4066Sahrens */ 19799653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 19899653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 199fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 200fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 201fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 202990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 20329ab75c9Srm160521 extern void zpool_free_handles(libzfs_handle_t *); 204fa9e4066Sahrens 205fa9e4066Sahrens /* 206fa9e4066Sahrens * Iterate over all active pools in the system. 207fa9e4066Sahrens */ 208fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 20999653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 210fa9e4066Sahrens 211fa9e4066Sahrens /* 212fa9e4066Sahrens * Functions to create and destroy pools 213fa9e4066Sahrens */ 21499653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2150a48a24eStimh nvlist_t *, nvlist_t *); 216fa9e4066Sahrens extern int zpool_destroy(zpool_handle_t *); 217fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 218fa9e4066Sahrens 2191195e687SMark J Musante typedef struct splitflags { 2201195e687SMark J Musante /* do not split, but return the config that would be split off */ 2211195e687SMark J Musante int dryrun : 1; 2221195e687SMark J Musante 2231195e687SMark J Musante /* after splitting, import the pool */ 2241195e687SMark J Musante int import : 1; 2251195e687SMark J Musante } splitflags_t; 2261195e687SMark J Musante 227fa9e4066Sahrens /* 228fa9e4066Sahrens * Functions to manipulate pool and vdev state 229fa9e4066Sahrens */ 230fa9e4066Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 231468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 232fa9e4066Sahrens 2333d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2343d7072f8Seschrock vdev_state_t *); 2353d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2363d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2373d7072f8Seschrock const char *, nvlist_t *, int); 238fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 23999653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2401195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 2411195e687SMark J Musante splitflags_t); 2423d7072f8Seschrock 243069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 244069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 2453d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2463d7072f8Seschrock 247fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 248ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 249573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 250573ca77eSGeorge Wilson boolean_t *, boolean_t *, boolean_t *); 2518488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 252fa9e4066Sahrens 253fa9e4066Sahrens /* 254b1b8ab34Slling * Functions to manage pool properties 255b1b8ab34Slling */ 256b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2573d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 258990b4856Slling size_t proplen, zprop_source_t *); 259990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 260990b4856Slling zprop_source_t *); 261990b4856Slling 262b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 263b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 264b1b8ab34Slling 265b1b8ab34Slling /* 266fa9e4066Sahrens * Pool health statistics. 267fa9e4066Sahrens */ 268fa9e4066Sahrens typedef enum { 269fa9e4066Sahrens /* 270fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 271b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 272fa9e4066Sahrens */ 273fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 274fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 275fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 276fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 277b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 278fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 279fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 280fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 281fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 282eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 28395173954Sek110237 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 28432b87932Sek110237 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 28532b87932Sek110237 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 286f67f35c3SEric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 287f67f35c3SEric Schrock 288f67f35c3SEric Schrock /* 289f67f35c3SEric Schrock * These faults have no corresponding message ID. At the time we are 290f67f35c3SEric Schrock * checking the status, the original reason for the FMA fault (I/O or 291f67f35c3SEric Schrock * checksum errors) has been lost. 292f67f35c3SEric Schrock */ 2933d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2943d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 295fa9e4066Sahrens 296fa9e4066Sahrens /* 297fa9e4066Sahrens * The following are not faults per se, but still an error possibly 298b81d61a6Slling * requiring administrative attention. There is no corresponding 299fa9e4066Sahrens * message ID. 300fa9e4066Sahrens */ 301eaca9bbdSeschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 302fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 303fa9e4066Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 304c25309d4SGeorge Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 305fa9e4066Sahrens 306fa9e4066Sahrens /* 307fa9e4066Sahrens * Finally, the following indicates a healthy pool. 308fa9e4066Sahrens */ 309fa9e4066Sahrens ZPOOL_STATUS_OK 310fa9e4066Sahrens } zpool_status_t; 311fa9e4066Sahrens 312ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 313ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 3149eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 315fa9e4066Sahrens 316fa9e4066Sahrens /* 317fa9e4066Sahrens * Statistics and configuration functions. 318fa9e4066Sahrens */ 319ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 32094de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 32155434c77Sek110237 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 322ea8dc4b6Seschrock 323fa9e4066Sahrens /* 324fa9e4066Sahrens * Import and export functions 325fa9e4066Sahrens */ 32689a89ebfSlling extern int zpool_export(zpool_handle_t *, boolean_t); 327394ab0cbSGeorge Wilson extern int zpool_export_force(zpool_handle_t *); 32899653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 329990b4856Slling char *altroot); 330990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 331c5904d13Seschrock nvlist_t *, boolean_t); 332fa9e4066Sahrens 333fa9e4066Sahrens /* 334fa9e4066Sahrens * Search for pools to import 335fa9e4066Sahrens */ 336d41c4376SMark J Musante 337d41c4376SMark J Musante typedef struct importargs { 338d41c4376SMark J Musante char **path; /* a list of paths to search */ 339d41c4376SMark J Musante int paths; /* number of paths to search */ 340d41c4376SMark J Musante char *poolname; /* name of a pool to find */ 341d41c4376SMark J Musante uint64_t guid; /* guid of a pool to find */ 342d41c4376SMark J Musante char *cachefile; /* cachefile to use for import */ 343d41c4376SMark J Musante int can_be_active : 1; /* can the pool be active? */ 344d41c4376SMark J Musante int unique : 1; /* does 'poolname' already exist? */ 345d41c4376SMark J Musante int exists : 1; /* set on return if pool already exists */ 346d41c4376SMark J Musante } importargs_t; 347d41c4376SMark J Musante 348d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 349d41c4376SMark J Musante 350d41c4376SMark J Musante /* legacy pool search routines */ 35124e697d4Sck153898 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3523a57275aSck153898 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 353e829d913Sck153898 char *, uint64_t); 354fa9e4066Sahrens 355fa9e4066Sahrens /* 356c67d9675Seschrock * Miscellaneous pool functions 357c67d9675Seschrock */ 358ecd6cf80Smarks struct zfs_cmd; 359ecd6cf80Smarks 3608f18d1faSGeorge Wilson extern const char *hist_event_table[LOG_END]; 3618f18d1faSGeorge Wilson 36288ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 36388ecc943SGeorge Wilson boolean_t verbose); 364990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 36506eeb2adSek110237 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 3668f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 3678f18d1faSGeorge Wilson nvlist_t ***, uint_t *); 3682a6b87f0Sek110237 extern void zpool_set_history_str(const char *subcommand, int argc, 3692a6b87f0Sek110237 char **argv, char *history_str); 3702a6b87f0Sek110237 extern int zpool_stage_history(libzfs_handle_t *, const char *); 37155434c77Sek110237 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 37255434c77Sek110237 size_t len); 373ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 374753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 375468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 376468c413aSTim Haley nvlist_t *); 377753a6d45SSherry Moore 378c67d9675Seschrock /* 379fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 380fa9e4066Sahrens * underlying datasets, only the references to them. 381fa9e4066Sahrens */ 38299653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 383fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 384fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 385fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 386d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 387fa9e4066Sahrens 388fa9e4066Sahrens /* 389fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 390b81d61a6Slling * and are found in sys/fs/zfs.h. 391fa9e4066Sahrens */ 392990b4856Slling 393990b4856Slling /* 394990b4856Slling * zfs dataset property management 395990b4856Slling */ 396990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 397e9dbad6fSeschrock extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 398e9dbad6fSeschrock extern const char *zfs_prop_column_name(zfs_prop_t); 399e9dbad6fSeschrock extern boolean_t zfs_prop_align_right(zfs_prop_t); 400e9dbad6fSeschrock 4010a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 4020a48a24eStimh nvlist_t *, uint64_t, zfs_handle_t *, const char *); 4030a48a24eStimh 404990b4856Slling extern const char *zfs_prop_to_name(zfs_prop_t); 405990b4856Slling extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 406990b4856Slling extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 407990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 40892241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 40992241e0bSTom Erickson boolean_t); 410990b4856Slling extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 411990b4856Slling zprop_source_t *, char *, size_t); 412edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 413edea4b55SLin Ling uint64_t *propvalue); 41414843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 41514843421SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 416990b4856Slling extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 41792241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 418990b4856Slling extern const char *zfs_prop_values(zfs_prop_t); 419990b4856Slling extern int zfs_prop_is_string(zfs_prop_t prop); 420990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 42192241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 422990b4856Slling 423990b4856Slling typedef struct zprop_list { 424990b4856Slling int pl_prop; 425e9dbad6fSeschrock char *pl_user_prop; 426990b4856Slling struct zprop_list *pl_next; 427e9dbad6fSeschrock boolean_t pl_all; 428e9dbad6fSeschrock size_t pl_width; 42992241e0bSTom Erickson size_t pl_recvd_width; 430e9dbad6fSeschrock boolean_t pl_fixed; 431990b4856Slling } zprop_list_t; 432e9dbad6fSeschrock 43392241e0bSTom Erickson extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t); 4342e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 435fa9e4066Sahrens 436fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 437fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 438fa9e4066Sahrens 439fa9e4066Sahrens /* 440990b4856Slling * zpool property management 441b1b8ab34Slling */ 442990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 443990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 444990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 445990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 446990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 447990b4856Slling 448990b4856Slling /* 449990b4856Slling * Functions shared by zfs and zpool property management. 450990b4856Slling */ 451990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 452990b4856Slling boolean_t ordered, zfs_type_t type); 453990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 454990b4856Slling zfs_type_t); 455990b4856Slling extern void zprop_free_list(zprop_list_t *); 456990b4856Slling 45792241e0bSTom Erickson #define ZFS_GET_NCOLS 5 45892241e0bSTom Erickson 45992241e0bSTom Erickson typedef enum { 46092241e0bSTom Erickson GET_COL_NONE, 46192241e0bSTom Erickson GET_COL_NAME, 46292241e0bSTom Erickson GET_COL_PROPERTY, 46392241e0bSTom Erickson GET_COL_VALUE, 46492241e0bSTom Erickson GET_COL_RECVD, 46592241e0bSTom Erickson GET_COL_SOURCE 46692241e0bSTom Erickson } zfs_get_column_t; 46792241e0bSTom Erickson 468990b4856Slling /* 469990b4856Slling * Functions for printing zfs or zpool properties 470990b4856Slling */ 471990b4856Slling typedef struct zprop_get_cbdata { 472b1b8ab34Slling int cb_sources; 47392241e0bSTom Erickson zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 47492241e0bSTom Erickson int cb_colwidths[ZFS_GET_NCOLS + 1]; 475b1b8ab34Slling boolean_t cb_scripted; 476b1b8ab34Slling boolean_t cb_literal; 477b1b8ab34Slling boolean_t cb_first; 478990b4856Slling zprop_list_t *cb_proplist; 479990b4856Slling zfs_type_t cb_type; 480990b4856Slling } zprop_get_cbdata_t; 481b1b8ab34Slling 482990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 48392241e0bSTom Erickson const char *, const char *, zprop_source_t, const char *, 48492241e0bSTom Erickson const char *); 485b1b8ab34Slling 486b1b8ab34Slling /* 487fa9e4066Sahrens * Iterator functions. 488fa9e4066Sahrens */ 489fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 49099653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 491fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4923bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4937f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4947f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 495ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 496fa9e4066Sahrens 497fa9e4066Sahrens /* 498fa9e4066Sahrens * Functions to create and destroy datasets. 499fa9e4066Sahrens */ 50099653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 501e9dbad6fSeschrock nvlist_t *); 5027f1f55eaSvb160487 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 503842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t); 504842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 505e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 506bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 507c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 5087f1f55eaSvb160487 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 5099e69d7d0SLori Alt 5109e69d7d0SLori Alt typedef struct sendflags { 5119e69d7d0SLori Alt /* print informational messages (ie, -v was specified) */ 5129e69d7d0SLori Alt int verbose : 1; 5139e69d7d0SLori Alt 51492241e0bSTom Erickson /* recursive send (ie, -R) */ 5159e69d7d0SLori Alt int replicate : 1; 5169e69d7d0SLori Alt 5179e69d7d0SLori Alt /* for incrementals, do all intermediate snapshots */ 51892241e0bSTom Erickson int doall : 1; /* (ie, -I) */ 5199e69d7d0SLori Alt 5209e69d7d0SLori Alt /* if dataset is a clone, do incremental from its origin */ 5219e69d7d0SLori Alt int fromorigin : 1; 5229e69d7d0SLori Alt 5239e69d7d0SLori Alt /* do deduplication */ 5249e69d7d0SLori Alt int dedup : 1; 52592241e0bSTom Erickson 52692241e0bSTom Erickson /* send properties (ie, -p) */ 52792241e0bSTom Erickson int props : 1; 5289e69d7d0SLori Alt } sendflags_t; 5299e69d7d0SLori Alt 5309e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 5319e69d7d0SLori Alt 5323cb34c60Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 5339e69d7d0SLori Alt sendflags_t, int, snapfilter_cb_t, void *); 5349e69d7d0SLori Alt 53599653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 536ca45db41SChris Kirby extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t, 537818119b8SChris Kirby boolean_t, boolean_t); 538ca45db41SChris Kirby extern int zfs_hold_range(zfs_handle_t *, const char *, const char *, 539620252bcSChris Kirby const char *, boolean_t, boolean_t); 540842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 541ca45db41SChris Kirby extern int zfs_release_range(zfs_handle_t *, const char *, const char *, 542620252bcSChris Kirby const char *, boolean_t); 543c1449561SEric Taylor extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); 544fa9e4066Sahrens 5450aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 54614843421SMatthew Ahrens uid_t rid, uint64_t space); 54714843421SMatthew Ahrens 54814843421SMatthew Ahrens extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type, 54914843421SMatthew Ahrens zfs_userspace_cb_t func, void *arg); 55014843421SMatthew Ahrens 5513cb34c60Sahrens typedef struct recvflags { 5524ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 553c6765aabSeschrock int verbose : 1; 5544ccbb6e7Sahrens 5554ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 556c6765aabSeschrock int isprefix : 1; 5574ccbb6e7Sahrens 558f64930f5STom Erickson /* 559f64930f5STom Erickson * Only the tail of the sent snapshot path is appended to the 560f64930f5STom Erickson * destination to determine the received snapshot name (ie, -e). 561f64930f5STom Erickson */ 562f64930f5STom Erickson int istail : 1; 563f64930f5STom Erickson 5644ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 565c6765aabSeschrock int dryrun : 1; 5664ccbb6e7Sahrens 5674ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 568c6765aabSeschrock int force : 1; 5694ccbb6e7Sahrens 5704ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 571c6765aabSeschrock int canmountoff : 1; 5724ccbb6e7Sahrens 5734ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 574c6765aabSeschrock int byteswap : 1; 57533408eefSLori Alt 57633408eefSLori Alt /* do not mount file systems as they are extracted (private) */ 57733408eefSLori Alt int nomount : 1; 5783cb34c60Sahrens } recvflags_t; 5793cb34c60Sahrens 5803cb34c60Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 5813cb34c60Sahrens int, avl_tree_t *); 5823cb34c60Sahrens 583fa9e4066Sahrens /* 584fa9e4066Sahrens * Miscellaneous functions. 585fa9e4066Sahrens */ 586fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 587fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 588fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 5895aba80dbSck153898 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 5907f1f55eaSvb160487 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 5917f1f55eaSvb160487 zfs_type_t); 5927b97dc1aSrm160521 extern int zfs_spa_version(zfs_handle_t *, int *); 593fa9e4066Sahrens 594fa9e4066Sahrens /* 595fa9e4066Sahrens * Mount support functions. 596fa9e4066Sahrens */ 59755434c77Sek110237 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 59899653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 599fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 600fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 601fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 602fa9e4066Sahrens 603fa9e4066Sahrens /* 604fa9e4066Sahrens * Share support functions. 605fa9e4066Sahrens */ 606f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 607fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 608f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 609f3861e1aSahl 610f3861e1aSahl /* 6113d7072f8Seschrock * Protocol-specific share support functions. 612f3861e1aSahl */ 613f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 614da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 615f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 616da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 617da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 618f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 619da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 620f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 621da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 622da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 623da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 624f3861e1aSahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 625f3861e1aSahl extern int zfs_share_iscsi(zfs_handle_t *); 626f3861e1aSahl extern int zfs_unshare_iscsi(zfs_handle_t *); 627ecd6cf80Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 628743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 629da6c28aaSamw void *, void *, int, zfs_share_op_t); 630fa9e4066Sahrens 631fa9e4066Sahrens /* 632fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 633fa9e4066Sahrens */ 634fa9e4066Sahrens #ifdef NDEBUG 635fa9e4066Sahrens #define verify(EX) ((void)(EX)) 636fa9e4066Sahrens #else 637fa9e4066Sahrens #define verify(EX) assert(EX) 638fa9e4066Sahrens #endif 639fa9e4066Sahrens 640fa9e4066Sahrens /* 641fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 642fa9e4066Sahrens */ 643fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 644e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 645fa9e4066Sahrens 646fa9e4066Sahrens /* 647fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 648fa9e4066Sahrens */ 64999653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 65099653d4eSeschrock boolean_t *); 651fa9e4066Sahrens 652fa9e4066Sahrens /* 653096d22d4SEric Schrock * Label manipulation. 654fa9e4066Sahrens */ 65599653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 656096d22d4SEric Schrock extern int zpool_clear_label(int); 657fa9e4066Sahrens 658e7cbe64fSgw25295 /* is this zvol valid for use as a dump device? */ 659e7cbe64fSgw25295 extern int zvol_check_dump_config(char *); 660e7cbe64fSgw25295 6613bb79becSeschrock /* 662743a77edSAlan Wright * Management interfaces for SMB ACL files 663743a77edSAlan Wright */ 664743a77edSAlan Wright 665743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 666743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 667743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 668743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 669743a77edSAlan Wright 670743a77edSAlan Wright /* 671f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 672f3861e1aSahl * sharing/unsharing them. 6733bb79becSeschrock */ 674f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 675f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 6763bb79becSeschrock 677069f55e2SEric Schrock /* 678069f55e2SEric Schrock * Mappings between vdev and FRU. 679069f55e2SEric Schrock */ 680069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *); 681069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 682069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 683069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 684069f55e2SEric Schrock const char *); 685069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 686069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 687069f55e2SEric Schrock 688fa9e4066Sahrens #ifdef __cplusplus 689fa9e4066Sahrens } 690fa9e4066Sahrens #endif 691fa9e4066Sahrens 692fa9e4066Sahrens #endif /* _LIBZFS_H */ 693