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), libsimgrid data (data + BSS), std_heap */
31 typedef struct s_mc_mem_region{
36 } s_mc_mem_region_t, *mc_mem_region_t;
38 typedef struct s_mc_snapshot{
40 int region_type[nb_regions];
41 size_t heap_bytes_used;
42 mc_mem_region_t *regions;
46 xbt_dynar_t to_ignore;
47 } s_mc_snapshot_t, *mc_snapshot_t;
49 typedef struct s_mc_snapshot_stack{
50 xbt_strbuff_t local_variables;
52 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
54 typedef struct s_mc_global_t{
55 mc_snapshot_t snapshot;
57 }s_mc_global_t, *mc_global_t;
59 //void MC_take_snapshot(mc_snapshot_t);
60 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
61 mc_snapshot_t MC_take_snapshot(void);
62 void MC_restore_snapshot(mc_snapshot_t);
63 void MC_free_snapshot(mc_snapshot_t);
64 void snapshot_stack_free_voidp(void *s);
66 /********************************* MC Global **********************************/
67 extern double *mc_time;
69 int MC_deadlock_check(void);
70 void MC_replay(xbt_fifo_t stack, int start);
71 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
72 void MC_wait_for_requests(void);
73 void MC_get_enabled_processes();
74 void MC_show_deadlock(smx_simcall_t req);
75 void MC_show_stack_safety(xbt_fifo_t stack);
76 void MC_dump_stack_safety(xbt_fifo_t stack);
78 /********************************* Requests ***********************************/
79 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
80 char* MC_request_to_string(smx_simcall_t req, int value);
81 unsigned int MC_request_testany_fail(smx_simcall_t req);
82 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
83 int MC_request_is_visible(smx_simcall_t req);
84 int MC_request_is_enabled(smx_simcall_t req);
85 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
86 int MC_process_is_enabled(smx_process_t process);
89 /******************************** States **************************************/
90 /* Possible exploration status of a process in a state */
92 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
93 MC_INTERLEAVE, /* Interleave the process (one or more request) */
94 MC_DONE /* Already interleaved */
95 } e_mc_process_state_t;
97 /* On every state, each process has an entry of the following type */
98 typedef struct mc_procstate{
99 e_mc_process_state_t state; /* Exploration control information */
100 unsigned int interleave_count; /* Number of times that the process was
102 } s_mc_procstate_t, *mc_procstate_t;
104 /* An exploration state is composed of: */
105 typedef struct mc_state {
106 unsigned long max_pid; /* Maximum pid at state's creation time */
107 mc_procstate_t proc_status; /* State's exploration status by process */
108 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
109 s_smx_simcall_t internal_req; /* Internal translation of request */
110 s_smx_simcall_t executed_req; /* The executed request of the state */
111 int req_num; /* The request number (in the case of a
112 multi-request like waitany ) */
113 mc_snapshot_t system_state; /* Snapshot of system state */
114 } s_mc_state_t, *mc_state_t;
116 extern xbt_fifo_t mc_stack_safety_stateless;
118 mc_state_t MC_state_new(void);
119 void MC_state_delete(mc_state_t state);
120 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
121 unsigned int MC_state_interleave_size(mc_state_t state);
122 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
123 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
124 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
125 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
126 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
127 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
129 /****************************** Statistics ************************************/
130 typedef struct mc_stats {
131 unsigned long state_size;
132 unsigned long visited_states;
133 unsigned long expanded_states;
134 unsigned long executed_transitions;
135 } s_mc_stats_t, *mc_stats_t;
137 typedef struct mc_stats_pair {
138 //unsigned long pair_size;
139 unsigned long visited_pairs;
140 unsigned long expanded_pairs;
141 unsigned long executed_transitions;
142 } s_mc_stats_pair_t, *mc_stats_pair_t;
144 extern mc_stats_t mc_stats;
145 extern mc_stats_pair_t mc_stats_pair;
147 void MC_print_statistics(mc_stats_t);
148 void MC_print_statistics_pairs(mc_stats_pair_t);
150 /********************************** MEMORY ******************************/
151 /* The possible memory modes for the modelchecker are standard and raw. */
152 /* Normally the system should operate in std, for switching to raw mode */
153 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
155 extern void *std_heap;
156 extern void *raw_heap;
159 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
160 /* an API to query about the status of a heap, we simply call mmstats and */
161 /* because I now how does structure looks like, then I redefine it here */
163 /* struct mstats { */
164 /* size_t bytes_total; /\* Total size of the heap. *\/ */
165 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
166 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
167 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
168 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
171 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
172 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
174 /******************************* MEMORY MAPPINGS ***************************/
175 /* These functions and data structures implements a binary interface for */
176 /* the proc maps ascii interface */
178 /* Each field is defined as documented in proc's manual page */
179 typedef struct s_map_region {
181 void *start_addr; /* Start address of the map */
182 void *end_addr; /* End address of the map */
183 int prot; /* Memory protection */
184 int flags; /* Aditional memory flags */
185 void *offset; /* Offset in the file/whatever */
186 char dev_major; /* Major of the device */
187 char dev_minor; /* Minor of the device */
188 unsigned long inode; /* Inode in the device */
189 char *pathname; /* Path name of the mapped file */
193 typedef struct s_memory_map {
195 s_map_region_t *regions; /* Pointer to an array of regions */
196 int mapsize; /* Number of regions in the memory */
198 } s_memory_map_t, *memory_map_t;
200 memory_map_t get_memory_map(void);
201 void free_memory_map(memory_map_t map);
202 void get_libsimgrid_plt_section(void);
203 void get_binary_plt_section(void);
205 extern void *start_data_libsimgrid;
206 extern void *start_data_binary;
207 extern void *start_bss_binary;
208 extern char *libsimgrid_path;
209 extern void *start_text_libsimgrid;
210 extern void *start_bss_libsimgrid;
211 extern void *start_plt_libsimgrid;
212 extern void *end_plt_libsimgrid;
213 extern void *start_plt_binary;
214 extern void *end_plt_binary;
215 extern void *start_got_plt_libsimgrid;
216 extern void *end_got_plt_libsimgrid;
217 extern void *start_got_plt_binary;
218 extern void *end_got_plt_binary;
220 /********************************** Snapshot comparison **********************************/
222 typedef struct s_mc_comparison_times{
223 double nb_processes_comparison_time;
224 double bytes_used_comparison_time;
225 double stacks_sizes_comparison_time;
226 double binary_global_variables_comparison_time;
227 double libsimgrid_global_variables_comparison_time;
228 double heap_comparison_time;
229 double stacks_comparison_time;
230 }s_mc_comparison_times_t, *mc_comparison_times_t;
232 extern mc_comparison_times_t mc_comp_times;
233 extern double mc_snapshot_comparison_time;
235 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
236 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
237 void print_comparison_times(void);
240 //#define MC_VERBOSE 1
242 /********************************** DPOR for safety **************************************/
249 extern e_mc_reduce_t mc_reduce_kind;
250 extern mc_global_t initial_state_safety;
252 void MC_dpor_init(void);
254 void MC_dpor_exit(void);
257 typedef struct s_mc_safety_visited_state{
258 mc_snapshot_t system_state;
260 }s_mc_safety_visited_state_t, *mc_safety_visited_state_t;
263 /********************************** Double-DFS for liveness property**************************************/
265 extern xbt_fifo_t mc_stack_liveness;
266 extern mc_global_t initial_state_liveness;
267 extern xbt_automaton_t _mc_property_automaton;
269 extern xbt_dynar_t mc_stack_comparison_ignore;
270 extern xbt_dynar_t mc_data_bss_comparison_ignore;
273 typedef struct s_mc_pair{
274 mc_snapshot_t system_state;
275 mc_state_t graph_state;
276 xbt_state_t automaton_state;
277 }s_mc_pair_t, *mc_pair_t;
279 typedef struct s_mc_pair_reached{
281 xbt_state_t automaton_state;
282 xbt_dynar_t prop_ato;
283 mc_snapshot_t system_state;
284 }s_mc_pair_reached_t, *mc_pair_reached_t;
286 typedef struct s_mc_pair_visited{
287 xbt_state_t automaton_state;
288 xbt_dynar_t prop_ato;
289 mc_snapshot_t system_state;
290 }s_mc_pair_visited_t, *mc_pair_visited_t;
292 int MC_automaton_evaluate_label(xbt_exp_label_t l);
293 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
295 int reached(xbt_state_t st);
296 void set_pair_reached(xbt_state_t st);
297 int visited(xbt_state_t st);
299 void MC_pair_delete(mc_pair_t pair);
300 void MC_exit_liveness(void);
301 mc_state_t MC_state_pair_new(void);
302 void pair_reached_free(mc_pair_reached_t pair);
303 void pair_reached_free_voidp(void *p);
304 void pair_visited_free(mc_pair_visited_t pair);
305 void pair_visited_free_voidp(void *p);
306 void MC_init_liveness(void);
307 void MC_init_memory_map_info(void);
309 int get_heap_region_index(mc_snapshot_t s);
311 /* **** Double-DFS stateless **** */
313 typedef struct s_mc_pair_stateless{
314 mc_state_t graph_state;
315 xbt_state_t automaton_state;
317 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
319 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
320 void MC_ddfs_init(void);
321 void MC_ddfs(int search_cycle);
322 void MC_show_stack_liveness(xbt_fifo_t stack);
323 void MC_dump_stack_liveness(xbt_fifo_t stack);
324 void pair_stateless_free(mc_pair_stateless_t pair);
325 void pair_stateless_free_voidp(void *p);
327 /********************************** Configuration of MC **************************************/
328 extern xbt_fifo_t mc_stack_safety;
330 /****** Core dump ******/
332 int create_dump(int pair);
334 /****** Local variables with DWARF ******/
350 } e_dw_location_type;
352 typedef struct s_dw_location{
353 e_dw_location_type type;
371 unsigned short int deref_size;
379 long unsigned int value;
384 long signed int value;
387 unsigned int plus_uconst;
390 }s_dw_location_t, *dw_location_t;
392 typedef struct s_dw_location_entry{
395 dw_location_t location;
396 }s_dw_location_entry_t, *dw_location_entry_t;
398 typedef struct s_dw_local_variable{
400 dw_location_t location;
401 }s_dw_local_variable_t, *dw_local_variable_t;
403 typedef struct s_dw_frame{
407 dw_location_t frame_base;
408 xbt_dict_t variables;
409 unsigned long int start;
410 unsigned long int end;
411 }s_dw_frame_t, *dw_frame_t;
413 /* FIXME : implement free functions for each structure */
415 extern xbt_dict_t mc_local_variables;
417 typedef struct s_variable_value{
424 }s_variable_value_t, *variable_value_t;
426 void variable_value_free_voidp(void* v);
427 void variable_value_free(variable_value_t v);
429 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
430 void print_local_variables(xbt_dict_t list);
431 char *get_libsimgrid_path(void);
432 xbt_dict_t MC_get_location_list(const char *elf_file);
434 /**** Global variables ****/
436 typedef struct s_global_variable{
440 }s_global_variable_t, *global_variable_t;
442 void global_variable_free(global_variable_t v);
443 void global_variable_free_voidp(void *v);
445 extern xbt_dynar_t mc_global_variables;