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>
20 #include "mc/datatypes.h"
22 #include "xbt/config.h"
23 #include "xbt/function_types.h"
24 #include "xbt/mmalloc.h"
25 #include "../simix/smx_private.h"
26 #include "../xbt/mmalloc/mmprivate.h"
27 #include "xbt/automaton.h"
30 #include "msg/datatypes.h"
31 #include "xbt/strbuff.h"
32 #include "xbt/parmap.h"
34 #include "mc_page_store.h"
35 #include "mc_interface.h"
39 typedef struct s_dw_frame s_dw_frame_t, *dw_frame_t;
40 typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
42 /****************************** Snapshots ***********************************/
44 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
46 /** @brief Copy/snapshot of a given memory region
48 * Two types of region snapshots exist:
50 * <li>flat/dense snapshots are a simple copy of the region;</li>
51 * <li>sparse/per-page snapshots are snaapshots which shared
52 * identical pages.</li>
55 typedef struct s_mc_mem_region{
56 /** @brief Virtual address of the region in the simulated process */
59 /** @brief Permanent virtual address of the region
61 * This is usually the same address as the simuilated process address.
62 * However, when using SMPI privatization of global variables,
63 * each SMPI process has its own set of global variables stored
64 * at a different virtual address. The scheduler maps those region
65 * on the region of the global variables.
70 /** @brief Copy of the snapshot for flat snapshots regions (NULL otherwise) */
73 /** @brief Size of the data region in bytes */
76 /** @brief Pages indices in the page store for per-page snapshots (NULL otherwise) */
79 } s_mc_mem_region_t, *mc_mem_region_t;
81 static inline __attribute__ ((always_inline))
82 bool mc_region_contain(mc_mem_region_t region, void* p)
84 return p >= region->start_addr &&
85 p < (void*)((char*) region->start_addr + region->size);
90 * Some parts of the snapshot are ignored by zeroing them out: the real
91 * values is stored here.
93 typedef struct s_mc_snapshot_ignored_data {
97 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
99 typedef struct s_fd_infos{
102 off_t current_position;
104 }s_fd_infos_t, *fd_infos_t;
106 typedef struct s_mc_snapshot{
107 size_t heap_bytes_used;
108 mc_mem_region_t regions[NB_REGIONS];
109 xbt_dynar_t enabled_processes;
110 mc_mem_region_t* privatization_regions;
111 int privatization_index;
114 xbt_dynar_t to_ignore;
116 xbt_dynar_t ignored_data;
118 fd_infos_t *current_fd;
122 /** @brief Process index used when no process is available
124 * The expected behaviour is that if a process index is needed it will fail.
126 #define MC_NO_PROCESS_INDEX -1
128 /** @brief Process index when any process is suitable
130 * We could use a special negative value in the future.
132 #define MC_ANY_PROCESS_INDEX 0
134 mc_mem_region_t mc_get_snapshot_region(void* addr, mc_snapshot_t snapshot, int process_index);
136 static inline __attribute__ ((always_inline))
137 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
139 if (mc_region_contain(region, addr))
142 return mc_get_snapshot_region(addr, snapshot, process_index);
145 /** Information about a given stack frame
148 typedef struct s_mc_stack_frame {
149 /** Instruction pointer */
153 unw_word_t frame_base;
156 unw_cursor_t unw_cursor;
157 } s_mc_stack_frame_t, *mc_stack_frame_t;
159 typedef struct s_mc_snapshot_stack{
160 xbt_dynar_t local_variables;
161 xbt_dynar_t stack_frames; // mc_stack_frame_t
163 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
165 typedef struct s_mc_global_t{
166 mc_snapshot_t snapshot;
170 int initial_communications_pattern_done;
171 int comm_deterministic;
172 int send_deterministic;
173 }s_mc_global_t, *mc_global_t;
175 typedef struct s_mc_checkpoint_ignore_region{
178 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
180 static void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
182 mc_snapshot_t MC_take_snapshot(int num_state);
183 void MC_restore_snapshot(mc_snapshot_t);
184 void MC_free_snapshot(mc_snapshot_t);
186 int mc_important_snapshot(mc_snapshot_t snapshot);
188 size_t* mc_take_page_snapshot_region(void* data, size_t page_count, uint64_t* pagemap, size_t* reference_pages);
189 void mc_free_page_snapshot_region(size_t* pagenos, size_t page_count);
190 void mc_restore_page_snapshot_region(void* start_addr, size_t page_count, size_t* pagenos, uint64_t* pagemap, size_t* reference_pagenos);
192 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);
193 void MC_region_destroy(mc_mem_region_t reg);
194 void mc_region_restore_sparse(mc_mem_region_t reg, mc_mem_region_t ref_reg);
195 void mc_softdirty_reset();
197 static inline __attribute__((always_inline))
198 bool mc_snapshot_region_linear(mc_mem_region_t region) {
199 return !region || !region->data;
202 void* mc_snapshot_read_fragmented(void* addr, mc_mem_region_t region, void* target, size_t size);
204 void* mc_snapshot_read(void* addr, mc_snapshot_t snapshot, int process_index, void* target, size_t size);
205 int mc_snapshot_region_memcmp(
206 void* addr1, mc_mem_region_t region1,
207 void* addr2, mc_mem_region_t region2, size_t size);
208 int mc_snapshot_memcmp(
209 void* addr1, mc_snapshot_t snapshot1,
210 void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
212 static void* mc_snapshot_read_pointer(void* addr, mc_snapshot_t snapshot, int process_index);
214 /** @brief State of the model-checker (global variables for the model checker)
216 * Each part of the state of the model chercker represented as a global
217 * variable prevents some sharing between snapshots and must be ignored.
218 * By moving as much state as possible in this structure allocated
219 * on the model-chercker heap, we avoid those issues.
221 typedef struct s_mc_model_checker {
222 // This is the parent snapshot of the current state:
223 mc_snapshot_t parent_snapshot;
224 mc_pages_store_t pages;
228 } s_mc_model_checker_t, *mc_model_checker_t;
230 mc_model_checker_t MC_model_checker_new(void);
231 void MC_model_checker_delete(mc_model_checker_t mc);
232 extern mc_model_checker_t mc_model_checker;
234 extern xbt_dynar_t mc_checkpoint_ignore;
236 /********************************* MC Global **********************************/
238 extern FILE *dot_output;
239 extern const char* colors[13];
240 extern xbt_parmap_t parmap;
242 extern int user_max_depth_reached;
244 int MC_deadlock_check(void);
245 void MC_replay(xbt_fifo_t stack, int start);
246 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
247 void MC_show_deadlock(smx_simcall_t req);
248 void MC_show_stack_safety(xbt_fifo_t stack);
249 void MC_dump_stack_safety(xbt_fifo_t stack);
251 /** Stack (of `mc_state_t`) representing the current position of the
252 * the MC in the exploration graph
254 * It is managed by its head (`xbt_fifo_shift` and `xbt_fifo_unshift`).
256 extern xbt_fifo_t mc_stack;
258 int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
260 /********************************* Requests ***********************************/
262 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
263 char* MC_request_to_string(smx_simcall_t req, int value);
264 unsigned int MC_request_testany_fail(smx_simcall_t req);
265 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
266 int MC_request_is_visible(smx_simcall_t req);
268 /** Can this requests can be executed.
270 * Most requests are always enabled but WAIT and WAITANY
271 * are not always enabled: a WAIT where the communication does not
272 * have both a source and a destination yet is not enabled
273 * (unless timeout is enabled in the wait and enabeld in SimGridMC).
275 int MC_request_is_enabled(smx_simcall_t req);
276 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
278 /** Is the process ready to execute its simcall?
280 * This is true if the request associated with the process is ready.
282 int MC_process_is_enabled(smx_process_t process);
284 char *MC_request_get_dot_output(smx_simcall_t req, int value);
287 /******************************** States **************************************/
289 extern mc_global_t initial_global_state;
291 /* Possible exploration status of a process in a state */
293 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
294 MC_INTERLEAVE, /* Interleave the process (one or more request) */
295 MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
296 MC_DONE /* Already interleaved */
297 } e_mc_process_state_t;
299 /* On every state, each process has an entry of the following type */
300 typedef struct mc_procstate{
301 e_mc_process_state_t state; /* Exploration control information */
302 unsigned int interleave_count; /* Number of times that the process was
304 } s_mc_procstate_t, *mc_procstate_t;
306 /* An exploration state.
308 * The `executed_state` is sometimes transformed into another `internal_req`.
309 * For example WAITANY is transformes into a WAIT and TESTANY into TEST.
310 * See `MC_state_set_executed_request()`.
312 typedef struct mc_state {
313 unsigned long max_pid; /* Maximum pid at state's creation time */
314 mc_procstate_t proc_status; /* State's exploration status by process */
315 s_smx_synchro_t internal_comm; /* To be referenced by the internal_req */
316 s_smx_simcall_t internal_req; /* Internal translation of request */
317 s_smx_simcall_t executed_req; /* The executed request of the state */
318 int req_num; /* The request number (in the case of a
319 multi-request like waitany ) */
320 mc_snapshot_t system_state; /* Snapshot of system state */
322 } s_mc_state_t, *mc_state_t;
324 mc_state_t MC_state_new(void);
325 void MC_state_delete(mc_state_t state);
326 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
327 unsigned int MC_state_interleave_size(mc_state_t state);
328 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
329 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
330 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
331 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
332 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
333 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
336 /****************************** Statistics ************************************/
338 typedef struct mc_stats {
339 unsigned long state_size;
340 unsigned long visited_states;
341 unsigned long visited_pairs;
342 unsigned long expanded_states;
343 unsigned long expanded_pairs;
344 unsigned long executed_transitions;
345 } s_mc_stats_t, *mc_stats_t;
347 extern mc_stats_t mc_stats;
349 void MC_print_statistics(mc_stats_t);
352 /********************************** MEMORY ******************************/
353 /* The possible memory modes for the modelchecker are standard and raw. */
354 /* Normally the system should operate in std, for switching to raw mode */
355 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
357 extern xbt_mheap_t std_heap;
358 extern xbt_mheap_t mc_heap;
361 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
362 /* an API to query about the status of a heap, we simply call mmstats and */
363 /* because I now how does structure looks like, then I redefine it here */
365 /* struct mstats { */
366 /* size_t bytes_total; /\* Total size of the heap. *\/ */
367 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
368 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
369 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
370 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
373 #define MC_SET_MC_HEAP mmalloc_set_current_heap(mc_heap)
374 #define MC_SET_STD_HEAP mmalloc_set_current_heap(std_heap)
377 /******************************* MEMORY MAPPINGS ***************************/
378 /* These functions and data structures implements a binary interface for */
379 /* the proc maps ascii interface */
381 /* Each field is defined as documented in proc's manual page */
382 typedef struct s_map_region {
384 void *start_addr; /* Start address of the map */
385 void *end_addr; /* End address of the map */
386 int prot; /* Memory protection */
387 int flags; /* Additional memory flags */
388 void *offset; /* Offset in the file/whatever */
389 char dev_major; /* Major of the device */
390 char dev_minor; /* Minor of the device */
391 unsigned long inode; /* Inode in the device */
392 char *pathname; /* Path name of the mapped file */
396 typedef struct s_memory_map {
398 s_map_region_t *regions; /* Pointer to an array of regions */
399 int mapsize; /* Number of regions in the memory */
401 } s_memory_map_t, *memory_map_t;
404 void MC_init_memory_map_info(void);
405 memory_map_t MC_get_memory_map(void);
406 void MC_free_memory_map(memory_map_t map);
408 extern char *libsimgrid_path;
410 /********************************** Snapshot comparison **********************************/
412 typedef struct s_mc_comparison_times{
413 double nb_processes_comparison_time;
414 double bytes_used_comparison_time;
415 double stacks_sizes_comparison_time;
416 double binary_global_variables_comparison_time;
417 double libsimgrid_global_variables_comparison_time;
418 double heap_comparison_time;
419 double stacks_comparison_time;
420 }s_mc_comparison_times_t, *mc_comparison_times_t;
422 extern __thread mc_comparison_times_t mc_comp_times;
423 extern __thread double mc_snapshot_comparison_time;
425 int snapshot_compare(void *state1, void *state2);
426 void print_comparison_times(void);
431 /********************************** Safety verification **************************************/
439 extern e_mc_reduce_t mc_reduce_kind;
440 extern xbt_dict_t first_enabled_state;
442 void MC_pre_modelcheck_safety(void);
443 void MC_modelcheck_safety(void);
445 typedef struct s_mc_visited_state{
446 mc_snapshot_t system_state;
447 size_t heap_bytes_used;
450 int other_num; // dot_output for
451 }s_mc_visited_state_t, *mc_visited_state_t;
453 extern xbt_dynar_t visited_states;
454 mc_visited_state_t is_visited_state(void);
455 void visited_state_free(mc_visited_state_t state);
456 void visited_state_free_voidp(void *s);
458 /********************************** Liveness verification **************************************/
460 extern xbt_automaton_t _mc_property_automaton;
462 typedef struct s_mc_pair{
465 mc_state_t graph_state; /* System state included */
466 xbt_automaton_state_t automaton_state;
467 xbt_dynar_t atomic_propositions;
469 }s_mc_pair_t, *mc_pair_t;
471 typedef struct s_mc_visited_pair{
473 int other_num; /* Dot output for */
475 mc_state_t graph_state; /* System state included */
476 xbt_automaton_state_t automaton_state;
477 xbt_dynar_t atomic_propositions;
478 size_t heap_bytes_used;
480 int acceptance_removed;
482 }s_mc_visited_pair_t, *mc_visited_pair_t;
484 mc_pair_t MC_pair_new(void);
485 void MC_pair_delete(mc_pair_t);
486 void mc_pair_free_voidp(void *p);
487 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
488 void MC_visited_pair_delete(mc_visited_pair_t p);
490 void MC_pre_modelcheck_liveness(void);
491 void MC_modelcheck_liveness(void);
492 void MC_show_stack_liveness(xbt_fifo_t stack);
493 void MC_dump_stack_liveness(xbt_fifo_t stack);
495 extern xbt_dynar_t visited_pairs;
496 int is_visited_pair(mc_visited_pair_t pair, int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
499 /********************************** Variables with DWARF **********************************/
501 enum mc_object_info_flags {
502 MC_OBJECT_INFO_NONE = 0,
503 MC_OBJECT_INFO_EXECUTABLE = 1
506 struct s_mc_object_info {
507 enum mc_object_info_flags flags;
509 char *start_exec, *end_exec; // Executable segment
510 char *start_rw, *end_rw; // Read-write segment
511 char *start_ro, *end_ro; // read-only segment
512 xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
513 xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
514 xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
515 xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
517 // Here we sort the minimal information for an efficient (and cache-efficient)
518 // lookup of a function given an instruction pointer.
519 // The entries are sorted by low_pc and a binary search can be used to look them up.
520 xbt_dynar_t functions_index;
523 mc_object_info_t MC_new_object_info(void);
524 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
525 void MC_free_object_info(mc_object_info_t* p);
527 void MC_dwarf_get_variables(mc_object_info_t info);
528 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
529 const char* MC_dwarf_attrname(int attr);
530 const char* MC_dwarf_tagname(int tag);
532 dw_frame_t MC_find_function_by_ip(void* ip);
533 mc_object_info_t MC_ip_find_object_info(void* ip);
535 extern mc_object_info_t mc_libsimgrid_info;
536 extern mc_object_info_t mc_binary_info;
537 extern mc_object_info_t mc_object_infos[2];
538 extern size_t mc_object_infos_size;
540 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
541 void MC_post_process_object_info(mc_object_info_t info);
545 /** \brief a DWARF expression with optional validity contraints */
546 typedef struct s_mc_expression {
549 // Optional validity:
550 void* lowpc, *highpc;
551 } s_mc_expression_t, *mc_expression_t;
553 /** A location list (list of location expressions) */
554 typedef struct s_mc_location_list {
556 mc_expression_t locations;
557 } s_mc_location_list_t, *mc_location_list_t;
559 /** A location is either a location in memory of a register location
563 * * mc_dwarf_resolve_locations or mc_dwarf_resolve_location is used
564 * to find the location of a given location expression or location list;
566 * * mc_get_location_type MUST be used to find the location type;
568 * * for MC_LOCATION_TYPE_ADDRESS, memory_address is the resulting address
570 * * for MC_LOCATION_TYPE_REGISTER, unw_get_reg(l.cursor, l.register_id, value)
571 * and unw_get_reg(l.cursor, l.register_id, value) can be used to read/write
575 typedef struct s_mc_location {
576 void* memory_location;
577 unw_cursor_t* cursor;
579 } s_mc_location_t, *mc_location_t;
581 /** Type of a given location
583 * Use `mc_get_location_type(location)` to find the type.
585 typedef enum mc_location_type {
586 MC_LOCATION_TYPE_ADDRESS,
587 MC_LOCATION_TYPE_REGISTER
590 /** Find the type of a location */
591 static inline __attribute__ ((always_inline))
592 enum mc_location_type mc_get_location_type(mc_location_t location) {
593 if (location->cursor) {
594 return MC_LOCATION_TYPE_REGISTER;
596 return MC_LOCATION_TYPE_ADDRESS;
600 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);
601 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);
603 void mc_dwarf_expression_clear(mc_expression_t expression);
604 void mc_dwarf_expression_init(mc_expression_t expression, size_t len, Dwarf_Op* ops);
606 void mc_dwarf_location_list_clear(mc_location_list_t list);
608 void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
609 void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
611 // ***** Variables and functions
615 Dwarf_Off id; /* Offset in the section (in hexadecimal form) */
616 char *name; /* Name of the type */
617 int byte_size; /* Size in bytes */
618 int element_count; /* Number of elements for array type */
619 char *dw_type_id; /* DW_AT_type id */
620 xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
623 // Location (for members) is either of:
624 struct s_mc_expression location;
627 dw_type_t subtype; // DW_AT_type
628 dw_type_t full_type; // The same (but more complete) type
631 void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot, int process_index);
633 typedef struct s_dw_variable{
634 Dwarf_Off dwarf_offset; /* Global offset of the field. */
641 s_mc_location_list_t locations;
645 mc_object_info_t object_info;
647 }s_dw_variable_t, *dw_variable_t;
654 s_mc_location_list_t frame_base;
655 xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
656 unsigned long int id; /* DWARF offset of the subprogram */
657 xbt_dynar_t /* <dw_frame_t> */ scopes;
658 Dwarf_Off abstract_origin_id;
659 mc_object_info_t object_info;
662 struct s_mc_function_index_item {
663 void* low_pc, *high_pc;
667 void mc_frame_free(dw_frame_t freme);
669 void dw_type_free(dw_type_t t);
670 void dw_variable_free(dw_variable_t v);
671 void dw_variable_free_voidp(void *t);
673 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
674 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
675 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
676 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
678 /** Find the DWARF offset for this ELF object
680 * An offset is applied to address found in DWARF:
683 * <li>for an executable obejct, addresses are virtual address
684 * (there is no offset) i.e. \f$\text{virtual address} = \{dwarf address}\f$;</li>
685 * <li>for a shared object, the addreses are offset from the begining
686 * of the shared object (the base address of the mapped shared
687 * object must be used as offset
688 * i.e. \f$\text{virtual address} = \text{shared object base address}
689 * + \text{dwarf address}\f$.</li>
692 void* MC_object_base_address(mc_object_info_t info);
694 /********************************** DWARF **********************************/
696 #define MC_EXPRESSION_STACK_SIZE 64
698 #define MC_EXPRESSION_OK 0
699 #define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
700 #define MC_EXPRESSION_E_STACK_OVERFLOW 2
701 #define MC_EXPRESSION_E_STACK_UNDERFLOW 3
702 #define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
703 #define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
704 #define MC_EXPRESSION_E_NO_BASE_ADDRESS 6
706 typedef struct s_mc_expression_state {
707 uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
710 unw_cursor_t* cursor;
712 mc_snapshot_t snapshot;
713 mc_object_info_t object_info;
715 } s_mc_expression_state_t, *mc_expression_state_t;
717 int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
719 void* mc_find_frame_base(dw_frame_t frame, mc_object_info_t object_info, unw_cursor_t* unw_cursor);
721 /********************************** Miscellaneous **********************************/
723 typedef struct s_local_variable{
724 dw_frame_t subprogram;
730 }s_local_variable_t, *local_variable_t;
732 /********************************* Communications pattern ***************************/
734 typedef struct s_mc_comm_pattern{
737 e_smx_comm_type_t type;
738 unsigned long src_proc;
739 unsigned long dst_proc;
740 const char *src_host;
741 const char *dst_host;
745 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
747 extern xbt_dynar_t initial_communications_pattern;
748 extern xbt_dynar_t communications_pattern;
749 extern xbt_dynar_t incomplete_communications_pattern;
751 // Can we use the SIMIX syscall for this?
752 typedef enum mc_call_type {
757 MC_CALL_TYPE_WAITANY,
760 static inline mc_call_type mc_get_call_type(smx_simcall_t req) {
762 case SIMCALL_COMM_ISEND:
763 return MC_CALL_TYPE_SEND;
764 case SIMCALL_COMM_IRECV:
765 return MC_CALL_TYPE_RECV;
766 case SIMCALL_COMM_WAIT:
767 return MC_CALL_TYPE_WAIT;
768 case SIMCALL_COMM_WAITANY:
769 return MC_CALL_TYPE_WAITANY;
771 return MC_CALL_TYPE_NONE;
775 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, mc_call_type call_type);
776 void mc_update_comm_pattern(mc_call_type call_type, smx_simcall_t request, int value, xbt_dynar_t current_pattern);
777 void complete_comm_pattern(xbt_dynar_t list, smx_synchro_t comm);
778 void MC_pre_modelcheck_comm_determinism(void);
779 void MC_modelcheck_comm_determinism(void);
781 /* *********** Sets *********** */
783 typedef struct s_mc_address_set *mc_address_set_t;
785 mc_address_set_t mc_address_set_new();
786 void mc_address_set_free(mc_address_set_t* p);
787 void mc_address_add(mc_address_set_t p, const void* value);
788 bool mc_address_test(mc_address_set_t p, const void* value);
790 /* *********** Hash *********** */
792 /** \brief Hash the current state
793 * \param num_state number of states
794 * \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
795 * \result resulting hash
797 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
799 /* *********** Snapshot *********** */
801 static inline __attribute__((always_inline))
802 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region)
804 size_t pageno = mc_page_number(region->start_addr, (void*) addr);
805 size_t snapshot_pageno = region->page_numbers[pageno];
806 const void* snapshot_page = mc_page_store_get_page(mc_model_checker->pages, snapshot_pageno);
807 return (char*) snapshot_page + mc_page_offset((void*) addr);
810 /** \brief Translate a pointer from process address space to snapshot address space
812 * The address space contains snapshot of the main/application memory:
813 * this function finds the address in a given snaphot for a given
814 * real/application address.
816 * For read only memory regions and other regions which are not int the
817 * snapshot, the address is not changed.
819 * \param addr Application address
820 * \param snapshot The snapshot of interest (if NULL no translation is done)
821 * \return Translated address in the snapshot address space
823 static inline __attribute__((always_inline))
824 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot, int process_index)
827 // If not in a process state/clone:
829 return (uintptr_t *) addr;
832 mc_mem_region_t region = mc_get_snapshot_region((void*) addr, snapshot, process_index);
834 xbt_assert(mc_region_contain(region, (void*) addr), "Trying to read out of the region boundary.");
837 return (void *) addr;
841 else if (region->data) {
842 uintptr_t offset = addr - (uintptr_t) region->start_addr;
843 return (void *) ((uintptr_t) region->data + offset);
846 // Per-page snapshot:
847 else if (region->page_numbers) {
848 return mc_translate_address_region(addr, region);
852 xbt_die("No data for this memory region");
856 static inline __attribute__ ((always_inline))
857 void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot) {
859 xbt_die("snapshot is NULL");
860 void** addr = &(std_heap->breakval);
861 return mc_snapshot_read_pointer(addr, snapshot, MC_ANY_PROCESS_INDEX);
864 static inline __attribute__ ((always_inline))
865 void* mc_snapshot_read_pointer(void* addr, mc_snapshot_t snapshot, int process_index)
868 return *(void**) mc_snapshot_read(addr, snapshot, process_index, &res, sizeof(void*));
871 /** @brief Read memory from a snapshot region
873 * @param addr Process (non-snapshot) address of the data
874 * @param region Snapshot memory region where the data is located
875 * @param target Buffer to store the value
876 * @param size Size of the data to read in bytes
877 * @return Pointer where the data is located (target buffer of original location)
879 static inline __attribute__((always_inline))
880 void* mc_snapshot_read_region(void* addr, mc_mem_region_t region, void* target, size_t size)
885 uintptr_t offset = (char*) addr - (char*) region->start_addr;
887 xbt_assert(mc_region_contain(region, addr),
888 "Trying to read out of the region boundary.");
890 // Linear memory region:
892 return (char*) region->data + offset;
895 // Fragmented memory region:
896 else if (region->page_numbers) {
897 // Last byte of the region:
898 void* end = (char*) addr + size - 1;
899 if( mc_same_page(addr, end) ) {
900 // The memory is contained in a single page:
901 return mc_translate_address_region((uintptr_t) addr, region);
903 // The memory spans several pages:
904 return mc_snapshot_read_fragmented(addr, region, target, size);
909 xbt_die("No data available for this region");
913 static inline __attribute__ ((always_inline))
914 void* mc_snapshot_read_pointer_region(void* addr, mc_mem_region_t region)
917 return *(void**) mc_snapshot_read_region(addr, region, &res, sizeof(void*));
920 #define MC_LOG_REQUEST(log, req, value) \
921 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) { \
922 char* req_str = MC_request_to_string(req, value); \
923 XBT_DEBUG("Execute: %s", req_str); \
927 /** @brief Dump the stacks of the application processes
929 * This functions is currently not used but it is quite convenient
930 * to call from the debugger.
932 * Does not work when an application thread is running.
934 void MC_dump_stacks(FILE* file);