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
  70 /******************************** States **************************************/
  71 /* Possible exploration status of a process in a state */
  72 typedef enum {
  73   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
  74   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
  75   MC_DONE                   /* Already interleaved */
  76 } e_mc_process_state_t;
  77
  78 /* On every state, each process has an entry of the following type */
  79 typedef struct mc_procstate{
  80   e_mc_process_state_t state;       /* Exploration control information */
  81   unsigned int interleave_count;    /* Number of times that the process was
  82                                        interleaved */
  83 } s_mc_procstate_t, *mc_procstate_t;
  84
  85 /* An exploration state is composed of: */
  86 typedef struct mc_state {
  87   unsigned long max_pid;            /* Maximum pid at state's creation time */
  88   mc_procstate_t proc_status;       /* State's exploration status by process */
  89   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
  90   s_smx_req_t internal_req;         /* Internal translation of request */
  91   s_smx_req_t executed_req;         /* The executed request of the state */
  92   int req_num;                      /* The request number (in the case of a
  93                                        multi-request like waitany ) */
  94 } s_mc_state_t, *mc_state_t;
  95
  96 extern xbt_fifo_t mc_stack_safety_stateless;
  97
  98 mc_state_t MC_state_new(void);
  99 void MC_state_delete(mc_state_t state);
 100 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 101 unsigned int MC_state_interleave_size(mc_state_t state);
 102 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 103 void MC_state_set_executed_request(mc_state_t state, smx_req_t req, int value);
 104 smx_req_t MC_state_get_executed_request(mc_state_t state, int *value);
 105 smx_req_t MC_state_get_internal_request(mc_state_t state);
 106 smx_req_t MC_state_get_request(mc_state_t state, int *value);
 107
 108 /****************************** Statistics ************************************/
 109 typedef struct mc_stats {
 110   unsigned long state_size;
 111   unsigned long visited_states;
 112   unsigned long expanded_states;
 113   unsigned long executed_transitions;
 114 } s_mc_stats_t, *mc_stats_t;
 115
 116 typedef struct mc_stats_pair {
 117   //unsigned long pair_size;
 118   unsigned long visited_pairs;
 119   unsigned long expanded_pairs;
 120   unsigned long executed_transitions;
 121 } s_mc_stats_pair_t, *mc_stats_pair_t;
 122
 123 extern mc_stats_t mc_stats;
 124 extern mc_stats_pair_t mc_stats_pair;
 125
 126 void MC_print_statistics(mc_stats_t);
 127 void MC_print_statistics_pairs(mc_stats_pair_t);
 128
 129 /********************************** MEMORY ******************************/
 130 /* The possible memory modes for the modelchecker are standard and raw. */
 131 /* Normally the system should operate in std, for switching to raw mode */
 132 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 133
 134 extern void *std_heap;
 135 extern void *raw_heap;
 136 /* extern int raw_heap_fd; */ /* unused */
 137 #define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
 138
 139 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 140 /* an API to query about the status of a heap, we simply call mmstats and */
 141 /* because I now how does structure looks like, then I redefine it here */
 142
 143 struct mstats {
 144   size_t bytes_total;           /* Total size of the heap. */
 145   size_t chunks_used;           /* Chunks allocated by the user. */
 146   size_t bytes_used;            /* Byte total of user-allocated chunks. */
 147   size_t chunks_free;           /* Chunks in the free list. */
 148   size_t bytes_free;            /* Byte total of chunks in the free list. */
 149 };
 150
 151 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 152 #define MC_UNSET_RAW_MEM    mmalloc_set_current_heap(std_heap)
 153
 154 /******************************* MEMORY MAPPINGS ***************************/
 155 /* These functions and data structures implements a binary interface for   */
 156 /* the proc maps ascii interface                                           */
 157
 158 /* Each field is defined as documented in proc's manual page  */
 159 typedef struct s_map_region {
 160
 161   void *start_addr;             /* Start address of the map */
 162   void *end_addr;               /* End address of the map */
 163   int prot;                     /* Memory protection */
 164   int flags;                    /* Aditional memory flags */
 165   void *offset;                 /* Offset in the file/whatever */
 166   char dev_major;               /* Major of the device */
 167   char dev_minor;               /* Minor of the device */
 168   unsigned long inode;          /* Inode in the device */
 169   char *pathname;               /* Path name of the mapped file */
 170
 171 } s_map_region;
 172
 173 typedef struct s_memory_map {
 174
 175   s_map_region *regions;        /* Pointer to an array of regions */
 176   int mapsize;                  /* Number of regions in the memory */
 177
 178 } s_memory_map_t, *memory_map_t;
 179
 180 memory_map_t get_memory_map(void);
 181
 182
 183 /********************************** Double-DFS for liveness property**************************************/
 184
 185 typedef struct s_mc_pair{
 186   mc_snapshot_t system_state;
 187   mc_state_t graph_state;
 188   xbt_state_t automaton_state;
 189 }s_mc_pair_t, *mc_pair_t;
 190
 191 typedef struct s_mc_pair_reached{
 192   xbt_state_t automaton_state;
 193   xbt_dynar_t prop_ato;
 194   mc_snapshot_t system_state;
 195 }s_mc_pair_reached_t, *mc_pair_reached_t;
 196
 197 extern xbt_fifo_t mc_stack_liveness_stateful;
 198
 199 int MC_automaton_evaluate_label(xbt_automaton_t a, xbt_exp_label_t l);
 200 mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 201
 202 int reached(xbt_automaton_t a);
 203 int set_pair_reached(xbt_automaton_t a);
 204 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
 205 void MC_show_stack_liveness_stateful(xbt_fifo_t stack);
 206 void MC_dump_stack_liveness_stateful(xbt_fifo_t stack);
 207 void MC_pair_delete(mc_pair_t pair);
 208 void MC_exit_liveness(void);
 209 mc_state_t MC_state_pair_new(void);
 210
 211 /* **** Double-DFS stateful without visited state **** */
 212
 213 void MC_ddfs_stateful_init(xbt_automaton_t a);
 214 void MC_ddfs_stateful(xbt_automaton_t a, int search_cycle, int restore);
 215
 216 /* **** Double-DFS stateless **** */
 217
 218 typedef struct s_mc_pair_stateless{
 219   mc_state_t graph_state;
 220   xbt_state_t automaton_state;
 221 }s_mc_pair_stateless_t, *mc_pair_stateless_t;
 222
 223 extern xbt_fifo_t mc_stack_liveness_stateless;
 224
 225 mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st);
 226 void MC_ddfs_stateless_init(xbt_automaton_t a);
 227 void MC_ddfs_stateless(xbt_automaton_t a, int search_cycle, int replay);
 228 void MC_show_stack_liveness_stateless(xbt_fifo_t stack);
 229 void MC_dump_stack_liveness_stateless(xbt_fifo_t stack);
 230 void MC_pair_stateless_delete(mc_pair_stateless_t pair);
 231
 232 /********************************** DPOR for safety (stateless) **************************************/
 233 void MC_dpor_init(void);
 234 void MC_dpor(void);
 235 void MC_dpor_exit(void);
 236
 237 /***** DPOR for safety (stateful) **** */
 238
 239 typedef struct s_mc_state_with_snapshot{
 240   mc_snapshot_t system_state;
 241   mc_state_t graph_state;
 242 }s_mc_state_ws_t, *mc_state_ws_t;
 243
 244 extern xbt_fifo_t mc_stack_safety_stateful;
 245
 246 void MC_init_stateful(void);
 247 void MC_modelcheck_stateful(void);
 248 mc_state_ws_t new_state_ws(mc_snapshot_t s, mc_state_t gs);
 249 void MC_dpor_stateful_init(void);
 250 void MC_dpor_stateful(void);
 251 void MC_exit_stateful(void);
 252
 253 #endif