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 "simgrid_config.h"
  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/smx_private.h"
  19 #include "xbt/automaton.h"
  20 #include "xbt/hash.h"
  21 #include "msg/msg.h"
  22 #include "msg/datatypes.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 extern char *prog_name;
  39
  40 void MC_take_snapshot(mc_snapshot_t);
  41 void MC_take_snapshot_liveness(mc_snapshot_t s);
  42 void MC_restore_snapshot(mc_snapshot_t);
  43 void MC_free_snapshot(mc_snapshot_t);
  44
  45
  46 /********************************* MC Global **********************************/
  47 extern double *mc_time;
  48
  49 /* Bound of the MC depth-first search algorithm */
  50 #define MAX_DEPTH 1000
  51 #define MAX_DEPTH_LIVENESS 500
  52
  53 int MC_deadlock_check(void);
  54 void MC_replay(xbt_fifo_t stack, int start);
  55 void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
  56 void MC_wait_for_requests(void);
  57 void MC_get_enabled_processes();
  58 void MC_show_deadlock(smx_simcall_t req);
  59 void MC_show_stack_safety(xbt_fifo_t stack);
  60 void MC_dump_stack_safety(xbt_fifo_t stack);
  61
  62 /********************************* Requests ***********************************/
  63 int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
  64 char* MC_request_to_string(smx_simcall_t req, int value);
  65 unsigned int MC_request_testany_fail(smx_simcall_t req);
  66 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
  67 int MC_request_is_visible(smx_simcall_t req);
  68 int MC_request_is_enabled(smx_simcall_t req);
  69 int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
  70 int MC_process_is_enabled(smx_process_t process);
  71
  72
  73 /******************************** States **************************************/
  74 /* Possible exploration status of a process in a state */
  75 typedef enum {
  76   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
  77   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
  78   MC_DONE                   /* Already interleaved */
  79 } e_mc_process_state_t;
  80
  81 /* On every state, each process has an entry of the following type */
  82 typedef struct mc_procstate{
  83   e_mc_process_state_t state;       /* Exploration control information */
  84   unsigned int interleave_count;    /* Number of times that the process was
  85                                        interleaved */
  86 } s_mc_procstate_t, *mc_procstate_t;
  87
  88 /* An exploration state is composed of: */
  89 typedef struct mc_state {
  90   unsigned long max_pid;            /* Maximum pid at state's creation time */
  91   mc_procstate_t proc_status;       /* State's exploration status by process */
  92   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
  93   s_smx_simcall_t internal_req;         /* Internal translation of request */
  94   s_smx_simcall_t executed_req;         /* The executed request of the state */
  95   int req_num;                      /* The request number (in the case of a
  96                                        multi-request like waitany ) */
  97   mc_snapshot_t system_state;      /* Snapshot of system state */
  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
 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 extern int raw_mem_set;
 158
 159 /******************************* MEMORY MAPPINGS ***************************/
 160 /* These functions and data structures implements a binary interface for   */
 161 /* the proc maps ascii interface                                           */
 162
 163 /* Each field is defined as documented in proc's manual page  */
 164 typedef struct s_map_region {
 165
 166   void *start_addr;             /* Start address of the map */
 167   void *end_addr;               /* End address of the map */
 168   int prot;                     /* Memory protection */
 169   int flags;                    /* Aditional memory flags */
 170   void *offset;                 /* Offset in the file/whatever */
 171   char dev_major;               /* Major of the device */
 172   char dev_minor;               /* Minor of the device */
 173   unsigned long inode;          /* Inode in the device */
 174   char *pathname;               /* Path name of the mapped file */
 175
 176 } s_map_region_t;
 177
 178 typedef struct s_memory_map {
 179
 180   s_map_region_t *regions;      /* Pointer to an array of regions */
 181   int mapsize;                  /* Number of regions in the memory */
 182
 183 } s_memory_map_t, *memory_map_t;
 184
 185 memory_map_t get_memory_map(void);
 186 void free_memory_map(memory_map_t map);
 187 void get_plt_section(void);
 188
 189
 190 /********************************** DPOR for safety  **************************************/
 191 typedef enum {
 192   e_mc_reduce_unset,
 193   e_mc_reduce_none,
 194   e_mc_reduce_dpor
 195 } e_mc_reduce_t;
 196 extern e_mc_reduce_t mc_reduce_kind;
 197
 198 void MC_dpor_init(void);
 199 void MC_dpor(void);
 200 void MC_dpor_exit(void);
 201 void MC_init_safety(void);
 202
 203
 204 /********************************** Double-DFS for liveness property**************************************/
 205
 206 extern mc_snapshot_t initial_snapshot_liveness;
 207 extern xbt_automaton_t _mc_property_automaton;
 208 extern int compare;
 209
 210 typedef struct s_mc_pair{
 211   mc_snapshot_t system_state;
 212   mc_state_t graph_state;
 213   xbt_state_t automaton_state;
 214 }s_mc_pair_t, *mc_pair_t;
 215
 216 typedef struct s_mc_pair_reached{
 217   int nb;
 218   xbt_state_t automaton_state;
 219   xbt_dynar_t prop_ato;
 220   mc_snapshot_t system_state;
 221 }s_mc_pair_reached_t, *mc_pair_reached_t;
 222
 223 int MC_automaton_evaluate_label(xbt_exp_label_t l);
 224 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 225
 226 int reached(xbt_state_t st);
 227 void set_pair_reached(xbt_state_t st);
 228 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
 229 void MC_pair_delete(mc_pair_t pair);
 230 void MC_exit_liveness(void);
 231 mc_state_t MC_state_pair_new(void);
 232
 233 /* **** Double-DFS stateless **** */
 234
 235 typedef struct s_mc_pair_stateless{
 236   mc_state_t graph_state;
 237   xbt_state_t automaton_state;
 238   int requests;
 239 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
 240
 241 extern xbt_fifo_t mc_stack_liveness;
 242
 243 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
 244 void MC_ddfs_init(void);
 245 void MC_ddfs(int search_cycle);
 246 void MC_show_stack_liveness(xbt_fifo_t stack);
 247 void MC_dump_stack_liveness(xbt_fifo_t stack);
 248 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
 249
 250 /********************************** Configuration of MC **************************************/
 251 extern xbt_fifo_t mc_stack_safety;
 252
 253 extern int _surf_mc_checkpoint;
 254 extern char* _surf_mc_property_file;
 255
 256 /****** Core dump ******/
 257
 258 int create_dump(int pair);
 259
 260
 261 #endif