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