1 /* Copyright (c) 2007-2012 Da SimGrid Team. All rights reserved. */
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. */
9 #include "simgrid_config.h"
13 #include "mc/datatypes.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"
22 #include "msg/datatypes.h"
23 #include "xbt/strbuff.h"
25 /****************************** Snapshots ***********************************/
27 typedef struct s_mc_mem_region{
32 } s_mc_mem_region_t, *mc_mem_region_t;
34 typedef struct s_mc_snapshot{
36 mc_mem_region_t *regions;
38 } s_mc_snapshot_t, *mc_snapshot_t;
40 typedef struct s_mc_snapshot_stack{
41 xbt_strbuff_t local_variables;
43 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
45 void MC_take_snapshot(mc_snapshot_t);
46 void MC_take_snapshot_liveness(mc_snapshot_t s);
47 void MC_restore_snapshot(mc_snapshot_t);
48 void MC_free_snapshot(mc_snapshot_t);
51 /********************************* MC Global **********************************/
52 extern double *mc_time;
54 /* Bound of the MC depth-first search algorithm */
55 #define MAX_DEPTH 1000
56 #define MAX_DEPTH_LIVENESS 500
58 int MC_deadlock_check(void);
59 void MC_replay(xbt_fifo_t stack, int start);
60 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
61 void MC_wait_for_requests(void);
62 void MC_get_enabled_processes();
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);
67 /********************************* Requests ***********************************/
68 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
69 char* MC_request_to_string(smx_simcall_t req, int value);
70 unsigned int MC_request_testany_fail(smx_simcall_t req);
71 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
72 int MC_request_is_visible(smx_simcall_t req);
73 int MC_request_is_enabled(smx_simcall_t req);
74 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
75 int MC_process_is_enabled(smx_process_t process);
78 /******************************** States **************************************/
79 /* Possible exploration status of a process in a state */
81 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
82 MC_INTERLEAVE, /* Interleave the process (one or more request) */
83 MC_DONE /* Already interleaved */
84 } e_mc_process_state_t;
86 /* On every state, each process has an entry of the following type */
87 typedef struct mc_procstate{
88 e_mc_process_state_t state; /* Exploration control information */
89 unsigned int interleave_count; /* Number of times that the process was
91 } s_mc_procstate_t, *mc_procstate_t;
93 /* An exploration state is composed of: */
94 typedef struct mc_state {
95 unsigned long max_pid; /* Maximum pid at state's creation time */
96 mc_procstate_t proc_status; /* State's exploration status by process */
97 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
98 s_smx_simcall_t internal_req; /* Internal translation of request */
99 s_smx_simcall_t executed_req; /* The executed request of the state */
100 int req_num; /* The request number (in the case of a
101 multi-request like waitany ) */
102 mc_snapshot_t system_state; /* Snapshot of system state */
103 } s_mc_state_t, *mc_state_t;
105 extern xbt_fifo_t mc_stack_safety_stateless;
107 mc_state_t MC_state_new(void);
108 void MC_state_delete(mc_state_t state);
109 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
110 unsigned int MC_state_interleave_size(mc_state_t state);
111 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
112 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
113 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
114 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
115 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
117 /****************************** Statistics ************************************/
118 typedef struct mc_stats {
119 unsigned long state_size;
120 unsigned long visited_states;
121 unsigned long expanded_states;
122 unsigned long executed_transitions;
123 } s_mc_stats_t, *mc_stats_t;
125 typedef struct mc_stats_pair {
126 //unsigned long pair_size;
127 unsigned long visited_pairs;
128 unsigned long expanded_pairs;
129 unsigned long executed_transitions;
130 } s_mc_stats_pair_t, *mc_stats_pair_t;
132 extern mc_stats_t mc_stats;
133 extern mc_stats_pair_t mc_stats_pair;
135 void MC_print_statistics(mc_stats_t);
136 void MC_print_statistics_pairs(mc_stats_pair_t);
138 /********************************** MEMORY ******************************/
139 /* The possible memory modes for the modelchecker are standard and raw. */
140 /* Normally the system should operate in std, for switching to raw mode */
141 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
143 extern void *std_heap;
144 extern void *raw_heap;
147 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
148 /* an API to query about the status of a heap, we simply call mmstats and */
149 /* because I now how does structure looks like, then I redefine it here */
151 /* struct mstats { */
152 /* size_t bytes_total; /\* Total size of the heap. *\/ */
153 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
154 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
155 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
156 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
159 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
160 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
162 extern int raw_mem_set;
164 /******************************* MEMORY MAPPINGS ***************************/
165 /* These functions and data structures implements a binary interface for */
166 /* the proc maps ascii interface */
168 /* Each field is defined as documented in proc's manual page */
169 typedef struct s_map_region {
171 void *start_addr; /* Start address of the map */
172 void *end_addr; /* End address of the map */
173 int prot; /* Memory protection */
174 int flags; /* Aditional memory flags */
175 void *offset; /* Offset in the file/whatever */
176 char dev_major; /* Major of the device */
177 char dev_minor; /* Minor of the device */
178 unsigned long inode; /* Inode in the device */
179 char *pathname; /* Path name of the mapped file */
183 typedef struct s_memory_map {
185 s_map_region_t *regions; /* Pointer to an array of regions */
186 int mapsize; /* Number of regions in the memory */
188 } s_memory_map_t, *memory_map_t;
190 memory_map_t get_memory_map(void);
191 void free_memory_map(memory_map_t map);
192 void get_libsimgrid_plt_section(void);
193 void get_binary_plt_section(void);
195 extern void *start_data_libsimgrid;
197 /********************************** DPOR for safety **************************************/
204 extern e_mc_reduce_t mc_reduce_kind;
206 void MC_dpor_init(void);
208 void MC_dpor_exit(void);
209 void MC_init_safety(void);
212 /********************************** Double-DFS for liveness property**************************************/
214 extern xbt_fifo_t mc_stack_liveness;
215 extern mc_snapshot_t initial_snapshot_liveness;
216 extern xbt_automaton_t _mc_property_automaton;
218 extern void *start_plt_libsimgrid;
219 extern void *end_plt_libsimgrid;
220 extern void *start_plt_binary;
221 extern void *end_plt_binary;
223 typedef struct s_mc_pair{
224 mc_snapshot_t system_state;
225 mc_state_t graph_state;
226 xbt_state_t automaton_state;
227 }s_mc_pair_t, *mc_pair_t;
229 typedef struct s_mc_pair_reached{
231 xbt_state_t automaton_state;
232 xbt_dynar_t prop_ato;
233 mc_snapshot_t system_state;
234 }s_mc_pair_reached_t, *mc_pair_reached_t;
236 int MC_automaton_evaluate_label(xbt_exp_label_t l);
237 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
239 int reached(xbt_state_t st);
240 void set_pair_reached(xbt_state_t st);
241 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
242 void MC_pair_delete(mc_pair_t pair);
243 void MC_exit_liveness(void);
244 mc_state_t MC_state_pair_new(void);
246 /* **** Double-DFS stateless **** */
248 typedef struct s_mc_pair_stateless{
249 mc_state_t graph_state;
250 xbt_state_t automaton_state;
252 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
254 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
255 void MC_ddfs_init(void);
256 void MC_ddfs(int search_cycle);
257 void MC_show_stack_liveness(xbt_fifo_t stack);
258 void MC_dump_stack_liveness(xbt_fifo_t stack);
259 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
261 /********************************** Configuration of MC **************************************/
262 extern xbt_fifo_t mc_stack_safety;
264 extern int _surf_mc_checkpoint;
265 extern char* _surf_mc_property_file;
267 /****** Core dump ******/
269 int create_dump(int pair);
271 /****** Local variables with DWARF ******/
287 } e_dw_location_type;
289 typedef struct s_dw_location{
290 e_dw_location_type type;
308 unsigned short int deref_size;
316 long unsigned int value;
321 long signed int value;
324 unsigned int plus_uconst;
327 }s_dw_location_t, *dw_location_t;
329 typedef struct s_dw_location_entry{
332 dw_location_t location;
333 }s_dw_location_entry_t, *dw_location_entry_t;
335 typedef struct s_dw_local_variable{
337 dw_location_t location;
338 }s_dw_local_variable_t, *dw_local_variable_t;
340 typedef struct s_dw_frame{
344 dw_location_t frame_base;
345 xbt_dict_t variables;
346 unsigned long int start;
347 unsigned long int end;
348 }s_dw_frame_t, *dw_frame_t;
350 /* FIXME : implement free functions for each structure */
352 extern xbt_dict_t mc_local_variables;
354 typedef struct s_variable_value{
361 }s_variable_value_t, *variable_value_t;
363 void MC_get_local_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *variables);
364 void print_local_variables(xbt_dict_t list);
365 char *get_libsimgrid_path(void);
366 xbt_dict_t MC_get_location_list(const char *elf_file);