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 }s_mc_global_t, *mc_global_t;
63 typedef struct s_mc_checkpoint_ignore_region{
66 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
68 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
69 mc_snapshot_t MC_take_snapshot(int num_state);
70 void MC_restore_snapshot(mc_snapshot_t);
71 void MC_free_snapshot(mc_snapshot_t);
73 extern xbt_dynar_t mc_checkpoint_ignore;
75 /********************************* MC Global **********************************/
77 extern double *mc_time;
78 extern FILE *dot_output;
79 extern const char* colors[13];
80 extern xbt_parmap_t parmap;
82 extern int user_max_depth_reached;
84 int MC_deadlock_check(void);
85 void MC_replay(xbt_fifo_t stack, int start);
86 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
87 void MC_wait_for_requests(void);
88 void MC_show_deadlock(smx_simcall_t req);
89 void MC_show_stack_safety(xbt_fifo_t stack);
90 void MC_dump_stack_safety(xbt_fifo_t stack);
92 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
95 /********************************* Requests ***********************************/
97 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
98 char* MC_request_to_string(smx_simcall_t req, int value);
99 unsigned int MC_request_testany_fail(smx_simcall_t req);
100 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
101 int MC_request_is_visible(smx_simcall_t req);
102 int MC_request_is_enabled(smx_simcall_t req);
103 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
104 int MC_process_is_enabled(smx_process_t process);
105 char *MC_request_get_dot_output(smx_simcall_t req, int value);
108 /******************************** States **************************************/
110 /* Possible exploration status of a process in a state */
112 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
113 MC_INTERLEAVE, /* Interleave the process (one or more request) */
114 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
115 MC_DONE /* Already interleaved */
116 } e_mc_process_state_t;
118 /* On every state, each process has an entry of the following type */
119 typedef struct mc_procstate{
120 e_mc_process_state_t state; /* Exploration control information */
121 unsigned int interleave_count; /* Number of times that the process was
123 } s_mc_procstate_t, *mc_procstate_t;
125 /* An exploration state is composed of: */
126 typedef struct mc_state {
127 unsigned long max_pid; /* Maximum pid at state's creation time */
128 mc_procstate_t proc_status; /* State's exploration status by process */
129 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
130 s_smx_simcall_t internal_req; /* Internal translation of request */
131 s_smx_simcall_t executed_req; /* The executed request of the state */
132 int req_num; /* The request number (in the case of a
133 multi-request like waitany ) */
134 mc_snapshot_t system_state; /* Snapshot of system state */
136 } s_mc_state_t, *mc_state_t;
138 mc_state_t MC_state_new(void);
139 void MC_state_delete(mc_state_t state);
140 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
141 unsigned int MC_state_interleave_size(mc_state_t state);
142 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
143 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
144 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
145 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
146 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
147 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
150 /****************************** Statistics ************************************/
152 typedef struct mc_stats {
153 unsigned long state_size;
154 unsigned long visited_states;
155 unsigned long visited_pairs;
156 unsigned long expanded_states;
157 unsigned long expanded_pairs;
158 unsigned long executed_transitions;
159 } s_mc_stats_t, *mc_stats_t;
161 extern mc_stats_t mc_stats;
163 void MC_print_statistics(mc_stats_t);
166 /********************************** MEMORY ******************************/
167 /* The possible memory modes for the modelchecker are standard and raw. */
168 /* Normally the system should operate in std, for switching to raw mode */
169 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
171 extern void *std_heap;
172 extern void *raw_heap;
175 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
176 /* an API to query about the status of a heap, we simply call mmstats and */
177 /* because I now how does structure looks like, then I redefine it here */
179 /* struct mstats { */
180 /* size_t bytes_total; /\* Total size of the heap. *\/ */
181 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
182 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
183 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
184 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
187 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
188 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
191 /******************************* MEMORY MAPPINGS ***************************/
192 /* These functions and data structures implements a binary interface for */
193 /* the proc maps ascii interface */
195 /* Each field is defined as documented in proc's manual page */
196 typedef struct s_map_region {
198 void *start_addr; /* Start address of the map */
199 void *end_addr; /* End address of the map */
200 int prot; /* Memory protection */
201 int flags; /* Additional memory flags */
202 void *offset; /* Offset in the file/whatever */
203 char dev_major; /* Major of the device */
204 char dev_minor; /* Minor of the device */
205 unsigned long inode; /* Inode in the device */
206 char *pathname; /* Path name of the mapped file */
210 typedef struct s_memory_map {
212 s_map_region_t *regions; /* Pointer to an array of regions */
213 int mapsize; /* Number of regions in the memory */
215 } s_memory_map_t, *memory_map_t;
218 void MC_init_memory_map_info(void);
219 memory_map_t MC_get_memory_map(void);
220 void MC_free_memory_map(memory_map_t map);
222 extern char *libsimgrid_path;
224 /********************************** Snapshot comparison **********************************/
226 typedef struct s_mc_comparison_times{
227 double nb_processes_comparison_time;
228 double bytes_used_comparison_time;
229 double stacks_sizes_comparison_time;
230 double binary_global_variables_comparison_time;
231 double libsimgrid_global_variables_comparison_time;
232 double heap_comparison_time;
233 double stacks_comparison_time;
234 double hash_global_variables_comparison_time;
235 double hash_local_variables_comparison_time;
236 }s_mc_comparison_times_t, *mc_comparison_times_t;
238 extern __thread mc_comparison_times_t mc_comp_times;
239 extern __thread double mc_snapshot_comparison_time;
241 int snapshot_compare(void *state1, void *state2);
242 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
243 void print_comparison_times(void);
249 /********************************** DPOR for safety property **************************************/
257 extern e_mc_reduce_t mc_reduce_kind;
258 extern mc_global_t initial_state_safety;
259 extern xbt_fifo_t mc_stack_safety;
260 extern xbt_dict_t first_enabled_state;
262 void MC_dpor_init(void);
265 typedef struct s_mc_visited_state{
266 mc_snapshot_t system_state;
267 size_t heap_bytes_used;
270 int other_num; // dot_output for
271 }s_mc_visited_state_t, *mc_visited_state_t;
274 /********************************** Double-DFS for liveness property **************************************/
276 extern xbt_fifo_t mc_stack_liveness;
277 extern mc_global_t initial_state_liveness;
278 extern xbt_automaton_t _mc_property_automaton;
280 extern xbt_dynar_t mc_stack_comparison_ignore;
281 extern xbt_dynar_t mc_data_bss_comparison_ignore;
283 typedef struct s_mc_pair{
286 mc_state_t graph_state; /* System state included */
287 xbt_automaton_state_t automaton_state;
288 xbt_dynar_t atomic_propositions;
290 }s_mc_pair_t, *mc_pair_t;
292 typedef struct s_mc_visited_pair{
294 int other_num; /* Dot output for */
296 mc_state_t graph_state; /* System state included */
297 xbt_automaton_state_t automaton_state;
298 xbt_dynar_t atomic_propositions;
299 size_t heap_bytes_used;
301 int acceptance_removed;
303 }s_mc_visited_pair_t, *mc_visited_pair_t;
305 mc_pair_t MC_pair_new(void);
306 void MC_pair_delete(mc_pair_t);
307 void mc_pair_free_voidp(void *p);
308 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
309 void MC_visited_pair_delete(mc_visited_pair_t p);
311 void MC_ddfs_init(void);
313 void MC_show_stack_liveness(xbt_fifo_t stack);
314 void MC_dump_stack_liveness(xbt_fifo_t stack);
317 /********************************** Variables with DWARF **********************************/
319 typedef struct s_mc_object_info {
328 xbt_dict_t local_variables;
329 xbt_dynar_t global_variables;
331 } s_mc_object_info_t, *mc_object_info_t;
333 mc_object_info_t MC_new_object_info();
334 mc_object_info_t MC_find_object_address(memory_map_t maps, char* name);
335 void MC_free_object_info(mc_object_info_t* p);
337 extern mc_object_info_t mc_libsimgrid_info;
338 extern mc_object_info_t mc_binary_info;
354 } e_dw_location_type;
356 typedef struct s_dw_location{
357 e_dw_location_type type;
375 unsigned short int deref_size;
383 long unsigned int value;
388 long signed int value;
391 unsigned int plus_uconst;
394 }s_dw_location_t, *dw_location_t;
396 typedef struct s_dw_location_entry{
399 dw_location_t location;
400 }s_dw_location_entry_t, *dw_location_entry_t;
402 typedef struct s_dw_variable{
407 dw_location_t location;
410 }s_dw_variable_t, *dw_variable_t;
412 typedef struct s_dw_frame{
416 dw_location_t frame_base;
417 xbt_dynar_t variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
418 unsigned long int start;
419 unsigned long int end;
420 }s_dw_frame_t, *dw_frame_t;
422 /********************************** Miscellaneous **********************************/
424 typedef struct s_local_variable{
431 }s_local_variable_t, *local_variable_t;