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