0a2623a0c2758cef199d80539d7f7b84ee6a43e2
[multipath-tools/.git] / libmultipath / structs.h
1 #ifndef _STRUCTS_H
2 #define _STRUCTS_H
3
4 #include <sys/types.h>
5 #include <inttypes.h>
6
7 #include "prio.h"
8 #include "byteorder.h"
9 #include "generic.h"
10
11 #define WWID_SIZE               128
12 #define SERIAL_SIZE             65
13 #define NODE_NAME_SIZE          224
14 #define PATH_STR_SIZE           16
15 #define PARAMS_SIZE             4096
16 #define FILE_NAME_SIZE          256
17 #define CALLOUT_MAX_SIZE        256
18 #define BLK_DEV_SIZE            33
19 #define PATH_SIZE               512
20 #define NAME_SIZE               512
21 #define HOST_NAME_LEN           16
22 #define SLOT_NAME_SIZE          40
23 #define PRKEY_SIZE              19
24
25 #define SCSI_VENDOR_SIZE        9
26 #define SCSI_PRODUCT_SIZE       17
27 #define SCSI_STATE_SIZE         19
28 #define NVME_MODEL_SIZE         41
29 #define NVME_REV_SIZE           9
30
31 /* This must be the maximum of SCSI and NVME sizes */
32 #define PATH_PRODUCT_SIZE NVME_MODEL_SIZE
33 #define PATH_REV_SIZE NVME_REV_SIZE
34
35 #define NO_PATH_RETRY_UNDEF     0
36 #define NO_PATH_RETRY_FAIL      -1
37 #define NO_PATH_RETRY_QUEUE     -2
38
39
40 enum free_path_mode {
41         KEEP_PATHS,
42         FREE_PATHS
43 };
44
45 enum rr_weight_mode {
46         RR_WEIGHT_UNDEF,
47         RR_WEIGHT_NONE,
48         RR_WEIGHT_PRIO
49 };
50
51 enum failback_mode {
52         FAILBACK_UNDEF,
53         FAILBACK_MANUAL,
54         FAILBACK_IMMEDIATE,
55         FAILBACK_FOLLOWOVER
56 };
57
58 enum sysfs_buses {
59         SYSFS_BUS_UNDEF,
60         SYSFS_BUS_SCSI,
61         SYSFS_BUS_CCW,
62         SYSFS_BUS_CCISS,
63         SYSFS_BUS_NVME,
64 };
65
66 enum pathstates {
67         PSTATE_UNDEF,
68         PSTATE_FAILED,
69         PSTATE_ACTIVE
70 };
71
72 enum pgstates {
73         PGSTATE_UNDEF,
74         PGSTATE_ENABLED,
75         PGSTATE_DISABLED,
76         PGSTATE_ACTIVE
77 };
78
79 enum yes_no_states {
80         YN_NO,
81         YN_YES,
82 };
83
84 enum queue_without_daemon_states {
85         QUE_NO_DAEMON_OFF = YN_NO,
86         QUE_NO_DAEMON_ON = YN_YES,
87         QUE_NO_DAEMON_FORCE,
88 };
89
90 enum attribute_bits {
91         ATTR_UID,
92         ATTR_GID,
93         ATTR_MODE,
94 };
95
96 enum yes_no_undef_states {
97         YNU_UNDEF,
98         YNU_NO,
99         YNU_YES,
100 };
101
102 #define _FIND_MULTIPATHS_F (1 << 1)
103 #define _FIND_MULTIPATHS_I (1 << 2)
104 #define _FIND_MULTIPATHS_N (1 << 3)
105 /*
106  * _FIND_MULTIPATHS_F must have the same value as YNU_YES.
107  * Generate a compile time error if that isn't the case.
108  */
109 char ___error1___[-(_FIND_MULTIPATHS_F != YNU_YES)];
110
111 #define find_multipaths_on(conf) \
112         (!!((conf)->find_multipaths & _FIND_MULTIPATHS_F))
113 #define ignore_wwids_on(conf) \
114         (!!((conf)->find_multipaths & _FIND_MULTIPATHS_I))
115 #define ignore_new_devs_on(conf) \
116         (!!((conf)->find_multipaths & _FIND_MULTIPATHS_N))
117
118 enum find_multipaths_states {
119         FIND_MULTIPATHS_UNDEF = YNU_UNDEF,
120         FIND_MULTIPATHS_OFF = YNU_NO,
121         FIND_MULTIPATHS_ON = _FIND_MULTIPATHS_F,
122         FIND_MULTIPATHS_GREEDY = _FIND_MULTIPATHS_I,
123         FIND_MULTIPATHS_SMART = _FIND_MULTIPATHS_F|_FIND_MULTIPATHS_I,
124         FIND_MULTIPATHS_STRICT = _FIND_MULTIPATHS_F|_FIND_MULTIPATHS_N,
125         __FIND_MULTIPATHS_LAST,
126 };
127
128 enum flush_states {
129         FLUSH_UNDEF = YNU_UNDEF,
130         FLUSH_DISABLED = YNU_NO,
131         FLUSH_ENABLED = YNU_YES,
132 };
133
134 enum log_checker_err_states {
135         LOG_CHKR_ERR_ALWAYS,
136         LOG_CHKR_ERR_ONCE,
137 };
138
139 enum user_friendly_names_states {
140         USER_FRIENDLY_NAMES_UNDEF = YNU_UNDEF,
141         USER_FRIENDLY_NAMES_OFF = YNU_NO,
142         USER_FRIENDLY_NAMES_ON = YNU_YES,
143 };
144
145 enum retain_hwhandler_states {
146         RETAIN_HWHANDLER_UNDEF = YNU_UNDEF,
147         RETAIN_HWHANDLER_OFF = YNU_NO,
148         RETAIN_HWHANDLER_ON = YNU_YES,
149 };
150
151 enum detect_prio_states {
152         DETECT_PRIO_UNDEF = YNU_UNDEF,
153         DETECT_PRIO_OFF = YNU_NO,
154         DETECT_PRIO_ON = YNU_YES,
155 };
156
157 enum detect_checker_states {
158         DETECT_CHECKER_UNDEF = YNU_UNDEF,
159         DETECT_CHECKER_OFF = YNU_NO,
160         DETECT_CHECKER_ON = YNU_YES,
161 };
162
163 enum deferred_remove_states {
164         DEFERRED_REMOVE_UNDEF = YNU_UNDEF,
165         DEFERRED_REMOVE_OFF = YNU_NO,
166         DEFERRED_REMOVE_ON = YNU_YES,
167         DEFERRED_REMOVE_IN_PROGRESS,
168 };
169
170 enum skip_kpartx_states {
171         SKIP_KPARTX_UNDEF = YNU_UNDEF,
172         SKIP_KPARTX_OFF = YNU_NO,
173         SKIP_KPARTX_ON = YNU_YES,
174 };
175
176 enum max_sectors_kb_states {
177         MAX_SECTORS_KB_UNDEF = 0,
178         MAX_SECTORS_KB_MIN = 4,  /* can't be smaller than page size */
179 };
180
181 enum scsi_protocol {
182         SCSI_PROTOCOL_FCP = 0,  /* Fibre Channel */
183         SCSI_PROTOCOL_SPI = 1,  /* parallel SCSI */
184         SCSI_PROTOCOL_SSA = 2,  /* Serial Storage Architecture - Obsolete */
185         SCSI_PROTOCOL_SBP = 3,  /* firewire */
186         SCSI_PROTOCOL_SRP = 4,  /* Infiniband RDMA */
187         SCSI_PROTOCOL_ISCSI = 5,
188         SCSI_PROTOCOL_SAS = 6,
189         SCSI_PROTOCOL_ADT = 7,  /* Media Changers */
190         SCSI_PROTOCOL_ATA = 8,
191         SCSI_PROTOCOL_UNSPEC = 0xf, /* No specific protocol */
192 };
193
194 enum no_undef_states {
195         NU_NO = -1,
196         NU_UNDEF = 0,
197 };
198
199 enum ghost_delay_states {
200         GHOST_DELAY_OFF = NU_NO,
201         GHOST_DELAY_UNDEF = NU_UNDEF,
202 };
203
204 enum initialized_states {
205         INIT_FAILED,
206         INIT_MISSING_UDEV,
207         INIT_REQUESTED_UDEV,
208         INIT_OK,
209 };
210
211 enum prkey_sources {
212         PRKEY_SOURCE_NONE,
213         PRKEY_SOURCE_CONF,
214         PRKEY_SOURCE_FILE,
215 };
216
217 enum all_tg_pt_states {
218         ALL_TG_PT_UNDEF = YNU_UNDEF,
219         ALL_TG_PT_OFF = YNU_NO,
220         ALL_TG_PT_ON = YNU_YES,
221 };
222
223 struct sg_id {
224         int host_no;
225         int channel;
226         int scsi_id;
227         int lun;
228         short h_cmd_per_lun;
229         short d_queue_depth;
230         enum scsi_protocol proto_id;
231         int transport_id;
232 };
233
234 # ifndef HDIO_GETGEO
235 #  define HDIO_GETGEO   0x0301  /* get device geometry */
236
237 struct hd_geometry {
238         unsigned char heads;
239         unsigned char sectors;
240         unsigned short cylinders;
241         unsigned long start;
242 };
243 #endif
244
245 struct path {
246         char dev[FILE_NAME_SIZE];
247         char dev_t[BLK_DEV_SIZE];
248         struct udev_device *udev;
249         struct sg_id sg_id;
250         struct hd_geometry geom;
251         char wwid[WWID_SIZE];
252         char vendor_id[SCSI_VENDOR_SIZE];
253         char product_id[PATH_PRODUCT_SIZE];
254         char rev[PATH_REV_SIZE];
255         char serial[SERIAL_SIZE];
256         char tgt_node_name[NODE_NAME_SIZE];
257         unsigned long long size;
258         unsigned int checkint;
259         unsigned int tick;
260         int bus;
261         int offline;
262         int state;
263         int dmstate;
264         int chkrstate;
265         int failcount;
266         int priority;
267         int pgindex;
268         int detect_prio;
269         int detect_checker;
270         int watch_checks;
271         int wait_checks;
272         int tpgs;
273         char * uid_attribute;
274         char * getuid;
275         struct prio prio;
276         char * prio_args;
277         struct checker checker;
278         struct multipath * mpp;
279         int fd;
280         int initialized;
281         int retriggers;
282         int wwid_changed;
283         time_t io_err_dis_reinstate_time;
284         int io_err_disable_reinstate;
285         int io_err_pathfail_cnt;
286         int io_err_pathfail_starttime;
287         int find_multipaths_timeout;
288         /* configlet pointers */
289         vector hwe;
290         struct gen_path generic_path;
291 };
292
293 typedef int (pgpolicyfn) (struct multipath *);
294
295 struct multipath {
296         char wwid[WWID_SIZE];
297         char alias_old[WWID_SIZE];
298         int pgpolicy;
299         pgpolicyfn *pgpolicyfn;
300         int nextpg;
301         int bestpg;
302         int queuedio;
303         int action;
304         int wait_for_udev;
305         int uev_wait_tick;
306         int pgfailback;
307         int failback_tick;
308         int rr_weight;
309         int nr_active;     /* current available(= not known as failed) paths */
310         int no_path_retry; /* number of retries after all paths are down */
311         int retry_tick;    /* remaining times for retries */
312         int disable_queueing;
313         int minio;
314         int flush_on_last_del;
315         int attribute_flags;
316         int fast_io_fail;
317         int retain_hwhandler;
318         int deferred_remove;
319         int delay_watch_checks;
320         int delay_wait_checks;
321         int marginal_path_err_sample_time;
322         int marginal_path_err_rate_threshold;
323         int marginal_path_err_recheck_gap_time;
324         int marginal_path_double_failed_time;
325         int skip_kpartx;
326         int max_sectors_kb;
327         int force_readonly;
328         int force_udev_reload;
329         int needs_paths_uevent;
330         int ghost_delay;
331         int ghost_delay_tick;
332         unsigned int dev_loss;
333         uid_t uid;
334         gid_t gid;
335         mode_t mode;
336         unsigned long long size;
337         vector paths;
338         vector pg;
339         struct dm_info * dmi;
340
341         /* configlet pointers */
342         char * alias;
343         char * alias_prefix;
344         char * selector;
345         char * features;
346         char * hwhandler;
347         struct mpentry * mpe;
348         vector hwe;
349
350         /* threads */
351         pthread_t waiter;
352
353         /* stats */
354         unsigned int stat_switchgroup;
355         unsigned int stat_path_failures;
356         unsigned int stat_map_loads;
357         unsigned int stat_total_queueing_time;
358         unsigned int stat_queueing_timeouts;
359         unsigned int stat_map_failures;
360
361         /* checkers shared data */
362         void * mpcontext;
363
364         /* persistent management data*/
365         int prkey_source;
366         struct be64 reservation_key;
367         uint8_t sa_flags;
368         unsigned char prflag;
369         int all_tg_pt;
370         struct gen_multipath generic_mp;
371 };
372
373 struct pathgroup {
374         long id;
375         int status;
376         int priority;
377         int enabled_paths;
378         vector paths;
379         struct multipath *mpp;
380         struct gen_pathgroup generic_pg;
381 };
382
383 struct adapter_group {
384         char adapter_name[SLOT_NAME_SIZE];
385         struct pathgroup *pgp;
386         int num_hosts;
387         vector host_groups;
388         int next_host_index;
389 };
390
391 struct host_group {
392         int host_no;
393         int num_paths;
394         vector paths;
395 };
396
397 struct path * alloc_path (void);
398 struct pathgroup * alloc_pathgroup (void);
399 struct multipath * alloc_multipath (void);
400 void free_path (struct path *);
401 void free_pathvec (vector vec, enum free_path_mode free_paths);
402 void free_pathgroup (struct pathgroup * pgp, enum free_path_mode free_paths);
403 void free_pgvec (vector pgvec, enum free_path_mode free_paths);
404 void free_multipath (struct multipath *, enum free_path_mode free_paths);
405 void free_multipath_attributes (struct multipath *);
406 void drop_multipath (vector mpvec, char * wwid, enum free_path_mode free_paths);
407 void free_multipathvec (vector mpvec, enum free_path_mode free_paths);
408
409 struct adapter_group * alloc_adaptergroup(void);
410 struct host_group * alloc_hostgroup(void);
411 void free_adaptergroup(vector adapters);
412 void free_hostgroup(vector hostgroups);
413
414 int store_adaptergroup(vector adapters, struct adapter_group *agp);
415 int store_hostgroup(vector hostgroupvec, struct host_group *hgp);
416
417 int store_path (vector pathvec, struct path * pp);
418 int store_pathgroup (vector pgvec, struct pathgroup * pgp);
419 int add_pathgroup(struct multipath*, struct pathgroup *);
420
421 struct multipath * find_mp_by_alias (const struct _vector *mp, const char *alias);
422 struct multipath * find_mp_by_wwid (const struct _vector *mp, const char *wwid);
423 struct multipath * find_mp_by_str (const struct _vector *mp, const char *wwid);
424 struct multipath * find_mp_by_minor (const struct _vector *mp, int minor);
425
426 struct path * find_path_by_devt (const struct _vector *pathvec, const char *devt);
427 struct path * find_path_by_dev (const struct _vector *pathvec, const char *dev);
428 struct path * first_path (const struct multipath *mpp);
429
430 int pathcountgr (const struct pathgroup *, int);
431 int pathcount (const struct multipath *, int);
432 int pathcmp (const struct pathgroup *, const struct pathgroup *);
433 int add_feature (char **, const char *);
434 int remove_feature (char **, const char *);
435
436 extern char sysfs_path[PATH_SIZE];
437
438 #endif /* _STRUCTS_H */