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_INVALIDNAME, /* invalid dataset name */ 702082Seschrock EZFS_BADRESTORE, /* unable to restore to destination */ 712082Seschrock EZFS_BADBACKUP, /* backup failed */ 722082Seschrock EZFS_BADTARGET, /* bad attach/detach/replace target */ 732082Seschrock EZFS_NODEVICE, /* no such device in pool */ 742082Seschrock EZFS_BADDEV, /* invalid device to add */ 752082Seschrock EZFS_NOREPLICAS, /* no valid replicas */ 762082Seschrock EZFS_RESILVERING, /* currently resilvering */ 772082Seschrock EZFS_BADVERSION, /* unsupported version */ 782082Seschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 792082Seschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 802082Seschrock EZFS_BADPATH, /* must be an absolute path */ 812082Seschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 822082Seschrock EZFS_ZONED, /* used improperly in local zone */ 832082Seschrock EZFS_MOUNTFAILED, /* failed to mount dataset */ 842082Seschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 853126Sahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 863126Sahl EZFS_SHARENFSFAILED, /* share(1M) failed */ 872082Seschrock EZFS_PERM, /* permission denied */ 882082Seschrock EZFS_NOSPC, /* out of space */ 892082Seschrock EZFS_IO, /* I/O error */ 902082Seschrock EZFS_INTR, /* signal received */ 912082Seschrock EZFS_ISSPARE, /* device is a hot spare */ 922082Seschrock EZFS_INVALCONFIG, /* invalid vdev configuration */ 932474Seschrock EZFS_RECURSIVE, /* recursive dependency */ 942926Sek110237 EZFS_NOHISTORY, /* no history object */ 953126Sahl EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 963126Sahl EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 973912Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 983912Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 993912Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 1003978Smmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 1014276Staylor EZFS_OPENFAILED, /* open of device failed */ 1024276Staylor EZFS_NOCAP, /* couldn't get capacity */ 1034276Staylor EZFS_LABELFAILED, /* write of label failed */ 1044543Smarks EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 1054543Smarks EZFS_BADWHO, /* invalid permission who */ 1064543Smarks EZFS_BADPERM, /* invalid permission */ 1074543Smarks EZFS_BADPERMSET, /* invalid permission set name */ 1084543Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 1094543Smarks EZFS_PERMRDONLY, /* pemissions are readonly */ 1105331Samw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 1115331Samw EZFS_SHARESMBFAILED, /* failed to share over smb */ 1125363Seschrock EZFS_BADCACHE, /* bad cache file */ 1135450Sbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 1146423Sgw25295 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 1157042Sgw25295 EZFS_NOTSUP, /* ops not supported on this dataset */ 1167214Slling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 1179701SGeorge.Wilson@Sun.COM EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 11810242Schris.kirby@sun.com EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 11910242Schris.kirby@sun.com EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 12010342Schris.kirby@sun.com EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 1213912Slling EZFS_UNKNOWN 1222082Seschrock }; 1232082Seschrock 1242082Seschrock /* 1254543Smarks * The following data structures are all part 1264543Smarks * of the zfs_allow_t data structure which is 1274543Smarks * used for printing 'allow' permissions. 1284543Smarks * It is a linked list of zfs_allow_t's which 1294543Smarks * then contain avl tree's for user/group/sets/... 1304543Smarks * and each one of the entries in those trees have 1314543Smarks * avl tree's for the permissions they belong to and 1324543Smarks * whether they are local,descendent or local+descendent 1334543Smarks * permissions. The AVL trees are used primarily for 1344543Smarks * sorting purposes, but also so that we can quickly find 1354543Smarks * a given user and or permission. 1364543Smarks */ 1374543Smarks typedef struct zfs_perm_node { 1384543Smarks avl_node_t z_node; 1394543Smarks char z_pname[MAXPATHLEN]; 1404543Smarks } zfs_perm_node_t; 1414543Smarks 1424543Smarks typedef struct zfs_allow_node { 1434543Smarks avl_node_t z_node; 1444543Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 1454543Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 1464543Smarks avl_tree_t z_local; /* local permissions */ 1474543Smarks avl_tree_t z_descend; /* descendent permissions */ 1484543Smarks } zfs_allow_node_t; 1494543Smarks 1504543Smarks typedef struct zfs_allow { 1514543Smarks struct zfs_allow *z_next; 1524543Smarks char z_setpoint[MAXPATHLEN]; 1534543Smarks avl_tree_t z_sets; 1544543Smarks avl_tree_t z_crperms; 1554543Smarks avl_tree_t z_user; 1564543Smarks avl_tree_t z_group; 1574543Smarks avl_tree_t z_everyone; 1584543Smarks } zfs_allow_t; 1594543Smarks 1604543Smarks /* 161789Sahrens * Basic handle types 162789Sahrens */ 163789Sahrens typedef struct zfs_handle zfs_handle_t; 164789Sahrens typedef struct zpool_handle zpool_handle_t; 1652082Seschrock typedef struct libzfs_handle libzfs_handle_t; 1662082Seschrock 1672082Seschrock /* 1682082Seschrock * Library initialization 1692082Seschrock */ 1702082Seschrock extern libzfs_handle_t *libzfs_init(void); 1712082Seschrock extern void libzfs_fini(libzfs_handle_t *); 1722082Seschrock 1732082Seschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 1742082Seschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 1752082Seschrock 1762082Seschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 1772082Seschrock 1782082Seschrock extern int libzfs_errno(libzfs_handle_t *); 1792082Seschrock extern const char *libzfs_error_action(libzfs_handle_t *); 1802082Seschrock extern const char *libzfs_error_description(libzfs_handle_t *); 1818228SEric.Taylor@Sun.COM extern void libzfs_mnttab_init(libzfs_handle_t *); 1828228SEric.Taylor@Sun.COM extern void libzfs_mnttab_fini(libzfs_handle_t *); 1838811SEric.Taylor@Sun.COM extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 1848228SEric.Taylor@Sun.COM extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 1858228SEric.Taylor@Sun.COM struct mnttab *); 1868228SEric.Taylor@Sun.COM extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 1878228SEric.Taylor@Sun.COM const char *, const char *); 1888228SEric.Taylor@Sun.COM extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 189789Sahrens 190789Sahrens /* 191789Sahrens * Basic handle functions 192789Sahrens */ 1932082Seschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 1942082Seschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 195789Sahrens extern void zpool_close(zpool_handle_t *); 196789Sahrens extern const char *zpool_get_name(zpool_handle_t *); 197789Sahrens extern int zpool_get_state(zpool_handle_t *); 1985094Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 1996865Srm160521 extern void zpool_free_handles(libzfs_handle_t *); 200789Sahrens 201789Sahrens /* 202789Sahrens * Iterate over all active pools in the system. 203789Sahrens */ 204789Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 2052082Seschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 206789Sahrens 207789Sahrens /* 208789Sahrens * Functions to create and destroy pools 209789Sahrens */ 2102082Seschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2117184Stimh nvlist_t *, nvlist_t *); 212789Sahrens extern int zpool_destroy(zpool_handle_t *); 213789Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 214789Sahrens 215789Sahrens /* 216789Sahrens * Functions to manipulate pool and vdev state 217789Sahrens */ 218789Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 219*10921STim.Haley@Sun.COM extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 220789Sahrens 2214451Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2224451Seschrock vdev_state_t *); 2234451Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2244451Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2254451Seschrock const char *, nvlist_t *, int); 226789Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 2272082Seschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2284451Seschrock 22910817SEric.Schrock@Sun.COM extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 23010817SEric.Schrock@Sun.COM extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 2314451Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2324451Seschrock 2335450Sbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 2347326SEric.Schrock@Sun.COM boolean_t *, boolean_t *); 2359816SGeorge.Wilson@Sun.COM extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 2369816SGeorge.Wilson@Sun.COM boolean_t *, boolean_t *, boolean_t *); 2374276Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 238789Sahrens 239789Sahrens /* 2403912Slling * Functions to manage pool properties 2413912Slling */ 2423912Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2434451Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 2445094Slling size_t proplen, zprop_source_t *); 2455094Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 2465094Slling zprop_source_t *); 2475094Slling 2483912Slling extern const char *zpool_prop_to_name(zpool_prop_t); 2493912Slling extern const char *zpool_prop_values(zpool_prop_t); 2503912Slling 2513912Slling /* 252789Sahrens * Pool health statistics. 253789Sahrens */ 254789Sahrens typedef enum { 255789Sahrens /* 256789Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 2571003Slling * event namespace. Each is associated with a corresponding message ID. 258789Sahrens */ 259789Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 260789Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 261789Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 262789Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 2631003Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 264789Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 265789Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 266789Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 267789Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 2681760Seschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 2693975Sek110237 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 2706523Sek110237 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 2716523Sek110237 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 2728343SEric.Schrock@Sun.COM ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 2738343SEric.Schrock@Sun.COM 2748343SEric.Schrock@Sun.COM /* 2758343SEric.Schrock@Sun.COM * These faults have no corresponding message ID. At the time we are 2768343SEric.Schrock@Sun.COM * checking the status, the original reason for the FMA fault (I/O or 2778343SEric.Schrock@Sun.COM * checksum errors) has been lost. 2788343SEric.Schrock@Sun.COM */ 2794451Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2804451Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 281789Sahrens 282789Sahrens /* 283789Sahrens * The following are not faults per se, but still an error possibly 2841003Slling * requiring administrative attention. There is no corresponding 285789Sahrens * message ID. 286789Sahrens */ 2871760Seschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 288789Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 289789Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 29010151SGeorge.Wilson@Sun.COM ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 291789Sahrens 292789Sahrens /* 293789Sahrens * Finally, the following indicates a healthy pool. 294789Sahrens */ 295789Sahrens ZPOOL_STATUS_OK 296789Sahrens } zpool_status_t; 297789Sahrens 2981544Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 2991544Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 300789Sahrens 301789Sahrens /* 302789Sahrens * Statistics and configuration functions. 303789Sahrens */ 3041544Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 3052142Seschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 3063444Sek110237 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 3071544Seschrock 308789Sahrens /* 309789Sahrens * Import and export functions 310789Sahrens */ 3117214Slling extern int zpool_export(zpool_handle_t *, boolean_t); 3128211SGeorge.Wilson@Sun.COM extern int zpool_export_force(zpool_handle_t *); 3132082Seschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 3145094Slling char *altroot); 3155094Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 3166643Seschrock nvlist_t *, boolean_t); 317789Sahrens 318789Sahrens /* 319789Sahrens * Search for pools to import 320789Sahrens */ 3216807Sck153898 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3225994Sck153898 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 3236957Sck153898 char *, uint64_t); 3246807Sck153898 extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **, 3256807Sck153898 char *); 3266807Sck153898 extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **, 3276807Sck153898 uint64_t); 3286807Sck153898 extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **); 329789Sahrens 330789Sahrens /* 3311354Seschrock * Miscellaneous pool functions 3321354Seschrock */ 3334543Smarks struct zfs_cmd; 3344543Smarks 33510685SGeorge.Wilson@Sun.COM extern const char *hist_event_table[LOG_END]; 33610685SGeorge.Wilson@Sun.COM 33710594SGeorge.Wilson@Sun.COM extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 33810594SGeorge.Wilson@Sun.COM boolean_t verbose); 3395094Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 3402926Sek110237 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 34110685SGeorge.Wilson@Sun.COM extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 34210685SGeorge.Wilson@Sun.COM nvlist_t ***, uint_t *); 3434988Sek110237 extern void zpool_set_history_str(const char *subcommand, int argc, 3444988Sek110237 char **argv, char *history_str); 3454988Sek110237 extern int zpool_stage_history(libzfs_handle_t *, const char *); 3463444Sek110237 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 3473444Sek110237 size_t len); 3484543Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 3499160SSherry.Moore@Sun.COM extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 350*10921STim.Haley@Sun.COM extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 351*10921STim.Haley@Sun.COM nvlist_t *); 3529160SSherry.Moore@Sun.COM 3531354Seschrock /* 354789Sahrens * Basic handle manipulations. These functions do not create or destroy the 355789Sahrens * underlying datasets, only the references to them. 356789Sahrens */ 3572082Seschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 358789Sahrens extern void zfs_close(zfs_handle_t *); 359789Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 360789Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 3617538SRichard.Morris@Sun.COM extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 362789Sahrens 363789Sahrens /* 364789Sahrens * Property management functions. Some functions are shared with the kernel, 3651003Slling * and are found in sys/fs/zfs.h. 366789Sahrens */ 3675094Slling 3685094Slling /* 3695094Slling * zfs dataset property management 3705094Slling */ 3715094Slling extern const char *zfs_prop_default_string(zfs_prop_t); 3722676Seschrock extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 3732676Seschrock extern const char *zfs_prop_column_name(zfs_prop_t); 3742676Seschrock extern boolean_t zfs_prop_align_right(zfs_prop_t); 3752676Seschrock 3767184Stimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 3777184Stimh nvlist_t *, uint64_t, zfs_handle_t *, const char *); 3787184Stimh 3795094Slling extern const char *zfs_prop_to_name(zfs_prop_t); 3805094Slling extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 3815094Slling extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 3825094Slling zprop_source_t *, char *, size_t, boolean_t); 3835094Slling extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 3845094Slling zprop_source_t *, char *, size_t); 3859469SLin.Ling@Sun.COM extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 3869469SLin.Ling@Sun.COM uint64_t *propvalue); 3879396SMatthew.Ahrens@Sun.COM extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 3889396SMatthew.Ahrens@Sun.COM char *propbuf, int proplen, boolean_t literal); 3895094Slling extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 3905094Slling extern int zfs_prop_inherit(zfs_handle_t *, const char *); 3915094Slling extern const char *zfs_prop_values(zfs_prop_t); 3925094Slling extern int zfs_prop_is_string(zfs_prop_t prop); 3935094Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 3945094Slling 3955094Slling typedef struct zprop_list { 3965094Slling int pl_prop; 3972676Seschrock char *pl_user_prop; 3985094Slling struct zprop_list *pl_next; 3992676Seschrock boolean_t pl_all; 4002676Seschrock size_t pl_width; 4012676Seschrock boolean_t pl_fixed; 4025094Slling } zprop_list_t; 4033912Slling 4045094Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 4058802SSanjeev.Bagewadi@Sun.COM extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 406789Sahrens 407789Sahrens #define ZFS_MOUNTPOINT_NONE "none" 408789Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 409789Sahrens 410789Sahrens /* 4115094Slling * zpool property management 4125094Slling */ 4135094Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 4145094Slling extern const char *zpool_prop_default_string(zpool_prop_t); 4155094Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 4165094Slling extern const char *zpool_prop_column_name(zpool_prop_t); 4175094Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 4185094Slling 4195094Slling /* 4205094Slling * Functions shared by zfs and zpool property management. 4213912Slling */ 4225094Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 4235094Slling boolean_t ordered, zfs_type_t type); 4245094Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 4255094Slling zfs_type_t); 4265094Slling extern void zprop_free_list(zprop_list_t *); 4275094Slling 4285094Slling /* 4295094Slling * Functions for printing zfs or zpool properties 4305094Slling */ 4315094Slling typedef struct zprop_get_cbdata { 4323912Slling int cb_sources; 4333912Slling int cb_columns[4]; 4343912Slling int cb_colwidths[5]; 4353912Slling boolean_t cb_scripted; 4363912Slling boolean_t cb_literal; 4373912Slling boolean_t cb_first; 4385094Slling zprop_list_t *cb_proplist; 4395094Slling zfs_type_t cb_type; 4405094Slling } zprop_get_cbdata_t; 4413912Slling 4425094Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 4435094Slling const char *, const char *, zprop_source_t, const char *); 4443912Slling 4453912Slling #define GET_COL_NAME 1 4463912Slling #define GET_COL_PROPERTY 2 4473912Slling #define GET_COL_VALUE 3 4483912Slling #define GET_COL_SOURCE 4 4493912Slling 4503912Slling /* 451789Sahrens * Iterator functions. 452789Sahrens */ 453789Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 4542082Seschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 455789Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4562474Seschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4571356Seschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4581356Seschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 45910342Schris.kirby@sun.com extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 460789Sahrens 461789Sahrens /* 462789Sahrens * Functions to create and destroy datasets. 463789Sahrens */ 4642082Seschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 4652676Seschrock nvlist_t *); 4664490Svb160487 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 46710242Schris.kirby@sun.com extern int zfs_destroy(zfs_handle_t *, boolean_t); 46810242Schris.kirby@sun.com extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 4692676Seschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 4707265Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 4715749Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 4724490Svb160487 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 4735367Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 4745367Sahrens boolean_t, boolean_t, boolean_t, boolean_t, int); 4752082Seschrock extern int zfs_promote(zfs_handle_t *); 47610342Schris.kirby@sun.com extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t, 47710342Schris.kirby@sun.com boolean_t); 47810342Schris.kirby@sun.com extern int zfs_hold_range(zfs_handle_t *, const char *, const char *, 47910342Schris.kirby@sun.com const char *, boolean_t); 48010242Schris.kirby@sun.com extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 48110342Schris.kirby@sun.com extern int zfs_release_range(zfs_handle_t *, const char *, const char *, 48210342Schris.kirby@sun.com const char *); 483789Sahrens 4849554SMatthew.Ahrens@Sun.COM typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 4859396SMatthew.Ahrens@Sun.COM uid_t rid, uint64_t space); 4869396SMatthew.Ahrens@Sun.COM 4879396SMatthew.Ahrens@Sun.COM extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type, 4889396SMatthew.Ahrens@Sun.COM zfs_userspace_cb_t func, void *arg); 4899396SMatthew.Ahrens@Sun.COM 4905367Sahrens typedef struct recvflags { 4915446Sahrens /* print informational messages (ie, -v was specified) */ 4925501Seschrock int verbose : 1; 4935446Sahrens 4945446Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 4955501Seschrock int isprefix : 1; 4965446Sahrens 4975446Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 4985501Seschrock int dryrun : 1; 4995446Sahrens 5005446Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 5015501Seschrock int force : 1; 5025446Sahrens 5035446Sahrens /* set "canmount=off" on all modified filesystems */ 5045501Seschrock int canmountoff : 1; 5055446Sahrens 5065446Sahrens /* byteswap flag is used internally; callers need not specify */ 5075501Seschrock int byteswap : 1; 5088584SLori.Alt@Sun.COM 5098584SLori.Alt@Sun.COM /* do not mount file systems as they are extracted (private) */ 5108584SLori.Alt@Sun.COM int nomount : 1; 5115367Sahrens } recvflags_t; 5125367Sahrens 5135367Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 5145367Sahrens int, avl_tree_t *); 5155367Sahrens 516789Sahrens /* 517789Sahrens * Miscellaneous functions. 518789Sahrens */ 519789Sahrens extern const char *zfs_type_to_name(zfs_type_t); 520789Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 521789Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 5223635Sck153898 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 5234490Svb160487 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 5244490Svb160487 zfs_type_t); 5255713Srm160521 extern int zfs_spa_version(zfs_handle_t *, int *); 526789Sahrens 527789Sahrens /* 528789Sahrens * Mount support functions. 529789Sahrens */ 5303444Sek110237 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 5312082Seschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 532789Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 533789Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 534789Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 535789Sahrens 536789Sahrens /* 537789Sahrens * Share support functions. 538789Sahrens */ 5393126Sahl extern boolean_t zfs_is_shared(zfs_handle_t *); 540789Sahrens extern int zfs_share(zfs_handle_t *); 5413126Sahl extern int zfs_unshare(zfs_handle_t *); 5423126Sahl 5433126Sahl /* 5444451Seschrock * Protocol-specific share support functions. 5453126Sahl */ 5463126Sahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 5475331Samw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 5483126Sahl extern int zfs_share_nfs(zfs_handle_t *); 5495331Samw extern int zfs_share_smb(zfs_handle_t *); 5505331Samw extern int zfs_shareall(zfs_handle_t *); 5513126Sahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 5525331Samw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 5533126Sahl extern int zfs_unshareall_nfs(zfs_handle_t *); 5545331Samw extern int zfs_unshareall_smb(zfs_handle_t *); 5555331Samw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 5565331Samw extern int zfs_unshareall(zfs_handle_t *); 5573126Sahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 5583126Sahl extern int zfs_share_iscsi(zfs_handle_t *); 5593126Sahl extern int zfs_unshare_iscsi(zfs_handle_t *); 5604543Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 5618845Samw@Sun.COM extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 5625331Samw void *, void *, int, zfs_share_op_t); 563789Sahrens 564789Sahrens /* 565789Sahrens * When dealing with nvlists, verify() is extremely useful 566789Sahrens */ 567789Sahrens #ifdef NDEBUG 568789Sahrens #define verify(EX) ((void)(EX)) 569789Sahrens #else 570789Sahrens #define verify(EX) assert(EX) 571789Sahrens #endif 572789Sahrens 573789Sahrens /* 574789Sahrens * Utility function to convert a number to a human-readable form. 575789Sahrens */ 576789Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 5772676Seschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 578789Sahrens 579789Sahrens /* 580789Sahrens * Given a device or file, determine if it is part of a pool. 581789Sahrens */ 5822082Seschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 5832082Seschrock boolean_t *); 584789Sahrens 585789Sahrens /* 58610830SEric.Schrock@Sun.COM * Label manipulation. 587789Sahrens */ 5882082Seschrock extern int zpool_read_label(int, nvlist_t **); 58910830SEric.Schrock@Sun.COM extern int zpool_clear_label(int); 590789Sahrens 5916423Sgw25295 /* is this zvol valid for use as a dump device? */ 5926423Sgw25295 extern int zvol_check_dump_config(char *); 5936423Sgw25295 5942474Seschrock /* 5958845Samw@Sun.COM * Management interfaces for SMB ACL files 5968845Samw@Sun.COM */ 5978845Samw@Sun.COM 5988845Samw@Sun.COM int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 5998845Samw@Sun.COM int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 6008845Samw@Sun.COM int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 6018845Samw@Sun.COM int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 6028845Samw@Sun.COM 6038845Samw@Sun.COM /* 6043126Sahl * Enable and disable datasets within a pool by mounting/unmounting and 6053126Sahl * sharing/unsharing them. 6062474Seschrock */ 6073126Sahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 6083126Sahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 6092474Seschrock 61010817SEric.Schrock@Sun.COM /* 61110817SEric.Schrock@Sun.COM * Mappings between vdev and FRU. 61210817SEric.Schrock@Sun.COM */ 61310817SEric.Schrock@Sun.COM extern void libzfs_fru_refresh(libzfs_handle_t *); 61410817SEric.Schrock@Sun.COM extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 61510817SEric.Schrock@Sun.COM extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 61610817SEric.Schrock@Sun.COM extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 61710817SEric.Schrock@Sun.COM const char *); 61810817SEric.Schrock@Sun.COM extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 61910817SEric.Schrock@Sun.COM extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 62010817SEric.Schrock@Sun.COM 621789Sahrens #ifdef __cplusplus 622789Sahrens } 623789Sahrens #endif 624789Sahrens 625789Sahrens #endif /* _LIBZFS_H */ 626