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 MC_take_snapshot(void);
52 void MC_restore_snapshot(mc_snapshot_t);
53 void MC_free_snapshot(mc_snapshot_t);
54 void snapshot_stack_free_voidp(void *s);
56 /********************************* MC Global **********************************/
57 extern double *mc_time;
59 int MC_deadlock_check(void);
60 void MC_replay(xbt_fifo_t stack, int start);
61 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
62 void MC_wait_for_requests(void);
63 void MC_get_enabled_processes();
64 void MC_show_deadlock(smx_simcall_t req);
65 void MC_show_stack_safety(xbt_fifo_t stack);
66 void MC_dump_stack_safety(xbt_fifo_t stack);
68 /********************************* Requests ***********************************/
69 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
70 char* MC_request_to_string(smx_simcall_t req, int value);
71 unsigned int MC_request_testany_fail(smx_simcall_t req);
72 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
73 int MC_request_is_visible(smx_simcall_t req);
74 int MC_request_is_enabled(smx_simcall_t req);
75 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
76 int MC_process_is_enabled(smx_process_t process);
79 /******************************** States **************************************/
80 /* Possible exploration status of a process in a state */
82 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
83 MC_INTERLEAVE, /* Interleave the process (one or more request) */
84 MC_DONE /* Already interleaved */
85 } e_mc_process_state_t;
87 /* On every state, each process has an entry of the following type */
88 typedef struct mc_procstate{
89 e_mc_process_state_t state; /* Exploration control information */
90 unsigned int interleave_count; /* Number of times that the process was
92 } s_mc_procstate_t, *mc_procstate_t;
94 /* An exploration state is composed of: */
95 typedef struct mc_state {
96 unsigned long max_pid; /* Maximum pid at state's creation time */
97 mc_procstate_t proc_status; /* State's exploration status by process */
98 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
99 s_smx_simcall_t internal_req; /* Internal translation of request */
100 s_smx_simcall_t executed_req; /* The executed request of the state */
101 int req_num; /* The request number (in the case of a
102 multi-request like waitany ) */
103 mc_snapshot_t system_state; /* Snapshot of system state */
104 } s_mc_state_t, *mc_state_t;
106 extern xbt_fifo_t mc_stack_safety_stateless;
108 mc_state_t MC_state_new(void);
109 void MC_state_delete(mc_state_t state);
110 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
111 unsigned int MC_state_interleave_size(mc_state_t state);
112 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
113 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
114 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
115 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
116 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
118 /****************************** Statistics ************************************/
119 typedef struct mc_stats {
120 unsigned long state_size;
121 unsigned long visited_states;
122 unsigned long expanded_states;
123 unsigned long executed_transitions;
124 } s_mc_stats_t, *mc_stats_t;
126 typedef struct mc_stats_pair {
127 //unsigned long pair_size;
128 unsigned long visited_pairs;
129 unsigned long expanded_pairs;
130 unsigned long executed_transitions;
131 } s_mc_stats_pair_t, *mc_stats_pair_t;
133 extern mc_stats_t mc_stats;
134 extern mc_stats_pair_t mc_stats_pair;
136 void MC_print_statistics(mc_stats_t);
137 void MC_print_statistics_pairs(mc_stats_pair_t);
139 /********************************** MEMORY ******************************/
140 /* The possible memory modes for the modelchecker are standard and raw. */
141 /* Normally the system should operate in std, for switching to raw mode */
142 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
144 extern void *std_heap;
145 extern void *raw_heap;
148 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
149 /* an API to query about the status of a heap, we simply call mmstats and */
150 /* because I now how does structure looks like, then I redefine it here */
152 /* struct mstats { */
153 /* size_t bytes_total; /\* Total size of the heap. *\/ */
154 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
155 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
156 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
157 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
160 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
161 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
163 /******************************* MEMORY MAPPINGS ***************************/
164 /* These functions and data structures implements a binary interface for */
165 /* the proc maps ascii interface */
167 /* Each field is defined as documented in proc's manual page */
168 typedef struct s_map_region {
170 void *start_addr; /* Start address of the map */
171 void *end_addr; /* End address of the map */
172 int prot; /* Memory protection */
173 int flags; /* Aditional memory flags */
174 void *offset; /* Offset in the file/whatever */
175 char dev_major; /* Major of the device */
176 char dev_minor; /* Minor of the device */
177 unsigned long inode; /* Inode in the device */
178 char *pathname; /* Path name of the mapped file */
182 typedef struct s_memory_map {
184 s_map_region_t *regions; /* Pointer to an array of regions */
185 int mapsize; /* Number of regions in the memory */
187 } s_memory_map_t, *memory_map_t;
189 memory_map_t get_memory_map(void);
190 void free_memory_map(memory_map_t map);
191 void get_libsimgrid_plt_section(void);
192 void get_binary_plt_section(void);
194 extern void *start_data_libsimgrid;
195 extern void *end_raw_heap;
197 /********************************** DPOR for safety **************************************/
204 extern e_mc_reduce_t mc_reduce_kind;
205 extern mc_global_t initial_state_safety;
207 void MC_dpor_init(void);
209 void MC_dpor_exit(void);
213 /********************************** Double-DFS for liveness property**************************************/
215 extern xbt_fifo_t mc_stack_liveness;
216 extern mc_global_t initial_state_liveness;
217 extern xbt_automaton_t _mc_property_automaton;
219 extern void *start_plt_libsimgrid;
220 extern void *end_plt_libsimgrid;
221 extern void *start_plt_binary;
222 extern void *end_plt_binary;
223 extern xbt_dynar_t mc_stack_comparison_ignore;
224 extern xbt_dynar_t mc_data_bss_comparison_ignore;
225 extern void *start_bss_libsimgrid;
227 typedef struct s_mc_pair{
228 mc_snapshot_t system_state;
229 mc_state_t graph_state;
230 xbt_state_t automaton_state;
231 }s_mc_pair_t, *mc_pair_t;
233 typedef struct s_mc_comparison_times{
235 xbt_dynar_t snapshot_comparison_times;
236 xbt_dynar_t chunks_used_comparison_times;
237 xbt_dynar_t stacks_sizes_comparison_times;
238 xbt_dynar_t program_data_segment_comparison_times;
239 xbt_dynar_t libsimgrid_data_segment_comparison_times;
240 xbt_dynar_t heap_comparison_times;
241 xbt_dynar_t stacks_comparison_times;
242 }s_mc_comparison_times_t, *mc_comparison_times_t;
244 typedef struct s_mc_pair_reached{
246 xbt_state_t automaton_state;
247 xbt_dynar_t prop_ato;
248 mc_snapshot_t system_state;
249 mc_comparison_times_t comparison_times;
250 }s_mc_pair_reached_t, *mc_pair_reached_t;
252 typedef struct s_mc_pair_visited{
253 xbt_state_t automaton_state;
254 xbt_dynar_t prop_ato;
255 mc_snapshot_t system_state;
256 }s_mc_pair_visited_t, *mc_pair_visited_t;
258 int MC_automaton_evaluate_label(xbt_exp_label_t l);
259 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
260 mc_comparison_times_t new_comparison_times(void);
262 int reached(xbt_state_t st);
263 void set_pair_reached(xbt_state_t st);
264 int visited(xbt_state_t st);
265 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2, mc_comparison_times_t ct1, mc_comparison_times_t ct2);
266 void MC_pair_delete(mc_pair_t pair);
267 void MC_exit_liveness(void);
268 mc_state_t MC_state_pair_new(void);
269 void pair_reached_free(mc_pair_reached_t pair);
270 void pair_reached_free_voidp(void *p);
271 void pair_visited_free(mc_pair_visited_t pair);
272 void pair_visited_free_voidp(void *p);
273 void MC_init_liveness(void);
274 void MC_init_memory_map_info(void);
275 void MC_print_comparison_times_statistics(mc_comparison_times_t ct);
277 /* **** Double-DFS stateless **** */
279 typedef struct s_mc_pair_stateless{
280 mc_state_t graph_state;
281 xbt_state_t automaton_state;
283 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
285 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
286 void MC_ddfs_init(void);
287 void MC_ddfs(int search_cycle);
288 void MC_show_stack_liveness(xbt_fifo_t stack);
289 void MC_dump_stack_liveness(xbt_fifo_t stack);
290 void pair_stateless_free(mc_pair_stateless_t pair);
291 void pair_stateless_free_voidp(void *p);
293 /********************************** Configuration of MC **************************************/
294 extern xbt_fifo_t mc_stack_safety;
296 extern int _surf_mc_checkpoint;
297 extern char* _surf_mc_property_file;
298 extern int _surf_mc_timeout;
299 extern int _surf_mc_max_depth;
300 extern int _surf_mc_stateful;
302 /****** Core dump ******/
304 int create_dump(int pair);
306 /****** Local variables with DWARF ******/
322 } e_dw_location_type;
324 typedef struct s_dw_location{
325 e_dw_location_type type;
343 unsigned short int deref_size;
351 long unsigned int value;
356 long signed int value;
359 unsigned int plus_uconst;
362 }s_dw_location_t, *dw_location_t;
364 typedef struct s_dw_location_entry{
367 dw_location_t location;
368 }s_dw_location_entry_t, *dw_location_entry_t;
370 typedef struct s_dw_local_variable{
372 dw_location_t location;
373 }s_dw_local_variable_t, *dw_local_variable_t;
375 typedef struct s_dw_frame{
379 dw_location_t frame_base;
380 xbt_dict_t variables;
381 unsigned long int start;
382 unsigned long int end;
383 }s_dw_frame_t, *dw_frame_t;
385 /* FIXME : implement free functions for each structure */
387 extern xbt_dict_t mc_local_variables;
389 typedef struct s_variable_value{
396 }s_variable_value_t, *variable_value_t;
398 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
399 void print_local_variables(xbt_dict_t list);
400 char *get_libsimgrid_path(void);
401 xbt_dict_t MC_get_location_list(const char *elf_file);