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 <simgrid/msg.h>
  34 #include "xbt/strbuff.h"
  35 #include "xbt/parmap.h"
  36
  37 #include "mc_forward.h"
  38 #include "mc_protocol.h"
  39
  40 SG_BEGIN_DECL()
  41
  42 typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
  43
  44 /********************************* MC Global **********************************/
  45
  46 /** Initialisation of the model-checker
  47  *
  48  * @param pid     PID of the target process
  49  * @param socket  FD for the communication socket **in server mode** (or -1 otherwise)
  50  */
  51 void MC_init_pid(pid_t pid, int socket);
  52
  53 extern FILE *dot_output;
  54 extern const char* colors[13];
  55 extern xbt_parmap_t parmap;
  56
  57 extern int user_max_depth_reached;
  58
  59 int MC_deadlock_check(void);
  60 void MC_replay(xbt_fifo_t stack);
  61 void MC_replay_liveness(xbt_fifo_t stack);
  62 void MC_show_deadlock(smx_simcall_t req);
  63 void MC_show_stack_safety(xbt_fifo_t stack);
  64 void MC_dump_stack_safety(xbt_fifo_t stack);
  65 void MC_show_non_termination(void);
  66
  67 /** Stack (of `mc_state_t`) representing the current position of the
  68  *  the MC in the exploration graph
  69  *
  70  *  It is managed by its head (`xbt_fifo_shift` and `xbt_fifo_unshift`).
  71  */
  72 extern xbt_fifo_t mc_stack;
  73
  74 int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
  75
  76
  77 /****************************** Statistics ************************************/
  78
  79 typedef struct mc_stats {
  80   unsigned long state_size;
  81   unsigned long visited_states;
  82   unsigned long visited_pairs;
  83   unsigned long expanded_states;
  84   unsigned long expanded_pairs;
  85   unsigned long executed_transitions;
  86 } s_mc_stats_t, *mc_stats_t;
  87
  88 extern mc_stats_t mc_stats;
  89
  90 void MC_print_statistics(mc_stats_t stats);
  91
  92 /********************************** Snapshot comparison **********************************/
  93
  94 typedef struct s_mc_comparison_times{
  95   double nb_processes_comparison_time;
  96   double bytes_used_comparison_time;
  97   double stacks_sizes_comparison_time;
  98   double global_variables_comparison_time;
  99   double heap_comparison_time;
 100   double stacks_comparison_time;
 101 }s_mc_comparison_times_t, *mc_comparison_times_t;
 102
 103 extern __thread mc_comparison_times_t mc_comp_times;
 104 extern __thread double mc_snapshot_comparison_time;
 105
 106 int snapshot_compare(void *state1, void *state2);
 107 void print_comparison_times(void);
 108
 109 //#define MC_DEBUG 1
 110 #define MC_VERBOSE 1
 111
 112 /********************************** Variables with DWARF **********************************/
 113
 114 void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
 115
 116 /********************************** Miscellaneous **********************************/
 117
 118 typedef struct s_local_variable{
 119   dw_frame_t subprogram;
 120   unsigned long ip;
 121   char *name;
 122   dw_type_t type;
 123   void *address;
 124   int region;
 125 }s_local_variable_t, *local_variable_t;
 126
 127 /* *********** Sets *********** */
 128
 129 typedef struct s_mc_address_set *mc_address_set_t;
 130
 131 mc_address_set_t mc_address_set_new(void);
 132 void mc_address_set_free(mc_address_set_t* p);
 133 void mc_address_add(mc_address_set_t p, const void* value);
 134 bool mc_address_test(mc_address_set_t p, const void* value);
 135
 136 /* *********** Hash *********** */
 137
 138 /** \brief Hash the current state
 139  *  \param num_state number of states
 140  *  \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
 141  *  \result resulting hash
 142  * */
 143 uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
 144
 145 /** @brief Dump the stacks of the application processes
 146  *
 147  *   This functions is currently not used but it is quite convenient
 148  *   to call from the debugger.
 149  *
 150  *   Does not work when an application thread is running.
 151  */
 152 void MC_dump_stacks(FILE* file);
 153
 154 void MC_report_assertion_error(void);
 155
 156 SG_END_DECL()
 157
 158 #endif