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