xref: /freebsd/sys/contrib/openzfs/cmd/zpool/zpool_util.h (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3  * CDDL HEADER START
4  *
5  * The contents of this file are subject to the terms of the
6  * Common Development and Distribution License (the "License").
7  * You may not use this file except in compliance with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or https://opensource.org/licenses/CDDL-1.0.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  */
25 
26 #ifndef	ZPOOL_UTIL_H
27 #define	ZPOOL_UTIL_H
28 
29 #include <libnvpair.h>
30 #include <libzfs.h>
31 #include <libzutil.h>
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 /* Path to scripts you can run with "zpool status/iostat -c" */
38 #define	ZPOOL_SCRIPTS_DIR SYSCONFDIR"/zfs/zpool.d"
39 
40 /*
41  * Basic utility functions
42  */
43 void *safe_malloc(size_t);
44 void *safe_realloc(void *, size_t);
45 void zpool_no_memory(void);
46 uint_t num_logs(nvlist_t *nv);
47 uint64_t array64_max(uint64_t array[], unsigned int len);
48 int highbit64(uint64_t i);
49 int lowbit64(uint64_t i);
50 
51 /*
52  * Misc utility functions
53  */
54 char *zpool_get_cmd_search_path(void);
55 
56 /*
57  * Virtual device functions
58  */
59 
60 nvlist_t *make_root_vdev(zpool_handle_t *zhp, nvlist_t *props, int force,
61     int check_rep, boolean_t replacing, boolean_t dryrun, int argc,
62     char **argv);
63 nvlist_t *split_mirror_vdev(zpool_handle_t *zhp, char *newname,
64     nvlist_t *props, splitflags_t flags, int argc, char **argv);
65 
66 /*
67  * Pool list functions
68  */
69 int for_each_pool(int, char **, boolean_t unavail, zprop_list_t **, zfs_type_t,
70     boolean_t, zpool_iter_f, void *);
71 
72 /* Vdev list functions */
73 int for_each_vdev(zpool_handle_t *zhp, pool_vdev_iter_f func, void *data);
74 
75 typedef struct zpool_list zpool_list_t;
76 
77 zpool_list_t *pool_list_get(int, char **, zprop_list_t **, zfs_type_t,
78     boolean_t, int *);
79 void pool_list_update(zpool_list_t *);
80 int pool_list_iter(zpool_list_t *, int unavail, zpool_iter_f, void *);
81 void pool_list_free(zpool_list_t *);
82 int pool_list_count(zpool_list_t *);
83 void pool_list_remove(zpool_list_t *, zpool_handle_t *);
84 
85 extern libzfs_handle_t *g_zfs;
86 
87 
88 typedef	struct vdev_cmd_data
89 {
90 	char **lines;	/* Array of lines of output, minus the column name */
91 	int lines_cnt;	/* Number of lines in the array */
92 
93 	char **cols;	/* Array of column names */
94 	int cols_cnt;	/* Number of column names */
95 
96 
97 	char *path;	/* vdev path */
98 	char *upath;	/* vdev underlying path */
99 	char *pool;	/* Pool name */
100 	char *cmd;	/* backpointer to cmd */
101 	char *vdev_enc_sysfs_path;	/* enclosure sysfs path (if any) */
102 } vdev_cmd_data_t;
103 
104 typedef struct vdev_cmd_data_list
105 {
106 	char *cmd;		/* Command to run */
107 	unsigned int count;	/* Number of vdev_cmd_data items (vdevs) */
108 
109 	/* fields used to select only certain vdevs, if requested */
110 	libzfs_handle_t *g_zfs;
111 	char **vdev_names;
112 	int vdev_names_count;
113 	int cb_name_flags;
114 
115 	vdev_cmd_data_t *data;	/* Array of vdevs */
116 
117 	/* List of unique column names and widths */
118 	char **uniq_cols;
119 	int uniq_cols_cnt;
120 	int *uniq_cols_width;
121 
122 } vdev_cmd_data_list_t;
123 
124 vdev_cmd_data_list_t *all_pools_for_each_vdev_run(int argc, char **argv,
125     char *cmd, libzfs_handle_t *g_zfs, char **vdev_names, int vdev_names_count,
126     int cb_name_flags);
127 
128 void free_vdev_cmd_data_list(vdev_cmd_data_list_t *vcdl);
129 
130 void free_vdev_cmd_data(vdev_cmd_data_t *data);
131 
132 int vdev_run_cmd_simple(char *path, char *cmd);
133 
134 int check_device(const char *path, boolean_t force,
135     boolean_t isspare, boolean_t iswholedisk);
136 boolean_t check_sector_size_database(char *path, int *sector_size);
137 void vdev_error(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
138 int check_file(const char *file, boolean_t force, boolean_t isspare);
139 void after_zpool_upgrade(zpool_handle_t *zhp);
140 int check_file_generic(const char *file, boolean_t force, boolean_t isspare);
141 
142 int zpool_power(zpool_handle_t *zhp, char *vdev, boolean_t turn_on);
143 int zpool_power_current_state(zpool_handle_t *zhp, char *vdev);
144 
145 #ifdef	__cplusplus
146 }
147 #endif
148 
149 #endif	/* ZPOOL_UTIL_H */
150