src/mc/mc_private.h

   1 /* Copyright (c) 2007-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #ifndef MC_PRIVATE_H
   8 #define MC_PRIVATE_H
   9
  10 #include "simgrid_config.h"
  11 #include <stdio.h>
  12 #include <stdbool.h>
  13 #ifndef WIN32
  14 #include <sys/mman.h>
  15 #endif
  16 #include <elfutils/libdw.h>
  17
  18 #include "mc/mc.h"
  19 #include "mc/datatypes.h"
  20 #include "xbt/fifo.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"
  27 #include "xbt/hash.h"
  28 #include "msg/msg.h"
  29 #include "msg/datatypes.h"
  30 #include "xbt/strbuff.h"
  31 #include "xbt/parmap.h"
  32 #include "mc_mmu.h"
  33
  34 SG_BEGIN_DECL()
  35
  36 typedef struct s_dw_frame s_dw_frame_t, *dw_frame_t;
  37 typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
  38
  39 /****************************** Snapshots ***********************************/
  40
  41 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
  42
  43 typedef struct s_mc_mem_region{
  44   // Real address:
  45   void *start_addr;
  46   // Copy of the datra:
  47   void *data;
  48   // Size of the data region:
  49   size_t size;
  50   // For per-page snapshots, this is an array to the number of
  51   size_t* page_numbers;
  52 } s_mc_mem_region_t, *mc_mem_region_t;
  53
  54 static inline  __attribute__ ((always_inline))
  55 bool mc_region_contain(mc_mem_region_t region, void* p)
  56 {
  57   return p >= region->start_addr &&
  58     p < (void*)((char*) region->start_addr + region->size);
  59 }
  60
  61 /** Ignored data
  62  *
  63  *  Some parts of the snapshot are ignored by zeroing them out: the real
  64  *  values is stored here.
  65  * */
  66 typedef struct s_mc_snapshot_ignored_data {
  67   void* start;
  68   size_t size;
  69   void* data;
  70 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
  71
  72 typedef struct s_mc_snapshot{
  73   size_t heap_bytes_used;
  74   mc_mem_region_t regions[NB_REGIONS];
  75   xbt_dynar_t enabled_processes;
  76   mc_mem_region_t* privatization_regions;
  77   int privatization_index;
  78   size_t *stack_sizes;
  79   xbt_dynar_t stacks;
  80   xbt_dynar_t to_ignore;
  81   uint64_t hash;
  82   xbt_dynar_t ignored_data;
  83 } s_mc_snapshot_t, *mc_snapshot_t;
  84
  85 mc_mem_region_t mc_get_snapshot_region(void* addr, mc_snapshot_t snapshot);
  86
  87 static inline __attribute__ ((always_inline))
  88 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, mc_mem_region_t region)
  89 {
  90   if (mc_region_contain(region, addr))
  91     return region;
  92   else
  93     return mc_get_snapshot_region(addr, snapshot);
  94 }
  95
  96 /** Information about a given stack frame
  97  *
  98  */
  99 typedef struct s_mc_stack_frame {
 100   /** Instruction pointer */
 101   unw_word_t ip;
 102   /** Stack pointer */
 103   unw_word_t sp;
 104   unw_word_t frame_base;
 105   dw_frame_t frame;
 106   char* frame_name;
 107   unw_cursor_t unw_cursor;
 108 } s_mc_stack_frame_t, *mc_stack_frame_t;
 109
 110 typedef struct s_mc_snapshot_stack{
 111   xbt_dynar_t local_variables;
 112   xbt_dynar_t stack_frames; // mc_stack_frame_t
 113 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
 114
 115 typedef struct s_mc_global_t{
 116   mc_snapshot_t snapshot;
 117   int raw_mem_set;
 118   int prev_pair;
 119   char *prev_req;
 120   int initial_communications_pattern_done;
 121   int comm_deterministic;
 122   int send_deterministic;
 123 }s_mc_global_t, *mc_global_t;
 124
 125 typedef struct s_mc_checkpoint_ignore_region{
 126   void *addr;
 127   size_t size;
 128 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
 129
 130 static void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
 131
 132 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
 133 mc_snapshot_t MC_take_snapshot(int num_state);
 134 void MC_restore_snapshot(mc_snapshot_t);
 135 void MC_free_snapshot(mc_snapshot_t);
 136
 137 int mc_important_snapshot(mc_snapshot_t snapshot);
 138
 139 size_t* mc_take_page_snapshot_region(void* data, size_t page_count, uint64_t* pagemap, size_t* reference_pages);
 140 void mc_free_page_snapshot_region(size_t* pagenos, size_t page_count);
 141 void mc_restore_page_snapshot_region(mc_mem_region_t region, size_t page_count, uint64_t* pagemap, mc_mem_region_t reference_region);
 142
 143 mc_mem_region_t mc_region_new_sparse(int type, void *start_addr, size_t size, mc_mem_region_t ref_reg);
 144 void mc_region_restore_sparse(mc_mem_region_t reg, mc_mem_region_t ref_reg);
 145 void mc_softdirty_reset();
 146
 147 typedef struct s_mc_pages_store s_mc_pages_store_t, * mc_pages_store_t;
 148 mc_pages_store_t mc_pages_store_new();
 149
 150 static inline __attribute__((always_inline))
 151 bool mc_snapshot_region_linear(mc_mem_region_t region) {
 152   return !region || !region->data;
 153 }
 154
 155 void* mc_snapshot_read_region(void* addr, mc_mem_region_t region, void* target, size_t size);
 156 void* mc_snapshot_read(void* addr, mc_snapshot_t snapshot, void* target, size_t size);
 157 int mc_snapshot_region_memcp(
 158   void* addr1, mc_mem_region_t region1,
 159   void* addr2, mc_mem_region_t region2, size_t size);
 160 int mc_snapshot_memcp(
 161   void* addr1, mc_snapshot_t snapshot1,
 162   void* addr2, mc_snapshot_t snapshot2, size_t size);
 163
 164 static void* mc_snapshot_read_pointer(void* addr, mc_snapshot_t snapshot);
 165
 166 /** @brief State of the model-checker (global variables for the model checker)
 167  *
 168  *  Each part of the state of the model chercker represented as a global
 169  *  variable prevents some sharing between snapshots and must be ignored.
 170  *  By moving as much state as possible in this structure allocated
 171  *  on the model-chercker heap, we avoid those issues.
 172  */
 173 typedef struct s_mc_model_checker {
 174   // This is the parent snapshot of the current state:
 175   mc_snapshot_t parent_snapshot;
 176   mc_pages_store_t pages;
 177   int fd_clear_refs;
 178   int fd_pagemap;
 179 } s_mc_model_checker_t, *mc_model_checker_t;
 180
 181 extern mc_model_checker_t mc_model_checker;
 182
 183 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region);
 184
 185 /** \brief Translate a pointer from process address space to snapshot address space
 186  *
 187  *  The address space contains snapshot of the main/application memory:
 188  *  this function finds the address in a given snaphot for a given
 189  *  real/application address.
 190  *
 191  *  For read only memory regions and other regions which are not int the
 192  *  snapshot, the address is not changed.
 193  *
 194  *  \param addr     Application address
 195  *  \param snapshot The snapshot of interest (if NULL no translation is done)
 196  *  \return         Translated address in the snapshot address space
 197  * */
 198 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot);
 199
 200 extern xbt_dynar_t mc_checkpoint_ignore;
 201
 202 /********************************* MC Global **********************************/
 203
 204 extern double *mc_time;
 205 extern FILE *dot_output;
 206 extern const char* colors[13];
 207 extern xbt_parmap_t parmap;
 208
 209 extern int user_max_depth_reached;
 210
 211 int MC_deadlock_check(void);
 212 void MC_replay(xbt_fifo_t stack, int start);
 213 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
 214 void MC_wait_for_requests(void);
 215 void MC_show_deadlock(smx_simcall_t req);
 216 void MC_show_stack_safety(xbt_fifo_t stack);
 217 void MC_dump_stack_safety(xbt_fifo_t stack);
 218 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
 219
 220 extern xbt_fifo_t mc_stack;
 221 int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
 222
 223
 224 /********************************* Requests ***********************************/
 225
 226 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
 227 char* MC_request_to_string(smx_simcall_t req, int value);
 228 unsigned int MC_request_testany_fail(smx_simcall_t req);
 229 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
 230 int MC_request_is_visible(smx_simcall_t req);
 231 int MC_request_is_enabled(smx_simcall_t req);
 232 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
 233 int MC_process_is_enabled(smx_process_t process);
 234 char *MC_request_get_dot_output(smx_simcall_t req, int value);
 235
 236
 237 /******************************** States **************************************/
 238
 239 extern mc_global_t initial_global_state;
 240
 241 /* Possible exploration status of a process in a state */
 242 typedef enum {
 243   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
 244   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
 245   MC_MORE_INTERLEAVE,       /* Interleave twice the process (for mc_random simcall) */
 246   MC_DONE                   /* Already interleaved */
 247 } e_mc_process_state_t;
 248
 249 /* On every state, each process has an entry of the following type */
 250 typedef struct mc_procstate{
 251   e_mc_process_state_t state;       /* Exploration control information */
 252   unsigned int interleave_count;    /* Number of times that the process was
 253                                        interleaved */
 254 } s_mc_procstate_t, *mc_procstate_t;
 255
 256 /* An exploration state is composed of: */
 257 typedef struct mc_state {
 258   unsigned long max_pid;            /* Maximum pid at state's creation time */
 259   mc_procstate_t proc_status;       /* State's exploration status by process */
 260   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
 261   s_smx_simcall_t internal_req;         /* Internal translation of request */
 262   s_smx_simcall_t executed_req;         /* The executed request of the state */
 263   int req_num;                      /* The request number (in the case of a
 264                                        multi-request like waitany ) */
 265   mc_snapshot_t system_state;      /* Snapshot of system state */
 266   int num;
 267 } s_mc_state_t, *mc_state_t;
 268
 269 mc_state_t MC_state_new(void);
 270 void MC_state_delete(mc_state_t state);
 271 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 272 unsigned int MC_state_interleave_size(mc_state_t state);
 273 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 274 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
 275 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
 276 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
 277 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
 278 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
 279
 280
 281 /****************************** Statistics ************************************/
 282
 283 typedef struct mc_stats {
 284   unsigned long state_size;
 285   unsigned long visited_states;
 286   unsigned long visited_pairs;
 287   unsigned long expanded_states;
 288   unsigned long expanded_pairs;
 289   unsigned long executed_transitions;
 290 } s_mc_stats_t, *mc_stats_t;
 291
 292 extern mc_stats_t mc_stats;
 293
 294 void MC_print_statistics(mc_stats_t);
 295
 296
 297 /********************************** MEMORY ******************************/
 298 /* The possible memory modes for the modelchecker are standard and raw. */
 299 /* Normally the system should operate in std, for switching to raw mode */
 300 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 301
 302 extern void *std_heap;
 303 extern void *mc_heap;
 304
 305
 306 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 307 /* an API to query about the status of a heap, we simply call mmstats and */
 308 /* because I now how does structure looks like, then I redefine it here */
 309
 310 /* struct mstats { */
 311 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
 312 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
 313 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
 314 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
 315 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
 316 /* }; */
 317
 318 #define MC_SET_MC_HEAP    mmalloc_set_current_heap(mc_heap)
 319 #define MC_SET_STD_HEAP  mmalloc_set_current_heap(std_heap)
 320
 321
 322 /******************************* MEMORY MAPPINGS ***************************/
 323 /* These functions and data structures implements a binary interface for   */
 324 /* the proc maps ascii interface                                           */
 325
 326 /* Each field is defined as documented in proc's manual page  */
 327 typedef struct s_map_region {
 328
 329   void *start_addr;             /* Start address of the map */
 330   void *end_addr;               /* End address of the map */
 331   int prot;                     /* Memory protection */
 332   int flags;                    /* Additional memory flags */
 333   void *offset;                 /* Offset in the file/whatever */
 334   char dev_major;               /* Major of the device */
 335   char dev_minor;               /* Minor of the device */
 336   unsigned long inode;          /* Inode in the device */
 337   char *pathname;               /* Path name of the mapped file */
 338
 339 } s_map_region_t;
 340
 341 typedef struct s_memory_map {
 342
 343   s_map_region_t *regions;      /* Pointer to an array of regions */
 344   int mapsize;                  /* Number of regions in the memory */
 345
 346 } s_memory_map_t, *memory_map_t;
 347
 348
 349 void MC_init_memory_map_info(void);
 350 memory_map_t MC_get_memory_map(void);
 351 void MC_free_memory_map(memory_map_t map);
 352
 353 extern char *libsimgrid_path;
 354
 355 /********************************** Snapshot comparison **********************************/
 356
 357 typedef struct s_mc_comparison_times{
 358   double nb_processes_comparison_time;
 359   double bytes_used_comparison_time;
 360   double stacks_sizes_comparison_time;
 361   double binary_global_variables_comparison_time;
 362   double libsimgrid_global_variables_comparison_time;
 363   double heap_comparison_time;
 364   double stacks_comparison_time;
 365 }s_mc_comparison_times_t, *mc_comparison_times_t;
 366
 367 extern __thread mc_comparison_times_t mc_comp_times;
 368 extern __thread double mc_snapshot_comparison_time;
 369
 370 int snapshot_compare(void *state1, void *state2);
 371 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
 372 void print_comparison_times(void);
 373
 374 //#define MC_DEBUG 1
 375 #define MC_VERBOSE 1
 376
 377 /********************************** Safety verification **************************************/
 378
 379 typedef enum {
 380   e_mc_reduce_unset,
 381   e_mc_reduce_none,
 382   e_mc_reduce_dpor
 383 } e_mc_reduce_t;
 384
 385 extern e_mc_reduce_t mc_reduce_kind;
 386 extern xbt_dict_t first_enabled_state;
 387
 388 void MC_pre_modelcheck_safety(void);
 389 void MC_modelcheck_safety(void);
 390
 391 typedef struct s_mc_visited_state{
 392   mc_snapshot_t system_state;
 393   size_t heap_bytes_used;
 394   int nb_processes;
 395   int num;
 396   int other_num; // dot_output for
 397 }s_mc_visited_state_t, *mc_visited_state_t;
 398
 399 extern xbt_dynar_t visited_states;
 400 int is_visited_state(void);
 401 void visited_state_free(mc_visited_state_t state);
 402 void visited_state_free_voidp(void *s);
 403
 404 /********************************** Liveness verification **************************************/
 405
 406 extern xbt_automaton_t _mc_property_automaton;
 407
 408 typedef struct s_mc_pair{
 409   int num;
 410   int search_cycle;
 411   mc_state_t graph_state; /* System state included */
 412   xbt_automaton_state_t automaton_state;
 413   xbt_dynar_t atomic_propositions;
 414   int requests;
 415 }s_mc_pair_t, *mc_pair_t;
 416
 417 typedef struct s_mc_visited_pair{
 418   int num;
 419   int other_num; /* Dot output for */
 420   int acceptance_pair;
 421   mc_state_t graph_state; /* System state included */
 422   xbt_automaton_state_t automaton_state;
 423   xbt_dynar_t atomic_propositions;
 424   size_t heap_bytes_used;
 425   int nb_processes;
 426   int acceptance_removed;
 427   int visited_removed;
 428 }s_mc_visited_pair_t, *mc_visited_pair_t;
 429
 430 mc_pair_t MC_pair_new(void);
 431 void MC_pair_delete(mc_pair_t);
 432 void mc_pair_free_voidp(void *p);
 433 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
 434 void MC_visited_pair_delete(mc_visited_pair_t p);
 435
 436 void MC_pre_modelcheck_liveness(void);
 437 void MC_modelcheck_liveness(void);
 438 void MC_show_stack_liveness(xbt_fifo_t stack);
 439 void MC_dump_stack_liveness(xbt_fifo_t stack);
 440
 441 extern xbt_dynar_t visited_pairs;
 442 int is_visited_pair(mc_visited_pair_t pair, int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
 443
 444
 445 /********************************** Variables with DWARF **********************************/
 446
 447 #define MC_OBJECT_INFO_EXECUTABLE 1
 448
 449 struct s_mc_object_info {
 450   size_t flags;
 451   char* file_name;
 452   char *start_exec, *end_exec; // Executable segment
 453   char *start_rw, *end_rw; // Read-write segment
 454   char *start_ro, *end_ro; // read-only segment
 455   xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
 456   xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
 457   xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
 458   xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
 459
 460   // Here we sort the minimal information for an efficient (and cache-efficient)
 461   // lookup of a function given an instruction pointer.
 462   // The entries are sorted by low_pc and a binary search can be used to look them up.
 463   xbt_dynar_t functions_index;
 464 };
 465
 466 mc_object_info_t MC_new_object_info(void);
 467 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
 468 void MC_free_object_info(mc_object_info_t* p);
 469
 470 void MC_dwarf_get_variables(mc_object_info_t info);
 471 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
 472 const char* MC_dwarf_attrname(int attr);
 473 const char* MC_dwarf_tagname(int tag);
 474
 475 dw_frame_t MC_find_function_by_ip(void* ip);
 476 mc_object_info_t MC_ip_find_object_info(void* ip);
 477
 478 extern mc_object_info_t mc_libsimgrid_info;
 479 extern mc_object_info_t mc_binary_info;
 480 extern mc_object_info_t mc_object_infos[2];
 481 extern size_t mc_object_infos_size;
 482
 483 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
 484 void MC_post_process_types(mc_object_info_t info);
 485 void MC_post_process_object_info(mc_object_info_t info);
 486
 487 // ***** Expressions
 488
 489 /** \brief a DWARF expression with optional validity contraints */
 490 typedef struct s_mc_expression {
 491   size_t size;
 492   Dwarf_Op* ops;
 493   // Optional validity:
 494   void* lowpc, *highpc;
 495 } s_mc_expression_t, *mc_expression_t;
 496
 497 /** A location list (list of location expressions) */
 498 typedef struct s_mc_location_list {
 499   size_t size;
 500   mc_expression_t locations;
 501 } s_mc_location_list_t, *mc_location_list_t;
 502
 503 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);
 504 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);
 505
 506 void mc_dwarf_expression_clear(mc_expression_t expression);
 507 void mc_dwarf_expression_init(mc_expression_t expression, size_t len, Dwarf_Op* ops);
 508
 509 void mc_dwarf_location_list_clear(mc_location_list_t list);
 510
 511 void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
 512 void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
 513
 514 // ***** Variables and functions
 515
 516 struct s_dw_type{
 517   e_dw_type_type type;
 518   Dwarf_Off id; /* Offset in the section (in hexadecimal form) */
 519   char *name; /* Name of the type */
 520   int byte_size; /* Size in bytes */
 521   int element_count; /* Number of elements for array type */
 522   char *dw_type_id; /* DW_AT_type id */
 523   xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
 524   int is_pointer_type;
 525
 526   // Location (for members) is either of:
 527   struct s_mc_expression location;
 528   int offset;
 529
 530   dw_type_t subtype; // DW_AT_type
 531   dw_type_t full_type; // The same (but more complete) type
 532 };
 533
 534 void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
 535
 536 typedef struct s_dw_variable{
 537   Dwarf_Off dwarf_offset; /* Global offset of the field. */
 538   int global;
 539   char *name;
 540   char *type_origin;
 541   dw_type_t type;
 542
 543   // Use either of:
 544   s_mc_location_list_t locations;
 545   void* address;
 546
 547   size_t start_scope;
 548   mc_object_info_t object_info;
 549
 550 }s_dw_variable_t, *dw_variable_t;
 551
 552 struct s_dw_frame{
 553   int tag;
 554   char *name;
 555   void *low_pc;
 556   void *high_pc;
 557   s_mc_location_list_t frame_base;
 558   xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
 559   unsigned long int id; /* DWARF offset of the subprogram */
 560   xbt_dynar_t /* <dw_frame_t> */ scopes;
 561   Dwarf_Off abstract_origin_id;
 562   mc_object_info_t object_info;
 563 };
 564
 565 struct s_mc_function_index_item {
 566   void* low_pc, *high_pc;
 567   dw_frame_t function;
 568 };
 569
 570 void mc_frame_free(dw_frame_t freme);
 571
 572 void dw_type_free(dw_type_t t);
 573 void dw_variable_free(dw_variable_t v);
 574 void dw_variable_free_voidp(void *t);
 575
 576 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
 577 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 578 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 579 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 580
 581 /** Find the DWARF offset for this ELF object
 582  *
 583  *  An offset is applied to address found in DWARF:
 584  *
 585  *  <ul>
 586  *    <li>for an executable obejct, addresses are virtual address
 587  *        (there is no offset) i.e. \f$\text{virtual address} = \{dwarf address}\f$;</li>
 588  *    <li>for a shared object, the addreses are offset from the begining
 589  *        of the shared object (the base address of the mapped shared
 590  *        object must be used as offset
 591  *        i.e. \f$\text{virtual address} = \text{shared object base address}
 592  *             + \text{dwarf address}\f$.</li>
 593  *
 594  */
 595 void* MC_object_base_address(mc_object_info_t info);
 596
 597 /********************************** DWARF **********************************/
 598
 599 #define MC_EXPRESSION_STACK_SIZE 64
 600
 601 #define MC_EXPRESSION_OK 0
 602 #define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
 603 #define MC_EXPRESSION_E_STACK_OVERFLOW 2
 604 #define MC_EXPRESSION_E_STACK_UNDERFLOW 3
 605 #define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
 606 #define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
 607 #define MC_EXPRESSION_E_NO_BASE_ADDRESS 6
 608
 609 typedef struct s_mc_expression_state {
 610   uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
 611   size_t stack_size;
 612
 613   unw_cursor_t* cursor;
 614   void* frame_base;
 615   mc_snapshot_t snapshot;
 616   mc_object_info_t object_info;
 617 } s_mc_expression_state_t, *mc_expression_state_t;
 618
 619 int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
 620
 621 void* mc_find_frame_base(dw_frame_t frame, mc_object_info_t object_info, unw_cursor_t* unw_cursor);
 622
 623 /********************************** Miscellaneous **********************************/
 624
 625 typedef struct s_local_variable{
 626   dw_frame_t subprogram;
 627   unsigned long ip;
 628   char *name;
 629   dw_type_t type;
 630   void *address;
 631   int region;
 632 }s_local_variable_t, *local_variable_t;
 633
 634 /********************************* Communications pattern ***************************/
 635
 636 typedef struct s_mc_comm_pattern{
 637   int num;
 638   smx_action_t comm;
 639   e_smx_comm_type_t type;
 640   unsigned long src_proc;
 641   unsigned long dst_proc;
 642   const char *src_host;
 643   const char *dst_host;
 644   char *rdv;
 645   ssize_t data_size;
 646   void *data;
 647 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
 648
 649 extern xbt_dynar_t communications_pattern;
 650 extern xbt_dynar_t incomplete_communications_pattern;
 651
 652 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
 653 void complete_comm_pattern(xbt_dynar_t list, smx_action_t comm);
 654 void MC_pre_modelcheck_comm_determinism(void);
 655 void MC_modelcheck_comm_determinism(void);
 656
 657 /* *********** Sets *********** */
 658
 659 typedef struct s_mc_address_set *mc_address_set_t;
 660
 661 mc_address_set_t mc_address_set_new();
 662 void mc_address_set_free(mc_address_set_t* p);
 663 void mc_address_add(mc_address_set_t p, const void* value);
 664 bool mc_address_test(mc_address_set_t p, const void* value);
 665
 666 /* *********** Hash *********** */
 667
 668 /** \brief Hash the current state
 669  *  \param num_state number of states
 670  *  \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
 671  *  \result resulting hash
 672  * */
 673 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
 674
 675 //
 676
 677 static inline __attribute__ ((always_inline))
 678   void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot) {
 679   if(snapshot==NULL)
 680       xbt_die("snapshot is NULL");
 681   void** addr = &((xbt_mheap_t)std_heap)->breakval;
 682   return mc_snapshot_read_pointer(addr, snapshot);
 683 }
 684
 685 static inline __attribute__ ((always_inline))
 686 void* mc_snapshot_read_pointer(void* addr, mc_snapshot_t snapshot)
 687 {
 688   void* res;
 689   return *(void**) mc_snapshot_read(addr, snapshot, &res, sizeof(void*));
 690 }
 691
 692 SG_END_DECL()
 693
 694 #endif
 695