multipath: implement "check usable paths" (-C/-U)
[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 san_path_err_threshold;
79         int san_path_err_forget_rate;
80         int san_path_err_recovery_time;
81         int skip_kpartx;
82         int max_sectors_kb;
83         char * bl_product;
84 };
85
86 struct mpentry {
87         char * wwid;
88         char * alias;
89         char * uid_attribute;
90         char * getuid;
91         char * selector;
92         char * features;
93
94         char * prio_name;
95         char * prio_args;
96         int prkey_source;
97         struct be64 reservation_key;
98         int pgpolicy;
99         int pgfailback;
100         int rr_weight;
101         int no_path_retry;
102         int minio;
103         int minio_rq;
104         int flush_on_last_del;
105         int attribute_flags;
106         int user_friendly_names;
107         int deferred_remove;
108         int delay_watch_checks;
109         int delay_wait_checks;
110         int san_path_err_threshold;
111         int san_path_err_forget_rate;
112         int san_path_err_recovery_time;
113         int skip_kpartx;
114         int max_sectors_kb;
115         uid_t uid;
116         gid_t gid;
117         mode_t mode;
118 };
119
120 struct config {
121         struct rcu_head rcu;
122         int verbosity;
123         int pgpolicy_flag;
124         int pgpolicy;
125         int minio;
126         int minio_rq;
127         int checkint;
128         int max_checkint;
129         int pgfailback;
130         int remove;
131         int rr_weight;
132         int no_path_retry;
133         int user_friendly_names;
134         int bindings_read_only;
135         int max_fds;
136         int force_reload;
137         int queue_without_daemon;
138         int ignore_wwids;
139         int checker_timeout;
140         int flush_on_last_del;
141         int attribute_flags;
142         int fast_io_fail;
143         unsigned int dev_loss;
144         int log_checker_err;
145         int allow_queueing;
146         int find_multipaths;
147         uid_t uid;
148         gid_t gid;
149         mode_t mode;
150         int reassign_maps;
151         int retain_hwhandler;
152         int detect_prio;
153         int detect_checker;
154         int force_sync;
155         int deferred_remove;
156         int processed_main_config;
157         int delay_watch_checks;
158         int delay_wait_checks;
159         int san_path_err_threshold;
160         int san_path_err_forget_rate;
161         int san_path_err_recovery_time;
162         int uxsock_timeout;
163         int strict_timing;
164         int retrigger_tries;
165         int retrigger_delay;
166         int ignore_new_devs;
167         int delayed_reconfig;
168         int uev_wait_timeout;
169         int skip_kpartx;
170         int disable_changed_wwids;
171         int remove_retries;
172         int max_sectors_kb;
173         unsigned int version[3];
174
175         char * multipath_dir;
176         char * selector;
177         char * uid_attrs;
178         char * uid_attribute;
179         char * getuid;
180         char * features;
181         char * hwhandler;
182         char * bindings_file;
183         char * wwids_file;
184         char * prkeys_file;
185         char * prio_name;
186         char * prio_args;
187         char * checker_name;
188         char * alias_prefix;
189         char * partition_delim;
190         char * config_dir;
191         int prkey_source;
192         struct be64 reservation_key;
193
194         vector keywords;
195         vector mptable;
196         vector hwtable;
197         struct hwentry *overrides;
198
199         vector blist_devnode;
200         vector blist_wwid;
201         vector blist_device;
202         vector blist_property;
203         vector elist_devnode;
204         vector elist_wwid;
205         vector elist_device;
206         vector elist_property;
207 };
208
209 extern struct udev * udev;
210
211 struct hwentry * find_hwe (vector hwtable, char * vendor, char * product, char *revision);
212 struct mpentry * find_mpe (vector mptable, char * wwid);
213 char * get_mpe_wwid (vector mptable, char * alias);
214
215 struct hwentry * alloc_hwe (void);
216 struct mpentry * alloc_mpe (void);
217
218 void free_hwe (struct hwentry * hwe);
219 void free_hwtable (vector hwtable);
220 void free_mpe (struct mpentry * mpe);
221 void free_mptable (vector mptable);
222
223 int store_hwe (vector hwtable, struct hwentry *);
224
225 struct config *load_config (char * file);
226 struct config * alloc_config (void);
227 void free_config (struct config * conf);
228 extern struct config *get_multipath_config(void);
229 extern void put_multipath_config(struct config *);
230
231 #endif