c71d972b6818c34682a22388d8c7c730c25c09fc
[multipath-tools/.git] / libmultipath / config.h
1 #ifndef _CONFIG_H
2 #define _CONFIG_H
3
4 #include <sys/types.h>
5 #include <stdint.h>
6 #include <urcu.h>
7 #include <inttypes.h>
8 #include "byteorder.h"
9
10 #define ORIGIN_DEFAULT 0
11 #define ORIGIN_CONFIG  1
12
13 /*
14  * In kernel, fast_io_fail == 0 means immediate failure on rport delete.
15  * OTOH '0' means not-configured in various places in multipath-tools.
16  */
17 #define MP_FAST_IO_FAIL_UNSET (0)
18 #define MP_FAST_IO_FAIL_OFF (-1)
19 #define MP_FAST_IO_FAIL_ZERO (-2)
20
21 enum devtypes {
22         DEV_NONE,
23         DEV_DEVT,
24         DEV_DEVNODE,
25         DEV_DEVMAP,
26         DEV_UEVENT
27 };
28
29 enum mpath_cmds {
30         CMD_NONE,
31         CMD_CREATE,
32         CMD_DRY_RUN,
33         CMD_LIST_SHORT,
34         CMD_LIST_LONG,
35         CMD_VALID_PATH,
36         CMD_REMOVE_WWID,
37         CMD_RESET_WWIDS,
38         CMD_ADD_WWID,
39         CMD_USABLE_PATHS,
40 };
41
42 enum force_reload_types {
43         FORCE_RELOAD_NONE,
44         FORCE_RELOAD_YES,
45         FORCE_RELOAD_WEAK,
46 };
47
48 struct hwentry {
49         char * vendor;
50         char * product;
51         char * revision;
52         char * uid_attribute;
53         char * getuid;
54         char * features;
55         char * hwhandler;
56         char * selector;
57         char * checker_name;
58         char * prio_name;
59         char * prio_args;
60         char * alias_prefix;
61
62         int pgpolicy;
63         int pgfailback;
64         int rr_weight;
65         int no_path_retry;
66         int minio;
67         int minio_rq;
68         int flush_on_last_del;
69         int fast_io_fail;
70         unsigned int dev_loss;
71         int user_friendly_names;
72         int retain_hwhandler;
73         int detect_prio;
74         int detect_checker;
75         int deferred_remove;
76         int delay_watch_checks;
77         int delay_wait_checks;
78         int marginal_path_err_sample_time;
79         int marginal_path_err_rate_threshold;
80         int marginal_path_err_recheck_gap_time;
81         int marginal_path_double_failed_time;
82         int skip_kpartx;
83         int max_sectors_kb;
84         int ghost_delay;
85         char * bl_product;
86 };
87
88 struct mpentry {
89         char * wwid;
90         char * alias;
91         char * uid_attribute;
92         char * getuid;
93         char * selector;
94         char * features;
95
96         char * prio_name;
97         char * prio_args;
98         int prkey_source;
99         struct be64 reservation_key;
100         int pgpolicy;
101         int pgfailback;
102         int rr_weight;
103         int no_path_retry;
104         int minio;
105         int minio_rq;
106         int flush_on_last_del;
107         int attribute_flags;
108         int user_friendly_names;
109         int deferred_remove;
110         int delay_watch_checks;
111         int delay_wait_checks;
112         int marginal_path_err_sample_time;
113         int marginal_path_err_rate_threshold;
114         int marginal_path_err_recheck_gap_time;
115         int marginal_path_double_failed_time;
116         int skip_kpartx;
117         int max_sectors_kb;
118         int ghost_delay;
119         uid_t uid;
120         gid_t gid;
121         mode_t mode;
122 };
123
124 struct config {
125         struct rcu_head rcu;
126         int verbosity;
127         int pgpolicy_flag;
128         int pgpolicy;
129         int minio;
130         int minio_rq;
131         int checkint;
132         int max_checkint;
133         int pgfailback;
134         int remove;
135         int rr_weight;
136         int no_path_retry;
137         int user_friendly_names;
138         int bindings_read_only;
139         int max_fds;
140         int force_reload;
141         int queue_without_daemon;
142         int checker_timeout;
143         int flush_on_last_del;
144         int attribute_flags;
145         int fast_io_fail;
146         unsigned int dev_loss;
147         int log_checker_err;
148         int allow_queueing;
149         int find_multipaths;
150         uid_t uid;
151         gid_t gid;
152         mode_t mode;
153         int reassign_maps;
154         int retain_hwhandler;
155         int detect_prio;
156         int detect_checker;
157         int force_sync;
158         int deferred_remove;
159         int processed_main_config;
160         int delay_watch_checks;
161         int delay_wait_checks;
162         int marginal_path_err_sample_time;
163         int marginal_path_err_rate_threshold;
164         int marginal_path_err_recheck_gap_time;
165         int marginal_path_double_failed_time;
166         int uxsock_timeout;
167         int strict_timing;
168         int retrigger_tries;
169         int retrigger_delay;
170         int delayed_reconfig;
171         int uev_wait_timeout;
172         int skip_kpartx;
173         int disable_changed_wwids;
174         int remove_retries;
175         int max_sectors_kb;
176         int ghost_delay;
177         unsigned int version[3];
178
179         char * multipath_dir;
180         char * selector;
181         char * uid_attrs;
182         char * uid_attribute;
183         char * getuid;
184         char * features;
185         char * hwhandler;
186         char * bindings_file;
187         char * wwids_file;
188         char * prkeys_file;
189         char * prio_name;
190         char * prio_args;
191         char * checker_name;
192         char * alias_prefix;
193         char * partition_delim;
194         char * config_dir;
195         int prkey_source;
196         struct be64 reservation_key;
197
198         vector keywords;
199         vector mptable;
200         vector hwtable;
201         struct hwentry *overrides;
202
203         vector blist_devnode;
204         vector blist_wwid;
205         vector blist_device;
206         vector blist_property;
207         vector elist_devnode;
208         vector elist_wwid;
209         vector elist_device;
210         vector elist_property;
211 };
212
213 extern struct udev * udev;
214
215 struct hwentry * find_hwe (vector hwtable, char * vendor, char * product, char *revision);
216 struct mpentry * find_mpe (vector mptable, char * wwid);
217 char * get_mpe_wwid (vector mptable, char * alias);
218
219 struct hwentry * alloc_hwe (void);
220 struct mpentry * alloc_mpe (void);
221
222 void free_hwe (struct hwentry * hwe);
223 void free_hwtable (vector hwtable);
224 void free_mpe (struct mpentry * mpe);
225 void free_mptable (vector mptable);
226
227 int store_hwe (vector hwtable, struct hwentry *);
228
229 struct config *load_config (char * file);
230 struct config * alloc_config (void);
231 void free_config (struct config * conf);
232 extern struct config *get_multipath_config(void);
233 extern void put_multipath_config(void *);
234
235 #endif