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