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_base.h"
  20 #include "mc/datatypes.h"
  21 #include "xbt/fifo.h"
  22 #include "xbt/config.h"
  23 #include "xbt/function_types.h"
  24 #include "xbt/mmalloc.h"
  25 #include "../simix/smx_private.h"
  26 #include "../xbt/mmalloc/mmprivate.h"
  27 #include "xbt/automaton.h"
  28 #include "xbt/hash.h"
  29 #include "msg/msg.h"
  30 #include "msg/datatypes.h"
  31 #include "xbt/strbuff.h"
  32 #include "xbt/parmap.h"
  33 #include "mc_mmu.h"
  34 #include "mc_page_store.h"
  35 #include "mc_interface.h"
  36
  37 SG_BEGIN_DECL()
  38
  39 typedef struct s_dw_frame s_dw_frame_t, *dw_frame_t;
  40 typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
  41
  42 /****************************** Snapshots ***********************************/
  43
  44 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
  45
  46 /** @brief Copy/snapshot of a given memory region
  47  *
  48  *  Two types of region snapshots exist:
  49  *  <ul>
  50  *    <li>flat/dense snapshots are a simple copy of the region;</li>
  51  *    <li>sparse/per-page snapshots are snaapshots which shared
  52  *    identical pages.</li>
  53  *  </ul>
  54  */
  55 typedef struct s_mc_mem_region{
  56   /** @brief  Virtual address of the region in the simulated process */
  57   void *start_addr;
  58
  59   /** @brief Permanent virtual address of the region
  60    *
  61    * This is usually the same address as the simuilated process address.
  62    * However, when using SMPI privatization of global variables,
  63    * each SMPI process has its own set of global variables stored
  64    * at a different virtual address. The scheduler maps those region
  65    * on the region of the global variables.
  66    *
  67    * */
  68   void *permanent_addr;
  69
  70   /** @brief Copy of the snapshot for flat snapshots regions (NULL otherwise) */
  71   void *data;
  72
  73   /** @brief Size of the data region in bytes */
  74   size_t size;
  75
  76   /** @brief Pages indices in the page store for per-page snapshots (NULL otherwise) */
  77   size_t* page_numbers;
  78
  79 } s_mc_mem_region_t, *mc_mem_region_t;
  80
  81 static inline  __attribute__ ((always_inline))
  82 bool mc_region_contain(mc_mem_region_t region, void* p)
  83 {
  84   return p >= region->start_addr &&
  85     p < (void*)((char*) region->start_addr + region->size);
  86 }
  87
  88 /** Ignored data
  89  *
  90  *  Some parts of the snapshot are ignored by zeroing them out: the real
  91  *  values is stored here.
  92  * */
  93 typedef struct s_mc_snapshot_ignored_data {
  94   void* start;
  95   size_t size;
  96   void* data;
  97 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
  98
  99 typedef struct s_fd_infos{
 100   char *filename;
 101   int number;
 102   off_t current_position;
 103   int flags;
 104 }s_fd_infos_t, *fd_infos_t;
 105
 106 typedef struct s_mc_snapshot{
 107   size_t heap_bytes_used;
 108   mc_mem_region_t regions[NB_REGIONS];
 109   xbt_dynar_t enabled_processes;
 110   mc_mem_region_t* privatization_regions;
 111   int privatization_index;
 112   size_t *stack_sizes;
 113   xbt_dynar_t stacks;
 114   xbt_dynar_t to_ignore;
 115   uint64_t hash;
 116   xbt_dynar_t ignored_data;
 117   int total_fd;
 118   fd_infos_t *current_fd;
 119 } s_mc_snapshot_t;
 120
 121
 122 /** @brief Process index used when no process is available
 123  *
 124  *  The expected behaviour is that if a process index is needed it will fail.
 125  * */
 126 #define MC_NO_PROCESS_INDEX -1
 127
 128 /** @brief Process index when any process is suitable
 129  *
 130  * We could use a special negative value in the future.
 131  */
 132 #define MC_ANY_PROCESS_INDEX 0
 133
 134 mc_mem_region_t mc_get_snapshot_region(void* addr, mc_snapshot_t snapshot, int process_index);
 135
 136 static inline __attribute__ ((always_inline))
 137 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
 138 {
 139   if (mc_region_contain(region, addr))
 140     return region;
 141   else
 142     return mc_get_snapshot_region(addr, snapshot, process_index);
 143 }
 144
 145 /** Information about a given stack frame
 146  *
 147  */
 148 typedef struct s_mc_stack_frame {
 149   /** Instruction pointer */
 150   unw_word_t ip;
 151   /** Stack pointer */
 152   unw_word_t sp;
 153   unw_word_t frame_base;
 154   dw_frame_t frame;
 155   char* frame_name;
 156   unw_cursor_t unw_cursor;
 157 } s_mc_stack_frame_t, *mc_stack_frame_t;
 158
 159 typedef struct s_mc_snapshot_stack{
 160   xbt_dynar_t local_variables;
 161   xbt_dynar_t stack_frames; // mc_stack_frame_t
 162   int process_index;
 163 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
 164
 165 typedef struct s_mc_global_t{
 166   mc_snapshot_t snapshot;
 167   int raw_mem_set;
 168   int prev_pair;
 169   char *prev_req;
 170   int initial_communications_pattern_done;
 171   int comm_deterministic;
 172   int send_deterministic;
 173 }s_mc_global_t, *mc_global_t;
 174
 175 typedef struct s_mc_checkpoint_ignore_region{
 176   void *addr;
 177   size_t size;
 178 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
 179
 180 static void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
 181
 182 mc_snapshot_t MC_take_snapshot(int num_state);
 183 void MC_restore_snapshot(mc_snapshot_t);
 184 void MC_free_snapshot(mc_snapshot_t);
 185
 186 int mc_important_snapshot(mc_snapshot_t snapshot);
 187
 188 size_t* mc_take_page_snapshot_region(void* data, size_t page_count, uint64_t* pagemap, size_t* reference_pages);
 189 void mc_free_page_snapshot_region(size_t* pagenos, size_t page_count);
 190 void mc_restore_page_snapshot_region(void* start_addr, size_t page_count, size_t* pagenos, uint64_t* pagemap, size_t* reference_pagenos);
 191
 192 mc_mem_region_t mc_region_new_sparse(int type, void *start_addr, void* data_addr, size_t size, mc_mem_region_t ref_reg);
 193 void MC_region_destroy(mc_mem_region_t reg);
 194 void mc_region_restore_sparse(mc_mem_region_t reg, mc_mem_region_t ref_reg);
 195 void mc_softdirty_reset();
 196
 197 static inline __attribute__((always_inline))
 198 bool mc_snapshot_region_linear(mc_mem_region_t region) {
 199   return !region || !region->data;
 200 }
 201
 202 void* mc_snapshot_read_fragmented(void* addr, mc_mem_region_t region, void* target, size_t size);
 203
 204 void* mc_snapshot_read(void* addr, mc_snapshot_t snapshot, int process_index, void* target, size_t size);
 205 int mc_snapshot_region_memcmp(
 206   void* addr1, mc_mem_region_t region1,
 207   void* addr2, mc_mem_region_t region2, size_t size);
 208 int mc_snapshot_memcmp(
 209   void* addr1, mc_snapshot_t snapshot1,
 210   void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
 211
 212 static void* mc_snapshot_read_pointer(void* addr, mc_snapshot_t snapshot, int process_index);
 213
 214 /** @brief State of the model-checker (global variables for the model checker)
 215  *
 216  *  Each part of the state of the model chercker represented as a global
 217  *  variable prevents some sharing between snapshots and must be ignored.
 218  *  By moving as much state as possible in this structure allocated
 219  *  on the model-chercker heap, we avoid those issues.
 220  */
 221 typedef struct s_mc_model_checker {
 222   // This is the parent snapshot of the current state:
 223   mc_snapshot_t parent_snapshot;
 224   mc_pages_store_t pages;
 225   int fd_clear_refs;
 226   int fd_pagemap;
 227   xbt_dynar_t record;
 228 } s_mc_model_checker_t, *mc_model_checker_t;
 229
 230 mc_model_checker_t MC_model_checker_new(void);
 231 void MC_model_checker_delete(mc_model_checker_t mc);
 232 extern mc_model_checker_t mc_model_checker;
 233
 234 extern xbt_dynar_t mc_checkpoint_ignore;
 235
 236 /********************************* MC Global **********************************/
 237
 238 extern FILE *dot_output;
 239 extern const char* colors[13];
 240 extern xbt_parmap_t parmap;
 241
 242 extern int user_max_depth_reached;
 243
 244 int MC_deadlock_check(void);
 245 void MC_replay(xbt_fifo_t stack, int start);
 246 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
 247 void MC_show_deadlock(smx_simcall_t req);
 248 void MC_show_stack_safety(xbt_fifo_t stack);
 249 void MC_dump_stack_safety(xbt_fifo_t stack);
 250
 251 /** Stack (of `mc_state_t`) representing the current position of the
 252  *  the MC in the exploration graph
 253  *
 254  *  It is managed by its head (`xbt_fifo_shift` and `xbt_fifo_unshift`).
 255  */
 256 extern xbt_fifo_t mc_stack;
 257
 258 int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
 259
 260 /********************************* Requests ***********************************/
 261
 262 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
 263 char* MC_request_to_string(smx_simcall_t req, int value);
 264 unsigned int MC_request_testany_fail(smx_simcall_t req);
 265 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
 266 int MC_request_is_visible(smx_simcall_t req);
 267
 268 /** Can this requests can be executed.
 269  *
 270  *  Most requests are always enabled but WAIT and WAITANY
 271  *  are not always enabled: a WAIT where the communication does not
 272  *  have both a source and a destination yet is not enabled
 273  *  (unless timeout is enabled in the wait and enabeld in SimGridMC).
 274  */
 275 int MC_request_is_enabled(smx_simcall_t req);
 276 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
 277
 278 /** Is the process ready to execute its simcall?
 279  *
 280  *  This is true if the request associated with the process is ready.
 281  */
 282 int MC_process_is_enabled(smx_process_t process);
 283
 284 char *MC_request_get_dot_output(smx_simcall_t req, int value);
 285
 286
 287 /******************************** States **************************************/
 288
 289 extern mc_global_t initial_global_state;
 290
 291 /* Possible exploration status of a process in a state */
 292 typedef enum {
 293   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
 294   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
 295   MC_MORE_INTERLEAVE,       /* Interleave twice the process (for mc_random simcall) */
 296   MC_DONE                   /* Already interleaved */
 297 } e_mc_process_state_t;
 298
 299 /* On every state, each process has an entry of the following type */
 300 typedef struct mc_procstate{
 301   e_mc_process_state_t state;       /* Exploration control information */
 302   unsigned int interleave_count;    /* Number of times that the process was
 303                                        interleaved */
 304 } s_mc_procstate_t, *mc_procstate_t;
 305
 306 /* An exploration state.
 307  *
 308  *  The `executed_state` is sometimes transformed into another `internal_req`.
 309  *  For example WAITANY is transformes into a WAIT and TESTANY into TEST.
 310  *  See `MC_state_set_executed_request()`.
 311  */
 312 typedef struct mc_state {
 313   unsigned long max_pid;            /* Maximum pid at state's creation time */
 314   mc_procstate_t proc_status;       /* State's exploration status by process */
 315   s_smx_synchro_t internal_comm;     /* To be referenced by the internal_req */
 316   s_smx_simcall_t internal_req;         /* Internal translation of request */
 317   s_smx_simcall_t executed_req;         /* The executed request of the state */
 318   int req_num;                      /* The request number (in the case of a
 319                                        multi-request like waitany ) */
 320   mc_snapshot_t system_state;      /* Snapshot of system state */
 321   int num;
 322 } s_mc_state_t, *mc_state_t;
 323
 324 mc_state_t MC_state_new(void);
 325 void MC_state_delete(mc_state_t state);
 326 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 327 unsigned int MC_state_interleave_size(mc_state_t state);
 328 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 329 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
 330 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
 331 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
 332 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
 333 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
 334
 335
 336 /****************************** Statistics ************************************/
 337
 338 typedef struct mc_stats {
 339   unsigned long state_size;
 340   unsigned long visited_states;
 341   unsigned long visited_pairs;
 342   unsigned long expanded_states;
 343   unsigned long expanded_pairs;
 344   unsigned long executed_transitions;
 345 } s_mc_stats_t, *mc_stats_t;
 346
 347 extern mc_stats_t mc_stats;
 348
 349 void MC_print_statistics(mc_stats_t);
 350
 351
 352 /********************************** MEMORY ******************************/
 353 /* The possible memory modes for the modelchecker are standard and raw. */
 354 /* Normally the system should operate in std, for switching to raw mode */
 355 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 356
 357 extern xbt_mheap_t std_heap;
 358 extern xbt_mheap_t mc_heap;
 359
 360
 361 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 362 /* an API to query about the status of a heap, we simply call mmstats and */
 363 /* because I now how does structure looks like, then I redefine it here */
 364
 365 /* struct mstats { */
 366 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
 367 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
 368 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
 369 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
 370 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
 371 /* }; */
 372
 373 #define MC_SET_MC_HEAP    mmalloc_set_current_heap(mc_heap)
 374 #define MC_SET_STD_HEAP  mmalloc_set_current_heap(std_heap)
 375
 376
 377 /******************************* MEMORY MAPPINGS ***************************/
 378 /* These functions and data structures implements a binary interface for   */
 379 /* the proc maps ascii interface                                           */
 380
 381 /* Each field is defined as documented in proc's manual page  */
 382 typedef struct s_map_region {
 383
 384   void *start_addr;             /* Start address of the map */
 385   void *end_addr;               /* End address of the map */
 386   int prot;                     /* Memory protection */
 387   int flags;                    /* Additional memory flags */
 388   void *offset;                 /* Offset in the file/whatever */
 389   char dev_major;               /* Major of the device */
 390   char dev_minor;               /* Minor of the device */
 391   unsigned long inode;          /* Inode in the device */
 392   char *pathname;               /* Path name of the mapped file */
 393
 394 } s_map_region_t;
 395
 396 typedef struct s_memory_map {
 397
 398   s_map_region_t *regions;      /* Pointer to an array of regions */
 399   int mapsize;                  /* Number of regions in the memory */
 400
 401 } s_memory_map_t, *memory_map_t;
 402
 403
 404 void MC_init_memory_map_info(void);
 405 memory_map_t MC_get_memory_map(void);
 406 void MC_free_memory_map(memory_map_t map);
 407
 408 extern char *libsimgrid_path;
 409
 410 /********************************** Snapshot comparison **********************************/
 411
 412 typedef struct s_mc_comparison_times{
 413   double nb_processes_comparison_time;
 414   double bytes_used_comparison_time;
 415   double stacks_sizes_comparison_time;
 416   double binary_global_variables_comparison_time;
 417   double libsimgrid_global_variables_comparison_time;
 418   double heap_comparison_time;
 419   double stacks_comparison_time;
 420 }s_mc_comparison_times_t, *mc_comparison_times_t;
 421
 422 extern __thread mc_comparison_times_t mc_comp_times;
 423 extern __thread double mc_snapshot_comparison_time;
 424
 425 int snapshot_compare(void *state1, void *state2);
 426 void print_comparison_times(void);
 427
 428 //#define MC_DEBUG 1
 429 #define MC_VERBOSE 1
 430
 431 /********************************** Safety verification **************************************/
 432
 433 typedef enum {
 434   e_mc_reduce_unset,
 435   e_mc_reduce_none,
 436   e_mc_reduce_dpor
 437 } e_mc_reduce_t;
 438
 439 extern e_mc_reduce_t mc_reduce_kind;
 440 extern xbt_dict_t first_enabled_state;
 441
 442 void MC_pre_modelcheck_safety(void);
 443 void MC_modelcheck_safety(void);
 444
 445 typedef struct s_mc_visited_state{
 446   mc_snapshot_t system_state;
 447   size_t heap_bytes_used;
 448   int nb_processes;
 449   int num;
 450   int other_num; // dot_output for
 451 }s_mc_visited_state_t, *mc_visited_state_t;
 452
 453 extern xbt_dynar_t visited_states;
 454 mc_visited_state_t is_visited_state(void);
 455 void visited_state_free(mc_visited_state_t state);
 456 void visited_state_free_voidp(void *s);
 457
 458 /********************************** Liveness verification **************************************/
 459
 460 extern xbt_automaton_t _mc_property_automaton;
 461
 462 typedef struct s_mc_pair{
 463   int num;
 464   int search_cycle;
 465   mc_state_t graph_state; /* System state included */
 466   xbt_automaton_state_t automaton_state;
 467   xbt_dynar_t atomic_propositions;
 468   int requests;
 469 }s_mc_pair_t, *mc_pair_t;
 470
 471 typedef struct s_mc_visited_pair{
 472   int num;
 473   int other_num; /* Dot output for */
 474   int acceptance_pair;
 475   mc_state_t graph_state; /* System state included */
 476   xbt_automaton_state_t automaton_state;
 477   xbt_dynar_t atomic_propositions;
 478   size_t heap_bytes_used;
 479   int nb_processes;
 480   int acceptance_removed;
 481   int visited_removed;
 482 }s_mc_visited_pair_t, *mc_visited_pair_t;
 483
 484 mc_pair_t MC_pair_new(void);
 485 void MC_pair_delete(mc_pair_t);
 486 void mc_pair_free_voidp(void *p);
 487 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
 488 void MC_visited_pair_delete(mc_visited_pair_t p);
 489
 490 void MC_pre_modelcheck_liveness(void);
 491 void MC_modelcheck_liveness(void);
 492 void MC_show_stack_liveness(xbt_fifo_t stack);
 493 void MC_dump_stack_liveness(xbt_fifo_t stack);
 494
 495 extern xbt_dynar_t visited_pairs;
 496 int is_visited_pair(mc_visited_pair_t pair, int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
 497
 498
 499 /********************************** Variables with DWARF **********************************/
 500
 501 #define MC_OBJECT_INFO_EXECUTABLE 1
 502
 503 struct s_mc_object_info {
 504   size_t flags;
 505   char* file_name;
 506   char *start_exec, *end_exec; // Executable segment
 507   char *start_rw, *end_rw; // Read-write segment
 508   char *start_ro, *end_ro; // read-only segment
 509   xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
 510   xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
 511   xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
 512   xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
 513
 514   // Here we sort the minimal information for an efficient (and cache-efficient)
 515   // lookup of a function given an instruction pointer.
 516   // The entries are sorted by low_pc and a binary search can be used to look them up.
 517   xbt_dynar_t functions_index;
 518 };
 519
 520 mc_object_info_t MC_new_object_info(void);
 521 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
 522 void MC_free_object_info(mc_object_info_t* p);
 523
 524 void MC_dwarf_get_variables(mc_object_info_t info);
 525 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
 526 const char* MC_dwarf_attrname(int attr);
 527 const char* MC_dwarf_tagname(int tag);
 528
 529 dw_frame_t MC_find_function_by_ip(void* ip);
 530 mc_object_info_t MC_ip_find_object_info(void* ip);
 531
 532 extern mc_object_info_t mc_libsimgrid_info;
 533 extern mc_object_info_t mc_binary_info;
 534 extern mc_object_info_t mc_object_infos[2];
 535 extern size_t mc_object_infos_size;
 536
 537 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
 538 void MC_post_process_object_info(mc_object_info_t info);
 539
 540 // ***** Expressions
 541
 542 /** \brief a DWARF expression with optional validity contraints */
 543 typedef struct s_mc_expression {
 544   size_t size;
 545   Dwarf_Op* ops;
 546   // Optional validity:
 547   void* lowpc, *highpc;
 548 } s_mc_expression_t, *mc_expression_t;
 549
 550 /** A location list (list of location expressions) */
 551 typedef struct s_mc_location_list {
 552   size_t size;
 553   mc_expression_t locations;
 554 } s_mc_location_list_t, *mc_location_list_t;
 555
 556 /** A location is either a location in memory of a register location
 557  *
 558  *  Usage:
 559  *
 560  *    * mc_dwarf_resolve_locations or mc_dwarf_resolve_location is used
 561  *      to find the location of a given location expression or location list;
 562  *
 563  *    * mc_get_location_type MUST be used to find the location type;
 564  *
 565  *    * for MC_LOCATION_TYPE_ADDRESS, memory_address is the resulting address
 566  *
 567  *    * for MC_LOCATION_TYPE_REGISTER, unw_get_reg(l.cursor, l.register_id, value)
 568  *        and unw_get_reg(l.cursor, l.register_id, value) can be used to read/write
 569  *        the value.
 570  *  </ul>
 571  */
 572 typedef struct s_mc_location {
 573   void* memory_location;
 574   unw_cursor_t* cursor;
 575   int register_id;
 576 } s_mc_location_t, *mc_location_t;
 577
 578 /** Type of a given location
 579  *
 580  *  Use `mc_get_location_type(location)` to find the type.
 581  * */
 582 typedef enum mc_location_type {
 583   MC_LOCATION_TYPE_ADDRESS,
 584   MC_LOCATION_TYPE_REGISTER
 585 } mc_location_type;
 586
 587 /** Find the type of a location */
 588 static inline __attribute__ ((always_inline))
 589 enum mc_location_type mc_get_location_type(mc_location_t location) {
 590   if (location->cursor) {
 591     return MC_LOCATION_TYPE_REGISTER;
 592   } else {
 593     return MC_LOCATION_TYPE_ADDRESS;
 594   }
 595 }
 596
 597 void mc_dwarf_resolve_location(mc_location_t location, mc_expression_t expression, mc_object_info_t object_info, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot, int process_index);
 598 void mc_dwarf_resolve_locations(mc_location_t location, mc_location_list_t locations, mc_object_info_t object_info, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot, int process_index);
 599
 600 void mc_dwarf_expression_clear(mc_expression_t expression);
 601 void mc_dwarf_expression_init(mc_expression_t expression, size_t len, Dwarf_Op* ops);
 602
 603 void mc_dwarf_location_list_clear(mc_location_list_t list);
 604
 605 void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
 606 void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
 607
 608 // ***** Variables and functions
 609
 610 struct s_dw_type{
 611   e_dw_type_type type;
 612   Dwarf_Off id; /* Offset in the section (in hexadecimal form) */
 613   char *name; /* Name of the type */
 614   int byte_size; /* Size in bytes */
 615   int element_count; /* Number of elements for array type */
 616   char *dw_type_id; /* DW_AT_type id */
 617   xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
 618   int is_pointer_type;
 619
 620   // Location (for members) is either of:
 621   struct s_mc_expression location;
 622   int offset;
 623
 624   dw_type_t subtype; // DW_AT_type
 625   dw_type_t full_type; // The same (but more complete) type
 626 };
 627
 628 void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot, int process_index);
 629
 630 typedef struct s_dw_variable{
 631   Dwarf_Off dwarf_offset; /* Global offset of the field. */
 632   int global;
 633   char *name;
 634   char *type_origin;
 635   dw_type_t type;
 636
 637   // Use either of:
 638   s_mc_location_list_t locations;
 639   void* address;
 640
 641   size_t start_scope;
 642   mc_object_info_t object_info;
 643
 644 }s_dw_variable_t, *dw_variable_t;
 645
 646 struct s_dw_frame{
 647   int tag;
 648   char *name;
 649   void *low_pc;
 650   void *high_pc;
 651   s_mc_location_list_t frame_base;
 652   xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
 653   unsigned long int id; /* DWARF offset of the subprogram */
 654   xbt_dynar_t /* <dw_frame_t> */ scopes;
 655   Dwarf_Off abstract_origin_id;
 656   mc_object_info_t object_info;
 657 };
 658
 659 struct s_mc_function_index_item {
 660   void* low_pc, *high_pc;
 661   dw_frame_t function;
 662 };
 663
 664 void mc_frame_free(dw_frame_t freme);
 665
 666 void dw_type_free(dw_type_t t);
 667 void dw_variable_free(dw_variable_t v);
 668 void dw_variable_free_voidp(void *t);
 669
 670 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
 671 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 672 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 673 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 674
 675 /** Find the DWARF offset for this ELF object
 676  *
 677  *  An offset is applied to address found in DWARF:
 678  *
 679  *  <ul>
 680  *    <li>for an executable obejct, addresses are virtual address
 681  *        (there is no offset) i.e. \f$\text{virtual address} = \{dwarf address}\f$;</li>
 682  *    <li>for a shared object, the addreses are offset from the begining
 683  *        of the shared object (the base address of the mapped shared
 684  *        object must be used as offset
 685  *        i.e. \f$\text{virtual address} = \text{shared object base address}
 686  *             + \text{dwarf address}\f$.</li>
 687  *
 688  */
 689 void* MC_object_base_address(mc_object_info_t info);
 690
 691 /********************************** DWARF **********************************/
 692
 693 #define MC_EXPRESSION_STACK_SIZE 64
 694
 695 #define MC_EXPRESSION_OK 0
 696 #define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
 697 #define MC_EXPRESSION_E_STACK_OVERFLOW 2
 698 #define MC_EXPRESSION_E_STACK_UNDERFLOW 3
 699 #define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
 700 #define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
 701 #define MC_EXPRESSION_E_NO_BASE_ADDRESS 6
 702
 703 typedef struct s_mc_expression_state {
 704   uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
 705   size_t stack_size;
 706
 707   unw_cursor_t* cursor;
 708   void* frame_base;
 709   mc_snapshot_t snapshot;
 710   mc_object_info_t object_info;
 711   int process_index;
 712 } s_mc_expression_state_t, *mc_expression_state_t;
 713
 714 int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
 715
 716 void* mc_find_frame_base(dw_frame_t frame, mc_object_info_t object_info, unw_cursor_t* unw_cursor);
 717
 718 /********************************** Miscellaneous **********************************/
 719
 720 typedef struct s_local_variable{
 721   dw_frame_t subprogram;
 722   unsigned long ip;
 723   char *name;
 724   dw_type_t type;
 725   void *address;
 726   int region;
 727 }s_local_variable_t, *local_variable_t;
 728
 729 /********************************* Communications pattern ***************************/
 730
 731 typedef struct s_mc_comm_pattern{
 732   int num;
 733   smx_synchro_t comm;
 734   e_smx_comm_type_t type;
 735   unsigned long src_proc;
 736   unsigned long dst_proc;
 737   const char *src_host;
 738   const char *dst_host;
 739   char *rdv;
 740   ssize_t data_size;
 741   void *data;
 742 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
 743
 744 extern xbt_dynar_t initial_communications_pattern;
 745 extern xbt_dynar_t communications_pattern;
 746 extern xbt_dynar_t incomplete_communications_pattern;
 747
 748 // Can we use the SIMIX syscall for this?
 749 typedef enum mc_call_type {
 750   MC_CALL_TYPE_NONE,
 751   MC_CALL_TYPE_SEND,
 752   MC_CALL_TYPE_RECV,
 753   MC_CALL_TYPE_WAIT,
 754   MC_CALL_TYPE_WAITANY,
 755 } mc_call_type;
 756
 757 static inline mc_call_type mc_get_call_type(smx_simcall_t req) {
 758   switch(req->call) {
 759   case SIMCALL_COMM_ISEND:
 760     return MC_CALL_TYPE_SEND;
 761   case SIMCALL_COMM_IRECV:
 762     return MC_CALL_TYPE_RECV;
 763   case SIMCALL_COMM_WAIT:
 764     return MC_CALL_TYPE_WAIT;
 765   case SIMCALL_COMM_WAITANY:
 766     return MC_CALL_TYPE_WAITANY;
 767   default:
 768     return MC_CALL_TYPE_NONE;
 769   }
 770 }
 771
 772 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, mc_call_type call_type);
 773 void mc_update_comm_pattern(mc_call_type call_type, smx_simcall_t request, int value, xbt_dynar_t current_pattern);
 774 void complete_comm_pattern(xbt_dynar_t list, smx_synchro_t comm);
 775 void MC_pre_modelcheck_comm_determinism(void);
 776 void MC_modelcheck_comm_determinism(void);
 777
 778 /* *********** Sets *********** */
 779
 780 typedef struct s_mc_address_set *mc_address_set_t;
 781
 782 mc_address_set_t mc_address_set_new();
 783 void mc_address_set_free(mc_address_set_t* p);
 784 void mc_address_add(mc_address_set_t p, const void* value);
 785 bool mc_address_test(mc_address_set_t p, const void* value);
 786
 787 /* *********** Hash *********** */
 788
 789 /** \brief Hash the current state
 790  *  \param num_state number of states
 791  *  \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
 792  *  \result resulting hash
 793  * */
 794 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
 795
 796 /* *********** Snapshot *********** */
 797
 798 static inline __attribute__((always_inline))
 799 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region)
 800 {
 801     size_t pageno = mc_page_number(region->start_addr, (void*) addr);
 802     size_t snapshot_pageno = region->page_numbers[pageno];
 803     const void* snapshot_page = mc_page_store_get_page(mc_model_checker->pages, snapshot_pageno);
 804     return (char*) snapshot_page + mc_page_offset((void*) addr);
 805 }
 806
 807 /** \brief Translate a pointer from process address space to snapshot address space
 808  *
 809  *  The address space contains snapshot of the main/application memory:
 810  *  this function finds the address in a given snaphot for a given
 811  *  real/application address.
 812  *
 813  *  For read only memory regions and other regions which are not int the
 814  *  snapshot, the address is not changed.
 815  *
 816  *  \param addr     Application address
 817  *  \param snapshot The snapshot of interest (if NULL no translation is done)
 818  *  \return         Translated address in the snapshot address space
 819  * */
 820 static inline __attribute__((always_inline))
 821 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot, int process_index)
 822 {
 823
 824   // If not in a process state/clone:
 825   if (!snapshot) {
 826     return (uintptr_t *) addr;
 827   }
 828
 829   mc_mem_region_t region = mc_get_snapshot_region((void*) addr, snapshot, process_index);
 830
 831   xbt_assert(mc_region_contain(region, (void*) addr), "Trying to read out of the region boundary.");
 832
 833   if (!region) {
 834     return (void *) addr;
 835   }
 836
 837   // Flat snapshot:
 838   else if (region->data) {
 839     uintptr_t offset = addr - (uintptr_t) region->start_addr;
 840     return (void *) ((uintptr_t) region->data + offset);
 841   }
 842
 843   // Per-page snapshot:
 844   else if (region->page_numbers) {
 845     return mc_translate_address_region(addr, region);
 846   }
 847
 848   else {
 849     xbt_die("No data for this memory region");
 850   }
 851 }
 852
 853 static inline __attribute__ ((always_inline))
 854   void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot) {
 855   if(snapshot==NULL)
 856       xbt_die("snapshot is NULL");
 857   void** addr = &(std_heap->breakval);
 858   return mc_snapshot_read_pointer(addr, snapshot, MC_ANY_PROCESS_INDEX);
 859 }
 860
 861 static inline __attribute__ ((always_inline))
 862 void* mc_snapshot_read_pointer(void* addr, mc_snapshot_t snapshot, int process_index)
 863 {
 864   void* res;
 865   return *(void**) mc_snapshot_read(addr, snapshot, process_index, &res, sizeof(void*));
 866 }
 867
 868 /** @brief Read memory from a snapshot region
 869  *
 870  *  @param addr    Process (non-snapshot) address of the data
 871  *  @param region  Snapshot memory region where the data is located
 872  *  @param target  Buffer to store the value
 873  *  @param size    Size of the data to read in bytes
 874  *  @return Pointer where the data is located (target buffer of original location)
 875  */
 876 static inline __attribute__((always_inline))
 877 void* mc_snapshot_read_region(void* addr, mc_mem_region_t region, void* target, size_t size)
 878 {
 879   if (region==NULL)
 880     return addr;
 881
 882   uintptr_t offset = (char*) addr - (char*) region->start_addr;
 883
 884   xbt_assert(mc_region_contain(region, addr),
 885     "Trying to read out of the region boundary.");
 886
 887   // Linear memory region:
 888   if (region->data) {
 889     return (char*) region->data + offset;
 890   }
 891
 892   // Fragmented memory region:
 893   else if (region->page_numbers) {
 894     // Last byte of the region:
 895     void* end = (char*) addr + size - 1;
 896     if( mc_same_page(addr, end) ) {
 897       // The memory is contained in a single page:
 898       return mc_translate_address_region((uintptr_t) addr, region);
 899     } else {
 900       // The memory spans several pages:
 901       return mc_snapshot_read_fragmented(addr, region, target, size);
 902     }
 903   }
 904
 905   else {
 906     xbt_die("No data available for this region");
 907   }
 908 }
 909
 910 static inline __attribute__ ((always_inline))
 911 void* mc_snapshot_read_pointer_region(void* addr, mc_mem_region_t region)
 912 {
 913   void* res;
 914   return *(void**) mc_snapshot_read_region(addr, region, &res, sizeof(void*));
 915 }
 916
 917 #define MC_LOG_REQUEST(log, req, value) \
 918   if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) { \
 919     char* req_str = MC_request_to_string(req, value); \
 920     XBT_DEBUG("Execute: %s", req_str); \
 921     xbt_free(req_str); \
 922   }
 923
 924 /** @brief Dump the stacks of the application processes
 925  *
 926  *   This functions is currently not used but it is quite convenient
 927  *   to call from the debugger.
 928  *
 929  *   Does not work when an application thread is running.
 930  */
 931 void MC_dump_stacks(FILE* file);
 932
 933 SG_END_DECL()
 934
 935 #endif