1 /* Copyright (c) 2007-2012 Da SimGrid Team. All rights reserved. */
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. */
9 #include "simgrid_config.h"
13 #include "mc/datatypes.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"
22 #include "msg/datatypes.h"
23 #include "xbt/strbuff.h"
25 /****************************** Snapshots ***********************************/
27 #define nb_regions 3 /* binary data (data + BSS), libsimgrid data (data + BSS), std_heap */
29 typedef struct s_mc_mem_region{
34 } s_mc_mem_region_t, *mc_mem_region_t;
36 typedef struct s_mc_snapshot{
38 int region_type[nb_regions];
39 size_t heap_bytes_used;
40 mc_mem_region_t *regions;
44 xbt_dynar_t to_ignore;
45 } s_mc_snapshot_t, *mc_snapshot_t;
47 typedef struct s_mc_snapshot_stack{
48 xbt_strbuff_t local_variables;
50 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
52 typedef struct s_mc_global_t{
53 mc_snapshot_t snapshot;
55 }s_mc_global_t, *mc_global_t;
57 //void MC_take_snapshot(mc_snapshot_t);
58 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
59 mc_snapshot_t MC_take_snapshot(void);
60 void MC_restore_snapshot(mc_snapshot_t);
61 void MC_free_snapshot(mc_snapshot_t);
62 void snapshot_stack_free_voidp(void *s);
64 /********************************* MC Global **********************************/
65 extern double *mc_time;
67 int MC_deadlock_check(void);
68 void MC_replay(xbt_fifo_t stack, int start);
69 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
70 void MC_wait_for_requests(void);
71 void MC_get_enabled_processes();
72 void MC_show_deadlock(smx_simcall_t req);
73 void MC_show_stack_safety(xbt_fifo_t stack);
74 void MC_dump_stack_safety(xbt_fifo_t stack);
76 /********************************* Requests ***********************************/
77 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
78 char* MC_request_to_string(smx_simcall_t req, int value);
79 unsigned int MC_request_testany_fail(smx_simcall_t req);
80 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
81 int MC_request_is_visible(smx_simcall_t req);
82 int MC_request_is_enabled(smx_simcall_t req);
83 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
84 int MC_process_is_enabled(smx_process_t process);
87 /******************************** States **************************************/
88 /* Possible exploration status of a process in a state */
90 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
91 MC_INTERLEAVE, /* Interleave the process (one or more request) */
92 MC_DONE /* Already interleaved */
93 } e_mc_process_state_t;
95 /* On every state, each process has an entry of the following type */
96 typedef struct mc_procstate{
97 e_mc_process_state_t state; /* Exploration control information */
98 unsigned int interleave_count; /* Number of times that the process was
100 } s_mc_procstate_t, *mc_procstate_t;
102 /* An exploration state is composed of: */
103 typedef struct mc_state {
104 unsigned long max_pid; /* Maximum pid at state's creation time */
105 mc_procstate_t proc_status; /* State's exploration status by process */
106 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
107 s_smx_simcall_t internal_req; /* Internal translation of request */
108 s_smx_simcall_t executed_req; /* The executed request of the state */
109 int req_num; /* The request number (in the case of a
110 multi-request like waitany ) */
111 mc_snapshot_t system_state; /* Snapshot of system state */
112 } s_mc_state_t, *mc_state_t;
114 extern xbt_fifo_t mc_stack_safety_stateless;
116 mc_state_t MC_state_new(void);
117 void MC_state_delete(mc_state_t state);
118 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
119 unsigned int MC_state_interleave_size(mc_state_t state);
120 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
121 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
122 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
123 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
124 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
125 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
127 /****************************** Statistics ************************************/
128 typedef struct mc_stats {
129 unsigned long state_size;
130 unsigned long visited_states;
131 unsigned long expanded_states;
132 unsigned long executed_transitions;
133 } s_mc_stats_t, *mc_stats_t;
135 typedef struct mc_stats_pair {
136 //unsigned long pair_size;
137 unsigned long visited_pairs;
138 unsigned long expanded_pairs;
139 unsigned long executed_transitions;
140 } s_mc_stats_pair_t, *mc_stats_pair_t;
142 extern mc_stats_t mc_stats;
143 extern mc_stats_pair_t mc_stats_pair;
145 void MC_print_statistics(mc_stats_t);
146 void MC_print_statistics_pairs(mc_stats_pair_t);
148 /********************************** MEMORY ******************************/
149 /* The possible memory modes for the modelchecker are standard and raw. */
150 /* Normally the system should operate in std, for switching to raw mode */
151 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
153 extern void *std_heap;
154 extern void *raw_heap;
157 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
158 /* an API to query about the status of a heap, we simply call mmstats and */
159 /* because I now how does structure looks like, then I redefine it here */
161 /* struct mstats { */
162 /* size_t bytes_total; /\* Total size of the heap. *\/ */
163 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
164 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
165 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
166 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
169 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
170 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
172 /******************************* MEMORY MAPPINGS ***************************/
173 /* These functions and data structures implements a binary interface for */
174 /* the proc maps ascii interface */
176 /* Each field is defined as documented in proc's manual page */
177 typedef struct s_map_region {
179 void *start_addr; /* Start address of the map */
180 void *end_addr; /* End address of the map */
181 int prot; /* Memory protection */
182 int flags; /* Aditional memory flags */
183 void *offset; /* Offset in the file/whatever */
184 char dev_major; /* Major of the device */
185 char dev_minor; /* Minor of the device */
186 unsigned long inode; /* Inode in the device */
187 char *pathname; /* Path name of the mapped file */
191 typedef struct s_memory_map {
193 s_map_region_t *regions; /* Pointer to an array of regions */
194 int mapsize; /* Number of regions in the memory */
196 } s_memory_map_t, *memory_map_t;
198 memory_map_t get_memory_map(void);
199 void free_memory_map(memory_map_t map);
200 void get_libsimgrid_plt_section(void);
201 void get_binary_plt_section(void);
203 extern void *start_data_libsimgrid;
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;
218 /********************************** Snapshot comparison **********************************/
220 typedef struct s_mc_comparison_times{
221 double nb_processes_comparison_time;
222 double bytes_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;
230 extern mc_comparison_times_t mc_comp_times;
231 extern double mc_snapshot_comparison_time;
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);
238 //#define MC_VERBOSE 1
240 /********************************** DPOR for safety **************************************/
247 extern e_mc_reduce_t mc_reduce_kind;
248 extern mc_global_t initial_state_safety;
250 void MC_dpor_init(void);
252 void MC_dpor_exit(void);
255 typedef struct s_mc_safety_visited_state{
256 mc_snapshot_t system_state;
258 }s_mc_safety_visited_state_t, *mc_safety_visited_state_t;
261 /********************************** Double-DFS for liveness property**************************************/
263 extern xbt_fifo_t mc_stack_liveness;
264 extern mc_global_t initial_state_liveness;
265 extern xbt_automaton_t _mc_property_automaton;
267 extern xbt_dynar_t mc_stack_comparison_ignore;
268 extern xbt_dynar_t mc_data_bss_comparison_ignore;
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;
277 typedef struct s_mc_pair_reached{
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;
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;
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);
293 int reached(xbt_state_t st);
294 void set_pair_reached(xbt_state_t st);
295 int visited(xbt_state_t st);
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);
307 int get_heap_region_index(mc_snapshot_t s);
309 /* **** Double-DFS stateless **** */
311 typedef struct s_mc_pair_stateless{
312 mc_state_t graph_state;
313 xbt_state_t automaton_state;
315 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
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);
325 /********************************** Configuration of MC **************************************/
326 extern xbt_fifo_t mc_stack_safety;
328 /****** Core dump ******/
330 int create_dump(int pair);
332 /****** Local variables with DWARF ******/
348 } e_dw_location_type;
350 typedef struct s_dw_location{
351 e_dw_location_type type;
369 unsigned short int deref_size;
377 long unsigned int value;
382 long signed int value;
385 unsigned int plus_uconst;
388 }s_dw_location_t, *dw_location_t;
390 typedef struct s_dw_location_entry{
393 dw_location_t location;
394 }s_dw_location_entry_t, *dw_location_entry_t;
396 typedef struct s_dw_local_variable{
398 dw_location_t location;
399 }s_dw_local_variable_t, *dw_local_variable_t;
401 typedef struct s_dw_frame{
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;
411 /* FIXME : implement free functions for each structure */
413 extern xbt_dict_t mc_local_variables;
415 typedef struct s_variable_value{
422 }s_variable_value_t, *variable_value_t;
424 void variable_value_free_voidp(void* v);
425 void variable_value_free(variable_value_t v);
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);
432 /**** Global variables ****/
434 typedef struct s_global_variable{
438 }s_global_variable_t, *global_variable_t;
440 void global_variable_free(global_variable_t v);
441 void global_variable_free_voidp(void *v);
443 extern xbt_dynar_t mc_global_variables;