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   void *start_addr;
  28   void *data;
  29   size_t size;
  30 } s_mc_mem_region_t, *mc_mem_region_t;
  31
  32 typedef struct s_mc_snapshot{
  33   unsigned int num_reg;
  34   mc_mem_region_t *regions;
  35 } s_mc_snapshot_t, *mc_snapshot_t;
  36
  37 void MC_take_snapshot(mc_snapshot_t);
  38 void MC_restore_snapshot(mc_snapshot_t);
  39 void MC_free_snapshot(mc_snapshot_t);
  40
  41 /********************************* MC Global **********************************/
  42 extern double *mc_time;
  43
  44 /* Bound of the MC depth-first search algorithm */
  45 #define MAX_DEPTH 1000
  46
  47 int MC_deadlock_check(void);
  48 void MC_replay(xbt_fifo_t stack);
  49 void MC_replay_liveness(xbt_fifo_t stack);
  50 void MC_wait_for_requests(void);
  51 void MC_get_enabled_processes();
  52 void MC_show_deadlock(smx_req_t req);
  53 void MC_show_deadlock_stateful(smx_req_t req);
  54 void MC_show_stack_safety_stateless(xbt_fifo_t stack);
  55 void MC_dump_stack_safety_stateless(xbt_fifo_t stack);
  56 void MC_show_stack_safety_stateful(xbt_fifo_t stack);
  57 void MC_dump_stack_safety_stateful(xbt_fifo_t stack);
  58
  59 /********************************* Requests ***********************************/
  60 int MC_request_depend(smx_req_t req1, smx_req_t req2);
  61 char* MC_request_to_string(smx_req_t req, int value);
  62 unsigned int MC_request_testany_fail(smx_req_t req);
  63 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
  64 int MC_request_is_visible(smx_req_t req);
  65 int MC_request_is_enabled(smx_req_t req);
  66 int MC_request_is_enabled_by_idx(smx_req_t req, unsigned int idx);
  67 int MC_process_is_enabled(smx_process_t process);
  68
  69 /********************************** DPOR **************************************/
  70 void MC_dpor_init(void);
  71 void MC_dpor(void);
  72 void MC_dpor_exit(void);
  73
  74 /******************************** States **************************************/
  75 /* Possible exploration status of a process in a state */
  76 typedef enum {
  77   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
  78   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
  79   MC_DONE                   /* Already interleaved */
  80 } e_mc_process_state_t;
  81
  82 /* On every state, each process has an entry of the following type */
  83 typedef struct mc_procstate{
  84   e_mc_process_state_t state;       /* Exploration control information */
  85   unsigned int interleave_count;    /* Number of times that the process was
  86                                        interleaved */
  87 } s_mc_procstate_t, *mc_procstate_t;
  88
  89 /* An exploration state is composed of: */
  90 typedef struct mc_state {
  91   unsigned long max_pid;            /* Maximum pid at state's creation time */
  92   mc_procstate_t proc_status;       /* State's exploration status by process */
  93   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
  94   s_smx_req_t internal_req;         /* Internal translation of request */
  95   s_smx_req_t executed_req;         /* The executed request of the state */
  96   int req_num;                      /* The request number (in the case of a
  97                                        multi-request like waitany ) */
  98 } s_mc_state_t, *mc_state_t;
  99
 100 extern xbt_fifo_t mc_stack_safety_stateless;
 101
 102 mc_state_t MC_state_new(void);
 103 void MC_state_delete(mc_state_t state);
 104 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 105 unsigned int MC_state_interleave_size(mc_state_t state);
 106 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 107 void MC_state_set_executed_request(mc_state_t state, smx_req_t req, int value);
 108 smx_req_t MC_state_get_executed_request(mc_state_t state, int *value);
 109 smx_req_t MC_state_get_internal_request(mc_state_t state);
 110 smx_req_t MC_state_get_request(mc_state_t state, int *value);
 111
 112 /****************************** Statistics ************************************/
 113 typedef struct mc_stats {
 114   unsigned long state_size;
 115   unsigned long visited_states;
 116   unsigned long expanded_states;
 117   unsigned long executed_transitions;
 118 } s_mc_stats_t, *mc_stats_t;
 119
 120 typedef struct mc_stats_pair {
 121   //unsigned long pair_size;
 122   unsigned long visited_pairs;
 123   unsigned long expanded_pairs;
 124   unsigned long executed_transitions;
 125 } s_mc_stats_pair_t, *mc_stats_pair_t;
 126
 127 extern mc_stats_t mc_stats;
 128 extern mc_stats_pair_t mc_stats_pair;
 129
 130 void MC_print_statistics(mc_stats_t);
 131 void MC_print_statistics_pairs(mc_stats_pair_t);
 132
 133 /********************************** MEMORY ******************************/
 134 /* The possible memory modes for the modelchecker are standard and raw. */
 135 /* Normally the system should operate in std, for switching to raw mode */
 136 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 137
 138 extern void *std_heap;
 139 extern void *raw_heap;
 140 /* extern int raw_heap_fd; */ /* unused */
 141 #define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
 142
 143 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 144 /* an API to query about the status of a heap, we simply call mmstats and */
 145 /* because I now how does structure looks like, then I redefine it here */
 146
 147 struct mstats {
 148   size_t bytes_total;           /* Total size of the heap. */
 149   size_t chunks_used;           /* Chunks allocated by the user. */
 150   size_t bytes_used;            /* Byte total of user-allocated chunks. */
 151   size_t chunks_free;           /* Chunks in the free list. */
 152   size_t bytes_free;            /* Byte total of chunks in the free list. */
 153 };
 154
 155 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 156 #define MC_UNSET_RAW_MEM    mmalloc_set_current_heap(std_heap)
 157
 158 /******************************* MEMORY MAPPINGS ***************************/
 159 /* These functions and data structures implements a binary interface for   */
 160 /* the proc maps ascii interface                                           */
 161
 162 /* Each field is defined as documented in proc's manual page  */
 163 typedef struct s_map_region {
 164
 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 */
 174
 175 } s_map_region;
 176
 177 typedef struct s_memory_map {
 178
 179   s_map_region *regions;        /* Pointer to an array of regions */
 180   int mapsize;                  /* Number of regions in the memory */
 181
 182 } s_memory_map_t, *memory_map_t;
 183
 184 memory_map_t get_memory_map(void);
 185
 186
 187 /********************************** Double-DFS for liveness property**************************************/
 188
 189 typedef struct s_mc_pair{
 190   mc_snapshot_t system_state;
 191   mc_state_t graph_state;
 192   xbt_state_t automaton_state;
 193 }s_mc_pair_t, *mc_pair_t;
 194
 195 extern xbt_fifo_t mc_stack_liveness_stateful;
 196
 197 int MC_automaton_evaluate_label(xbt_automaton_t a, xbt_exp_label_t l);
 198 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 199
 200 int reached(mc_pair_t p);
 201 void set_pair_reached(mc_pair_t p);
 202 void MC_show_stack_liveness_stateful(xbt_fifo_t stack);
 203 void MC_dump_stack_liveness_stateful(xbt_fifo_t stack);
 204 void MC_pair_delete(mc_pair_t pair);
 205 void MC_exit_liveness(void);
 206 mc_state_t MC_state_pair_new(void);
 207
 208 /* **** Double-DFS stateful without visited state **** */
 209
 210 void MC_ddfs_stateful_init(xbt_automaton_t a);
 211 void MC_ddfs_stateful(xbt_automaton_t a, int search_cycle, int restore);
 212
 213 /* **** Double-DFS stateful with visited state **** */
 214
 215 typedef struct s_mc_visited_pair{
 216   mc_pair_t pair;
 217   int search_cycle;
 218 }s_mc_visited_pair_t, *mc_visited_pair_t;
 219
 220 void MC_vddfs_stateful_init(xbt_automaton_t a);
 221 void MC_vddfs_stateful(xbt_automaton_t automaton, int search_cycle, int restore);
 222 void set_pair_visited(mc_pair_t p, int search_cycle);
 223 int visited(mc_pair_t p, int search_cycle);
 224
 225 /* **** Double-DFS stateless **** */
 226
 227 typedef struct s_mc_pair_stateless{
 228   mc_state_t graph_state;
 229   xbt_state_t automaton_state;
 230 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
 231
 232 extern xbt_fifo_t mc_stack_liveness_stateless;
 233
 234 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st);
 235 void MC_ddfs_stateless_init(xbt_automaton_t a);
 236 void MC_ddfs_stateless(xbt_automaton_t a, int search_cycle, int replay);
 237 int reached_stateless(mc_pair_stateless_t p);
 238 void set_pair_stateless_reached(mc_pair_stateless_t p);
 239 void MC_show_stack_liveness_stateless(xbt_fifo_t stack);
 240 void MC_dump_stack_liveness_stateless(xbt_fifo_t stack);
 241 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
 242
 243 /* **** DPOR Cristian stateful **** */
 244
 245 typedef struct s_mc_state_with_snapshot{
 246   mc_snapshot_t system_state;
 247   mc_state_t graph_state;
 248 }s_mc_state_ws_t, *mc_state_ws_t;
 249
 250 extern xbt_fifo_t mc_stack_safety_stateful;
 251
 252 void MC_init_stateful(void);
 253 void MC_modelcheck_stateful(void);
 254 mc_state_ws_t new_state_ws(mc_snapshot_t s, mc_state_t gs);
 255 void MC_dpor_stateful_init(void);
 256 void MC_dpor_stateful(void);
 257 void MC_exit_stateful(void);
 258
 259 /* **** DPOR 2 (invisible and independant transitions) **** */
 260
 261 typedef struct s_mc_prop_ato{
 262   char *id;
 263   int value;
 264 }s_mc_prop_ato_t, *mc_prop_ato_t;
 265
 266 typedef struct s_mc_pair_prop{
 267   mc_snapshot_t system_state;
 268   mc_state_t graph_state;
 269   xbt_state_t automaton_state;
 270   int num;
 271   xbt_dynar_t propositions;
 272   int fully_expanded;
 273   int interleave;
 274 }s_mc_pair_prop_t, *mc_pair_prop_t;
 275
 276 mc_prop_ato_t new_proposition(char* id, int value);
 277 mc_pair_prop_t new_pair_prop(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 278 int reached_prop(mc_pair_prop_t pair);
 279 void set_pair_prop_reached(mc_pair_prop_t pair);
 280 void MC_dpor2_init(xbt_automaton_t a);
 281 void MC_dpor2(xbt_automaton_t a, int search_cycle);
 282 int invisible(mc_pair_prop_t p, mc_pair_prop_t np);
 283 void set_fully_expanded(mc_pair_prop_t pair);
 284
 285 /* **** DPOR 3 (invisible and independant transitions with coloration of pairs) **** */
 286
 287 typedef enum {
 288   GREEN=0,
 289   ORANGE,
 290   RED
 291 } e_mc_color_pair_t;
 292
 293 typedef struct s_mc_pair_prop_col{
 294   mc_snapshot_t system_state;
 295   mc_state_t graph_state;
 296   xbt_state_t automaton_state;
 297   int num;
 298   xbt_dynar_t propositions;
 299   int fully_expanded;
 300   int interleave;
 301   e_mc_color_pair_t color;
 302   int expanded;
 303 }s_mc_pair_prop_col_t, *mc_pair_prop_col_t;
 304
 305 typedef struct s_mc_visited_pair_prop_col{
 306   mc_pair_prop_col_t pair;
 307   int search_cycle;
 308 }s_mc_visited_pair_prop_col_t, *mc_visited_pair_prop_col_t;
 309
 310 void MC_dpor3_init(xbt_automaton_t a);
 311 void MC_dpor3(xbt_automaton_t a, int search_cycle);
 312 mc_pair_prop_col_t new_pair_prop_col(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 313 void set_expanded(mc_pair_prop_col_t pair);
 314 int reached_prop_col(mc_pair_prop_col_t pair);
 315 void set_pair_prop_col_reached(mc_pair_prop_col_t pair);
 316 int invisible_col(mc_pair_prop_col_t p, mc_pair_prop_col_t np);
 317 void set_fully_expanded_col(mc_pair_prop_col_t pair);
 318 void set_pair_prop_col_visited(mc_pair_prop_col_t pair, int sc);
 319 int visited_pair_prop_col(mc_pair_prop_col_t pair, int sc);
 320
 321 #endif