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