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