src/mc/private.h

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