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/mmalloc/mmprivate.h"
25 #include "xbt/automaton.h"
28 #include "msg/datatypes.h"
29 #include "xbt/strbuff.h"
30 #include "xbt/parmap.h"
32 typedef struct s_dw_frame s_dw_frame_t, *dw_frame_t;
33 typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
35 /****************************** Snapshots ***********************************/
37 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
39 typedef struct s_mc_mem_region{
44 // Size of the data region:
46 } s_mc_mem_region_t, *mc_mem_region_t;
50 * Some parts of the snapshot are ignored by zeroing them out: the real
51 * values is stored here.
53 typedef struct s_mc_snapshot_ignored_data {
57 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
59 typedef struct s_mc_snapshot{
60 size_t heap_bytes_used;
61 mc_mem_region_t regions[NB_REGIONS];
62 xbt_dynar_t enabled_processes;
63 mc_mem_region_t* privatization_regions;
64 int privatization_index;
67 xbt_dynar_t to_ignore;
69 xbt_dynar_t ignored_data;
70 } s_mc_snapshot_t, *mc_snapshot_t;
72 /** Information about a given stack frame
75 typedef struct s_mc_stack_frame {
76 /** Instruction pointer */
80 unw_word_t frame_base;
83 unw_cursor_t unw_cursor;
84 } s_mc_stack_frame_t, *mc_stack_frame_t;
86 typedef struct s_mc_snapshot_stack{
87 xbt_dynar_t local_variables;
90 xbt_dynar_t stack_frames; // mc_stack_frame_t
91 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
93 typedef struct s_mc_global_t{
94 mc_snapshot_t snapshot;
98 int initial_communications_pattern_done;
99 int comm_deterministic;
100 int send_deterministic;
101 }s_mc_global_t, *mc_global_t;
103 typedef struct s_mc_checkpoint_ignore_region{
106 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
108 inline static void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot) {
110 xbt_die("snapshot is NULL");
111 xbt_mheap_t heap = (xbt_mheap_t)snapshot->regions[0]->data;
112 return heap->breakval;
115 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
116 mc_snapshot_t MC_take_snapshot(int num_state);
117 void MC_restore_snapshot(mc_snapshot_t);
118 void MC_free_snapshot(mc_snapshot_t);
120 /** \brief Translate a pointer from process address space to snapshot address space
122 * The address space contains snapshot of the main/application memory:
123 * this function finds the address in a given snaphot for a given
124 * real/application address.
126 * For read only memory regions and other regions which are not int the
127 * snapshot, the address is not changed.
129 * \param addr Application address
130 * \param snapshot The snapshot of interest (if NULL no translation is done)
131 * \return Translated address in the snapshot address space
133 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot);
135 /** \brief Translate a pointer from the snapshot address space to the application address space
137 * This is the inverse of mc_translate_address.
139 * \param addr Address in the snapshot address space
140 * \param snapsot Snapshot of interest (if NULL no translation is done)
141 * \return Translated address in the application address space
143 uintptr_t mc_untranslate_address(void* addr, mc_snapshot_t snapshot);
145 extern xbt_dynar_t mc_checkpoint_ignore;
147 /********************************* MC Global **********************************/
149 extern double *mc_time;
150 extern FILE *dot_output;
151 extern const char* colors[13];
152 extern xbt_parmap_t parmap;
154 extern int user_max_depth_reached;
156 int MC_deadlock_check(void);
157 void MC_replay(xbt_fifo_t stack, int start);
158 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
159 void MC_wait_for_requests(void);
160 void MC_show_deadlock(smx_simcall_t req);
161 void MC_show_stack_safety(xbt_fifo_t stack);
162 void MC_dump_stack_safety(xbt_fifo_t stack);
163 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
165 extern xbt_fifo_t mc_stack;
166 int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
169 /********************************* Requests ***********************************/
171 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
172 char* MC_request_to_string(smx_simcall_t req, int value);
173 unsigned int MC_request_testany_fail(smx_simcall_t req);
174 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
175 int MC_request_is_visible(smx_simcall_t req);
176 int MC_request_is_enabled(smx_simcall_t req);
177 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
178 int MC_process_is_enabled(smx_process_t process);
179 char *MC_request_get_dot_output(smx_simcall_t req, int value);
182 /******************************** States **************************************/
184 extern mc_global_t initial_global_state;
186 /* Possible exploration status of a process in a state */
188 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
189 MC_INTERLEAVE, /* Interleave the process (one or more request) */
190 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
191 MC_DONE /* Already interleaved */
192 } e_mc_process_state_t;
194 /* On every state, each process has an entry of the following type */
195 typedef struct mc_procstate{
196 e_mc_process_state_t state; /* Exploration control information */
197 unsigned int interleave_count; /* Number of times that the process was
199 } s_mc_procstate_t, *mc_procstate_t;
201 /* An exploration state is composed of: */
202 typedef struct mc_state {
203 unsigned long max_pid; /* Maximum pid at state's creation time */
204 mc_procstate_t proc_status; /* State's exploration status by process */
205 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
206 s_smx_simcall_t internal_req; /* Internal translation of request */
207 s_smx_simcall_t executed_req; /* The executed request of the state */
208 int req_num; /* The request number (in the case of a
209 multi-request like waitany ) */
210 mc_snapshot_t system_state; /* Snapshot of system state */
212 } s_mc_state_t, *mc_state_t;
214 mc_state_t MC_state_new(void);
215 void MC_state_delete(mc_state_t state);
216 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
217 unsigned int MC_state_interleave_size(mc_state_t state);
218 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
219 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
220 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
221 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
222 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
223 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
226 /****************************** Statistics ************************************/
228 typedef struct mc_stats {
229 unsigned long state_size;
230 unsigned long visited_states;
231 unsigned long visited_pairs;
232 unsigned long expanded_states;
233 unsigned long expanded_pairs;
234 unsigned long executed_transitions;
235 } s_mc_stats_t, *mc_stats_t;
237 extern mc_stats_t mc_stats;
239 void MC_print_statistics(mc_stats_t);
242 /********************************** MEMORY ******************************/
243 /* The possible memory modes for the modelchecker are standard and raw. */
244 /* Normally the system should operate in std, for switching to raw mode */
245 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
247 extern void *std_heap;
248 extern void *mc_heap;
251 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
252 /* an API to query about the status of a heap, we simply call mmstats and */
253 /* because I now how does structure looks like, then I redefine it here */
255 /* struct mstats { */
256 /* size_t bytes_total; /\* Total size of the heap. *\/ */
257 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
258 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
259 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
260 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
263 #define MC_SET_MC_HEAP mmalloc_set_current_heap(mc_heap)
264 #define MC_SET_STD_HEAP mmalloc_set_current_heap(std_heap)
267 /******************************* MEMORY MAPPINGS ***************************/
268 /* These functions and data structures implements a binary interface for */
269 /* the proc maps ascii interface */
271 /* Each field is defined as documented in proc's manual page */
272 typedef struct s_map_region {
274 void *start_addr; /* Start address of the map */
275 void *end_addr; /* End address of the map */
276 int prot; /* Memory protection */
277 int flags; /* Additional memory flags */
278 void *offset; /* Offset in the file/whatever */
279 char dev_major; /* Major of the device */
280 char dev_minor; /* Minor of the device */
281 unsigned long inode; /* Inode in the device */
282 char *pathname; /* Path name of the mapped file */
286 typedef struct s_memory_map {
288 s_map_region_t *regions; /* Pointer to an array of regions */
289 int mapsize; /* Number of regions in the memory */
291 } s_memory_map_t, *memory_map_t;
294 void MC_init_memory_map_info(void);
295 memory_map_t MC_get_memory_map(void);
296 void MC_free_memory_map(memory_map_t map);
298 extern char *libsimgrid_path;
300 /********************************** Snapshot comparison **********************************/
302 typedef struct s_mc_comparison_times{
303 double nb_processes_comparison_time;
304 double bytes_used_comparison_time;
305 double stacks_sizes_comparison_time;
306 double binary_global_variables_comparison_time;
307 double libsimgrid_global_variables_comparison_time;
308 double heap_comparison_time;
309 double stacks_comparison_time;
310 }s_mc_comparison_times_t, *mc_comparison_times_t;
312 extern __thread mc_comparison_times_t mc_comp_times;
313 extern __thread double mc_snapshot_comparison_time;
315 int snapshot_compare(void *state1, void *state2);
316 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
317 void print_comparison_times(void);
322 /********************************** Safety verification **************************************/
330 extern e_mc_reduce_t mc_reduce_kind;
331 extern xbt_dict_t first_enabled_state;
333 void MC_pre_modelcheck_safety(void);
334 void MC_modelcheck_safety(void);
336 typedef struct s_mc_visited_state{
337 mc_snapshot_t system_state;
338 size_t heap_bytes_used;
341 int other_num; // dot_output for
342 }s_mc_visited_state_t, *mc_visited_state_t;
344 extern xbt_dynar_t visited_states;
345 int is_visited_state(void);
346 void visited_state_free(mc_visited_state_t state);
347 void visited_state_free_voidp(void *s);
349 /********************************** Liveness verification **************************************/
351 extern xbt_automaton_t _mc_property_automaton;
353 typedef struct s_mc_pair{
356 mc_state_t graph_state; /* System state included */
357 xbt_automaton_state_t automaton_state;
358 xbt_dynar_t atomic_propositions;
360 }s_mc_pair_t, *mc_pair_t;
362 typedef struct s_mc_visited_pair{
364 int other_num; /* Dot output for */
366 mc_state_t graph_state; /* System state included */
367 xbt_automaton_state_t automaton_state;
368 xbt_dynar_t atomic_propositions;
369 size_t heap_bytes_used;
371 int acceptance_removed;
373 }s_mc_visited_pair_t, *mc_visited_pair_t;
375 mc_pair_t MC_pair_new(void);
376 void MC_pair_delete(mc_pair_t);
377 void mc_pair_free_voidp(void *p);
378 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
379 void MC_visited_pair_delete(mc_visited_pair_t p);
381 void MC_pre_modelcheck_liveness(void);
382 void MC_modelcheck_liveness(void);
383 void MC_show_stack_liveness(xbt_fifo_t stack);
384 void MC_dump_stack_liveness(xbt_fifo_t stack);
386 extern xbt_dynar_t visited_pairs;
387 int is_visited_pair(mc_visited_pair_t pair, int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
390 /********************************** Variables with DWARF **********************************/
392 #define MC_OBJECT_INFO_EXECUTABLE 1
394 struct s_mc_object_info {
397 char *start_exec, *end_exec; // Executable segment
398 char *start_rw, *end_rw; // Read-write segment
399 char *start_ro, *end_ro; // read-only segment
400 xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
401 xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
402 xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
403 xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
405 // Here we sort the minimal information for an efficient (and cache-efficient)
406 // lookup of a function given an instruction pointer.
407 // The entries are sorted by low_pc and a binary search can be used to look them up.
408 xbt_dynar_t functions_index;
411 mc_object_info_t MC_new_object_info(void);
412 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
413 void MC_free_object_info(mc_object_info_t* p);
415 void MC_dwarf_get_variables(mc_object_info_t info);
416 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
417 const char* MC_dwarf_attrname(int attr);
418 const char* MC_dwarf_tagname(int tag);
420 dw_frame_t MC_find_function_by_ip(void* ip);
421 mc_object_info_t MC_ip_find_object_info(void* ip);
423 extern mc_object_info_t mc_libsimgrid_info;
424 extern mc_object_info_t mc_binary_info;
425 extern mc_object_info_t mc_object_infos[2];
426 extern size_t mc_object_infos_size;
428 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
429 void MC_post_process_types(mc_object_info_t info);
430 void MC_post_process_object_info(mc_object_info_t info);
434 /** \brief a DWARF expression with optional validity contraints */
435 typedef struct s_mc_expression {
438 // Optional validity:
439 void* lowpc, *highpc;
440 } s_mc_expression_t, *mc_expression_t;
442 /** A location list (list of location expressions) */
443 typedef struct s_mc_location_list {
445 mc_expression_t locations;
446 } s_mc_location_list_t, *mc_location_list_t;
448 uintptr_t mc_dwarf_resolve_location(mc_expression_t expression, mc_object_info_t object_info, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot);
449 uintptr_t mc_dwarf_resolve_locations(mc_location_list_t locations, mc_object_info_t object_info, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot);
451 void mc_dwarf_expression_clear(mc_expression_t expression);
452 void mc_dwarf_expression_init(mc_expression_t expression, size_t len, Dwarf_Op* ops);
454 void mc_dwarf_location_list_clear(mc_location_list_t list);
456 void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
457 void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
459 // ***** Variables and functions
463 Dwarf_Off id; /* Offset in the section (in hexadecimal form) */
464 char *name; /* Name of the type */
465 int byte_size; /* Size in bytes */
466 int element_count; /* Number of elements for array type */
467 char *dw_type_id; /* DW_AT_type id */
468 xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
471 // Location (for members) is either of:
472 struct s_mc_expression location;
475 dw_type_t subtype; // DW_AT_type
476 dw_type_t full_type; // The same (but more complete) type
479 void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
480 void* mc_member_snapshot_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
482 typedef struct s_dw_variable{
483 Dwarf_Off dwarf_offset; /* Global offset of the field. */
490 s_mc_location_list_t locations;
494 mc_object_info_t object_info;
496 }s_dw_variable_t, *dw_variable_t;
503 s_mc_location_list_t frame_base;
504 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
505 unsigned long int id; /* DWARF offset of the subprogram */
506 xbt_dynar_t /* <dw_frame_t> */ scopes;
507 Dwarf_Off abstract_origin_id;
508 mc_object_info_t object_info;
511 struct s_mc_function_index_item {
512 void* low_pc, *high_pc;
516 void mc_frame_free(dw_frame_t freme);
518 void dw_type_free(dw_type_t t);
519 void dw_variable_free(dw_variable_t v);
520 void dw_variable_free_voidp(void *t);
522 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
523 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
524 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
525 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
527 /** Find the DWARF offset for this ELF object
529 * An offset is applied to address found in DWARF:
532 * <li>for an executable obejct, addresses are virtual address
533 * (there is no offset) i.e. \f$\text{virtual address} = \{dwarf address}\f$;</li>
534 * <li>for a shared object, the addreses are offset from the begining
535 * of the shared object (the base address of the mapped shared
536 * object must be used as offset
537 * i.e. \f$\text{virtual address} = \text{shared object base address}
538 * + \text{dwarf address}\f$.</li>
541 void* MC_object_base_address(mc_object_info_t info);
543 /********************************** DWARF **********************************/
545 #define MC_EXPRESSION_STACK_SIZE 64
547 #define MC_EXPRESSION_OK 0
548 #define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
549 #define MC_EXPRESSION_E_STACK_OVERFLOW 2
550 #define MC_EXPRESSION_E_STACK_UNDERFLOW 3
551 #define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
552 #define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
553 #define MC_EXPRESSION_E_NO_BASE_ADDRESS 6
555 typedef struct s_mc_expression_state {
556 uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
559 unw_cursor_t* cursor;
561 mc_snapshot_t snapshot;
562 mc_object_info_t object_info;
563 } s_mc_expression_state_t, *mc_expression_state_t;
565 int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
567 void* mc_find_frame_base(dw_frame_t frame, mc_object_info_t object_info, unw_cursor_t* unw_cursor);
569 /********************************** Miscellaneous **********************************/
571 typedef struct s_local_variable{
572 dw_frame_t subprogram;
578 }s_local_variable_t, *local_variable_t;
580 /********************************* Communications pattern ***************************/
582 typedef struct s_mc_comm_pattern{
585 e_smx_comm_type_t type;
586 unsigned long src_proc;
587 unsigned long dst_proc;
588 const char *src_host;
589 const char *dst_host;
593 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
595 extern xbt_dynar_t communications_pattern;
596 extern xbt_dynar_t incomplete_communications_pattern;
598 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
599 void complete_comm_pattern(xbt_dynar_t list, smx_action_t comm);
600 void MC_pre_modelcheck_comm_determinism(void);
601 void MC_modelcheck_comm_determinism(void);
603 /* *********** Sets *********** */
605 typedef struct s_mc_address_set *mc_address_set_t;
607 mc_address_set_t mc_address_set_new();
608 void mc_address_set_free(mc_address_set_t* p);
609 void mc_address_add(mc_address_set_t p, const void* value);
610 bool mc_address_test(mc_address_set_t p, const void* value);
612 /* *********** Hash *********** */
614 /** \brief Hash the current state
615 * \param num_state number of states
616 * \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
617 * \result resulting hash
619 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);