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