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