src/mc/mc_state.h

   1 /* Copyright (c) 2007-2015. The SimGrid Team.
   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 SIMGRID_MC_STATE_H
   8 #define SIMGRID_MC_STATE_H
   9
  10 #include <list>
  11 #include <memory>
  12
  13 #include <xbt/base.h>
  14 #include <xbt/dynar.h>
  15
  16 #include <simgrid_config.h>
  17 #include "src/simix/smx_private.h"
  18 #include "src/mc/mc_snapshot.h"
  19 #include "src/mc/mc_record.h"
  20
  21 namespace simgrid {
  22 namespace mc {
  23
  24 extern XBT_PRIVATE std::unique_ptr<s_mc_global_t> initial_global_state;
  25
  26 struct PatternCommunication {
  27   int num = 0;
  28   smx_synchro_t comm_addr;
  29   e_smx_comm_type_t type = SIMIX_COMM_SEND;
  30   unsigned long src_proc = 0;
  31   unsigned long dst_proc = 0;
  32   const char *src_host = nullptr;
  33   const char *dst_host = nullptr;
  34   std::string rdv;
  35   std::vector<char> data;
  36   int tag = 0;
  37   int index = 0;
  38
  39   PatternCommunication()
  40   {
  41     std::memset(&comm_addr, 0, sizeof(comm_addr));
  42   }
  43
  44   PatternCommunication dup() const
  45   {
  46     simgrid::mc::PatternCommunication res;
  47     // num?
  48     res.comm_addr = this->comm_addr;
  49     res.type = this->type;
  50     // src_proc?
  51     // dst_proc?
  52     res.dst_proc = this->dst_proc;
  53     res.dst_host = this->dst_host;
  54     res.rdv = this->rdv;
  55     res.data = this->data;
  56     // tag?
  57     res.index = this->index;
  58     return res;
  59   }
  60
  61 };
  62
  63 /* On every state, each process has an entry of the following type */
  64 class ProcessState {
  65   /* Possible exploration status of a process in a state */
  66   enum class InterleavingType {
  67     /** We do not have to execute this process transitions */
  68     disabled = 0,
  69     /** We still have to execute (some of) this process transitions */
  70     interleave,
  71     /** We have already executed this process transitions */
  72     done,
  73   };
  74
  75   /** Exploration control information */
  76   InterleavingType state = InterleavingType::disabled;
  77 public:
  78
  79   /** Number of times that the process was interleaved */
  80   // TODO, make this private
  81   unsigned int interleave_count = 0;
  82
  83   bool isDisabled() const
  84   {
  85     return this->state == InterleavingType::disabled;
  86   }
  87   bool isDone() const
  88   {
  89     return this->state == InterleavingType::done;
  90   }
  91   bool isToInterleave() const
  92   {
  93     return this->state == InterleavingType::interleave;
  94   }
  95   void interleave()
  96   {
  97     this->state = InterleavingType::interleave;
  98     this->interleave_count = 0;
  99   }
 100   void setDone()
 101   {
 102     this->state = InterleavingType::done;
 103   }
 104 };
 105
 106 /* A node in the exploration graph (kind-of)
 107  */
 108 struct XBT_PRIVATE State {
 109
 110   /** Sequential state number (used for debugging) */
 111   int num = 0;
 112
 113   /* Which transition was executed for this simcall
 114    *
 115    * Some simcalls can lead to different transitions:
 116    *
 117    * * waitany/testany can trigger on different messages;
 118    *
 119    * * random can produce different values.
 120    */
 121   int req_num = 0;
 122
 123   /** State's exploration status by process */
 124   std::vector<ProcessState> processStates;
 125
 126   /** The simcall which was executed */
 127   s_smx_simcall_t executed_req;
 128
 129   /* Internal translation of the simcall
 130    *
 131    * SIMCALL_COMM_TESTANY is translated to a SIMCALL_COMM_TEST
 132    * and SIMCALL_COMM_WAITANY to a SIMCALL_COMM_WAIT.
 133    */
 134   s_smx_simcall_t internal_req;
 135
 136   /* Can be used as a copy of the remote synchro object */
 137   s_smx_synchro_t internal_comm;
 138
 139   /** Snapshot of system state (if needed) */
 140   std::shared_ptr<simgrid::mc::Snapshot> system_state;
 141
 142   // For CommunicationDeterminismChecker
 143   std::vector<std::vector<simgrid::mc::PatternCommunication>> incomplete_comm_pattern;
 144   std::vector<unsigned> communicationIndices;
 145
 146   State();
 147
 148   std::size_t interleaveSize() const;
 149   void interleave(smx_process_t process)
 150   {
 151     this->processStates[process->pid].interleave();
 152   }
 153   RecordTraceElement getRecordElement() const;
 154 };
 155
 156 XBT_PRIVATE void replay(std::list<std::unique_ptr<simgrid::mc::State>> const& stack);
 157
 158 }
 159 }
 160
 161 XBT_PRIVATE simgrid::mc::State* MC_state_new(void);
 162 XBT_PRIVATE smx_simcall_t MC_state_get_request(simgrid::mc::State* state);
 163
 164 #endif