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 typedef struct s_dw_frame s_dw_frame_t, *dw_frame_t;
32 typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
34 /****************************** Snapshots ***********************************/
36 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
38 typedef struct s_mc_mem_region{
42 } s_mc_mem_region_t, *mc_mem_region_t;
44 typedef struct s_mc_snapshot{
45 size_t heap_bytes_used;
46 mc_mem_region_t regions[NB_REGIONS];
50 xbt_dynar_t to_ignore;
52 } s_mc_snapshot_t, *mc_snapshot_t;
54 /** Information about a given stack frame
57 typedef struct s_mc_stack_frame {
58 /** Instruction pointer */
62 unw_word_t frame_base;
65 unw_cursor_t unw_cursor;
66 } s_mc_stack_frame_t, *mc_stack_frame_t;
68 typedef struct s_mc_snapshot_stack{
69 xbt_dynar_t local_variables;
72 xbt_dynar_t stack_frames; // mc_stack_frame_t
73 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
75 typedef struct s_mc_global_t{
76 mc_snapshot_t snapshot;
80 int initial_communications_pattern_done;
81 int comm_deterministic;
82 int send_deterministic;
83 }s_mc_global_t, *mc_global_t;
85 typedef struct s_mc_checkpoint_ignore_region{
88 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
90 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
91 mc_snapshot_t MC_take_snapshot(int num_state);
92 void MC_restore_snapshot(mc_snapshot_t);
93 void MC_free_snapshot(mc_snapshot_t);
95 extern xbt_dynar_t mc_checkpoint_ignore;
97 /********************************* MC Global **********************************/
99 extern double *mc_time;
100 extern FILE *dot_output;
101 extern const char* colors[13];
102 extern xbt_parmap_t parmap;
104 extern int user_max_depth_reached;
106 int MC_deadlock_check(void);
107 void MC_replay(xbt_fifo_t stack, int start);
108 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
109 void MC_wait_for_requests(void);
110 void MC_show_deadlock(smx_simcall_t req);
111 void MC_show_stack_safety(xbt_fifo_t stack);
112 void MC_dump_stack_safety(xbt_fifo_t stack);
114 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
117 /********************************* Requests ***********************************/
119 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
120 char* MC_request_to_string(smx_simcall_t req, int value);
121 unsigned int MC_request_testany_fail(smx_simcall_t req);
122 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
123 int MC_request_is_visible(smx_simcall_t req);
124 int MC_request_is_enabled(smx_simcall_t req);
125 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
126 int MC_process_is_enabled(smx_process_t process);
127 char *MC_request_get_dot_output(smx_simcall_t req, int value);
130 /******************************** States **************************************/
132 /* Possible exploration status of a process in a state */
134 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
135 MC_INTERLEAVE, /* Interleave the process (one or more request) */
136 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
137 MC_DONE /* Already interleaved */
138 } e_mc_process_state_t;
140 /* On every state, each process has an entry of the following type */
141 typedef struct mc_procstate{
142 e_mc_process_state_t state; /* Exploration control information */
143 unsigned int interleave_count; /* Number of times that the process was
145 } s_mc_procstate_t, *mc_procstate_t;
147 /* An exploration state is composed of: */
148 typedef struct mc_state {
149 unsigned long max_pid; /* Maximum pid at state's creation time */
150 mc_procstate_t proc_status; /* State's exploration status by process */
151 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
152 s_smx_simcall_t internal_req; /* Internal translation of request */
153 s_smx_simcall_t executed_req; /* The executed request of the state */
154 int req_num; /* The request number (in the case of a
155 multi-request like waitany ) */
156 mc_snapshot_t system_state; /* Snapshot of system state */
158 } s_mc_state_t, *mc_state_t;
160 mc_state_t MC_state_new(void);
161 void MC_state_delete(mc_state_t state);
162 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
163 unsigned int MC_state_interleave_size(mc_state_t state);
164 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
165 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
166 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
167 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
168 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
169 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
172 /****************************** Statistics ************************************/
174 typedef struct mc_stats {
175 unsigned long state_size;
176 unsigned long visited_states;
177 unsigned long visited_pairs;
178 unsigned long expanded_states;
179 unsigned long expanded_pairs;
180 unsigned long executed_transitions;
181 } s_mc_stats_t, *mc_stats_t;
183 extern mc_stats_t mc_stats;
185 void MC_print_statistics(mc_stats_t);
188 /********************************** MEMORY ******************************/
189 /* The possible memory modes for the modelchecker are standard and raw. */
190 /* Normally the system should operate in std, for switching to raw mode */
191 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
193 extern void *std_heap;
194 extern void *raw_heap;
197 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
198 /* an API to query about the status of a heap, we simply call mmstats and */
199 /* because I now how does structure looks like, then I redefine it here */
201 /* struct mstats { */
202 /* size_t bytes_total; /\* Total size of the heap. *\/ */
203 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
204 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
205 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
206 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
209 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
210 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
213 /******************************* MEMORY MAPPINGS ***************************/
214 /* These functions and data structures implements a binary interface for */
215 /* the proc maps ascii interface */
217 /* Each field is defined as documented in proc's manual page */
218 typedef struct s_map_region {
220 void *start_addr; /* Start address of the map */
221 void *end_addr; /* End address of the map */
222 int prot; /* Memory protection */
223 int flags; /* Additional memory flags */
224 void *offset; /* Offset in the file/whatever */
225 char dev_major; /* Major of the device */
226 char dev_minor; /* Minor of the device */
227 unsigned long inode; /* Inode in the device */
228 char *pathname; /* Path name of the mapped file */
232 typedef struct s_memory_map {
234 s_map_region_t *regions; /* Pointer to an array of regions */
235 int mapsize; /* Number of regions in the memory */
237 } s_memory_map_t, *memory_map_t;
240 void MC_init_memory_map_info(void);
241 memory_map_t MC_get_memory_map(void);
242 void MC_free_memory_map(memory_map_t map);
244 extern char *libsimgrid_path;
246 /********************************** Snapshot comparison **********************************/
248 typedef struct s_mc_comparison_times{
249 double nb_processes_comparison_time;
250 double bytes_used_comparison_time;
251 double stacks_sizes_comparison_time;
252 double binary_global_variables_comparison_time;
253 double libsimgrid_global_variables_comparison_time;
254 double heap_comparison_time;
255 double stacks_comparison_time;
256 }s_mc_comparison_times_t, *mc_comparison_times_t;
258 extern __thread mc_comparison_times_t mc_comp_times;
259 extern __thread double mc_snapshot_comparison_time;
261 int snapshot_compare(void *state1, void *state2);
262 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
263 void print_comparison_times(void);
268 /********************************** DPOR for safety property **************************************/
276 extern e_mc_reduce_t mc_reduce_kind;
277 extern mc_global_t initial_state_safety;
278 extern xbt_fifo_t mc_stack_safety;
279 extern xbt_dict_t first_enabled_state;
281 void MC_dpor_init(void);
284 typedef struct s_mc_visited_state{
285 mc_snapshot_t system_state;
286 size_t heap_bytes_used;
289 int other_num; // dot_output for
290 }s_mc_visited_state_t, *mc_visited_state_t;
293 /********************************** Double-DFS for liveness property **************************************/
295 extern xbt_fifo_t mc_stack_liveness;
296 extern mc_global_t initial_state_liveness;
297 extern xbt_automaton_t _mc_property_automaton;
300 typedef struct s_mc_pair{
303 mc_state_t graph_state; /* System state included */
304 xbt_automaton_state_t automaton_state;
305 xbt_dynar_t atomic_propositions;
307 }s_mc_pair_t, *mc_pair_t;
309 typedef struct s_mc_visited_pair{
311 int other_num; /* Dot output for */
313 mc_state_t graph_state; /* System state included */
314 xbt_automaton_state_t automaton_state;
315 xbt_dynar_t atomic_propositions;
316 size_t heap_bytes_used;
318 int acceptance_removed;
320 }s_mc_visited_pair_t, *mc_visited_pair_t;
322 mc_pair_t MC_pair_new(void);
323 void MC_pair_delete(mc_pair_t);
324 void mc_pair_free_voidp(void *p);
325 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
326 void MC_visited_pair_delete(mc_visited_pair_t p);
328 void MC_ddfs_init(void);
330 void MC_show_stack_liveness(xbt_fifo_t stack);
331 void MC_dump_stack_liveness(xbt_fifo_t stack);
334 /********************************** Variables with DWARF **********************************/
336 #define MC_OBJECT_INFO_EXECUTABLE 1
338 struct s_mc_object_info {
341 char *start_exec, *end_exec; // Executable segment
342 char *start_rw, *end_rw; // Read-write segment
343 char *start_ro, *end_ro; // read-only segment
344 xbt_dict_t local_variables; // xbt_dict_t<frame_name, dw_frame_t>
345 xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
346 xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
347 xbt_dict_t types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
349 // Here we sort the minimal information for an efficient (and cache-efficient)
350 // lookup of a function given an instruction pointer.
351 // The entries are sorted by low_pc and a binary search can be used to look them up.
352 xbt_dynar_t functions_index;
355 mc_object_info_t MC_new_object_info(void);
356 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
357 void MC_free_object_info(mc_object_info_t* p);
359 void MC_dwarf_get_variables(mc_object_info_t info);
360 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
361 const char* MC_dwarf_attrname(int attr);
362 const char* MC_dwarf_tagname(int tag);
364 dw_frame_t MC_find_function_by_ip(void* ip);
365 mc_object_info_t MC_ip_find_object_info(void* ip);
367 extern mc_object_info_t mc_libsimgrid_info;
368 extern mc_object_info_t mc_binary_info;
370 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
371 void MC_post_process_types(mc_object_info_t info);
387 } e_dw_location_type;
389 typedef struct s_dw_location{
390 e_dw_location_type type;
408 unsigned short int deref_size;
416 long unsigned int value;
421 long signed int value;
424 unsigned int plus_uconst;
427 }s_dw_location_t, *dw_location_t;
429 typedef struct s_dw_location_entry{
432 dw_location_t location;
433 }s_dw_location_entry_t, *dw_location_entry_t;
435 typedef struct s_dw_variable{
436 Dwarf_Off dwarf_offset; /* Global offset of the field. */
443 dw_location_t location;
446 }s_dw_variable_t, *dw_variable_t;
452 dw_location_t frame_base;
453 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
454 unsigned long int start; /* DWARF offset of the subprogram */
455 unsigned long int end; /* Dwarf offset of the next sibling */
458 struct s_mc_function_index_item {
459 void* low_pc, *high_pc;
463 void dw_type_free(dw_type_t t);
464 void dw_variable_free(dw_variable_t v);
465 void dw_variable_free_voidp(void *t);
467 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
468 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
469 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
470 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
471 void* MC_object_base_address(mc_object_info_t info);
473 /********************************** DWARF **********************************/
475 Dwarf_Off MC_dwarf_resolve_location(unw_cursor_t* c, dw_location_t location, void* frame_pointer_address);
476 void* mc_find_frame_base(void* ip, dw_frame_t frame, unw_cursor_t* unw_cursor);
478 /********************************** Miscellaneous **********************************/
480 typedef struct s_local_variable{
487 }s_local_variable_t, *local_variable_t;
489 /********************************* Communications pattern ***************************/
491 typedef struct s_mc_comm_pattern{
494 e_smx_comm_type_t type;
496 unsigned long src_proc;
497 unsigned long dst_proc;
498 const char *src_host;
499 const char *dst_host;
504 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
506 extern xbt_dynar_t communications_pattern;
508 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
510 /* *********** Sets *********** */
512 typedef struct s_mc_address_set *mc_address_set_t;
514 mc_address_set_t mc_address_set_new();
515 mc_address_set_t mc_address_set_free(mc_address_set_t* p);
516 void mc_address_add(mc_address_set_t p, const void* value);
517 bool mc_address_test(mc_address_set_t p, const void* value);
519 /* *********** Hash *********** */
521 /** \brief Hash the current state
522 * \param num_state number of states
523 * \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
524 * \result resulting hash
526 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);