src/mc/mc_private.h

   1 /* Copyright (c) 2007-2013. 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/automaton.h"
  25 #include "xbt/hash.h"
  26 #include "msg/msg.h"
  27 #include "msg/datatypes.h"
  28 #include "xbt/strbuff.h"
  29 #include "xbt/parmap.h"
  30
  31 typedef struct s_dw_frame s_dw_frame_t, *dw_frame_t;
  32
  33 /****************************** Snapshots ***********************************/
  34
  35 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
  36
  37 typedef struct s_mc_mem_region{
  38   void *start_addr;
  39   void *data;
  40   size_t size;
  41 } s_mc_mem_region_t, *mc_mem_region_t;
  42
  43 typedef struct s_mc_snapshot{
  44   size_t heap_bytes_used;
  45   mc_mem_region_t regions[NB_REGIONS];
  46   int nb_processes;
  47   size_t *stack_sizes;
  48   xbt_dynar_t stacks;
  49   xbt_dynar_t to_ignore;
  50   uint64_t hash;
  51 } s_mc_snapshot_t, *mc_snapshot_t;
  52
  53 /** Information about a given stack frame
  54  *
  55  */
  56 typedef struct s_mc_stack_frame {
  57   /** Instruction pointer */
  58   unw_word_t ip;
  59   /** Stack pointer */
  60   unw_word_t sp;
  61   unw_word_t frame_base;
  62   dw_frame_t frame;
  63   char* frame_name;
  64   unw_cursor_t unw_cursor;
  65 } s_mc_stack_frame_t, *mc_stack_frame_t;
  66
  67 typedef struct s_mc_snapshot_stack{
  68   xbt_dynar_t local_variables;
  69   void *stack_pointer;
  70   void *real_address;
  71   xbt_dynar_t stack_frames; // mc_stack_frame_t
  72 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
  73
  74 typedef struct s_mc_global_t{
  75   mc_snapshot_t snapshot;
  76   int raw_mem_set;
  77   int prev_pair;
  78   char *prev_req;
  79   int initial_communications_pattern_done;
  80   int comm_deterministic;
  81   int send_deterministic;
  82 }s_mc_global_t, *mc_global_t;
  83
  84 typedef struct s_mc_checkpoint_ignore_region{
  85   void *addr;
  86   size_t size;
  87 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
  88
  89 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
  90 mc_snapshot_t MC_take_snapshot(int num_state);
  91 void MC_restore_snapshot(mc_snapshot_t);
  92 void MC_free_snapshot(mc_snapshot_t);
  93
  94 extern xbt_dynar_t mc_checkpoint_ignore;
  95
  96 /********************************* MC Global **********************************/
  97
  98 extern double *mc_time;
  99 extern FILE *dot_output;
 100 extern const char* colors[13];
 101 extern xbt_parmap_t parmap;
 102
 103 extern int user_max_depth_reached;
 104
 105 int MC_deadlock_check(void);
 106 void MC_replay(xbt_fifo_t stack, int start);
 107 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
 108 void MC_wait_for_requests(void);
 109 void MC_show_deadlock(smx_simcall_t req);
 110 void MC_show_stack_safety(xbt_fifo_t stack);
 111 void MC_dump_stack_safety(xbt_fifo_t stack);
 112 void MC_init(void);
 113 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
 114
 115
 116 /********************************* Requests ***********************************/
 117
 118 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
 119 char* MC_request_to_string(smx_simcall_t req, int value);
 120 unsigned int MC_request_testany_fail(smx_simcall_t req);
 121 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
 122 int MC_request_is_visible(smx_simcall_t req);
 123 int MC_request_is_enabled(smx_simcall_t req);
 124 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
 125 int MC_process_is_enabled(smx_process_t process);
 126 char *MC_request_get_dot_output(smx_simcall_t req, int value);
 127
 128
 129 /******************************** States **************************************/
 130
 131 /* Possible exploration status of a process in a state */
 132 typedef enum {
 133   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
 134   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
 135   MC_MORE_INTERLEAVE,       /* Interleave twice the process (for mc_random simcall) */
 136   MC_DONE                   /* Already interleaved */
 137 } e_mc_process_state_t;
 138
 139 /* On every state, each process has an entry of the following type */
 140 typedef struct mc_procstate{
 141   e_mc_process_state_t state;       /* Exploration control information */
 142   unsigned int interleave_count;    /* Number of times that the process was
 143                                        interleaved */
 144 } s_mc_procstate_t, *mc_procstate_t;
 145
 146 /* An exploration state is composed of: */
 147 typedef struct mc_state {
 148   unsigned long max_pid;            /* Maximum pid at state's creation time */
 149   mc_procstate_t proc_status;       /* State's exploration status by process */
 150   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
 151   s_smx_simcall_t internal_req;         /* Internal translation of request */
 152   s_smx_simcall_t executed_req;         /* The executed request of the state */
 153   int req_num;                      /* The request number (in the case of a
 154                                        multi-request like waitany ) */
 155   mc_snapshot_t system_state;      /* Snapshot of system state */
 156   int num;
 157 } s_mc_state_t, *mc_state_t;
 158
 159 mc_state_t MC_state_new(void);
 160 void MC_state_delete(mc_state_t state);
 161 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 162 unsigned int MC_state_interleave_size(mc_state_t state);
 163 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 164 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
 165 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
 166 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
 167 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
 168 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
 169
 170
 171 /****************************** Statistics ************************************/
 172
 173 typedef struct mc_stats {
 174   unsigned long state_size;
 175   unsigned long visited_states;
 176   unsigned long visited_pairs;
 177   unsigned long expanded_states;
 178   unsigned long expanded_pairs;
 179   unsigned long executed_transitions;
 180 } s_mc_stats_t, *mc_stats_t;
 181
 182 extern mc_stats_t mc_stats;
 183
 184 void MC_print_statistics(mc_stats_t);
 185
 186
 187 /********************************** MEMORY ******************************/
 188 /* The possible memory modes for the modelchecker are standard and raw. */
 189 /* Normally the system should operate in std, for switching to raw mode */
 190 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 191
 192 extern void *std_heap;
 193 extern void *raw_heap;
 194
 195
 196 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 197 /* an API to query about the status of a heap, we simply call mmstats and */
 198 /* because I now how does structure looks like, then I redefine it here */
 199
 200 /* struct mstats { */
 201 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
 202 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
 203 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
 204 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
 205 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
 206 /* }; */
 207
 208 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 209 #define MC_UNSET_RAW_MEM  mmalloc_set_current_heap(std_heap)
 210
 211
 212 /******************************* MEMORY MAPPINGS ***************************/
 213 /* These functions and data structures implements a binary interface for   */
 214 /* the proc maps ascii interface                                           */
 215
 216 /* Each field is defined as documented in proc's manual page  */
 217 typedef struct s_map_region {
 218
 219   void *start_addr;             /* Start address of the map */
 220   void *end_addr;               /* End address of the map */
 221   int prot;                     /* Memory protection */
 222   int flags;                    /* Additional memory flags */
 223   void *offset;                 /* Offset in the file/whatever */
 224   char dev_major;               /* Major of the device */
 225   char dev_minor;               /* Minor of the device */
 226   unsigned long inode;          /* Inode in the device */
 227   char *pathname;               /* Path name of the mapped file */
 228
 229 } s_map_region_t;
 230
 231 typedef struct s_memory_map {
 232
 233   s_map_region_t *regions;      /* Pointer to an array of regions */
 234   int mapsize;                  /* Number of regions in the memory */
 235
 236 } s_memory_map_t, *memory_map_t;
 237
 238
 239 void MC_init_memory_map_info(void);
 240 memory_map_t MC_get_memory_map(void);
 241 void MC_free_memory_map(memory_map_t map);
 242
 243 extern char *libsimgrid_path;
 244
 245 /********************************** Snapshot comparison **********************************/
 246
 247 typedef struct s_mc_comparison_times{
 248   double nb_processes_comparison_time;
 249   double bytes_used_comparison_time;
 250   double stacks_sizes_comparison_time;
 251   double binary_global_variables_comparison_time;
 252   double libsimgrid_global_variables_comparison_time;
 253   double heap_comparison_time;
 254   double stacks_comparison_time;
 255 }s_mc_comparison_times_t, *mc_comparison_times_t;
 256
 257 extern __thread mc_comparison_times_t mc_comp_times;
 258 extern __thread double mc_snapshot_comparison_time;
 259
 260 int snapshot_compare(void *state1, void *state2);
 261 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
 262 void print_comparison_times(void);
 263
 264 //#define MC_DEBUG 1
 265 #define MC_VERBOSE 1
 266 #define MC_USE_SNAPSHOT_HASH 1
 267
 268 /********************************** DPOR for safety property **************************************/
 269
 270 typedef enum {
 271   e_mc_reduce_unset,
 272   e_mc_reduce_none,
 273   e_mc_reduce_dpor
 274 } e_mc_reduce_t;
 275
 276 extern e_mc_reduce_t mc_reduce_kind;
 277 extern mc_global_t initial_state_safety;
 278 extern xbt_fifo_t mc_stack_safety;
 279 extern xbt_dict_t first_enabled_state;
 280
 281 void MC_dpor_init(void);
 282 void MC_dpor(void);
 283
 284 typedef struct s_mc_visited_state{
 285   mc_snapshot_t system_state;
 286   size_t heap_bytes_used;
 287   int nb_processes;
 288   int num;
 289   int other_num; // dot_output for
 290 }s_mc_visited_state_t, *mc_visited_state_t;
 291
 292
 293 /********************************** Double-DFS for liveness property **************************************/
 294
 295 extern xbt_fifo_t mc_stack_liveness;
 296 extern mc_global_t initial_state_liveness;
 297 extern xbt_automaton_t _mc_property_automaton;
 298 extern int compare;
 299
 300 typedef struct s_mc_pair{
 301   int num;
 302   int search_cycle;
 303   mc_state_t graph_state; /* System state included */
 304   xbt_automaton_state_t automaton_state;
 305   xbt_dynar_t atomic_propositions;
 306   int requests;
 307 }s_mc_pair_t, *mc_pair_t;
 308
 309 typedef struct s_mc_visited_pair{
 310   int num;
 311   int other_num; /* Dot output for */
 312   int acceptance_pair;
 313   mc_state_t graph_state; /* System state included */
 314   xbt_automaton_state_t automaton_state;
 315   xbt_dynar_t atomic_propositions;
 316   size_t heap_bytes_used;
 317   int nb_processes;
 318   int acceptance_removed;
 319   int visited_removed;
 320 }s_mc_visited_pair_t, *mc_visited_pair_t;
 321
 322 mc_pair_t MC_pair_new(void);
 323 void MC_pair_delete(mc_pair_t);
 324 void mc_pair_free_voidp(void *p);
 325 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
 326 void MC_visited_pair_delete(mc_visited_pair_t p);
 327
 328 void MC_ddfs_init(void);
 329 void MC_ddfs(void);
 330 void MC_show_stack_liveness(xbt_fifo_t stack);
 331 void MC_dump_stack_liveness(xbt_fifo_t stack);
 332
 333
 334 /********************************** Variables with DWARF **********************************/
 335
 336 struct s_mc_object_info {
 337   char* file_name;
 338   char *start_exec, *end_exec; // Executable segment
 339   char *start_rw, *end_rw; // Read-write segment
 340   char *start_ro, *end_ro; // read-only segment
 341   xbt_dict_t local_variables; // xbt_dict_t<frame_name, dw_frame_t>
 342   xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
 343   xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
 344   xbt_dict_t types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
 345 };
 346
 347 mc_object_info_t MC_new_object_info(void);
 348 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name);
 349 void MC_free_object_info(mc_object_info_t* p);
 350
 351 void MC_dwarf_get_variables(mc_object_info_t info);
 352 void MC_dwarf_get_variables_libdw(mc_object_info_t info);
 353 const char* MC_dwarf_attrname(int attr);
 354 const char* MC_dwarf_tagname(int tag);
 355
 356 extern mc_object_info_t mc_libsimgrid_info;
 357 extern mc_object_info_t mc_binary_info;
 358
 359 typedef enum {
 360   e_dw_loclist,
 361   e_dw_register,
 362   e_dw_bregister_op,
 363   e_dw_lit,
 364   e_dw_fbregister_op,
 365   e_dw_piece,
 366   e_dw_arithmetic,
 367   e_dw_plus_uconst,
 368   e_dw_compose,
 369   e_dw_deref,
 370   e_dw_uconstant,
 371   e_dw_sconstant,
 372   e_dw_unsupported
 373 } e_dw_location_type;
 374
 375 typedef struct s_dw_location{
 376   e_dw_location_type type;
 377   union{
 378
 379     xbt_dynar_t loclist;
 380
 381     int reg;
 382
 383     struct{
 384       unsigned int reg;
 385       int offset;
 386     }breg_op;
 387
 388     unsigned int lit;
 389
 390     int fbreg_op;
 391
 392     int piece;
 393
 394     unsigned short int deref_size;
 395
 396     xbt_dynar_t compose;
 397
 398     char *arithmetic;
 399
 400     struct{
 401       int bytes;
 402       long unsigned int value;
 403     }uconstant;
 404
 405     struct{
 406       int bytes;
 407       long signed int value;
 408     }sconstant;
 409
 410     unsigned int plus_uconst;
 411
 412   }location;
 413 }s_dw_location_t, *dw_location_t;
 414
 415 typedef struct s_dw_location_entry{
 416   long lowpc;
 417   long highpc;
 418   dw_location_t location;
 419 }s_dw_location_entry_t, *dw_location_entry_t;
 420
 421 typedef struct s_dw_variable{
 422   Dwarf_Off dwarf_offset; /* Global offset of the field. */
 423   int global;
 424   char *name;
 425   char *type_origin;
 426
 427   // Use either of:
 428   dw_location_t location;
 429   void* address;
 430
 431 }s_dw_variable_t, *dw_variable_t;
 432
 433 struct s_dw_frame{
 434   char *name;
 435   void *low_pc;
 436   void *high_pc;
 437   dw_location_t frame_base;
 438   xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
 439   unsigned long int start; /* DWARF offset of the subprogram */
 440   unsigned long int end;   /* Dwarf offset of the next sibling */
 441 };
 442
 443 void dw_type_free(dw_type_t t);
 444 void dw_variable_free(dw_variable_t v);
 445 void dw_variable_free_voidp(void *t);
 446
 447 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
 448 void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 449 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 450 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
 451
 452 /********************************** DWARF **********************************/
 453
 454 Dwarf_Off MC_dwarf_resolve_location(unw_cursor_t* c, dw_location_t location, void* frame_pointer_address);
 455 void* mc_find_frame_base(unw_word_t ip, dw_frame_t frame, unw_cursor_t* unw_cursor);
 456
 457 /********************************** Miscellaneous **********************************/
 458
 459 typedef struct s_local_variable{
 460   char *frame;
 461   unsigned long ip;
 462   char *name;
 463   char *type;
 464   void *address;
 465   int region;
 466 }s_local_variable_t, *local_variable_t;
 467
 468 /********************************* Communications pattern ***************************/
 469
 470 typedef struct s_mc_comm_pattern{
 471   int num;
 472   smx_action_t comm;
 473   e_smx_comm_type_t type;
 474   int completed;
 475   unsigned long src_proc;
 476   unsigned long dst_proc;
 477   char *rdv;
 478   size_t data_size;
 479   void *data;
 480   int matched_comm;
 481 }s_mc_comm_pattern_t, *mc_comm_pattern_t;
 482
 483 extern xbt_dynar_t communications_pattern;
 484
 485 void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
 486
 487 /* *********** Sets *********** */
 488
 489 typedef struct s_mc_address_set *mc_address_set_t;
 490
 491 mc_address_set_t mc_address_set_new();
 492 mc_address_set_t mc_address_set_free(mc_address_set_t* p);
 493 void mc_address_add(mc_address_set_t p, const void* value);
 494 bool mc_address_test(mc_address_set_t p, const void* value);
 495
 496 /* *********** Hash *********** */
 497
 498 /** \brief Hash the current state
 499  *  \param num_state number of states
 500  *  \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
 501  *  \result resulting hash
 502  * */
 503 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
 504
 505 #endif
 506