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