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. */
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"
23 /****************************** Snapshots ***********************************/
25 typedef struct s_mc_mem_region{
30 } s_mc_mem_region_t, *mc_mem_region_t;
32 typedef struct s_mc_snapshot{
34 mc_mem_region_t *regions;
35 } s_mc_snapshot_t, *mc_snapshot_t;
37 extern char *prog_name;
39 void MC_take_snapshot(mc_snapshot_t);
40 void MC_take_snapshot_liveness(mc_snapshot_t s);
41 void MC_restore_snapshot(mc_snapshot_t);
42 void MC_free_snapshot(mc_snapshot_t);
45 /********************************* MC Global **********************************/
46 extern double *mc_time;
48 /* Bound of the MC depth-first search algorithm */
49 #define MAX_DEPTH 1000
50 #define MAX_DEPTH_LIVENESS 500
52 int MC_deadlock_check(void);
53 void MC_replay(xbt_fifo_t stack, int start);
54 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
55 void MC_wait_for_requests(void);
56 void MC_get_enabled_processes();
57 void MC_show_deadlock(smx_simcall_t req);
58 void MC_show_stack_safety(xbt_fifo_t stack);
59 void MC_dump_stack_safety(xbt_fifo_t stack);
61 /********************************* Requests ***********************************/
62 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
63 char* MC_request_to_string(smx_simcall_t req, int value);
64 unsigned int MC_request_testany_fail(smx_simcall_t req);
65 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
66 int MC_request_is_visible(smx_simcall_t req);
67 int MC_request_is_enabled(smx_simcall_t req);
68 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
69 int MC_process_is_enabled(smx_process_t process);
72 /******************************** States **************************************/
73 /* Possible exploration status of a process in a state */
75 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
76 MC_INTERLEAVE, /* Interleave the process (one or more request) */
77 MC_DONE /* Already interleaved */
78 } e_mc_process_state_t;
80 /* On every state, each process has an entry of the following type */
81 typedef struct mc_procstate{
82 e_mc_process_state_t state; /* Exploration control information */
83 unsigned int interleave_count; /* Number of times that the process was
85 } s_mc_procstate_t, *mc_procstate_t;
87 /* An exploration state is composed of: */
88 typedef struct mc_state {
89 unsigned long max_pid; /* Maximum pid at state's creation time */
90 mc_procstate_t proc_status; /* State's exploration status by process */
91 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
92 s_smx_simcall_t internal_req; /* Internal translation of request */
93 s_smx_simcall_t executed_req; /* The executed request of the state */
94 int req_num; /* The request number (in the case of a
95 multi-request like waitany ) */
96 mc_snapshot_t system_state; /* Snapshot of system state */
97 } s_mc_state_t, *mc_state_t;
99 extern xbt_fifo_t mc_stack_safety_stateless;
101 mc_state_t MC_state_new(void);
102 void MC_state_delete(mc_state_t state);
103 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
104 unsigned int MC_state_interleave_size(mc_state_t state);
105 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
106 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
107 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
108 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
109 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
111 /****************************** Statistics ************************************/
112 typedef struct mc_stats {
113 unsigned long state_size;
114 unsigned long visited_states;
115 unsigned long expanded_states;
116 unsigned long executed_transitions;
117 } s_mc_stats_t, *mc_stats_t;
119 typedef struct mc_stats_pair {
120 //unsigned long pair_size;
121 unsigned long visited_pairs;
122 unsigned long expanded_pairs;
123 unsigned long executed_transitions;
124 } s_mc_stats_pair_t, *mc_stats_pair_t;
126 extern mc_stats_t mc_stats;
127 extern mc_stats_pair_t mc_stats_pair;
129 void MC_print_statistics(mc_stats_t);
130 void MC_print_statistics_pairs(mc_stats_pair_t);
132 /********************************** MEMORY ******************************/
133 /* The possible memory modes for the modelchecker are standard and raw. */
134 /* Normally the system should operate in std, for switching to raw mode */
135 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
137 extern void *std_heap;
138 extern void *raw_heap;
141 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
142 /* an API to query about the status of a heap, we simply call mmstats and */
143 /* because I now how does structure looks like, then I redefine it here */
146 size_t bytes_total; /* Total size of the heap. */
147 size_t chunks_used; /* Chunks allocated by the user. */
148 size_t bytes_used; /* Byte total of user-allocated chunks. */
149 size_t chunks_free; /* Chunks in the free list. */
150 size_t bytes_free; /* Byte total of chunks in the free list. */
153 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
154 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
156 extern int raw_mem_set;
158 /******************************* MEMORY MAPPINGS ***************************/
159 /* These functions and data structures implements a binary interface for */
160 /* the proc maps ascii interface */
162 /* Each field is defined as documented in proc's manual page */
163 typedef struct s_map_region {
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 */
177 typedef struct s_memory_map {
179 s_map_region_t *regions; /* Pointer to an array of regions */
180 int mapsize; /* Number of regions in the memory */
182 } s_memory_map_t, *memory_map_t;
184 memory_map_t get_memory_map(void);
187 /********************************** DPOR for safety **************************************/
193 extern e_mc_reduce_t mc_reduce_kind;
195 void MC_dpor_init(void);
197 void MC_dpor_exit(void);
198 void MC_init_safety(void);
201 /********************************** Double-DFS for liveness property**************************************/
203 extern mc_snapshot_t initial_snapshot_liveness;
204 extern xbt_automaton_t _mc_property_automaton;
206 typedef struct s_mc_pair{
207 mc_snapshot_t system_state;
208 mc_state_t graph_state;
209 xbt_state_t automaton_state;
210 }s_mc_pair_t, *mc_pair_t;
212 typedef struct s_mc_pair_reached{
214 xbt_state_t automaton_state;
215 xbt_dynar_t prop_ato;
216 mc_snapshot_t system_state;
217 //xbt_dict_t rdv_points;
218 }s_mc_pair_reached_t, *mc_pair_reached_t;
220 typedef struct s_mc_pair_visited{
221 xbt_state_t automaton_state;
222 xbt_dynar_t prop_ato;
223 mc_snapshot_t system_state;
225 }s_mc_pair_visited_t, *mc_pair_visited_t;
227 typedef struct s_mc_pair_visited_hash{
228 xbt_state_t automaton_state;
229 xbt_dynar_t prop_ato;
230 unsigned int *hash_regions;
232 }s_mc_pair_visited_hash_t, *mc_pair_visited_hash_t;
234 typedef struct s_mc_pair_reached_hash{
235 xbt_state_t automaton_state;
236 xbt_dynar_t prop_ato;
237 unsigned int *hash_regions;
238 }s_mc_pair_reached_hash_t, *mc_pair_reached_hash_t;
242 int MC_automaton_evaluate_label(xbt_exp_label_t l);
243 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
245 int reached(xbt_state_t st);
246 void set_pair_reached(xbt_state_t st);
247 int reached_hash(xbt_state_t st);
248 void set_pair_reached_hash(xbt_state_t st);
249 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
250 void MC_pair_delete(mc_pair_t pair);
251 void MC_exit_liveness(void);
252 mc_state_t MC_state_pair_new(void);
253 int visited(xbt_state_t st, int search_cycle);
254 void set_pair_visited(xbt_state_t st, int search_cycle);
255 int visited_hash(xbt_state_t st, int search_cycle);
256 void set_pair_visited_hash(xbt_state_t st, int search_cycle);
257 unsigned int hash_region(char *str, int str_len);
258 int rdv_points_compare(xbt_dict_t d1, xbt_dict_t d2);
260 /* **** Double-DFS stateless **** */
262 typedef struct s_mc_pair_stateless{
263 mc_state_t graph_state;
264 xbt_state_t automaton_state;
266 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
268 extern xbt_fifo_t mc_stack_liveness;
270 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
271 void MC_ddfs_init(void);
272 void MC_ddfs(int search_cycle);
273 void MC_show_stack_liveness(xbt_fifo_t stack);
274 void MC_dump_stack_liveness(xbt_fifo_t stack);
275 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
277 /********************************** Configuration of MC **************************************/
278 extern xbt_fifo_t mc_stack_safety;
280 extern int _surf_mc_checkpoint;
281 extern char* _surf_mc_property_file;
283 /****** Core dump ******/
285 int create_dump(int pair);