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 "mc/mc.h"
  16 #include "mc/datatypes.h"
  17 #include "xbt/fifo.h"
  18 #include "xbt/config.h"
  19 #include "xbt/function_types.h"
  20 #include "xbt/mmalloc.h"
  21 #include "../simix/smx_private.h"
  22 #include "xbt/automaton.h"
  23 #include "xbt/hash.h"
  24 #include "msg/msg.h"
  25 #include "msg/datatypes.h"
  26 #include "xbt/strbuff.h"
  27 #include "xbt/parmap.h"
  28
  29 /****************************** Snapshots ***********************************/
  30
  31 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
  32
  33 typedef struct s_mc_mem_region{
  34   void *start_addr;
  35   void *data;
  36   size_t size;
  37 } s_mc_mem_region_t, *mc_mem_region_t;
  38
  39 typedef struct s_mc_snapshot{
  40   size_t heap_bytes_used;
  41   mc_mem_region_t regions[NB_REGIONS];
  42   int nb_processes;
  43   size_t *stack_sizes;
  44   xbt_dynar_t stacks;
  45   xbt_dynar_t to_ignore;
  46   char hash_global[41];
  47   char hash_local[41];
  48 } s_mc_snapshot_t, *mc_snapshot_t;
  49
  50 typedef struct s_mc_snapshot_stack{
  51   xbt_dynar_t local_variables;
  52   void *stack_pointer;
  53   void *real_address;
  54 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
  55
  56 typedef struct s_mc_global_t{
  57   mc_snapshot_t snapshot;
  58   int raw_mem_set;
  59   int prev_pair;
  60   char *prev_req;
  61 }s_mc_global_t, *mc_global_t;
  62
  63 typedef struct s_mc_checkpoint_ignore_region{
  64   void *addr;
  65   size_t size;
  66 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
  67
  68 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
  69 mc_snapshot_t MC_take_snapshot(int num_state);
  70 void MC_restore_snapshot(mc_snapshot_t);
  71 void MC_free_snapshot(mc_snapshot_t);
  72
  73 extern xbt_dynar_t mc_checkpoint_ignore;
  74
  75 /********************************* MC Global **********************************/
  76
  77 extern double *mc_time;
  78 extern FILE *dot_output;
  79 extern const char* colors[13];
  80 extern xbt_parmap_t parmap;
  81
  82 extern int user_max_depth_reached;
  83
  84 int MC_deadlock_check(void);
  85 void MC_replay(xbt_fifo_t stack, int start);
  86 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
  87 void MC_wait_for_requests(void);
  88 void MC_show_deadlock(smx_simcall_t req);
  89 void MC_show_stack_safety(xbt_fifo_t stack);
  90 void MC_dump_stack_safety(xbt_fifo_t stack);
  91 void MC_init(void);
  92 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
  93
  94
  95 /********************************* Requests ***********************************/
  96
  97 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
  98 char* MC_request_to_string(smx_simcall_t req, int value);
  99 unsigned int MC_request_testany_fail(smx_simcall_t req);
 100 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
 101 int MC_request_is_visible(smx_simcall_t req);
 102 int MC_request_is_enabled(smx_simcall_t req);
 103 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
 104 int MC_process_is_enabled(smx_process_t process);
 105 char *MC_request_get_dot_output(smx_simcall_t req, int value);
 106
 107
 108 /******************************** States **************************************/
 109
 110 /* Possible exploration status of a process in a state */
 111 typedef enum {
 112   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
 113   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
 114   MC_MORE_INTERLEAVE,       /* Interleave twice the process (for mc_random simcall) */
 115   MC_DONE                   /* Already interleaved */
 116 } e_mc_process_state_t;
 117
 118 /* On every state, each process has an entry of the following type */
 119 typedef struct mc_procstate{
 120   e_mc_process_state_t state;       /* Exploration control information */
 121   unsigned int interleave_count;    /* Number of times that the process was
 122                                        interleaved */
 123 } s_mc_procstate_t, *mc_procstate_t;
 124
 125 /* An exploration state is composed of: */
 126 typedef struct mc_state {
 127   unsigned long max_pid;            /* Maximum pid at state's creation time */
 128   mc_procstate_t proc_status;       /* State's exploration status by process */
 129   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
 130   s_smx_simcall_t internal_req;         /* Internal translation of request */
 131   s_smx_simcall_t executed_req;         /* The executed request of the state */
 132   int req_num;                      /* The request number (in the case of a
 133                                        multi-request like waitany ) */
 134   mc_snapshot_t system_state;      /* Snapshot of system state */
 135   int num;
 136 } s_mc_state_t, *mc_state_t;
 137
 138 mc_state_t MC_state_new(void);
 139 void MC_state_delete(mc_state_t state);
 140 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 141 unsigned int MC_state_interleave_size(mc_state_t state);
 142 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 143 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
 144 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
 145 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
 146 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
 147 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
 148
 149
 150 /****************************** Statistics ************************************/
 151
 152 typedef struct mc_stats {
 153   unsigned long state_size;
 154   unsigned long visited_states;
 155   unsigned long visited_pairs;
 156   unsigned long expanded_states;
 157   unsigned long expanded_pairs;
 158   unsigned long executed_transitions;
 159 } s_mc_stats_t, *mc_stats_t;
 160
 161 extern mc_stats_t mc_stats;
 162
 163 void MC_print_statistics(mc_stats_t);
 164
 165
 166 /********************************** MEMORY ******************************/
 167 /* The possible memory modes for the modelchecker are standard and raw. */
 168 /* Normally the system should operate in std, for switching to raw mode */
 169 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 170
 171 extern void *std_heap;
 172 extern void *raw_heap;
 173
 174
 175 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 176 /* an API to query about the status of a heap, we simply call mmstats and */
 177 /* because I now how does structure looks like, then I redefine it here */
 178
 179 /* struct mstats { */
 180 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
 181 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
 182 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
 183 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
 184 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
 185 /* }; */
 186
 187 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 188 #define MC_UNSET_RAW_MEM  mmalloc_set_current_heap(std_heap)
 189
 190
 191 /******************************* MEMORY MAPPINGS ***************************/
 192 /* These functions and data structures implements a binary interface for   */
 193 /* the proc maps ascii interface                                           */
 194
 195 /* Each field is defined as documented in proc's manual page  */
 196 typedef struct s_map_region {
 197
 198   void *start_addr;             /* Start address of the map */
 199   void *end_addr;               /* End address of the map */
 200   int prot;                     /* Memory protection */
 201   int flags;                    /* Additional memory flags */
 202   void *offset;                 /* Offset in the file/whatever */
 203   char dev_major;               /* Major of the device */
 204   char dev_minor;               /* Minor of the device */
 205   unsigned long inode;          /* Inode in the device */
 206   char *pathname;               /* Path name of the mapped file */
 207
 208 } s_map_region_t;
 209
 210 typedef struct s_memory_map {
 211
 212   s_map_region_t *regions;      /* Pointer to an array of regions */
 213   int mapsize;                  /* Number of regions in the memory */
 214
 215 } s_memory_map_t, *memory_map_t;
 216
 217
 218 void MC_init_memory_map_info(void);
 219 memory_map_t MC_get_memory_map(void);
 220 void MC_free_memory_map(memory_map_t map);
 221 void MC_get_libsimgrid_plt_section(void);
 222 void MC_get_binary_plt_section(void);
 223
 224 extern char *libsimgrid_path;
 225 extern void *start_plt_libsimgrid;
 226 extern void *end_plt_libsimgrid;
 227 extern void *start_plt_binary;
 228 extern void *end_plt_binary;
 229 extern void *start_got_plt_libsimgrid;
 230 extern void *end_got_plt_libsimgrid;
 231 extern void *start_got_plt_binary;
 232 extern void *end_got_plt_binary;
 233
 234 /********************************** Snapshot comparison **********************************/
 235
 236 typedef struct s_mc_comparison_times{
 237   double nb_processes_comparison_time;
 238   double bytes_used_comparison_time;
 239   double stacks_sizes_comparison_time;
 240   double binary_global_variables_comparison_time;
 241   double libsimgrid_global_variables_comparison_time;
 242   double heap_comparison_time;
 243   double stacks_comparison_time;
 244   double hash_global_variables_comparison_time;
 245   double hash_local_variables_comparison_time;
 246 }s_mc_comparison_times_t, *mc_comparison_times_t;
 247
 248 extern __thread mc_comparison_times_t mc_comp_times;
 249 extern __thread double mc_snapshot_comparison_time;
 250
 251 int snapshot_compare(void *state1, void *state2);
 252 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
 253 void print_comparison_times(void);
 254
 255 //#define MC_DEBUG 1
 256 #define MC_VERBOSE 1
 257
 258
 259 /********************************** DPOR for safety property **************************************/
 260
 261 typedef enum {
 262   e_mc_reduce_unset,
 263   e_mc_reduce_none,
 264   e_mc_reduce_dpor
 265 } e_mc_reduce_t;
 266
 267 extern e_mc_reduce_t mc_reduce_kind;
 268 extern mc_global_t initial_state_safety;
 269 extern xbt_fifo_t mc_stack_safety;
 270 extern xbt_dict_t first_enabled_state;
 271
 272 void MC_dpor_init(void);
 273 void MC_dpor(void);
 274
 275 typedef struct s_mc_visited_state{
 276   mc_snapshot_t system_state;
 277   size_t heap_bytes_used;
 278   int nb_processes;
 279   int num;
 280   int other_num; // dot_output for
 281 }s_mc_visited_state_t, *mc_visited_state_t;
 282
 283
 284 /********************************** Double-DFS for liveness property **************************************/
 285
 286 extern xbt_fifo_t mc_stack_liveness;
 287 extern mc_global_t initial_state_liveness;
 288 extern xbt_automaton_t _mc_property_automaton;
 289 extern int compare;
 290 extern xbt_dynar_t mc_stack_comparison_ignore;
 291 extern xbt_dynar_t mc_data_bss_comparison_ignore;
 292
 293 typedef struct s_mc_pair{
 294   int num;
 295   int search_cycle;
 296   mc_state_t graph_state; /* System state included */
 297   xbt_automaton_state_t automaton_state;
 298   xbt_dynar_t atomic_propositions;
 299   int requests;
 300 }s_mc_pair_t, *mc_pair_t;
 301
 302 typedef struct s_mc_visited_pair{
 303   int num;
 304   int other_num; /* Dot output for */
 305   int acceptance_pair;
 306   mc_state_t graph_state; /* System state included */
 307   xbt_automaton_state_t automaton_state;
 308   xbt_dynar_t atomic_propositions;
 309   size_t heap_bytes_used;
 310   int nb_processes;
 311   int acceptance_removed;
 312   int visited_removed;
 313 }s_mc_visited_pair_t, *mc_visited_pair_t;
 314
 315 mc_pair_t MC_pair_new(void);
 316 void MC_pair_delete(mc_pair_t);
 317 void mc_pair_free_voidp(void *p);
 318 mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
 319 void MC_visited_pair_delete(mc_visited_pair_t p);
 320
 321 void MC_ddfs_init(void);
 322 void MC_ddfs(void);
 323 void MC_show_stack_liveness(xbt_fifo_t stack);
 324 void MC_dump_stack_liveness(xbt_fifo_t stack);
 325
 326
 327 /********************************** Variables with DWARF **********************************/
 328
 329 typedef struct s_mc_object_info {
 330   char* file_name;
 331   char* start_text;
 332   char* start_data;
 333   xbt_dict_t local_variables;
 334   xbt_dynar_t global_variables;
 335   xbt_dict_t types;
 336   // TODO, add start_data, end _data ...
 337 } s_mc_object_info_t, *mc_object_info_t;
 338
 339 mc_object_info_t MC_new_object_info();
 340 mc_object_info_t MC_find_object_address(memory_map_t maps, char* name);
 341 void MC_free_object_info(mc_object_info_t* p);
 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   int global;
 410   char *name;
 411   char *type_origin;
 412   union{
 413     dw_location_t location;
 414     void *address;
 415   }address;
 416 }s_dw_variable_t, *dw_variable_t;
 417
 418 typedef struct s_dw_frame{
 419   char *name;
 420   void *low_pc;
 421   void *high_pc;
 422   dw_location_t frame_base;
 423   xbt_dynar_t variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
 424   unsigned long int start;
 425   unsigned long int end;
 426 }s_dw_frame_t, *dw_frame_t;
 427
 428 /********************************** Miscellaneous **********************************/
 429
 430 typedef struct s_local_variable{
 431   char *frame;
 432   unsigned long ip;
 433   char *name;
 434   char *type;
 435   void *address;
 436   int region;
 437 }s_local_variable_t, *local_variable_t;
 438
 439 #endif
 440