Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : more condition (state with processes interleaved > 0) for detection...
[simgrid.git] / src / mc / private.h
1 /*      $Id: private.h 5497 2008-05-26 12:19:15Z cristianrosa $  */
2
3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
4    All rights reserved.                                          */
5
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. */
8
9 #ifndef MC_PRIVATE_H
10 #define MC_PRIVATE_H
11
12 #include <stdio.h>
13 #include <sys/mman.h>
14 #include "mc/mc.h"
15 #include "mc/datatypes.h"
16 #include "xbt/fifo.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"
22 #include "xbt/hash.h"
23
24 /****************************** Snapshots ***********************************/
25
26 typedef struct s_mc_mem_region{
27   int type;
28   void *start_addr;
29   void *data;
30   size_t size;
31 } s_mc_mem_region_t, *mc_mem_region_t;
32
33 typedef struct s_mc_snapshot{
34   unsigned int num_reg;
35   mc_mem_region_t *regions;
36 } s_mc_snapshot_t, *mc_snapshot_t;
37
38 void MC_take_snapshot(mc_snapshot_t);
39 void MC_restore_snapshot(mc_snapshot_t);
40 void MC_free_snapshot(mc_snapshot_t);
41
42 /********************************* MC Global **********************************/
43 extern double *mc_time;
44
45 /* Bound of the MC depth-first search algorithm */
46 #define MAX_DEPTH 1000
47
48 int MC_deadlock_check(void);
49 void MC_replay(xbt_fifo_t stack);
50 void MC_replay_liveness(xbt_fifo_t stack);
51 void MC_wait_for_requests(void);
52 void MC_get_enabled_processes();
53 void MC_show_deadlock(smx_req_t req);
54 void MC_show_deadlock_stateful(smx_req_t req);
55 void MC_show_stack_safety_stateless(xbt_fifo_t stack);
56 void MC_dump_stack_safety_stateless(xbt_fifo_t stack);
57 void MC_show_stack_safety_stateful(xbt_fifo_t stack);
58 void MC_dump_stack_safety_stateful(xbt_fifo_t stack);
59
60 /********************************* Requests ***********************************/
61 int MC_request_depend(smx_req_t req1, smx_req_t req2);
62 char* MC_request_to_string(smx_req_t req, int value);
63 unsigned int MC_request_testany_fail(smx_req_t req);
64 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
65 int MC_request_is_visible(smx_req_t req);
66 int MC_request_is_enabled(smx_req_t req);
67 int MC_request_is_enabled_by_idx(smx_req_t req, unsigned int idx);
68 int MC_process_is_enabled(smx_process_t process);
69
70
71 /******************************** States **************************************/
72 /* Possible exploration status of a process in a state */
73 typedef enum {
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;
78
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
83                                        interleaved */
84 } s_mc_procstate_t, *mc_procstate_t;
85
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_req_t internal_req;         /* Internal translation of request */
92   s_smx_req_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 } s_mc_state_t, *mc_state_t;
96
97 extern xbt_fifo_t mc_stack_safety_stateless;
98
99 mc_state_t MC_state_new(void);
100 void MC_state_delete(mc_state_t state);
101 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
102 unsigned int MC_state_interleave_size(mc_state_t state);
103 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
104 void MC_state_set_executed_request(mc_state_t state, smx_req_t req, int value);
105 smx_req_t MC_state_get_executed_request(mc_state_t state, int *value);
106 smx_req_t MC_state_get_internal_request(mc_state_t state);
107 smx_req_t MC_state_get_request(mc_state_t state, int *value);
108
109 /****************************** Statistics ************************************/
110 typedef struct mc_stats {
111   unsigned long state_size;
112   unsigned long visited_states;
113   unsigned long expanded_states;
114   unsigned long executed_transitions;
115 } s_mc_stats_t, *mc_stats_t;
116
117 typedef struct mc_stats_pair {
118   //unsigned long pair_size;
119   unsigned long visited_pairs;
120   unsigned long expanded_pairs;
121   unsigned long executed_transitions;
122 } s_mc_stats_pair_t, *mc_stats_pair_t;
123
124 extern mc_stats_t mc_stats;
125 extern mc_stats_pair_t mc_stats_pair;
126
127 void MC_print_statistics(mc_stats_t);
128 void MC_print_statistics_pairs(mc_stats_pair_t);
129
130 /********************************** MEMORY ******************************/
131 /* The possible memory modes for the modelchecker are standard and raw. */
132 /* Normally the system should operate in std, for switching to raw mode */
133 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
134
135 extern void *std_heap;
136 extern void *raw_heap;
137 /* extern int raw_heap_fd; */ /* unused */
138 #define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
139
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 */
143
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. */
150 };
151
152 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
153 #define MC_UNSET_RAW_MEM    mmalloc_set_current_heap(std_heap)
154
155 /******************************* MEMORY MAPPINGS ***************************/
156 /* These functions and data structures implements a binary interface for   */
157 /* the proc maps ascii interface                                           */
158
159 /* Each field is defined as documented in proc's manual page  */
160 typedef struct s_map_region {
161
162   void *start_addr;             /* Start address of the map */
163   void *end_addr;               /* End address of the map */
164   int prot;                     /* Memory protection */
165   int flags;                    /* Aditional memory flags */
166   void *offset;                 /* Offset in the file/whatever */
167   char dev_major;               /* Major of the device */
168   char dev_minor;               /* Minor of the device */
169   unsigned long inode;          /* Inode in the device */
170   char *pathname;               /* Path name of the mapped file */
171
172 } s_map_region;
173
174 typedef struct s_memory_map {
175
176   s_map_region *regions;        /* Pointer to an array of regions */
177   int mapsize;                  /* Number of regions in the memory */
178
179 } s_memory_map_t, *memory_map_t;
180
181 memory_map_t get_memory_map(void);
182
183
184 /********************************** DPOR for safety (stateless) **************************************/
185 void MC_dpor_init(void);
186 void MC_dpor(void);
187 void MC_dpor_exit(void);
188
189 /***** DPOR for safety (stateful) **** */
190
191 typedef struct s_mc_state_with_snapshot{
192   mc_snapshot_t system_state;
193   mc_state_t graph_state;
194 }s_mc_state_ws_t, *mc_state_ws_t;
195
196 extern xbt_fifo_t mc_stack_safety_stateful;
197
198 void MC_init_stateful(void);
199 void MC_modelcheck_stateful(void);
200 mc_state_ws_t new_state_ws(mc_snapshot_t s, mc_state_t gs);
201 void MC_dpor_stateful_init(void);
202 void MC_dpor_stateful(void);
203 void MC_exit_stateful(void);
204
205
206 /********************************** Double-DFS for liveness property**************************************/
207
208 typedef struct s_mc_pair{
209   mc_snapshot_t system_state;
210   mc_state_t graph_state;
211   xbt_state_t automaton_state;
212 }s_mc_pair_t, *mc_pair_t;
213
214 typedef struct s_mc_pair_reached{
215   xbt_state_t automaton_state;
216   xbt_dynar_t prop_ato;
217   mc_snapshot_t system_state;
218 }s_mc_pair_reached_t, *mc_pair_reached_t;
219
220 extern xbt_fifo_t mc_stack_liveness_stateful;
221
222 int MC_automaton_evaluate_label(xbt_automaton_t a, xbt_exp_label_t l);
223 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
224
225 int reached(xbt_automaton_t a, xbt_state_t st, mc_snapshot_t s);
226 void set_pair_reached(xbt_automaton_t a, xbt_state_t st, mc_snapshot_t s);
227 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
228 void MC_show_stack_liveness_stateful(xbt_fifo_t stack);
229 void MC_dump_stack_liveness_stateful(xbt_fifo_t stack);
230 void MC_pair_delete(mc_pair_t pair);
231 void MC_exit_liveness(void);
232 mc_state_t MC_state_pair_new(void);
233
234 /* **** Double-DFS stateful without visited state **** */
235
236 void MC_ddfs_stateful_init(xbt_automaton_t a);
237 void MC_ddfs_stateful(xbt_automaton_t a, int search_cycle, int restore);
238
239 /* **** Double-DFS stateless **** */
240
241 typedef struct s_mc_pair_stateless{
242   mc_state_t graph_state;
243   xbt_state_t automaton_state;
244 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
245
246 extern xbt_fifo_t mc_stack_liveness_stateless;
247
248 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st);
249 void MC_ddfs_stateless_init(xbt_automaton_t a);
250 void MC_ddfs_stateless(xbt_automaton_t a, int search_cycle, int replay);
251 void MC_show_stack_liveness_stateless(xbt_fifo_t stack);
252 void MC_dump_stack_liveness_stateless(xbt_fifo_t stack);
253 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
254
255
256
257 #endif