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"
16 #include <elfutils/libdw.h>
19 #include "mc/datatypes.h"
21 #include "xbt/config.h"
22 #include "xbt/function_types.h"
23 #include "xbt/mmalloc.h"
24 #include "../simix/smx_private.h"
25 #include "../xbt/mmalloc/mmprivate.h"
26 #include "xbt/automaton.h"
29 #include "msg/datatypes.h"
30 #include "xbt/strbuff.h"
31 #include "xbt/parmap.h"
33 #include "mc_page_store.h"
34 #include "mc_interface.h"
38 typedef struct s_dw_frame s_dw_frame_t, *dw_frame_t;
39 typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
41 /****************************** Snapshots ***********************************/
43 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
45 /** @brief Copy/snapshot of a given memory region
47 * Two types of region snapshots exist:
49 * <li>flat/dense snapshots are a simple copy of the region;</li>
50 * <li>sparse/per-page snapshots are snaapshots which shared
51 * identical pages.</li>
54 typedef struct s_mc_mem_region{
55 /** @brief Virtual address of the region in the simulated process */
58 /** @brief Permanent virtual address of the region
60 * This is usually the same address as the simuilated process address.
61 * However, when using SMPI privatization of global variables,
62 * each SMPI process has its own set of global variables stored
63 * at a different virtual address. The scheduler maps those region
64 * on the region of the global variables.
69 /** @brief Copy of the snapshot for flat snapshots regions (NULL otherwise) */
72 /** @brief Size of the data region in bytes */
75 /** @brief Pages indices in the page store for per-page snapshots (NULL otherwise) */
78 } s_mc_mem_region_t, *mc_mem_region_t;
80 static inline __attribute__ ((always_inline))
81 bool mc_region_contain(mc_mem_region_t region, void* p)
83 return p >= region->start_addr &&
84 p < (void*)((char*) region->start_addr + region->size);
89 * Some parts of the snapshot are ignored by zeroing them out: the real
90 * values is stored here.
92 typedef struct s_mc_snapshot_ignored_data {
96 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
98 typedef struct s_mc_snapshot{
99 size_t heap_bytes_used;
100 mc_mem_region_t regions[NB_REGIONS];
101 xbt_dynar_t enabled_processes;
102 mc_mem_region_t* privatization_regions;
103 int privatization_index;
106 xbt_dynar_t to_ignore;
108 xbt_dynar_t ignored_data;
111 /** @brief Process index used when no process is available
113 * The expected behaviour is that if a process index is needed it will fail.
115 #define MC_NO_PROCESS_INDEX -1
117 /** @brief Process index when any process is suitable
119 * We could use a special negative value in the future.
121 #define MC_ANY_PROCESS_INDEX 0
123 mc_mem_region_t mc_get_snapshot_region(void* addr, mc_snapshot_t snapshot, int process_index);
125 static inline __attribute__ ((always_inline))
126 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
128 if (mc_region_contain(region, addr))
131 return mc_get_snapshot_region(addr, snapshot, process_index);
134 /** Information about a given stack frame
137 typedef struct s_mc_stack_frame {
138 /** Instruction pointer */
142 unw_word_t frame_base;
145 unw_cursor_t unw_cursor;
146 } s_mc_stack_frame_t, *mc_stack_frame_t;
148 typedef struct s_mc_snapshot_stack{
149 xbt_dynar_t local_variables;
150 xbt_dynar_t stack_frames; // mc_stack_frame_t
152 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
154 typedef struct s_mc_global_t{
155 mc_snapshot_t snapshot;
159 int initial_communications_pattern_done;
160 int comm_deterministic;
161 int send_deterministic;
162 }s_mc_global_t, *mc_global_t;
164 typedef struct s_mc_checkpoint_ignore_region{
167 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
169 static void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
171 mc_snapshot_t MC_take_snapshot(int num_state);
172 void MC_restore_snapshot(mc_snapshot_t);
173 void MC_free_snapshot(mc_snapshot_t);
175 int mc_important_snapshot(mc_snapshot_t snapshot);
177 size_t* mc_take_page_snapshot_region(void* data, size_t page_count, uint64_t* pagemap, size_t* reference_pages);
178 void mc_free_page_snapshot_region(size_t* pagenos, size_t page_count);
179 void mc_restore_page_snapshot_region(void* start_addr, size_t page_count, size_t* pagenos, uint64_t* pagemap, size_t* reference_pagenos);
181 mc_mem_region_t mc_region_new_sparse(int type, void *start_addr, void* data_addr, size_t size, mc_mem_region_t ref_reg);
182 void MC_region_destroy(mc_mem_region_t reg);
183 void mc_region_restore_sparse(mc_mem_region_t reg, mc_mem_region_t ref_reg);
184 void mc_softdirty_reset();
186 static inline __attribute__((always_inline))
187 bool mc_snapshot_region_linear(mc_mem_region_t region) {
188 return !region || !region->data;
191 void* mc_snapshot_read_fragmented(void* addr, mc_mem_region_t region, void* target, size_t size);
193 void* mc_snapshot_read(void* addr, mc_snapshot_t snapshot, int process_index, void* target, size_t size);
194 int mc_snapshot_region_memcmp(
195 void* addr1, mc_mem_region_t region1,
196 void* addr2, mc_mem_region_t region2, size_t size);
197 int mc_snapshot_memcmp(
198 void* addr1, mc_snapshot_t snapshot1,
199 void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
201 static void* mc_snapshot_read_pointer(void* addr, mc_snapshot_t snapshot, int process_index);
203 /** @brief State of the model-checker (global variables for the model checker)
205 * Each part of the state of the model chercker represented as a global
206 * variable prevents some sharing between snapshots and must be ignored.
207 * By moving as much state as possible in this structure allocated
208 * on the model-chercker heap, we avoid those issues.
210 typedef struct s_mc_model_checker {
211 // This is the parent snapshot of the current state:
212 mc_snapshot_t parent_snapshot;
213 mc_pages_store_t pages;
216 } s_mc_model_checker_t, *mc_model_checker_t;
218 extern mc_model_checker_t mc_model_checker;
220 extern xbt_dynar_t mc_checkpoint_ignore;
222 /********************************* MC Global **********************************/
224 extern double *mc_time;
225 extern FILE *dot_output;
226 extern const char* colors[13];
227 extern xbt_parmap_t parmap;
229 extern int user_max_depth_reached;
231 int MC_deadlock_check(void);
232 void MC_replay(xbt_fifo_t stack, int start);
233 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
234 void MC_wait_for_requests(void);
235 void MC_show_deadlock(smx_simcall_t req);
236 void MC_show_stack_safety(xbt_fifo_t stack);
237 void MC_dump_stack_safety(xbt_fifo_t stack);
239 extern xbt_fifo_t mc_stack;
240 int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
243 /********************************* Requests ***********************************/
245 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
246 char* MC_request_to_string(smx_simcall_t req, int value);
247 unsigned int MC_request_testany_fail(smx_simcall_t req);
248 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
249 int MC_request_is_visible(smx_simcall_t req);
251 /** Can this requests can be executed.
253 * Most requests are always enabled but WAIT and WAITANY
254 * are not always enabled: a WAIT where the communication does not
255 * have both a source and a destination yet is not enabled
256 * (unless timeout is enabled in the wait and enabeld in SimGridMC).
258 int MC_request_is_enabled(smx_simcall_t req);
259 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
261 /** Is the process ready to execute its simcall?
263 * This is true if the request associated with the process is ready.
265 int MC_process_is_enabled(smx_process_t process);
267 char *MC_request_get_dot_output(smx_simcall_t req, int value);
270 /******************************** States **************************************/
272 extern mc_global_t initial_global_state;
274 /* Possible exploration status of a process in a state */
276 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
277 MC_INTERLEAVE, /* Interleave the process (one or more request) */
278 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
279 MC_DONE /* Already interleaved */
280 } e_mc_process_state_t;
282 /* On every state, each process has an entry of the following type */
283 typedef struct mc_procstate{
284 e_mc_process_state_t state; /* Exploration control information */
285 unsigned int interleave_count; /* Number of times that the process was
287 } s_mc_procstate_t, *mc_procstate_t;
289 /* An exploration state is composed of: */
290 typedef struct mc_state {
291 unsigned long max_pid; /* Maximum pid at state's creation time */
292 mc_procstate_t proc_status; /* State's exploration status by process */
293 s_smx_synchro_t internal_comm; /* To be referenced by the internal_req */
294 s_smx_simcall_t internal_req; /* Internal translation of request */
295 s_smx_simcall_t executed_req; /* The executed request of the state */
296 int req_num; /* The request number (in the case of a
297 multi-request like waitany ) */
298 mc_snapshot_t system_state; /* Snapshot of system state */
300 } s_mc_state_t, *mc_state_t;
302 mc_state_t MC_state_new(void);
303 void MC_state_delete(mc_state_t state);
304 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
305 unsigned int MC_state_interleave_size(mc_state_t state);
306 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
307 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
308 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
309 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
310 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
311 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
314 /****************************** Statistics ************************************/
316 typedef struct mc_stats {
317 unsigned long state_size;
318 unsigned long visited_states;
319 unsigned long visited_pairs;
320 unsigned long expanded_states;
321 unsigned long expanded_pairs;
322 unsigned long executed_transitions;
323 } s_mc_stats_t, *mc_stats_t;
325 extern mc_stats_t mc_stats;
327 void MC_print_statistics(mc_stats_t);
330 /********************************** MEMORY ******************************/
331 /* The possible memory modes for the modelchecker are standard and raw. */
332 /* Normally the system should operate in std, for switching to raw mode */
333 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
335 extern xbt_mheap_t std_heap;
336 extern xbt_mheap_t mc_heap;
339 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
340 /* an API to query about the status of a heap, we simply call mmstats and */
341 /* because I now how does structure looks like, then I redefine it here */
343 /* struct mstats { */
344 /* size_t bytes_total; /\* Total size of the heap. *\/ */
345 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
346 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
347 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
348 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
351 #define MC_SET_MC_HEAP mmalloc_set_current_heap(mc_heap)
352 #define MC_SET_STD_HEAP mmalloc_set_current_heap(std_heap)
355 /******************************* MEMORY MAPPINGS ***************************/
356 /* These functions and data structures implements a binary interface for */
357 /* the proc maps ascii interface */
359 /* Each field is defined as documented in proc's manual page */
360 typedef struct s_map_region {
362 void *start_addr; /* Start address of the map */
363 void *end_addr; /* End address of the map */
364 int prot; /* Memory protection */
365 int flags; /* Additional memory flags */
366 void *offset; /* Offset in the file/whatever */
367 char dev_major; /* Major of the device */
368 char dev_minor; /* Minor of the device */
369 unsigned long inode; /* Inode in the device */
370 char *pathname; /* Path name of the mapped file */
374 typedef struct s_memory_map {
376 s_map_region_t *regions; /* Pointer to an array of regions */
377 int mapsize; /* Number of regions in the memory */
379 } s_memory_map_t, *memory_map_t;
382 void MC_init_memory_map_info(void);
383 memory_map_t MC_get_memory_map(void);
384 void MC_free_memory_map(memory_map_t map);
386 extern char *libsimgrid_path;
388 /********************************** Snapshot comparison **********************************/
390 typedef struct s_mc_comparison_times{
391 double nb_processes_comparison_time;
392 double bytes_used_comparison_time;
393 double stacks_sizes_comparison_time;
394 double binary_global_variables_comparison_time;
395 double libsimgrid_global_variables_comparison_time;
396 double heap_comparison_time;
397 double stacks_comparison_time;
398 }s_mc_comparison_times_t, *mc_comparison_times_t;
400 extern __thread mc_comparison_times_t mc_comp_times;
401 extern __thread double mc_snapshot_comparison_time;
403 int snapshot_compare(void *state1, void *state2);
404 void print_comparison_times(void);
409 /********************************** Safety verification **************************************/
417 extern e_mc_reduce_t mc_reduce_kind;
418 extern xbt_dict_t first_enabled_state;
420 void MC_pre_modelcheck_safety(void);
421 void MC_modelcheck_safety(void);
423 typedef struct s_mc_visited_state{
424 mc_snapshot_t system_state;
425 size_t heap_bytes_used;
428 int other_num; // dot_output for
429 }s_mc_visited_state_t, *mc_visited_state_t;
431 extern xbt_dynar_t visited_states;
432 mc_visited_state_t is_visited_state(void);
433 void visited_state_free(mc_visited_state_t state);
434 void visited_state_free_voidp(void *s);
436 /********************************** Liveness verification **************************************/
438 extern xbt_automaton_t _mc_property_automaton;
440 typedef struct s_mc_pair{
443 mc_state_t graph_state; /* System state included */
444 xbt_automaton_state_t automaton_state;
445 xbt_dynar_t atomic_propositions;
447 }s_mc_pair_t, *mc_pair_t;
449 typedef struct s_mc_visited_pair{
451 int other_num; /* Dot output for */
453 mc_state_t graph_state; /* System state included */
454 xbt_automaton_state_t automaton_state;
455 xbt_dynar_t atomic_propositions;
456 size_t heap_bytes_used;
458 int acceptance_removed;
460 }s_mc_visited_pair_t, *mc_visited_pair_t;
462 mc_pair_t MC_pair_new(void);
463 void MC_pair_delete(mc_pair_t);
464 void mc_pair_free_voidp(void *p);
465 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
466 void MC_visited_pair_delete(mc_visited_pair_t p);
468 void MC_pre_modelcheck_liveness(void);
469 void MC_modelcheck_liveness(void);
470 void MC_show_stack_liveness(xbt_fifo_t stack);
471 void MC_dump_stack_liveness(xbt_fifo_t stack);
473 extern xbt_dynar_t visited_pairs;
474 int is_visited_pair(mc_visited_pair_t pair, int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
477 /********************************** Variables with DWARF **********************************/
479 #define MC_OBJECT_INFO_EXECUTABLE 1
481 struct s_mc_object_info {
484 char *start_exec, *end_exec; // Executable segment
485 char *start_rw, *end_rw; // Read-write segment
486 char *start_ro, *end_ro; // read-only segment
487 xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
488 xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
489 xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
490 xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
492 // Here we sort the minimal information for an efficient (and cache-efficient)
493 // lookup of a function given an instruction pointer.
494 // The entries are sorted by low_pc and a binary search can be used to look them up.
495 xbt_dynar_t functions_index;
498 mc_object_info_t MC_new_object_info(void);
499 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
500 void MC_free_object_info(mc_object_info_t* p);
502 void MC_dwarf_get_variables(mc_object_info_t info);
503 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
504 const char* MC_dwarf_attrname(int attr);
505 const char* MC_dwarf_tagname(int tag);
507 dw_frame_t MC_find_function_by_ip(void* ip);
508 mc_object_info_t MC_ip_find_object_info(void* ip);
510 extern mc_object_info_t mc_libsimgrid_info;
511 extern mc_object_info_t mc_binary_info;
512 extern mc_object_info_t mc_object_infos[2];
513 extern size_t mc_object_infos_size;
515 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
516 void MC_post_process_object_info(mc_object_info_t info);
520 /** \brief a DWARF expression with optional validity contraints */
521 typedef struct s_mc_expression {
524 // Optional validity:
525 void* lowpc, *highpc;
526 } s_mc_expression_t, *mc_expression_t;
528 /** A location list (list of location expressions) */
529 typedef struct s_mc_location_list {
531 mc_expression_t locations;
532 } s_mc_location_list_t, *mc_location_list_t;
534 /** A location is either a location in memory of a register location
538 * * mc_dwarf_resolve_locations or mc_dwarf_resolve_location is used
539 * to find the location of a given location expression or location list;
541 * * mc_get_location_type MUST be used to find the location type;
543 * * for MC_LOCATION_TYPE_ADDRESS, memory_address is the resulting address
545 * * for MC_LOCATION_TYPE_REGISTER, unw_get_reg(l.cursor, l.register_id, value)
546 * and unw_get_reg(l.cursor, l.register_id, value) can be used to read/write
550 typedef struct s_mc_location {
551 void* memory_location;
552 unw_cursor_t* cursor;
554 } s_mc_location_t, *mc_location_t;
556 /** Type of a given location
558 * Use `mc_get_location_type(location)` to find the type.
560 typedef enum mc_location_type {
561 MC_LOCATION_TYPE_ADDRESS,
562 MC_LOCATION_TYPE_REGISTER
565 /** Find the type of a location */
566 static inline __attribute__ ((always_inline))
567 enum mc_location_type mc_get_location_type(mc_location_t location) {
568 if (location->cursor) {
569 return MC_LOCATION_TYPE_REGISTER;
571 return MC_LOCATION_TYPE_ADDRESS;
575 void mc_dwarf_resolve_location(mc_location_t location, mc_expression_t expression, mc_object_info_t object_info, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot, int process_index);
576 void mc_dwarf_resolve_locations(mc_location_t location, mc_location_list_t locations, mc_object_info_t object_info, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot, int process_index);
578 void mc_dwarf_expression_clear(mc_expression_t expression);
579 void mc_dwarf_expression_init(mc_expression_t expression, size_t len, Dwarf_Op* ops);
581 void mc_dwarf_location_list_clear(mc_location_list_t list);
583 void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
584 void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
586 // ***** Variables and functions
590 Dwarf_Off id; /* Offset in the section (in hexadecimal form) */
591 char *name; /* Name of the type */
592 int byte_size; /* Size in bytes */
593 int element_count; /* Number of elements for array type */
594 char *dw_type_id; /* DW_AT_type id */
595 xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
598 // Location (for members) is either of:
599 struct s_mc_expression location;
602 dw_type_t subtype; // DW_AT_type
603 dw_type_t full_type; // The same (but more complete) type
606 void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot, int process_index);
608 typedef struct s_dw_variable{
609 Dwarf_Off dwarf_offset; /* Global offset of the field. */
616 s_mc_location_list_t locations;
620 mc_object_info_t object_info;
622 }s_dw_variable_t, *dw_variable_t;
629 s_mc_location_list_t frame_base;
630 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
631 unsigned long int id; /* DWARF offset of the subprogram */
632 xbt_dynar_t /* <dw_frame_t> */ scopes;
633 Dwarf_Off abstract_origin_id;
634 mc_object_info_t object_info;
637 struct s_mc_function_index_item {
638 void* low_pc, *high_pc;
642 void mc_frame_free(dw_frame_t freme);
644 void dw_type_free(dw_type_t t);
645 void dw_variable_free(dw_variable_t v);
646 void dw_variable_free_voidp(void *t);
648 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
649 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
650 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
651 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
653 /** Find the DWARF offset for this ELF object
655 * An offset is applied to address found in DWARF:
658 * <li>for an executable obejct, addresses are virtual address
659 * (there is no offset) i.e. \f$\text{virtual address} = \{dwarf address}\f$;</li>
660 * <li>for a shared object, the addreses are offset from the begining
661 * of the shared object (the base address of the mapped shared
662 * object must be used as offset
663 * i.e. \f$\text{virtual address} = \text{shared object base address}
664 * + \text{dwarf address}\f$.</li>
667 void* MC_object_base_address(mc_object_info_t info);
669 /********************************** DWARF **********************************/
671 #define MC_EXPRESSION_STACK_SIZE 64
673 #define MC_EXPRESSION_OK 0
674 #define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
675 #define MC_EXPRESSION_E_STACK_OVERFLOW 2
676 #define MC_EXPRESSION_E_STACK_UNDERFLOW 3
677 #define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
678 #define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
679 #define MC_EXPRESSION_E_NO_BASE_ADDRESS 6
681 typedef struct s_mc_expression_state {
682 uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
685 unw_cursor_t* cursor;
687 mc_snapshot_t snapshot;
688 mc_object_info_t object_info;
690 } s_mc_expression_state_t, *mc_expression_state_t;
692 int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
694 void* mc_find_frame_base(dw_frame_t frame, mc_object_info_t object_info, unw_cursor_t* unw_cursor);
696 /********************************** Miscellaneous **********************************/
698 typedef struct s_local_variable{
699 dw_frame_t subprogram;
705 }s_local_variable_t, *local_variable_t;
707 /********************************* Communications pattern ***************************/
709 typedef struct s_mc_comm_pattern{
712 e_smx_comm_type_t type;
713 unsigned long src_proc;
714 unsigned long dst_proc;
715 const char *src_host;
716 const char *dst_host;
720 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
722 extern xbt_dynar_t initial_communications_pattern;
723 extern xbt_dynar_t communications_pattern;
724 extern xbt_dynar_t incomplete_communications_pattern;
726 // Can we use the SIMIX syscall for this?
727 typedef enum mc_call_type {
732 MC_CALL_TYPE_WAITANY,
735 static inline mc_call_type mc_get_call_type(smx_simcall_t req) {
737 case SIMCALL_COMM_ISEND:
738 return MC_CALL_TYPE_SEND;
739 case SIMCALL_COMM_IRECV:
740 return MC_CALL_TYPE_RECV;
741 case SIMCALL_COMM_WAIT:
742 return MC_CALL_TYPE_WAIT;
743 case SIMCALL_COMM_WAITANY:
744 return MC_CALL_TYPE_WAITANY;
746 return MC_CALL_TYPE_NONE;
750 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, mc_call_type call_type);
751 void mc_update_comm_pattern(mc_call_type call_type, smx_simcall_t request, int value, xbt_dynar_t current_pattern);
752 void complete_comm_pattern(xbt_dynar_t list, smx_synchro_t comm);
753 void MC_pre_modelcheck_comm_determinism(void);
754 void MC_modelcheck_comm_determinism(void);
756 /* *********** Sets *********** */
758 typedef struct s_mc_address_set *mc_address_set_t;
760 mc_address_set_t mc_address_set_new();
761 void mc_address_set_free(mc_address_set_t* p);
762 void mc_address_add(mc_address_set_t p, const void* value);
763 bool mc_address_test(mc_address_set_t p, const void* value);
765 /* *********** Hash *********** */
767 /** \brief Hash the current state
768 * \param num_state number of states
769 * \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
770 * \result resulting hash
772 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
774 /* *********** Snapshot *********** */
776 static inline __attribute__((always_inline))
777 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region)
779 size_t pageno = mc_page_number(region->start_addr, (void*) addr);
780 size_t snapshot_pageno = region->page_numbers[pageno];
781 const void* snapshot_page = mc_page_store_get_page(mc_model_checker->pages, snapshot_pageno);
782 return (char*) snapshot_page + mc_page_offset((void*) addr);
785 /** \brief Translate a pointer from process address space to snapshot address space
787 * The address space contains snapshot of the main/application memory:
788 * this function finds the address in a given snaphot for a given
789 * real/application address.
791 * For read only memory regions and other regions which are not int the
792 * snapshot, the address is not changed.
794 * \param addr Application address
795 * \param snapshot The snapshot of interest (if NULL no translation is done)
796 * \return Translated address in the snapshot address space
798 static inline __attribute__((always_inline))
799 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot, int process_index)
802 // If not in a process state/clone:
804 return (uintptr_t *) addr;
807 mc_mem_region_t region = mc_get_snapshot_region((void*) addr, snapshot, process_index);
809 xbt_assert(mc_region_contain(region, (void*) addr), "Trying to read out of the region boundary.");
812 return (void *) addr;
816 else if (region->data) {
817 uintptr_t offset = addr - (uintptr_t) region->start_addr;
818 return (void *) ((uintptr_t) region->data + offset);
821 // Per-page snapshot:
822 else if (region->page_numbers) {
823 return mc_translate_address_region(addr, region);
827 xbt_die("No data for this memory region");
831 static inline __attribute__ ((always_inline))
832 void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot) {
834 xbt_die("snapshot is NULL");
835 void** addr = &(std_heap->breakval);
836 return mc_snapshot_read_pointer(addr, snapshot, MC_ANY_PROCESS_INDEX);
839 static inline __attribute__ ((always_inline))
840 void* mc_snapshot_read_pointer(void* addr, mc_snapshot_t snapshot, int process_index)
843 return *(void**) mc_snapshot_read(addr, snapshot, process_index, &res, sizeof(void*));
846 /** @brief Read memory from a snapshot region
848 * @param addr Process (non-snapshot) address of the data
849 * @param region Snapshot memory region where the data is located
850 * @param target Buffer to store the value
851 * @param size Size of the data to read in bytes
852 * @return Pointer where the data is located (target buffer of original location)
854 static inline __attribute__((always_inline))
855 void* mc_snapshot_read_region(void* addr, mc_mem_region_t region, void* target, size_t size)
860 uintptr_t offset = (char*) addr - (char*) region->start_addr;
862 xbt_assert(mc_region_contain(region, addr),
863 "Trying to read out of the region boundary.");
865 // Linear memory region:
867 return (char*) region->data + offset;
870 // Fragmented memory region:
871 else if (region->page_numbers) {
872 // Last byte of the region:
873 void* end = (char*) addr + size - 1;
874 if( mc_same_page(addr, end) ) {
875 // The memory is contained in a single page:
876 return mc_translate_address_region((uintptr_t) addr, region);
878 // The memory spans several pages:
879 return mc_snapshot_read_fragmented(addr, region, target, size);
884 xbt_die("No data available for this region");
888 static inline __attribute__ ((always_inline))
889 void* mc_snapshot_read_pointer_region(void* addr, mc_mem_region_t region)
892 return *(void**) mc_snapshot_read_region(addr, region, &res, sizeof(void*));
895 #define MC_LOG_REQUEST(log, req, value) \
896 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) { \
897 char* req_str = MC_request_to_string(req, value); \
898 XBT_DEBUG("Execute: %s", req_str); \