1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5441d80aaSlling * Common Development and Distribution License (the "License"). 6441d80aaSlling * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21f3861e1aSahl 22fa9e4066Sahrens /* 236949a980Smarks * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 24fa9e4066Sahrens * Use is subject to license terms. 25fa9e4066Sahrens */ 26fa9e4066Sahrens 27fa9e4066Sahrens #ifndef _LIBZFS_H 28fa9e4066Sahrens #define _LIBZFS_H 29fa9e4066Sahrens 30fa9e4066Sahrens #include <assert.h> 31fa9e4066Sahrens #include <libnvpair.h> 32*ebedde84SEric Taylor #include <sys/mnttab.h> 33fa9e4066Sahrens #include <sys/param.h> 34fa9e4066Sahrens #include <sys/types.h> 35fa9e4066Sahrens #include <sys/varargs.h> 36fa9e4066Sahrens #include <sys/fs/zfs.h> 37ecd6cf80Smarks #include <sys/avl.h> 38ecd6cf80Smarks #include <ucred.h> 39fa9e4066Sahrens 40fa9e4066Sahrens #ifdef __cplusplus 41fa9e4066Sahrens extern "C" { 42fa9e4066Sahrens #endif 43fa9e4066Sahrens 44fa9e4066Sahrens /* 45fa9e4066Sahrens * Miscellaneous ZFS constants 46fa9e4066Sahrens */ 47fa9e4066Sahrens #define ZFS_MAXNAMELEN MAXNAMELEN 48fa9e4066Sahrens #define ZPOOL_MAXNAMELEN MAXNAMELEN 49fa9e4066Sahrens #define ZFS_MAXPROPLEN MAXPATHLEN 50990b4856Slling #define ZPOOL_MAXPROPLEN MAXPATHLEN 51fa9e4066Sahrens 5299653d4eSeschrock /* 5399653d4eSeschrock * libzfs errors 5499653d4eSeschrock */ 5599653d4eSeschrock enum { 5699653d4eSeschrock EZFS_NOMEM = 2000, /* out of memory */ 5799653d4eSeschrock EZFS_BADPROP, /* invalid property value */ 5899653d4eSeschrock EZFS_PROPREADONLY, /* cannot set readonly property */ 5999653d4eSeschrock EZFS_PROPTYPE, /* property does not apply to dataset type */ 6099653d4eSeschrock EZFS_PROPNONINHERIT, /* property is not inheritable */ 6199653d4eSeschrock EZFS_PROPSPACE, /* bad quota or reservation */ 6299653d4eSeschrock EZFS_BADTYPE, /* dataset is not of appropriate type */ 6399653d4eSeschrock EZFS_BUSY, /* pool or dataset is busy */ 6499653d4eSeschrock EZFS_EXISTS, /* pool or dataset already exists */ 6599653d4eSeschrock EZFS_NOENT, /* no such pool or dataset */ 6699653d4eSeschrock EZFS_BADSTREAM, /* bad backup stream */ 6799653d4eSeschrock EZFS_DSREADONLY, /* dataset is readonly */ 6899653d4eSeschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 6999653d4eSeschrock EZFS_VOLHASDATA, /* volume already contains data */ 7099653d4eSeschrock EZFS_INVALIDNAME, /* invalid dataset name */ 7199653d4eSeschrock EZFS_BADRESTORE, /* unable to restore to destination */ 7299653d4eSeschrock EZFS_BADBACKUP, /* backup failed */ 7399653d4eSeschrock EZFS_BADTARGET, /* bad attach/detach/replace target */ 7499653d4eSeschrock EZFS_NODEVICE, /* no such device in pool */ 7599653d4eSeschrock EZFS_BADDEV, /* invalid device to add */ 7699653d4eSeschrock EZFS_NOREPLICAS, /* no valid replicas */ 7799653d4eSeschrock EZFS_RESILVERING, /* currently resilvering */ 7899653d4eSeschrock EZFS_BADVERSION, /* unsupported version */ 7999653d4eSeschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 8099653d4eSeschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 8199653d4eSeschrock EZFS_BADPATH, /* must be an absolute path */ 8299653d4eSeschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 8399653d4eSeschrock EZFS_ZONED, /* used improperly in local zone */ 8499653d4eSeschrock EZFS_MOUNTFAILED, /* failed to mount dataset */ 8599653d4eSeschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 86f3861e1aSahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 87f3861e1aSahl EZFS_SHARENFSFAILED, /* share(1M) failed */ 8899653d4eSeschrock EZFS_DEVLINKS, /* failed to create zvol links */ 8999653d4eSeschrock EZFS_PERM, /* permission denied */ 9099653d4eSeschrock EZFS_NOSPC, /* out of space */ 9199653d4eSeschrock EZFS_IO, /* I/O error */ 9299653d4eSeschrock EZFS_INTR, /* signal received */ 9399653d4eSeschrock EZFS_ISSPARE, /* device is a hot spare */ 9499653d4eSeschrock EZFS_INVALCONFIG, /* invalid vdev configuration */ 953bb79becSeschrock EZFS_RECURSIVE, /* recursive dependency */ 9606eeb2adSek EZFS_NOHISTORY, /* no history object */ 97f3861e1aSahl EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 98f3861e1aSahl EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 99b1b8ab34Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 100b1b8ab34Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 101b1b8ab34Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 102b7661cccSmmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 1038488aeb5Staylor EZFS_OPENFAILED, /* open of device failed */ 1048488aeb5Staylor EZFS_NOCAP, /* couldn't get capacity */ 1058488aeb5Staylor EZFS_LABELFAILED, /* write of label failed */ 106ecd6cf80Smarks EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 107ecd6cf80Smarks EZFS_BADWHO, /* invalid permission who */ 108ecd6cf80Smarks EZFS_BADPERM, /* invalid permission */ 109ecd6cf80Smarks EZFS_BADPERMSET, /* invalid permission set name */ 110ecd6cf80Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 111ecd6cf80Smarks EZFS_PERMRDONLY, /* pemissions are readonly */ 112da6c28aaSamw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 113da6c28aaSamw EZFS_SHARESMBFAILED, /* failed to share over smb */ 1142f8aaab3Seschrock EZFS_BADCACHE, /* bad cache file */ 115fa94a07fSbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 116e7cbe64fSgw EZFS_VDEVNOTSUP, /* unsupported vdev type */ 11715e6edf1Sgw EZFS_NOTSUP, /* ops not supported on this dataset */ 11889a89ebfSlling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 119b1b8ab34Slling EZFS_UNKNOWN 12099653d4eSeschrock }; 12199653d4eSeschrock 122ecd6cf80Smarks /* 123ecd6cf80Smarks * The following data structures are all part 124ecd6cf80Smarks * of the zfs_allow_t data structure which is 125ecd6cf80Smarks * used for printing 'allow' permissions. 126ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 127ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 128ecd6cf80Smarks * and each one of the entries in those trees have 129ecd6cf80Smarks * avl tree's for the permissions they belong to and 130ecd6cf80Smarks * whether they are local,descendent or local+descendent 131ecd6cf80Smarks * permissions. The AVL trees are used primarily for 132ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 133ecd6cf80Smarks * a given user and or permission. 134ecd6cf80Smarks */ 135ecd6cf80Smarks typedef struct zfs_perm_node { 136ecd6cf80Smarks avl_node_t z_node; 137ecd6cf80Smarks char z_pname[MAXPATHLEN]; 138ecd6cf80Smarks } zfs_perm_node_t; 139ecd6cf80Smarks 140ecd6cf80Smarks typedef struct zfs_allow_node { 141ecd6cf80Smarks avl_node_t z_node; 142ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 143ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 144ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 145ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 146ecd6cf80Smarks } zfs_allow_node_t; 147ecd6cf80Smarks 148ecd6cf80Smarks typedef struct zfs_allow { 149ecd6cf80Smarks struct zfs_allow *z_next; 150ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 151ecd6cf80Smarks avl_tree_t z_sets; 152ecd6cf80Smarks avl_tree_t z_crperms; 153ecd6cf80Smarks avl_tree_t z_user; 154ecd6cf80Smarks avl_tree_t z_group; 155ecd6cf80Smarks avl_tree_t z_everyone; 156ecd6cf80Smarks } zfs_allow_t; 157ecd6cf80Smarks 158fa9e4066Sahrens /* 159fa9e4066Sahrens * Basic handle types 160fa9e4066Sahrens */ 161fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 162fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 16399653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 16499653d4eSeschrock 16599653d4eSeschrock /* 16699653d4eSeschrock * Library initialization 16799653d4eSeschrock */ 16899653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 16999653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 17099653d4eSeschrock 17199653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 17299653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 17399653d4eSeschrock 17499653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 17599653d4eSeschrock 17699653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 17799653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 17899653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 179*ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 180*ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 181*ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 182*ebedde84SEric Taylor struct mnttab *); 183*ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 184*ebedde84SEric Taylor const char *, const char *); 185*ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 186fa9e4066Sahrens 187fa9e4066Sahrens /* 188fa9e4066Sahrens * Basic handle functions 189fa9e4066Sahrens */ 19099653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 19199653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 192fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 193fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 194fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 195990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 19629ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *); 197fa9e4066Sahrens 198fa9e4066Sahrens /* 199fa9e4066Sahrens * Iterate over all active pools in the system. 200fa9e4066Sahrens */ 201fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 20299653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 203fa9e4066Sahrens 204fa9e4066Sahrens /* 205fa9e4066Sahrens * Functions to create and destroy pools 206fa9e4066Sahrens */ 20799653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2080a48a24eStimh nvlist_t *, nvlist_t *); 209fa9e4066Sahrens extern int zpool_destroy(zpool_handle_t *); 210fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 211fa9e4066Sahrens 212fa9e4066Sahrens /* 213fa9e4066Sahrens * Functions to manipulate pool and vdev state 214fa9e4066Sahrens */ 215fa9e4066Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 2163d7072f8Seschrock extern int zpool_clear(zpool_handle_t *, const char *); 217fa9e4066Sahrens 2183d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2193d7072f8Seschrock vdev_state_t *); 2203d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2213d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2223d7072f8Seschrock const char *, nvlist_t *, int); 223fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 22499653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2253d7072f8Seschrock 2263d7072f8Seschrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 2273d7072f8Seschrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 2283d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2293d7072f8Seschrock 230fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 231ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 2328488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 233fa9e4066Sahrens 234b1b8ab34Slling /* 235b1b8ab34Slling * Functions to manage pool properties 236b1b8ab34Slling */ 237b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2383d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 239990b4856Slling size_t proplen, zprop_source_t *); 240990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 241990b4856Slling zprop_source_t *); 242990b4856Slling 243b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 244b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 245b1b8ab34Slling 246fa9e4066Sahrens /* 247fa9e4066Sahrens * Pool health statistics. 248fa9e4066Sahrens */ 249fa9e4066Sahrens typedef enum { 250fa9e4066Sahrens /* 251fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 252b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 253fa9e4066Sahrens */ 254fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 255fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 256fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 257fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 258b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 259fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 260fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 261fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 262fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 263eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 26495173954Sek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 26532b87932Sek ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 26632b87932Sek ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 2673d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2683d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 269b87f3af3Sperrin ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 270fa9e4066Sahrens 271fa9e4066Sahrens /* 272fa9e4066Sahrens * The following are not faults per se, but still an error possibly 273b81d61a6Slling * requiring administrative attention. There is no corresponding 274fa9e4066Sahrens * message ID. 275fa9e4066Sahrens */ 276eaca9bbdSeschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 277fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 278fa9e4066Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 279fa9e4066Sahrens 280fa9e4066Sahrens /* 281fa9e4066Sahrens * Finally, the following indicates a healthy pool. 282fa9e4066Sahrens */ 283fa9e4066Sahrens ZPOOL_STATUS_OK 284fa9e4066Sahrens } zpool_status_t; 285fa9e4066Sahrens 286ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 287ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 288fa9e4066Sahrens 289fa9e4066Sahrens /* 290fa9e4066Sahrens * Statistics and configuration functions. 291fa9e4066Sahrens */ 292ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 29394de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 29455434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 295ea8dc4b6Seschrock 296fa9e4066Sahrens /* 297fa9e4066Sahrens * Import and export functions 298fa9e4066Sahrens */ 29989a89ebfSlling extern int zpool_export(zpool_handle_t *, boolean_t); 300394ab0cbSGeorge Wilson extern int zpool_export_force(zpool_handle_t *); 30199653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 302990b4856Slling char *altroot); 303990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 304c5904d13Seschrock nvlist_t *, boolean_t); 305fa9e4066Sahrens 306fa9e4066Sahrens /* 307fa9e4066Sahrens * Search for pools to import 308fa9e4066Sahrens */ 30924e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3103a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 311e829d913Sck char *, uint64_t); 31224e697d4Sck extern nvlist_t *zpool_find_import_byname(libzfs_handle_t *, int, char **, 31324e697d4Sck char *); 31424e697d4Sck extern nvlist_t *zpool_find_import_byguid(libzfs_handle_t *, int, char **, 31524e697d4Sck uint64_t); 31624e697d4Sck extern nvlist_t *zpool_find_import_activeok(libzfs_handle_t *, int, char **); 317fa9e4066Sahrens 318c67d9675Seschrock /* 319c67d9675Seschrock * Miscellaneous pool functions 320c67d9675Seschrock */ 321ecd6cf80Smarks struct zfs_cmd; 322ecd6cf80Smarks 32399653d4eSeschrock extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 324990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 32506eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 3262a6b87f0Sek extern void zpool_set_history_str(const char *subcommand, int argc, 3272a6b87f0Sek char **argv, char *history_str); 3282a6b87f0Sek extern int zpool_stage_history(libzfs_handle_t *, const char *); 32955434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 33055434c77Sek size_t len); 331ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 33219397407SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *); 333fa9e4066Sahrens /* 334fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 335fa9e4066Sahrens * underlying datasets, only the references to them. 336fa9e4066Sahrens */ 33799653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 338fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 339fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 340fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 341d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 342fa9e4066Sahrens 343fa9e4066Sahrens /* 344fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 345b81d61a6Slling * and are found in sys/fs/zfs.h. 346fa9e4066Sahrens */ 347990b4856Slling 348990b4856Slling /* 349990b4856Slling * zfs dataset property management 350990b4856Slling */ 351990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 352990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 353990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t); 354990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t); 355990b4856Slling 3560a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 3570a48a24eStimh nvlist_t *, uint64_t, zfs_handle_t *, const char *); 3580a48a24eStimh 359e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t); 360e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 361e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 362990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 363e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 364990b4856Slling zprop_source_t *, char *, size_t); 365e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 366e9dbad6fSeschrock extern int zfs_prop_inherit(zfs_handle_t *, const char *); 367e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t); 368e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop); 369990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 370e9dbad6fSeschrock 371990b4856Slling typedef struct zprop_list { 372990b4856Slling int pl_prop; 373e9dbad6fSeschrock char *pl_user_prop; 374990b4856Slling struct zprop_list *pl_next; 375e9dbad6fSeschrock boolean_t pl_all; 376e9dbad6fSeschrock size_t pl_width; 377e9dbad6fSeschrock boolean_t pl_fixed; 378990b4856Slling } zprop_list_t; 379e9dbad6fSeschrock 380990b4856Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 381fa9e4066Sahrens 382fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 383fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 384fa9e4066Sahrens 385b1b8ab34Slling /* 386990b4856Slling * zpool property management 387990b4856Slling */ 388990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 389990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 390990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 391990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 392990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 393990b4856Slling 394990b4856Slling /* 395990b4856Slling * Functions shared by zfs and zpool property management. 396b1b8ab34Slling */ 397990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 398990b4856Slling boolean_t ordered, zfs_type_t type); 399990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 400990b4856Slling zfs_type_t); 401990b4856Slling extern void zprop_free_list(zprop_list_t *); 402990b4856Slling 403990b4856Slling /* 404990b4856Slling * Functions for printing zfs or zpool properties 405990b4856Slling */ 406990b4856Slling typedef struct zprop_get_cbdata { 407b1b8ab34Slling int cb_sources; 408b1b8ab34Slling int cb_columns[4]; 409b1b8ab34Slling int cb_colwidths[5]; 410b1b8ab34Slling boolean_t cb_scripted; 411b1b8ab34Slling boolean_t cb_literal; 412b1b8ab34Slling boolean_t cb_first; 413990b4856Slling zprop_list_t *cb_proplist; 414990b4856Slling zfs_type_t cb_type; 415990b4856Slling } zprop_get_cbdata_t; 416b1b8ab34Slling 417990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 418990b4856Slling const char *, const char *, zprop_source_t, const char *); 419b1b8ab34Slling 420b1b8ab34Slling #define GET_COL_NAME 1 421b1b8ab34Slling #define GET_COL_PROPERTY 2 422b1b8ab34Slling #define GET_COL_VALUE 3 423b1b8ab34Slling #define GET_COL_SOURCE 4 424b1b8ab34Slling 425fa9e4066Sahrens /* 426fa9e4066Sahrens * Iterator functions. 427fa9e4066Sahrens */ 428fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 42999653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 430fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4313bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4327f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4337f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 434fa9e4066Sahrens 435fa9e4066Sahrens /* 436fa9e4066Sahrens * Functions to create and destroy datasets. 437fa9e4066Sahrens */ 43899653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 439e9dbad6fSeschrock nvlist_t *); 4407f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 441fa9e4066Sahrens extern int zfs_destroy(zfs_handle_t *); 4421d452cf5Sahrens extern int zfs_destroy_snaps(zfs_handle_t *, char *); 443e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 444bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 445c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 4467f1f55eaSvb extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 4473cb34c60Sahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 4483cb34c60Sahrens boolean_t, boolean_t, boolean_t, boolean_t, int); 44999653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 450fa9e4066Sahrens 4513cb34c60Sahrens typedef struct recvflags { 4524ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 453c6765aabSeschrock int verbose : 1; 4544ccbb6e7Sahrens 4554ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 456c6765aabSeschrock int isprefix : 1; 4574ccbb6e7Sahrens 4584ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 459c6765aabSeschrock int dryrun : 1; 4604ccbb6e7Sahrens 4614ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 462c6765aabSeschrock int force : 1; 4634ccbb6e7Sahrens 4644ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 465c6765aabSeschrock int canmountoff : 1; 4664ccbb6e7Sahrens 4674ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 468c6765aabSeschrock int byteswap : 1; 4693cb34c60Sahrens } recvflags_t; 4703cb34c60Sahrens 4713cb34c60Sahrens extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t, 4723cb34c60Sahrens int, avl_tree_t *); 4733cb34c60Sahrens 474fa9e4066Sahrens /* 475fa9e4066Sahrens * Miscellaneous functions. 476fa9e4066Sahrens */ 477fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 478fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 479fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 4805aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 4817f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 4827f1f55eaSvb zfs_type_t); 4837b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *); 484fa9e4066Sahrens 485ecd6cf80Smarks /* 486ecd6cf80Smarks * dataset permission functions. 487ecd6cf80Smarks */ 488ecd6cf80Smarks extern int zfs_perm_set(zfs_handle_t *, nvlist_t *); 489ecd6cf80Smarks extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *); 490ecd6cf80Smarks extern int zfs_build_perms(zfs_handle_t *, char *, char *, 491ecd6cf80Smarks zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t); 492ecd6cf80Smarks extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **); 493ecd6cf80Smarks extern void zfs_free_allows(zfs_allow_t *); 4946949a980Smarks extern void zfs_deleg_permissions(void); 495ecd6cf80Smarks 496fa9e4066Sahrens /* 497fa9e4066Sahrens * Mount support functions. 498fa9e4066Sahrens */ 49955434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 50099653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 501fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 502fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 503fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 504fa9e4066Sahrens 505fa9e4066Sahrens /* 506fa9e4066Sahrens * Share support functions. 507fa9e4066Sahrens */ 508f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 509fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 510f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 511f3861e1aSahl 512f3861e1aSahl /* 5133d7072f8Seschrock * Protocol-specific share support functions. 514f3861e1aSahl */ 515f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 516da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 517f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 518da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 519da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 520f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 521da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 522f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 523da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 524da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 525da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 526f3861e1aSahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 527f3861e1aSahl extern int zfs_share_iscsi(zfs_handle_t *); 528f3861e1aSahl extern int zfs_unshare_iscsi(zfs_handle_t *); 529ecd6cf80Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 530ecd6cf80Smarks extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, 531da6c28aaSamw void *, void *, int, zfs_share_op_t); 532fa9e4066Sahrens 533fa9e4066Sahrens /* 534fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 535fa9e4066Sahrens */ 536fa9e4066Sahrens #ifdef NDEBUG 537fa9e4066Sahrens #define verify(EX) ((void)(EX)) 538fa9e4066Sahrens #else 539fa9e4066Sahrens #define verify(EX) assert(EX) 540fa9e4066Sahrens #endif 541fa9e4066Sahrens 542fa9e4066Sahrens /* 543fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 544fa9e4066Sahrens */ 545fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 546e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 547fa9e4066Sahrens 548fa9e4066Sahrens /* 549fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 550fa9e4066Sahrens */ 55199653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 55299653d4eSeschrock boolean_t *); 553fa9e4066Sahrens 554fa9e4066Sahrens /* 555fa9e4066Sahrens * ftyp special. Read the label from a given device. 556fa9e4066Sahrens */ 55799653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 558fa9e4066Sahrens 559fa9e4066Sahrens /* 560f3861e1aSahl * Create and remove zvol /dev links. 561fa9e4066Sahrens */ 562fa9e4066Sahrens extern int zpool_create_zvol_links(zpool_handle_t *); 563fa9e4066Sahrens extern int zpool_remove_zvol_links(zpool_handle_t *); 564fa9e4066Sahrens 565e7cbe64fSgw /* is this zvol valid for use as a dump device? */ 566e7cbe64fSgw extern int zvol_check_dump_config(char *); 567e7cbe64fSgw 5683bb79becSeschrock /* 569f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 570f3861e1aSahl * sharing/unsharing them. 5713bb79becSeschrock */ 572f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 573f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 5743bb79becSeschrock 575fa9e4066Sahrens #ifdef __cplusplus 576fa9e4066Sahrens } 577fa9e4066Sahrens #endif 578fa9e4066Sahrens 579fa9e4066Sahrens #endif /* _LIBZFS_H */ 580