src/kernel/actor/SimcallObserver.hpp

   1 /* Copyright (c) 2019-2021. 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
  11 #include <string>
  12
  13 namespace simgrid {
  14 namespace kernel {
  15 namespace actor {
  16
  17 class SimcallObserver {
  18   ActorImpl* const issuer_;
  19
  20 public:
  21   explicit SimcallObserver(ActorImpl* issuer) : issuer_(issuer) {}
  22   ActorImpl* get_issuer() const { return issuer_; }
  23   /** Whether this transition can currently be taken without blocking.
  24    *
  25    * For example, a mutex_lock is not enabled when the mutex is not free.
  26    * A comm_receive is not enabled before the corresponding send has been issued.
  27    */
  28   virtual bool is_enabled() const { return true; }
  29
  30   /** Returns the amount of time that this transition can be used.
  31    *
  32    * If it's 1 (as with send/wait), there is no need to fork the state space exploration on this point.
  33    * If it's more than one (as with mc_random or waitany), we need to consider this transition several times to start
  34    * differing branches
  35    */
  36   virtual int get_max_consider() const { return 1; }
  37
  38   /** Prepares the simcall to be used.
  39    *
  40    * For most simcalls, this does nothing. Once enabled, there is nothing to do to prepare a send().
  41    *
  42    * It is useful only for the simcalls that can be used several times, such as waitany() or random().
  43    * For them, prepare() selects the right outcome for the time being considered.
  44    *
  45    * The first time a simcall is considered, times_considered is 0, not 1.
  46    */
  47   virtual void prepare(int times_considered)
  48   { /* Nothing to do by default */
  49   }
  50
  51   /** Some simcalls may only be observable under some circumstances.
  52    * Most simcalls are not visible from the MC because they don't have an observer at all. */
  53   virtual bool is_visible() const { return true; }
  54   virtual std::string to_string(int times_considered) const = 0;
  55   virtual std::string dot_label() const                     = 0;
  56 };
  57
  58 template <class T> class ResultingSimcall : public SimcallObserver {
  59   T result_;
  60
  61 public:
  62   ResultingSimcall(smx_actor_t actor, T default_result) : SimcallObserver(actor), result_(default_result) {}
  63   void set_result(T res) { result_ = res; }
  64   T get_result() const { return result_; }
  65 };
  66
  67 class RandomSimcall : public SimcallObserver {
  68   const int min_;
  69   const int max_;
  70   int next_value_ = 0;
  71
  72 public:
  73   RandomSimcall(smx_actor_t actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max) {}
  74   int get_max_consider() const override;
  75   void prepare(int times_considered) override;
  76   std::string to_string(int times_considered) const override;
  77   std::string dot_label() const override;
  78   int get_value() const { return next_value_; }
  79 };
  80
  81 class MutexUnlockSimcall : public SimcallObserver {
  82   using SimcallObserver::SimcallObserver;
  83
  84 public:
  85   std::string to_string(int times_considered) const override;
  86   std::string dot_label() const override;
  87 };
  88
  89 class MutexLockSimcall : public SimcallObserver {
  90   activity::MutexImpl* const mutex_;
  91   const bool blocking_;
  92
  93 public:
  94   MutexLockSimcall(smx_actor_t actor, activity::MutexImpl* mutex, bool blocking = true)
  95       : SimcallObserver(actor), mutex_(mutex), blocking_(blocking)
  96   {
  97   }
  98   bool is_enabled() const override;
  99   std::string to_string(int times_considered) const override;
 100   std::string dot_label() const override;
 101   activity::MutexImpl* get_mutex() const { return mutex_; }
 102 };
 103
 104 class ConditionWaitSimcall : public ResultingSimcall<bool> {
 105   activity::ConditionVariableImpl* const cond_;
 106   activity::MutexImpl* const mutex_;
 107   const double timeout_;
 108
 109 public:
 110   ConditionWaitSimcall(smx_actor_t actor, activity::ConditionVariableImpl* cond, activity::MutexImpl* mutex,
 111                        double timeout = -1.0)
 112       : ResultingSimcall(actor, false), cond_(cond), mutex_(mutex), timeout_(timeout)
 113   {
 114   }
 115   bool is_enabled() const override;
 116   bool is_visible() const override { return false; }
 117   std::string to_string(int times_considered) const override;
 118   std::string dot_label() const override;
 119   activity::ConditionVariableImpl* get_cond() const { return cond_; }
 120   activity::MutexImpl* get_mutex() const { return mutex_; }
 121   double get_timeout() const { return timeout_; }
 122 };
 123
 124 class SemAcquireSimcall : public ResultingSimcall<bool> {
 125   activity::SemaphoreImpl* const sem_;
 126   const double timeout_;
 127
 128 public:
 129   SemAcquireSimcall(smx_actor_t actor, activity::SemaphoreImpl* sem, double timeout = -1.0)
 130       : ResultingSimcall(actor, false), sem_(sem), timeout_(timeout)
 131   {
 132   }
 133   bool is_enabled() const override;
 134   bool is_visible() const override { return false; }
 135   std::string to_string(int times_considered) const override;
 136   std::string dot_label() const override;
 137   activity::SemaphoreImpl* get_sem() const { return sem_; }
 138   double get_timeout() const { return timeout_; }
 139 };
 140
 141 class ExecutionWaitanySimcall : public ResultingSimcall<int> {
 142   const std::vector<activity::ExecImpl*>& execs_;
 143   const double timeout_;
 144
 145 public:
 146   ExecutionWaitanySimcall(smx_actor_t actor, const std::vector<activity::ExecImpl*>& execs, double timeout)
 147       : ResultingSimcall(actor, -1), execs_(execs), timeout_(timeout)
 148   {
 149   }
 150   bool is_visible() const override { return false; }
 151   std::string to_string(int times_considered) const override;
 152   std::string dot_label() const override;
 153   const std::vector<activity::ExecImpl*>& get_execs() const { return execs_; }
 154   double get_timeout() const { return timeout_; }
 155 };
 156
 157 class IoWaitanySimcall : public ResultingSimcall<int> {
 158   const std::vector<activity::IoImpl*>& ios_;
 159   const double timeout_;
 160
 161 public:
 162   IoWaitanySimcall(smx_actor_t actor, const std::vector<activity::IoImpl*>& ios, double timeout)
 163       : ResultingSimcall(actor, -1), ios_(ios), timeout_(timeout)
 164   {
 165   }
 166   bool is_visible() const override { return false; }
 167   std::string to_string(int times_considered) const override;
 168   std::string dot_label() const override;
 169   const std::vector<activity::IoImpl*>& get_ios() const { return ios_; }
 170   double get_timeout() const { return timeout_; }
 171 };
 172 } // namespace actor
 173 } // namespace kernel
 174 } // namespace simgrid
 175
 176 #endif