1789Sahrens /* 2789Sahrens * CDDL HEADER START 3789Sahrens * 4789Sahrens * The contents of this file are subject to the terms of the 51485Slling * Common Development and Distribution License (the "License"). 61485Slling * You may not use this file except in compliance with the License. 7789Sahrens * 8789Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9789Sahrens * or http://www.opensolaris.org/os/licensing. 10789Sahrens * See the License for the specific language governing permissions 11789Sahrens * and limitations under the License. 12789Sahrens * 13789Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14789Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15789Sahrens * If applicable, add the following below this CDDL HEADER, with the 16789Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17789Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18789Sahrens * 19789Sahrens * CDDL HEADER END 20789Sahrens */ 213126Sahl 22789Sahrens /* 238584SLori.Alt@Sun.COM * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 24789Sahrens * Use is subject to license terms. 25789Sahrens */ 26789Sahrens 27789Sahrens #ifndef _LIBZFS_H 28789Sahrens #define _LIBZFS_H 29789Sahrens 30789Sahrens #include <assert.h> 31789Sahrens #include <libnvpair.h> 328228SEric.Taylor@Sun.COM #include <sys/mnttab.h> 33789Sahrens #include <sys/param.h> 34789Sahrens #include <sys/types.h> 35789Sahrens #include <sys/varargs.h> 36789Sahrens #include <sys/fs/zfs.h> 374543Smarks #include <sys/avl.h> 384543Smarks #include <ucred.h> 39789Sahrens 40789Sahrens #ifdef __cplusplus 41789Sahrens extern "C" { 42789Sahrens #endif 43789Sahrens 44789Sahrens /* 45789Sahrens * Miscellaneous ZFS constants 46789Sahrens */ 47789Sahrens #define ZFS_MAXNAMELEN MAXNAMELEN 48789Sahrens #define ZPOOL_MAXNAMELEN MAXNAMELEN 49789Sahrens #define ZFS_MAXPROPLEN MAXPATHLEN 505094Slling #define ZPOOL_MAXPROPLEN MAXPATHLEN 51789Sahrens 52789Sahrens /* 532082Seschrock * libzfs errors 542082Seschrock */ 552082Seschrock enum { 562082Seschrock EZFS_NOMEM = 2000, /* out of memory */ 572082Seschrock EZFS_BADPROP, /* invalid property value */ 582082Seschrock EZFS_PROPREADONLY, /* cannot set readonly property */ 592082Seschrock EZFS_PROPTYPE, /* property does not apply to dataset type */ 602082Seschrock EZFS_PROPNONINHERIT, /* property is not inheritable */ 612082Seschrock EZFS_PROPSPACE, /* bad quota or reservation */ 622082Seschrock EZFS_BADTYPE, /* dataset is not of appropriate type */ 632082Seschrock EZFS_BUSY, /* pool or dataset is busy */ 642082Seschrock EZFS_EXISTS, /* pool or dataset already exists */ 652082Seschrock EZFS_NOENT, /* no such pool or dataset */ 662082Seschrock EZFS_BADSTREAM, /* bad backup stream */ 672082Seschrock EZFS_DSREADONLY, /* dataset is readonly */ 682082Seschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 692082Seschrock EZFS_VOLHASDATA, /* volume already contains data */ 702082Seschrock EZFS_INVALIDNAME, /* invalid dataset name */ 712082Seschrock EZFS_BADRESTORE, /* unable to restore to destination */ 722082Seschrock EZFS_BADBACKUP, /* backup failed */ 732082Seschrock EZFS_BADTARGET, /* bad attach/detach/replace target */ 742082Seschrock EZFS_NODEVICE, /* no such device in pool */ 752082Seschrock EZFS_BADDEV, /* invalid device to add */ 762082Seschrock EZFS_NOREPLICAS, /* no valid replicas */ 772082Seschrock EZFS_RESILVERING, /* currently resilvering */ 782082Seschrock EZFS_BADVERSION, /* unsupported version */ 792082Seschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 802082Seschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 812082Seschrock EZFS_BADPATH, /* must be an absolute path */ 822082Seschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 832082Seschrock EZFS_ZONED, /* used improperly in local zone */ 842082Seschrock EZFS_MOUNTFAILED, /* failed to mount dataset */ 852082Seschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 863126Sahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 873126Sahl EZFS_SHARENFSFAILED, /* share(1M) failed */ 882082Seschrock EZFS_DEVLINKS, /* failed to create zvol links */ 892082Seschrock EZFS_PERM, /* permission denied */ 902082Seschrock EZFS_NOSPC, /* out of space */ 912082Seschrock EZFS_IO, /* I/O error */ 922082Seschrock EZFS_INTR, /* signal received */ 932082Seschrock EZFS_ISSPARE, /* device is a hot spare */ 942082Seschrock EZFS_INVALCONFIG, /* invalid vdev configuration */ 952474Seschrock EZFS_RECURSIVE, /* recursive dependency */ 962926Sek110237 EZFS_NOHISTORY, /* no history object */ 973126Sahl EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 983126Sahl EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 993912Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 1003912Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 1013912Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 1023978Smmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 1034276Staylor EZFS_OPENFAILED, /* open of device failed */ 1044276Staylor EZFS_NOCAP, /* couldn't get capacity */ 1054276Staylor EZFS_LABELFAILED, /* write of label failed */ 1064543Smarks EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 1074543Smarks EZFS_BADWHO, /* invalid permission who */ 1084543Smarks EZFS_BADPERM, /* invalid permission */ 1094543Smarks EZFS_BADPERMSET, /* invalid permission set name */ 1104543Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 1114543Smarks EZFS_PERMRDONLY, /* pemissions are readonly */ 1125331Samw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 1135331Samw EZFS_SHARESMBFAILED, /* failed to share over smb */ 1145363Seschrock EZFS_BADCACHE, /* bad cache file */ 1155450Sbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 1166423Sgw25295 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 1177042Sgw25295 EZFS_NOTSUP, /* ops not supported on this dataset */ 1187214Slling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 1199701SGeorge.Wilson@Sun.COM EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 1203912Slling EZFS_UNKNOWN 1212082Seschrock }; 1222082Seschrock 1232082Seschrock /* 1244543Smarks * The following data structures are all part 1254543Smarks * of the zfs_allow_t data structure which is 1264543Smarks * used for printing 'allow' permissions. 1274543Smarks * It is a linked list of zfs_allow_t's which 1284543Smarks * then contain avl tree's for user/group/sets/... 1294543Smarks * and each one of the entries in those trees have 1304543Smarks * avl tree's for the permissions they belong to and 1314543Smarks * whether they are local,descendent or local+descendent 1324543Smarks * permissions. The AVL trees are used primarily for 1334543Smarks * sorting purposes, but also so that we can quickly find 1344543Smarks * a given user and or permission. 1354543Smarks */ 1364543Smarks typedef struct zfs_perm_node { 1374543Smarks avl_node_t z_node; 1384543Smarks char z_pname[MAXPATHLEN]; 1394543Smarks } zfs_perm_node_t; 1404543Smarks 1414543Smarks typedef struct zfs_allow_node { 1424543Smarks avl_node_t z_node; 1434543Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 1444543Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 1454543Smarks avl_tree_t z_local; /* local permissions */ 1464543Smarks avl_tree_t z_descend; /* descendent permissions */ 1474543Smarks } zfs_allow_node_t; 1484543Smarks 1494543Smarks typedef struct zfs_allow { 1504543Smarks struct zfs_allow *z_next; 1514543Smarks char z_setpoint[MAXPATHLEN]; 1524543Smarks avl_tree_t z_sets; 1534543Smarks avl_tree_t z_crperms; 1544543Smarks avl_tree_t z_user; 1554543Smarks avl_tree_t z_group; 1564543Smarks avl_tree_t z_everyone; 1574543Smarks } zfs_allow_t; 1584543Smarks 1594543Smarks /* 160789Sahrens * Basic handle types 161789Sahrens */ 162789Sahrens typedef struct zfs_handle zfs_handle_t; 163789Sahrens typedef struct zpool_handle zpool_handle_t; 1642082Seschrock typedef struct libzfs_handle libzfs_handle_t; 1652082Seschrock 1662082Seschrock /* 1672082Seschrock * Library initialization 1682082Seschrock */ 1692082Seschrock extern libzfs_handle_t *libzfs_init(void); 1702082Seschrock extern void libzfs_fini(libzfs_handle_t *); 1712082Seschrock 1722082Seschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 1732082Seschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 1742082Seschrock 1752082Seschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 1762082Seschrock 1772082Seschrock extern int libzfs_errno(libzfs_handle_t *); 1782082Seschrock extern const char *libzfs_error_action(libzfs_handle_t *); 1792082Seschrock extern const char *libzfs_error_description(libzfs_handle_t *); 1808228SEric.Taylor@Sun.COM extern void libzfs_mnttab_init(libzfs_handle_t *); 1818228SEric.Taylor@Sun.COM extern void libzfs_mnttab_fini(libzfs_handle_t *); 1828811SEric.Taylor@Sun.COM extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 1838228SEric.Taylor@Sun.COM extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 1848228SEric.Taylor@Sun.COM struct mnttab *); 1858228SEric.Taylor@Sun.COM extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 1868228SEric.Taylor@Sun.COM const char *, const char *); 1878228SEric.Taylor@Sun.COM extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 188789Sahrens 189789Sahrens /* 190789Sahrens * Basic handle functions 191789Sahrens */ 1922082Seschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 1932082Seschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 194789Sahrens extern void zpool_close(zpool_handle_t *); 195789Sahrens extern const char *zpool_get_name(zpool_handle_t *); 196789Sahrens extern int zpool_get_state(zpool_handle_t *); 1975094Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 1986865Srm160521 extern void zpool_free_handles(libzfs_handle_t *); 199789Sahrens 200789Sahrens /* 201789Sahrens * Iterate over all active pools in the system. 202789Sahrens */ 203789Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 2042082Seschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 205789Sahrens 206789Sahrens /* 207789Sahrens * Functions to create and destroy pools 208789Sahrens */ 2092082Seschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2107184Stimh nvlist_t *, nvlist_t *); 211789Sahrens extern int zpool_destroy(zpool_handle_t *); 212789Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 213789Sahrens 214789Sahrens /* 215789Sahrens * Functions to manipulate pool and vdev state 216789Sahrens */ 217789Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 2184451Seschrock extern int zpool_clear(zpool_handle_t *, const char *); 219789Sahrens 2204451Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2214451Seschrock vdev_state_t *); 2224451Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2234451Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2244451Seschrock const char *, nvlist_t *, int); 225789Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 2262082Seschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2274451Seschrock 2284451Seschrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 2294451Seschrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 2304451Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2314451Seschrock 2325450Sbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 2337326SEric.Schrock@Sun.COM boolean_t *, boolean_t *); 2349816SGeorge.Wilson@Sun.COM extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 2359816SGeorge.Wilson@Sun.COM boolean_t *, boolean_t *, boolean_t *); 2364276Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 237789Sahrens 238789Sahrens /* 2393912Slling * Functions to manage pool properties 2403912Slling */ 2413912Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2424451Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 2435094Slling size_t proplen, zprop_source_t *); 2445094Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 2455094Slling zprop_source_t *); 2465094Slling 2473912Slling extern const char *zpool_prop_to_name(zpool_prop_t); 2483912Slling extern const char *zpool_prop_values(zpool_prop_t); 2493912Slling 2503912Slling /* 251789Sahrens * Pool health statistics. 252789Sahrens */ 253789Sahrens typedef enum { 254789Sahrens /* 255789Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 2561003Slling * event namespace. Each is associated with a corresponding message ID. 257789Sahrens */ 258789Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 259789Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 260789Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 261789Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 2621003Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 263789Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 264789Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 265789Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 266789Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 2671760Seschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 2683975Sek110237 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 2696523Sek110237 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 2706523Sek110237 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 2718343SEric.Schrock@Sun.COM ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 2728343SEric.Schrock@Sun.COM 2738343SEric.Schrock@Sun.COM /* 2748343SEric.Schrock@Sun.COM * These faults have no corresponding message ID. At the time we are 2758343SEric.Schrock@Sun.COM * checking the status, the original reason for the FMA fault (I/O or 2768343SEric.Schrock@Sun.COM * checksum errors) has been lost. 2778343SEric.Schrock@Sun.COM */ 2784451Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2794451Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 280789Sahrens 281789Sahrens /* 282789Sahrens * The following are not faults per se, but still an error possibly 2831003Slling * requiring administrative attention. There is no corresponding 284789Sahrens * message ID. 285789Sahrens */ 2861760Seschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 287789Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 288789Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 289*10151SGeorge.Wilson@Sun.COM ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 290789Sahrens 291789Sahrens /* 292789Sahrens * Finally, the following indicates a healthy pool. 293789Sahrens */ 294789Sahrens ZPOOL_STATUS_OK 295789Sahrens } zpool_status_t; 296789Sahrens 2971544Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 2981544Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 299789Sahrens 300789Sahrens /* 301789Sahrens * Statistics and configuration functions. 302789Sahrens */ 3031544Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 3042142Seschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 3053444Sek110237 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 3061544Seschrock 307789Sahrens /* 308789Sahrens * Import and export functions 309789Sahrens */ 3107214Slling extern int zpool_export(zpool_handle_t *, boolean_t); 3118211SGeorge.Wilson@Sun.COM extern int zpool_export_force(zpool_handle_t *); 3122082Seschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 3135094Slling char *altroot); 3145094Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 3156643Seschrock nvlist_t *, boolean_t); 316789Sahrens 317789Sahrens /* 318789Sahrens * Search for pools to import 319789Sahrens */ 3206807Sck153898 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3215994Sck153898 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 3226957Sck153898 char *, uint64_t); 3236807Sck153898 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **, 3246807Sck153898 char *); 3256807Sck153898 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **, 3266807Sck153898 uint64_t); 3276807Sck153898 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **); 328789Sahrens 329789Sahrens /* 3301354Seschrock * Miscellaneous pool functions 3311354Seschrock */ 3324543Smarks struct zfs_cmd; 3334543Smarks 3342082Seschrock extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 3355094Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 3362926Sek110237 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 3374988Sek110237 extern void zpool_set_history_str(const char *subcommand, int argc, 3384988Sek110237 char **argv, char *history_str); 3394988Sek110237 extern int zpool_stage_history(libzfs_handle_t *, const char *); 3403444Sek110237 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 3413444Sek110237 size_t len); 3424543Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 3439160SSherry.Moore@Sun.COM extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 3449160SSherry.Moore@Sun.COM 3451354Seschrock /* 346789Sahrens * Basic handle manipulations. These functions do not create or destroy the 347789Sahrens * underlying datasets, only the references to them. 348789Sahrens */ 3492082Seschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 350789Sahrens extern void zfs_close(zfs_handle_t *); 351789Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 352789Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 3537538SRichard.Morris@Sun.COM extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 354789Sahrens 355789Sahrens /* 356789Sahrens * Property management functions. Some functions are shared with the kernel, 3571003Slling * and are found in sys/fs/zfs.h. 358789Sahrens */ 3595094Slling 3605094Slling /* 3615094Slling * zfs dataset property management 3625094Slling */ 3635094Slling extern const char *zfs_prop_default_string(zfs_prop_t); 3642676Seschrock extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 3652676Seschrock extern const char *zfs_prop_column_name(zfs_prop_t); 3662676Seschrock extern boolean_t zfs_prop_align_right(zfs_prop_t); 3672676Seschrock 3687184Stimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 3697184Stimh nvlist_t *, uint64_t, zfs_handle_t *, const char *); 3707184Stimh 3715094Slling extern const char *zfs_prop_to_name(zfs_prop_t); 3725094Slling extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 3735094Slling extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 3745094Slling zprop_source_t *, char *, size_t, boolean_t); 3755094Slling extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 3765094Slling zprop_source_t *, char *, size_t); 3779469SLin.Ling@Sun.COM extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 3789469SLin.Ling@Sun.COM uint64_t *propvalue); 3799396SMatthew.Ahrens@Sun.COM extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 3809396SMatthew.Ahrens@Sun.COM char *propbuf, int proplen, boolean_t literal); 3815094Slling extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 3825094Slling extern int zfs_prop_inherit(zfs_handle_t *, const char *); 3835094Slling extern const char *zfs_prop_values(zfs_prop_t); 3845094Slling extern int zfs_prop_is_string(zfs_prop_t prop); 3855094Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 3865094Slling 3875094Slling typedef struct zprop_list { 3885094Slling int pl_prop; 3892676Seschrock char *pl_user_prop; 3905094Slling struct zprop_list *pl_next; 3912676Seschrock boolean_t pl_all; 3922676Seschrock size_t pl_width; 3932676Seschrock boolean_t pl_fixed; 3945094Slling } zprop_list_t; 3953912Slling 3965094Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 3978802SSanjeev.Bagewadi@Sun.COM extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 398789Sahrens 399789Sahrens #define ZFS_MOUNTPOINT_NONE "none" 400789Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 401789Sahrens 402789Sahrens /* 4035094Slling * zpool property management 4045094Slling */ 4055094Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 4065094Slling extern const char *zpool_prop_default_string(zpool_prop_t); 4075094Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 4085094Slling extern const char *zpool_prop_column_name(zpool_prop_t); 4095094Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 4105094Slling 4115094Slling /* 4125094Slling * Functions shared by zfs and zpool property management. 4133912Slling */ 4145094Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 4155094Slling boolean_t ordered, zfs_type_t type); 4165094Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 4175094Slling zfs_type_t); 4185094Slling extern void zprop_free_list(zprop_list_t *); 4195094Slling 4205094Slling /* 4215094Slling * Functions for printing zfs or zpool properties 4225094Slling */ 4235094Slling typedef struct zprop_get_cbdata { 4243912Slling int cb_sources; 4253912Slling int cb_columns[4]; 4263912Slling int cb_colwidths[5]; 4273912Slling boolean_t cb_scripted; 4283912Slling boolean_t cb_literal; 4293912Slling boolean_t cb_first; 4305094Slling zprop_list_t *cb_proplist; 4315094Slling zfs_type_t cb_type; 4325094Slling } zprop_get_cbdata_t; 4333912Slling 4345094Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 4355094Slling const char *, const char *, zprop_source_t, const char *); 4363912Slling 4373912Slling #define GET_COL_NAME 1 4383912Slling #define GET_COL_PROPERTY 2 4393912Slling #define GET_COL_VALUE 3 4403912Slling #define GET_COL_SOURCE 4 4413912Slling 4423912Slling /* 443789Sahrens * Iterator functions. 444789Sahrens */ 445789Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 4462082Seschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 447789Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4482474Seschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4491356Seschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4501356Seschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 451789Sahrens 452789Sahrens /* 453789Sahrens * Functions to create and destroy datasets. 454789Sahrens */ 4552082Seschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 4562676Seschrock nvlist_t *); 4574490Svb160487 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 458789Sahrens extern int zfs_destroy(zfs_handle_t *); 4592199Sahrens extern int zfs_destroy_snaps(zfs_handle_t *, char *); 4602676Seschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 4617265Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 4625749Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 4634490Svb160487 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 4645367Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 4655367Sahrens boolean_t, boolean_t, boolean_t, boolean_t, int); 4662082Seschrock extern int zfs_promote(zfs_handle_t *); 467789Sahrens 4689554SMatthew.Ahrens@Sun.COM typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 4699396SMatthew.Ahrens@Sun.COM uid_t rid, uint64_t space); 4709396SMatthew.Ahrens@Sun.COM 4719396SMatthew.Ahrens@Sun.COM extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type, 4729396SMatthew.Ahrens@Sun.COM zfs_userspace_cb_t func, void *arg); 4739396SMatthew.Ahrens@Sun.COM 4745367Sahrens typedef struct recvflags { 4755446Sahrens /* print informational messages (ie, -v was specified) */ 4765501Seschrock int verbose : 1; 4775446Sahrens 4785446Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 4795501Seschrock int isprefix : 1; 4805446Sahrens 4815446Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 4825501Seschrock int dryrun : 1; 4835446Sahrens 4845446Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 4855501Seschrock int force : 1; 4865446Sahrens 4875446Sahrens /* set "canmount=off" on all modified filesystems */ 4885501Seschrock int canmountoff : 1; 4895446Sahrens 4905446Sahrens /* byteswap flag is used internally; callers need not specify */ 4915501Seschrock int byteswap : 1; 4928584SLori.Alt@Sun.COM 4938584SLori.Alt@Sun.COM /* do not mount file systems as they are extracted (private) */ 4948584SLori.Alt@Sun.COM int nomount : 1; 4955367Sahrens } recvflags_t; 4965367Sahrens 4975367Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 4985367Sahrens int, avl_tree_t *); 4995367Sahrens 500789Sahrens /* 501789Sahrens * Miscellaneous functions. 502789Sahrens */ 503789Sahrens extern const char *zfs_type_to_name(zfs_type_t); 504789Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 505789Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 5063635Sck153898 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 5074490Svb160487 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 5084490Svb160487 zfs_type_t); 5095713Srm160521 extern int zfs_spa_version(zfs_handle_t *, int *); 510789Sahrens 511789Sahrens /* 512789Sahrens * Mount support functions. 513789Sahrens */ 5143444Sek110237 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 5152082Seschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 516789Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 517789Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 518789Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 519789Sahrens 520789Sahrens /* 521789Sahrens * Share support functions. 522789Sahrens */ 5233126Sahl extern boolean_t zfs_is_shared(zfs_handle_t *); 524789Sahrens extern int zfs_share(zfs_handle_t *); 5253126Sahl extern int zfs_unshare(zfs_handle_t *); 5263126Sahl 5273126Sahl /* 5284451Seschrock * Protocol-specific share support functions. 5293126Sahl */ 5303126Sahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 5315331Samw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 5323126Sahl extern int zfs_share_nfs(zfs_handle_t *); 5335331Samw extern int zfs_share_smb(zfs_handle_t *); 5345331Samw extern int zfs_shareall(zfs_handle_t *); 5353126Sahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 5365331Samw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 5373126Sahl extern int zfs_unshareall_nfs(zfs_handle_t *); 5385331Samw extern int zfs_unshareall_smb(zfs_handle_t *); 5395331Samw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 5405331Samw extern int zfs_unshareall(zfs_handle_t *); 5413126Sahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 5423126Sahl extern int zfs_share_iscsi(zfs_handle_t *); 5433126Sahl extern int zfs_unshare_iscsi(zfs_handle_t *); 5444543Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 5458845Samw@Sun.COM extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 5465331Samw void *, void *, int, zfs_share_op_t); 547789Sahrens 548789Sahrens /* 549789Sahrens * When dealing with nvlists, verify() is extremely useful 550789Sahrens */ 551789Sahrens #ifdef NDEBUG 552789Sahrens #define verify(EX) ((void)(EX)) 553789Sahrens #else 554789Sahrens #define verify(EX) assert(EX) 555789Sahrens #endif 556789Sahrens 557789Sahrens /* 558789Sahrens * Utility function to convert a number to a human-readable form. 559789Sahrens */ 560789Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 5612676Seschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 562789Sahrens 563789Sahrens /* 564789Sahrens * Given a device or file, determine if it is part of a pool. 565789Sahrens */ 5662082Seschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 5672082Seschrock boolean_t *); 568789Sahrens 569789Sahrens /* 570789Sahrens * ftyp special. Read the label from a given device. 571789Sahrens */ 5722082Seschrock extern int zpool_read_label(int, nvlist_t **); 573789Sahrens 574789Sahrens /* 5753126Sahl * Create and remove zvol /dev links. 576789Sahrens */ 577789Sahrens extern int zpool_create_zvol_links(zpool_handle_t *); 578789Sahrens extern int zpool_remove_zvol_links(zpool_handle_t *); 579789Sahrens 5806423Sgw25295 /* is this zvol valid for use as a dump device? */ 5816423Sgw25295 extern int zvol_check_dump_config(char *); 5826423Sgw25295 5832474Seschrock /* 5848845Samw@Sun.COM * Management interfaces for SMB ACL files 5858845Samw@Sun.COM */ 5868845Samw@Sun.COM 5878845Samw@Sun.COM int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 5888845Samw@Sun.COM int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 5898845Samw@Sun.COM int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 5908845Samw@Sun.COM int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 5918845Samw@Sun.COM 5928845Samw@Sun.COM /* 5933126Sahl * Enable and disable datasets within a pool by mounting/unmounting and 5943126Sahl * sharing/unsharing them. 5952474Seschrock */ 5963126Sahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 5973126Sahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 5982474Seschrock 599789Sahrens #ifdef __cplusplus 600789Sahrens } 601789Sahrens #endif 602789Sahrens 603789Sahrens #endif /* _LIBZFS_H */ 604