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