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;
58 }s_mc_global_t, *mc_global_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);
65 int is_stack_ignore_variable(char *frame, char *var_name);
67 /********************************* MC Global **********************************/
69 extern double *mc_time;
70 extern FILE *dot_output;
71 extern const char* colors[10];
73 int MC_deadlock_check(void);
74 void MC_replay(xbt_fifo_t stack, int start);
75 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
76 void MC_wait_for_requests(void);
77 void MC_show_deadlock(smx_simcall_t req);
78 void MC_show_stack_safety(xbt_fifo_t stack);
79 void MC_dump_stack_safety(xbt_fifo_t stack);
81 void MC_init_dot_output(void);
82 int SIMIX_pre_mc_random(smx_simcall_t simcall);
85 /********************************* Requests ***********************************/
87 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
88 char* MC_request_to_string(smx_simcall_t req, int value);
89 unsigned int MC_request_testany_fail(smx_simcall_t req);
90 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
91 int MC_request_is_visible(smx_simcall_t req);
92 int MC_request_is_enabled(smx_simcall_t req);
93 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
94 int MC_process_is_enabled(smx_process_t process);
95 char *MC_request_get_dot_output(smx_simcall_t req, int value);
98 /******************************** States **************************************/
100 /* Possible exploration status of a process in a state */
102 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
103 MC_INTERLEAVE, /* Interleave the process (one or more request) */
104 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
105 MC_DONE /* Already interleaved */
106 } e_mc_process_state_t;
108 /* On every state, each process has an entry of the following type */
109 typedef struct mc_procstate{
110 e_mc_process_state_t state; /* Exploration control information */
111 unsigned int interleave_count; /* Number of times that the process was
113 } s_mc_procstate_t, *mc_procstate_t;
115 /* An exploration state is composed of: */
116 typedef struct mc_state {
117 unsigned long max_pid; /* Maximum pid at state's creation time */
118 mc_procstate_t proc_status; /* State's exploration status by process */
119 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
120 s_smx_simcall_t internal_req; /* Internal translation of request */
121 s_smx_simcall_t executed_req; /* The executed request of the state */
122 int req_num; /* The request number (in the case of a
123 multi-request like waitany ) */
124 mc_snapshot_t system_state; /* Snapshot of system state */
126 } s_mc_state_t, *mc_state_t;
128 mc_state_t MC_state_new(void);
129 void MC_state_delete(mc_state_t state);
130 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
131 unsigned int MC_state_interleave_size(mc_state_t state);
132 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
133 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
134 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
135 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
136 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
137 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
140 /****************************** Statistics ************************************/
142 typedef struct mc_stats {
143 unsigned long state_size;
144 unsigned long visited_states;
145 unsigned long visited_pairs;
146 unsigned long expanded_states;
147 unsigned long expanded_pairs;
148 unsigned long executed_transitions;
149 } s_mc_stats_t, *mc_stats_t;
151 extern mc_stats_t mc_stats;
153 void MC_print_statistics(mc_stats_t);
156 /********************************** MEMORY ******************************/
157 /* The possible memory modes for the modelchecker are standard and raw. */
158 /* Normally the system should operate in std, for switching to raw mode */
159 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
161 extern void *std_heap;
162 extern void *raw_heap;
165 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
166 /* an API to query about the status of a heap, we simply call mmstats and */
167 /* because I now how does structure looks like, then I redefine it here */
169 /* struct mstats { */
170 /* size_t bytes_total; /\* Total size of the heap. *\/ */
171 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
172 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
173 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
174 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
177 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
178 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
181 /******************************* MEMORY MAPPINGS ***************************/
182 /* These functions and data structures implements a binary interface for */
183 /* the proc maps ascii interface */
185 /* Each field is defined as documented in proc's manual page */
186 typedef struct s_map_region {
188 void *start_addr; /* Start address of the map */
189 void *end_addr; /* End address of the map */
190 int prot; /* Memory protection */
191 int flags; /* Aditional memory flags */
192 void *offset; /* Offset in the file/whatever */
193 char dev_major; /* Major of the device */
194 char dev_minor; /* Minor of the device */
195 unsigned long inode; /* Inode in the device */
196 char *pathname; /* Path name of the mapped file */
200 typedef struct s_memory_map {
202 s_map_region_t *regions; /* Pointer to an array of regions */
203 int mapsize; /* Number of regions in the memory */
205 } s_memory_map_t, *memory_map_t;
208 void MC_init_memory_map_info(void);
209 memory_map_t get_memory_map(void);
210 void free_memory_map(memory_map_t map);
211 void get_libsimgrid_plt_section(void);
212 void get_binary_plt_section(void);
214 extern void *start_data_libsimgrid;
215 extern void *start_data_binary;
216 extern void *start_bss_binary;
217 extern char *libsimgrid_path;
218 extern void *start_text_libsimgrid;
219 extern void *start_bss_libsimgrid;
220 extern void *start_plt_libsimgrid;
221 extern void *end_plt_libsimgrid;
222 extern void *start_plt_binary;
223 extern void *end_plt_binary;
224 extern void *start_got_plt_libsimgrid;
225 extern void *end_got_plt_libsimgrid;
226 extern void *start_got_plt_binary;
227 extern void *end_got_plt_binary;
230 /********************************** Snapshot comparison **********************************/
232 typedef struct s_mc_comparison_times{
233 double nb_processes_comparison_time;
234 double bytes_used_comparison_time;
235 double stacks_sizes_comparison_time;
236 double binary_global_variables_comparison_time;
237 double libsimgrid_global_variables_comparison_time;
238 double heap_comparison_time;
239 double stacks_comparison_time;
240 double hash_global_variables_comparison_time;
241 double hash_local_variables_comparison_time;
242 }s_mc_comparison_times_t, *mc_comparison_times_t;
244 extern mc_comparison_times_t mc_comp_times;
245 extern double mc_snapshot_comparison_time;
247 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
248 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
249 void print_comparison_times(void);
255 /********************************** DPOR for safety property **************************************/
263 extern e_mc_reduce_t mc_reduce_kind;
264 extern mc_global_t initial_state_safety;
265 extern xbt_fifo_t mc_stack_safety;
266 extern xbt_dict_t first_enabled_state;
268 void MC_dpor_init(void);
271 typedef struct s_mc_visited_state{
272 mc_snapshot_t system_state;
273 size_t heap_bytes_used;
276 }s_mc_visited_state_t, *mc_visited_state_t;
279 /********************************** Double-DFS for liveness property **************************************/
281 extern xbt_fifo_t mc_stack_liveness;
282 extern mc_global_t initial_state_liveness;
283 extern xbt_automaton_t _mc_property_automaton;
285 extern xbt_dynar_t mc_stack_comparison_ignore;
286 extern xbt_dynar_t mc_data_bss_comparison_ignore;
288 typedef struct s_mc_pair{
291 mc_state_t graph_state; /* System state included */
292 xbt_automaton_state_t automaton_state;
293 xbt_dynar_t atomic_propositions;
295 size_t heap_bytes_used;
299 int acceptance_removed;
300 }s_mc_pair_t, *mc_pair_t;
302 mc_pair_t MC_pair_new(void);
303 void MC_pair_delete(mc_pair_t);
305 void MC_ddfs_init(void);
307 void MC_show_stack_liveness(xbt_fifo_t stack);
308 void MC_dump_stack_liveness(xbt_fifo_t stack);
311 /********************************** Local variables with DWARF **********************************/
327 } e_dw_location_type;
329 typedef struct s_dw_location{
330 e_dw_location_type type;
348 unsigned short int deref_size;
356 long unsigned int value;
361 long signed int value;
364 unsigned int plus_uconst;
367 }s_dw_location_t, *dw_location_t;
369 typedef struct s_dw_location_entry{
372 dw_location_t location;
373 }s_dw_location_entry_t, *dw_location_entry_t;
375 typedef struct s_dw_local_variable{
377 dw_location_t location;
378 }s_dw_local_variable_t, *dw_local_variable_t;
380 typedef struct s_dw_frame{
384 dw_location_t frame_base;
385 xbt_dict_t variables;
386 unsigned long int start;
387 unsigned long int end;
388 }s_dw_frame_t, *dw_frame_t;
390 /* FIXME : implement free functions for each structure */
392 extern xbt_dict_t mc_local_variables;
394 typedef struct s_variable_value{
401 }s_variable_value_t, *variable_value_t;
403 void variable_value_free_voidp(void* v);
404 void variable_value_free(variable_value_t v);
406 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
407 void print_local_variables(xbt_dict_t list);
408 xbt_dict_t MC_get_location_list(const char *elf_file);
411 /********************************** Global variables with objdump **********************************/
413 typedef struct s_global_variable{
417 }s_global_variable_t, *global_variable_t;
419 void global_variable_free(global_variable_t v);
420 void global_variable_free_voidp(void *v);
422 extern xbt_dynar_t mc_global_variables;