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_dynar_t local_variables;
52 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
54 typedef struct s_mc_global_t{
55 mc_snapshot_t snapshot;
59 }s_mc_global_t, *mc_global_t;
61 typedef struct s_mc_checkpoint_ignore_region{
64 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
66 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
67 mc_snapshot_t MC_take_snapshot(void);
68 void MC_restore_snapshot(mc_snapshot_t);
69 void MC_free_snapshot(mc_snapshot_t);
71 extern xbt_dynar_t mc_checkpoint_ignore;
73 /********************************* MC Global **********************************/
75 extern double *mc_time;
76 extern FILE *dot_output;
77 extern const char* colors[13];
79 extern int user_max_depth_reached;
81 int MC_deadlock_check(void);
82 void MC_replay(xbt_fifo_t stack, int start);
83 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
84 void MC_wait_for_requests(void);
85 void MC_show_deadlock(smx_simcall_t req);
86 void MC_show_stack_safety(xbt_fifo_t stack);
87 void MC_dump_stack_safety(xbt_fifo_t stack);
89 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
92 /********************************* Requests ***********************************/
94 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
95 char* MC_request_to_string(smx_simcall_t req, int value);
96 unsigned int MC_request_testany_fail(smx_simcall_t req);
97 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
98 int MC_request_is_visible(smx_simcall_t req);
99 int MC_request_is_enabled(smx_simcall_t req);
100 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
101 int MC_process_is_enabled(smx_process_t process);
102 char *MC_request_get_dot_output(smx_simcall_t req, int value);
105 /******************************** States **************************************/
107 /* Possible exploration status of a process in a state */
109 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
110 MC_INTERLEAVE, /* Interleave the process (one or more request) */
111 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
112 MC_DONE /* Already interleaved */
113 } e_mc_process_state_t;
115 /* On every state, each process has an entry of the following type */
116 typedef struct mc_procstate{
117 e_mc_process_state_t state; /* Exploration control information */
118 unsigned int interleave_count; /* Number of times that the process was
120 } s_mc_procstate_t, *mc_procstate_t;
122 /* An exploration state is composed of: */
123 typedef struct mc_state {
124 unsigned long max_pid; /* Maximum pid at state's creation time */
125 mc_procstate_t proc_status; /* State's exploration status by process */
126 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
127 s_smx_simcall_t internal_req; /* Internal translation of request */
128 s_smx_simcall_t executed_req; /* The executed request of the state */
129 int req_num; /* The request number (in the case of a
130 multi-request like waitany ) */
131 mc_snapshot_t system_state; /* Snapshot of system state */
133 } s_mc_state_t, *mc_state_t;
135 mc_state_t MC_state_new(void);
136 void MC_state_delete(mc_state_t state);
137 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
138 unsigned int MC_state_interleave_size(mc_state_t state);
139 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
140 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
141 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
142 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
143 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
144 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
147 /****************************** Statistics ************************************/
149 typedef struct mc_stats {
150 unsigned long state_size;
151 unsigned long visited_states;
152 unsigned long visited_pairs;
153 unsigned long expanded_states;
154 unsigned long expanded_pairs;
155 unsigned long executed_transitions;
156 } s_mc_stats_t, *mc_stats_t;
158 extern mc_stats_t mc_stats;
160 void MC_print_statistics(mc_stats_t);
163 /********************************** MEMORY ******************************/
164 /* The possible memory modes for the modelchecker are standard and raw. */
165 /* Normally the system should operate in std, for switching to raw mode */
166 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
168 extern void *std_heap;
169 extern void *raw_heap;
172 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
173 /* an API to query about the status of a heap, we simply call mmstats and */
174 /* because I now how does structure looks like, then I redefine it here */
176 /* struct mstats { */
177 /* size_t bytes_total; /\* Total size of the heap. *\/ */
178 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
179 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
180 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
181 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
184 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
185 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
188 /******************************* MEMORY MAPPINGS ***************************/
189 /* These functions and data structures implements a binary interface for */
190 /* the proc maps ascii interface */
192 /* Each field is defined as documented in proc's manual page */
193 typedef struct s_map_region {
195 void *start_addr; /* Start address of the map */
196 void *end_addr; /* End address of the map */
197 int prot; /* Memory protection */
198 int flags; /* Additional memory flags */
199 void *offset; /* Offset in the file/whatever */
200 char dev_major; /* Major of the device */
201 char dev_minor; /* Minor of the device */
202 unsigned long inode; /* Inode in the device */
203 char *pathname; /* Path name of the mapped file */
207 typedef struct s_memory_map {
209 s_map_region_t *regions; /* Pointer to an array of regions */
210 int mapsize; /* Number of regions in the memory */
212 } s_memory_map_t, *memory_map_t;
215 void MC_init_memory_map_info(void);
216 memory_map_t MC_get_memory_map(void);
217 void MC_free_memory_map(memory_map_t map);
218 void MC_get_libsimgrid_plt_section(void);
219 void MC_get_binary_plt_section(void);
221 extern void *start_data_libsimgrid;
222 extern void *start_data_binary;
223 extern void *start_bss_binary;
224 extern char *libsimgrid_path;
225 extern void *start_text_libsimgrid;
226 extern void *start_text_binary;
227 extern void *start_bss_libsimgrid;
228 extern void *start_plt_libsimgrid;
229 extern void *end_plt_libsimgrid;
230 extern void *start_plt_binary;
231 extern void *end_plt_binary;
232 extern void *start_got_plt_libsimgrid;
233 extern void *end_got_plt_libsimgrid;
234 extern void *start_got_plt_binary;
235 extern void *end_got_plt_binary;
238 /********************************** Snapshot comparison **********************************/
240 typedef struct s_mc_comparison_times{
241 double nb_processes_comparison_time;
242 double bytes_used_comparison_time;
243 double stacks_sizes_comparison_time;
244 double binary_global_variables_comparison_time;
245 double libsimgrid_global_variables_comparison_time;
246 double heap_comparison_time;
247 double stacks_comparison_time;
248 double hash_global_variables_comparison_time;
249 double hash_local_variables_comparison_time;
250 }s_mc_comparison_times_t, *mc_comparison_times_t;
252 extern mc_comparison_times_t mc_comp_times;
253 extern double mc_snapshot_comparison_time;
255 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
256 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
257 void print_comparison_times(void);
263 /********************************** DPOR for safety property **************************************/
271 extern e_mc_reduce_t mc_reduce_kind;
272 extern mc_global_t initial_state_safety;
273 extern xbt_fifo_t mc_stack_safety;
274 extern xbt_dict_t first_enabled_state;
276 void MC_dpor_init(void);
279 typedef struct s_mc_visited_state{
280 mc_snapshot_t system_state;
281 size_t heap_bytes_used;
284 int other_num; // dot_output for
285 }s_mc_visited_state_t, *mc_visited_state_t;
288 /********************************** Double-DFS for liveness property **************************************/
290 extern xbt_fifo_t mc_stack_liveness;
291 extern mc_global_t initial_state_liveness;
292 extern xbt_automaton_t _mc_property_automaton;
294 extern xbt_dynar_t mc_stack_comparison_ignore;
295 extern xbt_dynar_t mc_data_bss_comparison_ignore;
297 typedef struct s_mc_pair{
299 int other_num; /* Dot output for */
301 mc_state_t graph_state; /* System state included */
302 xbt_automaton_state_t automaton_state;
303 xbt_dynar_t atomic_propositions;
305 size_t heap_bytes_used;
309 int acceptance_removed;
310 }s_mc_pair_t, *mc_pair_t;
312 mc_pair_t MC_pair_new(void);
313 void MC_pair_delete(mc_pair_t);
314 void mc_pair_free_voidp(void *p);
316 void MC_ddfs_init(void);
318 void MC_show_stack_liveness(xbt_fifo_t stack);
319 void MC_dump_stack_liveness(xbt_fifo_t stack);
322 /********************************** Variables with DWARF **********************************/
324 extern xbt_dict_t mc_local_variables_libsimgrid;
325 extern xbt_dict_t mc_local_variables_binary;
326 extern xbt_dynar_t mc_global_variables_libsimgrid;
327 extern xbt_dynar_t mc_global_variables_binary;
328 extern xbt_dict_t mc_variables_type_libsimgrid;
329 extern xbt_dict_t mc_variables_type_binary;
345 } e_dw_location_type;
347 typedef struct s_dw_location{
348 e_dw_location_type type;
366 unsigned short int deref_size;
374 long unsigned int value;
379 long signed int value;
382 unsigned int plus_uconst;
385 }s_dw_location_t, *dw_location_t;
387 typedef struct s_dw_location_entry{
390 dw_location_t location;
391 }s_dw_location_entry_t, *dw_location_entry_t;
393 typedef struct s_dw_variable{
398 dw_location_t location;
401 }s_dw_variable_t, *dw_variable_t;
403 typedef struct s_dw_frame{
407 dw_location_t frame_base;
408 xbt_dynar_t variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
409 unsigned long int start;
410 unsigned long int end;
411 }s_dw_frame_t, *dw_frame_t;
413 /********************************** Miscellaneous **********************************/
415 typedef struct s_local_variable{
422 }s_local_variable_t, *local_variable_t;