xref: /freebsd/sys/contrib/openzfs/include/libzutil.h (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
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);
86 
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 *);
100 extern char *zfs_strip_path(char *);
101 
102 extern int zfs_strcmp_pathname(const char *, const char *, int);
103 
104 extern boolean_t zfs_dev_is_dm(const char *);
105 extern boolean_t zfs_dev_is_whole_disk(const char *);
106 extern int zfs_dev_flush(int);
107 extern char *zfs_get_underlying_path(const char *);
108 extern char *zfs_get_enclosure_sysfs_path(const char *);
109 
110 extern boolean_t is_mpath_whole_disk(const char *);
111 
112 extern boolean_t zfs_isnumber(const char *);
113 
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 extern void zfs_niceraw(uint64_t, char *, size_t);
140 
141 #define	nicenum(num, buf, size)	zfs_nicenum(num, buf, size)
142 
143 extern void zpool_dump_ddt(const ddt_stat_t *, const ddt_histogram_t *);
144 extern int zpool_history_unpack(char *, uint64_t, uint64_t *, nvlist_t ***,
145     uint_t *);
146 
147 struct zfs_cmd;
148 int zfs_ioctl_fd(int fd, unsigned long request, struct zfs_cmd *zc);
149 
150 /*
151  * List of colors to use
152  */
153 #define	ANSI_RED	"\033[0;31m"
154 #define	ANSI_YELLOW	"\033[0;33m"
155 #define	ANSI_RESET	"\033[0m"
156 #define	ANSI_BOLD	"\033[1m"
157 
158 void color_start(char *color);
159 void color_end(void);
160 int printf_color(char *color, char *format, ...);
161 
162 #ifdef	__cplusplus
163 }
164 #endif
165 
166 #endif	/* _LIBZUTIL_H */
167