1 /* $Id: private.h 5497 2008-05-26 12:19:15Z cristianrosa $ */
3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
4 All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
15 #include "mc/datatypes.h"
17 #include "xbt/config.h"
18 #include "xbt/function_types.h"
19 #include "xbt/mmalloc.h"
20 #include "../simix/private.h"
21 #include "xbt/automaton.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, char *prgm);
40 void MC_restore_snapshot(mc_snapshot_t);
41 void MC_free_snapshot(mc_snapshot_t);
43 /********************************* MC Global **********************************/
44 extern double *mc_time;
46 /* Bound of the MC depth-first search algorithm */
47 #define MAX_DEPTH 1000
48 #define MAX_DEPTH_LIVENESS 50
50 int MC_deadlock_check(void);
51 void MC_replay(xbt_fifo_t stack);
52 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
53 void MC_wait_for_requests(void);
54 void MC_get_enabled_processes();
55 void MC_show_deadlock(smx_req_t req);
56 void MC_show_deadlock_stateful(smx_req_t req);
57 void MC_show_stack_safety_stateless(xbt_fifo_t stack);
58 void MC_dump_stack_safety_stateless(xbt_fifo_t stack);
59 void MC_show_stack_safety_stateful(xbt_fifo_t stack);
60 void MC_dump_stack_safety_stateful(xbt_fifo_t stack);
62 /********************************* Requests ***********************************/
63 int MC_request_depend(smx_req_t req1, smx_req_t req2);
64 char* MC_request_to_string(smx_req_t req, int value);
65 unsigned int MC_request_testany_fail(smx_req_t req);
66 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
67 int MC_request_is_visible(smx_req_t req);
68 int MC_request_is_enabled(smx_req_t req);
69 int MC_request_is_enabled_by_idx(smx_req_t req, unsigned int idx);
70 int MC_process_is_enabled(smx_process_t process);
73 /******************************** States **************************************/
74 /* Possible exploration status of a process in a state */
76 MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
77 MC_INTERLEAVE, /* Interleave the process (one or more request) */
78 MC_DONE /* Already interleaved */
79 } e_mc_process_state_t;
81 /* On every state, each process has an entry of the following type */
82 typedef struct mc_procstate{
83 e_mc_process_state_t state; /* Exploration control information */
84 unsigned int interleave_count; /* Number of times that the process was
86 } s_mc_procstate_t, *mc_procstate_t;
88 /* An exploration state is composed of: */
89 typedef struct mc_state {
90 unsigned long max_pid; /* Maximum pid at state's creation time */
91 mc_procstate_t proc_status; /* State's exploration status by process */
92 s_smx_action_t internal_comm; /* To be referenced by the internal_req */
93 s_smx_req_t internal_req; /* Internal translation of request */
94 s_smx_req_t executed_req; /* The executed request of the state */
95 int req_num; /* The request number (in the case of a
96 multi-request like waitany ) */
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_req_t req, int value);
107 smx_req_t MC_state_get_executed_request(mc_state_t state, int *value);
108 smx_req_t MC_state_get_internal_request(mc_state_t state);
109 smx_req_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;
139 /* extern int raw_heap_fd; */ /* unused */
140 #define STD_HEAP_SIZE 20480000 /* Maximum size of the system's heap */
142 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
143 /* an API to query about the status of a heap, we simply call mmstats and */
144 /* because I now how does structure looks like, then I redefine it here */
147 size_t bytes_total; /* Total size of the heap. */
148 size_t chunks_used; /* Chunks allocated by the user. */
149 size_t bytes_used; /* Byte total of user-allocated chunks. */
150 size_t chunks_free; /* Chunks in the free list. */
151 size_t bytes_free; /* Byte total of chunks in the free list. */
154 #define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
155 #define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
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 *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);
186 /********************************** DPOR for safety (stateless) **************************************/
187 void MC_dpor_init(void);
189 void MC_dpor_exit(void);
191 /***** DPOR for safety (stateful) **** */
193 typedef struct s_mc_state_with_snapshot{
194 mc_snapshot_t system_state;
195 mc_state_t graph_state;
196 }s_mc_state_ws_t, *mc_state_ws_t;
198 extern xbt_fifo_t mc_stack_safety_stateful;
200 void MC_init_stateful(void);
201 void MC_modelcheck_stateful(void);
202 mc_state_ws_t new_state_ws(mc_snapshot_t s, mc_state_t gs);
203 void MC_dpor_stateful_init(void);
204 void MC_dpor_stateful(void);
205 void MC_exit_stateful(void);
208 /********************************** Double-DFS for liveness property**************************************/
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{
217 xbt_state_t automaton_state;
218 xbt_dynar_t prop_ato;
219 mc_snapshot_t system_state;
220 }s_mc_pair_reached_t, *mc_pair_reached_t;
222 typedef struct s_mc_pair_visited{
223 xbt_state_t automaton_state;
224 xbt_dynar_t prop_ato;
225 mc_snapshot_t system_state;
227 }s_mc_pair_visited_t, *mc_pair_visited_t;
229 int MC_automaton_evaluate_label(xbt_automaton_t a, xbt_exp_label_t l);
230 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
232 int reached(xbt_automaton_t a, xbt_state_t st, char *prgm);
233 void set_pair_reached(xbt_automaton_t a, xbt_state_t st, char *prgm);
234 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
235 void MC_show_stack_liveness_stateful(xbt_fifo_t stack);
236 void MC_dump_stack_liveness_stateful(xbt_fifo_t stack);
237 void MC_pair_delete(mc_pair_t pair);
238 void MC_exit_liveness(void);
239 mc_state_t MC_state_pair_new(void);
240 int visited(xbt_automaton_t a, xbt_state_t st, int search_cycle, char *prgm);
241 void set_pair_visited(xbt_automaton_t a, xbt_state_t st, int search_cycle, char *prgm);
243 /* **** Double-DFS stateful without visited state **** */
245 extern xbt_fifo_t mc_stack_liveness_stateful;
247 void MC_ddfs_stateful_init(xbt_automaton_t a);
248 void MC_ddfs_stateful(xbt_automaton_t a, int search_cycle, int restore);
250 /* **** Double-DFS stateless **** */
252 typedef struct s_mc_pair_stateless{
253 mc_state_t graph_state;
254 xbt_state_t automaton_state;
256 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
258 extern xbt_fifo_t mc_stack_liveness_stateless;
259 extern mc_snapshot_t initial_snapshot_liveness;
261 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
262 void MC_ddfs_stateless_init(xbt_automaton_t a, char *prgm);
263 void MC_ddfs_stateless(xbt_automaton_t a, int search_cycle, int replay, char *prgm);
264 void MC_show_stack_liveness_stateless(xbt_fifo_t stack);
265 void MC_dump_stack_liveness_stateless(xbt_fifo_t stack);
266 void MC_pair_stateless_delete(mc_pair_stateless_t pair);