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 typedef struct s_mc_mem_region{
32 } s_mc_mem_region_t, *mc_mem_region_t;
34 typedef struct s_mc_snapshot{
36 mc_mem_region_t *regions;
38 } s_mc_snapshot_t, *mc_snapshot_t;
40 typedef struct s_mc_snapshot_stack{
41 xbt_strbuff_t local_variables;
43 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
45 typedef struct s_mc_global_t{
46 mc_snapshot_t snapshot;
48 }s_mc_global_t, *mc_global_t;
50 //void MC_take_snapshot(mc_snapshot_t);
51 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
52 mc_snapshot_t MC_take_snapshot(void);
53 void MC_restore_snapshot(mc_snapshot_t);
54 void MC_free_snapshot(mc_snapshot_t);
55 void snapshot_stack_free_voidp(void *s);
57 /********************************* MC Global **********************************/
58 extern double *mc_time;
60 int MC_deadlock_check(void);
61 void MC_replay(xbt_fifo_t stack, int start);
62 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
63 void MC_wait_for_requests(void);
64 void MC_get_enabled_processes();
65 void MC_show_deadlock(smx_simcall_t req);
66 void MC_show_stack_safety(xbt_fifo_t stack);
67 void MC_dump_stack_safety(xbt_fifo_t stack);
69 /********************************* Requests ***********************************/
70 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
71 char* MC_request_to_string(smx_simcall_t req, int value);
72 unsigned int MC_request_testany_fail(smx_simcall_t req);
73 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
74 int MC_request_is_visible(smx_simcall_t req);
75 int MC_request_is_enabled(smx_simcall_t req);
76 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
77 int MC_process_is_enabled(smx_process_t process);
80 /******************************** States **************************************/
81 /* Possible exploration status of a process in a state */
83 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
84 MC_INTERLEAVE, /* Interleave the process (one or more request) */
85 MC_DONE /* Already interleaved */
86 } e_mc_process_state_t;
88 /* On every state, each process has an entry of the following type */
89 typedef struct mc_procstate{
90 e_mc_process_state_t state; /* Exploration control information */
91 unsigned int interleave_count; /* Number of times that the process was
93 } s_mc_procstate_t, *mc_procstate_t;
95 /* An exploration state is composed of: */
96 typedef struct mc_state {
97 unsigned long max_pid; /* Maximum pid at state's creation time */
98 mc_procstate_t proc_status; /* State's exploration status by process */
99 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
100 s_smx_simcall_t internal_req; /* Internal translation of request */
101 s_smx_simcall_t executed_req; /* The executed request of the state */
102 int req_num; /* The request number (in the case of a
103 multi-request like waitany ) */
104 mc_snapshot_t system_state; /* Snapshot of system state */
105 } s_mc_state_t, *mc_state_t;
107 extern xbt_fifo_t mc_stack_safety_stateless;
109 mc_state_t MC_state_new(void);
110 void MC_state_delete(mc_state_t state);
111 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
112 unsigned int MC_state_interleave_size(mc_state_t state);
113 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
114 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
115 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
116 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
117 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
118 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
120 /****************************** Statistics ************************************/
121 typedef struct mc_stats {
122 unsigned long state_size;
123 unsigned long visited_states;
124 unsigned long expanded_states;
125 unsigned long executed_transitions;
126 } s_mc_stats_t, *mc_stats_t;
128 typedef struct mc_stats_pair {
129 //unsigned long pair_size;
130 unsigned long visited_pairs;
131 unsigned long expanded_pairs;
132 unsigned long executed_transitions;
133 } s_mc_stats_pair_t, *mc_stats_pair_t;
135 extern mc_stats_t mc_stats;
136 extern mc_stats_pair_t mc_stats_pair;
138 void MC_print_statistics(mc_stats_t);
139 void MC_print_statistics_pairs(mc_stats_pair_t);
141 /********************************** MEMORY ******************************/
142 /* The possible memory modes for the modelchecker are standard and raw. */
143 /* Normally the system should operate in std, for switching to raw mode */
144 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
146 extern void *std_heap;
147 extern void *raw_heap;
150 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
151 /* an API to query about the status of a heap, we simply call mmstats and */
152 /* because I now how does structure looks like, then I redefine it here */
154 /* struct mstats { */
155 /* size_t bytes_total; /\* Total size of the heap. *\/ */
156 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
157 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
158 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
159 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
162 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
163 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
165 /******************************* MEMORY MAPPINGS ***************************/
166 /* These functions and data structures implements a binary interface for */
167 /* the proc maps ascii interface */
169 /* Each field is defined as documented in proc's manual page */
170 typedef struct s_map_region {
172 void *start_addr; /* Start address of the map */
173 void *end_addr; /* End address of the map */
174 int prot; /* Memory protection */
175 int flags; /* Aditional memory flags */
176 void *offset; /* Offset in the file/whatever */
177 char dev_major; /* Major of the device */
178 char dev_minor; /* Minor of the device */
179 unsigned long inode; /* Inode in the device */
180 char *pathname; /* Path name of the mapped file */
184 typedef struct s_memory_map {
186 s_map_region_t *regions; /* Pointer to an array of regions */
187 int mapsize; /* Number of regions in the memory */
189 } s_memory_map_t, *memory_map_t;
191 memory_map_t get_memory_map(void);
192 void free_memory_map(memory_map_t map);
193 void get_libsimgrid_plt_section(void);
194 void get_binary_plt_section(void);
196 extern void *start_data_libsimgrid;
197 extern void *end_raw_heap;
198 extern void *start_data_binary;
199 extern void *start_bss_binary;
200 extern char *libsimgrid_path;
201 extern void *start_text_libsimgrid;
202 extern void *start_bss_libsimgrid;
203 extern void *start_plt_libsimgrid;
204 extern void *end_plt_libsimgrid;
205 extern void *start_plt_binary;
206 extern void *end_plt_binary;
209 /********************************** DPOR for safety **************************************/
216 extern e_mc_reduce_t mc_reduce_kind;
217 extern mc_global_t initial_state_safety;
219 void MC_dpor_init(void);
221 void MC_dpor_exit(void);
225 /********************************** Double-DFS for liveness property**************************************/
227 extern xbt_fifo_t mc_stack_liveness;
228 extern mc_global_t initial_state_liveness;
229 extern xbt_automaton_t _mc_property_automaton;
231 extern xbt_dynar_t mc_stack_comparison_ignore;
232 extern xbt_dynar_t mc_data_bss_comparison_ignore;
235 typedef struct s_mc_pair{
236 mc_snapshot_t system_state;
237 mc_state_t graph_state;
238 xbt_state_t automaton_state;
239 }s_mc_pair_t, *mc_pair_t;
241 typedef struct s_mc_comparison_times{
243 xbt_dynar_t snapshot_comparison_times;
244 xbt_dynar_t chunks_used_comparison_times;
245 xbt_dynar_t stacks_sizes_comparison_times;
246 xbt_dynar_t program_data_segment_comparison_times;
247 xbt_dynar_t libsimgrid_data_segment_comparison_times;
248 xbt_dynar_t heap_comparison_times;
249 xbt_dynar_t stacks_comparison_times;
250 }s_mc_comparison_times_t, *mc_comparison_times_t;
252 typedef struct s_mc_pair_reached{
254 xbt_state_t automaton_state;
255 xbt_dynar_t prop_ato;
256 mc_snapshot_t system_state;
257 mc_comparison_times_t comparison_times;
258 }s_mc_pair_reached_t, *mc_pair_reached_t;
260 typedef struct s_mc_pair_visited{
261 xbt_state_t automaton_state;
262 xbt_dynar_t prop_ato;
263 mc_snapshot_t system_state;
264 }s_mc_pair_visited_t, *mc_pair_visited_t;
266 int MC_automaton_evaluate_label(xbt_exp_label_t l);
267 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
268 mc_comparison_times_t new_comparison_times(void);
270 int reached(xbt_state_t st);
271 void set_pair_reached(xbt_state_t st);
272 int visited(xbt_state_t st);
273 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
274 mc_snapshot_t s1, mc_snapshot_t s2);
275 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2, mc_comparison_times_t ct1, mc_comparison_times_t ct2);
276 void MC_pair_delete(mc_pair_t pair);
277 void MC_exit_liveness(void);
278 mc_state_t MC_state_pair_new(void);
279 void pair_reached_free(mc_pair_reached_t pair);
280 void pair_reached_free_voidp(void *p);
281 void pair_visited_free(mc_pair_visited_t pair);
282 void pair_visited_free_voidp(void *p);
283 void MC_init_liveness(void);
284 void MC_init_memory_map_info(void);
285 void MC_print_comparison_times_statistics(mc_comparison_times_t ct);
287 /* **** Double-DFS stateless **** */
289 typedef struct s_mc_pair_stateless{
290 mc_state_t graph_state;
291 xbt_state_t automaton_state;
293 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
295 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
296 void MC_ddfs_init(void);
297 void MC_ddfs(int search_cycle);
298 void MC_show_stack_liveness(xbt_fifo_t stack);
299 void MC_dump_stack_liveness(xbt_fifo_t stack);
300 void pair_stateless_free(mc_pair_stateless_t pair);
301 void pair_stateless_free_voidp(void *p);
303 /********************************** Configuration of MC **************************************/
304 extern xbt_fifo_t mc_stack_safety;
306 extern int _surf_mc_checkpoint;
307 extern char* _surf_mc_property_file;
308 extern int _surf_mc_timeout;
309 extern int _surf_mc_max_depth;
310 extern int _surf_mc_visited;
312 /****** Core dump ******/
314 int create_dump(int pair);
316 /****** Local variables with DWARF ******/
332 } e_dw_location_type;
334 typedef struct s_dw_location{
335 e_dw_location_type type;
353 unsigned short int deref_size;
361 long unsigned int value;
366 long signed int value;
369 unsigned int plus_uconst;
372 }s_dw_location_t, *dw_location_t;
374 typedef struct s_dw_location_entry{
377 dw_location_t location;
378 }s_dw_location_entry_t, *dw_location_entry_t;
380 typedef struct s_dw_local_variable{
382 dw_location_t location;
383 }s_dw_local_variable_t, *dw_local_variable_t;
385 typedef struct s_dw_frame{
389 dw_location_t frame_base;
390 xbt_dict_t variables;
391 unsigned long int start;
392 unsigned long int end;
393 }s_dw_frame_t, *dw_frame_t;
395 /* FIXME : implement free functions for each structure */
397 extern xbt_dict_t mc_local_variables;
399 typedef struct s_variable_value{
406 }s_variable_value_t, *variable_value_t;
408 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
409 void print_local_variables(xbt_dict_t list);
410 char *get_libsimgrid_path(void);
411 xbt_dict_t MC_get_location_list(const char *elf_file);