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"
15 #include <elfutils/libdw.h>
18 #include "mc/datatypes.h"
20 #include "xbt/config.h"
21 #include "xbt/function_types.h"
22 #include "xbt/mmalloc.h"
23 #include "../simix/smx_private.h"
24 #include "xbt/automaton.h"
27 #include "msg/datatypes.h"
28 #include "xbt/strbuff.h"
29 #include "xbt/parmap.h"
31 /****************************** Snapshots ***********************************/
33 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
35 typedef struct s_mc_mem_region{
39 } s_mc_mem_region_t, *mc_mem_region_t;
41 typedef struct s_mc_snapshot{
42 size_t heap_bytes_used;
43 mc_mem_region_t regions[NB_REGIONS];
47 xbt_dynar_t to_ignore;
50 } s_mc_snapshot_t, *mc_snapshot_t;
52 typedef struct s_mc_snapshot_stack{
53 xbt_dynar_t local_variables;
56 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
58 typedef struct s_mc_global_t{
59 mc_snapshot_t snapshot;
63 }s_mc_global_t, *mc_global_t;
65 typedef struct s_mc_checkpoint_ignore_region{
68 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
70 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
71 mc_snapshot_t MC_take_snapshot(int num_state);
72 void MC_restore_snapshot(mc_snapshot_t);
73 void MC_free_snapshot(mc_snapshot_t);
75 extern xbt_dynar_t mc_checkpoint_ignore;
77 /********************************* MC Global **********************************/
79 extern double *mc_time;
80 extern FILE *dot_output;
81 extern const char* colors[13];
82 extern xbt_parmap_t parmap;
84 extern int user_max_depth_reached;
86 int MC_deadlock_check(void);
87 void MC_replay(xbt_fifo_t stack, int start);
88 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
89 void MC_wait_for_requests(void);
90 void MC_show_deadlock(smx_simcall_t req);
91 void MC_show_stack_safety(xbt_fifo_t stack);
92 void MC_dump_stack_safety(xbt_fifo_t stack);
94 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
97 /********************************* Requests ***********************************/
99 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
100 char* MC_request_to_string(smx_simcall_t req, int value);
101 unsigned int MC_request_testany_fail(smx_simcall_t req);
102 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
103 int MC_request_is_visible(smx_simcall_t req);
104 int MC_request_is_enabled(smx_simcall_t req);
105 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
106 int MC_process_is_enabled(smx_process_t process);
107 char *MC_request_get_dot_output(smx_simcall_t req, int value);
110 /******************************** States **************************************/
112 /* Possible exploration status of a process in a state */
114 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
115 MC_INTERLEAVE, /* Interleave the process (one or more request) */
116 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
117 MC_DONE /* Already interleaved */
118 } e_mc_process_state_t;
120 /* On every state, each process has an entry of the following type */
121 typedef struct mc_procstate{
122 e_mc_process_state_t state; /* Exploration control information */
123 unsigned int interleave_count; /* Number of times that the process was
125 } s_mc_procstate_t, *mc_procstate_t;
127 /* An exploration state is composed of: */
128 typedef struct mc_state {
129 unsigned long max_pid; /* Maximum pid at state's creation time */
130 mc_procstate_t proc_status; /* State's exploration status by process */
131 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
132 s_smx_simcall_t internal_req; /* Internal translation of request */
133 s_smx_simcall_t executed_req; /* The executed request of the state */
134 int req_num; /* The request number (in the case of a
135 multi-request like waitany ) */
136 mc_snapshot_t system_state; /* Snapshot of system state */
138 } s_mc_state_t, *mc_state_t;
140 mc_state_t MC_state_new(void);
141 void MC_state_delete(mc_state_t state);
142 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
143 unsigned int MC_state_interleave_size(mc_state_t state);
144 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
145 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
146 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
147 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
148 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
149 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
152 /****************************** Statistics ************************************/
154 typedef struct mc_stats {
155 unsigned long state_size;
156 unsigned long visited_states;
157 unsigned long visited_pairs;
158 unsigned long expanded_states;
159 unsigned long expanded_pairs;
160 unsigned long executed_transitions;
161 } s_mc_stats_t, *mc_stats_t;
163 extern mc_stats_t mc_stats;
165 void MC_print_statistics(mc_stats_t);
168 /********************************** MEMORY ******************************/
169 /* The possible memory modes for the modelchecker are standard and raw. */
170 /* Normally the system should operate in std, for switching to raw mode */
171 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
173 extern void *std_heap;
174 extern void *raw_heap;
177 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
178 /* an API to query about the status of a heap, we simply call mmstats and */
179 /* because I now how does structure looks like, then I redefine it here */
181 /* struct mstats { */
182 /* size_t bytes_total; /\* Total size of the heap. *\/ */
183 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
184 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
185 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
186 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
189 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
190 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
193 /******************************* MEMORY MAPPINGS ***************************/
194 /* These functions and data structures implements a binary interface for */
195 /* the proc maps ascii interface */
197 /* Each field is defined as documented in proc's manual page */
198 typedef struct s_map_region {
200 void *start_addr; /* Start address of the map */
201 void *end_addr; /* End address of the map */
202 int prot; /* Memory protection */
203 int flags; /* Additional memory flags */
204 void *offset; /* Offset in the file/whatever */
205 char dev_major; /* Major of the device */
206 char dev_minor; /* Minor of the device */
207 unsigned long inode; /* Inode in the device */
208 char *pathname; /* Path name of the mapped file */
212 typedef struct s_memory_map {
214 s_map_region_t *regions; /* Pointer to an array of regions */
215 int mapsize; /* Number of regions in the memory */
217 } s_memory_map_t, *memory_map_t;
220 void MC_init_memory_map_info(void);
221 memory_map_t MC_get_memory_map(void);
222 void MC_free_memory_map(memory_map_t map);
224 extern char *libsimgrid_path;
226 /********************************** Snapshot comparison **********************************/
228 typedef struct s_mc_comparison_times{
229 double nb_processes_comparison_time;
230 double bytes_used_comparison_time;
231 double stacks_sizes_comparison_time;
232 double binary_global_variables_comparison_time;
233 double libsimgrid_global_variables_comparison_time;
234 double heap_comparison_time;
235 double stacks_comparison_time;
236 double hash_global_variables_comparison_time;
237 double hash_local_variables_comparison_time;
238 }s_mc_comparison_times_t, *mc_comparison_times_t;
240 extern __thread mc_comparison_times_t mc_comp_times;
241 extern __thread double mc_snapshot_comparison_time;
243 int snapshot_compare(void *state1, void *state2);
244 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
245 void print_comparison_times(void);
251 /********************************** DPOR for safety property **************************************/
259 extern e_mc_reduce_t mc_reduce_kind;
260 extern mc_global_t initial_state_safety;
261 extern xbt_fifo_t mc_stack_safety;
262 extern xbt_dict_t first_enabled_state;
264 void MC_dpor_init(void);
267 typedef struct s_mc_visited_state{
268 mc_snapshot_t system_state;
269 size_t heap_bytes_used;
272 int other_num; // dot_output for
273 }s_mc_visited_state_t, *mc_visited_state_t;
276 /********************************** Double-DFS for liveness property **************************************/
278 extern xbt_fifo_t mc_stack_liveness;
279 extern mc_global_t initial_state_liveness;
280 extern xbt_automaton_t _mc_property_automaton;
282 extern xbt_dynar_t mc_stack_comparison_ignore;
283 extern xbt_dynar_t mc_data_bss_comparison_ignore;
285 typedef struct s_mc_pair{
288 mc_state_t graph_state; /* System state included */
289 xbt_automaton_state_t automaton_state;
290 xbt_dynar_t atomic_propositions;
292 }s_mc_pair_t, *mc_pair_t;
294 typedef struct s_mc_visited_pair{
296 int other_num; /* Dot output for */
298 mc_state_t graph_state; /* System state included */
299 xbt_automaton_state_t automaton_state;
300 xbt_dynar_t atomic_propositions;
301 size_t heap_bytes_used;
303 int acceptance_removed;
305 }s_mc_visited_pair_t, *mc_visited_pair_t;
307 mc_pair_t MC_pair_new(void);
308 void MC_pair_delete(mc_pair_t);
309 void mc_pair_free_voidp(void *p);
310 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
311 void MC_visited_pair_delete(mc_visited_pair_t p);
313 void MC_ddfs_init(void);
315 void MC_show_stack_liveness(xbt_fifo_t stack);
316 void MC_dump_stack_liveness(xbt_fifo_t stack);
319 /********************************** Variables with DWARF **********************************/
321 typedef struct s_mc_object_info {
330 xbt_dict_t local_variables; // xbt_dict_t<frame_name, dw_frame_t>
331 xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
332 xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
333 xbt_dict_t location_list; // Location list (probably temporary)
334 } s_mc_object_info_t, *mc_object_info_t;
336 mc_object_info_t MC_new_object_info(void);
337 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name);
338 void MC_free_object_info(mc_object_info_t* p);
340 xbt_dict_t MC_dwarf_get_location_list(const char *elf_file);
341 void MC_dwarf_get_variables(mc_object_info_t info);
342 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
343 const char* MC_dwarf_attrname(int attr);
344 const char* MC_dwarf_tagname(int tag);
346 extern mc_object_info_t mc_libsimgrid_info;
347 extern mc_object_info_t mc_binary_info;
363 } e_dw_location_type;
365 typedef struct s_dw_location{
366 e_dw_location_type type;
384 unsigned short int deref_size;
392 long unsigned int value;
397 long signed int value;
400 unsigned int plus_uconst;
403 }s_dw_location_t, *dw_location_t;
405 typedef struct s_dw_location_entry{
408 dw_location_t location;
409 }s_dw_location_entry_t, *dw_location_entry_t;
411 typedef struct s_dw_variable{
412 Dwarf_Off dwarf_offset; /* Global offset of the field. */
417 dw_location_t location; // For global==0
418 void *address; // For global!=0
420 }s_dw_variable_t, *dw_variable_t;
422 typedef struct s_dw_frame{
426 dw_location_t frame_base;
427 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
428 unsigned long int start; /* DWARF offset of the subprogram */
429 unsigned long int end; /* Dwarf offset of the next sibling */
430 }s_dw_frame_t, *dw_frame_t;
432 void dw_type_free(dw_type_t t);
433 void dw_variable_free(dw_variable_t v);
434 void dw_variable_free_voidp(void *t);
436 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
437 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
438 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
439 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
441 /********************************** DWARF **********************************/
443 Dwarf_Off MC_dwarf_resolve_location(unw_cursor_t* c, dw_location_t location, void* frame_pointer_address);
445 /********************************** Miscellaneous **********************************/
447 typedef struct s_local_variable{
454 }s_local_variable_t, *local_variable_t;
456 #define MC_USE_LIBDW (getenv("MC_USE_OBJDUMP") == NULL)