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