Logo AND Algorithmique Numérique Distribuée

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