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 /* 236949a980Smarks * Copyright 2008 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> 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 51fa9e4066Sahrens /* 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_VOLHASDATA, /* volume already contains data */ 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_DEVLINKS, /* failed to create zvol links */ 8899653d4eSeschrock EZFS_PERM, /* permission denied */ 8999653d4eSeschrock EZFS_NOSPC, /* out of space */ 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 */ 118b1b8ab34Slling EZFS_UNKNOWN 11999653d4eSeschrock }; 12099653d4eSeschrock 12199653d4eSeschrock /* 122ecd6cf80Smarks * The following data structures are all part 123ecd6cf80Smarks * of the zfs_allow_t data structure which is 124ecd6cf80Smarks * used for printing 'allow' permissions. 125ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 126ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 127ecd6cf80Smarks * and each one of the entries in those trees have 128ecd6cf80Smarks * avl tree's for the permissions they belong to and 129ecd6cf80Smarks * whether they are local,descendent or local+descendent 130ecd6cf80Smarks * permissions. The AVL trees are used primarily for 131ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 132ecd6cf80Smarks * a given user and or permission. 133ecd6cf80Smarks */ 134ecd6cf80Smarks typedef struct zfs_perm_node { 135ecd6cf80Smarks avl_node_t z_node; 136ecd6cf80Smarks char z_pname[MAXPATHLEN]; 137ecd6cf80Smarks } zfs_perm_node_t; 138ecd6cf80Smarks 139ecd6cf80Smarks typedef struct zfs_allow_node { 140ecd6cf80Smarks avl_node_t z_node; 141ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 142ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 143ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 144ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 145ecd6cf80Smarks } zfs_allow_node_t; 146ecd6cf80Smarks 147ecd6cf80Smarks typedef struct zfs_allow { 148ecd6cf80Smarks struct zfs_allow *z_next; 149ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 150ecd6cf80Smarks avl_tree_t z_sets; 151ecd6cf80Smarks avl_tree_t z_crperms; 152ecd6cf80Smarks avl_tree_t z_user; 153ecd6cf80Smarks avl_tree_t z_group; 154ecd6cf80Smarks avl_tree_t z_everyone; 155ecd6cf80Smarks } zfs_allow_t; 156ecd6cf80Smarks 157ecd6cf80Smarks /* 158fa9e4066Sahrens * Basic handle types 159fa9e4066Sahrens */ 160fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 161fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 16299653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 16399653d4eSeschrock 16499653d4eSeschrock /* 16599653d4eSeschrock * Library initialization 16699653d4eSeschrock */ 16799653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 16899653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 16999653d4eSeschrock 17099653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 17199653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 17299653d4eSeschrock 17399653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 17499653d4eSeschrock 17599653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 17699653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 17799653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 178fa9e4066Sahrens 179fa9e4066Sahrens /* 180fa9e4066Sahrens * Basic handle functions 181fa9e4066Sahrens */ 18299653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 18399653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 184fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 185fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 186fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 187990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 18829ab75c9Srm160521 extern void zpool_free_handles(libzfs_handle_t *); 189fa9e4066Sahrens 190fa9e4066Sahrens /* 191fa9e4066Sahrens * Iterate over all active pools in the system. 192fa9e4066Sahrens */ 193fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 19499653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 195fa9e4066Sahrens 196fa9e4066Sahrens /* 197fa9e4066Sahrens * Functions to create and destroy pools 198fa9e4066Sahrens */ 19999653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2000a48a24eStimh nvlist_t *, nvlist_t *); 201fa9e4066Sahrens extern int zpool_destroy(zpool_handle_t *); 202fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 203fa9e4066Sahrens 204fa9e4066Sahrens /* 205fa9e4066Sahrens * Functions to manipulate pool and vdev state 206fa9e4066Sahrens */ 207fa9e4066Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 2083d7072f8Seschrock extern int zpool_clear(zpool_handle_t *, const char *); 209fa9e4066Sahrens 2103d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2113d7072f8Seschrock vdev_state_t *); 2123d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2133d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2143d7072f8Seschrock const char *, nvlist_t *, int); 215fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 21699653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2173d7072f8Seschrock 2183d7072f8Seschrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 2193d7072f8Seschrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 2203d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2213d7072f8Seschrock 222fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 223ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 2248488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 225fa9e4066Sahrens 226fa9e4066Sahrens /* 227b1b8ab34Slling * Functions to manage pool properties 228b1b8ab34Slling */ 229b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2303d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 231990b4856Slling size_t proplen, zprop_source_t *); 232990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 233990b4856Slling zprop_source_t *); 234990b4856Slling 235b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 236b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 237b1b8ab34Slling 238b1b8ab34Slling /* 239fa9e4066Sahrens * Pool health statistics. 240fa9e4066Sahrens */ 241fa9e4066Sahrens typedef enum { 242fa9e4066Sahrens /* 243fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 244b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 245fa9e4066Sahrens */ 246fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 247fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 248fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 249fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 250b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 251fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 252fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 253fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 254fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 255eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 25695173954Sek110237 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 25732b87932Sek110237 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 25832b87932Sek110237 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 2593d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2603d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 261b87f3af3Sperrin ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 262fa9e4066Sahrens 263fa9e4066Sahrens /* 264fa9e4066Sahrens * The following are not faults per se, but still an error possibly 265b81d61a6Slling * requiring administrative attention. There is no corresponding 266fa9e4066Sahrens * message ID. 267fa9e4066Sahrens */ 268eaca9bbdSeschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 269fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 270fa9e4066Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 271fa9e4066Sahrens 272fa9e4066Sahrens /* 273fa9e4066Sahrens * Finally, the following indicates a healthy pool. 274fa9e4066Sahrens */ 275fa9e4066Sahrens ZPOOL_STATUS_OK 276fa9e4066Sahrens } zpool_status_t; 277fa9e4066Sahrens 278ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 279ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 280fa9e4066Sahrens 281fa9e4066Sahrens /* 282fa9e4066Sahrens * Statistics and configuration functions. 283fa9e4066Sahrens */ 284ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 28594de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 28655434c77Sek110237 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 287ea8dc4b6Seschrock 288fa9e4066Sahrens /* 289fa9e4066Sahrens * Import and export functions 290fa9e4066Sahrens */ 29189a89ebfSlling extern int zpool_export(zpool_handle_t *, boolean_t); 29299653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 293990b4856Slling char *altroot); 294990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 295c5904d13Seschrock nvlist_t *, boolean_t); 296fa9e4066Sahrens 297fa9e4066Sahrens /* 298fa9e4066Sahrens * Search for pools to import 299fa9e4066Sahrens */ 30024e697d4Sck153898 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3013a57275aSck153898 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 302e829d913Sck153898 char *, uint64_t); 30324e697d4Sck153898 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **, 30424e697d4Sck153898 char *); 30524e697d4Sck153898 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **, 30624e697d4Sck153898 uint64_t); 30724e697d4Sck153898 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **); 308fa9e4066Sahrens 309fa9e4066Sahrens /* 310c67d9675Seschrock * Miscellaneous pool functions 311c67d9675Seschrock */ 312ecd6cf80Smarks struct zfs_cmd; 313ecd6cf80Smarks 31499653d4eSeschrock extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 315990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 31606eeb2adSek110237 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 3172a6b87f0Sek110237 extern void zpool_set_history_str(const char *subcommand, int argc, 3182a6b87f0Sek110237 char **argv, char *history_str); 3192a6b87f0Sek110237 extern int zpool_stage_history(libzfs_handle_t *, const char *); 32055434c77Sek110237 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 32155434c77Sek110237 size_t len); 322ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 323c67d9675Seschrock /* 324fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 325fa9e4066Sahrens * underlying datasets, only the references to them. 326fa9e4066Sahrens */ 32799653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 328fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 329fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 330fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 331*d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 332fa9e4066Sahrens 333fa9e4066Sahrens /* 334fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 335b81d61a6Slling * and are found in sys/fs/zfs.h. 336fa9e4066Sahrens */ 337990b4856Slling 338990b4856Slling /* 339990b4856Slling * zfs dataset property management 340990b4856Slling */ 341990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 342e9dbad6fSeschrock extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 343e9dbad6fSeschrock extern const char *zfs_prop_column_name(zfs_prop_t); 344e9dbad6fSeschrock extern boolean_t zfs_prop_align_right(zfs_prop_t); 345e9dbad6fSeschrock 3460a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 3470a48a24eStimh nvlist_t *, uint64_t, zfs_handle_t *, const char *); 3480a48a24eStimh 349990b4856Slling extern const char *zfs_prop_to_name(zfs_prop_t); 350990b4856Slling extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 351990b4856Slling extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 352990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 353990b4856Slling extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 354990b4856Slling zprop_source_t *, char *, size_t); 355990b4856Slling extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 356990b4856Slling extern int zfs_prop_inherit(zfs_handle_t *, const char *); 357990b4856Slling extern const char *zfs_prop_values(zfs_prop_t); 358990b4856Slling extern int zfs_prop_is_string(zfs_prop_t prop); 359990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 360990b4856Slling 361990b4856Slling typedef struct zprop_list { 362990b4856Slling int pl_prop; 363e9dbad6fSeschrock char *pl_user_prop; 364990b4856Slling struct zprop_list *pl_next; 365e9dbad6fSeschrock boolean_t pl_all; 366e9dbad6fSeschrock size_t pl_width; 367e9dbad6fSeschrock boolean_t pl_fixed; 368990b4856Slling } zprop_list_t; 369e9dbad6fSeschrock 370990b4856Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 371fa9e4066Sahrens 372fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 373fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 374fa9e4066Sahrens 375fa9e4066Sahrens /* 376990b4856Slling * zpool property management 377b1b8ab34Slling */ 378990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 379990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 380990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 381990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 382990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 383990b4856Slling 384990b4856Slling /* 385990b4856Slling * Functions shared by zfs and zpool property management. 386990b4856Slling */ 387990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 388990b4856Slling boolean_t ordered, zfs_type_t type); 389990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 390990b4856Slling zfs_type_t); 391990b4856Slling extern void zprop_free_list(zprop_list_t *); 392990b4856Slling 393990b4856Slling /* 394990b4856Slling * Functions for printing zfs or zpool properties 395990b4856Slling */ 396990b4856Slling typedef struct zprop_get_cbdata { 397b1b8ab34Slling int cb_sources; 398b1b8ab34Slling int cb_columns[4]; 399b1b8ab34Slling int cb_colwidths[5]; 400b1b8ab34Slling boolean_t cb_scripted; 401b1b8ab34Slling boolean_t cb_literal; 402b1b8ab34Slling boolean_t cb_first; 403990b4856Slling zprop_list_t *cb_proplist; 404990b4856Slling zfs_type_t cb_type; 405990b4856Slling } zprop_get_cbdata_t; 406b1b8ab34Slling 407990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 408990b4856Slling const char *, const char *, zprop_source_t, const char *); 409b1b8ab34Slling 410b1b8ab34Slling #define GET_COL_NAME 1 411b1b8ab34Slling #define GET_COL_PROPERTY 2 412b1b8ab34Slling #define GET_COL_VALUE 3 413b1b8ab34Slling #define GET_COL_SOURCE 4 414b1b8ab34Slling 415b1b8ab34Slling /* 416fa9e4066Sahrens * Iterator functions. 417fa9e4066Sahrens */ 418fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 41999653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 420fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4213bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4227f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4237f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 424fa9e4066Sahrens 425fa9e4066Sahrens /* 426fa9e4066Sahrens * Functions to create and destroy datasets. 427fa9e4066Sahrens */ 42899653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 429e9dbad6fSeschrock nvlist_t *); 4307f1f55eaSvb160487 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 431fa9e4066Sahrens extern int zfs_destroy(zfs_handle_t *); 4321d452cf5Sahrens extern int zfs_destroy_snaps(zfs_handle_t *, char *); 433e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 434bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 435c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 4367f1f55eaSvb160487 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 4373cb34c60Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 4383cb34c60Sahrens boolean_t, boolean_t, boolean_t, boolean_t, int); 43999653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 440fa9e4066Sahrens 4413cb34c60Sahrens typedef struct recvflags { 4424ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 443c6765aabSeschrock int verbose : 1; 4444ccbb6e7Sahrens 4454ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 446c6765aabSeschrock int isprefix : 1; 4474ccbb6e7Sahrens 4484ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 449c6765aabSeschrock int dryrun : 1; 4504ccbb6e7Sahrens 4514ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 452c6765aabSeschrock int force : 1; 4534ccbb6e7Sahrens 4544ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 455c6765aabSeschrock int canmountoff : 1; 4564ccbb6e7Sahrens 4574ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 458c6765aabSeschrock int byteswap : 1; 4593cb34c60Sahrens } recvflags_t; 4603cb34c60Sahrens 4613cb34c60Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 4623cb34c60Sahrens int, avl_tree_t *); 4633cb34c60Sahrens 464fa9e4066Sahrens /* 465fa9e4066Sahrens * Miscellaneous functions. 466fa9e4066Sahrens */ 467fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 468fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 469fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 4705aba80dbSck153898 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 4717f1f55eaSvb160487 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 4727f1f55eaSvb160487 zfs_type_t); 4737b97dc1aSrm160521 extern int zfs_spa_version(zfs_handle_t *, int *); 474fa9e4066Sahrens 475fa9e4066Sahrens /* 476ecd6cf80Smarks * dataset permission functions. 477ecd6cf80Smarks */ 478ecd6cf80Smarks extern int zfs_perm_set(zfs_handle_t *, nvlist_t *); 479ecd6cf80Smarks extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *); 480ecd6cf80Smarks extern int zfs_build_perms(zfs_handle_t *, char *, char *, 481ecd6cf80Smarks zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t); 482ecd6cf80Smarks extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **); 483ecd6cf80Smarks extern void zfs_free_allows(zfs_allow_t *); 4846949a980Smarks extern void zfs_deleg_permissions(void); 485ecd6cf80Smarks 486ecd6cf80Smarks /* 487fa9e4066Sahrens * Mount support functions. 488fa9e4066Sahrens */ 48955434c77Sek110237 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 49099653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 491fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 492fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 493fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 494fa9e4066Sahrens 495fa9e4066Sahrens /* 496fa9e4066Sahrens * Share support functions. 497fa9e4066Sahrens */ 498f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 499fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 500f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 501f3861e1aSahl 502f3861e1aSahl /* 5033d7072f8Seschrock * Protocol-specific share support functions. 504f3861e1aSahl */ 505f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 506da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 507f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 508da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 509da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 510f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 511da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 512f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 513da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 514da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 515da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 516f3861e1aSahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 517f3861e1aSahl extern int zfs_share_iscsi(zfs_handle_t *); 518f3861e1aSahl extern int zfs_unshare_iscsi(zfs_handle_t *); 519ecd6cf80Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 520ecd6cf80Smarks extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, 521da6c28aaSamw void *, void *, int, zfs_share_op_t); 522fa9e4066Sahrens 523fa9e4066Sahrens /* 524fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 525fa9e4066Sahrens */ 526fa9e4066Sahrens #ifdef NDEBUG 527fa9e4066Sahrens #define verify(EX) ((void)(EX)) 528fa9e4066Sahrens #else 529fa9e4066Sahrens #define verify(EX) assert(EX) 530fa9e4066Sahrens #endif 531fa9e4066Sahrens 532fa9e4066Sahrens /* 533fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 534fa9e4066Sahrens */ 535fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 536e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 537fa9e4066Sahrens 538fa9e4066Sahrens /* 539fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 540fa9e4066Sahrens */ 54199653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 54299653d4eSeschrock boolean_t *); 543fa9e4066Sahrens 544fa9e4066Sahrens /* 545fa9e4066Sahrens * ftyp special. Read the label from a given device. 546fa9e4066Sahrens */ 54799653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 548fa9e4066Sahrens 549fa9e4066Sahrens /* 550f3861e1aSahl * Create and remove zvol /dev links. 551fa9e4066Sahrens */ 552fa9e4066Sahrens extern int zpool_create_zvol_links(zpool_handle_t *); 553fa9e4066Sahrens extern int zpool_remove_zvol_links(zpool_handle_t *); 554fa9e4066Sahrens 555e7cbe64fSgw25295 /* is this zvol valid for use as a dump device? */ 556e7cbe64fSgw25295 extern int zvol_check_dump_config(char *); 557e7cbe64fSgw25295 5583bb79becSeschrock /* 559f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 560f3861e1aSahl * sharing/unsharing them. 5613bb79becSeschrock */ 562f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 563f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 5643bb79becSeschrock 565fa9e4066Sahrens #ifdef __cplusplus 566fa9e4066Sahrens } 567fa9e4066Sahrens #endif 568fa9e4066Sahrens 569fa9e4066Sahrens #endif /* _LIBZFS_H */ 570