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);
98 /** \brief Translate a pointer from process address space to snapshot address space
100 * The address space contains snapshot of the main/application memory:
101 * this function finds the address in a given snaphot for a given
102 * real/application address.
104 * For read only memory regions and other regions which are not int the
105 * snapshot, the address is not changed.
107 * \param addr Application address
108 * \param snapshot The snapshot of interest (if NULL no translation is done)
109 * \return Translated address in the snapshot address space
111 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot);
113 /** \brief Translate a pointer from the snapshot address space to the application address space
115 * This is the inverse of mc_translate_address.
117 * \param addr Address in the snapshot address space
118 * \param snapsot Snapshot of interest (if NULL no translation is done)
119 * \return Translated address in the application address space
121 uintptr_t mc_untranslate_address(void* addr, mc_snapshot_t snapshot);
123 extern xbt_dynar_t mc_checkpoint_ignore;
125 /********************************* MC Global **********************************/
127 extern double *mc_time;
128 extern FILE *dot_output;
129 extern const char* colors[13];
130 extern xbt_parmap_t parmap;
132 extern int user_max_depth_reached;
134 int MC_deadlock_check(void);
135 void MC_replay(xbt_fifo_t stack, int start);
136 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
137 void MC_wait_for_requests(void);
138 void MC_show_deadlock(smx_simcall_t req);
139 void MC_show_stack_safety(xbt_fifo_t stack);
140 void MC_dump_stack_safety(xbt_fifo_t stack);
142 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
145 /********************************* Requests ***********************************/
147 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
148 char* MC_request_to_string(smx_simcall_t req, int value);
149 unsigned int MC_request_testany_fail(smx_simcall_t req);
150 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
151 int MC_request_is_visible(smx_simcall_t req);
152 int MC_request_is_enabled(smx_simcall_t req);
153 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
154 int MC_process_is_enabled(smx_process_t process);
155 char *MC_request_get_dot_output(smx_simcall_t req, int value);
158 /******************************** States **************************************/
160 /* Possible exploration status of a process in a state */
162 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
163 MC_INTERLEAVE, /* Interleave the process (one or more request) */
164 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
165 MC_DONE /* Already interleaved */
166 } e_mc_process_state_t;
168 /* On every state, each process has an entry of the following type */
169 typedef struct mc_procstate{
170 e_mc_process_state_t state; /* Exploration control information */
171 unsigned int interleave_count; /* Number of times that the process was
173 } s_mc_procstate_t, *mc_procstate_t;
175 /* An exploration state is composed of: */
176 typedef struct mc_state {
177 unsigned long max_pid; /* Maximum pid at state's creation time */
178 mc_procstate_t proc_status; /* State's exploration status by process */
179 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
180 s_smx_simcall_t internal_req; /* Internal translation of request */
181 s_smx_simcall_t executed_req; /* The executed request of the state */
182 int req_num; /* The request number (in the case of a
183 multi-request like waitany ) */
184 mc_snapshot_t system_state; /* Snapshot of system state */
186 } s_mc_state_t, *mc_state_t;
188 mc_state_t MC_state_new(void);
189 void MC_state_delete(mc_state_t state);
190 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
191 unsigned int MC_state_interleave_size(mc_state_t state);
192 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
193 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
194 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
195 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
196 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
197 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
200 /****************************** Statistics ************************************/
202 typedef struct mc_stats {
203 unsigned long state_size;
204 unsigned long visited_states;
205 unsigned long visited_pairs;
206 unsigned long expanded_states;
207 unsigned long expanded_pairs;
208 unsigned long executed_transitions;
209 } s_mc_stats_t, *mc_stats_t;
211 extern mc_stats_t mc_stats;
213 void MC_print_statistics(mc_stats_t);
216 /********************************** MEMORY ******************************/
217 /* The possible memory modes for the modelchecker are standard and raw. */
218 /* Normally the system should operate in std, for switching to raw mode */
219 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
221 extern void *std_heap;
222 extern void *raw_heap;
225 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
226 /* an API to query about the status of a heap, we simply call mmstats and */
227 /* because I now how does structure looks like, then I redefine it here */
229 /* struct mstats { */
230 /* size_t bytes_total; /\* Total size of the heap. *\/ */
231 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
232 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
233 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
234 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
237 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
238 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
241 /******************************* MEMORY MAPPINGS ***************************/
242 /* These functions and data structures implements a binary interface for */
243 /* the proc maps ascii interface */
245 /* Each field is defined as documented in proc's manual page */
246 typedef struct s_map_region {
248 void *start_addr; /* Start address of the map */
249 void *end_addr; /* End address of the map */
250 int prot; /* Memory protection */
251 int flags; /* Additional memory flags */
252 void *offset; /* Offset in the file/whatever */
253 char dev_major; /* Major of the device */
254 char dev_minor; /* Minor of the device */
255 unsigned long inode; /* Inode in the device */
256 char *pathname; /* Path name of the mapped file */
260 typedef struct s_memory_map {
262 s_map_region_t *regions; /* Pointer to an array of regions */
263 int mapsize; /* Number of regions in the memory */
265 } s_memory_map_t, *memory_map_t;
268 void MC_init_memory_map_info(void);
269 memory_map_t MC_get_memory_map(void);
270 void MC_free_memory_map(memory_map_t map);
272 extern char *libsimgrid_path;
274 /********************************** Snapshot comparison **********************************/
276 typedef struct s_mc_comparison_times{
277 double nb_processes_comparison_time;
278 double bytes_used_comparison_time;
279 double stacks_sizes_comparison_time;
280 double binary_global_variables_comparison_time;
281 double libsimgrid_global_variables_comparison_time;
282 double heap_comparison_time;
283 double stacks_comparison_time;
284 }s_mc_comparison_times_t, *mc_comparison_times_t;
286 extern __thread mc_comparison_times_t mc_comp_times;
287 extern __thread double mc_snapshot_comparison_time;
289 int snapshot_compare(void *state1, void *state2);
290 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
291 void print_comparison_times(void);
296 /********************************** DPOR for safety property **************************************/
304 extern e_mc_reduce_t mc_reduce_kind;
305 extern mc_global_t initial_state_safety;
306 extern xbt_fifo_t mc_stack_safety;
307 extern xbt_dict_t first_enabled_state;
309 void MC_dpor_init(void);
312 typedef struct s_mc_visited_state{
313 mc_snapshot_t system_state;
314 size_t heap_bytes_used;
317 int other_num; // dot_output for
318 }s_mc_visited_state_t, *mc_visited_state_t;
321 /********************************** Double-DFS for liveness property **************************************/
323 extern xbt_fifo_t mc_stack_liveness;
324 extern mc_global_t initial_state_liveness;
325 extern xbt_automaton_t _mc_property_automaton;
328 typedef struct s_mc_pair{
331 mc_state_t graph_state; /* System state included */
332 xbt_automaton_state_t automaton_state;
333 xbt_dynar_t atomic_propositions;
335 }s_mc_pair_t, *mc_pair_t;
337 typedef struct s_mc_visited_pair{
339 int other_num; /* Dot output for */
341 mc_state_t graph_state; /* System state included */
342 xbt_automaton_state_t automaton_state;
343 xbt_dynar_t atomic_propositions;
344 size_t heap_bytes_used;
346 int acceptance_removed;
348 }s_mc_visited_pair_t, *mc_visited_pair_t;
350 mc_pair_t MC_pair_new(void);
351 void MC_pair_delete(mc_pair_t);
352 void mc_pair_free_voidp(void *p);
353 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
354 void MC_visited_pair_delete(mc_visited_pair_t p);
356 void MC_ddfs_init(void);
358 void MC_show_stack_liveness(xbt_fifo_t stack);
359 void MC_dump_stack_liveness(xbt_fifo_t stack);
362 /********************************** Variables with DWARF **********************************/
364 #define MC_OBJECT_INFO_EXECUTABLE 1
366 struct s_mc_object_info {
369 char *start_exec, *end_exec; // Executable segment
370 char *start_rw, *end_rw; // Read-write segment
371 char *start_ro, *end_ro; // read-only segment
372 xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
373 xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
374 xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
375 xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
377 // Here we sort the minimal information for an efficient (and cache-efficient)
378 // lookup of a function given an instruction pointer.
379 // The entries are sorted by low_pc and a binary search can be used to look them up.
380 xbt_dynar_t functions_index;
383 mc_object_info_t MC_new_object_info(void);
384 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
385 void MC_free_object_info(mc_object_info_t* p);
387 void MC_dwarf_get_variables(mc_object_info_t info);
388 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
389 const char* MC_dwarf_attrname(int attr);
390 const char* MC_dwarf_tagname(int tag);
392 dw_frame_t MC_find_function_by_ip(void* ip);
393 mc_object_info_t MC_ip_find_object_info(void* ip);
395 extern mc_object_info_t mc_libsimgrid_info;
396 extern mc_object_info_t mc_binary_info;
397 extern mc_object_info_t mc_object_infos[2];
398 extern size_t mc_object_infos_size;
400 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
401 void MC_post_process_types(mc_object_info_t info);
405 /** \brief a DWARF expression with optional validity contraints */
406 typedef struct s_mc_expression {
409 // Optional validity:
410 void* lowpc, *highpc;
411 } s_mc_expression_t, *mc_expression_t;
413 /** A location list (list of location expressions) */
414 typedef struct s_mc_location_list {
416 mc_expression_t locations;
417 } s_mc_location_list_t, *mc_location_list_t;
419 Dwarf_Off mc_dwarf_resolve_location(mc_expression_t expression, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot);
420 Dwarf_Off mc_dwarf_resolve_locations(mc_location_list_t locations, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot);
422 void mc_dwarf_expression_clear(mc_expression_t expression);
423 void mc_dwarf_expression_init(mc_expression_t expression, size_t len, Dwarf_Op* ops);
425 void mc_dwarf_location_list_clear(mc_location_list_t list);
427 void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
428 void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
430 // ***** Variables and functions
434 void *id; /* Offset in the section (in hexadecimal form) */
435 char *name; /* Name of the type */
436 int byte_size; /* Size in bytes */
437 int element_count; /* Number of elements for array type */
438 char *dw_type_id; /* DW_AT_type id */
439 xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
442 // Location (for members) is either of:
443 struct s_mc_expression location;
446 dw_type_t subtype; // DW_AT_type
447 dw_type_t full_type; // The same (but more complete) type
450 void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
451 void* mc_member_snapshot_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
453 typedef struct s_dw_variable{
454 Dwarf_Off dwarf_offset; /* Global offset of the field. */
461 s_mc_location_list_t locations;
466 }s_dw_variable_t, *dw_variable_t;
473 s_mc_location_list_t frame_base;
474 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
475 unsigned long int start; /* DWARF offset of the subprogram */
476 xbt_dynar_t /* <dw_frame_t> */ scopes;
479 struct s_mc_function_index_item {
480 void* low_pc, *high_pc;
484 void mc_frame_free(dw_frame_t freme);
486 void dw_type_free(dw_type_t t);
487 void dw_variable_free(dw_variable_t v);
488 void dw_variable_free_voidp(void *t);
490 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
491 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
492 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
493 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
494 void* MC_object_base_address(mc_object_info_t info);
496 /********************************** DWARF **********************************/
498 #define MC_EXPRESSION_STACK_SIZE 64
500 #define MC_EXPRESSION_OK 0
501 #define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
502 #define MC_EXPRESSION_E_STACK_OVERFLOW 2
503 #define MC_EXPRESSION_E_STACK_UNDERFLOW 3
504 #define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
505 #define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
507 typedef struct s_mc_expression_state {
508 uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
511 unw_cursor_t* cursor;
513 mc_snapshot_t snapshot;
514 } s_mc_expression_state_t, *mc_expression_state_t;
516 int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
518 void* mc_find_frame_base(dw_frame_t frame, unw_cursor_t* unw_cursor);
520 /********************************** Miscellaneous **********************************/
522 typedef struct s_local_variable{
529 }s_local_variable_t, *local_variable_t;
531 /********************************* Communications pattern ***************************/
533 typedef struct s_mc_comm_pattern{
536 e_smx_comm_type_t type;
538 unsigned long src_proc;
539 unsigned long dst_proc;
540 const char *src_host;
541 const char *dst_host;
546 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
548 extern xbt_dynar_t communications_pattern;
550 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
552 /* *********** Sets *********** */
554 typedef struct s_mc_address_set *mc_address_set_t;
556 mc_address_set_t mc_address_set_new();
557 void mc_address_set_free(mc_address_set_t* p);
558 void mc_address_add(mc_address_set_t p, const void* value);
559 bool mc_address_test(mc_address_set_t p, const void* value);
561 /* *********** Hash *********** */
563 /** \brief Hash the current state
564 * \param num_state number of states
565 * \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
566 * \result resulting hash
568 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);