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;
51 } s_mc_snapshot_t, *mc_snapshot_t;
53 typedef struct s_mc_snapshot_stack{
54 xbt_dynar_t local_variables;
57 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
59 typedef struct s_mc_global_t{
60 mc_snapshot_t snapshot;
64 int initial_communications_pattern_done;
65 int comm_deterministic;
66 int send_deterministic;
67 }s_mc_global_t, *mc_global_t;
69 typedef struct s_mc_checkpoint_ignore_region{
72 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
74 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
75 mc_snapshot_t MC_take_snapshot(int num_state);
76 void MC_restore_snapshot(mc_snapshot_t);
77 void MC_free_snapshot(mc_snapshot_t);
79 extern xbt_dynar_t mc_checkpoint_ignore;
81 /********************************* MC Global **********************************/
83 extern double *mc_time;
84 extern FILE *dot_output;
85 extern const char* colors[13];
86 extern xbt_parmap_t parmap;
88 extern int user_max_depth_reached;
90 int MC_deadlock_check(void);
91 void MC_replay(xbt_fifo_t stack, int start);
92 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
93 void MC_wait_for_requests(void);
94 void MC_show_deadlock(smx_simcall_t req);
95 void MC_show_stack_safety(xbt_fifo_t stack);
96 void MC_dump_stack_safety(xbt_fifo_t stack);
98 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
101 /********************************* Requests ***********************************/
103 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
104 char* MC_request_to_string(smx_simcall_t req, int value);
105 unsigned int MC_request_testany_fail(smx_simcall_t req);
106 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
107 int MC_request_is_visible(smx_simcall_t req);
108 int MC_request_is_enabled(smx_simcall_t req);
109 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
110 int MC_process_is_enabled(smx_process_t process);
111 char *MC_request_get_dot_output(smx_simcall_t req, int value);
114 /******************************** States **************************************/
116 /* Possible exploration status of a process in a state */
118 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
119 MC_INTERLEAVE, /* Interleave the process (one or more request) */
120 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
121 MC_DONE /* Already interleaved */
122 } e_mc_process_state_t;
124 /* On every state, each process has an entry of the following type */
125 typedef struct mc_procstate{
126 e_mc_process_state_t state; /* Exploration control information */
127 unsigned int interleave_count; /* Number of times that the process was
129 } s_mc_procstate_t, *mc_procstate_t;
131 /* An exploration state is composed of: */
132 typedef struct mc_state {
133 unsigned long max_pid; /* Maximum pid at state's creation time */
134 mc_procstate_t proc_status; /* State's exploration status by process */
135 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
136 s_smx_simcall_t internal_req; /* Internal translation of request */
137 s_smx_simcall_t executed_req; /* The executed request of the state */
138 int req_num; /* The request number (in the case of a
139 multi-request like waitany ) */
140 mc_snapshot_t system_state; /* Snapshot of system state */
142 } s_mc_state_t, *mc_state_t;
144 mc_state_t MC_state_new(void);
145 void MC_state_delete(mc_state_t state);
146 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
147 unsigned int MC_state_interleave_size(mc_state_t state);
148 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
149 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
150 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
151 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
152 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
153 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
156 /****************************** Statistics ************************************/
158 typedef struct mc_stats {
159 unsigned long state_size;
160 unsigned long visited_states;
161 unsigned long visited_pairs;
162 unsigned long expanded_states;
163 unsigned long expanded_pairs;
164 unsigned long executed_transitions;
165 } s_mc_stats_t, *mc_stats_t;
167 extern mc_stats_t mc_stats;
169 void MC_print_statistics(mc_stats_t);
172 /********************************** MEMORY ******************************/
173 /* The possible memory modes for the modelchecker are standard and raw. */
174 /* Normally the system should operate in std, for switching to raw mode */
175 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
177 extern void *std_heap;
178 extern void *raw_heap;
181 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
182 /* an API to query about the status of a heap, we simply call mmstats and */
183 /* because I now how does structure looks like, then I redefine it here */
185 /* struct mstats { */
186 /* size_t bytes_total; /\* Total size of the heap. *\/ */
187 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
188 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
189 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
190 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
193 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
194 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
197 /******************************* MEMORY MAPPINGS ***************************/
198 /* These functions and data structures implements a binary interface for */
199 /* the proc maps ascii interface */
201 /* Each field is defined as documented in proc's manual page */
202 typedef struct s_map_region {
204 void *start_addr; /* Start address of the map */
205 void *end_addr; /* End address of the map */
206 int prot; /* Memory protection */
207 int flags; /* Additional memory flags */
208 void *offset; /* Offset in the file/whatever */
209 char dev_major; /* Major of the device */
210 char dev_minor; /* Minor of the device */
211 unsigned long inode; /* Inode in the device */
212 char *pathname; /* Path name of the mapped file */
216 typedef struct s_memory_map {
218 s_map_region_t *regions; /* Pointer to an array of regions */
219 int mapsize; /* Number of regions in the memory */
221 } s_memory_map_t, *memory_map_t;
224 void MC_init_memory_map_info(void);
225 memory_map_t MC_get_memory_map(void);
226 void MC_free_memory_map(memory_map_t map);
228 extern char *libsimgrid_path;
230 /********************************** Snapshot comparison **********************************/
232 typedef struct s_mc_comparison_times{
233 double nb_processes_comparison_time;
234 double bytes_used_comparison_time;
235 double stacks_sizes_comparison_time;
236 double binary_global_variables_comparison_time;
237 double libsimgrid_global_variables_comparison_time;
238 double heap_comparison_time;
239 double stacks_comparison_time;
240 double hash_global_variables_comparison_time;
241 double hash_local_variables_comparison_time;
242 }s_mc_comparison_times_t, *mc_comparison_times_t;
244 extern __thread mc_comparison_times_t mc_comp_times;
245 extern __thread double mc_snapshot_comparison_time;
247 int snapshot_compare(void *state1, void *state2);
248 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
249 void print_comparison_times(void);
255 /********************************** DPOR for safety property **************************************/
263 extern e_mc_reduce_t mc_reduce_kind;
264 extern mc_global_t initial_state_safety;
265 extern xbt_fifo_t mc_stack_safety;
266 extern xbt_dict_t first_enabled_state;
268 void MC_dpor_init(void);
271 typedef struct s_mc_visited_state{
272 mc_snapshot_t system_state;
273 size_t heap_bytes_used;
276 int other_num; // dot_output for
277 }s_mc_visited_state_t, *mc_visited_state_t;
280 /********************************** Double-DFS for liveness property **************************************/
282 extern xbt_fifo_t mc_stack_liveness;
283 extern mc_global_t initial_state_liveness;
284 extern xbt_automaton_t _mc_property_automaton;
286 extern xbt_dynar_t mc_stack_comparison_ignore;
287 extern xbt_dynar_t mc_data_bss_comparison_ignore;
289 typedef struct s_mc_pair{
292 mc_state_t graph_state; /* System state included */
293 xbt_automaton_state_t automaton_state;
294 xbt_dynar_t atomic_propositions;
296 }s_mc_pair_t, *mc_pair_t;
298 typedef struct s_mc_visited_pair{
300 int other_num; /* Dot output for */
302 mc_state_t graph_state; /* System state included */
303 xbt_automaton_state_t automaton_state;
304 xbt_dynar_t atomic_propositions;
305 size_t heap_bytes_used;
307 int acceptance_removed;
309 }s_mc_visited_pair_t, *mc_visited_pair_t;
311 mc_pair_t MC_pair_new(void);
312 void MC_pair_delete(mc_pair_t);
313 void mc_pair_free_voidp(void *p);
314 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
315 void MC_visited_pair_delete(mc_visited_pair_t p);
317 void MC_ddfs_init(void);
319 void MC_show_stack_liveness(xbt_fifo_t stack);
320 void MC_dump_stack_liveness(xbt_fifo_t stack);
323 /********************************** Variables with DWARF **********************************/
325 struct s_mc_object_info {
327 char *start_exec, *end_exec; // Executable segment
328 char *start_rw, *end_rw; // Read-write segment
329 char *start_ro, *end_ro; // read-only segment
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 types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
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 void MC_dwarf_get_variables(mc_object_info_t info);
341 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
342 const char* MC_dwarf_attrname(int attr);
343 const char* MC_dwarf_tagname(int tag);
345 extern mc_object_info_t mc_libsimgrid_info;
346 extern mc_object_info_t mc_binary_info;
362 } e_dw_location_type;
364 typedef struct s_dw_location{
365 e_dw_location_type type;
383 unsigned short int deref_size;
391 long unsigned int value;
396 long signed int value;
399 unsigned int plus_uconst;
402 }s_dw_location_t, *dw_location_t;
404 typedef struct s_dw_location_entry{
407 dw_location_t location;
408 }s_dw_location_entry_t, *dw_location_entry_t;
410 typedef struct s_dw_variable{
411 Dwarf_Off dwarf_offset; /* Global offset of the field. */
416 dw_location_t location; // For global==0
417 void *address; // For global!=0
419 }s_dw_variable_t, *dw_variable_t;
421 typedef struct s_dw_frame{
425 dw_location_t frame_base;
426 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
427 unsigned long int start; /* DWARF offset of the subprogram */
428 unsigned long int end; /* Dwarf offset of the next sibling */
429 }s_dw_frame_t, *dw_frame_t;
431 void dw_type_free(dw_type_t t);
432 void dw_variable_free(dw_variable_t v);
433 void dw_variable_free_voidp(void *t);
435 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
436 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
437 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
438 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
440 /********************************** DWARF **********************************/
442 Dwarf_Off MC_dwarf_resolve_location(unw_cursor_t* c, dw_location_t location, void* frame_pointer_address);
443 void* mc_find_frame_base(unw_word_t ip, dw_frame_t frame, unw_cursor_t* unw_cursor);
445 /********************************** Miscellaneous **********************************/
447 typedef struct s_local_variable{
454 }s_local_variable_t, *local_variable_t;
456 /********************************* Communications pattern ***************************/
458 typedef struct s_mc_comm_pattern{
461 e_smx_comm_type_t type;
463 unsigned long src_proc;
464 unsigned long dst_proc;
469 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
471 extern xbt_dynar_t communications_pattern;
473 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
475 /* *********** Sets *********** */
477 typedef struct s_mc_address_set *mc_address_set_t;
479 mc_address_set_t mc_address_set_new();
480 mc_address_set_t mc_address_set_free(mc_address_set_t* p);
481 void mc_address_add(mc_address_set_t p, const void* value);
482 bool mc_address_test(mc_address_set_t p, const void* value);
484 /* *********** Hash *********** */
486 uint64_t mc_hash_processes_state(int num_state);
488 #define MC_USE_SNAPSHOT_HASH 1