1 /* Copyright (c) 2007-2013 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;
46 } s_mc_snapshot_t, *mc_snapshot_t;
48 typedef struct s_mc_snapshot_stack{
49 xbt_strbuff_t local_variables;
51 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
53 typedef struct s_mc_global_t{
54 mc_snapshot_t snapshot;
56 }s_mc_global_t, *mc_global_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);
63 int is_stack_ignore_variable(char *frame, char *var_name);
65 /********************************* MC Global **********************************/
67 extern double *mc_time;
68 extern FILE *dot_output;
69 extern const char* colors[10];
71 int MC_deadlock_check(void);
72 void MC_replay(xbt_fifo_t stack, int start);
73 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
74 void MC_wait_for_requests(void);
75 void MC_show_deadlock(smx_simcall_t req);
76 void MC_show_stack_safety(xbt_fifo_t stack);
77 void MC_dump_stack_safety(xbt_fifo_t stack);
79 void MC_init_dot_output(void);
80 int SIMIX_pre_mc_random(smx_simcall_t simcall);
83 /********************************* Requests ***********************************/
85 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
86 char* MC_request_to_string(smx_simcall_t req, int value);
87 unsigned int MC_request_testany_fail(smx_simcall_t req);
88 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
89 int MC_request_is_visible(smx_simcall_t req);
90 int MC_request_is_enabled(smx_simcall_t req);
91 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
92 int MC_process_is_enabled(smx_process_t process);
93 char *MC_request_get_dot_output(smx_simcall_t req, int value);
96 /******************************** States **************************************/
98 /* Possible exploration status of a process in a state */
100 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
101 MC_INTERLEAVE, /* Interleave the process (one or more request) */
102 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
103 MC_DONE /* Already interleaved */
104 } e_mc_process_state_t;
106 /* On every state, each process has an entry of the following type */
107 typedef struct mc_procstate{
108 e_mc_process_state_t state; /* Exploration control information */
109 unsigned int interleave_count; /* Number of times that the process was
111 } s_mc_procstate_t, *mc_procstate_t;
113 /* An exploration state is composed of: */
114 typedef struct mc_state {
115 unsigned long max_pid; /* Maximum pid at state's creation time */
116 mc_procstate_t proc_status; /* State's exploration status by process */
117 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
118 s_smx_simcall_t internal_req; /* Internal translation of request */
119 s_smx_simcall_t executed_req; /* The executed request of the state */
120 int req_num; /* The request number (in the case of a
121 multi-request like waitany ) */
122 mc_snapshot_t system_state; /* Snapshot of system state */
124 } s_mc_state_t, *mc_state_t;
126 mc_state_t MC_state_new(void);
127 void MC_state_delete(mc_state_t state);
128 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
129 unsigned int MC_state_interleave_size(mc_state_t state);
130 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
131 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
132 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
133 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
134 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
135 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
138 /****************************** Statistics ************************************/
140 typedef struct mc_stats {
141 unsigned long state_size;
142 unsigned long visited_states;
143 unsigned long visited_pairs;
144 unsigned long expanded_states;
145 unsigned long expanded_pairs;
146 unsigned long executed_transitions;
147 } s_mc_stats_t, *mc_stats_t;
149 extern mc_stats_t mc_stats;
151 void MC_print_statistics(mc_stats_t);
154 /********************************** MEMORY ******************************/
155 /* The possible memory modes for the modelchecker are standard and raw. */
156 /* Normally the system should operate in std, for switching to raw mode */
157 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
159 extern void *std_heap;
160 extern void *raw_heap;
163 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
164 /* an API to query about the status of a heap, we simply call mmstats and */
165 /* because I now how does structure looks like, then I redefine it here */
167 /* struct mstats { */
168 /* size_t bytes_total; /\* Total size of the heap. *\/ */
169 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
170 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
171 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
172 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
175 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
176 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
179 /******************************* MEMORY MAPPINGS ***************************/
180 /* These functions and data structures implements a binary interface for */
181 /* the proc maps ascii interface */
183 /* Each field is defined as documented in proc's manual page */
184 typedef struct s_map_region {
186 void *start_addr; /* Start address of the map */
187 void *end_addr; /* End address of the map */
188 int prot; /* Memory protection */
189 int flags; /* Aditional memory flags */
190 void *offset; /* Offset in the file/whatever */
191 char dev_major; /* Major of the device */
192 char dev_minor; /* Minor of the device */
193 unsigned long inode; /* Inode in the device */
194 char *pathname; /* Path name of the mapped file */
198 typedef struct s_memory_map {
200 s_map_region_t *regions; /* Pointer to an array of regions */
201 int mapsize; /* Number of regions in the memory */
203 } s_memory_map_t, *memory_map_t;
206 void MC_init_memory_map_info(void);
207 memory_map_t get_memory_map(void);
208 void free_memory_map(memory_map_t map);
209 void get_libsimgrid_plt_section(void);
210 void get_binary_plt_section(void);
212 extern void *start_data_libsimgrid;
213 extern void *start_data_binary;
214 extern void *start_bss_binary;
215 extern char *libsimgrid_path;
216 extern void *start_text_libsimgrid;
217 extern void *start_bss_libsimgrid;
218 extern void *start_plt_libsimgrid;
219 extern void *end_plt_libsimgrid;
220 extern void *start_plt_binary;
221 extern void *end_plt_binary;
222 extern void *start_got_plt_libsimgrid;
223 extern void *end_got_plt_libsimgrid;
224 extern void *start_got_plt_binary;
225 extern void *end_got_plt_binary;
228 /********************************** Snapshot comparison **********************************/
230 typedef struct s_mc_comparison_times{
231 double nb_processes_comparison_time;
232 double bytes_used_comparison_time;
233 double stacks_sizes_comparison_time;
234 double binary_global_variables_comparison_time;
235 double libsimgrid_global_variables_comparison_time;
236 double heap_comparison_time;
237 double stacks_comparison_time;
238 double hash_global_variables_comparison_time;
239 double hash_local_variables_comparison_time;
240 }s_mc_comparison_times_t, *mc_comparison_times_t;
242 extern mc_comparison_times_t mc_comp_times;
243 extern double mc_snapshot_comparison_time;
245 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
246 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
247 void print_comparison_times(void);
253 /********************************** DPOR for safety property **************************************/
261 extern e_mc_reduce_t mc_reduce_kind;
262 extern mc_global_t initial_state_safety;
263 extern xbt_fifo_t mc_stack_safety;
265 void MC_dpor_init(void);
268 typedef struct s_mc_visited_state{
269 mc_snapshot_t system_state;
270 size_t heap_bytes_used;
273 }s_mc_visited_state_t, *mc_visited_state_t;
276 /********************************** Double-DFS for liveness property **************************************/
278 extern xbt_fifo_t mc_stack_liveness;
279 extern mc_global_t initial_state_liveness;
280 extern xbt_automaton_t _mc_property_automaton;
282 extern xbt_dynar_t mc_stack_comparison_ignore;
283 extern xbt_dynar_t mc_data_bss_comparison_ignore;
285 typedef struct s_mc_pair{
286 mc_snapshot_t system_state;
287 mc_state_t graph_state;
288 xbt_automaton_state_t automaton_state;
291 }s_mc_pair_t, *mc_pair_t;
293 typedef struct s_mc_acceptance_pair{
295 xbt_automaton_state_t automaton_state;
296 xbt_dynar_t prop_ato;
297 mc_snapshot_t system_state;
298 size_t heap_bytes_used;
300 }s_mc_acceptance_pair_t, *mc_acceptance_pair_t;
302 typedef struct s_mc_visited_pair{
303 xbt_automaton_state_t automaton_state;
304 xbt_dynar_t prop_ato;
305 mc_snapshot_t system_state;
307 size_t heap_bytes_used;
309 }s_mc_visited_pair_t, *mc_visited_pair_t;
311 mc_pair_t MC_pair_new(mc_state_t sg, xbt_automaton_state_t st, int r);
312 void MC_pair_delete(mc_pair_t);
314 void MC_ddfs_init(void);
315 void MC_ddfs(int search_cycle);
316 void MC_show_stack_liveness(xbt_fifo_t stack);
317 void MC_dump_stack_liveness(xbt_fifo_t stack);
320 /********************************** Local variables with DWARF **********************************/
336 } e_dw_location_type;
338 typedef struct s_dw_location{
339 e_dw_location_type type;
357 unsigned short int deref_size;
365 long unsigned int value;
370 long signed int value;
373 unsigned int plus_uconst;
376 }s_dw_location_t, *dw_location_t;
378 typedef struct s_dw_location_entry{
381 dw_location_t location;
382 }s_dw_location_entry_t, *dw_location_entry_t;
384 typedef struct s_dw_local_variable{
386 dw_location_t location;
387 }s_dw_local_variable_t, *dw_local_variable_t;
389 typedef struct s_dw_frame{
393 dw_location_t frame_base;
394 xbt_dict_t variables;
395 unsigned long int start;
396 unsigned long int end;
397 }s_dw_frame_t, *dw_frame_t;
399 /* FIXME : implement free functions for each structure */
401 extern xbt_dict_t mc_local_variables;
403 typedef struct s_variable_value{
410 }s_variable_value_t, *variable_value_t;
412 void variable_value_free_voidp(void* v);
413 void variable_value_free(variable_value_t v);
415 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
416 void print_local_variables(xbt_dict_t list);
417 xbt_dict_t MC_get_location_list(const char *elf_file);
420 /********************************** Global variables with objdump **********************************/
422 typedef struct s_global_variable{
426 }s_global_variable_t, *global_variable_t;
428 void global_variable_free(global_variable_t v);
429 void global_variable_free_voidp(void *v);
431 extern xbt_dynar_t mc_global_variables;