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