[mirror_zfs.git] / include / libzutil.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2018 by Delphix. All rights reserved.
 */

#ifndef	_LIBZUTIL_H
#define	_LIBZUTIL_H

#include <sys/nvpair.h>
#include <sys/fs/zfs.h>

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * Default wait time for a device name to be created.
 */
#define	DISK_LABEL_WAIT		(30 * 1000)  /* 30 seconds */


/*
 * Pool Config Operations
 *
 * These are specific to the library libzfs or libzpool instance.
 */
typedef nvlist_t *refresh_config_func_t(void *, nvlist_t *);

typedef int pool_active_func_t(void *, const char *, uint64_t, boolean_t *);

typedef const struct pool_config_ops {
	refresh_config_func_t	*pco_refresh_config;
	pool_active_func_t	*pco_pool_active;
} pool_config_ops_t;

/*
 * An instance of pool_config_ops_t is expected in the caller's binary.
 */
extern const pool_config_ops_t libzfs_config_ops;
extern const pool_config_ops_t libzpool_config_ops;

typedef struct importargs {
	char **path;		/* a list of paths to search		*/
	int paths;		/* number of paths to search		*/
	const char *poolname;	/* name of a pool to find		*/
	uint64_t guid;		/* guid of a pool to find		*/
	const char *cachefile;	/* cachefile to use for import		*/
	boolean_t can_be_active; /* can the pool be active?		*/
	boolean_t scan;		/* prefer scanning to libblkid cache    */
	nvlist_t *policy;	/* load policy (max txg, rewind, etc.)	*/
} importargs_t;

extern nvlist_t *zpool_search_import(void *, importargs_t *,
    const pool_config_ops_t *);
extern int zpool_find_config(void *, const char *, nvlist_t **, importargs_t *,
    const pool_config_ops_t *);

extern const char * const * zpool_default_search_paths(size_t *count);
extern int zpool_read_label(int, nvlist_t **, int *);
extern int zpool_label_disk_wait(const char *, int);

struct udev_device;

extern int zfs_device_get_devid(struct udev_device *, char *, size_t);
extern int zfs_device_get_physical(struct udev_device *, char *, size_t);

extern void update_vdev_config_dev_strs(nvlist_t *);

/*
 * Default device paths
 */
#define	DISK_ROOT	"/dev"
#define	UDISK_ROOT	"/dev/disk"
#define	ZVOL_ROOT	"/dev/zvol"

extern int zfs_append_partition(char *path, size_t max_len);
extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen);

extern char *zfs_strip_partition(char *);
extern char *zfs_strip_path(char *);

extern int zfs_strcmp_pathname(const char *, const char *, int);

extern boolean_t zfs_dev_is_dm(const char *);
extern boolean_t zfs_dev_is_whole_disk(const char *);
extern int zfs_dev_flush(int);
extern char *zfs_get_underlying_path(const char *);
extern char *zfs_get_enclosure_sysfs_path(const char *);

extern boolean_t is_mpath_whole_disk(const char *);

extern boolean_t zfs_isnumber(const char *);

/*
 * Formats for iostat numbers.  Examples: "12K", "30ms", "4B", "2321234", "-".
 *
 * ZFS_NICENUM_1024:	Print kilo, mega, tera, peta, exa..
 * ZFS_NICENUM_BYTES:	Print single bytes ("13B"), kilo, mega, tera...
 * ZFS_NICENUM_TIME:	Print nanosecs, microsecs, millisecs, seconds...
 * ZFS_NICENUM_RAW:	Print the raw number without any formatting
 * ZFS_NICENUM_RAWTIME:	Same as RAW, but print dashes ('-') for zero.
 */
enum zfs_nicenum_format {
	ZFS_NICENUM_1024 = 0,
	ZFS_NICENUM_BYTES = 1,
	ZFS_NICENUM_TIME = 2,
	ZFS_NICENUM_RAW = 3,
	ZFS_NICENUM_RAWTIME = 4
};

/*
 * Convert a number to a human-readable form.
 */
extern void zfs_nicebytes(uint64_t, char *, size_t);
extern void zfs_nicenum(uint64_t, char *, size_t);
extern void zfs_nicenum_format(uint64_t, char *, size_t,
    enum zfs_nicenum_format);
extern void zfs_nicetime(uint64_t, char *, size_t);

#define	nicenum(num, buf, size)	zfs_nicenum(num, buf, size)

extern void zpool_dump_ddt(const ddt_stat_t *, const ddt_histogram_t *);
extern int zpool_history_unpack(char *, uint64_t, uint64_t *, nvlist_t ***,
    uint_t *);

struct zfs_cmd;
int zfs_ioctl_fd(int fd, unsigned long request, struct zfs_cmd *zc);

#ifdef	__cplusplus
}
#endif

#endif	/* _LIBZUTIL_H */
Commit	Line	Data
e89f1295 DB	1	/*
	2	* CDDL HEADER START
	3	*
	4	* The contents of this file are subject to the terms of the
	5	* Common Development and Distribution License (the "License").
	6	* You may not use this file except in compliance with the License.
	7	*
	8	* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	9	* or http://www.opensolaris.org/os/licensing.
	10	* See the License for the specific language governing permissions
	11	* and limitations under the License.
	12	*
	13	* When distributing Covered Code, include this CDDL HEADER in each
	14	* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	15	* If applicable, add the following below this CDDL HEADER, with the
	16	* fields enclosed by brackets "[]" replaced with your own identifying
	17	* information: Portions Copyright [yyyy] [name of copyright owner]
	18	*
	19	* CDDL HEADER END
	20	*/
	21	/*
	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
	23	* Copyright (c) 2018 by Delphix. All rights reserved.
	24	*/
	25
	26	#ifndef _LIBZUTIL_H
	27	#define _LIBZUTIL_H
	28
	29	#include <sys/nvpair.h>
	30	#include <sys/fs/zfs.h>
	31
	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
	36	/*
	37	* Default wait time for a device name to be created.
	38	*/
	39	#define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */
	40
	41
	42	/*
	43	* Pool Config Operations
	44	*
	45	* These are specific to the library libzfs or libzpool instance.
	46	*/
	47	typedef nvlist_t refresh_config_func_t(void , nvlist_t *);
	48
	49	typedef int pool_active_func_t(void , const char , uint64_t, boolean_t *);
	50
	51	typedef const struct pool_config_ops {
	52	refresh_config_func_t *pco_refresh_config;
	53	pool_active_func_t *pco_pool_active;
	54	} pool_config_ops_t;
	55
	56	/*
	57	* An instance of pool_config_ops_t is expected in the caller's binary.
	58	*/
	59	extern const pool_config_ops_t libzfs_config_ops;
	60	extern const pool_config_ops_t libzpool_config_ops;
	61
	62	typedef struct importargs {
	63	char *path; / a list of paths to search */
	64	int paths; /* number of paths to search */
65	const char poolname; / name of a pool to find */
66	uint64_t guid; /* guid of a pool to find */
67	const char cachefile; / cachefile to use for import */
68	boolean_t can_be_active; /* can the pool be active? */
69	boolean_t scan; /* prefer scanning to libblkid cache */
70	nvlist_t policy; / load policy (max txg, rewind, etc.) */
71	} importargs_t;
72
73	extern nvlist_t zpool_search_import(void , importargs_t *,
74	const pool_config_ops_t *);
75	extern int zpool_find_config(void , const char , nvlist_t *, importargs_t ,
76	const pool_config_ops_t *);
77
78	extern const char * const * zpool_default_search_paths(size_t *count);
79	extern int zpool_read_label(int, nvlist_t *, int );
80	extern int zpool_label_disk_wait(const char *, int);
81
82	struct udev_device;
83
84	extern int zfs_device_get_devid(struct udev_device , char , size_t);
85	extern int zfs_device_get_physical(struct udev_device , char , size_t);
95692927	86
e89f1295 DB	87	extern void update_vdev_config_dev_strs(nvlist_t *);
	88
	89	/*
	90	* Default device paths
	91	*/
	92	#define DISK_ROOT "/dev"
	93	#define UDISK_ROOT "/dev/disk"
	94	#define ZVOL_ROOT "/dev/zvol"
	95
	96	extern int zfs_append_partition(char *path, size_t max_len);
	97	extern int zfs_resolve_shortname(const char name, char path, size_t pathlen);
	98
	99	extern char zfs_strip_partition(char );
035ebb36	100	extern char zfs_strip_path(char );
e89f1295 DB	101
	102	extern int zfs_strcmp_pathname(const char , const char , int);
	103
7c5eff94 MM	104	extern boolean_t zfs_dev_is_dm(const char *);
7c5eff94 MM	105	extern boolean_t zfs_dev_is_whole_disk(const char *);
d46f0deb	106	extern int zfs_dev_flush(int);
e89f1295 DB	107	extern char zfs_get_underlying_path(const char );
	108	extern char zfs_get_enclosure_sysfs_path(const char );
	109
e89f1295	110	extern boolean_t is_mpath_whole_disk(const char *);
e89f1295	111
3283f137 MM	112	extern boolean_t zfs_isnumber(const char *);
3283f137 MM	113
e89f1295 DB	114	/*
	115	* Formats for iostat numbers. Examples: "12K", "30ms", "4B", "2321234", "-".
	116	*
	117	* ZFS_NICENUM_1024: Print kilo, mega, tera, peta, exa..
	118	* ZFS_NICENUM_BYTES: Print single bytes ("13B"), kilo, mega, tera...
	119	* ZFS_NICENUM_TIME: Print nanosecs, microsecs, millisecs, seconds...
	120	* ZFS_NICENUM_RAW: Print the raw number without any formatting
	121	* ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero.
	122	*/
	123	enum zfs_nicenum_format {
	124	ZFS_NICENUM_1024 = 0,
	125	ZFS_NICENUM_BYTES = 1,
	126	ZFS_NICENUM_TIME = 2,
	127	ZFS_NICENUM_RAW = 3,
	128	ZFS_NICENUM_RAWTIME = 4
	129	};
	130
	131	/*
	132	* Convert a number to a human-readable form.
	133	*/
	134	extern void zfs_nicebytes(uint64_t, char *, size_t);
	135	extern void zfs_nicenum(uint64_t, char *, size_t);
	136	extern void zfs_nicenum_format(uint64_t, char *, size_t,
	137	enum zfs_nicenum_format);
	138	extern void zfs_nicetime(uint64_t, char *, size_t);
	139
	140	#define nicenum(num, buf, size) zfs_nicenum(num, buf, size)
	141
	142	extern void zpool_dump_ddt(const ddt_stat_t , const ddt_histogram_t );
	143	extern int zpool_history_unpack(char , uint64_t, uint64_t , nvlist_t ***,
	144	uint_t *);
	145
1f2f46be MM	146	struct zfs_cmd;
	147	int zfs_ioctl_fd(int fd, unsigned long request, struct zfs_cmd *zc);
	148
e89f1295 DB	149	#ifdef __cplusplus
	150	}
	151	#endif
	152
	153	#endif /* _LIBZUTIL_H */