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