Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : update tesh files
[simgrid.git] / src / mc / mc_private.h
1 /* Copyright (c) 2007-2013 Da SimGrid Team. All rights reserved.            */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef MC_PRIVATE_H
7 #define MC_PRIVATE_H
8
9 #include "simgrid_config.h"
10 #include <stdio.h>
11 #ifndef WIN32
12 #include <sys/mman.h>
13 #endif
14 #include "mc/mc.h"
15 #include "mc/datatypes.h"
16 #include "xbt/fifo.h"
17 #include "xbt/config.h"
18 #include "xbt/function_types.h"
19 #include "xbt/mmalloc.h"
20 #include "../simix/smx_private.h"
21 #include "xbt/automaton.h"
22 #include "xbt/hash.h"
23 #include "msg/msg.h"
24 #include "msg/datatypes.h"
25 #include "xbt/strbuff.h"
26
27 /****************************** Snapshots ***********************************/
28
29 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/ 
30
31 typedef struct s_mc_mem_region{
32   void *start_addr;
33   void *data;
34   size_t size;
35 } s_mc_mem_region_t, *mc_mem_region_t;
36
37 typedef struct s_mc_snapshot{
38   size_t heap_bytes_used;
39   mc_mem_region_t regions[NB_REGIONS];
40   int nb_processes;
41   size_t *stack_sizes;
42   xbt_dynar_t stacks;
43   xbt_dynar_t to_ignore;
44   char hash_global[41];
45   char hash_local[41];
46 } s_mc_snapshot_t, *mc_snapshot_t;
47
48 typedef struct s_mc_snapshot_stack{
49   xbt_dynar_t local_variables;
50   void *stack_pointer;
51   void *real_address;
52 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
53
54 typedef struct s_mc_global_t{
55   mc_snapshot_t snapshot;
56   int raw_mem_set;
57   int prev_pair;
58   char *prev_req;
59 }s_mc_global_t, *mc_global_t;
60
61 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
62 mc_snapshot_t MC_take_snapshot(void);
63 void MC_restore_snapshot(mc_snapshot_t);
64 void MC_free_snapshot(mc_snapshot_t);
65
66 /********************************* MC Global **********************************/
67
68 extern double *mc_time;
69 extern FILE *dot_output;
70 extern const char* colors[13];
71
72 int MC_deadlock_check(void);
73 void MC_replay(xbt_fifo_t stack, int start);
74 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
75 void MC_wait_for_requests(void);
76 void MC_show_deadlock(smx_simcall_t req);
77 void MC_show_stack_safety(xbt_fifo_t stack);
78 void MC_dump_stack_safety(xbt_fifo_t stack);
79 void MC_init(void);
80 int SIMIX_pre_mc_random(smx_simcall_t simcall);
81
82
83 /********************************* Requests ***********************************/
84
85 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
86 char* MC_request_to_string(smx_simcall_t req, int value);
87 unsigned int MC_request_testany_fail(smx_simcall_t req);
88 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
89 int MC_request_is_visible(smx_simcall_t req);
90 int MC_request_is_enabled(smx_simcall_t req);
91 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
92 int MC_process_is_enabled(smx_process_t process);
93 char *MC_request_get_dot_output(smx_simcall_t req, int value);
94
95
96 /******************************** States **************************************/
97
98 /* Possible exploration status of a process in a state */
99 typedef enum {
100   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
101   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
102   MC_MORE_INTERLEAVE,       /* Interleave twice the process (for mc_random simcall) */
103   MC_DONE                   /* Already interleaved */
104 } e_mc_process_state_t;
105
106 /* On every state, each process has an entry of the following type */
107 typedef struct mc_procstate{
108   e_mc_process_state_t state;       /* Exploration control information */
109   unsigned int interleave_count;    /* Number of times that the process was
110                                        interleaved */
111 } s_mc_procstate_t, *mc_procstate_t;
112
113 /* An exploration state is composed of: */
114 typedef struct mc_state {
115   unsigned long max_pid;            /* Maximum pid at state's creation time */
116   mc_procstate_t proc_status;       /* State's exploration status by process */
117   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
118   s_smx_simcall_t internal_req;         /* Internal translation of request */
119   s_smx_simcall_t executed_req;         /* The executed request of the state */
120   int req_num;                      /* The request number (in the case of a
121                                        multi-request like waitany ) */
122   mc_snapshot_t system_state;      /* Snapshot of system state */
123   int num;
124 } s_mc_state_t, *mc_state_t;
125
126 mc_state_t MC_state_new(void);
127 void MC_state_delete(mc_state_t state);
128 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
129 unsigned int MC_state_interleave_size(mc_state_t state);
130 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
131 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
132 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
133 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
134 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
135 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
136
137
138 /****************************** Statistics ************************************/
139
140 typedef struct mc_stats {
141   unsigned long state_size;
142   unsigned long visited_states;
143   unsigned long visited_pairs;
144   unsigned long expanded_states;
145   unsigned long expanded_pairs;
146   unsigned long executed_transitions;
147 } s_mc_stats_t, *mc_stats_t;
148
149 extern mc_stats_t mc_stats;
150
151 void MC_print_statistics(mc_stats_t);
152
153
154 /********************************** MEMORY ******************************/
155 /* The possible memory modes for the modelchecker are standard and raw. */
156 /* Normally the system should operate in std, for switching to raw mode */
157 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
158
159 extern void *std_heap;
160 extern void *raw_heap;
161
162
163 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
164 /* an API to query about the status of a heap, we simply call mmstats and */
165 /* because I now how does structure looks like, then I redefine it here */
166
167 /* struct mstats { */
168 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
169 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
170 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
171 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
172 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
173 /* }; */
174
175 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
176 #define MC_UNSET_RAW_MEM  mmalloc_set_current_heap(std_heap)
177
178
179 /******************************* MEMORY MAPPINGS ***************************/
180 /* These functions and data structures implements a binary interface for   */
181 /* the proc maps ascii interface                                           */
182
183 /* Each field is defined as documented in proc's manual page  */
184 typedef struct s_map_region {
185
186   void *start_addr;             /* Start address of the map */
187   void *end_addr;               /* End address of the map */
188   int prot;                     /* Memory protection */
189   int flags;                    /* Aditional memory flags */
190   void *offset;                 /* Offset in the file/whatever */
191   char dev_major;               /* Major of the device */
192   char dev_minor;               /* Minor of the device */
193   unsigned long inode;          /* Inode in the device */
194   char *pathname;               /* Path name of the mapped file */
195
196 } s_map_region_t;
197
198 typedef struct s_memory_map {
199
200   s_map_region_t *regions;      /* Pointer to an array of regions */
201   int mapsize;                  /* Number of regions in the memory */
202
203 } s_memory_map_t, *memory_map_t;
204
205
206 void MC_init_memory_map_info(void);
207 memory_map_t MC_get_memory_map(void);
208 void MC_free_memory_map(memory_map_t map);
209 void MC_get_libsimgrid_plt_section(void);
210 void MC_get_binary_plt_section(void);
211
212 extern void *start_data_libsimgrid;
213 extern void *start_data_binary;
214 extern void *start_bss_binary;
215 extern char *libsimgrid_path;
216 extern void *start_text_libsimgrid;
217 extern void *start_text_binary;
218 extern void *start_bss_libsimgrid;
219 extern void *start_plt_libsimgrid;
220 extern void *end_plt_libsimgrid;
221 extern void *start_plt_binary;
222 extern void *end_plt_binary;
223 extern void *start_got_plt_libsimgrid;
224 extern void *end_got_plt_libsimgrid;
225 extern void *start_got_plt_binary;
226 extern void *end_got_plt_binary;
227
228
229 /********************************** Snapshot comparison **********************************/
230
231 typedef struct s_mc_comparison_times{
232   double nb_processes_comparison_time;
233   double bytes_used_comparison_time;
234   double stacks_sizes_comparison_time;
235   double binary_global_variables_comparison_time;
236   double libsimgrid_global_variables_comparison_time;
237   double heap_comparison_time;
238   double stacks_comparison_time;
239   double hash_global_variables_comparison_time;
240   double hash_local_variables_comparison_time;
241 }s_mc_comparison_times_t, *mc_comparison_times_t;
242
243 extern mc_comparison_times_t mc_comp_times;
244 extern double mc_snapshot_comparison_time;
245
246 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
247 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
248 void print_comparison_times(void);
249
250 //#define MC_DEBUG 1
251 #define MC_VERBOSE 1
252
253
254 /********************************** DPOR for safety property **************************************/
255
256 typedef enum {
257   e_mc_reduce_unset,
258   e_mc_reduce_none,
259   e_mc_reduce_dpor
260 } e_mc_reduce_t;
261
262 extern e_mc_reduce_t mc_reduce_kind;
263 extern mc_global_t initial_state_safety;
264 extern xbt_fifo_t mc_stack_safety;
265 extern xbt_dict_t first_enabled_state;
266
267 void MC_dpor_init(void);
268 void MC_dpor(void);
269
270 typedef struct s_mc_visited_state{
271   mc_snapshot_t system_state;
272   size_t heap_bytes_used;
273   int nb_processes;
274   int num;
275 }s_mc_visited_state_t, *mc_visited_state_t;
276
277
278 /********************************** Double-DFS for liveness property **************************************/
279
280 extern xbt_fifo_t mc_stack_liveness;
281 extern mc_global_t initial_state_liveness;
282 extern xbt_automaton_t _mc_property_automaton;
283 extern int compare;
284 extern xbt_dynar_t mc_stack_comparison_ignore;
285 extern xbt_dynar_t mc_data_bss_comparison_ignore;
286
287 typedef struct s_mc_pair{
288   int num;
289   int search_cycle;
290   mc_state_t graph_state; /* System state included */
291   xbt_automaton_state_t automaton_state;
292   xbt_dynar_t atomic_propositions;
293   int requests;
294   size_t heap_bytes_used;
295   int nb_processes;
296   int stack_removed;
297   int visited_removed;
298   int acceptance_removed;
299 }s_mc_pair_t, *mc_pair_t;
300
301 mc_pair_t MC_pair_new(void);
302 void MC_pair_delete(mc_pair_t);
303
304 void MC_ddfs_init(void);
305 void MC_ddfs(void);
306 void MC_show_stack_liveness(xbt_fifo_t stack);
307 void MC_dump_stack_liveness(xbt_fifo_t stack);
308
309
310 /********************************** Variables with DWARF **********************************/
311
312 extern xbt_dict_t mc_local_variables_libsimgrid;
313 extern xbt_dict_t mc_local_variables_binary;
314 extern xbt_dynar_t mc_global_variables_libsimgrid;
315 extern xbt_dynar_t mc_global_variables_binary;
316 extern xbt_dict_t mc_variables_type_libsimgrid;
317 extern xbt_dict_t mc_variables_type_binary;
318
319 typedef enum {
320   e_dw_loclist,
321   e_dw_register,
322   e_dw_bregister_op,
323   e_dw_lit,
324   e_dw_fbregister_op,
325   e_dw_piece,
326   e_dw_arithmetic,
327   e_dw_plus_uconst,
328   e_dw_compose,
329   e_dw_deref,
330   e_dw_uconstant,
331   e_dw_sconstant,
332   e_dw_unsupported
333 } e_dw_location_type;
334
335 typedef struct s_dw_location{
336   e_dw_location_type type;
337   union{
338     
339     xbt_dynar_t loclist;
340     
341     int reg;
342     
343     struct{
344       unsigned int reg;
345       int offset;
346     }breg_op;
347
348     unsigned int lit;
349
350     int fbreg_op;
351
352     int piece;
353
354     unsigned short int deref_size;
355
356     xbt_dynar_t compose;
357
358     char *arithmetic;
359
360     struct{
361       int bytes;
362       long unsigned int value;
363     }uconstant;
364
365     struct{
366       int bytes;
367       long signed int value;
368     }sconstant;
369
370     unsigned int plus_uconst;
371
372   }location;
373 }s_dw_location_t, *dw_location_t;
374
375 typedef struct s_dw_location_entry{
376   long lowpc;
377   long highpc;
378   dw_location_t location;
379 }s_dw_location_entry_t, *dw_location_entry_t;
380
381 typedef struct s_dw_variable{
382   int global;
383   char *name;
384   char *type_origin;
385   union{
386     dw_location_t location;
387     void *address;
388   }address;
389 }s_dw_variable_t, *dw_variable_t;
390
391 typedef struct s_dw_frame{
392   char *name;
393   void *low_pc;
394   void *high_pc;
395   dw_location_t frame_base;
396   xbt_dynar_t variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
397   unsigned long int start;
398   unsigned long int end;
399 }s_dw_frame_t, *dw_frame_t;
400
401 /********************************** Miscellaneous **********************************/
402
403 typedef struct s_local_variable{
404   char *frame;
405   unsigned long ip;
406   char *name;
407   char *type;
408   void *address;
409   int region;
410 }s_local_variable_t, *local_variable_t;
411
412 #endif
413