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