Logo AND Algorithmique Numérique Distribuée

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