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 }s_mc_global_t, *mc_global_t;
  48
  49 void MC_take_snapshot(mc_snapshot_t);
  50 mc_snapshot_t MC_take_snapshot_liveness(void);
  51 void MC_restore_snapshot(mc_snapshot_t);
  52 void MC_free_snapshot(mc_snapshot_t);
  53 void snapshot_stack_free_voidp(void *s);
  54
  55 /********************************* MC Global **********************************/
  56 extern double *mc_time;
  57
  58 /* Bound of the MC depth-first search algorithm */
  59 #define MAX_DEPTH 1000
  60 #define MAX_DEPTH_LIVENESS 500
  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
 121 /****************************** Statistics ************************************/
 122 typedef struct mc_stats {
 123   unsigned long state_size;
 124   unsigned long visited_states;
 125   unsigned long expanded_states;
 126   unsigned long executed_transitions;
 127 } s_mc_stats_t, *mc_stats_t;
 128
 129 typedef struct mc_stats_pair {
 130   //unsigned long pair_size;
 131   unsigned long visited_pairs;
 132   unsigned long expanded_pairs;
 133   unsigned long executed_transitions;
 134 } s_mc_stats_pair_t, *mc_stats_pair_t;
 135
 136 extern mc_stats_t mc_stats;
 137 extern mc_stats_pair_t mc_stats_pair;
 138
 139 void MC_print_statistics(mc_stats_t);
 140 void MC_print_statistics_pairs(mc_stats_pair_t);
 141
 142 /********************************** MEMORY ******************************/
 143 /* The possible memory modes for the modelchecker are standard and raw. */
 144 /* Normally the system should operate in std, for switching to raw mode */
 145 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 146
 147 extern void *std_heap;
 148 extern void *raw_heap;
 149
 150
 151 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 152 /* an API to query about the status of a heap, we simply call mmstats and */
 153 /* because I now how does structure looks like, then I redefine it here */
 154
 155 /* struct mstats { */
 156 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
 157 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
 158 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
 159 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
 160 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
 161 /* }; */
 162
 163 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 164 #define MC_UNSET_RAW_MEM  mmalloc_set_current_heap(std_heap)
 165
 166 extern int raw_mem_set;
 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
 202 /********************************** DPOR for safety  **************************************/
 203 typedef enum {
 204   e_mc_reduce_unset,
 205   e_mc_reduce_none,
 206   e_mc_reduce_dpor
 207 } e_mc_reduce_t;
 208
 209 extern e_mc_reduce_t mc_reduce_kind;
 210
 211 void MC_dpor_init(void);
 212 void MC_dpor(void);
 213 void MC_dpor_exit(void);
 214 void MC_init_safety(void);
 215
 216
 217 /********************************** Double-DFS for liveness property**************************************/
 218
 219 extern xbt_fifo_t mc_stack_liveness;
 220 extern mc_global_t initial_state_liveness;
 221 extern xbt_automaton_t _mc_property_automaton;
 222 extern int compare;
 223 extern void *start_plt_libsimgrid;
 224 extern void *end_plt_libsimgrid;
 225 extern void *start_plt_binary;
 226 extern void *end_plt_binary;
 227 extern xbt_dynar_t mc_stack_comparison_ignore;
 228
 229 typedef struct s_mc_pair{
 230   mc_snapshot_t system_state;
 231   mc_state_t graph_state;
 232   xbt_state_t automaton_state;
 233 }s_mc_pair_t, *mc_pair_t;
 234
 235 typedef struct s_mc_pair_reached{
 236   int nb;
 237   xbt_state_t automaton_state;
 238   xbt_dynar_t prop_ato;
 239   mc_snapshot_t system_state;
 240 }s_mc_pair_reached_t, *mc_pair_reached_t;
 241
 242 int MC_automaton_evaluate_label(xbt_exp_label_t l);
 243 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 244
 245 int reached(xbt_state_t st);
 246 void set_pair_reached(xbt_state_t st);
 247 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
 248 void MC_pair_delete(mc_pair_t pair);
 249 void MC_exit_liveness(void);
 250 mc_state_t MC_state_pair_new(void);
 251 void pair_reached_free(mc_pair_reached_t pair);
 252 void pair_reached_free_voidp(void *p);
 253 void MC_init_liveness(void);
 254 void MC_init_memory_map_info(void);
 255
 256 /* **** Double-DFS stateless **** */
 257
 258 typedef struct s_mc_pair_stateless{
 259   mc_state_t graph_state;
 260   xbt_state_t automaton_state;
 261   int requests;
 262 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
 263
 264 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
 265 void MC_ddfs_init(void);
 266 void MC_ddfs(int search_cycle);
 267 void MC_show_stack_liveness(xbt_fifo_t stack);
 268 void MC_dump_stack_liveness(xbt_fifo_t stack);
 269 void pair_stateless_free(mc_pair_stateless_t pair);
 270 void pair_stateless_free_voidp(void *p);
 271
 272 /********************************** Configuration of MC **************************************/
 273 extern xbt_fifo_t mc_stack_safety;
 274
 275 extern int _surf_mc_checkpoint;
 276 extern char* _surf_mc_property_file;
 277
 278 /****** Core dump ******/
 279
 280 int create_dump(int pair);
 281
 282 /****** Local variables with DWARF ******/
 283
 284 typedef enum {
 285   e_dw_loclist,
 286   e_dw_register,
 287   e_dw_bregister_op,
 288   e_dw_lit,
 289   e_dw_fbregister_op,
 290   e_dw_piece,
 291   e_dw_arithmetic,
 292   e_dw_plus_uconst,
 293   e_dw_compose,
 294   e_dw_deref,
 295   e_dw_uconstant,
 296   e_dw_sconstant,
 297   e_dw_unsupported
 298 } e_dw_location_type;
 299
 300 typedef struct s_dw_location{
 301   e_dw_location_type type;
 302   union{
 303
 304     xbt_dynar_t loclist;
 305
 306     int reg;
 307
 308     struct{
 309       unsigned int reg;
 310       int offset;
 311     }breg_op;
 312
 313     unsigned int lit;
 314
 315     int fbreg_op;
 316
 317     int piece;
 318
 319     unsigned short int deref_size;
 320
 321     xbt_dynar_t compose;
 322
 323     char *arithmetic;
 324
 325     struct{
 326       int bytes;
 327       long unsigned int value;
 328     }uconstant;
 329
 330     struct{
 331       int bytes;
 332       long signed int value;
 333     }sconstant;
 334
 335     unsigned int plus_uconst;
 336
 337   }location;
 338 }s_dw_location_t, *dw_location_t;
 339
 340 typedef struct s_dw_location_entry{
 341   long lowpc;
 342   long highpc;
 343   dw_location_t location;
 344 }s_dw_location_entry_t, *dw_location_entry_t;
 345
 346 typedef struct s_dw_local_variable{
 347   char *name;
 348   dw_location_t location;
 349 }s_dw_local_variable_t, *dw_local_variable_t;
 350
 351 typedef struct s_dw_frame{
 352   char *name;
 353   void *low_pc;
 354   void *high_pc;
 355   dw_location_t frame_base;
 356   xbt_dict_t variables;
 357   unsigned long int start;
 358   unsigned long int end;
 359 }s_dw_frame_t, *dw_frame_t;
 360
 361 /* FIXME : implement free functions for each structure */
 362
 363 extern xbt_dict_t mc_local_variables;
 364
 365 typedef struct s_variable_value{
 366   char *type;
 367
 368   union{
 369     void *address;
 370     long int res;
 371   }value;
 372 }s_variable_value_t, *variable_value_t;
 373
 374 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
 375 void print_local_variables(xbt_dict_t list);
 376 char *get_libsimgrid_path(void);
 377 xbt_dict_t MC_get_location_list(const char *elf_file);
 378
 379 #endif