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