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 /* 2333408eefSLori Alt * Copyright 2009 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 5299653d4eSeschrock /* 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 */ 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 */ 95f3861e1aSahl EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 96f3861e1aSahl EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 97b1b8ab34Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 98b1b8ab34Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 99b1b8ab34Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 100b7661cccSmmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 1018488aeb5Staylor EZFS_OPENFAILED, /* open of device failed */ 1028488aeb5Staylor EZFS_NOCAP, /* couldn't get capacity */ 1038488aeb5Staylor EZFS_LABELFAILED, /* write of label failed */ 104ecd6cf80Smarks EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 105ecd6cf80Smarks EZFS_BADWHO, /* invalid permission who */ 106ecd6cf80Smarks EZFS_BADPERM, /* invalid permission */ 107ecd6cf80Smarks EZFS_BADPERMSET, /* invalid permission set name */ 108ecd6cf80Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 109ecd6cf80Smarks EZFS_PERMRDONLY, /* pemissions are readonly */ 110da6c28aaSamw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 111da6c28aaSamw EZFS_SHARESMBFAILED, /* failed to share over smb */ 1122f8aaab3Seschrock EZFS_BADCACHE, /* bad cache file */ 113fa94a07fSbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 114e7cbe64fSgw EZFS_VDEVNOTSUP, /* unsupported vdev type */ 11515e6edf1Sgw EZFS_NOTSUP, /* ops not supported on this dataset */ 11689a89ebfSlling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 117e6ca193dSGeorge Wilson EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 118842727c2SChris Kirby EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 119842727c2SChris Kirby EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 120ca45db41SChris Kirby EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 121b1b8ab34Slling EZFS_UNKNOWN 12299653d4eSeschrock }; 12399653d4eSeschrock 124ecd6cf80Smarks /* 125ecd6cf80Smarks * The following data structures are all part 126ecd6cf80Smarks * of the zfs_allow_t data structure which is 127ecd6cf80Smarks * used for printing 'allow' permissions. 128ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 129ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 130ecd6cf80Smarks * and each one of the entries in those trees have 131ecd6cf80Smarks * avl tree's for the permissions they belong to and 132ecd6cf80Smarks * whether they are local,descendent or local+descendent 133ecd6cf80Smarks * permissions. The AVL trees are used primarily for 134ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 135ecd6cf80Smarks * a given user and or permission. 136ecd6cf80Smarks */ 137ecd6cf80Smarks typedef struct zfs_perm_node { 138ecd6cf80Smarks avl_node_t z_node; 139ecd6cf80Smarks char z_pname[MAXPATHLEN]; 140ecd6cf80Smarks } zfs_perm_node_t; 141ecd6cf80Smarks 142ecd6cf80Smarks typedef struct zfs_allow_node { 143ecd6cf80Smarks avl_node_t z_node; 144ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 145ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 146ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 147ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 148ecd6cf80Smarks } zfs_allow_node_t; 149ecd6cf80Smarks 150ecd6cf80Smarks typedef struct zfs_allow { 151ecd6cf80Smarks struct zfs_allow *z_next; 152ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 153ecd6cf80Smarks avl_tree_t z_sets; 154ecd6cf80Smarks avl_tree_t z_crperms; 155ecd6cf80Smarks avl_tree_t z_user; 156ecd6cf80Smarks avl_tree_t z_group; 157ecd6cf80Smarks avl_tree_t z_everyone; 158ecd6cf80Smarks } zfs_allow_t; 159ecd6cf80Smarks 160fa9e4066Sahrens /* 161fa9e4066Sahrens * Basic handle types 162fa9e4066Sahrens */ 163fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 164fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 16599653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 16699653d4eSeschrock 16799653d4eSeschrock /* 16899653d4eSeschrock * Library initialization 16999653d4eSeschrock */ 17099653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 17199653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 17299653d4eSeschrock 17399653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 17499653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 17599653d4eSeschrock 17699653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 17799653d4eSeschrock 17899653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 17999653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 18099653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 181ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 182ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 183b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 184ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 185ebedde84SEric Taylor struct mnttab *); 186ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 187ebedde84SEric Taylor const char *, const char *); 188ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 189fa9e4066Sahrens 190fa9e4066Sahrens /* 191fa9e4066Sahrens * Basic handle functions 192fa9e4066Sahrens */ 19399653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 19499653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 195fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 196fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 197fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 198990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 19929ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *); 200fa9e4066Sahrens 201fa9e4066Sahrens /* 202fa9e4066Sahrens * Iterate over all active pools in the system. 203fa9e4066Sahrens */ 204fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 20599653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 206fa9e4066Sahrens 207fa9e4066Sahrens /* 208fa9e4066Sahrens * Functions to create and destroy pools 209fa9e4066Sahrens */ 21099653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2110a48a24eStimh nvlist_t *, nvlist_t *); 212fa9e4066Sahrens extern int zpool_destroy(zpool_handle_t *); 213fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 214fa9e4066Sahrens 215fa9e4066Sahrens /* 216fa9e4066Sahrens * Functions to manipulate pool and vdev state 217fa9e4066Sahrens */ 218fa9e4066Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 2193d7072f8Seschrock extern int zpool_clear(zpool_handle_t *, const char *); 220fa9e4066Sahrens 2213d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2223d7072f8Seschrock vdev_state_t *); 2233d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2243d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2253d7072f8Seschrock const char *, nvlist_t *, int); 226fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 22799653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2283d7072f8Seschrock 2293d7072f8Seschrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 2303d7072f8Seschrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 2313d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2323d7072f8Seschrock 233fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 234ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 235573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 236573ca77eSGeorge Wilson boolean_t *, boolean_t *, boolean_t *); 2378488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 238fa9e4066Sahrens 239b1b8ab34Slling /* 240b1b8ab34Slling * Functions to manage pool properties 241b1b8ab34Slling */ 242b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2433d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 244990b4856Slling size_t proplen, zprop_source_t *); 245990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 246990b4856Slling zprop_source_t *); 247990b4856Slling 248b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 249b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 250b1b8ab34Slling 251fa9e4066Sahrens /* 252fa9e4066Sahrens * Pool health statistics. 253fa9e4066Sahrens */ 254fa9e4066Sahrens typedef enum { 255fa9e4066Sahrens /* 256fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 257b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 258fa9e4066Sahrens */ 259fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 260fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 261fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 262fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 263b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 264fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 265fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 266fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 267fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 268eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 26995173954Sek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 27032b87932Sek ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 27132b87932Sek ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 272f67f35c3SEric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 273f67f35c3SEric Schrock 274f67f35c3SEric Schrock /* 275f67f35c3SEric Schrock * These faults have no corresponding message ID. At the time we are 276f67f35c3SEric Schrock * checking the status, the original reason for the FMA fault (I/O or 277f67f35c3SEric Schrock * checksum errors) has been lost. 278f67f35c3SEric Schrock */ 2793d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2803d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 281fa9e4066Sahrens 282fa9e4066Sahrens /* 283fa9e4066Sahrens * The following are not faults per se, but still an error possibly 284b81d61a6Slling * requiring administrative attention. There is no corresponding 285fa9e4066Sahrens * message ID. 286fa9e4066Sahrens */ 287eaca9bbdSeschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 288fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 289fa9e4066Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 290c25309d4SGeorge Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 291fa9e4066Sahrens 292fa9e4066Sahrens /* 293fa9e4066Sahrens * Finally, the following indicates a healthy pool. 294fa9e4066Sahrens */ 295fa9e4066Sahrens ZPOOL_STATUS_OK 296fa9e4066Sahrens } zpool_status_t; 297fa9e4066Sahrens 298ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 299ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 300fa9e4066Sahrens 301fa9e4066Sahrens /* 302fa9e4066Sahrens * Statistics and configuration functions. 303fa9e4066Sahrens */ 304ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 30594de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 30655434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 307ea8dc4b6Seschrock 308fa9e4066Sahrens /* 309fa9e4066Sahrens * Import and export functions 310fa9e4066Sahrens */ 31189a89ebfSlling extern int zpool_export(zpool_handle_t *, boolean_t); 312394ab0cbSGeorge Wilson extern int zpool_export_force(zpool_handle_t *); 31399653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 314990b4856Slling char *altroot); 315990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 316c5904d13Seschrock nvlist_t *, boolean_t); 317fa9e4066Sahrens 318fa9e4066Sahrens /* 319fa9e4066Sahrens * Search for pools to import 320fa9e4066Sahrens */ 32124e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3223a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 323e829d913Sck char *, uint64_t); 32424e697d4Sck extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **, 32524e697d4Sck char *); 32624e697d4Sck extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **, 32724e697d4Sck uint64_t); 32824e697d4Sck extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **); 329fa9e4066Sahrens 330c67d9675Seschrock /* 331c67d9675Seschrock * Miscellaneous pool functions 332c67d9675Seschrock */ 333ecd6cf80Smarks struct zfs_cmd; 334ecd6cf80Smarks 335*8f18d1faSGeorge Wilson extern const char *hist_event_table[LOG_END]; 336*8f18d1faSGeorge Wilson 33788ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 33888ecc943SGeorge Wilson boolean_t verbose); 339990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 34006eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 341*8f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 342*8f18d1faSGeorge Wilson nvlist_t ***, uint_t *); 3432a6b87f0Sek extern void zpool_set_history_str(const char *subcommand, int argc, 3442a6b87f0Sek char **argv, char *history_str); 3452a6b87f0Sek extern int zpool_stage_history(libzfs_handle_t *, const char *); 34655434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 34755434c77Sek size_t len); 348ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 349753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 350753a6d45SSherry Moore 351fa9e4066Sahrens /* 352fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 353fa9e4066Sahrens * underlying datasets, only the references to them. 354fa9e4066Sahrens */ 35599653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 356fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 357fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 358fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 359d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 360fa9e4066Sahrens 361fa9e4066Sahrens /* 362fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 363b81d61a6Slling * and are found in sys/fs/zfs.h. 364fa9e4066Sahrens */ 365990b4856Slling 366990b4856Slling /* 367990b4856Slling * zfs dataset property management 368990b4856Slling */ 369990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 370990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 371990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t); 372990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t); 373990b4856Slling 3740a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 3750a48a24eStimh nvlist_t *, uint64_t, zfs_handle_t *, const char *); 3760a48a24eStimh 377e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t); 378e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 379e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 380990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 381e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 382990b4856Slling zprop_source_t *, char *, size_t); 383edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 384edea4b55SLin Ling uint64_t *propvalue); 38514843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 38614843421SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 387e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 388e9dbad6fSeschrock extern int zfs_prop_inherit(zfs_handle_t *, const char *); 389e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t); 390e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop); 391990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 392e9dbad6fSeschrock 393990b4856Slling typedef struct zprop_list { 394990b4856Slling int pl_prop; 395e9dbad6fSeschrock char *pl_user_prop; 396990b4856Slling struct zprop_list *pl_next; 397e9dbad6fSeschrock boolean_t pl_all; 398e9dbad6fSeschrock size_t pl_width; 399e9dbad6fSeschrock boolean_t pl_fixed; 400990b4856Slling } zprop_list_t; 401e9dbad6fSeschrock 402990b4856Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 4032e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 404fa9e4066Sahrens 405fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 406fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 407fa9e4066Sahrens 408b1b8ab34Slling /* 409990b4856Slling * zpool property management 410990b4856Slling */ 411990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 412990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 413990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 414990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 415990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 416990b4856Slling 417990b4856Slling /* 418990b4856Slling * Functions shared by zfs and zpool property management. 419b1b8ab34Slling */ 420990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 421990b4856Slling boolean_t ordered, zfs_type_t type); 422990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 423990b4856Slling zfs_type_t); 424990b4856Slling extern void zprop_free_list(zprop_list_t *); 425990b4856Slling 426990b4856Slling /* 427990b4856Slling * Functions for printing zfs or zpool properties 428990b4856Slling */ 429990b4856Slling typedef struct zprop_get_cbdata { 430b1b8ab34Slling int cb_sources; 431b1b8ab34Slling int cb_columns[4]; 432b1b8ab34Slling int cb_colwidths[5]; 433b1b8ab34Slling boolean_t cb_scripted; 434b1b8ab34Slling boolean_t cb_literal; 435b1b8ab34Slling boolean_t cb_first; 436990b4856Slling zprop_list_t *cb_proplist; 437990b4856Slling zfs_type_t cb_type; 438990b4856Slling } zprop_get_cbdata_t; 439b1b8ab34Slling 440990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 441990b4856Slling const char *, const char *, zprop_source_t, const char *); 442b1b8ab34Slling 443b1b8ab34Slling #define GET_COL_NAME 1 444b1b8ab34Slling #define GET_COL_PROPERTY 2 445b1b8ab34Slling #define GET_COL_VALUE 3 446b1b8ab34Slling #define GET_COL_SOURCE 4 447b1b8ab34Slling 448fa9e4066Sahrens /* 449fa9e4066Sahrens * Iterator functions. 450fa9e4066Sahrens */ 451fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 45299653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 453fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4543bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4557f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4567f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 457ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 458fa9e4066Sahrens 459fa9e4066Sahrens /* 460fa9e4066Sahrens * Functions to create and destroy datasets. 461fa9e4066Sahrens */ 46299653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 463e9dbad6fSeschrock nvlist_t *); 4647f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 465842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t); 466842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 467e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 468bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 469c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 4707f1f55eaSvb extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 4713cb34c60Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 4723cb34c60Sahrens boolean_t, boolean_t, boolean_t, boolean_t, int); 47399653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 474ca45db41SChris Kirby extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t, 475ca45db41SChris Kirby boolean_t); 476ca45db41SChris Kirby extern int zfs_hold_range(zfs_handle_t *, const char *, const char *, 477ca45db41SChris Kirby const char *, boolean_t); 478842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 479ca45db41SChris Kirby extern int zfs_release_range(zfs_handle_t *, const char *, const char *, 480ca45db41SChris Kirby const char *); 481fa9e4066Sahrens 4820aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 48314843421SMatthew Ahrens uid_t rid, uint64_t space); 48414843421SMatthew Ahrens 48514843421SMatthew Ahrens extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type, 48614843421SMatthew Ahrens zfs_userspace_cb_t func, void *arg); 48714843421SMatthew Ahrens 4883cb34c60Sahrens typedef struct recvflags { 4894ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 490c6765aabSeschrock int verbose : 1; 4914ccbb6e7Sahrens 4924ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 493c6765aabSeschrock int isprefix : 1; 4944ccbb6e7Sahrens 4954ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 496c6765aabSeschrock int dryrun : 1; 4974ccbb6e7Sahrens 4984ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 499c6765aabSeschrock int force : 1; 5004ccbb6e7Sahrens 5014ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 502c6765aabSeschrock int canmountoff : 1; 5034ccbb6e7Sahrens 5044ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 505c6765aabSeschrock int byteswap : 1; 50633408eefSLori Alt 50733408eefSLori Alt /* do not mount file systems as they are extracted (private) */ 50833408eefSLori Alt int nomount : 1; 5093cb34c60Sahrens } recvflags_t; 5103cb34c60Sahrens 5113cb34c60Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 5123cb34c60Sahrens int, avl_tree_t *); 5133cb34c60Sahrens 514fa9e4066Sahrens /* 515fa9e4066Sahrens * Miscellaneous functions. 516fa9e4066Sahrens */ 517fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 518fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 519fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 5205aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 5217f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 5227f1f55eaSvb zfs_type_t); 5237b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *); 524fa9e4066Sahrens 525fa9e4066Sahrens /* 526fa9e4066Sahrens * Mount support functions. 527fa9e4066Sahrens */ 52855434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 52999653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 530fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 531fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 532fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 533fa9e4066Sahrens 534fa9e4066Sahrens /* 535fa9e4066Sahrens * Share support functions. 536fa9e4066Sahrens */ 537f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 538fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 539f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 540f3861e1aSahl 541f3861e1aSahl /* 5423d7072f8Seschrock * Protocol-specific share support functions. 543f3861e1aSahl */ 544f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 545da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 546f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 547da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 548da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 549f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 550da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 551f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 552da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 553da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 554da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 555f3861e1aSahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 556f3861e1aSahl extern int zfs_share_iscsi(zfs_handle_t *); 557f3861e1aSahl extern int zfs_unshare_iscsi(zfs_handle_t *); 558ecd6cf80Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 559743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 560da6c28aaSamw void *, void *, int, zfs_share_op_t); 561fa9e4066Sahrens 562fa9e4066Sahrens /* 563fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 564fa9e4066Sahrens */ 565fa9e4066Sahrens #ifdef NDEBUG 566fa9e4066Sahrens #define verify(EX) ((void)(EX)) 567fa9e4066Sahrens #else 568fa9e4066Sahrens #define verify(EX) assert(EX) 569fa9e4066Sahrens #endif 570fa9e4066Sahrens 571fa9e4066Sahrens /* 572fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 573fa9e4066Sahrens */ 574fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 575e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 576fa9e4066Sahrens 577fa9e4066Sahrens /* 578fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 579fa9e4066Sahrens */ 58099653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 58199653d4eSeschrock boolean_t *); 582fa9e4066Sahrens 583fa9e4066Sahrens /* 584fa9e4066Sahrens * ftyp special. Read the label from a given device. 585fa9e4066Sahrens */ 58699653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 587fa9e4066Sahrens 588e7cbe64fSgw /* is this zvol valid for use as a dump device? */ 589e7cbe64fSgw extern int zvol_check_dump_config(char *); 590e7cbe64fSgw 591743a77edSAlan Wright /* 592743a77edSAlan Wright * Management interfaces for SMB ACL files 593743a77edSAlan Wright */ 594743a77edSAlan Wright 595743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 596743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 597743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 598743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 599743a77edSAlan Wright 6003bb79becSeschrock /* 601f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 602f3861e1aSahl * sharing/unsharing them. 6033bb79becSeschrock */ 604f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 605f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 6063bb79becSeschrock 607fa9e4066Sahrens #ifdef __cplusplus 608fa9e4066Sahrens } 609fa9e4066Sahrens #endif 610fa9e4066Sahrens 611fa9e4066Sahrens #endif /* _LIBZFS_H */ 612