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