src/mc/mc_private.h

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