1 /* Copyright (c) 2007-2014. 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{
43 // Size of the data region:
45 } s_mc_mem_region_t, *mc_mem_region_t;
47 typedef struct s_mc_snapshot{
48 size_t heap_bytes_used;
49 mc_mem_region_t regions[NB_REGIONS];
53 xbt_dynar_t to_ignore;
55 } s_mc_snapshot_t, *mc_snapshot_t;
57 /** Information about a given stack frame
60 typedef struct s_mc_stack_frame {
61 /** Instruction pointer */
65 unw_word_t frame_base;
68 unw_cursor_t unw_cursor;
69 } s_mc_stack_frame_t, *mc_stack_frame_t;
71 typedef struct s_mc_snapshot_stack{
72 xbt_dynar_t local_variables;
75 xbt_dynar_t stack_frames; // mc_stack_frame_t
76 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
78 typedef struct s_mc_global_t{
79 mc_snapshot_t snapshot;
83 int initial_communications_pattern_done;
84 int comm_deterministic;
85 int send_deterministic;
86 }s_mc_global_t, *mc_global_t;
88 typedef struct s_mc_checkpoint_ignore_region{
91 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
93 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
94 mc_snapshot_t MC_take_snapshot(int num_state);
95 void MC_restore_snapshot(mc_snapshot_t);
96 void MC_free_snapshot(mc_snapshot_t);
97 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot);
99 extern xbt_dynar_t mc_checkpoint_ignore;
101 /********************************* MC Global **********************************/
103 extern double *mc_time;
104 extern FILE *dot_output;
105 extern const char* colors[13];
106 extern xbt_parmap_t parmap;
108 extern int user_max_depth_reached;
110 int MC_deadlock_check(void);
111 void MC_replay(xbt_fifo_t stack, int start);
112 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
113 void MC_wait_for_requests(void);
114 void MC_show_deadlock(smx_simcall_t req);
115 void MC_show_stack_safety(xbt_fifo_t stack);
116 void MC_dump_stack_safety(xbt_fifo_t stack);
118 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
121 /********************************* Requests ***********************************/
123 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
124 char* MC_request_to_string(smx_simcall_t req, int value);
125 unsigned int MC_request_testany_fail(smx_simcall_t req);
126 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
127 int MC_request_is_visible(smx_simcall_t req);
128 int MC_request_is_enabled(smx_simcall_t req);
129 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
130 int MC_process_is_enabled(smx_process_t process);
131 char *MC_request_get_dot_output(smx_simcall_t req, int value);
134 /******************************** States **************************************/
136 /* Possible exploration status of a process in a state */
138 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
139 MC_INTERLEAVE, /* Interleave the process (one or more request) */
140 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
141 MC_DONE /* Already interleaved */
142 } e_mc_process_state_t;
144 /* On every state, each process has an entry of the following type */
145 typedef struct mc_procstate{
146 e_mc_process_state_t state; /* Exploration control information */
147 unsigned int interleave_count; /* Number of times that the process was
149 } s_mc_procstate_t, *mc_procstate_t;
151 /* An exploration state is composed of: */
152 typedef struct mc_state {
153 unsigned long max_pid; /* Maximum pid at state's creation time */
154 mc_procstate_t proc_status; /* State's exploration status by process */
155 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
156 s_smx_simcall_t internal_req; /* Internal translation of request */
157 s_smx_simcall_t executed_req; /* The executed request of the state */
158 int req_num; /* The request number (in the case of a
159 multi-request like waitany ) */
160 mc_snapshot_t system_state; /* Snapshot of system state */
162 } s_mc_state_t, *mc_state_t;
164 mc_state_t MC_state_new(void);
165 void MC_state_delete(mc_state_t state);
166 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
167 unsigned int MC_state_interleave_size(mc_state_t state);
168 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
169 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
170 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
171 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
172 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
173 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
176 /****************************** Statistics ************************************/
178 typedef struct mc_stats {
179 unsigned long state_size;
180 unsigned long visited_states;
181 unsigned long visited_pairs;
182 unsigned long expanded_states;
183 unsigned long expanded_pairs;
184 unsigned long executed_transitions;
185 } s_mc_stats_t, *mc_stats_t;
187 extern mc_stats_t mc_stats;
189 void MC_print_statistics(mc_stats_t);
192 /********************************** MEMORY ******************************/
193 /* The possible memory modes for the modelchecker are standard and raw. */
194 /* Normally the system should operate in std, for switching to raw mode */
195 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
197 extern void *std_heap;
198 extern void *raw_heap;
201 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
202 /* an API to query about the status of a heap, we simply call mmstats and */
203 /* because I now how does structure looks like, then I redefine it here */
205 /* struct mstats { */
206 /* size_t bytes_total; /\* Total size of the heap. *\/ */
207 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
208 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
209 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
210 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
213 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
214 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
217 /******************************* MEMORY MAPPINGS ***************************/
218 /* These functions and data structures implements a binary interface for */
219 /* the proc maps ascii interface */
221 /* Each field is defined as documented in proc's manual page */
222 typedef struct s_map_region {
224 void *start_addr; /* Start address of the map */
225 void *end_addr; /* End address of the map */
226 int prot; /* Memory protection */
227 int flags; /* Additional memory flags */
228 void *offset; /* Offset in the file/whatever */
229 char dev_major; /* Major of the device */
230 char dev_minor; /* Minor of the device */
231 unsigned long inode; /* Inode in the device */
232 char *pathname; /* Path name of the mapped file */
236 typedef struct s_memory_map {
238 s_map_region_t *regions; /* Pointer to an array of regions */
239 int mapsize; /* Number of regions in the memory */
241 } s_memory_map_t, *memory_map_t;
244 void MC_init_memory_map_info(void);
245 memory_map_t MC_get_memory_map(void);
246 void MC_free_memory_map(memory_map_t map);
248 extern char *libsimgrid_path;
250 /********************************** Snapshot comparison **********************************/
252 typedef struct s_mc_comparison_times{
253 double nb_processes_comparison_time;
254 double bytes_used_comparison_time;
255 double stacks_sizes_comparison_time;
256 double binary_global_variables_comparison_time;
257 double libsimgrid_global_variables_comparison_time;
258 double heap_comparison_time;
259 double stacks_comparison_time;
260 }s_mc_comparison_times_t, *mc_comparison_times_t;
262 extern __thread mc_comparison_times_t mc_comp_times;
263 extern __thread double mc_snapshot_comparison_time;
265 int snapshot_compare(void *state1, void *state2);
266 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
267 void print_comparison_times(void);
272 /********************************** DPOR for safety property **************************************/
280 extern e_mc_reduce_t mc_reduce_kind;
281 extern mc_global_t initial_state_safety;
282 extern xbt_fifo_t mc_stack_safety;
283 extern xbt_dict_t first_enabled_state;
285 void MC_dpor_init(void);
288 typedef struct s_mc_visited_state{
289 mc_snapshot_t system_state;
290 size_t heap_bytes_used;
293 int other_num; // dot_output for
294 }s_mc_visited_state_t, *mc_visited_state_t;
297 /********************************** Double-DFS for liveness property **************************************/
299 extern xbt_fifo_t mc_stack_liveness;
300 extern mc_global_t initial_state_liveness;
301 extern xbt_automaton_t _mc_property_automaton;
304 typedef struct s_mc_pair{
307 mc_state_t graph_state; /* System state included */
308 xbt_automaton_state_t automaton_state;
309 xbt_dynar_t atomic_propositions;
311 }s_mc_pair_t, *mc_pair_t;
313 typedef struct s_mc_visited_pair{
315 int other_num; /* Dot output for */
317 mc_state_t graph_state; /* System state included */
318 xbt_automaton_state_t automaton_state;
319 xbt_dynar_t atomic_propositions;
320 size_t heap_bytes_used;
322 int acceptance_removed;
324 }s_mc_visited_pair_t, *mc_visited_pair_t;
326 mc_pair_t MC_pair_new(void);
327 void MC_pair_delete(mc_pair_t);
328 void mc_pair_free_voidp(void *p);
329 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
330 void MC_visited_pair_delete(mc_visited_pair_t p);
332 void MC_ddfs_init(void);
334 void MC_show_stack_liveness(xbt_fifo_t stack);
335 void MC_dump_stack_liveness(xbt_fifo_t stack);
338 /********************************** Variables with DWARF **********************************/
340 #define MC_OBJECT_INFO_EXECUTABLE 1
342 struct s_mc_object_info {
345 char *start_exec, *end_exec; // Executable segment
346 char *start_rw, *end_rw; // Read-write segment
347 char *start_ro, *end_ro; // read-only segment
348 xbt_dynar_t subprograms; // xbt_dynar_t<dw_frame_t>
349 xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
350 xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
351 xbt_dict_t types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
353 // Here we sort the minimal information for an efficient (and cache-efficient)
354 // lookup of a function given an instruction pointer.
355 // The entries are sorted by low_pc and a binary search can be used to look them up.
356 xbt_dynar_t functions_index;
359 mc_object_info_t MC_new_object_info(void);
360 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
361 void MC_free_object_info(mc_object_info_t* p);
363 void MC_dwarf_get_variables(mc_object_info_t info);
364 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
365 const char* MC_dwarf_attrname(int attr);
366 const char* MC_dwarf_tagname(int tag);
368 dw_frame_t MC_find_function_by_ip(void* ip);
369 mc_object_info_t MC_ip_find_object_info(void* ip);
371 extern mc_object_info_t mc_libsimgrid_info;
372 extern mc_object_info_t mc_binary_info;
374 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
375 void MC_post_process_types(mc_object_info_t info);
379 /** \brief a DWARF expression with optional validity contraints */
380 typedef struct s_mc_expression {
383 // Optional validity:
384 void* lowpc, *highpc;
385 } s_mc_expression_t, *mc_expression_t;
387 /** A location list (list of location expressions) */
388 typedef struct s_mc_location_list {
390 mc_expression_t locations;
391 } s_mc_location_list_t, *mc_location_list_t;
393 Dwarf_Off mc_dwarf_resolve_location(mc_expression_t expression, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot);
394 Dwarf_Off mc_dwarf_resolve_locations(mc_location_list_t locations, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot);
396 void mc_dwarf_location_list_clear(mc_location_list_t list);
398 void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
399 void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
401 // ***** Variables and functions
403 typedef struct s_dw_variable{
404 Dwarf_Off dwarf_offset; /* Global offset of the field. */
411 s_mc_location_list_t locations;
416 }s_dw_variable_t, *dw_variable_t;
422 s_mc_location_list_t frame_base;
423 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
424 unsigned long int start; /* DWARF offset of the subprogram */
425 unsigned long int end; /* Dwarf offset of the next sibling */
428 struct s_mc_function_index_item {
429 void* low_pc, *high_pc;
433 void dw_type_free(dw_type_t t);
434 void dw_variable_free(dw_variable_t v);
435 void dw_variable_free_voidp(void *t);
437 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
438 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
439 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
440 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
441 void* MC_object_base_address(mc_object_info_t info);
443 /********************************** DWARF **********************************/
445 #define MC_EXPRESSION_STACK_SIZE 64
447 #define MC_EXPRESSION_OK 0
448 #define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
449 #define MC_EXPRESSION_E_STACK_OVERFLOW 2
450 #define MC_EXPRESSION_E_STACK_UNDERFLOW 3
451 #define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
452 #define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
454 typedef struct s_mc_expression_state {
455 uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
458 unw_cursor_t* cursor;
460 mc_snapshot_t snapshot;
461 } s_mc_expression_state_t, *mc_expression_state_t;
463 int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
465 void* mc_find_frame_base(dw_frame_t frame, unw_cursor_t* unw_cursor);
467 /********************************** Miscellaneous **********************************/
469 typedef struct s_local_variable{
476 }s_local_variable_t, *local_variable_t;
478 /********************************* Communications pattern ***************************/
480 typedef struct s_mc_comm_pattern{
483 e_smx_comm_type_t type;
485 unsigned long src_proc;
486 unsigned long dst_proc;
487 const char *src_host;
488 const char *dst_host;
493 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
495 extern xbt_dynar_t communications_pattern;
497 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
499 /* *********** Sets *********** */
501 typedef struct s_mc_address_set *mc_address_set_t;
503 mc_address_set_t mc_address_set_new();
504 mc_address_set_t mc_address_set_free(mc_address_set_t* p);
505 void mc_address_add(mc_address_set_t p, const void* value);
506 bool mc_address_test(mc_address_set_t p, const void* value);
508 /* *********** Hash *********** */
510 /** \brief Hash the current state
511 * \param num_state number of states
512 * \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
513 * \result resulting hash
515 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);