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, int start);
  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_stack_safety(xbt_fifo_t stack);
  58 void MC_dump_stack_safety(xbt_fifo_t stack);
  59
  60 /********************************* Requests ***********************************/
  61 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
  62 char* MC_request_to_string(smx_simcall_t req, int value);
  63 unsigned int MC_request_testany_fail(smx_simcall_t req);
  64 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
  65 int MC_request_is_visible(smx_simcall_t req);
  66 int MC_request_is_enabled(smx_simcall_t req);
  67 int MC_request_is_enabled_by_idx(smx_simcall_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_simcall_t internal_req;         /* Internal translation of request */
  92   s_smx_simcall_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   mc_snapshot_t system_state;      /* Snapshot of system state */
  96 } s_mc_state_t, *mc_state_t;
  97
  98 extern xbt_fifo_t mc_stack_safety_stateless;
  99
 100 mc_state_t MC_state_new(void);
 101 void MC_state_delete(mc_state_t state);
 102 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 103 unsigned int MC_state_interleave_size(mc_state_t state);
 104 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 105 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
 106 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
 107 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
 108 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
 109
 110 /****************************** Statistics ************************************/
 111 typedef struct mc_stats {
 112   unsigned long state_size;
 113   unsigned long visited_states;
 114   unsigned long expanded_states;
 115   unsigned long executed_transitions;
 116 } s_mc_stats_t, *mc_stats_t;
 117
 118 typedef struct mc_stats_pair {
 119   //unsigned long pair_size;
 120   unsigned long visited_pairs;
 121   unsigned long expanded_pairs;
 122   unsigned long executed_transitions;
 123 } s_mc_stats_pair_t, *mc_stats_pair_t;
 124
 125 extern mc_stats_t mc_stats;
 126 extern mc_stats_pair_t mc_stats_pair;
 127
 128 void MC_print_statistics(mc_stats_t);
 129 void MC_print_statistics_pairs(mc_stats_pair_t);
 130
 131 /********************************** MEMORY ******************************/
 132 /* The possible memory modes for the modelchecker are standard and raw. */
 133 /* Normally the system should operate in std, for switching to raw mode */
 134 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 135
 136 extern void *std_heap;
 137 extern void *raw_heap;
 138
 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_t;
 173
 174 typedef struct s_memory_map {
 175
 176   s_map_region_t *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  **************************************/
 185 typedef enum {
 186   e_mc_reduce_unset,
 187   e_mc_reduce_none,
 188   e_mc_reduce_dpor
 189 } e_mc_reduce_t;
 190 extern e_mc_reduce_t mc_reduce_kind;
 191
 192 void MC_dpor_init(void);
 193 void MC_dpor(void);
 194 void MC_dpor_exit(void);
 195 void MC_init_safety(void);
 196
 197
 198 /********************************** Double-DFS for liveness property**************************************/
 199
 200 extern mc_snapshot_t initial_snapshot_liveness;
 201 extern xbt_automaton_t _mc_property_automaton;
 202
 203 typedef struct s_mc_pair{
 204   mc_snapshot_t system_state;
 205   mc_state_t graph_state;
 206   xbt_state_t automaton_state;
 207 }s_mc_pair_t, *mc_pair_t;
 208
 209 typedef struct s_mc_pair_reached{
 210   int nb;
 211   xbt_state_t automaton_state;
 212   xbt_dynar_t prop_ato;
 213   mc_snapshot_t system_state;
 214   //xbt_dict_t rdv_points;
 215 }s_mc_pair_reached_t, *mc_pair_reached_t;
 216
 217 typedef struct s_mc_pair_visited{
 218   xbt_state_t automaton_state;
 219   xbt_dynar_t prop_ato;
 220   mc_snapshot_t system_state;
 221   int search_cycle;
 222 }s_mc_pair_visited_t, *mc_pair_visited_t;
 223
 224 typedef struct s_mc_pair_visited_hash{
 225   xbt_state_t automaton_state;
 226   xbt_dynar_t prop_ato;
 227   unsigned int *hash_regions;
 228   int search_cycle;
 229 }s_mc_pair_visited_hash_t, *mc_pair_visited_hash_t;
 230
 231 typedef struct s_mc_pair_reached_hash{
 232   xbt_state_t automaton_state;
 233   xbt_dynar_t prop_ato;
 234   unsigned int *hash_regions;
 235 }s_mc_pair_reached_hash_t, *mc_pair_reached_hash_t;
 236
 237
 238
 239 int MC_automaton_evaluate_label(xbt_exp_label_t l);
 240 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 241
 242 int reached(xbt_state_t st);
 243 void set_pair_reached(xbt_state_t st);
 244 int reached_hash(xbt_state_t st);
 245 void set_pair_reached_hash(xbt_state_t st);
 246 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
 247 int data_program_region_compare(void *d1, void *d2, size_t size);
 248 int data_libsimgrid_region_compare(void *d1, void *d2, size_t size);
 249 void MC_pair_delete(mc_pair_t pair);
 250 void MC_exit_liveness(void);
 251 mc_state_t MC_state_pair_new(void);
 252 int visited(xbt_state_t st, int search_cycle);
 253 void set_pair_visited(xbt_state_t st, int search_cycle);
 254 int visited_hash(xbt_state_t st, int search_cycle);
 255 void set_pair_visited_hash(xbt_state_t st, int search_cycle);
 256 unsigned int hash_region(char *str, int str_len);
 257 int rdv_points_compare(xbt_dict_t d1, xbt_dict_t d2);
 258
 259 /* **** Double-DFS stateless **** */
 260
 261 typedef struct s_mc_pair_stateless{
 262   mc_state_t graph_state;
 263   xbt_state_t automaton_state;
 264   int requests;
 265 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
 266
 267 extern xbt_fifo_t mc_stack_liveness;
 268
 269 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
 270 void MC_ddfs_init(void);
 271 void MC_ddfs(int search_cycle);
 272 void MC_show_stack_liveness(xbt_fifo_t stack);
 273 void MC_dump_stack_liveness(xbt_fifo_t stack);
 274 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
 275
 276 /********************************** Configuration of MC **************************************/
 277 extern xbt_fifo_t mc_stack_safety;
 278
 279 extern int _surf_mc_checkpoint;
 280 extern char* _surf_mc_property_file;
 281
 282
 283 #endif