Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
do not force the O2 parameter inside SMPI scripts
[simgrid.git] / src / mc / mc_private.h
1 /* Copyright (c) 2007-2012 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 #include <sys/mman.h>
12 #include "mc/mc.h"
13 #include "mc/datatypes.h"
14 #include "xbt/fifo.h"
15 #include "xbt/config.h"
16 #include "xbt/function_types.h"
17 #include "xbt/mmalloc.h"
18 #include "../simix/smx_private.h"
19 #include "xbt/automaton.h"
20 #include "xbt/hash.h"
21 #include "msg/msg.h"
22 #include "msg/datatypes.h"
23 #include "xbt/strbuff.h"
24
25 /****************************** Snapshots ***********************************/
26
27 #define nb_regions 3 /* binary data (data + BSS), libsimgrid data (data + BSS), std_heap */ 
28
29 typedef struct s_mc_mem_region{
30   int type;
31   void *start_addr;
32   void *data;
33   size_t size;
34 } s_mc_mem_region_t, *mc_mem_region_t;
35
36 typedef struct s_mc_snapshot{
37   unsigned int num_reg;
38   int region_type[nb_regions];
39   size_t heap_chunks_used;
40   mc_mem_region_t *regions;
41   size_t *stack_sizes;
42   xbt_dynar_t stacks;
43   int nb_processes;
44 } s_mc_snapshot_t, *mc_snapshot_t;
45
46 typedef struct s_mc_snapshot_stack{
47   xbt_strbuff_t local_variables;
48   void *stack_pointer;
49 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
50
51 typedef struct s_mc_global_t{
52   mc_snapshot_t snapshot;
53   int raw_mem_set;
54 }s_mc_global_t, *mc_global_t;
55
56 //void MC_take_snapshot(mc_snapshot_t);
57 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
58 mc_snapshot_t MC_take_snapshot(void);
59 void MC_restore_snapshot(mc_snapshot_t);
60 void MC_free_snapshot(mc_snapshot_t);
61 void snapshot_stack_free_voidp(void *s);
62
63 /********************************* MC Global **********************************/
64 extern double *mc_time;
65
66 int MC_deadlock_check(void);
67 void MC_replay(xbt_fifo_t stack, int start);
68 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
69 void MC_wait_for_requests(void);
70 void MC_get_enabled_processes();
71 void MC_show_deadlock(smx_simcall_t req);
72 void MC_show_stack_safety(xbt_fifo_t stack);
73 void MC_dump_stack_safety(xbt_fifo_t stack);
74
75 /********************************* Requests ***********************************/
76 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
77 char* MC_request_to_string(smx_simcall_t req, int value);
78 unsigned int MC_request_testany_fail(smx_simcall_t req);
79 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
80 int MC_request_is_visible(smx_simcall_t req);
81 int MC_request_is_enabled(smx_simcall_t req);
82 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
83 int MC_process_is_enabled(smx_process_t process);
84
85
86 /******************************** States **************************************/
87 /* Possible exploration status of a process in a state */
88 typedef enum {
89   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
90   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
91   MC_DONE                   /* Already interleaved */
92 } e_mc_process_state_t;
93
94 /* On every state, each process has an entry of the following type */
95 typedef struct mc_procstate{
96   e_mc_process_state_t state;       /* Exploration control information */
97   unsigned int interleave_count;    /* Number of times that the process was
98                                        interleaved */
99 } s_mc_procstate_t, *mc_procstate_t;
100
101 /* An exploration state is composed of: */
102 typedef struct mc_state {
103   unsigned long max_pid;            /* Maximum pid at state's creation time */
104   mc_procstate_t proc_status;       /* State's exploration status by process */
105   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
106   s_smx_simcall_t internal_req;         /* Internal translation of request */
107   s_smx_simcall_t executed_req;         /* The executed request of the state */
108   int req_num;                      /* The request number (in the case of a
109                                        multi-request like waitany ) */
110   mc_snapshot_t system_state;      /* Snapshot of system state */
111 } s_mc_state_t, *mc_state_t;
112
113 extern xbt_fifo_t mc_stack_safety_stateless;
114
115 mc_state_t MC_state_new(void);
116 void MC_state_delete(mc_state_t state);
117 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
118 unsigned int MC_state_interleave_size(mc_state_t state);
119 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
120 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
121 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
122 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
123 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
124 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
125
126 /****************************** Statistics ************************************/
127 typedef struct mc_stats {
128   unsigned long state_size;
129   unsigned long visited_states;
130   unsigned long expanded_states;
131   unsigned long executed_transitions;
132 } s_mc_stats_t, *mc_stats_t;
133
134 typedef struct mc_stats_pair {
135   //unsigned long pair_size;
136   unsigned long visited_pairs;
137   unsigned long expanded_pairs;
138   unsigned long executed_transitions;
139 } s_mc_stats_pair_t, *mc_stats_pair_t;
140
141 extern mc_stats_t mc_stats;
142 extern mc_stats_pair_t mc_stats_pair;
143
144 void MC_print_statistics(mc_stats_t);
145 void MC_print_statistics_pairs(mc_stats_pair_t);
146
147 /********************************** MEMORY ******************************/
148 /* The possible memory modes for the modelchecker are standard and raw. */
149 /* Normally the system should operate in std, for switching to raw mode */
150 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
151
152 extern void *std_heap;
153 extern void *raw_heap;
154
155
156 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
157 /* an API to query about the status of a heap, we simply call mmstats and */
158 /* because I now how does structure looks like, then I redefine it here */
159
160 /* struct mstats { */
161 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
162 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
163 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
164 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
165 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
166 /* }; */
167
168 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
169 #define MC_UNSET_RAW_MEM  mmalloc_set_current_heap(std_heap)
170
171 /******************************* MEMORY MAPPINGS ***************************/
172 /* These functions and data structures implements a binary interface for   */
173 /* the proc maps ascii interface                                           */
174
175 /* Each field is defined as documented in proc's manual page  */
176 typedef struct s_map_region {
177
178   void *start_addr;             /* Start address of the map */
179   void *end_addr;               /* End address of the map */
180   int prot;                     /* Memory protection */
181   int flags;                    /* Aditional memory flags */
182   void *offset;                 /* Offset in the file/whatever */
183   char dev_major;               /* Major of the device */
184   char dev_minor;               /* Minor of the device */
185   unsigned long inode;          /* Inode in the device */
186   char *pathname;               /* Path name of the mapped file */
187
188 } s_map_region_t;
189
190 typedef struct s_memory_map {
191
192   s_map_region_t *regions;      /* Pointer to an array of regions */
193   int mapsize;                  /* Number of regions in the memory */
194
195 } s_memory_map_t, *memory_map_t;
196
197 memory_map_t get_memory_map(void);
198 void free_memory_map(memory_map_t map);
199 void get_libsimgrid_plt_section(void);
200 void get_binary_plt_section(void);
201
202 extern void *start_data_libsimgrid;
203 extern void *end_raw_heap;
204 extern void *start_data_binary;
205 extern void *start_bss_binary;
206 extern char *libsimgrid_path;
207 extern void *start_text_libsimgrid;
208 extern void *start_bss_libsimgrid;
209 extern void *start_plt_libsimgrid;
210 extern void *end_plt_libsimgrid;
211 extern void *start_plt_binary;
212 extern void *end_plt_binary;
213 extern void *start_got_plt_libsimgrid;
214 extern void *end_got_plt_libsimgrid;
215 extern void *start_got_plt_binary;
216 extern void *end_got_plt_binary;
217
218 /********************************** Snapshot comparison **********************************/
219
220 typedef struct s_mc_comparison_times{
221   double nb_processes_comparison_time;
222   double chunks_used_comparison_time;
223   double stacks_sizes_comparison_time;
224   double binary_global_variables_comparison_time;
225   double libsimgrid_global_variables_comparison_time;
226   double heap_comparison_time;
227   double stacks_comparison_time;
228 }s_mc_comparison_times_t, *mc_comparison_times_t;
229
230 extern mc_comparison_times_t mc_comp_times;
231 extern double mc_snapshot_comparison_time;
232
233 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
234 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
235 void print_comparison_times(void);
236
237 //#define MC_DEBUG 1
238 //#define MC_VERBOSE 1
239
240 /********************************** DPOR for safety  **************************************/
241 typedef enum {
242   e_mc_reduce_unset,
243   e_mc_reduce_none,
244   e_mc_reduce_dpor
245 } e_mc_reduce_t;
246
247 extern e_mc_reduce_t mc_reduce_kind;
248 extern mc_global_t initial_state_safety;
249
250 void MC_dpor_init(void);
251 void MC_dpor(void);
252 void MC_dpor_exit(void);
253 void MC_init(void);
254
255 typedef struct s_mc_safety_visited_state{
256   mc_snapshot_t system_state;
257   int num;
258 }s_mc_safety_visited_state_t, *mc_safety_visited_state_t;
259
260
261 /********************************** Double-DFS for liveness property**************************************/
262
263 extern xbt_fifo_t mc_stack_liveness;
264 extern mc_global_t initial_state_liveness;
265 extern xbt_automaton_t _mc_property_automaton;
266 extern int compare;
267 extern xbt_dynar_t mc_stack_comparison_ignore;
268 extern xbt_dynar_t mc_data_bss_comparison_ignore;
269
270
271 typedef struct s_mc_pair{
272   mc_snapshot_t system_state;
273   mc_state_t graph_state;
274   xbt_state_t automaton_state;
275 }s_mc_pair_t, *mc_pair_t;
276
277 typedef struct s_mc_pair_reached{
278   int nb;
279   xbt_state_t automaton_state;
280   xbt_dynar_t prop_ato;
281   mc_snapshot_t system_state;
282 }s_mc_pair_reached_t, *mc_pair_reached_t;
283
284 typedef struct s_mc_pair_visited{
285   xbt_state_t automaton_state;
286   xbt_dynar_t prop_ato;
287   mc_snapshot_t system_state;
288 }s_mc_pair_visited_t, *mc_pair_visited_t;
289
290 int MC_automaton_evaluate_label(xbt_exp_label_t l);
291 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
292
293 int reached(xbt_state_t st);
294 void set_pair_reached(xbt_state_t st);
295 int visited(xbt_state_t st);
296
297 void MC_pair_delete(mc_pair_t pair);
298 void MC_exit_liveness(void);
299 mc_state_t MC_state_pair_new(void);
300 void pair_reached_free(mc_pair_reached_t pair);
301 void pair_reached_free_voidp(void *p);
302 void pair_visited_free(mc_pair_visited_t pair);
303 void pair_visited_free_voidp(void *p);
304 void MC_init_liveness(void);
305 void MC_init_memory_map_info(void);
306
307 int get_heap_region_index(mc_snapshot_t s);
308
309 /* **** Double-DFS stateless **** */
310
311 typedef struct s_mc_pair_stateless{
312   mc_state_t graph_state;
313   xbt_state_t automaton_state;
314   int requests;
315 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
316
317 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
318 void MC_ddfs_init(void);
319 void MC_ddfs(int search_cycle);
320 void MC_show_stack_liveness(xbt_fifo_t stack);
321 void MC_dump_stack_liveness(xbt_fifo_t stack);
322 void pair_stateless_free(mc_pair_stateless_t pair);
323 void pair_stateless_free_voidp(void *p);
324
325 /********************************** Configuration of MC **************************************/
326 extern xbt_fifo_t mc_stack_safety;
327
328 /****** Core dump ******/
329
330 int create_dump(int pair);
331
332 /****** Local variables with DWARF ******/
333
334 typedef enum {
335   e_dw_loclist,
336   e_dw_register,
337   e_dw_bregister_op,
338   e_dw_lit,
339   e_dw_fbregister_op,
340   e_dw_piece,
341   e_dw_arithmetic,
342   e_dw_plus_uconst,
343   e_dw_compose,
344   e_dw_deref,
345   e_dw_uconstant,
346   e_dw_sconstant,
347   e_dw_unsupported
348 } e_dw_location_type;
349
350 typedef struct s_dw_location{
351   e_dw_location_type type;
352   union{
353     
354     xbt_dynar_t loclist;
355     
356     int reg;
357     
358     struct{
359       unsigned int reg;
360       int offset;
361     }breg_op;
362
363     unsigned int lit;
364
365     int fbreg_op;
366
367     int piece;
368
369     unsigned short int deref_size;
370
371     xbt_dynar_t compose;
372
373     char *arithmetic;
374
375     struct{
376       int bytes;
377       long unsigned int value;
378     }uconstant;
379
380     struct{
381       int bytes;
382       long signed int value;
383     }sconstant;
384
385     unsigned int plus_uconst;
386
387   }location;
388 }s_dw_location_t, *dw_location_t;
389
390 typedef struct s_dw_location_entry{
391   long lowpc;
392   long highpc;
393   dw_location_t location;
394 }s_dw_location_entry_t, *dw_location_entry_t;
395
396 typedef struct s_dw_local_variable{
397   char *name;
398   dw_location_t location;
399 }s_dw_local_variable_t, *dw_local_variable_t;
400
401 typedef struct s_dw_frame{
402   char *name;
403   void *low_pc;
404   void *high_pc;
405   dw_location_t frame_base;
406   xbt_dict_t variables;
407   unsigned long int start;
408   unsigned long int end;
409 }s_dw_frame_t, *dw_frame_t;
410
411 /* FIXME : implement free functions for each structure */
412
413 extern xbt_dict_t mc_local_variables;
414
415 typedef struct s_variable_value{
416   char *type;
417   
418   union{
419     void *address;
420     long int res;
421   }value;
422 }s_variable_value_t, *variable_value_t;
423
424 void variable_value_free_voidp(void* v);
425 void variable_value_free(variable_value_t v);
426
427 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
428 void print_local_variables(xbt_dict_t list);
429 char *get_libsimgrid_path(void);
430 xbt_dict_t MC_get_location_list(const char *elf_file);
431
432 /**** Global variables ****/
433
434 typedef struct s_global_variable{
435   char *name;
436   size_t size;
437   void *address;
438 }s_global_variable_t, *global_variable_t;
439
440 void global_variable_free(global_variable_t v);
441 void global_variable_free_voidp(void *v);
442
443 extern xbt_dynar_t mc_global_variables;
444
445 #endif