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 */ 119*9701SGeorge.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 *); 2344276Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 235789Sahrens 236789Sahrens /* 2373912Slling * Functions to manage pool properties 2383912Slling */ 2393912Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2404451Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 2415094Slling size_t proplen, zprop_source_t *); 2425094Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 2435094Slling zprop_source_t *); 2445094Slling 2453912Slling extern const char *zpool_prop_to_name(zpool_prop_t); 2463912Slling extern const char *zpool_prop_values(zpool_prop_t); 2473912Slling 2483912Slling /* 249789Sahrens * Pool health statistics. 250789Sahrens */ 251789Sahrens typedef enum { 252789Sahrens /* 253789Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 2541003Slling * event namespace. Each is associated with a corresponding message ID. 255789Sahrens */ 256789Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 257789Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 258789Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 259789Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 2601003Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 261789Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 262789Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 263789Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 264789Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 2651760Seschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 2663975Sek110237 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 2676523Sek110237 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 2686523Sek110237 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 2698343SEric.Schrock@Sun.COM ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 2708343SEric.Schrock@Sun.COM 2718343SEric.Schrock@Sun.COM /* 2728343SEric.Schrock@Sun.COM * These faults have no corresponding message ID. At the time we are 2738343SEric.Schrock@Sun.COM * checking the status, the original reason for the FMA fault (I/O or 2748343SEric.Schrock@Sun.COM * checksum errors) has been lost. 2758343SEric.Schrock@Sun.COM */ 2764451Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2774451Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 278789Sahrens 279789Sahrens /* 280789Sahrens * The following are not faults per se, but still an error possibly 2811003Slling * requiring administrative attention. There is no corresponding 282789Sahrens * message ID. 283789Sahrens */ 2841760Seschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 285789Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 286789Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 287789Sahrens 288789Sahrens /* 289789Sahrens * Finally, the following indicates a healthy pool. 290789Sahrens */ 291789Sahrens ZPOOL_STATUS_OK 292789Sahrens } zpool_status_t; 293789Sahrens 2941544Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 2951544Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 296789Sahrens 297789Sahrens /* 298789Sahrens * Statistics and configuration functions. 299789Sahrens */ 3001544Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 3012142Seschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 3023444Sek110237 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 3031544Seschrock 304789Sahrens /* 305789Sahrens * Import and export functions 306789Sahrens */ 3077214Slling extern int zpool_export(zpool_handle_t *, boolean_t); 3088211SGeorge.Wilson@Sun.COM extern int zpool_export_force(zpool_handle_t *); 3092082Seschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 3105094Slling char *altroot); 3115094Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 3126643Seschrock nvlist_t *, boolean_t); 313789Sahrens 314789Sahrens /* 315789Sahrens * Search for pools to import 316789Sahrens */ 3176807Sck153898 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3185994Sck153898 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 3196957Sck153898 char *, uint64_t); 3206807Sck153898 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **, 3216807Sck153898 char *); 3226807Sck153898 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **, 3236807Sck153898 uint64_t); 3246807Sck153898 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **); 325789Sahrens 326789Sahrens /* 3271354Seschrock * Miscellaneous pool functions 3281354Seschrock */ 3294543Smarks struct zfs_cmd; 3304543Smarks 3312082Seschrock extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 3325094Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 3332926Sek110237 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 3344988Sek110237 extern void zpool_set_history_str(const char *subcommand, int argc, 3354988Sek110237 char **argv, char *history_str); 3364988Sek110237 extern int zpool_stage_history(libzfs_handle_t *, const char *); 3373444Sek110237 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 3383444Sek110237 size_t len); 3394543Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 3409160SSherry.Moore@Sun.COM extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 3419160SSherry.Moore@Sun.COM 3421354Seschrock /* 343789Sahrens * Basic handle manipulations. These functions do not create or destroy the 344789Sahrens * underlying datasets, only the references to them. 345789Sahrens */ 3462082Seschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 347789Sahrens extern void zfs_close(zfs_handle_t *); 348789Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 349789Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 3507538SRichard.Morris@Sun.COM extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 351789Sahrens 352789Sahrens /* 353789Sahrens * Property management functions. Some functions are shared with the kernel, 3541003Slling * and are found in sys/fs/zfs.h. 355789Sahrens */ 3565094Slling 3575094Slling /* 3585094Slling * zfs dataset property management 3595094Slling */ 3605094Slling extern const char *zfs_prop_default_string(zfs_prop_t); 3612676Seschrock extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 3622676Seschrock extern const char *zfs_prop_column_name(zfs_prop_t); 3632676Seschrock extern boolean_t zfs_prop_align_right(zfs_prop_t); 3642676Seschrock 3657184Stimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 3667184Stimh nvlist_t *, uint64_t, zfs_handle_t *, const char *); 3677184Stimh 3685094Slling extern const char *zfs_prop_to_name(zfs_prop_t); 3695094Slling extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 3705094Slling extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 3715094Slling zprop_source_t *, char *, size_t, boolean_t); 3725094Slling extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 3735094Slling zprop_source_t *, char *, size_t); 3749469SLin.Ling@Sun.COM extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 3759469SLin.Ling@Sun.COM uint64_t *propvalue); 3769396SMatthew.Ahrens@Sun.COM extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 3779396SMatthew.Ahrens@Sun.COM char *propbuf, int proplen, boolean_t literal); 3785094Slling extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 3795094Slling extern int zfs_prop_inherit(zfs_handle_t *, const char *); 3805094Slling extern const char *zfs_prop_values(zfs_prop_t); 3815094Slling extern int zfs_prop_is_string(zfs_prop_t prop); 3825094Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 3835094Slling 3845094Slling typedef struct zprop_list { 3855094Slling int pl_prop; 3862676Seschrock char *pl_user_prop; 3875094Slling struct zprop_list *pl_next; 3882676Seschrock boolean_t pl_all; 3892676Seschrock size_t pl_width; 3902676Seschrock boolean_t pl_fixed; 3915094Slling } zprop_list_t; 3923912Slling 3935094Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 3948802SSanjeev.Bagewadi@Sun.COM extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 395789Sahrens 396789Sahrens #define ZFS_MOUNTPOINT_NONE "none" 397789Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 398789Sahrens 399789Sahrens /* 4005094Slling * zpool property management 4015094Slling */ 4025094Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 4035094Slling extern const char *zpool_prop_default_string(zpool_prop_t); 4045094Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 4055094Slling extern const char *zpool_prop_column_name(zpool_prop_t); 4065094Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 4075094Slling 4085094Slling /* 4095094Slling * Functions shared by zfs and zpool property management. 4103912Slling */ 4115094Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 4125094Slling boolean_t ordered, zfs_type_t type); 4135094Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 4145094Slling zfs_type_t); 4155094Slling extern void zprop_free_list(zprop_list_t *); 4165094Slling 4175094Slling /* 4185094Slling * Functions for printing zfs or zpool properties 4195094Slling */ 4205094Slling typedef struct zprop_get_cbdata { 4213912Slling int cb_sources; 4223912Slling int cb_columns[4]; 4233912Slling int cb_colwidths[5]; 4243912Slling boolean_t cb_scripted; 4253912Slling boolean_t cb_literal; 4263912Slling boolean_t cb_first; 4275094Slling zprop_list_t *cb_proplist; 4285094Slling zfs_type_t cb_type; 4295094Slling } zprop_get_cbdata_t; 4303912Slling 4315094Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 4325094Slling const char *, const char *, zprop_source_t, const char *); 4333912Slling 4343912Slling #define GET_COL_NAME 1 4353912Slling #define GET_COL_PROPERTY 2 4363912Slling #define GET_COL_VALUE 3 4373912Slling #define GET_COL_SOURCE 4 4383912Slling 4393912Slling /* 440789Sahrens * Iterator functions. 441789Sahrens */ 442789Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 4432082Seschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 444789Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4452474Seschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4461356Seschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4471356Seschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 448789Sahrens 449789Sahrens /* 450789Sahrens * Functions to create and destroy datasets. 451789Sahrens */ 4522082Seschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 4532676Seschrock nvlist_t *); 4544490Svb160487 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 455789Sahrens extern int zfs_destroy(zfs_handle_t *); 4562199Sahrens extern int zfs_destroy_snaps(zfs_handle_t *, char *); 4572676Seschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 4587265Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 4595749Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 4604490Svb160487 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 4615367Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 4625367Sahrens boolean_t, boolean_t, boolean_t, boolean_t, int); 4632082Seschrock extern int zfs_promote(zfs_handle_t *); 464789Sahrens 4659554SMatthew.Ahrens@Sun.COM typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 4669396SMatthew.Ahrens@Sun.COM uid_t rid, uint64_t space); 4679396SMatthew.Ahrens@Sun.COM 4689396SMatthew.Ahrens@Sun.COM extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type, 4699396SMatthew.Ahrens@Sun.COM zfs_userspace_cb_t func, void *arg); 4709396SMatthew.Ahrens@Sun.COM 4715367Sahrens typedef struct recvflags { 4725446Sahrens /* print informational messages (ie, -v was specified) */ 4735501Seschrock int verbose : 1; 4745446Sahrens 4755446Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 4765501Seschrock int isprefix : 1; 4775446Sahrens 4785446Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 4795501Seschrock int dryrun : 1; 4805446Sahrens 4815446Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 4825501Seschrock int force : 1; 4835446Sahrens 4845446Sahrens /* set "canmount=off" on all modified filesystems */ 4855501Seschrock int canmountoff : 1; 4865446Sahrens 4875446Sahrens /* byteswap flag is used internally; callers need not specify */ 4885501Seschrock int byteswap : 1; 4898584SLori.Alt@Sun.COM 4908584SLori.Alt@Sun.COM /* do not mount file systems as they are extracted (private) */ 4918584SLori.Alt@Sun.COM int nomount : 1; 4925367Sahrens } recvflags_t; 4935367Sahrens 4945367Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 4955367Sahrens int, avl_tree_t *); 4965367Sahrens 497789Sahrens /* 498789Sahrens * Miscellaneous functions. 499789Sahrens */ 500789Sahrens extern const char *zfs_type_to_name(zfs_type_t); 501789Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 502789Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 5033635Sck153898 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 5044490Svb160487 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 5054490Svb160487 zfs_type_t); 5065713Srm160521 extern int zfs_spa_version(zfs_handle_t *, int *); 507789Sahrens 508789Sahrens /* 509789Sahrens * Mount support functions. 510789Sahrens */ 5113444Sek110237 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 5122082Seschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 513789Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 514789Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 515789Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 516789Sahrens 517789Sahrens /* 518789Sahrens * Share support functions. 519789Sahrens */ 5203126Sahl extern boolean_t zfs_is_shared(zfs_handle_t *); 521789Sahrens extern int zfs_share(zfs_handle_t *); 5223126Sahl extern int zfs_unshare(zfs_handle_t *); 5233126Sahl 5243126Sahl /* 5254451Seschrock * Protocol-specific share support functions. 5263126Sahl */ 5273126Sahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 5285331Samw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 5293126Sahl extern int zfs_share_nfs(zfs_handle_t *); 5305331Samw extern int zfs_share_smb(zfs_handle_t *); 5315331Samw extern int zfs_shareall(zfs_handle_t *); 5323126Sahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 5335331Samw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 5343126Sahl extern int zfs_unshareall_nfs(zfs_handle_t *); 5355331Samw extern int zfs_unshareall_smb(zfs_handle_t *); 5365331Samw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 5375331Samw extern int zfs_unshareall(zfs_handle_t *); 5383126Sahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 5393126Sahl extern int zfs_share_iscsi(zfs_handle_t *); 5403126Sahl extern int zfs_unshare_iscsi(zfs_handle_t *); 5414543Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 5428845Samw@Sun.COM extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 5435331Samw void *, void *, int, zfs_share_op_t); 544789Sahrens 545789Sahrens /* 546789Sahrens * When dealing with nvlists, verify() is extremely useful 547789Sahrens */ 548789Sahrens #ifdef NDEBUG 549789Sahrens #define verify(EX) ((void)(EX)) 550789Sahrens #else 551789Sahrens #define verify(EX) assert(EX) 552789Sahrens #endif 553789Sahrens 554789Sahrens /* 555789Sahrens * Utility function to convert a number to a human-readable form. 556789Sahrens */ 557789Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 5582676Seschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 559789Sahrens 560789Sahrens /* 561789Sahrens * Given a device or file, determine if it is part of a pool. 562789Sahrens */ 5632082Seschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 5642082Seschrock boolean_t *); 565789Sahrens 566789Sahrens /* 567789Sahrens * ftyp special. Read the label from a given device. 568789Sahrens */ 5692082Seschrock extern int zpool_read_label(int, nvlist_t **); 570789Sahrens 571789Sahrens /* 5723126Sahl * Create and remove zvol /dev links. 573789Sahrens */ 574789Sahrens extern int zpool_create_zvol_links(zpool_handle_t *); 575789Sahrens extern int zpool_remove_zvol_links(zpool_handle_t *); 576789Sahrens 5776423Sgw25295 /* is this zvol valid for use as a dump device? */ 5786423Sgw25295 extern int zvol_check_dump_config(char *); 5796423Sgw25295 5802474Seschrock /* 5818845Samw@Sun.COM * Management interfaces for SMB ACL files 5828845Samw@Sun.COM */ 5838845Samw@Sun.COM 5848845Samw@Sun.COM int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 5858845Samw@Sun.COM int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 5868845Samw@Sun.COM int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 5878845Samw@Sun.COM int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 5888845Samw@Sun.COM 5898845Samw@Sun.COM /* 5903126Sahl * Enable and disable datasets within a pool by mounting/unmounting and 5913126Sahl * sharing/unsharing them. 5922474Seschrock */ 5933126Sahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 5943126Sahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 5952474Seschrock 596789Sahrens #ifdef __cplusplus 597789Sahrens } 598789Sahrens #endif 599789Sahrens 600789Sahrens #endif /* _LIBZFS_H */ 601