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"
26 #include "xbt/parmap.h"
28 /****************************** Snapshots ***********************************/
30 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
32 typedef struct s_mc_mem_region{
36 } s_mc_mem_region_t, *mc_mem_region_t;
38 typedef struct s_mc_snapshot{
39 size_t heap_bytes_used;
40 mc_mem_region_t regions[NB_REGIONS];
44 xbt_dynar_t to_ignore;
47 } s_mc_snapshot_t, *mc_snapshot_t;
49 typedef struct s_mc_snapshot_stack{
50 xbt_dynar_t local_variables;
53 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
55 typedef struct s_mc_global_t{
56 mc_snapshot_t snapshot;
60 }s_mc_global_t, *mc_global_t;
62 typedef struct s_mc_checkpoint_ignore_region{
65 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
67 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
68 mc_snapshot_t MC_take_snapshot(void);
69 void MC_restore_snapshot(mc_snapshot_t);
70 void MC_free_snapshot(mc_snapshot_t);
72 extern xbt_dynar_t mc_checkpoint_ignore;
74 /********************************* MC Global **********************************/
76 extern double *mc_time;
77 extern FILE *dot_output;
78 extern const char* colors[13];
79 extern xbt_parmap_t parmap;
81 extern int user_max_depth_reached;
83 int MC_deadlock_check(void);
84 void MC_replay(xbt_fifo_t stack, int start);
85 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
86 void MC_wait_for_requests(void);
87 void MC_show_deadlock(smx_simcall_t req);
88 void MC_show_stack_safety(xbt_fifo_t stack);
89 void MC_dump_stack_safety(xbt_fifo_t stack);
91 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
94 /********************************* Requests ***********************************/
96 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
97 char* MC_request_to_string(smx_simcall_t req, int value);
98 unsigned int MC_request_testany_fail(smx_simcall_t req);
99 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
100 int MC_request_is_visible(smx_simcall_t req);
101 int MC_request_is_enabled(smx_simcall_t req);
102 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
103 int MC_process_is_enabled(smx_process_t process);
104 char *MC_request_get_dot_output(smx_simcall_t req, int value);
107 /******************************** States **************************************/
109 /* Possible exploration status of a process in a state */
111 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
112 MC_INTERLEAVE, /* Interleave the process (one or more request) */
113 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
114 MC_DONE /* Already interleaved */
115 } e_mc_process_state_t;
117 /* On every state, each process has an entry of the following type */
118 typedef struct mc_procstate{
119 e_mc_process_state_t state; /* Exploration control information */
120 unsigned int interleave_count; /* Number of times that the process was
122 } s_mc_procstate_t, *mc_procstate_t;
124 /* An exploration state is composed of: */
125 typedef struct mc_state {
126 unsigned long max_pid; /* Maximum pid at state's creation time */
127 mc_procstate_t proc_status; /* State's exploration status by process */
128 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
129 s_smx_simcall_t internal_req; /* Internal translation of request */
130 s_smx_simcall_t executed_req; /* The executed request of the state */
131 int req_num; /* The request number (in the case of a
132 multi-request like waitany ) */
133 mc_snapshot_t system_state; /* Snapshot of system state */
135 } s_mc_state_t, *mc_state_t;
137 mc_state_t MC_state_new(void);
138 void MC_state_delete(mc_state_t state);
139 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
140 unsigned int MC_state_interleave_size(mc_state_t state);
141 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
142 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
143 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
144 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
145 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
146 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
149 /****************************** Statistics ************************************/
151 typedef struct mc_stats {
152 unsigned long state_size;
153 unsigned long visited_states;
154 unsigned long visited_pairs;
155 unsigned long expanded_states;
156 unsigned long expanded_pairs;
157 unsigned long executed_transitions;
158 } s_mc_stats_t, *mc_stats_t;
160 extern mc_stats_t mc_stats;
162 void MC_print_statistics(mc_stats_t);
165 /********************************** MEMORY ******************************/
166 /* The possible memory modes for the modelchecker are standard and raw. */
167 /* Normally the system should operate in std, for switching to raw mode */
168 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
170 extern void *std_heap;
171 extern void *raw_heap;
174 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
175 /* an API to query about the status of a heap, we simply call mmstats and */
176 /* because I now how does structure looks like, then I redefine it here */
178 /* struct mstats { */
179 /* size_t bytes_total; /\* Total size of the heap. *\/ */
180 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
181 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
182 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
183 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
186 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
187 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
190 /******************************* MEMORY MAPPINGS ***************************/
191 /* These functions and data structures implements a binary interface for */
192 /* the proc maps ascii interface */
194 /* Each field is defined as documented in proc's manual page */
195 typedef struct s_map_region {
197 void *start_addr; /* Start address of the map */
198 void *end_addr; /* End address of the map */
199 int prot; /* Memory protection */
200 int flags; /* Additional memory flags */
201 void *offset; /* Offset in the file/whatever */
202 char dev_major; /* Major of the device */
203 char dev_minor; /* Minor of the device */
204 unsigned long inode; /* Inode in the device */
205 char *pathname; /* Path name of the mapped file */
209 typedef struct s_memory_map {
211 s_map_region_t *regions; /* Pointer to an array of regions */
212 int mapsize; /* Number of regions in the memory */
214 } s_memory_map_t, *memory_map_t;
217 void MC_init_memory_map_info(void);
218 memory_map_t MC_get_memory_map(void);
219 void MC_free_memory_map(memory_map_t map);
220 void MC_get_libsimgrid_plt_section(void);
221 void MC_get_binary_plt_section(void);
223 extern void *start_data_libsimgrid;
224 extern void *start_data_binary;
225 extern void *start_bss_binary;
226 extern char *libsimgrid_path;
227 extern void *start_text_libsimgrid;
228 extern void *start_text_binary;
229 extern void *start_bss_libsimgrid;
230 extern void *start_plt_libsimgrid;
231 extern void *end_plt_libsimgrid;
232 extern void *start_plt_binary;
233 extern void *end_plt_binary;
234 extern void *start_got_plt_libsimgrid;
235 extern void *end_got_plt_libsimgrid;
236 extern void *start_got_plt_binary;
237 extern void *end_got_plt_binary;
240 /********************************** Snapshot comparison **********************************/
242 typedef struct s_mc_comparison_times{
243 double nb_processes_comparison_time;
244 double bytes_used_comparison_time;
245 double stacks_sizes_comparison_time;
246 double binary_global_variables_comparison_time;
247 double libsimgrid_global_variables_comparison_time;
248 double heap_comparison_time;
249 double stacks_comparison_time;
250 double hash_global_variables_comparison_time;
251 double hash_local_variables_comparison_time;
252 }s_mc_comparison_times_t, *mc_comparison_times_t;
254 extern __thread mc_comparison_times_t mc_comp_times;
255 extern __thread double mc_snapshot_comparison_time;
257 int snapshot_compare(void *p1, void *p2);
258 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
259 void print_comparison_times(void);
265 /********************************** DPOR for safety property **************************************/
273 extern e_mc_reduce_t mc_reduce_kind;
274 extern mc_global_t initial_state_safety;
275 extern xbt_fifo_t mc_stack_safety;
276 extern xbt_dict_t first_enabled_state;
278 void MC_dpor_init(void);
281 typedef struct s_mc_visited_state{
282 mc_snapshot_t system_state;
283 size_t heap_bytes_used;
286 int other_num; // dot_output for
287 }s_mc_visited_state_t, *mc_visited_state_t;
290 /********************************** Double-DFS for liveness property **************************************/
292 extern xbt_fifo_t mc_stack_liveness;
293 extern mc_global_t initial_state_liveness;
294 extern xbt_automaton_t _mc_property_automaton;
296 extern xbt_dynar_t mc_stack_comparison_ignore;
297 extern xbt_dynar_t mc_data_bss_comparison_ignore;
299 typedef struct s_mc_pair{
301 int other_num; /* Dot output for */
303 mc_state_t graph_state; /* System state included */
304 xbt_automaton_state_t automaton_state;
305 xbt_dynar_t atomic_propositions;
307 size_t heap_bytes_used;
311 int acceptance_removed;
312 }s_mc_pair_t, *mc_pair_t;
314 mc_pair_t MC_pair_new(void);
315 void MC_pair_delete(mc_pair_t);
316 void mc_pair_free_voidp(void *p);
318 void MC_ddfs_init(void);
320 void MC_show_stack_liveness(xbt_fifo_t stack);
321 void MC_dump_stack_liveness(xbt_fifo_t stack);
324 /********************************** Variables with DWARF **********************************/
326 extern xbt_dict_t mc_local_variables_libsimgrid;
327 extern xbt_dict_t mc_local_variables_binary;
328 extern xbt_dynar_t mc_global_variables_libsimgrid;
329 extern xbt_dynar_t mc_global_variables_binary;
330 extern xbt_dict_t mc_variables_type_libsimgrid;
331 extern xbt_dict_t mc_variables_type_binary;
347 } e_dw_location_type;
349 typedef struct s_dw_location{
350 e_dw_location_type type;
368 unsigned short int deref_size;
376 long unsigned int value;
381 long signed int value;
384 unsigned int plus_uconst;
387 }s_dw_location_t, *dw_location_t;
389 typedef struct s_dw_location_entry{
392 dw_location_t location;
393 }s_dw_location_entry_t, *dw_location_entry_t;
395 typedef struct s_dw_variable{
400 dw_location_t location;
403 }s_dw_variable_t, *dw_variable_t;
405 typedef struct s_dw_frame{
409 dw_location_t frame_base;
410 xbt_dynar_t variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
411 unsigned long int start;
412 unsigned long int end;
413 }s_dw_frame_t, *dw_frame_t;
415 /********************************** Miscellaneous **********************************/
417 typedef struct s_local_variable{
424 }s_local_variable_t, *local_variable_t;