src/mc/mc_state.hpp

   1 /* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_MC_STATE_HPP
   7 #define SIMGRID_MC_STATE_HPP
   8
   9 #include <list>
  10 #include <memory>
  11
  12 #include "src/mc/Transition.hpp"
  13 #include "src/mc/mc_record.hpp"
  14 #include "src/mc/mc_snapshot.hpp"
  15
  16 namespace simgrid {
  17 namespace mc {
  18
  19 enum class PatternCommunicationType {
  20   none    = 0,
  21   send    = 1,
  22   receive = 2,
  23 };
  24
  25 class PatternCommunication {
  26 public:
  27   int num = 0;
  28   simgrid::kernel::activity::CommImpl* comm_addr;
  29   PatternCommunicationType type = PatternCommunicationType::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() { std::memset(&comm_addr, 0, sizeof(comm_addr)); }
  40
  41   PatternCommunication dup() const
  42   {
  43     simgrid::mc::PatternCommunication res;
  44     // num?
  45     res.comm_addr = this->comm_addr;
  46     res.type      = this->type;
  47     // src_proc?
  48     // dst_proc?
  49     res.dst_proc = this->dst_proc;
  50     res.dst_host = this->dst_host;
  51     res.rdv      = this->rdv;
  52     res.data     = this->data;
  53     // tag?
  54     res.index = this->index;
  55     return res;
  56   }
  57 };
  58
  59 /* On every state, each process has an entry of the following type.
  60  * This represents both the process and its transition because
  61  *   a process cannot have more than one enabled transition at a given time.
  62  */
  63 class ProcessState {
  64   /* Possible exploration status of a process transition in a state.
  65    * Either the checker did not consider the transition, or it was considered and to do, or considered and done.
  66    */
  67   enum class InterleavingType {
  68     /** This process transition is not considered by the checker (yet?) */
  69     disabled = 0,
  70     /** The checker algorithm decided that this process transitions should be done at some point */
  71     todo,
  72     /** The checker algorithm decided that this should be done, but it was done in the meanwhile */
  73     done,
  74   };
  75
  76   /** Exploration control information */
  77   InterleavingType state = InterleavingType::disabled;
  78
  79 public:
  80   /** Number of times that the process was considered to be executed */
  81   // TODO, make this private
  82   unsigned int times_considered = 0;
  83
  84   bool isDisabled() const { return this->state == InterleavingType::disabled; }
  85   bool isDone() const { return this->state == InterleavingType::done; }
  86   bool isTodo() const { return this->state == InterleavingType::todo; }
  87   /** Mark that we should try executing this process at some point in the future of the checker algorithm */
  88   void consider()
  89   {
  90     this->state            = InterleavingType::todo;
  91     this->times_considered = 0;
  92   }
  93   void setDone() { this->state = InterleavingType::done; }
  94 };
  95
  96 /* A node in the exploration graph (kind-of)
  97  */
  98 class XBT_PRIVATE State {
  99 public:
 100   /** Sequential state number (used for debugging) */
 101   int num = 0;
 102
 103   /** State's exploration status by process */
 104   std::vector<ProcessState> actorStates;
 105
 106   Transition transition;
 107
 108   /** The simcall which was executed, going out of that state */
 109   s_smx_simcall executed_req;
 110
 111   /* Internal translation of the executed_req simcall
 112    *
 113    * SIMCALL_COMM_TESTANY is translated to a SIMCALL_COMM_TEST
 114    * and SIMCALL_COMM_WAITANY to a SIMCALL_COMM_WAIT.
 115    */
 116   s_smx_simcall internal_req;
 117
 118   /* Can be used as a copy of the remote synchro object */
 119   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> internal_comm;
 120
 121   /** Snapshot of system state (if needed) */
 122   std::shared_ptr<simgrid::mc::Snapshot> system_state;
 123
 124   // For CommunicationDeterminismChecker
 125   std::vector<std::vector<simgrid::mc::PatternCommunication>> incomplete_comm_pattern;
 126   std::vector<unsigned> communicationIndices;
 127
 128   explicit State(unsigned long state_number);
 129
 130   std::size_t interleaveSize() const;
 131   void addInterleavingSet(smx_actor_t actor) { this->actorStates[actor->pid].consider(); }
 132   Transition getTransition() const;
 133 };
 134 }
 135 }
 136
 137 XBT_PRIVATE smx_simcall_t MC_state_get_request(simgrid::mc::State* state);
 138
 139 #endif