Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix lua platform script
[simgrid.git] / src / mc / mc_private.h
1 /* Copyright (c) 2007-2012 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 #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/smx_private.h"
19 #include "xbt/automaton.h"
20 #include "xbt/hash.h"
21 #include "msg/msg.h"
22 #include "msg/datatypes.h"
23 #include "xbt/strbuff.h"
24
25 /****************************** Snapshots ***********************************/
26
27 typedef struct s_mc_mem_region{
28   int type;
29   void *start_addr;
30   void *data;
31   size_t size;
32 } s_mc_mem_region_t, *mc_mem_region_t;
33
34 typedef struct s_mc_snapshot{
35   unsigned int num_reg;
36   mc_mem_region_t *regions;
37   xbt_dynar_t stacks;
38 } s_mc_snapshot_t, *mc_snapshot_t;
39
40 typedef struct s_mc_snapshot_stack{
41   xbt_strbuff_t local_variables;
42   void *stack_pointer;
43 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
44
45 typedef struct s_mc_global_t{
46   mc_snapshot_t snapshot;
47   int raw_mem_set;
48 }s_mc_global_t, *mc_global_t;
49
50 //void MC_take_snapshot(mc_snapshot_t);
51 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
52 mc_snapshot_t MC_take_snapshot(void);
53 void MC_restore_snapshot(mc_snapshot_t);
54 void MC_free_snapshot(mc_snapshot_t);
55 void snapshot_stack_free_voidp(void *s);
56
57 /********************************* MC Global **********************************/
58 extern double *mc_time;
59
60 int MC_deadlock_check(void);
61 void MC_replay(xbt_fifo_t stack, int start);
62 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
63 void MC_wait_for_requests(void);
64 void MC_get_enabled_processes();
65 void MC_show_deadlock(smx_simcall_t req);
66 void MC_show_stack_safety(xbt_fifo_t stack);
67 void MC_dump_stack_safety(xbt_fifo_t stack);
68
69 /********************************* Requests ***********************************/
70 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
71 char* MC_request_to_string(smx_simcall_t req, int value);
72 unsigned int MC_request_testany_fail(smx_simcall_t req);
73 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
74 int MC_request_is_visible(smx_simcall_t req);
75 int MC_request_is_enabled(smx_simcall_t req);
76 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
77 int MC_process_is_enabled(smx_process_t process);
78
79
80 /******************************** States **************************************/
81 /* Possible exploration status of a process in a state */
82 typedef enum {
83   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
84   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
85   MC_DONE                   /* Already interleaved */
86 } e_mc_process_state_t;
87
88 /* On every state, each process has an entry of the following type */
89 typedef struct mc_procstate{
90   e_mc_process_state_t state;       /* Exploration control information */
91   unsigned int interleave_count;    /* Number of times that the process was
92                                        interleaved */
93 } s_mc_procstate_t, *mc_procstate_t;
94
95 /* An exploration state is composed of: */
96 typedef struct mc_state {
97   unsigned long max_pid;            /* Maximum pid at state's creation time */
98   mc_procstate_t proc_status;       /* State's exploration status by process */
99   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
100   s_smx_simcall_t internal_req;         /* Internal translation of request */
101   s_smx_simcall_t executed_req;         /* The executed request of the state */
102   int req_num;                      /* The request number (in the case of a
103                                        multi-request like waitany ) */
104   mc_snapshot_t system_state;      /* Snapshot of system state */
105 } s_mc_state_t, *mc_state_t;
106
107 extern xbt_fifo_t mc_stack_safety_stateless;
108
109 mc_state_t MC_state_new(void);
110 void MC_state_delete(mc_state_t state);
111 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
112 unsigned int MC_state_interleave_size(mc_state_t state);
113 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
114 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
115 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
116 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
117 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
118 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
119
120 /****************************** Statistics ************************************/
121 typedef struct mc_stats {
122   unsigned long state_size;
123   unsigned long visited_states;
124   unsigned long expanded_states;
125   unsigned long executed_transitions;
126 } s_mc_stats_t, *mc_stats_t;
127
128 typedef struct mc_stats_pair {
129   //unsigned long pair_size;
130   unsigned long visited_pairs;
131   unsigned long expanded_pairs;
132   unsigned long executed_transitions;
133 } s_mc_stats_pair_t, *mc_stats_pair_t;
134
135 extern mc_stats_t mc_stats;
136 extern mc_stats_pair_t mc_stats_pair;
137
138 void MC_print_statistics(mc_stats_t);
139 void MC_print_statistics_pairs(mc_stats_pair_t);
140
141 /********************************** MEMORY ******************************/
142 /* The possible memory modes for the modelchecker are standard and raw. */
143 /* Normally the system should operate in std, for switching to raw mode */
144 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
145
146 extern void *std_heap;
147 extern void *raw_heap;
148
149
150 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
151 /* an API to query about the status of a heap, we simply call mmstats and */
152 /* because I now how does structure looks like, then I redefine it here */
153
154 /* struct mstats { */
155 /*   size_t bytes_total;           /\* Total size of the heap. *\/ */
156 /*   size_t chunks_used;           /\* Chunks allocated by the user. *\/ */
157 /*   size_t bytes_used;            /\* Byte total of user-allocated chunks. *\/ */
158 /*   size_t chunks_free;           /\* Chunks in the free list. *\/ */
159 /*   size_t bytes_free;            /\* Byte total of chunks in the free list. *\/ */
160 /* }; */
161
162 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
163 #define MC_UNSET_RAW_MEM  mmalloc_set_current_heap(std_heap)
164
165 /******************************* MEMORY MAPPINGS ***************************/
166 /* These functions and data structures implements a binary interface for   */
167 /* the proc maps ascii interface                                           */
168
169 /* Each field is defined as documented in proc's manual page  */
170 typedef struct s_map_region {
171
172   void *start_addr;             /* Start address of the map */
173   void *end_addr;               /* End address of the map */
174   int prot;                     /* Memory protection */
175   int flags;                    /* Aditional memory flags */
176   void *offset;                 /* Offset in the file/whatever */
177   char dev_major;               /* Major of the device */
178   char dev_minor;               /* Minor of the device */
179   unsigned long inode;          /* Inode in the device */
180   char *pathname;               /* Path name of the mapped file */
181
182 } s_map_region_t;
183
184 typedef struct s_memory_map {
185
186   s_map_region_t *regions;      /* Pointer to an array of regions */
187   int mapsize;                  /* Number of regions in the memory */
188
189 } s_memory_map_t, *memory_map_t;
190
191 memory_map_t get_memory_map(void);
192 void free_memory_map(memory_map_t map);
193 void get_libsimgrid_plt_section(void);
194 void get_binary_plt_section(void);
195
196 extern void *start_data_libsimgrid;
197 extern void *end_raw_heap;
198 extern void *start_data_binary;
199 extern void *start_bss_binary;
200 extern char *libsimgrid_path;
201 extern void *start_text_libsimgrid;
202 extern void *start_bss_libsimgrid;
203 extern void *start_plt_libsimgrid;
204 extern void *end_plt_libsimgrid;
205 extern void *start_plt_binary;
206 extern void *end_plt_binary;
207 extern void *start_got_plt_libsimgrid;
208 extern void *end_got_plt_libsimgrid;
209 extern void *start_got_plt_binary;
210 extern void *end_got_plt_binary;
211
212
213 /********************************** DPOR for safety  **************************************/
214 typedef enum {
215   e_mc_reduce_unset,
216   e_mc_reduce_none,
217   e_mc_reduce_dpor
218 } e_mc_reduce_t;
219
220 extern e_mc_reduce_t mc_reduce_kind;
221 extern mc_global_t initial_state_safety;
222
223 void MC_dpor_init(void);
224 void MC_dpor(void);
225 void MC_dpor_exit(void);
226 void MC_init(void);
227
228 typedef struct s_mc_safety_visited_state{
229   mc_snapshot_t system_state;
230   int num;
231 }s_mc_safety_visited_state_t, *mc_safety_visited_state_t;
232
233
234 /********************************** Double-DFS for liveness property**************************************/
235
236 extern xbt_fifo_t mc_stack_liveness;
237 extern mc_global_t initial_state_liveness;
238 extern xbt_automaton_t _mc_property_automaton;
239 extern int compare;
240 extern xbt_dynar_t mc_stack_comparison_ignore;
241 extern xbt_dynar_t mc_data_bss_comparison_ignore;
242
243
244 typedef struct s_mc_pair{
245   mc_snapshot_t system_state;
246   mc_state_t graph_state;
247   xbt_state_t automaton_state;
248 }s_mc_pair_t, *mc_pair_t;
249
250 typedef struct s_mc_comparison_times{
251   int nb_comparisons;
252   xbt_dynar_t snapshot_comparison_times;
253   xbt_dynar_t chunks_used_comparison_times;
254   xbt_dynar_t stacks_sizes_comparison_times;
255   xbt_dynar_t binary_global_variables_comparison_times;
256   xbt_dynar_t libsimgrid_global_variables_comparison_times;
257   xbt_dynar_t heap_comparison_times;
258   xbt_dynar_t stacks_comparison_times;
259 }s_mc_comparison_times_t, *mc_comparison_times_t;
260
261 typedef struct s_mc_pair_reached{
262   int nb;
263   xbt_state_t automaton_state;
264   xbt_dynar_t prop_ato;
265   mc_snapshot_t system_state;
266   mc_comparison_times_t comparison_times;
267 }s_mc_pair_reached_t, *mc_pair_reached_t;
268
269 typedef struct s_mc_pair_visited{
270   xbt_state_t automaton_state;
271   xbt_dynar_t prop_ato;
272   mc_snapshot_t system_state;
273 }s_mc_pair_visited_t, *mc_pair_visited_t;
274
275 int MC_automaton_evaluate_label(xbt_exp_label_t l);
276 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
277 mc_comparison_times_t new_comparison_times(void);
278
279 int reached(xbt_state_t st);
280 void set_pair_reached(xbt_state_t st);
281 int visited(xbt_state_t st);
282 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
283                                    mc_snapshot_t s1, mc_snapshot_t s2);
284 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2, mc_comparison_times_t ct1, mc_comparison_times_t ct2);
285 void MC_pair_delete(mc_pair_t pair);
286 void MC_exit_liveness(void);
287 mc_state_t MC_state_pair_new(void);
288 void pair_reached_free(mc_pair_reached_t pair);
289 void pair_reached_free_voidp(void *p);
290 void pair_visited_free(mc_pair_visited_t pair);
291 void pair_visited_free_voidp(void *p);
292 void MC_init_liveness(void);
293 void MC_init_memory_map_info(void);
294 void MC_print_comparison_times_statistics(mc_comparison_times_t ct);
295
296 int get_heap_region_index(mc_snapshot_t s);
297
298 /* **** Double-DFS stateless **** */
299
300 typedef struct s_mc_pair_stateless{
301   mc_state_t graph_state;
302   xbt_state_t automaton_state;
303   int requests;
304 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
305
306 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
307 void MC_ddfs_init(void);
308 void MC_ddfs(int search_cycle);
309 void MC_show_stack_liveness(xbt_fifo_t stack);
310 void MC_dump_stack_liveness(xbt_fifo_t stack);
311 void pair_stateless_free(mc_pair_stateless_t pair);
312 void pair_stateless_free_voidp(void *p);
313
314 /********************************** Configuration of MC **************************************/
315 extern xbt_fifo_t mc_stack_safety;
316
317 /****** Core dump ******/
318
319 int create_dump(int pair);
320
321 /****** Local variables with DWARF ******/
322
323 typedef enum {
324   e_dw_loclist,
325   e_dw_register,
326   e_dw_bregister_op,
327   e_dw_lit,
328   e_dw_fbregister_op,
329   e_dw_piece,
330   e_dw_arithmetic,
331   e_dw_plus_uconst,
332   e_dw_compose,
333   e_dw_deref,
334   e_dw_uconstant,
335   e_dw_sconstant,
336   e_dw_unsupported
337 } e_dw_location_type;
338
339 typedef struct s_dw_location{
340   e_dw_location_type type;
341   union{
342     
343     xbt_dynar_t loclist;
344     
345     int reg;
346     
347     struct{
348       unsigned int reg;
349       int offset;
350     }breg_op;
351
352     unsigned int lit;
353
354     int fbreg_op;
355
356     int piece;
357
358     unsigned short int deref_size;
359
360     xbt_dynar_t compose;
361
362     char *arithmetic;
363
364     struct{
365       int bytes;
366       long unsigned int value;
367     }uconstant;
368
369     struct{
370       int bytes;
371       long signed int value;
372     }sconstant;
373
374     unsigned int plus_uconst;
375
376   }location;
377 }s_dw_location_t, *dw_location_t;
378
379 typedef struct s_dw_location_entry{
380   long lowpc;
381   long highpc;
382   dw_location_t location;
383 }s_dw_location_entry_t, *dw_location_entry_t;
384
385 typedef struct s_dw_local_variable{
386   char *name;
387   dw_location_t location;
388 }s_dw_local_variable_t, *dw_local_variable_t;
389
390 typedef struct s_dw_frame{
391   char *name;
392   void *low_pc;
393   void *high_pc;
394   dw_location_t frame_base;
395   xbt_dict_t variables;
396   unsigned long int start;
397   unsigned long int end;
398 }s_dw_frame_t, *dw_frame_t;
399
400 /* FIXME : implement free functions for each structure */
401
402 extern xbt_dict_t mc_local_variables;
403
404 typedef struct s_variable_value{
405   char *type;
406   
407   union{
408     void *address;
409     long int res;
410   }value;
411 }s_variable_value_t, *variable_value_t;
412
413 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
414 void print_local_variables(xbt_dict_t list);
415 char *get_libsimgrid_path(void);
416 xbt_dict_t MC_get_location_list(const char *elf_file);
417
418 /**** Global variables ****/
419
420 typedef struct s_global_variable{
421   char *name;
422   size_t size;
423   void *address;
424 }s_global_variable_t, *global_variable_t;
425
426 void global_variable_free(global_variable_t v);
427 void global_variable_free_voidp(void *v);
428
429 extern xbt_dynar_t mc_global_variables;
430
431 #endif