src/kernel/actor/SimcallObserver.hpp

   1 /* Copyright (c) 2019-2023. 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_SIMCALL_OBSERVER_HPP
   7 #define SIMGRID_MC_SIMCALL_OBSERVER_HPP
   8
   9 #include "simgrid/forward.h"
  10 #include "src/mc/transition/Transition.hpp"
  11 #include "xbt/asserts.h"
  12
  13 #include <string>
  14 #include <unordered_map>
  15
  16 namespace simgrid::kernel::actor {
  17
  18 class SimcallObserver {
  19   ActorImpl* const issuer_;
  20
  21 protected:
  22   ~SimcallObserver() = default;
  23
  24 public:
  25   explicit SimcallObserver(ActorImpl* issuer) : issuer_(issuer) {}
  26   ActorImpl* get_issuer() const { return issuer_; }
  27   /** Whether this transition can currently be taken without blocking.
  28    *
  29    * For example, a mutex_lock is not enabled when the mutex is not free.
  30    * A comm_receive is not enabled before the corresponding send has been issued.
  31    */
  32   virtual bool is_enabled() { return true; }
  33
  34   /** Returns the amount of time that this transition can be used.
  35    *
  36    * If it's 0, the transition is not enabled.
  37    * If it's 1 (as with send/wait), there is no need to fork the state space exploration on this point.
  38    * If it's more than one (as with mc_random or waitany), we need to consider this transition several times to start
  39    * differing branches
  40    */
  41   virtual int get_max_consider() const { return 1; }
  42
  43   /** Prepares the simcall to be used.
  44    *
  45    * For most simcalls, this does nothing. Once enabled, there is nothing to do to prepare a send().
  46    *
  47    * It is useful only for the simcalls that can be used several times, such as waitany() or random().
  48    * For them, prepare() selects the right outcome for the time being considered.
  49    *
  50    * The first time a simcall is considered, times_considered is 0, not 1.
  51    */
  52   virtual void prepare(int times_considered)
  53   { /* Nothing to do by default */
  54   }
  55
  56   /** Serialize to the given string buffer, to send over the network */
  57   virtual void serialize(std::stringstream& stream) const = 0;
  58
  59   /** Used to debug (to display the simcall on which each actor is blocked when displaying it */
  60   virtual std::string to_string() const = 0;
  61
  62   /** Whether the MC should see this simcall.
  63    * Simcall that don't have an observer (ie, most of them) are not visible from the MC, but if there is an observer,
  64    * they are observable by default. */
  65   virtual bool is_visible() const { return true; }
  66 };
  67
  68 template <class T> class ResultingSimcall : public SimcallObserver {
  69   T result_;
  70
  71 protected:
  72   ~ResultingSimcall() = default;
  73
  74 public:
  75   ResultingSimcall(ActorImpl* actor, T default_result) : SimcallObserver(actor), result_(default_result) {}
  76   void set_result(T res) { result_ = res; }
  77   T get_result() const { return result_; }
  78 };
  79
  80 class RandomSimcall final : public SimcallObserver {
  81   const int min_;
  82   const int max_;
  83   int next_value_ = 0;
  84
  85 public:
  86   RandomSimcall(ActorImpl* actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max)
  87   {
  88     xbt_assert(min <= max);
  89   }
  90   void serialize(std::stringstream& stream) const override;
  91   std::string to_string() const override;
  92   int get_max_consider() const override;
  93   void prepare(int times_considered) override;
  94   int get_value() const { return next_value_; }
  95 };
  96
  97 class ConditionWaitSimcall final : public ResultingSimcall<bool> {
  98   activity::ConditionVariableImpl* const cond_;
  99   activity::MutexImpl* const mutex_;
 100   const double timeout_;
 101
 102 public:
 103   ConditionWaitSimcall(ActorImpl* actor, activity::ConditionVariableImpl* cond, activity::MutexImpl* mutex,
 104                        double timeout = -1.0)
 105       : ResultingSimcall(actor, false), cond_(cond), mutex_(mutex), timeout_(timeout)
 106   {
 107   }
 108   void serialize(std::stringstream& stream) const override;
 109   std::string to_string() const override;
 110   bool is_enabled() override;
 111   activity::ConditionVariableImpl* get_cond() const { return cond_; }
 112   activity::MutexImpl* get_mutex() const { return mutex_; }
 113   double get_timeout() const { return timeout_; }
 114 };
 115
 116 class ActorJoinSimcall final : public SimcallObserver {
 117   s4u::ActorPtr const other_; // We need a Ptr to ensure access to the actor after its end, but Ptr requires s4u
 118   const double timeout_;
 119
 120 public:
 121   ActorJoinSimcall(ActorImpl* actor, ActorImpl* other, double timeout = -1.0);
 122   void serialize(std::stringstream& stream) const override;
 123   std::string to_string() const override;
 124   bool is_enabled() override;
 125
 126   s4u::ActorPtr get_other_actor() const { return other_; }
 127   double get_timeout() const { return timeout_; }
 128 };
 129
 130 class ObjectAccessSimcallObserver final : public SimcallObserver {
 131   ObjectAccessSimcallItem* const object_;
 132
 133 public:
 134   ObjectAccessSimcallObserver(ActorImpl* actor, ObjectAccessSimcallItem* object)
 135       : SimcallObserver(actor), object_(object)
 136   {
 137   }
 138   void serialize(std::stringstream& stream) const override;
 139   std::string to_string() const override;
 140   bool is_visible() const override;
 141   bool is_enabled() override { return true; }
 142
 143   ActorImpl* get_owner() const;
 144 };
 145
 146 /* Semi private template used by the to_string methods of various observer classes */
 147 template <typename A> static std::string ptr_to_id(A* ptr)
 148 {
 149   static std::unordered_map<A*, std::string> map({{nullptr, "-"}});
 150   auto [elm, inserted] = map.try_emplace(ptr);
 151   if (inserted)
 152     elm->second = std::to_string(map.size() - 1);
 153   return elm->second;
 154 }
 155
 156 } // namespace simgrid::kernel::actor
 157
 158 #endif