src/mc/private.h

   1 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
   2    All rights reserved.                                          */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef MC_PRIVATE_H
   8 #define MC_PRIVATE_H
   9
  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/private.h"
  19
  20 /****************************** Snapshots ***********************************/
  21
  22 typedef struct s_mc_mem_region{
  23   void *start_addr;
  24   void *data;
  25   size_t size;
  26 } s_mc_mem_region_t, *mc_mem_region_t;
  27
  28 typedef struct s_mc_snapshot{
  29   unsigned int num_reg;
  30   mc_mem_region_t *regions;
  31 } s_mc_snapshot_t, *mc_snapshot_t;
  32
  33 void MC_take_snapshot(mc_snapshot_t);
  34 void MC_restore_snapshot(mc_snapshot_t);
  35 void MC_free_snapshot(mc_snapshot_t);
  36
  37 /********************************* MC Global **********************************/
  38 extern double *mc_time;
  39
  40 /* Bound of the MC depth-first search algorithm */
  41 #define MAX_DEPTH 1000
  42
  43 int MC_deadlock_check(void);
  44 void MC_replay(xbt_fifo_t stack);
  45 void MC_wait_for_requests(void);
  46 void MC_get_enabled_processes();
  47 void MC_show_deadlock(smx_req_t req);
  48 void MC_show_stack(xbt_fifo_t stack);
  49 void MC_dump_stack(xbt_fifo_t stack);
  50
  51 /********************************* Requests ***********************************/
  52 int MC_request_depend(smx_req_t req1, smx_req_t req2);
  53 char* MC_request_to_string(smx_req_t req, int value);
  54 unsigned int MC_request_testany_fail(smx_req_t req);
  55 /*int MC_waitany_is_enabled_by_comm(smx_req_t req, unsigned int comm);*/
  56 int MC_request_is_visible(smx_req_t req);
  57 int MC_request_is_enabled(smx_req_t req);
  58 int MC_request_is_enabled_by_idx(smx_req_t req, unsigned int idx);
  59 int MC_process_is_enabled(smx_process_t process);
  60
  61 /********************************** DPOR **************************************/
  62 void MC_dpor_init(void);
  63 void MC_dpor(void);
  64 void MC_dpor_exit(void);
  65
  66 /******************************** States **************************************/
  67 /* Possible exploration status of a process in a state */
  68 typedef enum {
  69   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
  70   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
  71   MC_DONE                   /* Already interleaved */
  72 } e_mc_process_state_t;
  73
  74 /* On every state, each process has an entry of the following type */
  75 typedef struct mc_procstate{
  76   e_mc_process_state_t state;       /* Exploration control information */
  77   unsigned int interleave_count;    /* Number of times that the process was
  78                                        interleaved */
  79 } s_mc_procstate_t, *mc_procstate_t;
  80
  81 /* An exploration state is composed of: */
  82 typedef struct mc_state {
  83   unsigned long max_pid;            /* Maximum pid at state's creation time */
  84   mc_procstate_t proc_status;       /* State's exploration status by process */
  85   s_smx_action_t internal_comm;     /* To be referenced by the internal_req */
  86   s_smx_req_t internal_req;         /* Internal translation of request */
  87   s_smx_req_t executed_req;         /* The executed request of the state */
  88   int req_num;                      /* The request number (in the case of a
  89                                        multi-request like waitany ) */
  90 } s_mc_state_t, *mc_state_t;
  91
  92 extern xbt_fifo_t mc_stack;
  93
  94 mc_state_t MC_state_new(void);
  95 void MC_state_delete(mc_state_t state);
  96 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
  97 unsigned int MC_state_interleave_size(mc_state_t state);
  98 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
  99 void MC_state_set_executed_request(mc_state_t state, smx_req_t req, int value);
 100 smx_req_t MC_state_get_executed_request(mc_state_t state, int *value);
 101 smx_req_t MC_state_get_internal_request(mc_state_t state);
 102 smx_req_t MC_state_get_request(mc_state_t state, int *value);
 103
 104 /****************************** Statistics ************************************/
 105 typedef struct mc_stats {
 106   unsigned long state_size;
 107   unsigned long visited_states;
 108   unsigned long expanded_states;
 109   unsigned long executed_transitions;
 110 } s_mc_stats_t, *mc_stats_t;
 111
 112 extern mc_stats_t mc_stats;
 113
 114 void MC_print_statistics(mc_stats_t);
 115
 116 /********************************** MEMORY ******************************/
 117 /* The possible memory modes for the modelchecker are standard and raw. */
 118 /* Normally the system should operate in std, for switching to raw mode */
 119 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
 120
 121 extern void *std_heap;
 122 extern void *raw_heap;
 123 /* extern int raw_heap_fd; */ /* unused */
 124 #define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
 125
 126 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
 127 /* an API to query about the status of a heap, we simply call mmstats and */
 128 /* because I now how does structure looks like, then I redefine it here */
 129
 130 struct mstats {
 131   size_t bytes_total;           /* Total size of the heap. */
 132   size_t chunks_used;           /* Chunks allocated by the user. */
 133   size_t bytes_used;            /* Byte total of user-allocated chunks. */
 134   size_t chunks_free;           /* Chunks in the free list. */
 135   size_t bytes_free;            /* Byte total of chunks in the free list. */
 136 };
 137
 138 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
 139 #define MC_UNSET_RAW_MEM    mmalloc_set_current_heap(std_heap)
 140
 141 /******************************* MEMORY MAPPINGS ***************************/
 142 /* These functions and data structures implements a binary interface for   */
 143 /* the proc maps ascii interface                                           */
 144
 145 /* Each field is defined as documented in proc's manual page  */
 146 typedef struct s_map_region {
 147
 148   void *start_addr;             /* Start address of the map */
 149   void *end_addr;               /* End address of the map */
 150   int prot;                     /* Memory protection */
 151   int flags;                    /* Aditional memory flags */
 152   void *offset;                 /* Offset in the file/whatever */
 153   char dev_major;               /* Major of the device */
 154   char dev_minor;               /* Minor of the device */
 155   unsigned long inode;          /* Inode in the device */
 156   char *pathname;               /* Path name of the mapped file */
 157
 158 } s_map_region;
 159
 160 typedef struct s_memory_map {
 161
 162   s_map_region *regions;        /* Pointer to an array of regions */
 163   int mapsize;                  /* Number of regions in the memory */
 164
 165 } s_memory_map_t, *memory_map_t;
 166
 167 memory_map_t get_memory_map(void);
 168
 169
 170 #endif