src/kernel/actor/SimcallObserver.hpp

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