Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branches 'MC_LTL' and 'MC_LTL' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / src / mc / private.h
1 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
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 <stdio.h>
11 #include <sys/mman.h>
12 #include "mc/mc.h"
13 #include "mc/datatypes.h"
14 #include "xbt/fifo.h"
15 #include "xbt/config.h"
16 #include "xbt/function_types.h"
17 #include "xbt/mmalloc.h"
18 #include "../simix/private.h"
19 #include "xbt/automaton.h"
20 #include "xbt/hash.h"
21
22 /****************************** Snapshots ***********************************/
23
24 typedef struct s_mc_mem_region{
25   int type;
26   void *start_addr;
27   void *data;
28   size_t size;
29 } s_mc_mem_region_t, *mc_mem_region_t;
30
31 typedef struct s_mc_snapshot{
32   unsigned int num_reg;
33   mc_mem_region_t *regions;
34 } s_mc_snapshot_t, *mc_snapshot_t;
35
36 extern char *prog_name;
37
38 void MC_take_snapshot(mc_snapshot_t);
39 void MC_take_snapshot_liveness(mc_snapshot_t s);
40 void MC_take_snapshot_to_restore_liveness(mc_snapshot_t s);
41 void MC_restore_snapshot(mc_snapshot_t);
42 void MC_free_snapshot(mc_snapshot_t);
43
44 /********************************* MC Global **********************************/
45 extern double *mc_time;
46
47 /* Bound of the MC depth-first search algorithm */
48 #define MAX_DEPTH 1000
49 #define MAX_DEPTH_LIVENESS 500
50
51 int MC_deadlock_check(void);
52 void MC_replay(xbt_fifo_t stack);
53 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
54 void MC_wait_for_requests(void);
55 void MC_get_enabled_processes();
56 void MC_show_deadlock(smx_req_t req);
57 void MC_show_deadlock_stateful(smx_req_t req);
58 void MC_show_stack_safety_stateless(xbt_fifo_t stack);
59 void MC_dump_stack_safety_stateless(xbt_fifo_t stack);
60 void MC_show_stack_safety_stateful(xbt_fifo_t stack);
61 void MC_dump_stack_safety_stateful(xbt_fifo_t stack);
62
63 /********************************* Requests ***********************************/
64 int MC_request_depend(smx_req_t req1, smx_req_t req2);
65 char* MC_request_to_string(smx_req_t req, int value);
66 unsigned int MC_request_testany_fail(smx_req_t req);
67 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
68 int MC_request_is_visible(smx_req_t req);
69 int MC_request_is_enabled(smx_req_t req);
70 int MC_request_is_enabled_by_idx(smx_req_t req, unsigned int idx);
71 int MC_process_is_enabled(smx_process_t process);
72
73
74 /******************************** States **************************************/
75 /* Possible exploration status of a process in a state */
76 typedef enum {
77   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
78   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
79   MC_DONE                   /* Already interleaved */
80 } e_mc_process_state_t;
81
82 /* On every state, each process has an entry of the following type */
83 typedef struct mc_procstate{
84   e_mc_process_state_t state;       /* Exploration control information */
85   unsigned int interleave_count;    /* Number of times that the process was
86                                        interleaved */
87 } s_mc_procstate_t, *mc_procstate_t;
88
89 /* An exploration state is composed of: */
90 typedef struct mc_state {
91   unsigned long max_pid;            /* Maximum pid at state's creation time */
92   mc_procstate_t proc_status;       /* State's exploration status by process */
93   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
94   s_smx_req_t internal_req;         /* Internal translation of request */
95   s_smx_req_t executed_req;         /* The executed request of the state */
96   int req_num;                      /* The request number (in the case of a
97                                        multi-request like waitany ) */
98 } s_mc_state_t, *mc_state_t;
99
100 extern xbt_fifo_t mc_stack_safety_stateless;
101
102 mc_state_t MC_state_new(void);
103 void MC_state_delete(mc_state_t state);
104 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
105 unsigned int MC_state_interleave_size(mc_state_t state);
106 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
107 void MC_state_set_executed_request(mc_state_t state, smx_req_t req, int value);
108 smx_req_t MC_state_get_executed_request(mc_state_t state, int *value);
109 smx_req_t MC_state_get_internal_request(mc_state_t state);
110 smx_req_t MC_state_get_request(mc_state_t state, int *value);
111
112 /****************************** Statistics ************************************/
113 typedef struct mc_stats {
114   unsigned long state_size;
115   unsigned long visited_states;
116   unsigned long expanded_states;
117   unsigned long executed_transitions;
118 } s_mc_stats_t, *mc_stats_t;
119
120 typedef struct mc_stats_pair {
121   //unsigned long pair_size;
122   unsigned long visited_pairs;
123   unsigned long expanded_pairs;
124   unsigned long executed_transitions;
125 } s_mc_stats_pair_t, *mc_stats_pair_t;
126
127 extern mc_stats_t mc_stats;
128 extern mc_stats_pair_t mc_stats_pair;
129
130 void MC_print_statistics(mc_stats_t);
131 void MC_print_statistics_pairs(mc_stats_pair_t);
132
133 /********************************** MEMORY ******************************/
134 /* The possible memory modes for the modelchecker are standard and raw. */
135 /* Normally the system should operate in std, for switching to raw mode */
136 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
137
138 extern void *std_heap;
139 extern void *raw_heap;
140 /* extern int raw_heap_fd; */ /* unused */
141 #define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
142
143 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
144 /* an API to query about the status of a heap, we simply call mmstats and */
145 /* because I now how does structure looks like, then I redefine it here */
146
147 struct mstats {
148   size_t bytes_total;           /* Total size of the heap. */
149   size_t chunks_used;           /* Chunks allocated by the user. */
150   size_t bytes_used;            /* Byte total of user-allocated chunks. */
151   size_t chunks_free;           /* Chunks in the free list. */
152   size_t bytes_free;            /* Byte total of chunks in the free list. */
153 };
154
155 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
156 #define MC_UNSET_RAW_MEM    mmalloc_set_current_heap(std_heap)
157
158 /******************************* MEMORY MAPPINGS ***************************/
159 /* These functions and data structures implements a binary interface for   */
160 /* the proc maps ascii interface                                           */
161
162 /* Each field is defined as documented in proc's manual page  */
163 typedef struct s_map_region {
164
165   void *start_addr;             /* Start address of the map */
166   void *end_addr;               /* End address of the map */
167   int prot;                     /* Memory protection */
168   int flags;                    /* Aditional memory flags */
169   void *offset;                 /* Offset in the file/whatever */
170   char dev_major;               /* Major of the device */
171   char dev_minor;               /* Minor of the device */
172   unsigned long inode;          /* Inode in the device */
173   char *pathname;               /* Path name of the mapped file */
174
175 } s_map_region;
176
177 typedef struct s_memory_map {
178
179   s_map_region *regions;        /* Pointer to an array of regions */
180   int mapsize;                  /* Number of regions in the memory */
181
182 } s_memory_map_t, *memory_map_t;
183
184 memory_map_t get_memory_map(void);
185
186
187 /********************************** DPOR for safety (stateless) **************************************/
188 void MC_dpor_init(void);
189 void MC_dpor(void);
190 void MC_dpor_exit(void);
191
192 /***** DPOR for safety (stateful) **** */
193
194 typedef struct s_mc_state_with_snapshot{
195   mc_snapshot_t system_state;
196   mc_state_t graph_state;
197 }s_mc_state_ws_t, *mc_state_ws_t;
198
199 extern xbt_fifo_t mc_stack_safety_stateful;
200
201 void MC_init_stateful(void);
202 void MC_modelcheck_stateful(void);
203 mc_state_ws_t new_state_ws(mc_snapshot_t s, mc_state_t gs);
204 void MC_dpor_stateful_init(void);
205 void MC_dpor_stateful(void);
206 void MC_exit_stateful(void);
207
208
209 /********************************** Double-DFS for liveness property**************************************/
210
211 extern mc_snapshot_t initial_snapshot_liveness;
212 extern xbt_automaton_t automaton;
213
214 typedef struct s_mc_pair{
215   mc_snapshot_t system_state;
216   mc_state_t graph_state;
217   xbt_state_t automaton_state;
218 }s_mc_pair_t, *mc_pair_t;
219
220 typedef struct s_mc_pair_reached{
221   xbt_state_t automaton_state;
222   xbt_dynar_t prop_ato;
223   mc_snapshot_t system_state;
224 }s_mc_pair_reached_t, *mc_pair_reached_t;
225
226 typedef struct s_mc_pair_visited{
227   xbt_state_t automaton_state;
228   xbt_dynar_t prop_ato;
229   mc_snapshot_t system_state;
230   int search_cycle;
231 }s_mc_pair_visited_t, *mc_pair_visited_t;
232
233 typedef struct s_mc_pair_visited_hash{
234   xbt_state_t automaton_state;
235   xbt_dynar_t prop_ato;
236   unsigned int *hash_regions;
237   int search_cycle;
238 }s_mc_pair_visited_hash_t, *mc_pair_visited_hash_t;
239
240 typedef struct s_mc_pair_reached_hash{
241   xbt_state_t automaton_state;
242   xbt_dynar_t prop_ato;
243   unsigned int *hash_regions;
244 }s_mc_pair_reached_hash_t, *mc_pair_reached_hash_t;
245
246 int MC_automaton_evaluate_label(xbt_exp_label_t l);
247 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
248
249 int reached(xbt_state_t st);
250 void set_pair_reached(xbt_state_t st);
251 int reached_hash(xbt_state_t st);
252 void set_pair_reached_hash(xbt_state_t st);
253 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
254 void MC_pair_delete(mc_pair_t pair);
255 void MC_exit_liveness(void);
256 mc_state_t MC_state_pair_new(void);
257 int visited(xbt_state_t st, int search_cycle);
258 void set_pair_visited(xbt_state_t st, int search_cycle);
259 int visited_hash(xbt_state_t st, int search_cycle);
260 void set_pair_visited_hash(xbt_state_t st, int search_cycle);
261 unsigned int hash_region(char *str, int str_len);
262
263
264 /* **** Double-DFS stateless **** */
265
266 typedef struct s_mc_pair_stateless{
267   mc_state_t graph_state;
268   xbt_state_t automaton_state;
269   int requests;
270 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
271
272 extern xbt_fifo_t mc_stack_liveness;
273
274 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
275 void MC_ddfs_init();
276 void MC_ddfs(int search_cycle);
277 void MC_show_stack_liveness(xbt_fifo_t stack);
278 void MC_dump_stack_liveness(xbt_fifo_t stack);
279 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
280
281
282 #endif