xref: /freebsd/sys/contrib/openzfs/cmd/zpool/zpool_util.h (revision b3512b30dbec579da28028e29d8b33ec7242af68)
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  */
24 
25 #ifndef	ZPOOL_UTIL_H
26 #define	ZPOOL_UTIL_H
27 
28 #include <libnvpair.h>
29 #include <libzfs.h>
30 
31 #ifdef	__cplusplus
32 extern "C" {
33 #endif
34 
35 /* Path to scripts you can run with "zpool status/iostat -c" */
36 #define	ZPOOL_SCRIPTS_DIR SYSCONFDIR"/zfs/zpool.d"
37 
38 /*
39  * Basic utility functions
40  */
41 void *safe_malloc(size_t);
42 void zpool_no_memory(void);
43 uint_t num_logs(nvlist_t *nv);
44 uint64_t array64_max(uint64_t array[], unsigned int len);
45 int highbit64(uint64_t i);
46 int lowbit64(uint64_t i);
47 
48 /*
49  * Misc utility functions
50  */
51 char *zpool_get_cmd_search_path(void);
52 
53 /*
54  * Virtual device functions
55  */
56 
57 nvlist_t *make_root_vdev(zpool_handle_t *zhp, nvlist_t *props, int force,
58     int check_rep, boolean_t replacing, boolean_t dryrun, int argc,
59     char **argv);
60 nvlist_t *split_mirror_vdev(zpool_handle_t *zhp, char *newname,
61     nvlist_t *props, splitflags_t flags, int argc, char **argv);
62 
63 /*
64  * Pool list functions
65  */
66 int for_each_pool(int, char **, boolean_t unavail, zprop_list_t **,
67     zpool_iter_f, void *);
68 
69 /* Vdev list functions */
70 typedef int (*pool_vdev_iter_f)(zpool_handle_t *, nvlist_t *, void *);
71 int for_each_vdev(zpool_handle_t *zhp, pool_vdev_iter_f func, void *data);
72 
73 typedef struct zpool_list zpool_list_t;
74 
75 zpool_list_t *pool_list_get(int, char **, zprop_list_t **, int *);
76 void pool_list_update(zpool_list_t *);
77 int pool_list_iter(zpool_list_t *, int unavail, zpool_iter_f, void *);
78 void pool_list_free(zpool_list_t *);
79 int pool_list_count(zpool_list_t *);
80 void pool_list_remove(zpool_list_t *, zpool_handle_t *);
81 
82 extern libzfs_handle_t *g_zfs;
83 
84 
85 typedef	struct vdev_cmd_data
86 {
87 	char **lines;	/* Array of lines of output, minus the column name */
88 	int lines_cnt;	/* Number of lines in the array */
89 
90 	char **cols;	/* Array of column names */
91 	int cols_cnt;	/* Number of column names */
92 
93 
94 	char *path;	/* vdev path */
95 	char *upath;	/* vdev underlying path */
96 	char *pool;	/* Pool name */
97 	char *cmd;	/* backpointer to cmd */
98 	char *vdev_enc_sysfs_path;	/* enclosure sysfs path (if any) */
99 } vdev_cmd_data_t;
100 
101 typedef struct vdev_cmd_data_list
102 {
103 	char *cmd;		/* Command to run */
104 	unsigned int count;	/* Number of vdev_cmd_data items (vdevs) */
105 
106 	/* fields used to select only certain vdevs, if requested */
107 	libzfs_handle_t *g_zfs;
108 	char **vdev_names;
109 	int vdev_names_count;
110 	int cb_name_flags;
111 
112 	vdev_cmd_data_t *data;	/* Array of vdevs */
113 
114 	/* List of unique column names and widths */
115 	char **uniq_cols;
116 	int uniq_cols_cnt;
117 	int *uniq_cols_width;
118 
119 } vdev_cmd_data_list_t;
120 
121 vdev_cmd_data_list_t *all_pools_for_each_vdev_run(int argc, char **argv,
122     char *cmd, libzfs_handle_t *g_zfs, char **vdev_names, int vdev_names_count,
123     int cb_name_flags);
124 
125 void free_vdev_cmd_data_list(vdev_cmd_data_list_t *vcdl);
126 
127 int check_device(const char *path, boolean_t force,
128     boolean_t isspare, boolean_t iswholedisk);
129 boolean_t check_sector_size_database(char *path, int *sector_size);
130 void vdev_error(const char *fmt, ...);
131 int check_file(const char *file, boolean_t force, boolean_t isspare);
132 
133 #ifdef	__cplusplus
134 }
135 #endif
136 
137 #endif	/* ZPOOL_UTIL_H */
138