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"
24 /****************************** Snapshots ***********************************/
26 typedef struct s_mc_mem_region{
31 } s_mc_mem_region_t, *mc_mem_region_t;
33 typedef struct s_mc_snapshot{
35 mc_mem_region_t *regions;
36 } s_mc_snapshot_t, *mc_snapshot_t;
38 void MC_take_snapshot(mc_snapshot_t);
39 void MC_take_snapshot_liveness(mc_snapshot_t s);
40 void MC_restore_snapshot(mc_snapshot_t);
41 void MC_free_snapshot(mc_snapshot_t);
44 /********************************* MC Global **********************************/
45 extern double *mc_time;
47 /* Bound of the MC depth-first search algorithm */
48 #define MAX_DEPTH 1000
49 #define MAX_DEPTH_LIVENESS 500
51 int MC_deadlock_check(void);
52 void MC_replay(xbt_fifo_t stack, int start);
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_simcall_t req);
57 void MC_show_stack_safety(xbt_fifo_t stack);
58 void MC_dump_stack_safety(xbt_fifo_t stack);
60 /********************************* Requests ***********************************/
61 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
62 char* MC_request_to_string(smx_simcall_t req, int value);
63 unsigned int MC_request_testany_fail(smx_simcall_t req);
64 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
65 int MC_request_is_visible(smx_simcall_t req);
66 int MC_request_is_enabled(smx_simcall_t req);
67 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
68 int MC_process_is_enabled(smx_process_t process);
71 /******************************** States **************************************/
72 /* Possible exploration status of a process in a state */
74 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
75 MC_INTERLEAVE, /* Interleave the process (one or more request) */
76 MC_DONE /* Already interleaved */
77 } e_mc_process_state_t;
79 /* On every state, each process has an entry of the following type */
80 typedef struct mc_procstate{
81 e_mc_process_state_t state; /* Exploration control information */
82 unsigned int interleave_count; /* Number of times that the process was
84 } s_mc_procstate_t, *mc_procstate_t;
86 /* An exploration state is composed of: */
87 typedef struct mc_state {
88 unsigned long max_pid; /* Maximum pid at state's creation time */
89 mc_procstate_t proc_status; /* State's exploration status by process */
90 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
91 s_smx_simcall_t internal_req; /* Internal translation of request */
92 s_smx_simcall_t executed_req; /* The executed request of the state */
93 int req_num; /* The request number (in the case of a
94 multi-request like waitany ) */
95 mc_snapshot_t system_state; /* Snapshot of system state */
96 } s_mc_state_t, *mc_state_t;
98 extern xbt_fifo_t mc_stack_safety_stateless;
100 mc_state_t MC_state_new(void);
101 void MC_state_delete(mc_state_t state);
102 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
103 unsigned int MC_state_interleave_size(mc_state_t state);
104 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
105 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
106 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
107 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
108 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
110 /****************************** Statistics ************************************/
111 typedef struct mc_stats {
112 unsigned long state_size;
113 unsigned long visited_states;
114 unsigned long expanded_states;
115 unsigned long executed_transitions;
116 } s_mc_stats_t, *mc_stats_t;
118 typedef struct mc_stats_pair {
119 //unsigned long pair_size;
120 unsigned long visited_pairs;
121 unsigned long expanded_pairs;
122 unsigned long executed_transitions;
123 } s_mc_stats_pair_t, *mc_stats_pair_t;
125 extern mc_stats_t mc_stats;
126 extern mc_stats_pair_t mc_stats_pair;
128 void MC_print_statistics(mc_stats_t);
129 void MC_print_statistics_pairs(mc_stats_pair_t);
131 /********************************** MEMORY ******************************/
132 /* The possible memory modes for the modelchecker are standard and raw. */
133 /* Normally the system should operate in std, for switching to raw mode */
134 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
136 extern void *std_heap;
137 extern void *raw_heap;
140 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
141 /* an API to query about the status of a heap, we simply call mmstats and */
142 /* because I now how does structure looks like, then I redefine it here */
144 /* struct mstats { */
145 /* size_t bytes_total; /\* Total size of the heap. *\/ */
146 /* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
147 /* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
148 /* size_t chunks_free; /\* Chunks in the free list. *\/ */
149 /* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
152 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
153 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
155 extern int raw_mem_set;
157 /******************************* MEMORY MAPPINGS ***************************/
158 /* These functions and data structures implements a binary interface for */
159 /* the proc maps ascii interface */
161 /* Each field is defined as documented in proc's manual page */
162 typedef struct s_map_region {
164 void *start_addr; /* Start address of the map */
165 void *end_addr; /* End address of the map */
166 int prot; /* Memory protection */
167 int flags; /* Aditional memory flags */
168 void *offset; /* Offset in the file/whatever */
169 char dev_major; /* Major of the device */
170 char dev_minor; /* Minor of the device */
171 unsigned long inode; /* Inode in the device */
172 char *pathname; /* Path name of the mapped file */
176 typedef struct s_memory_map {
178 s_map_region_t *regions; /* Pointer to an array of regions */
179 int mapsize; /* Number of regions in the memory */
181 } s_memory_map_t, *memory_map_t;
183 memory_map_t get_memory_map(void);
184 void free_memory_map(memory_map_t map);
185 void get_plt_section(void);
188 /********************************** DPOR for safety **************************************/
195 extern e_mc_reduce_t mc_reduce_kind;
197 void MC_dpor_init(void);
199 void MC_dpor_exit(void);
200 void MC_init_safety(void);
203 /********************************** Double-DFS for liveness property**************************************/
205 extern xbt_fifo_t mc_stack_liveness;
206 extern mc_snapshot_t initial_snapshot_liveness;
207 extern xbt_automaton_t _mc_property_automaton;
210 typedef struct s_mc_pair{
211 mc_snapshot_t system_state;
212 mc_state_t graph_state;
213 xbt_state_t automaton_state;
214 }s_mc_pair_t, *mc_pair_t;
216 typedef struct s_mc_pair_reached{
218 xbt_state_t automaton_state;
219 xbt_dynar_t prop_ato;
220 mc_snapshot_t system_state;
221 }s_mc_pair_reached_t, *mc_pair_reached_t;
223 int MC_automaton_evaluate_label(xbt_exp_label_t l);
224 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
226 int reached(xbt_state_t st);
227 void set_pair_reached(xbt_state_t st);
228 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
229 void MC_pair_delete(mc_pair_t pair);
230 void MC_exit_liveness(void);
231 mc_state_t MC_state_pair_new(void);
233 /* **** Double-DFS stateless **** */
235 typedef struct s_mc_pair_stateless{
236 mc_state_t graph_state;
237 xbt_state_t automaton_state;
239 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
241 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
242 void MC_ddfs_init(void);
243 void MC_ddfs(int search_cycle);
244 void MC_show_stack_liveness(xbt_fifo_t stack);
245 void MC_dump_stack_liveness(xbt_fifo_t stack);
246 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
248 /********************************** Configuration of MC **************************************/
249 extern xbt_fifo_t mc_stack_safety;
251 extern int _surf_mc_checkpoint;
252 extern char* _surf_mc_property_file;
254 /****** Core dump ******/
256 int create_dump(int pair);
258 /****** Local variables with DWARF ******/
272 } e_dw_location_type;
274 typedef struct s_dw_location{
275 e_dw_location_type type;
306 }s_dw_location_t, *dw_location_t;
308 typedef struct s_dw_location_entry{
311 dw_location_t location;
312 }s_dw_location_entry_t, *dw_location_entry_t;
314 typedef struct s_dw_local_variable{
316 dw_location_t location;
317 }s_dw_local_variable_t, *dw_local_variable_t;
319 typedef struct s_dw_frame{
321 dw_location_t location;
322 xbt_dynar_t variables;
323 }s_dw_frame_t, *dw_frame_t;
325 /* FIXME : implement free functions for each strcuture */
327 extern xbt_dynar_t mc_binary_local_variables;
329 void MC_get_binary_local_variables(void);
330 void print_local_variables(xbt_dynar_t list);