1 /* Copyright (c) 2007-2013. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "simgrid_config.h"
16 #include "mc/datatypes.h"
18 #include "xbt/config.h"
19 #include "xbt/function_types.h"
20 #include "xbt/mmalloc.h"
21 #include "../simix/smx_private.h"
22 #include "xbt/automaton.h"
25 #include "msg/datatypes.h"
26 #include "xbt/strbuff.h"
27 #include "xbt/parmap.h"
29 /****************************** Snapshots ***********************************/
31 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
33 typedef struct s_mc_mem_region{
37 } s_mc_mem_region_t, *mc_mem_region_t;
39 typedef struct s_mc_snapshot{
40 size_t heap_bytes_used;
41 mc_mem_region_t regions[NB_REGIONS];
45 xbt_dynar_t to_ignore;
48 } s_mc_snapshot_t, *mc_snapshot_t;
50 typedef struct s_mc_snapshot_stack{
51 xbt_dynar_t local_variables;
54 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
56 typedef struct s_mc_global_t{
57 mc_snapshot_t snapshot;
61 int initial_communications_pattern_done;
62 int comm_deterministic;
63 int send_deterministic;
64 }s_mc_global_t, *mc_global_t;
66 typedef struct s_mc_checkpoint_ignore_region{
69 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
71 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
72 mc_snapshot_t MC_take_snapshot(int num_state);
73 void MC_restore_snapshot(mc_snapshot_t);
74 void MC_free_snapshot(mc_snapshot_t);
76 extern xbt_dynar_t mc_checkpoint_ignore;
78 /********************************* MC Global **********************************/
80 extern double *mc_time;
81 extern FILE *dot_output;
82 extern const char* colors[13];
83 extern xbt_parmap_t parmap;
85 extern int user_max_depth_reached;
87 int MC_deadlock_check(void);
88 void MC_replay(xbt_fifo_t stack, int start);
89 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
90 void MC_wait_for_requests(void);
91 void MC_show_deadlock(smx_simcall_t req);
92 void MC_show_stack_safety(xbt_fifo_t stack);
93 void MC_dump_stack_safety(xbt_fifo_t stack);
95 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
98 /********************************* Requests ***********************************/
100 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
101 char* MC_request_to_string(smx_simcall_t req, int value);
102 unsigned int MC_request_testany_fail(smx_simcall_t req);
103 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
104 int MC_request_is_visible(smx_simcall_t req);
105 int MC_request_is_enabled(smx_simcall_t req);
106 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
107 int MC_process_is_enabled(smx_process_t process);
108 char *MC_request_get_dot_output(smx_simcall_t req, int value);
111 /******************************** States **************************************/
113 /* Possible exploration status of a process in a state */
115 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
116 MC_INTERLEAVE, /* Interleave the process (one or more request) */
117 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
118 MC_DONE /* Already interleaved */
119 } e_mc_process_state_t;
121 /* On every state, each process has an entry of the following type */
122 typedef struct mc_procstate{
123 e_mc_process_state_t state; /* Exploration control information */
124 unsigned int interleave_count; /* Number of times that the process was
126 } s_mc_procstate_t, *mc_procstate_t;
128 /* An exploration state is composed of: */
129 typedef struct mc_state {
130 unsigned long max_pid; /* Maximum pid at state's creation time */
131 mc_procstate_t proc_status; /* State's exploration status by process */
132 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
133 s_smx_simcall_t internal_req; /* Internal translation of request */
134 s_smx_simcall_t executed_req; /* The executed request of the state */
135 int req_num; /* The request number (in the case of a
136 multi-request like waitany ) */
137 mc_snapshot_t system_state; /* Snapshot of system state */
139 } s_mc_state_t, *mc_state_t;
141 mc_state_t MC_state_new(void);
142 void MC_state_delete(mc_state_t state);
143 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
144 unsigned int MC_state_interleave_size(mc_state_t state);
145 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
146 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
147 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
148 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
149 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
150 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
153 /****************************** Statistics ************************************/
155 typedef struct mc_stats {
156 unsigned long state_size;
157 unsigned long visited_states;
158 unsigned long visited_pairs;
159 unsigned long expanded_states;
160 unsigned long expanded_pairs;
161 unsigned long executed_transitions;
162 } s_mc_stats_t, *mc_stats_t;
164 extern mc_stats_t mc_stats;
166 void MC_print_statistics(mc_stats_t);
169 /********************************** MEMORY ******************************/
170 /* The possible memory modes for the modelchecker are standard and raw. */
171 /* Normally the system should operate in std, for switching to raw mode */
172 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
174 extern void *std_heap;
175 extern void *raw_heap;
178 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
179 /* an API to query about the status of a heap, we simply call mmstats and */
180 /* because I now how does structure looks like, then I redefine it here */
182 /* struct mstats { */
183 /* size_t bytes_total; /\* Total size of the heap. *\/ */
184 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
185 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
186 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
187 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
190 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
191 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
194 /******************************* MEMORY MAPPINGS ***************************/
195 /* These functions and data structures implements a binary interface for */
196 /* the proc maps ascii interface */
198 /* Each field is defined as documented in proc's manual page */
199 typedef struct s_map_region {
201 void *start_addr; /* Start address of the map */
202 void *end_addr; /* End address of the map */
203 int prot; /* Memory protection */
204 int flags; /* Additional memory flags */
205 void *offset; /* Offset in the file/whatever */
206 char dev_major; /* Major of the device */
207 char dev_minor; /* Minor of the device */
208 unsigned long inode; /* Inode in the device */
209 char *pathname; /* Path name of the mapped file */
213 typedef struct s_memory_map {
215 s_map_region_t *regions; /* Pointer to an array of regions */
216 int mapsize; /* Number of regions in the memory */
218 } s_memory_map_t, *memory_map_t;
221 void MC_init_memory_map_info(void);
222 memory_map_t MC_get_memory_map(void);
223 void MC_free_memory_map(memory_map_t map);
224 void MC_get_libsimgrid_plt_section(void);
225 void MC_get_binary_plt_section(void);
227 extern void *start_data_libsimgrid;
228 extern void *start_data_binary;
229 extern void *start_bss_binary;
230 extern char *libsimgrid_path;
231 extern void *start_text_libsimgrid;
232 extern void *start_text_binary;
233 extern void *start_bss_libsimgrid;
234 extern void *start_plt_libsimgrid;
235 extern void *end_plt_libsimgrid;
236 extern void *start_plt_binary;
237 extern void *end_plt_binary;
238 extern void *start_got_plt_libsimgrid;
239 extern void *end_got_plt_libsimgrid;
240 extern void *start_got_plt_binary;
241 extern void *end_got_plt_binary;
244 /********************************** Snapshot comparison **********************************/
246 typedef struct s_mc_comparison_times{
247 double nb_processes_comparison_time;
248 double bytes_used_comparison_time;
249 double stacks_sizes_comparison_time;
250 double binary_global_variables_comparison_time;
251 double libsimgrid_global_variables_comparison_time;
252 double heap_comparison_time;
253 double stacks_comparison_time;
254 double hash_global_variables_comparison_time;
255 double hash_local_variables_comparison_time;
256 }s_mc_comparison_times_t, *mc_comparison_times_t;
258 extern __thread mc_comparison_times_t mc_comp_times;
259 extern __thread double mc_snapshot_comparison_time;
261 int snapshot_compare(void *state1, void *state2);
262 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
263 void print_comparison_times(void);
269 /********************************** DPOR for safety property **************************************/
277 extern e_mc_reduce_t mc_reduce_kind;
278 extern mc_global_t initial_state_safety;
279 extern xbt_fifo_t mc_stack_safety;
280 extern xbt_dict_t first_enabled_state;
282 void MC_dpor_init(void);
285 typedef struct s_mc_visited_state{
286 mc_snapshot_t system_state;
287 size_t heap_bytes_used;
290 int other_num; // dot_output for
291 }s_mc_visited_state_t, *mc_visited_state_t;
294 /********************************** Double-DFS for liveness property **************************************/
296 extern xbt_fifo_t mc_stack_liveness;
297 extern mc_global_t initial_state_liveness;
298 extern xbt_automaton_t _mc_property_automaton;
300 extern xbt_dynar_t mc_stack_comparison_ignore;
301 extern xbt_dynar_t mc_data_bss_comparison_ignore;
303 typedef struct s_mc_pair{
306 mc_state_t graph_state; /* System state included */
307 xbt_automaton_state_t automaton_state;
308 xbt_dynar_t atomic_propositions;
310 }s_mc_pair_t, *mc_pair_t;
312 typedef struct s_mc_visited_pair{
314 int other_num; /* Dot output for */
316 mc_state_t graph_state; /* System state included */
317 xbt_automaton_state_t automaton_state;
318 xbt_dynar_t atomic_propositions;
319 size_t heap_bytes_used;
321 int acceptance_removed;
323 }s_mc_visited_pair_t, *mc_visited_pair_t;
325 mc_pair_t MC_pair_new(void);
326 void MC_pair_delete(mc_pair_t);
327 void mc_pair_free_voidp(void *p);
328 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
329 void MC_visited_pair_delete(mc_visited_pair_t p);
331 void MC_ddfs_init(void);
333 void MC_show_stack_liveness(xbt_fifo_t stack);
334 void MC_dump_stack_liveness(xbt_fifo_t stack);
337 /********************************** Variables with DWARF **********************************/
339 extern xbt_dict_t mc_local_variables_libsimgrid;
340 extern xbt_dict_t mc_local_variables_binary;
341 extern xbt_dynar_t mc_global_variables_libsimgrid;
342 extern xbt_dynar_t mc_global_variables_binary;
343 extern xbt_dict_t mc_variables_type_libsimgrid;
344 extern xbt_dict_t mc_variables_type_binary;
360 } e_dw_location_type;
362 typedef struct s_dw_location{
363 e_dw_location_type type;
381 unsigned short int deref_size;
389 long unsigned int value;
394 long signed int value;
397 unsigned int plus_uconst;
400 }s_dw_location_t, *dw_location_t;
402 typedef struct s_dw_location_entry{
405 dw_location_t location;
406 }s_dw_location_entry_t, *dw_location_entry_t;
408 typedef struct s_dw_variable{
413 dw_location_t location;
416 }s_dw_variable_t, *dw_variable_t;
418 typedef struct s_dw_frame{
422 dw_location_t frame_base;
423 xbt_dynar_t variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
424 unsigned long int start;
425 unsigned long int end;
426 }s_dw_frame_t, *dw_frame_t;
428 /********************************** Miscellaneous **********************************/
430 typedef struct s_local_variable{
437 }s_local_variable_t, *local_variable_t;
439 /********************************* Communications pattern ***************************/
441 typedef struct s_mc_comm_pattern{
444 e_smx_comm_type_t type;
446 unsigned long src_proc;
447 unsigned long dst_proc;
452 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
454 extern xbt_dynar_t communications_pattern;
456 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);