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