src/mc/mc_private.h

   1 /* Copyright (c) 2007-2012 Da SimGrid Team. All rights reserved.            */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef MC_PRIVATE_H
   7 #define MC_PRIVATE_H
   8
   9 #include "simgrid_config.h"
  10 #include <stdio.h>
  11 #ifndef WIN32
  12 #include <sys/mman.h>
  13 #endif
  14 #include "mc/mc.h"
  15 #include "mc/datatypes.h"
  16 #include "xbt/fifo.h"
  17 #include "xbt/config.h"
  18 #include "xbt/function_types.h"
  19 #include "xbt/mmalloc.h"
  20 #include "../simix/smx_private.h"
  21 #include "xbt/automaton.h"
  22 #include "xbt/hash.h"
  23 #include "msg/msg.h"
  24 #include "msg/datatypes.h"
  25 #include "xbt/strbuff.h"
  26
  27 /****************************** Snapshots ***********************************/
  28
  29 #define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
  30
  31 typedef struct s_mc_mem_region{
  32   void *start_addr;
  33   void *data;
  34   size_t size;
  35 } s_mc_mem_region_t, *mc_mem_region_t;
  36
  37 typedef struct s_mc_snapshot{
  38   size_t heap_bytes_used;
  39   mc_mem_region_t regions[NB_REGIONS];
  40   int nb_processes;
  41   size_t *stack_sizes;
  42   xbt_dynar_t stacks;
  43   xbt_dynar_t to_ignore;
  44 } s_mc_snapshot_t, *mc_snapshot_t;
  45
  46 typedef struct s_mc_snapshot_stack{
  47   xbt_strbuff_t local_variables;
  48   void *stack_pointer;
  49 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
  50
  51 typedef struct s_mc_global_t{
  52   mc_snapshot_t snapshot;
  53   int raw_mem_set;
  54 }s_mc_global_t, *mc_global_t;
  55
  56 //void MC_take_snapshot(mc_snapshot_t);
  57 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
  58 mc_snapshot_t MC_take_snapshot(void);
  59 void MC_restore_snapshot(mc_snapshot_t);
  60 void MC_free_snapshot(mc_snapshot_t);
  61 void snapshot_stack_free_voidp(void *s);
  62
  63 /********************************* MC Global **********************************/
  64 extern double *mc_time;
  65
  66 int MC_deadlock_check(void);
  67 void MC_replay(xbt_fifo_t stack, int start);
  68 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
  69 void MC_wait_for_requests(void);
  70 void MC_show_deadlock(smx_simcall_t req);
  71 void MC_show_stack_safety(xbt_fifo_t stack);
  72 void MC_dump_stack_safety(xbt_fifo_t stack);
  73
  74 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
  75
  76 /********************************* Requests ***********************************/
  77 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
  78 char* MC_request_to_string(smx_simcall_t req, int value);
  79 unsigned int MC_request_testany_fail(smx_simcall_t req);
  80 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
  81 int MC_request_is_visible(smx_simcall_t req);
  82 int MC_request_is_enabled(smx_simcall_t req);
  83 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
  84 int MC_process_is_enabled(smx_process_t process);
  85
  86
  87 /******************************** States **************************************/
  88 /* Possible exploration status of a process in a state */
  89 typedef enum {
  90   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
  91   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
  92   MC_DONE                   /* Already interleaved */
  93 } e_mc_process_state_t;
  94
  95 /* On every state, each process has an entry of the following type */
  96 typedef struct mc_procstate{
  97   e_mc_process_state_t state;       /* Exploration control information */
  98   unsigned int interleave_count;    /* Number of times that the process was
  99                                        interleaved */
 100 } s_mc_procstate_t, *mc_procstate_t;
 101
 102 /* An exploration state is composed of: */
 103 typedef struct mc_state {
 104   unsigned long max_pid;            /* Maximum pid at state's creation time */
 105   mc_procstate_t proc_status;       /* State's exploration status by process */
 106   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
 107   s_smx_simcall_t internal_req;         /* Internal translation of request */
 108   s_smx_simcall_t executed_req;         /* The executed request of the state */
 109   int req_num;                      /* The request number (in the case of a
 110                                        multi-request like waitany ) */
 111   mc_snapshot_t system_state;      /* Snapshot of system state */
 112 } s_mc_state_t, *mc_state_t;
 113
 114 mc_state_t MC_state_new(void);
 115 void MC_state_delete(mc_state_t state);
 116 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 117 unsigned int MC_state_interleave_size(mc_state_t state);
 118 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 119 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
 120 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
 121 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
 122 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
 123 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
 124
 125 /****************************** Statistics ************************************/
 126 typedef struct mc_stats {
 127   unsigned long state_size;
 128   unsigned long visited_states;
 129   unsigned long expanded_states;
 130   unsigned long executed_transitions;
 131 } s_mc_stats_t, *mc_stats_t;
 132
 133 typedef struct mc_stats_pair {
 134   //unsigned long pair_size;
 135   unsigned long visited_pairs;
 136   unsigned long expanded_pairs;
 137   unsigned long executed_transitions;
 138 } s_mc_stats_pair_t, *mc_stats_pair_t;
 139
 140 extern mc_stats_t mc_stats;
 141 extern mc_stats_pair_t mc_stats_pair;
 142
 143 void MC_print_statistics(mc_stats_t);
 144 void MC_print_statistics_pairs(mc_stats_pair_t);
 145
 146 /********************************** MEMORY ******************************/
 147 /* The possible memory modes for the modelchecker are standard and raw. */
 148 /* Normally the system should operate in std, for switching to raw mode */
 149 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 150
 151 extern void *std_heap;
 152 extern void *raw_heap;
 153
 154
 155 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 156 /* an API to query about the status of a heap, we simply call mmstats and */
 157 /* because I now how does structure looks like, then I redefine it here */
 158
 159 /* struct mstats { */
 160 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
 161 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
 162 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
 163 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
 164 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
 165 /* }; */
 166
 167 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 168 #define MC_UNSET_RAW_MEM  mmalloc_set_current_heap(std_heap)
 169
 170 /******************************* MEMORY MAPPINGS ***************************/
 171 /* These functions and data structures implements a binary interface for   */
 172 /* the proc maps ascii interface                                           */
 173
 174 /* Each field is defined as documented in proc's manual page  */
 175 typedef struct s_map_region {
 176
 177   void *start_addr;             /* Start address of the map */
 178   void *end_addr;               /* End address of the map */
 179   int prot;                     /* Memory protection */
 180   int flags;                    /* Aditional memory flags */
 181   void *offset;                 /* Offset in the file/whatever */
 182   char dev_major;               /* Major of the device */
 183   char dev_minor;               /* Minor of the device */
 184   unsigned long inode;          /* Inode in the device */
 185   char *pathname;               /* Path name of the mapped file */
 186
 187 } s_map_region_t;
 188
 189 typedef struct s_memory_map {
 190
 191   s_map_region_t *regions;      /* Pointer to an array of regions */
 192   int mapsize;                  /* Number of regions in the memory */
 193
 194 } s_memory_map_t, *memory_map_t;
 195
 196 memory_map_t get_memory_map(void);
 197 void free_memory_map(memory_map_t map);
 198 void get_libsimgrid_plt_section(void);
 199 void get_binary_plt_section(void);
 200
 201 extern void *start_data_libsimgrid;
 202 extern void *start_data_binary;
 203 extern void *start_bss_binary;
 204 extern char *libsimgrid_path;
 205 extern void *start_text_libsimgrid;
 206 extern void *start_bss_libsimgrid;
 207 extern void *start_plt_libsimgrid;
 208 extern void *end_plt_libsimgrid;
 209 extern void *start_plt_binary;
 210 extern void *end_plt_binary;
 211 extern void *start_got_plt_libsimgrid;
 212 extern void *end_got_plt_libsimgrid;
 213 extern void *start_got_plt_binary;
 214 extern void *end_got_plt_binary;
 215
 216 /********************************** Snapshot comparison **********************************/
 217
 218 typedef struct s_mc_comparison_times{
 219   double nb_processes_comparison_time;
 220   double bytes_used_comparison_time;
 221   double stacks_sizes_comparison_time;
 222   double binary_global_variables_comparison_time;
 223   double libsimgrid_global_variables_comparison_time;
 224   double heap_comparison_time;
 225   double stacks_comparison_time;
 226 }s_mc_comparison_times_t, *mc_comparison_times_t;
 227
 228 extern mc_comparison_times_t mc_comp_times;
 229 extern double mc_snapshot_comparison_time;
 230
 231 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
 232 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
 233 void print_comparison_times(void);
 234
 235 //#define MC_DEBUG 1
 236 //#define MC_VERBOSE 1
 237
 238 /********************************** DPOR for safety  **************************************/
 239 typedef enum {
 240   e_mc_reduce_unset,
 241   e_mc_reduce_none,
 242   e_mc_reduce_dpor
 243 } e_mc_reduce_t;
 244
 245 extern e_mc_reduce_t mc_reduce_kind;
 246 extern mc_global_t initial_state_safety;
 247
 248 void MC_dpor_init(void);
 249 void MC_dpor(void);
 250 void MC_init(void);
 251
 252 typedef struct s_mc_safety_visited_state{
 253   mc_snapshot_t system_state;
 254   int num;
 255 }s_mc_safety_visited_state_t, *mc_safety_visited_state_t;
 256
 257
 258 /********************************** Double-DFS for liveness property**************************************/
 259
 260 extern xbt_fifo_t mc_stack_liveness;
 261 extern mc_global_t initial_state_liveness;
 262 extern xbt_automaton_t _mc_property_automaton;
 263 extern int compare;
 264 extern xbt_dynar_t mc_stack_comparison_ignore;
 265 extern xbt_dynar_t mc_data_bss_comparison_ignore;
 266
 267
 268 typedef struct s_mc_pair{
 269   mc_snapshot_t system_state;
 270   mc_state_t graph_state;
 271   xbt_state_t automaton_state;
 272 }s_mc_pair_t, *mc_pair_t;
 273
 274 typedef struct s_mc_pair_reached{
 275   int nb;
 276   xbt_state_t automaton_state;
 277   xbt_dynar_t prop_ato;
 278   mc_snapshot_t system_state;
 279 }s_mc_pair_reached_t, *mc_pair_reached_t;
 280
 281 typedef struct s_mc_pair_visited{
 282   xbt_state_t automaton_state;
 283   xbt_dynar_t prop_ato;
 284   mc_snapshot_t system_state;
 285 }s_mc_pair_visited_t, *mc_pair_visited_t;
 286
 287 int MC_automaton_evaluate_label(xbt_exp_label_t l);
 288
 289 int reached(xbt_state_t st);
 290 void set_pair_reached(xbt_state_t st);
 291 int visited(xbt_state_t st);
 292
 293 void MC_pair_delete(mc_pair_t pair);
 294 mc_state_t MC_state_pair_new(void);
 295 void pair_reached_free(mc_pair_reached_t pair);
 296 void pair_reached_free_voidp(void *p);
 297 void pair_visited_free(mc_pair_visited_t pair);
 298 void pair_visited_free_voidp(void *p);
 299 void MC_init_memory_map_info(void);
 300
 301 int get_heap_region_index(mc_snapshot_t s);
 302
 303 /* **** Double-DFS stateless **** */
 304
 305 typedef struct s_mc_pair_stateless{
 306   mc_state_t graph_state;
 307   xbt_state_t automaton_state;
 308   int requests;
 309 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
 310
 311 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
 312 void MC_ddfs_init(void);
 313 void MC_ddfs(int search_cycle);
 314 void MC_show_stack_liveness(xbt_fifo_t stack);
 315 void MC_dump_stack_liveness(xbt_fifo_t stack);
 316 void pair_stateless_free(mc_pair_stateless_t pair);
 317 void pair_stateless_free_voidp(void *p);
 318
 319 /********************************** Configuration of MC **************************************/
 320 extern xbt_fifo_t mc_stack_safety;
 321
 322 /****** Core dump ******/
 323
 324 int create_dump(int pair);
 325
 326 /****** Local variables with DWARF ******/
 327
 328 typedef enum {
 329   e_dw_loclist,
 330   e_dw_register,
 331   e_dw_bregister_op,
 332   e_dw_lit,
 333   e_dw_fbregister_op,
 334   e_dw_piece,
 335   e_dw_arithmetic,
 336   e_dw_plus_uconst,
 337   e_dw_compose,
 338   e_dw_deref,
 339   e_dw_uconstant,
 340   e_dw_sconstant,
 341   e_dw_unsupported
 342 } e_dw_location_type;
 343
 344 typedef struct s_dw_location{
 345   e_dw_location_type type;
 346   union{
 347
 348     xbt_dynar_t loclist;
 349
 350     int reg;
 351
 352     struct{
 353       unsigned int reg;
 354       int offset;
 355     }breg_op;
 356
 357     unsigned int lit;
 358
 359     int fbreg_op;
 360
 361     int piece;
 362
 363     unsigned short int deref_size;
 364
 365     xbt_dynar_t compose;
 366
 367     char *arithmetic;
 368
 369     struct{
 370       int bytes;
 371       long unsigned int value;
 372     }uconstant;
 373
 374     struct{
 375       int bytes;
 376       long signed int value;
 377     }sconstant;
 378
 379     unsigned int plus_uconst;
 380
 381   }location;
 382 }s_dw_location_t, *dw_location_t;
 383
 384 typedef struct s_dw_location_entry{
 385   long lowpc;
 386   long highpc;
 387   dw_location_t location;
 388 }s_dw_location_entry_t, *dw_location_entry_t;
 389
 390 typedef struct s_dw_local_variable{
 391   char *name;
 392   dw_location_t location;
 393 }s_dw_local_variable_t, *dw_local_variable_t;
 394
 395 typedef struct s_dw_frame{
 396   char *name;
 397   void *low_pc;
 398   void *high_pc;
 399   dw_location_t frame_base;
 400   xbt_dict_t variables;
 401   unsigned long int start;
 402   unsigned long int end;
 403 }s_dw_frame_t, *dw_frame_t;
 404
 405 /* FIXME : implement free functions for each structure */
 406
 407 extern xbt_dict_t mc_local_variables;
 408
 409 typedef struct s_variable_value{
 410   char *type;
 411
 412   union{
 413     void *address;
 414     long int res;
 415   }value;
 416 }s_variable_value_t, *variable_value_t;
 417
 418 void variable_value_free_voidp(void* v);
 419 void variable_value_free(variable_value_t v);
 420
 421 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
 422 void print_local_variables(xbt_dict_t list);
 423 xbt_dict_t MC_get_location_list(const char *elf_file);
 424
 425 /**** Global variables ****/
 426
 427 typedef struct s_global_variable{
 428   char *name;
 429   size_t size;
 430   void *address;
 431 }s_global_variable_t, *global_variable_t;
 432
 433 void global_variable_free(global_variable_t v);
 434 void global_variable_free_voidp(void *v);
 435
 436 extern xbt_dynar_t mc_global_variables;
 437
 438 #endif