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 /* 2355434c77Sek * Copyright 2007 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 #pragma ident "%Z%%M% %I% %E% SMI" 31fa9e4066Sahrens 32fa9e4066Sahrens #include <assert.h> 33fa9e4066Sahrens #include <libnvpair.h> 34fa9e4066Sahrens #include <sys/param.h> 35fa9e4066Sahrens #include <sys/types.h> 36fa9e4066Sahrens #include <sys/varargs.h> 37fa9e4066Sahrens #include <sys/fs/zfs.h> 38ecd6cf80Smarks #include <sys/avl.h> 39ecd6cf80Smarks #include <ucred.h> 40fa9e4066Sahrens 41fa9e4066Sahrens #ifdef __cplusplus 42fa9e4066Sahrens extern "C" { 43fa9e4066Sahrens #endif 44fa9e4066Sahrens 45fa9e4066Sahrens /* 46fa9e4066Sahrens * Miscellaneous ZFS constants 47fa9e4066Sahrens */ 48fa9e4066Sahrens #define ZFS_MAXNAMELEN MAXNAMELEN 49fa9e4066Sahrens #define ZPOOL_MAXNAMELEN MAXNAMELEN 50fa9e4066Sahrens #define ZFS_MAXPROPLEN MAXPATHLEN 51990b4856Slling #define ZPOOL_MAXPROPLEN MAXPATHLEN 52fa9e4066Sahrens 5399653d4eSeschrock /* 5499653d4eSeschrock * libzfs errors 5599653d4eSeschrock */ 5699653d4eSeschrock enum { 5799653d4eSeschrock EZFS_NOMEM = 2000, /* out of memory */ 5899653d4eSeschrock EZFS_BADPROP, /* invalid property value */ 5999653d4eSeschrock EZFS_PROPREADONLY, /* cannot set readonly property */ 6099653d4eSeschrock EZFS_PROPTYPE, /* property does not apply to dataset type */ 6199653d4eSeschrock EZFS_PROPNONINHERIT, /* property is not inheritable */ 6299653d4eSeschrock EZFS_PROPSPACE, /* bad quota or reservation */ 6399653d4eSeschrock EZFS_BADTYPE, /* dataset is not of appropriate type */ 6499653d4eSeschrock EZFS_BUSY, /* pool or dataset is busy */ 6599653d4eSeschrock EZFS_EXISTS, /* pool or dataset already exists */ 6699653d4eSeschrock EZFS_NOENT, /* no such pool or dataset */ 6799653d4eSeschrock EZFS_BADSTREAM, /* bad backup stream */ 6899653d4eSeschrock EZFS_DSREADONLY, /* dataset is readonly */ 6999653d4eSeschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 7099653d4eSeschrock EZFS_VOLHASDATA, /* volume already contains data */ 7199653d4eSeschrock EZFS_INVALIDNAME, /* invalid dataset name */ 7299653d4eSeschrock EZFS_BADRESTORE, /* unable to restore to destination */ 7399653d4eSeschrock EZFS_BADBACKUP, /* backup failed */ 7499653d4eSeschrock EZFS_BADTARGET, /* bad attach/detach/replace target */ 7599653d4eSeschrock EZFS_NODEVICE, /* no such device in pool */ 7699653d4eSeschrock EZFS_BADDEV, /* invalid device to add */ 7799653d4eSeschrock EZFS_NOREPLICAS, /* no valid replicas */ 7899653d4eSeschrock EZFS_RESILVERING, /* currently resilvering */ 7999653d4eSeschrock EZFS_BADVERSION, /* unsupported version */ 8099653d4eSeschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 8199653d4eSeschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 8299653d4eSeschrock EZFS_BADPATH, /* must be an absolute path */ 8399653d4eSeschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 8499653d4eSeschrock EZFS_ZONED, /* used improperly in local zone */ 8599653d4eSeschrock EZFS_MOUNTFAILED, /* failed to mount dataset */ 8699653d4eSeschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 87f3861e1aSahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 88f3861e1aSahl EZFS_SHARENFSFAILED, /* share(1M) failed */ 8999653d4eSeschrock EZFS_DEVLINKS, /* failed to create zvol links */ 9099653d4eSeschrock EZFS_PERM, /* permission denied */ 9199653d4eSeschrock EZFS_NOSPC, /* out of space */ 9299653d4eSeschrock EZFS_IO, /* I/O error */ 9399653d4eSeschrock EZFS_INTR, /* signal received */ 9499653d4eSeschrock EZFS_ISSPARE, /* device is a hot spare */ 9599653d4eSeschrock EZFS_INVALCONFIG, /* invalid vdev configuration */ 963bb79becSeschrock EZFS_RECURSIVE, /* recursive dependency */ 9706eeb2adSek EZFS_NOHISTORY, /* no history object */ 98f3861e1aSahl EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */ 99f3861e1aSahl EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */ 100b1b8ab34Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 101b1b8ab34Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 102b1b8ab34Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 103b7661cccSmmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 1048488aeb5Staylor EZFS_OPENFAILED, /* open of device failed */ 1058488aeb5Staylor EZFS_NOCAP, /* couldn't get capacity */ 1068488aeb5Staylor EZFS_LABELFAILED, /* write of label failed */ 107ecd6cf80Smarks EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */ 108ecd6cf80Smarks EZFS_BADWHO, /* invalid permission who */ 109ecd6cf80Smarks EZFS_BADPERM, /* invalid permission */ 110ecd6cf80Smarks EZFS_BADPERMSET, /* invalid permission set name */ 111ecd6cf80Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 112ecd6cf80Smarks EZFS_PERMRDONLY, /* pemissions are readonly */ 113*da6c28aaSamw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 114*da6c28aaSamw EZFS_SHARESMBFAILED, /* failed to share over smb */ 115b1b8ab34Slling EZFS_UNKNOWN 11699653d4eSeschrock }; 11799653d4eSeschrock 118ecd6cf80Smarks /* 119ecd6cf80Smarks * The following data structures are all part 120ecd6cf80Smarks * of the zfs_allow_t data structure which is 121ecd6cf80Smarks * used for printing 'allow' permissions. 122ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 123ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 124ecd6cf80Smarks * and each one of the entries in those trees have 125ecd6cf80Smarks * avl tree's for the permissions they belong to and 126ecd6cf80Smarks * whether they are local,descendent or local+descendent 127ecd6cf80Smarks * permissions. The AVL trees are used primarily for 128ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 129ecd6cf80Smarks * a given user and or permission. 130ecd6cf80Smarks */ 131ecd6cf80Smarks typedef struct zfs_perm_node { 132ecd6cf80Smarks avl_node_t z_node; 133ecd6cf80Smarks char z_pname[MAXPATHLEN]; 134ecd6cf80Smarks } zfs_perm_node_t; 135ecd6cf80Smarks 136ecd6cf80Smarks typedef struct zfs_allow_node { 137ecd6cf80Smarks avl_node_t z_node; 138ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 139ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 140ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 141ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 142ecd6cf80Smarks } zfs_allow_node_t; 143ecd6cf80Smarks 144ecd6cf80Smarks typedef struct zfs_allow { 145ecd6cf80Smarks struct zfs_allow *z_next; 146ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 147ecd6cf80Smarks avl_tree_t z_sets; 148ecd6cf80Smarks avl_tree_t z_crperms; 149ecd6cf80Smarks avl_tree_t z_user; 150ecd6cf80Smarks avl_tree_t z_group; 151ecd6cf80Smarks avl_tree_t z_everyone; 152ecd6cf80Smarks } zfs_allow_t; 153ecd6cf80Smarks 154fa9e4066Sahrens /* 155fa9e4066Sahrens * Basic handle types 156fa9e4066Sahrens */ 157fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 158fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 15999653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 16099653d4eSeschrock 16199653d4eSeschrock /* 16299653d4eSeschrock * Library initialization 16399653d4eSeschrock */ 16499653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 16599653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 16699653d4eSeschrock 16799653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 16899653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 16999653d4eSeschrock 17099653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 17199653d4eSeschrock 17299653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 17399653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 17499653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 175fa9e4066Sahrens 176fa9e4066Sahrens /* 177fa9e4066Sahrens * Basic handle functions 178fa9e4066Sahrens */ 17999653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 18099653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 181fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 182fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 183fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 184990b4856Slling extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 185fa9e4066Sahrens 186fa9e4066Sahrens /* 187fa9e4066Sahrens * Iterate over all active pools in the system. 188fa9e4066Sahrens */ 189fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 19099653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 191fa9e4066Sahrens 192fa9e4066Sahrens /* 193fa9e4066Sahrens * Functions to create and destroy pools 194fa9e4066Sahrens */ 19599653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 196990b4856Slling nvlist_t *); 197fa9e4066Sahrens extern int zpool_destroy(zpool_handle_t *); 198fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 199fa9e4066Sahrens 200fa9e4066Sahrens /* 201fa9e4066Sahrens * Functions to manipulate pool and vdev state 202fa9e4066Sahrens */ 203fa9e4066Sahrens extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 2043d7072f8Seschrock extern int zpool_clear(zpool_handle_t *, const char *); 205fa9e4066Sahrens 2063d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2073d7072f8Seschrock vdev_state_t *); 2083d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2093d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2103d7072f8Seschrock const char *, nvlist_t *, int); 211fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 21299653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2133d7072f8Seschrock 2143d7072f8Seschrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t); 2153d7072f8Seschrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t); 2163d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2173d7072f8Seschrock 21899653d4eSeschrock extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 2198488aeb5Staylor extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); 220fa9e4066Sahrens 221b1b8ab34Slling /* 222b1b8ab34Slling * Functions to manage pool properties 223b1b8ab34Slling */ 224b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2253d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 226990b4856Slling size_t proplen, zprop_source_t *); 227990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 228990b4856Slling zprop_source_t *); 229990b4856Slling 230b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 231b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 232b1b8ab34Slling 233fa9e4066Sahrens /* 234fa9e4066Sahrens * Pool health statistics. 235fa9e4066Sahrens */ 236fa9e4066Sahrens typedef enum { 237fa9e4066Sahrens /* 238fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 239b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 240fa9e4066Sahrens */ 241fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 242fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 243fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 244fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 245b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 246fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 247fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 248fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 249fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 250eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 25195173954Sek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 2523d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 2533d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 254fa9e4066Sahrens 255fa9e4066Sahrens /* 256fa9e4066Sahrens * The following are not faults per se, but still an error possibly 257b81d61a6Slling * requiring administrative attention. There is no corresponding 258fa9e4066Sahrens * message ID. 259fa9e4066Sahrens */ 260eaca9bbdSeschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 261fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 262fa9e4066Sahrens ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 263fa9e4066Sahrens 264fa9e4066Sahrens /* 265fa9e4066Sahrens * Finally, the following indicates a healthy pool. 266fa9e4066Sahrens */ 267fa9e4066Sahrens ZPOOL_STATUS_OK 268fa9e4066Sahrens } zpool_status_t; 269fa9e4066Sahrens 270ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 271ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 272fa9e4066Sahrens 273fa9e4066Sahrens /* 274fa9e4066Sahrens * Statistics and configuration functions. 275fa9e4066Sahrens */ 276ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 27794de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 27855434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 279ea8dc4b6Seschrock 280fa9e4066Sahrens /* 281fa9e4066Sahrens * Import and export functions 282fa9e4066Sahrens */ 283fa9e4066Sahrens extern int zpool_export(zpool_handle_t *); 28499653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 285990b4856Slling char *altroot); 286990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 287990b4856Slling nvlist_t *); 288fa9e4066Sahrens 289fa9e4066Sahrens /* 290fa9e4066Sahrens * Search for pools to import 291fa9e4066Sahrens */ 29299653d4eSeschrock extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 293fa9e4066Sahrens 294c67d9675Seschrock /* 295c67d9675Seschrock * Miscellaneous pool functions 296c67d9675Seschrock */ 297ecd6cf80Smarks struct zfs_cmd; 298ecd6cf80Smarks 29999653d4eSeschrock extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 300990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 30106eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 3022a6b87f0Sek extern void zpool_set_history_str(const char *subcommand, int argc, 3032a6b87f0Sek char **argv, char *history_str); 3042a6b87f0Sek extern int zpool_stage_history(libzfs_handle_t *, const char *); 30555434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 30655434c77Sek size_t len); 307ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 308fa9e4066Sahrens /* 309fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 310fa9e4066Sahrens * underlying datasets, only the references to them. 311fa9e4066Sahrens */ 31299653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 313fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 314fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 315fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 316fa9e4066Sahrens 317fa9e4066Sahrens /* 318fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 319b81d61a6Slling * and are found in sys/fs/zfs.h. 320fa9e4066Sahrens */ 321990b4856Slling 322990b4856Slling /* 323990b4856Slling * zfs dataset property management 324990b4856Slling */ 325990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 326990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 327990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t); 328990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t); 329990b4856Slling 330e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t); 331e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 332e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 333990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 334e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 335990b4856Slling zprop_source_t *, char *, size_t); 336e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 337e9dbad6fSeschrock extern int zfs_prop_inherit(zfs_handle_t *, const char *); 338e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t); 339e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop); 340990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 341e9dbad6fSeschrock 342990b4856Slling typedef struct zprop_list { 343990b4856Slling int pl_prop; 344e9dbad6fSeschrock char *pl_user_prop; 345990b4856Slling struct zprop_list *pl_next; 346e9dbad6fSeschrock boolean_t pl_all; 347e9dbad6fSeschrock size_t pl_width; 348e9dbad6fSeschrock boolean_t pl_fixed; 349990b4856Slling } zprop_list_t; 350e9dbad6fSeschrock 351990b4856Slling extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **); 352fa9e4066Sahrens 353fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 354fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 355fa9e4066Sahrens 356b1b8ab34Slling /* 357990b4856Slling * zpool property management 358990b4856Slling */ 359990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 360990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 361990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 362990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 363990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 364990b4856Slling 365990b4856Slling /* 366990b4856Slling * Functions shared by zfs and zpool property management. 367b1b8ab34Slling */ 368990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 369990b4856Slling boolean_t ordered, zfs_type_t type); 370990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 371990b4856Slling zfs_type_t); 372990b4856Slling extern void zprop_free_list(zprop_list_t *); 373990b4856Slling 374990b4856Slling /* 375990b4856Slling * Functions for printing zfs or zpool properties 376990b4856Slling */ 377990b4856Slling typedef struct zprop_get_cbdata { 378b1b8ab34Slling int cb_sources; 379b1b8ab34Slling int cb_columns[4]; 380b1b8ab34Slling int cb_colwidths[5]; 381b1b8ab34Slling boolean_t cb_scripted; 382b1b8ab34Slling boolean_t cb_literal; 383b1b8ab34Slling boolean_t cb_first; 384990b4856Slling zprop_list_t *cb_proplist; 385990b4856Slling zfs_type_t cb_type; 386990b4856Slling } zprop_get_cbdata_t; 387b1b8ab34Slling 388990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 389990b4856Slling const char *, const char *, zprop_source_t, const char *); 390b1b8ab34Slling 391b1b8ab34Slling #define GET_COL_NAME 1 392b1b8ab34Slling #define GET_COL_PROPERTY 2 393b1b8ab34Slling #define GET_COL_VALUE 3 394b1b8ab34Slling #define GET_COL_SOURCE 4 395b1b8ab34Slling 396fa9e4066Sahrens /* 397fa9e4066Sahrens * Iterator functions. 398fa9e4066Sahrens */ 399fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 40099653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 401fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 4023bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 4037f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 4047f7322feSeschrock extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 405fa9e4066Sahrens 406fa9e4066Sahrens /* 407fa9e4066Sahrens * Functions to create and destroy datasets. 408fa9e4066Sahrens */ 40999653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 410e9dbad6fSeschrock nvlist_t *); 4117f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 412fa9e4066Sahrens extern int zfs_destroy(zfs_handle_t *); 4131d452cf5Sahrens extern int zfs_destroy_snaps(zfs_handle_t *, char *); 414e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 4151d452cf5Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t); 416b12a1c38Slling extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 4177f1f55eaSvb extern int zfs_rename(zfs_handle_t *, const char *, boolean_t); 41872bdce51Sahl extern int zfs_send(zfs_handle_t *, const char *, int); 41998579b20Snd extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int, 42072bdce51Sahl boolean_t, int); 42199653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 422fa9e4066Sahrens 423fa9e4066Sahrens /* 424fa9e4066Sahrens * Miscellaneous functions. 425fa9e4066Sahrens */ 426fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 427fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 428fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 4295aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 4307f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 4317f1f55eaSvb zfs_type_t); 432fa9e4066Sahrens 433ecd6cf80Smarks /* 434ecd6cf80Smarks * dataset permission functions. 435ecd6cf80Smarks */ 436ecd6cf80Smarks extern int zfs_perm_set(zfs_handle_t *, nvlist_t *); 437ecd6cf80Smarks extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *); 438ecd6cf80Smarks extern int zfs_build_perms(zfs_handle_t *, char *, char *, 439ecd6cf80Smarks zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t); 440ecd6cf80Smarks extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **); 441ecd6cf80Smarks extern void zfs_free_allows(zfs_allow_t *); 442ecd6cf80Smarks 443fa9e4066Sahrens /* 444fa9e4066Sahrens * Mount support functions. 445fa9e4066Sahrens */ 44655434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 44799653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 448fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 449fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 450fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 451fa9e4066Sahrens 452fa9e4066Sahrens /* 453fa9e4066Sahrens * Share support functions. 454fa9e4066Sahrens */ 455f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 456fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 457f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 458f3861e1aSahl 459f3861e1aSahl /* 4603d7072f8Seschrock * Protocol-specific share support functions. 461f3861e1aSahl */ 462f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 463*da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 464f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 465*da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 466*da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 467f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 468*da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 469f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 470*da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 471*da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 472*da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 473f3861e1aSahl extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *); 474f3861e1aSahl extern int zfs_share_iscsi(zfs_handle_t *); 475f3861e1aSahl extern int zfs_unshare_iscsi(zfs_handle_t *); 476ecd6cf80Smarks extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *); 477ecd6cf80Smarks extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, 478*da6c28aaSamw void *, void *, int, zfs_share_op_t); 479fa9e4066Sahrens 480fa9e4066Sahrens /* 481fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 482fa9e4066Sahrens */ 483fa9e4066Sahrens #ifdef NDEBUG 484fa9e4066Sahrens #define verify(EX) ((void)(EX)) 485fa9e4066Sahrens #else 486fa9e4066Sahrens #define verify(EX) assert(EX) 487fa9e4066Sahrens #endif 488fa9e4066Sahrens 489fa9e4066Sahrens /* 490fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 491fa9e4066Sahrens */ 492fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 493e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 494fa9e4066Sahrens 495fa9e4066Sahrens /* 496fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 497fa9e4066Sahrens */ 49899653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 49999653d4eSeschrock boolean_t *); 500fa9e4066Sahrens 501fa9e4066Sahrens /* 502fa9e4066Sahrens * ftyp special. Read the label from a given device. 503fa9e4066Sahrens */ 50499653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 505fa9e4066Sahrens 506fa9e4066Sahrens /* 507f3861e1aSahl * Create and remove zvol /dev links. 508fa9e4066Sahrens */ 509fa9e4066Sahrens extern int zpool_create_zvol_links(zpool_handle_t *); 510fa9e4066Sahrens extern int zpool_remove_zvol_links(zpool_handle_t *); 511fa9e4066Sahrens 5123bb79becSeschrock /* 513f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 514f3861e1aSahl * sharing/unsharing them. 5153bb79becSeschrock */ 516f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 517f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 5183bb79becSeschrock 519fa9e4066Sahrens #ifdef __cplusplus 520fa9e4066Sahrens } 521fa9e4066Sahrens #endif 522fa9e4066Sahrens 523fa9e4066Sahrens #endif /* _LIBZFS_H */ 524