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"
15 #include "mc/datatypes.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"
24 #include "msg/datatypes.h"
25 #include "xbt/strbuff.h"
27 /****************************** Snapshots ***********************************/
29 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
31 typedef struct s_mc_mem_region{
35 } s_mc_mem_region_t, *mc_mem_region_t;
37 typedef struct s_mc_snapshot{
38 size_t heap_bytes_used;
39 mc_mem_region_t regions[NB_REGIONS];
43 xbt_dynar_t to_ignore;
44 } s_mc_snapshot_t, *mc_snapshot_t;
46 typedef struct s_mc_snapshot_stack{
47 xbt_strbuff_t local_variables;
49 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
51 typedef struct s_mc_global_t{
52 mc_snapshot_t snapshot;
54 }s_mc_global_t, *mc_global_t;
56 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
57 mc_snapshot_t MC_take_snapshot(void);
58 void MC_restore_snapshot(mc_snapshot_t);
59 void MC_free_snapshot(mc_snapshot_t);
60 void snapshot_stack_free_voidp(void *s);
62 /********************************* MC Global **********************************/
63 extern double *mc_time;
65 int MC_deadlock_check(void);
66 void MC_replay(xbt_fifo_t stack, int start);
67 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
68 void MC_wait_for_requests(void);
69 void MC_show_deadlock(smx_simcall_t req);
70 void MC_show_stack_safety(xbt_fifo_t stack);
71 void MC_dump_stack_safety(xbt_fifo_t stack);
73 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
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);
86 /******************************** States **************************************/
87 /* Possible exploration status of a process in a state */
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;
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
99 } s_mc_procstate_t, *mc_procstate_t;
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;
113 mc_state_t MC_state_new(void);
114 void MC_state_delete(mc_state_t state);
115 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
116 unsigned int MC_state_interleave_size(mc_state_t state);
117 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
118 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
119 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
120 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
121 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
122 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
124 /****************************** Statistics ************************************/
125 typedef struct mc_stats {
126 unsigned long state_size;
127 unsigned long visited_states;
128 unsigned long expanded_states;
129 unsigned long executed_transitions;
130 } s_mc_stats_t, *mc_stats_t;
132 typedef struct mc_stats_pair {
133 //unsigned long pair_size;
134 unsigned long visited_pairs;
135 unsigned long expanded_pairs;
136 unsigned long executed_transitions;
137 } s_mc_stats_pair_t, *mc_stats_pair_t;
139 extern mc_stats_t mc_stats;
140 extern mc_stats_pair_t mc_stats_pair;
142 void MC_print_statistics(mc_stats_t);
143 void MC_print_statistics_pairs(mc_stats_pair_t);
145 /********************************** MEMORY ******************************/
146 /* The possible memory modes for the modelchecker are standard and raw. */
147 /* Normally the system should operate in std, for switching to raw mode */
148 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
150 extern void *std_heap;
151 extern void *raw_heap;
154 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
155 /* an API to query about the status of a heap, we simply call mmstats and */
156 /* because I now how does structure looks like, then I redefine it here */
158 /* struct mstats { */
159 /* size_t bytes_total; /\* Total size of the heap. *\/ */
160 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
161 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
162 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
163 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
166 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
167 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
169 /******************************* MEMORY MAPPINGS ***************************/
170 /* These functions and data structures implements a binary interface for */
171 /* the proc maps ascii interface */
173 /* Each field is defined as documented in proc's manual page */
174 typedef struct s_map_region {
176 void *start_addr; /* Start address of the map */
177 void *end_addr; /* End address of the map */
178 int prot; /* Memory protection */
179 int flags; /* Aditional memory flags */
180 void *offset; /* Offset in the file/whatever */
181 char dev_major; /* Major of the device */
182 char dev_minor; /* Minor of the device */
183 unsigned long inode; /* Inode in the device */
184 char *pathname; /* Path name of the mapped file */
188 typedef struct s_memory_map {
190 s_map_region_t *regions; /* Pointer to an array of regions */
191 int mapsize; /* Number of regions in the memory */
193 } s_memory_map_t, *memory_map_t;
195 memory_map_t get_memory_map(void);
196 void free_memory_map(memory_map_t map);
197 void get_libsimgrid_plt_section(void);
198 void get_binary_plt_section(void);
200 extern void *start_data_libsimgrid;
201 extern void *start_data_binary;
202 extern void *start_bss_binary;
203 extern char *libsimgrid_path;
204 extern void *start_text_libsimgrid;
205 extern void *start_bss_libsimgrid;
206 extern void *start_plt_libsimgrid;
207 extern void *end_plt_libsimgrid;
208 extern void *start_plt_binary;
209 extern void *end_plt_binary;
210 extern void *start_got_plt_libsimgrid;
211 extern void *end_got_plt_libsimgrid;
212 extern void *start_got_plt_binary;
213 extern void *end_got_plt_binary;
215 /********************************** Snapshot comparison **********************************/
217 typedef struct s_mc_comparison_times{
218 double nb_processes_comparison_time;
219 double bytes_used_comparison_time;
220 double stacks_sizes_comparison_time;
221 double binary_global_variables_comparison_time;
222 double libsimgrid_global_variables_comparison_time;
223 double heap_comparison_time;
224 double stacks_comparison_time;
225 }s_mc_comparison_times_t, *mc_comparison_times_t;
227 extern mc_comparison_times_t mc_comp_times;
228 extern double mc_snapshot_comparison_time;
230 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
231 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
232 void print_comparison_times(void);
235 //#define MC_VERBOSE 1
237 /********************************** DPOR for safety **************************************/
244 extern e_mc_reduce_t mc_reduce_kind;
245 extern mc_global_t initial_state_safety;
247 void MC_dpor_init(void);
251 typedef struct s_mc_safety_visited_state{
252 mc_snapshot_t system_state;
254 }s_mc_safety_visited_state_t, *mc_safety_visited_state_t;
257 /********************************** Double-DFS for liveness property**************************************/
259 extern xbt_fifo_t mc_stack_liveness;
260 extern mc_global_t initial_state_liveness;
261 extern xbt_automaton_t _mc_property_automaton;
263 extern xbt_dynar_t mc_stack_comparison_ignore;
264 extern xbt_dynar_t mc_data_bss_comparison_ignore;
267 typedef struct s_mc_pair{
268 mc_snapshot_t system_state;
269 mc_state_t graph_state;
270 xbt_state_t automaton_state;
271 }s_mc_pair_t, *mc_pair_t;
273 typedef struct s_mc_pair_reached{
275 xbt_state_t automaton_state;
276 xbt_dynar_t prop_ato;
277 mc_snapshot_t system_state;
278 }s_mc_pair_reached_t, *mc_pair_reached_t;
280 typedef struct s_mc_pair_visited{
281 xbt_state_t automaton_state;
282 xbt_dynar_t prop_ato;
283 mc_snapshot_t system_state;
284 }s_mc_pair_visited_t, *mc_pair_visited_t;
286 int MC_automaton_evaluate_label(xbt_exp_label_t l);
288 int reached(xbt_state_t st);
289 void set_pair_reached(xbt_state_t st);
290 int visited(xbt_state_t st);
292 void MC_pair_delete(mc_pair_t pair);
293 mc_state_t MC_state_pair_new(void);
294 void pair_reached_free(mc_pair_reached_t pair);
295 void pair_reached_free_voidp(void *p);
296 void pair_visited_free(mc_pair_visited_t pair);
297 void pair_visited_free_voidp(void *p);
298 void MC_init_memory_map_info(void);
300 int get_heap_region_index(mc_snapshot_t s);
302 /* **** Double-DFS stateless **** */
304 typedef struct s_mc_pair_stateless{
305 mc_state_t graph_state;
306 xbt_state_t automaton_state;
308 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
310 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
311 void MC_ddfs_init(void);
312 void MC_ddfs(int search_cycle);
313 void MC_show_stack_liveness(xbt_fifo_t stack);
314 void MC_dump_stack_liveness(xbt_fifo_t stack);
315 void pair_stateless_free(mc_pair_stateless_t pair);
316 void pair_stateless_free_voidp(void *p);
318 /********************************** Configuration of MC **************************************/
319 extern xbt_fifo_t mc_stack_safety;
321 /****** Core dump ******/
323 int create_dump(int pair);
325 /****** Local variables with DWARF ******/
341 } e_dw_location_type;
343 typedef struct s_dw_location{
344 e_dw_location_type type;
362 unsigned short int deref_size;
370 long unsigned int value;
375 long signed int value;
378 unsigned int plus_uconst;
381 }s_dw_location_t, *dw_location_t;
383 typedef struct s_dw_location_entry{
386 dw_location_t location;
387 }s_dw_location_entry_t, *dw_location_entry_t;
389 typedef struct s_dw_local_variable{
391 dw_location_t location;
392 }s_dw_local_variable_t, *dw_local_variable_t;
394 typedef struct s_dw_frame{
398 dw_location_t frame_base;
399 xbt_dict_t variables;
400 unsigned long int start;
401 unsigned long int end;
402 }s_dw_frame_t, *dw_frame_t;
404 /* FIXME : implement free functions for each structure */
406 extern xbt_dict_t mc_local_variables;
408 typedef struct s_variable_value{
415 }s_variable_value_t, *variable_value_t;
417 void variable_value_free_voidp(void* v);
418 void variable_value_free(variable_value_t v);
420 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
421 void print_local_variables(xbt_dict_t list);
422 xbt_dict_t MC_get_location_list(const char *elf_file);
424 /**** Global variables ****/
426 typedef struct s_global_variable{
430 }s_global_variable_t, *global_variable_t;
432 void global_variable_free(global_variable_t v);
433 void global_variable_free_voidp(void *v);
435 extern xbt_dynar_t mc_global_variables;