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;
48 typedef struct s_mc_snapshot{
49 size_t heap_bytes_used;
50 mc_mem_region_t regions[NB_REGIONS];
51 xbt_dynar_t enabled_processes;
52 mc_mem_region_t* privatization_regions;
53 int privatization_index;
56 xbt_dynar_t to_ignore;
58 } s_mc_snapshot_t, *mc_snapshot_t;
60 /** Information about a given stack frame
63 typedef struct s_mc_stack_frame {
64 /** Instruction pointer */
68 unw_word_t frame_base;
71 unw_cursor_t unw_cursor;
72 } s_mc_stack_frame_t, *mc_stack_frame_t;
74 typedef struct s_mc_snapshot_stack{
75 xbt_dynar_t local_variables;
78 xbt_dynar_t stack_frames; // mc_stack_frame_t
79 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
81 typedef struct s_mc_global_t{
82 mc_snapshot_t snapshot;
86 int initial_communications_pattern_done;
87 int comm_deterministic;
88 int send_deterministic;
89 }s_mc_global_t, *mc_global_t;
91 typedef struct s_mc_checkpoint_ignore_region{
94 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
96 inline static void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot) {
98 xbt_die("snapshot is NULL");
99 xbt_mheap_t heap = (xbt_mheap_t)snapshot->regions[0]->data;
100 return heap->breakval;
103 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
104 mc_snapshot_t MC_take_snapshot(int num_state);
105 void MC_restore_snapshot(mc_snapshot_t);
106 void MC_free_snapshot(mc_snapshot_t);
108 /** \brief Translate a pointer from process address space to snapshot address space
110 * The address space contains snapshot of the main/application memory:
111 * this function finds the address in a given snaphot for a given
112 * real/application address.
114 * For read only memory regions and other regions which are not int the
115 * snapshot, the address is not changed.
117 * \param addr Application address
118 * \param snapshot The snapshot of interest (if NULL no translation is done)
119 * \return Translated address in the snapshot address space
121 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot);
123 /** \brief Translate a pointer from the snapshot address space to the application address space
125 * This is the inverse of mc_translate_address.
127 * \param addr Address in the snapshot address space
128 * \param snapsot Snapshot of interest (if NULL no translation is done)
129 * \return Translated address in the application address space
131 uintptr_t mc_untranslate_address(void* addr, mc_snapshot_t snapshot);
133 extern xbt_dynar_t mc_checkpoint_ignore;
135 /********************************* MC Global **********************************/
137 extern double *mc_time;
138 extern FILE *dot_output;
139 extern const char* colors[13];
140 extern xbt_parmap_t parmap;
142 extern int user_max_depth_reached;
144 int MC_deadlock_check(void);
145 void MC_replay(xbt_fifo_t stack, int start);
146 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
147 void MC_wait_for_requests(void);
148 void MC_show_deadlock(smx_simcall_t req);
149 void MC_show_stack_safety(xbt_fifo_t stack);
150 void MC_dump_stack_safety(xbt_fifo_t stack);
151 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
153 extern xbt_fifo_t mc_stack;
154 int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
157 /********************************* Requests ***********************************/
159 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
160 char* MC_request_to_string(smx_simcall_t req, int value);
161 unsigned int MC_request_testany_fail(smx_simcall_t req);
162 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
163 int MC_request_is_visible(smx_simcall_t req);
164 int MC_request_is_enabled(smx_simcall_t req);
165 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
166 int MC_process_is_enabled(smx_process_t process);
167 char *MC_request_get_dot_output(smx_simcall_t req, int value);
170 /******************************** States **************************************/
172 extern mc_global_t initial_global_state;
174 /* Possible exploration status of a process in a state */
176 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
177 MC_INTERLEAVE, /* Interleave the process (one or more request) */
178 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
179 MC_DONE /* Already interleaved */
180 } e_mc_process_state_t;
182 /* On every state, each process has an entry of the following type */
183 typedef struct mc_procstate{
184 e_mc_process_state_t state; /* Exploration control information */
185 unsigned int interleave_count; /* Number of times that the process was
187 } s_mc_procstate_t, *mc_procstate_t;
189 /* An exploration state is composed of: */
190 typedef struct mc_state {
191 unsigned long max_pid; /* Maximum pid at state's creation time */
192 mc_procstate_t proc_status; /* State's exploration status by process */
193 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
194 s_smx_simcall_t internal_req; /* Internal translation of request */
195 s_smx_simcall_t executed_req; /* The executed request of the state */
196 int req_num; /* The request number (in the case of a
197 multi-request like waitany ) */
198 mc_snapshot_t system_state; /* Snapshot of system state */
200 } s_mc_state_t, *mc_state_t;
202 mc_state_t MC_state_new(void);
203 void MC_state_delete(mc_state_t state);
204 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
205 unsigned int MC_state_interleave_size(mc_state_t state);
206 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
207 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
208 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
209 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
210 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
211 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
214 /****************************** Statistics ************************************/
216 typedef struct mc_stats {
217 unsigned long state_size;
218 unsigned long visited_states;
219 unsigned long visited_pairs;
220 unsigned long expanded_states;
221 unsigned long expanded_pairs;
222 unsigned long executed_transitions;
223 } s_mc_stats_t, *mc_stats_t;
225 extern mc_stats_t mc_stats;
227 void MC_print_statistics(mc_stats_t);
230 /********************************** MEMORY ******************************/
231 /* The possible memory modes for the modelchecker are standard and raw. */
232 /* Normally the system should operate in std, for switching to raw mode */
233 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
235 extern void *std_heap;
236 extern void *mc_heap;
239 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
240 /* an API to query about the status of a heap, we simply call mmstats and */
241 /* because I now how does structure looks like, then I redefine it here */
243 /* struct mstats { */
244 /* size_t bytes_total; /\* Total size of the heap. *\/ */
245 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
246 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
247 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
248 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
251 #define MC_SET_MC_HEAP mmalloc_set_current_heap(mc_heap)
252 #define MC_SET_STD_HEAP mmalloc_set_current_heap(std_heap)
255 /******************************* MEMORY MAPPINGS ***************************/
256 /* These functions and data structures implements a binary interface for */
257 /* the proc maps ascii interface */
259 /* Each field is defined as documented in proc's manual page */
260 typedef struct s_map_region {
262 void *start_addr; /* Start address of the map */
263 void *end_addr; /* End address of the map */
264 int prot; /* Memory protection */
265 int flags; /* Additional memory flags */
266 void *offset; /* Offset in the file/whatever */
267 char dev_major; /* Major of the device */
268 char dev_minor; /* Minor of the device */
269 unsigned long inode; /* Inode in the device */
270 char *pathname; /* Path name of the mapped file */
274 typedef struct s_memory_map {
276 s_map_region_t *regions; /* Pointer to an array of regions */
277 int mapsize; /* Number of regions in the memory */
279 } s_memory_map_t, *memory_map_t;
282 void MC_init_memory_map_info(void);
283 memory_map_t MC_get_memory_map(void);
284 void MC_free_memory_map(memory_map_t map);
286 extern char *libsimgrid_path;
288 /********************************** Snapshot comparison **********************************/
290 typedef struct s_mc_comparison_times{
291 double nb_processes_comparison_time;
292 double bytes_used_comparison_time;
293 double stacks_sizes_comparison_time;
294 double binary_global_variables_comparison_time;
295 double libsimgrid_global_variables_comparison_time;
296 double heap_comparison_time;
297 double stacks_comparison_time;
298 }s_mc_comparison_times_t, *mc_comparison_times_t;
300 extern __thread mc_comparison_times_t mc_comp_times;
301 extern __thread double mc_snapshot_comparison_time;
303 int snapshot_compare(void *state1, void *state2);
304 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
305 void print_comparison_times(void);
310 /********************************** Safety verification **************************************/
318 extern e_mc_reduce_t mc_reduce_kind;
319 extern xbt_dict_t first_enabled_state;
321 void MC_pre_modelcheck_safety(void);
322 void MC_modelcheck_safety(void);
324 typedef struct s_mc_visited_state{
325 mc_snapshot_t system_state;
326 size_t heap_bytes_used;
329 int other_num; // dot_output for
330 }s_mc_visited_state_t, *mc_visited_state_t;
332 extern xbt_dynar_t visited_states;
333 int is_visited_state(void);
334 void visited_state_free(mc_visited_state_t state);
335 void visited_state_free_voidp(void *s);
337 /********************************** Liveness verification **************************************/
339 extern xbt_automaton_t _mc_property_automaton;
341 typedef struct s_mc_pair{
344 mc_state_t graph_state; /* System state included */
345 xbt_automaton_state_t automaton_state;
346 xbt_dynar_t atomic_propositions;
348 }s_mc_pair_t, *mc_pair_t;
350 typedef struct s_mc_visited_pair{
352 int other_num; /* Dot output for */
354 mc_state_t graph_state; /* System state included */
355 xbt_automaton_state_t automaton_state;
356 xbt_dynar_t atomic_propositions;
357 size_t heap_bytes_used;
359 int acceptance_removed;
361 }s_mc_visited_pair_t, *mc_visited_pair_t;
363 mc_pair_t MC_pair_new(void);
364 void MC_pair_delete(mc_pair_t);
365 void mc_pair_free_voidp(void *p);
366 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
367 void MC_visited_pair_delete(mc_visited_pair_t p);
369 void MC_pre_modelcheck_liveness(void);
370 void MC_modelcheck_liveness(void);
371 void MC_show_stack_liveness(xbt_fifo_t stack);
372 void MC_dump_stack_liveness(xbt_fifo_t stack);
374 extern xbt_dynar_t visited_pairs;
375 int is_visited_pair(mc_visited_pair_t pair, int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
378 /********************************** Variables with DWARF **********************************/
380 #define MC_OBJECT_INFO_EXECUTABLE 1
382 struct s_mc_object_info {
385 char *start_exec, *end_exec; // Executable segment
386 char *start_rw, *end_rw; // Read-write segment
387 char *start_ro, *end_ro; // read-only segment
388 xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
389 xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
390 xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
391 xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
393 // Here we sort the minimal information for an efficient (and cache-efficient)
394 // lookup of a function given an instruction pointer.
395 // The entries are sorted by low_pc and a binary search can be used to look them up.
396 xbt_dynar_t functions_index;
399 mc_object_info_t MC_new_object_info(void);
400 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
401 void MC_free_object_info(mc_object_info_t* p);
403 void MC_dwarf_get_variables(mc_object_info_t info);
404 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
405 const char* MC_dwarf_attrname(int attr);
406 const char* MC_dwarf_tagname(int tag);
408 dw_frame_t MC_find_function_by_ip(void* ip);
409 mc_object_info_t MC_ip_find_object_info(void* ip);
411 extern mc_object_info_t mc_libsimgrid_info;
412 extern mc_object_info_t mc_binary_info;
413 extern mc_object_info_t mc_object_infos[2];
414 extern size_t mc_object_infos_size;
416 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
417 void MC_post_process_types(mc_object_info_t info);
418 void MC_post_process_object_info(mc_object_info_t info);
422 /** \brief a DWARF expression with optional validity contraints */
423 typedef struct s_mc_expression {
426 // Optional validity:
427 void* lowpc, *highpc;
428 } s_mc_expression_t, *mc_expression_t;
430 /** A location list (list of location expressions) */
431 typedef struct s_mc_location_list {
433 mc_expression_t locations;
434 } s_mc_location_list_t, *mc_location_list_t;
436 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);
437 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);
439 void mc_dwarf_expression_clear(mc_expression_t expression);
440 void mc_dwarf_expression_init(mc_expression_t expression, size_t len, Dwarf_Op* ops);
442 void mc_dwarf_location_list_clear(mc_location_list_t list);
444 void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
445 void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
447 // ***** Variables and functions
451 Dwarf_Off id; /* Offset in the section (in hexadecimal form) */
452 char *name; /* Name of the type */
453 int byte_size; /* Size in bytes */
454 int element_count; /* Number of elements for array type */
455 char *dw_type_id; /* DW_AT_type id */
456 xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
459 // Location (for members) is either of:
460 struct s_mc_expression location;
463 dw_type_t subtype; // DW_AT_type
464 dw_type_t full_type; // The same (but more complete) type
467 void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
468 void* mc_member_snapshot_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
470 typedef struct s_dw_variable{
471 Dwarf_Off dwarf_offset; /* Global offset of the field. */
478 s_mc_location_list_t locations;
482 mc_object_info_t object_info;
484 }s_dw_variable_t, *dw_variable_t;
491 s_mc_location_list_t frame_base;
492 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
493 unsigned long int id; /* DWARF offset of the subprogram */
494 xbt_dynar_t /* <dw_frame_t> */ scopes;
495 Dwarf_Off abstract_origin_id;
496 mc_object_info_t object_info;
499 struct s_mc_function_index_item {
500 void* low_pc, *high_pc;
504 void mc_frame_free(dw_frame_t freme);
506 void dw_type_free(dw_type_t t);
507 void dw_variable_free(dw_variable_t v);
508 void dw_variable_free_voidp(void *t);
510 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
511 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
512 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
513 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
515 /** Find the DWARF offset for this ELF object
517 * An offset is applied to address found in DWARF:
520 * <li>for an executable obejct, addresses are virtual address
521 * (there is no offset) i.e. \f$\text{virtual address} = \{dwarf address}\f$;</li>
522 * <li>for a shared object, the addreses are offset from the begining
523 * of the shared object (the base address of the mapped shared
524 * object must be used as offset
525 * i.e. \f$\text{virtual address} = \text{shared object base address}
526 * + \text{dwarf address}\f$.</li>
529 void* MC_object_base_address(mc_object_info_t info);
531 /********************************** DWARF **********************************/
533 #define MC_EXPRESSION_STACK_SIZE 64
535 #define MC_EXPRESSION_OK 0
536 #define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
537 #define MC_EXPRESSION_E_STACK_OVERFLOW 2
538 #define MC_EXPRESSION_E_STACK_UNDERFLOW 3
539 #define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
540 #define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
541 #define MC_EXPRESSION_E_NO_BASE_ADDRESS 6
543 typedef struct s_mc_expression_state {
544 uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
547 unw_cursor_t* cursor;
549 mc_snapshot_t snapshot;
550 mc_object_info_t object_info;
551 } s_mc_expression_state_t, *mc_expression_state_t;
553 int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
555 void* mc_find_frame_base(dw_frame_t frame, mc_object_info_t object_info, unw_cursor_t* unw_cursor);
557 /********************************** Miscellaneous **********************************/
559 typedef struct s_local_variable{
560 dw_frame_t subprogram;
566 }s_local_variable_t, *local_variable_t;
568 /********************************* Communications pattern ***************************/
570 typedef struct s_mc_comm_pattern{
573 e_smx_comm_type_t type;
574 unsigned long src_proc;
575 unsigned long dst_proc;
576 const char *src_host;
577 const char *dst_host;
581 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
583 extern xbt_dynar_t communications_pattern;
584 extern xbt_dynar_t incomplete_communications_pattern;
586 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
587 void complete_comm_pattern(xbt_dynar_t list, smx_action_t comm);
588 void MC_pre_modelcheck_comm_determinism(void);
589 void MC_modelcheck_comm_determinism(void);
591 /* *********** Sets *********** */
593 typedef struct s_mc_address_set *mc_address_set_t;
595 mc_address_set_t mc_address_set_new();
596 void mc_address_set_free(mc_address_set_t* p);
597 void mc_address_add(mc_address_set_t p, const void* value);
598 bool mc_address_test(mc_address_set_t p, const void* value);
600 /* *********** Hash *********** */
602 /** \brief Hash the current state
603 * \param num_state number of states
604 * \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
605 * \result resulting hash
607 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);