src/mc/mc_private.h

   1 /* Copyright (c) 2007-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef MC_PRIVATE_H
   8 #define MC_PRIVATE_H
   9
  10 #include <sys/types.h>
  11
  12 #include "simgrid_config.h"
  13 #include <stdio.h>
  14 #include <stdint.h>
  15 #include <stdbool.h>
  16 #ifndef WIN32
  17 #include <sys/mman.h>
  18 #endif
  19 #include <elfutils/libdw.h>
  20
  21 #include "mc/mc.h"
  22 #include "mc_base.h"
  23 #include "mc/datatypes.h"
  24 #include "xbt/fifo.h"
  25 #include "xbt/config.h"
  26
  27 #include "xbt/function_types.h"
  28 #include "xbt/mmalloc.h"
  29 #include "../simix/smx_private.h"
  30 #include "../xbt/mmalloc/mmprivate.h"
  31 #include "xbt/automaton.h"
  32 #include "xbt/hash.h"
  33 #include "msg/msg.h"
  34 #include "msg/datatypes.h"
  35 #include "xbt/strbuff.h"
  36 #include "xbt/parmap.h"
  37
  38 #include "mc_forward.h"
  39 #include "mc_protocol.h"
  40
  41 SG_BEGIN_DECL()
  42
  43 typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
  44
  45 /********************************* MC Global **********************************/
  46
  47 /** Initialisation of the model-checker
  48  *
  49  * @param pid     PID of the target process
  50  * @param socket  FD for the communication socket **in server mode** (or -1 otherwise)
  51  */
  52 void MC_init_pid(pid_t pid, int socket);
  53
  54 extern FILE *dot_output;
  55 extern const char* colors[13];
  56 extern xbt_parmap_t parmap;
  57
  58 extern int user_max_depth_reached;
  59
  60 int MC_deadlock_check(void);
  61 void MC_replay(xbt_fifo_t stack);
  62 void MC_replay_liveness(xbt_fifo_t stack);
  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 void MC_show_non_termination(void);
  67
  68 /** Stack (of `mc_state_t`) representing the current position of the
  69  *  the MC in the exploration graph
  70  *
  71  *  It is managed by its head (`xbt_fifo_shift` and `xbt_fifo_unshift`).
  72  */
  73 extern xbt_fifo_t mc_stack;
  74
  75 int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
  76
  77
  78 /****************************** Statistics ************************************/
  79
  80 typedef struct mc_stats {
  81   unsigned long state_size;
  82   unsigned long visited_states;
  83   unsigned long visited_pairs;
  84   unsigned long expanded_states;
  85   unsigned long expanded_pairs;
  86   unsigned long executed_transitions;
  87 } s_mc_stats_t, *mc_stats_t;
  88
  89 extern mc_stats_t mc_stats;
  90
  91 void MC_print_statistics(mc_stats_t stats);
  92
  93 /********************************** Snapshot comparison **********************************/
  94
  95 typedef struct s_mc_comparison_times{
  96   double nb_processes_comparison_time;
  97   double bytes_used_comparison_time;
  98   double stacks_sizes_comparison_time;
  99   double global_variables_comparison_time;
 100   double heap_comparison_time;
 101   double stacks_comparison_time;
 102 }s_mc_comparison_times_t, *mc_comparison_times_t;
 103
 104 extern __thread mc_comparison_times_t mc_comp_times;
 105 extern __thread double mc_snapshot_comparison_time;
 106
 107 int snapshot_compare(void *state1, void *state2);
 108 void print_comparison_times(void);
 109
 110 //#define MC_DEBUG 1
 111 #define MC_VERBOSE 1
 112
 113 /********************************** Variables with DWARF **********************************/
 114
 115 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
 116
 117 /********************************** Miscellaneous **********************************/
 118
 119 typedef struct s_local_variable{
 120   dw_frame_t subprogram;
 121   unsigned long ip;
 122   char *name;
 123   dw_type_t type;
 124   void *address;
 125   int region;
 126 }s_local_variable_t, *local_variable_t;
 127
 128 /* *********** Sets *********** */
 129
 130 typedef struct s_mc_address_set *mc_address_set_t;
 131
 132 mc_address_set_t mc_address_set_new(void);
 133 void mc_address_set_free(mc_address_set_t* p);
 134 void mc_address_add(mc_address_set_t p, const void* value);
 135 bool mc_address_test(mc_address_set_t p, const void* value);
 136
 137 /* *********** Hash *********** */
 138
 139 /** \brief Hash the current state
 140  *  \param num_state number of states
 141  *  \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
 142  *  \result resulting hash
 143  * */
 144 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
 145
 146 /** @brief Dump the stacks of the application processes
 147  *
 148  *   This functions is currently not used but it is quite convenient
 149  *   to call from the debugger.
 150  *
 151  *   Does not work when an application thread is running.
 152  */
 153 void MC_dump_stacks(FILE* file);
 154
 155 SG_END_DECL()
 156
 157 #endif