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
  23 /****************************** Snapshots ***********************************/
  24
  25 typedef struct s_mc_mem_region{
  26   void *start_addr;
  27   void *data;
  28   size_t size;
  29 } s_mc_mem_region_t, *mc_mem_region_t;
  30
  31 typedef struct s_mc_snapshot{
  32   unsigned int num_reg;
  33   mc_mem_region_t *regions;
  34 } s_mc_snapshot_t, *mc_snapshot_t;
  35
  36 void MC_take_snapshot(mc_snapshot_t);
  37 void MC_restore_snapshot(mc_snapshot_t);
  38 void MC_free_snapshot(mc_snapshot_t);
  39
  40 /********************************* MC Global **********************************/
  41 extern double *mc_time;
  42
  43 /* Bound of the MC depth-first search algorithm */
  44 #define MAX_DEPTH 1000
  45
  46 int MC_deadlock_check(void);
  47 void MC_replay(xbt_fifo_t stack);
  48 void MC_wait_for_requests(void);
  49 void MC_get_enabled_processes();
  50 void MC_show_deadlock(smx_req_t req);
  51 void MC_show_stack(xbt_fifo_t stack);
  52 void MC_dump_stack(xbt_fifo_t stack);
  53
  54 /********************************* Requests ***********************************/
  55 int MC_request_depend(smx_req_t req1, smx_req_t req2);
  56 char* MC_request_to_string(smx_req_t req, int value);
  57 unsigned int MC_request_testany_fail(smx_req_t req);
  58 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
  59 int MC_request_is_visible(smx_req_t req);
  60 int MC_request_is_enabled(smx_req_t req);
  61 int MC_request_is_enabled_by_idx(smx_req_t req, unsigned int idx);
  62 int MC_process_is_enabled(smx_process_t process);
  63
  64 /********************************** DPOR **************************************/
  65 void MC_dpor_init(void);
  66 void MC_dpor(void);
  67 void MC_dpor_exit(void);
  68
  69 /******************************** States **************************************/
  70 /* Possible exploration status of a process in a state */
  71 typedef enum {
  72   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
  73   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
  74   MC_DONE                   /* Already interleaved */
  75 } e_mc_process_state_t;
  76
  77 /* On every state, each process has an entry of the following type */
  78 typedef struct mc_procstate{
  79   e_mc_process_state_t state;       /* Exploration control information */
  80   unsigned int interleave_count;    /* Number of times that the process was
  81                                        interleaved */
  82 } s_mc_procstate_t, *mc_procstate_t;
  83
  84 /* An exploration state is composed of: */
  85 typedef struct mc_state {
  86   unsigned long max_pid;            /* Maximum pid at state's creation time */
  87   mc_procstate_t proc_status;       /* State's exploration status by process */
  88   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
  89   s_smx_req_t internal_req;         /* Internal translation of request */
  90   s_smx_req_t executed_req;         /* The executed request of the state */
  91   int req_num;                      /* The request number (in the case of a
  92                                        multi-request like waitany ) */
  93 } s_mc_state_t, *mc_state_t;
  94
  95 extern xbt_fifo_t mc_stack;
  96
  97 mc_state_t MC_state_new(void);
  98 void MC_state_delete(mc_state_t state);
  99 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
 100 unsigned int MC_state_interleave_size(mc_state_t state);
 101 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
 102 void MC_state_set_executed_request(mc_state_t state, smx_req_t req, int value);
 103 smx_req_t MC_state_get_executed_request(mc_state_t state, int *value);
 104 smx_req_t MC_state_get_internal_request(mc_state_t state);
 105 smx_req_t MC_state_get_request(mc_state_t state, int *value);
 106
 107 /****************************** Statistics ************************************/
 108 typedef struct mc_stats {
 109   unsigned long state_size;
 110   unsigned long visited_states;
 111   unsigned long expanded_states;
 112   unsigned long executed_transitions;
 113 } s_mc_stats_t, *mc_stats_t;
 114
 115 extern mc_stats_t mc_stats;
 116
 117 void MC_print_statistics(mc_stats_t);
 118
 119 /********************************** MEMORY ******************************/
 120 /* The possible memory modes for the modelchecker are standard and raw. */
 121 /* Normally the system should operate in std, for switching to raw mode */
 122 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 123
 124 extern void *std_heap;
 125 extern void *raw_heap;
 126 /* extern int raw_heap_fd; */ /* unused */
 127 #define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
 128
 129 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 130 /* an API to query about the status of a heap, we simply call mmstats and */
 131 /* because I now how does structure looks like, then I redefine it here */
 132
 133 struct mstats {
 134   size_t bytes_total;           /* Total size of the heap. */
 135   size_t chunks_used;           /* Chunks allocated by the user. */
 136   size_t bytes_used;            /* Byte total of user-allocated chunks. */
 137   size_t chunks_free;           /* Chunks in the free list. */
 138   size_t bytes_free;            /* Byte total of chunks in the free list. */
 139 };
 140
 141 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 142 #define MC_UNSET_RAW_MEM    mmalloc_set_current_heap(std_heap)
 143
 144 /******************************* MEMORY MAPPINGS ***************************/
 145 /* These functions and data structures implements a binary interface for   */
 146 /* the proc maps ascii interface                                           */
 147
 148 /* Each field is defined as documented in proc's manual page  */
 149 typedef struct s_map_region {
 150
 151   void *start_addr;             /* Start address of the map */
 152   void *end_addr;               /* End address of the map */
 153   int prot;                     /* Memory protection */
 154   int flags;                    /* Aditional memory flags */
 155   void *offset;                 /* Offset in the file/whatever */
 156   char dev_major;               /* Major of the device */
 157   char dev_minor;               /* Minor of the device */
 158   unsigned long inode;          /* Inode in the device */
 159   char *pathname;               /* Path name of the mapped file */
 160
 161 } s_map_region;
 162
 163 typedef struct s_memory_map {
 164
 165   s_map_region *regions;        /* Pointer to an array of regions */
 166   int mapsize;                  /* Number of regions in the memory */
 167
 168 } s_memory_map_t, *memory_map_t;
 169
 170 memory_map_t get_memory_map(void);
 171
 172 /********************************** DFS **************************************/
 173
 174 typedef struct s_mc_pairs{
 175   mc_snapshot_t system_state;
 176   mc_state_t graph_state;
 177   xbt_state_t automaton_state;
 178   int num;
 179 }s_mc_pairs_t, *mc_pairs_t;
 180
 181 typedef struct s_mc_visited_pairs{
 182   mc_state_t graph_state;
 183   xbt_state_t automaton_state;
 184   int search_cycle;
 185 }s_mc_visited_pairs_t, *mc_visited_pairs_t;
 186
 187 typedef struct s_mc_reached_pairs{
 188   mc_state_t graph_state;
 189   xbt_state_t automaton_state;
 190 }s_mc_reached_pairs_t, *mc_reached_pairs_t;
 191
 192 extern xbt_fifo_t mc_snapshot_stack;
 193
 194 void MC_dfs_init(xbt_automaton_t a);
 195 void MC_dfs(xbt_automaton_t automaton, int search_cycle, int restore);
 196 int MC_automaton_evaluate_label(xbt_automaton_t a, xbt_exp_label_t l);
 197 mc_pairs_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
 198 void set_pair_visited(mc_state_t gs, xbt_state_t as, int search_cycle);
 199 int visited(mc_state_t gs, xbt_state_t as, int search_cycle);
 200 int reached(mc_state_t gs, xbt_state_t as);
 201 void set_pair_reached(mc_state_t gs, xbt_state_t as);
 202 void MC_show_snapshot_stack(xbt_fifo_t stack);
 203 void MC_dump_snapshot_stack(xbt_fifo_t stack);
 204 void MC_pair_delete(mc_pairs_t pair);
 205
 206 #endif