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