libzfs.h revision 9d9a58e3638ed2e79c339c93e9c52b7150075364
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw/*
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * CDDL HEADER START
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw *
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * The contents of this file are subject to the terms of the
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * Common Development and Distribution License (the "License").
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * You may not use this file except in compliance with the License.
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw *
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * or http://www.opensolaris.org/os/licensing.
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * See the License for the specific language governing permissions
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * and limitations under the License.
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw *
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * When distributing Covered Code, include this CDDL HEADER in each
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * If applicable, add the following below this CDDL HEADER, with the
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * fields enclosed by brackets "[]" replaced with your own identifying
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * information: Portions Copyright [yyyy] [name of copyright owner]
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw *
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * CDDL HEADER END
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw
c586600796766c83eb9485c446886fd9ed2359a9Keyur Desai/*
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#ifndef _LIBZFS_H
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#define _LIBZFS_H
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <assert.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <libnvpair.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <sys/mnttab.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <sys/param.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <sys/types.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <sys/varargs.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <sys/fs/zfs.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <sys/avl.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#include <ucred.h>
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami#ifdef __cplusplus
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahramiextern "C" {
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami#endif
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw/*
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * Miscellaneous ZFS constants
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown#define ZFS_MAXNAMELEN MAXNAMELEN
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown#define ZPOOL_MAXNAMELEN MAXNAMELEN
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown#define ZFS_MAXPROPLEN MAXPATHLEN
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown#define ZPOOL_MAXPROPLEN MAXPATHLEN
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown/*
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * libzfs errors
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brownenum {
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_NOMEM = 2000, /* out of memory */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_BADPROP, /* invalid property value */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_PROPREADONLY, /* cannot set readonly property */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_PROPTYPE, /* property does not apply to dataset type */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_PROPNONINHERIT, /* property is not inheritable */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_PROPSPACE, /* bad quota or reservation */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_BADTYPE, /* dataset is not of appropriate type */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_BUSY, /* pool or dataset is busy */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_EXISTS, /* pool or dataset already exists */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_NOENT, /* no such pool or dataset */
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States EZFS_BADSTREAM, /* bad backup stream */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_DSREADONLY, /* dataset is readonly */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_INVALIDNAME, /* invalid dataset name */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_BADRESTORE, /* unable to restore to destination */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_BADBACKUP, /* backup failed */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_BADTARGET, /* bad attach/detach/replace target */
c586600796766c83eb9485c446886fd9ed2359a9Keyur Desai EZFS_NODEVICE, /* no such device in pool */
c586600796766c83eb9485c446886fd9ed2359a9Keyur Desai EZFS_BADDEV, /* invalid device to add */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_NOREPLICAS, /* no valid replicas */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_RESILVERING, /* currently resilvering */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_BADVERSION, /* unsupported version */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_POOLUNAVAIL, /* pool is currently unavailable */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_DEVOVERFLOW, /* too many devices in one vdev */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_BADPATH, /* must be an absolute path */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_ZONED, /* used improperly in local zone */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_MOUNTFAILED, /* failed to mount dataset */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_UMOUNTFAILED, /* failed to unmount dataset */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_SHARENFSFAILED, /* share(1M) failed */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_PERM, /* permission denied */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_NOSPC, /* out of space */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_FAULT, /* bad address */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_IO, /* I/O error */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_INTR, /* signal received */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_ISSPARE, /* device is a hot spare */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_INVALCONFIG, /* invalid vdev configuration */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_RECURSIVE, /* recursive dependency */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_NOHISTORY, /* no history object */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_POOLPROPS, /* couldn't retrieve pool props */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_NAMETOOLONG, /* dataset name is too long */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_OPENFAILED, /* open of device failed */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_NOCAP, /* couldn't get capacity */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_LABELFAILED, /* write of label failed */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_BADWHO, /* invalid permission who */
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright EZFS_BADPERM, /* invalid permission */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_BADPERMSET, /* invalid permission set name */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_NODELEGATION, /* delegated administration is disabled */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw EZFS_PERMRDONLY, /* pemissions are readonly */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_SHARESMBFAILED, /* failed to share over smb */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_BADCACHE, /* bad cache file */
8e22821528b08c6dba4e8176351560f316f6d0dedm EZFS_ISL2CACHE, /* device is for the level 2 ARC */
8e22821528b08c6dba4e8176351560f316f6d0dedm EZFS_VDEVNOTSUP, /* unsupported vdev type */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_NOTSUP, /* ops not supported on this dataset */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_REFTAG_RELE, /* snapshot release: tag not found */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_PIPEFAILED, /* pipe create failed */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_THREADCREATEFAILED, /* thread create failed */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_SCRUBBING, /* currently scrubbing */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_NO_SCRUB, /* no active scrub */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown EZFS_UNKNOWN
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown};
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown/*
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * The following data structures are all part
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * of the zfs_allow_t data structure which is
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States * used for printing 'allow' permissions.
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * It is a linked list of zfs_allow_t's which
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright * then contain avl tree's for user/group/sets/...
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * and each one of the entries in those trees have
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * avl tree's for the permissions they belong to and
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * whether they are local,descendent or local+descendent
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * permissions. The AVL trees are used primarily for
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright * sorting purposes, but also so that we can quickly find
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown * a given user and or permission.
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown */
1fcced4c370617db71610fecffd5451a5894ca5eJordan Browntypedef struct zfs_perm_node {
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown avl_node_t z_node;
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown char z_pname[MAXPATHLEN];
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown} zfs_perm_node_t;
1fcced4c370617db71610fecffd5451a5894ca5eJordan Brown
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wrighttypedef struct zfs_allow_node {
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw avl_node_t z_node;
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw char z_key[MAXPATHLEN]; /* name, such as joe */
c5c4113dfcabb1eed3d4bdf7609de5170027a794nw avl_tree_t z_localdescend; /* local+descendent perms */
avl_tree_t z_local; /* local permissions */
avl_tree_t z_descend; /* descendent permissions */
} zfs_allow_node_t;
typedef struct zfs_allow {
struct zfs_allow *z_next;
char z_setpoint[MAXPATHLEN];
avl_tree_t z_sets;
avl_tree_t z_crperms;
avl_tree_t z_user;
avl_tree_t z_group;
avl_tree_t z_everyone;
} zfs_allow_t;
/*
* Basic handle types
*/
typedef struct zfs_handle zfs_handle_t;
typedef struct zpool_handle zpool_handle_t;
typedef struct libzfs_handle libzfs_handle_t;
/*
* Library initialization
*/
extern libzfs_handle_t *libzfs_init(void);
extern void libzfs_fini(libzfs_handle_t *);
extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
extern int libzfs_errno(libzfs_handle_t *);
extern const char *libzfs_error_action(libzfs_handle_t *);
extern const char *libzfs_error_description(libzfs_handle_t *);
extern void libzfs_mnttab_init(libzfs_handle_t *);
extern void libzfs_mnttab_fini(libzfs_handle_t *);
extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
struct mnttab *);
extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
const char *, const char *);
extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
/*
* Basic handle functions
*/
extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
extern void zpool_close(zpool_handle_t *);
extern const char *zpool_get_name(zpool_handle_t *);
extern int zpool_get_state(zpool_handle_t *);
extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
extern void zpool_free_handles(libzfs_handle_t *);
/*
* Iterate over all active pools in the system.
*/
typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
/*
* Functions to create and destroy pools
*/
extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
nvlist_t *, nvlist_t *);
extern int zpool_destroy(zpool_handle_t *);
extern int zpool_add(zpool_handle_t *, nvlist_t *);
typedef struct splitflags {
/* do not split, but return the config that would be split off */
int dryrun : 1;
/* after splitting, import the pool */
int import : 1;
} splitflags_t;
/*
* Functions to manipulate pool and vdev state
*/
extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
vdev_state_t *);
extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
extern int zpool_vdev_attach(zpool_handle_t *, const char *,
const char *, nvlist_t *, int);
extern int zpool_vdev_detach(zpool_handle_t *, const char *);
extern int zpool_vdev_remove(zpool_handle_t *, const char *);
extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
splitflags_t);
extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
boolean_t *, boolean_t *);
extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
boolean_t *, boolean_t *, boolean_t *);
extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
/*
* Functions to manage pool properties
*/
extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
size_t proplen, zprop_source_t *);
extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
zprop_source_t *);
extern const char *zpool_prop_to_name(zpool_prop_t);
extern const char *zpool_prop_values(zpool_prop_t);
/*
* Pool health statistics.
*/
typedef enum {
/*
* The following correspond to faults as defined in the (fault.fs.zfs.*)
* event namespace. Each is associated with a corresponding message ID.
*/
ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
/*
* These faults have no corresponding message ID. At the time we are
* checking the status, the original reason for the FMA fault (I/O or
* checksum errors) has been lost.
*/
ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
/*
* The following are not faults per se, but still an error possibly
* requiring administrative attention. There is no corresponding
* message ID.
*/
ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */
ZPOOL_STATUS_RESILVERING, /* device being resilvered */
ZPOOL_STATUS_OFFLINE_DEV, /* device online */
ZPOOL_STATUS_REMOVED_DEV, /* removed device */
/*
* Finally, the following indicates a healthy pool.
*/
ZPOOL_STATUS_OK
} zpool_status_t;
extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
extern zpool_status_t zpool_import_status(nvlist_t *, char **);
extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
/*
* Statistics and configuration functions.
*/
extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
/*
* Import and export functions
*/
extern int zpool_export(zpool_handle_t *, boolean_t);
extern int zpool_export_force(zpool_handle_t *);
extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
char *altroot);
extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
nvlist_t *, int);
/*
* Search for pools to import
*/
typedef struct importargs {
char **path; /* a list of paths to search */
int paths; /* number of paths to search */
char *poolname; /* name of a pool to find */
uint64_t guid; /* guid of a pool to find */
char *cachefile; /* cachefile to use for import */
int can_be_active : 1; /* can the pool be active? */
int unique : 1; /* does 'poolname' already exist? */
int exists : 1; /* set on return if pool already exists */
} importargs_t;
extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
/* legacy pool search routines */
extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
char *, uint64_t);
/*
* Miscellaneous pool functions
*/
struct zfs_cmd;
extern const char *zfs_history_event_names[LOG_END];
extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
boolean_t verbose);
extern int zpool_upgrade(zpool_handle_t *, uint64_t);
extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
nvlist_t ***, uint_t *);
extern void zpool_set_history_str(const char *subcommand, int argc,
char **argv, char *history_str);
extern int zpool_stage_history(libzfs_handle_t *, const char *);
extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
size_t len);
extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
nvlist_t *);
/*
* Basic handle manipulations. These functions do not create or destroy the
* underlying datasets, only the references to them.
*/
extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
extern void zfs_close(zfs_handle_t *);
extern zfs_type_t zfs_get_type(const zfs_handle_t *);
extern const char *zfs_get_name(const zfs_handle_t *);
extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
/*
* Property management functions. Some functions are shared with the kernel,
* and are found in sys/fs/zfs.h.
*/
/*
* zfs dataset property management
*/
extern const char *zfs_prop_default_string(zfs_prop_t);
extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
extern const char *zfs_prop_column_name(zfs_prop_t);
extern boolean_t zfs_prop_align_right(zfs_prop_t);
extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
nvlist_t *, uint64_t, zfs_handle_t *, const char *);
extern const char *zfs_prop_to_name(zfs_prop_t);
extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
zprop_source_t *, char *, size_t, boolean_t);
extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
boolean_t);
extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
zprop_source_t *, char *, size_t);
extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
uint64_t *propvalue);
extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
char *propbuf, int proplen, boolean_t literal);
extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
extern const char *zfs_prop_values(zfs_prop_t);
extern int zfs_prop_is_string(zfs_prop_t prop);
extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
typedef struct zprop_list {
int pl_prop;
char *pl_user_prop;
struct zprop_list *pl_next;
boolean_t pl_all;
size_t pl_width;
size_t pl_recvd_width;
boolean_t pl_fixed;
} zprop_list_t;
extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t);
extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
#define ZFS_MOUNTPOINT_NONE "none"
#define ZFS_MOUNTPOINT_LEGACY "legacy"
/*
* zpool property management
*/
extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
extern const char *zpool_prop_default_string(zpool_prop_t);
extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
extern const char *zpool_prop_column_name(zpool_prop_t);
extern boolean_t zpool_prop_align_right(zpool_prop_t);
/*
* Functions shared by zfs and zpool property management.
*/
extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
boolean_t ordered, zfs_type_t type);
extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
zfs_type_t);
extern void zprop_free_list(zprop_list_t *);
#define ZFS_GET_NCOLS 5
typedef enum {
GET_COL_NONE,
GET_COL_NAME,
GET_COL_PROPERTY,
GET_COL_VALUE,
GET_COL_RECVD,
GET_COL_SOURCE
} zfs_get_column_t;
/*
* Functions for printing zfs or zpool properties
*/
typedef struct zprop_get_cbdata {
int cb_sources;
zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
int cb_colwidths[ZFS_GET_NCOLS + 1];
boolean_t cb_scripted;
boolean_t cb_literal;
boolean_t cb_first;
zprop_list_t *cb_proplist;
zfs_type_t cb_type;
} zprop_get_cbdata_t;
void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
const char *, const char *, zprop_source_t, const char *,
const char *);
/*
* Iterator functions.
*/
typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
typedef struct get_all_cb {
zfs_handle_t **cb_handles;
size_t cb_alloc;
size_t cb_used;
boolean_t cb_verbose;
int (*cb_getone)(zfs_handle_t *, void *);
} get_all_cb_t;
void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
int libzfs_dataset_cmp(const void *, const void *);
/*
* Functions to create and destroy datasets.
*/
extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
nvlist_t *);
extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
extern int zfs_destroy(zfs_handle_t *, boolean_t);
extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
typedef struct sendflags {
/* print informational messages (ie, -v was specified) */
int verbose : 1;
/* recursive send (ie, -R) */
int replicate : 1;
/* for incrementals, do all intermediate snapshots */
int doall : 1; /* (ie, -I) */
/* if dataset is a clone, do incremental from its origin */
int fromorigin : 1;
/* do deduplication */
int dedup : 1;
/* send properties (ie, -p) */
int props : 1;
} sendflags_t;
typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
extern int zfs_send(zfs_handle_t *zhp, const char *fromsnap, const char *tosnap,
sendflags_t flags, int outfd, snapfilter_cb_t filter_func,
void *cb_arg, nvlist_t **debugnvp);
extern int zfs_promote(zfs_handle_t *);
extern int zfs_hold(zfs_handle_t *, const char *, const char *, boolean_t,
boolean_t, boolean_t, int, uint64_t, uint64_t);
extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
uid_t rid, uint64_t space);
extern int zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
zfs_userspace_cb_t func, void *arg);
typedef struct recvflags {
/* print informational messages (ie, -v was specified) */
int verbose : 1;
/* the destination is a prefix, not the exact fs (ie, -d) */
int isprefix : 1;
/*
* Only the tail of the sent snapshot path is appended to the
* destination to determine the received snapshot name (ie, -e).
*/
int istail : 1;
/* do not actually do the recv, just check if it would work (ie, -n) */
int dryrun : 1;
/* rollback/destroy filesystems as necessary (eg, -F) */
int force : 1;
/* set "canmount=off" on all modified filesystems */
int canmountoff : 1;
/* byteswap flag is used internally; callers need not specify */
int byteswap : 1;
/* do not mount file systems as they are extracted (private) */
int nomount : 1;
} recvflags_t;
extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
int, avl_tree_t *);
/*
* Miscellaneous functions.
*/
extern const char *zfs_type_to_name(zfs_type_t);
extern void zfs_refresh_properties(zfs_handle_t *);
extern int zfs_name_valid(const char *, zfs_type_t);
extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
zfs_type_t);
extern int zfs_spa_version(zfs_handle_t *, int *);
/*
* Mount support functions.
*/
extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
extern int zfs_mount(zfs_handle_t *, const char *, int);
extern int zfs_unmount(zfs_handle_t *, const char *, int);
extern int zfs_unmountall(zfs_handle_t *, int);
/*
* Share support functions.
*/
extern boolean_t zfs_is_shared(zfs_handle_t *);
extern int zfs_share(zfs_handle_t *);
extern int zfs_unshare(zfs_handle_t *);
/*
* Protocol-specific share support functions.
*/
extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
extern int zfs_share_nfs(zfs_handle_t *);
extern int zfs_share_smb(zfs_handle_t *);
extern int zfs_shareall(zfs_handle_t *);
extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
extern int zfs_unshare_smb(zfs_handle_t *, const char *);
extern int zfs_unshareall_nfs(zfs_handle_t *);
extern int zfs_unshareall_smb(zfs_handle_t *);
extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
extern int zfs_unshareall(zfs_handle_t *);
extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
void *, void *, int, zfs_share_op_t);
/*
* When dealing with nvlists, verify() is extremely useful
*/
#ifdef NDEBUG
#define verify(EX) ((void)(EX))
#else
#define verify(EX) assert(EX)
#endif
/*
* Utility function to convert a number to a human-readable form.
*/
extern void zfs_nicenum(uint64_t, char *, size_t);
extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
/*
* Given a device or file, determine if it is part of a pool.
*/
extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
boolean_t *);
/*
* Label manipulation.
*/
extern int zpool_read_label(int, nvlist_t **);
extern int zpool_clear_label(int);
/* is this zvol valid for use as a dump device? */
extern int zvol_check_dump_config(char *);
/*
* Management interfaces for SMB ACL files
*/
int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
/*
* Enable and disable datasets within a pool by mounting/unmounting and
* sharing/unsharing them.
*/
extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
/*
* Mappings between vdev and FRU.
*/
extern void libzfs_fru_refresh(libzfs_handle_t *);
extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
const char *);
extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
#ifdef __cplusplus
}
#endif
#endif /* _LIBZFS_H */