src/mc/mc_private.h

   1 /* Copyright (c) 2007-2012 Da SimGrid Team. All rights reserved.            */
   2
   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. */
   5
   6 #ifndef MC_PRIVATE_H
   7 #define MC_PRIVATE_H
   8
   9 #include <stdio.h>
  10 #include <sys/mman.h>
  11 #include "mc/mc.h"
  12 #include "mc/datatypes.h"
  13 #include "xbt/fifo.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"
  19 #include "xbt/hash.h"
  20 #include "msg/msg.h"
  21 #include "msg/datatypes.h"
  22
  23 /****************************** Snapshots ***********************************/
  24
  25 typedef struct s_mc_mem_region{
  26   int type;
  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 extern char *prog_name;
  38
  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);
  43
  44 /********************************* MC Global **********************************/
  45 extern double *mc_time;
  46
  47 /* Bound of the MC depth-first search algorithm */
  48 #define MAX_DEPTH 1000
  49 #define MAX_DEPTH_LIVENESS 500
  50
  51 int MC_deadlock_check(void);
  52 void MC_replay(xbt_fifo_t stack);
  53 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
  54 void MC_wait_for_requests(void);
  55 void MC_get_enabled_processes();
  56 void MC_show_deadlock(smx_simcall_t req);
  57 void MC_show_deadlock_stateful(smx_simcall_t req);
  58 void MC_show_stack_safety_stateless(xbt_fifo_t stack);
  59 void MC_dump_stack_safety_stateless(xbt_fifo_t stack);
  60 void MC_show_stack_safety_stateful(xbt_fifo_t stack);
  61 void MC_dump_stack_safety_stateful(xbt_fifo_t stack);
  62
  63 /********************************* Requests ***********************************/
  64 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
  65 char* MC_request_to_string(smx_simcall_t req, int value);
  66 unsigned int MC_request_testany_fail(smx_simcall_t req);
  67 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
  68 int MC_request_is_visible(smx_simcall_t req);
  69 int MC_request_is_enabled(smx_simcall_t req);
  70 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
  71 int MC_process_is_enabled(smx_process_t process);
  72
  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_simcall_t internal_req;         /* Internal translation of request */
  95   s_smx_simcall_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_simcall_t req, int value);
 108 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
 109 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
 110 smx_simcall_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 #define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
 141
 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 */
 145
 146 struct mstats {
 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. */
 152 };
 153
 154 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 155 #define MC_UNSET_RAW_MEM    mmalloc_set_current_heap(std_heap)
 156
 157 /******************************* MEMORY MAPPINGS ***************************/
 158 /* These functions and data structures implements a binary interface for   */
 159 /* the proc maps ascii interface                                           */
 160
 161 /* Each field is defined as documented in proc's manual page  */
 162 typedef struct s_map_region {
 163
 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 */
 173
 174 } s_map_region_t;
 175
 176 typedef struct s_memory_map {
 177
 178   s_map_region_t *regions;      /* Pointer to an array of regions */
 179   int mapsize;                  /* Number of regions in the memory */
 180
 181 } s_memory_map_t, *memory_map_t;
 182
 183 memory_map_t get_memory_map(void);
 184
 185
 186 /********************************** DPOR for safety (stateless) **************************************/
 187 void MC_dpor_init(void);
 188 void MC_dpor(void);
 189 void MC_dpor_exit(void);
 190
 191 /***** DPOR for safety (stateful) **** */
 192
 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;
 197
 198 extern xbt_fifo_t mc_stack_safety_stateful;
 199
 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);
 206
 207
 208 /********************************** Double-DFS for liveness property**************************************/
 209
 210 extern mc_snapshot_t initial_snapshot_liveness;
 211 extern xbt_automaton_t automaton;
 212
 213 typedef struct s_mc_pair{
 214   mc_snapshot_t system_state;
 215   mc_state_t graph_state;
 216   xbt_state_t automaton_state;
 217 }s_mc_pair_t, *mc_pair_t;
 218
 219 typedef struct s_mc_pair_reached{
 220   int nb;
 221   xbt_state_t automaton_state;
 222   xbt_dynar_t prop_ato;
 223   mc_snapshot_t system_state;
 224   //xbt_dict_t rdv_points;
 225 }s_mc_pair_reached_t, *mc_pair_reached_t;
 226
 227 typedef struct s_mc_pair_visited{
 228   xbt_state_t automaton_state;
 229   xbt_dynar_t prop_ato;
 230   mc_snapshot_t system_state;
 231   int search_cycle;
 232 }s_mc_pair_visited_t, *mc_pair_visited_t;
 233
 234 typedef struct s_mc_pair_visited_hash{
 235   xbt_state_t automaton_state;
 236   xbt_dynar_t prop_ato;
 237   unsigned int *hash_regions;
 238   int search_cycle;
 239 }s_mc_pair_visited_hash_t, *mc_pair_visited_hash_t;
 240
 241 typedef struct s_mc_pair_reached_hash{
 242   xbt_state_t automaton_state;
 243   xbt_dynar_t prop_ato;
 244   unsigned int *hash_regions;
 245 }s_mc_pair_reached_hash_t, *mc_pair_reached_hash_t;
 246
 247
 248
 249 int MC_automaton_evaluate_label(xbt_exp_label_t l);
 250 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 251
 252 int reached(xbt_state_t st);
 253 void set_pair_reached(xbt_state_t st);
 254 int reached_hash(xbt_state_t st);
 255 void set_pair_reached_hash(xbt_state_t st);
 256 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
 257 int data_program_region_compare(void *d1, void *d2, size_t size);
 258 int data_libsimgrid_region_compare(void *d1, void *d2, size_t size);
 259 void MC_pair_delete(mc_pair_t pair);
 260 void MC_exit_liveness(void);
 261 mc_state_t MC_state_pair_new(void);
 262 int visited(xbt_state_t st, int search_cycle);
 263 void set_pair_visited(xbt_state_t st, int search_cycle);
 264 int visited_hash(xbt_state_t st, int search_cycle);
 265 void set_pair_visited_hash(xbt_state_t st, int search_cycle);
 266 unsigned int hash_region(char *str, int str_len);
 267 int rdv_points_compare(xbt_dict_t d1, xbt_dict_t d2);
 268
 269 /* **** Double-DFS stateless **** */
 270
 271 typedef struct s_mc_pair_stateless{
 272   mc_state_t graph_state;
 273   xbt_state_t automaton_state;
 274   int requests;
 275 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
 276
 277 extern xbt_fifo_t mc_stack_liveness;
 278
 279 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
 280 void MC_ddfs_init(void);
 281 void MC_ddfs(int search_cycle);
 282 void MC_show_stack_liveness(xbt_fifo_t stack);
 283 void MC_dump_stack_liveness(xbt_fifo_t stack);
 284 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
 285
 286
 287 #endif