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