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