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 "xbt/asserts.h"
  11 #include "xbt/utility.hpp"
  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   XBT_DECLARE_ENUM_CLASS(Simcall, UNKNOWN, RANDOM, ISEND, IRECV, COMM_WAIT, COMM_TEST);
  24
  25   SimcallObserver() = default;
  26   explicit SimcallObserver(ActorImpl* issuer) : issuer_(issuer) {}
  27   ActorImpl* get_issuer() const { return issuer_; }
  28   /** Whether this transition can currently be taken without blocking.
  29    *
  30    * For example, a mutex_lock is not enabled when the mutex is not free.
  31    * A comm_receive is not enabled before the corresponding send has been issued.
  32    */
  33   virtual bool is_enabled() const { return true; }
  34
  35   /** Returns the amount of time that this transition can be used.
  36    *
  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   /** We need to save the observer of simcalls as they get executed to later compute their dependencies in classical
  57    * DPOR */
  58   virtual SimcallObserver* clone() = 0;
  59
  60   /** Computes the dependency relation */
  61   virtual bool depends(SimcallObserver* other);
  62
  63   /** Serialize to the given buffer */
  64   virtual void serialize(Simcall& type, char* buffer) { type = Simcall::UNKNOWN; }
  65
  66   /** Some simcalls may only be observable under some conditions.
  67    * Most simcalls are not visible from the MC because they don't have an observer at all. */
  68   virtual bool is_visible() const { return true; }
  69   virtual std::string dot_label(int times_considered) const = 0;
  70 };
  71
  72 template <class T> class ResultingSimcall : public SimcallObserver {
  73   T result_;
  74
  75 public:
  76   ResultingSimcall() = default;
  77   ResultingSimcall(ActorImpl* actor, T default_result) : SimcallObserver(actor), result_(default_result) {}
  78   void set_result(T res) { result_ = res; }
  79   T get_result() const { return result_; }
  80 };
  81
  82 class RandomSimcall : public SimcallObserver {
  83   const int min_;
  84   const int max_;
  85   int next_value_ = 0;
  86
  87 public:
  88   RandomSimcall(ActorImpl* actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max)
  89   {
  90     xbt_assert(min < max);
  91   }
  92   SimcallObserver* clone() override
  93   {
  94     auto res         = new RandomSimcall(get_issuer(), min_, max_);
  95     res->next_value_ = next_value_;
  96     return res;
  97   }
  98   void serialize(Simcall& type, char* buffer) override { type = Simcall::RANDOM; }
  99   int get_max_consider() const override;
 100   void prepare(int times_considered) override;
 101   std::string dot_label(int times_considered) const override;
 102   int get_value() const { return next_value_; }
 103   bool depends(SimcallObserver* other) override;
 104 };
 105
 106 class MutexSimcall : public SimcallObserver {
 107   activity::MutexImpl* const mutex_;
 108
 109 public:
 110   MutexSimcall(ActorImpl* actor, activity::MutexImpl* mutex) : SimcallObserver(actor), mutex_(mutex) {}
 111   activity::MutexImpl* get_mutex() const { return mutex_; }
 112   bool depends(SimcallObserver* other) override;
 113 };
 114
 115 class MutexUnlockSimcall : public MutexSimcall {
 116   using MutexSimcall::MutexSimcall;
 117
 118 public:
 119   SimcallObserver* clone() override { return new MutexUnlockSimcall(get_issuer(), get_mutex()); }
 120   std::string dot_label(int times_considered) const override;
 121 };
 122
 123 class MutexLockSimcall : public MutexSimcall {
 124   const bool blocking_;
 125
 126 public:
 127   MutexLockSimcall(ActorImpl* actor, activity::MutexImpl* mutex, bool blocking = true)
 128       : MutexSimcall(actor, mutex), blocking_(blocking)
 129   {
 130   }
 131   SimcallObserver* clone() override { return new MutexLockSimcall(get_issuer(), get_mutex(), blocking_); }
 132   bool is_enabled() const override;
 133   std::string dot_label(int times_considered) const override;
 134 };
 135
 136 class ConditionWaitSimcall : public ResultingSimcall<bool> {
 137   activity::ConditionVariableImpl* const cond_;
 138   activity::MutexImpl* const mutex_;
 139   const double timeout_;
 140
 141 public:
 142   ConditionWaitSimcall(ActorImpl* actor, activity::ConditionVariableImpl* cond, activity::MutexImpl* mutex,
 143                        double timeout = -1.0)
 144       : ResultingSimcall(actor, false), cond_(cond), mutex_(mutex), timeout_(timeout)
 145   {
 146   }
 147   SimcallObserver* clone() override { return new ConditionWaitSimcall(get_issuer(), cond_, mutex_, timeout_); }
 148   bool is_enabled() const override;
 149   bool is_visible() const override { return false; }
 150   std::string dot_label(int times_considered) const override;
 151   activity::ConditionVariableImpl* get_cond() const { return cond_; }
 152   activity::MutexImpl* get_mutex() const { return mutex_; }
 153   double get_timeout() const { return timeout_; }
 154 };
 155
 156 class SemAcquireSimcall : public ResultingSimcall<bool> {
 157   activity::SemaphoreImpl* const sem_;
 158   const double timeout_;
 159
 160 public:
 161   SemAcquireSimcall(ActorImpl* actor, activity::SemaphoreImpl* sem, double timeout = -1.0)
 162       : ResultingSimcall(actor, false), sem_(sem), timeout_(timeout)
 163   {
 164   }
 165   SimcallObserver* clone() override { return new SemAcquireSimcall(get_issuer(), sem_, timeout_); }
 166   bool is_enabled() const override;
 167   bool is_visible() const override { return false; }
 168   std::string dot_label(int times_considered) const override;
 169   activity::SemaphoreImpl* get_sem() const { return sem_; }
 170   double get_timeout() const { return timeout_; }
 171 };
 172
 173 class ActivityTestSimcall : public ResultingSimcall<bool> {
 174   activity::ActivityImpl* const activity_;
 175
 176 public:
 177   ActivityTestSimcall(ActorImpl* actor, activity::ActivityImpl* activity)
 178       : ResultingSimcall(actor, true), activity_(activity)
 179   {
 180   }
 181   SimcallObserver* clone() override { return new ActivityTestSimcall(get_issuer(), activity_); }
 182   bool is_visible() const override { return true; }
 183   bool depends(SimcallObserver* other) override;
 184   std::string dot_label(int times_considered) const override;
 185   activity::ActivityImpl* get_activity() const { return activity_; }
 186 };
 187
 188 class ActivityTestanySimcall : public ResultingSimcall<ssize_t> {
 189   const std::vector<activity::ActivityImpl*>& activities_;
 190   int next_value_ = 0;
 191
 192 public:
 193   ActivityTestanySimcall(ActorImpl* actor, const std::vector<activity::ActivityImpl*>& activities)
 194       : ResultingSimcall(actor, -1), activities_(activities)
 195   {
 196   }
 197   SimcallObserver* clone() override { return new ActivityTestanySimcall(get_issuer(), activities_); }
 198   bool is_visible() const override { return true; }
 199   int get_max_consider() const override;
 200   void prepare(int times_considered) override;
 201   std::string dot_label(int times_considered) const override;
 202   const std::vector<activity::ActivityImpl*>& get_activities() const { return activities_; }
 203   int get_value() const { return next_value_; }
 204 };
 205
 206 class ActivityWaitSimcall : public ResultingSimcall<bool> {
 207   activity::ActivityImpl* activity_;
 208   const double timeout_;
 209
 210 public:
 211   ActivityWaitSimcall(ActorImpl* actor, activity::ActivityImpl* activity, double timeout)
 212       : ResultingSimcall(actor, false), activity_(activity), timeout_(timeout)
 213   {
 214   }
 215   SimcallObserver* clone() override { return new ActivityWaitSimcall(get_issuer(), activity_, timeout_); }
 216   void serialize(Simcall& type, char* buffer);
 217   bool is_visible() const override { return true; }
 218   bool is_enabled() const override;
 219   bool depends(SimcallObserver* other) override;
 220   std::string dot_label(int times_considered) const override;
 221   activity::ActivityImpl* get_activity() const { return activity_; }
 222   void set_activity(activity::ActivityImpl* activity) { activity_ = activity; }
 223   double get_timeout() const { return timeout_; }
 224 };
 225
 226 class ActivityWaitanySimcall : public ResultingSimcall<ssize_t> {
 227   const std::vector<activity::ActivityImpl*>& activities_;
 228   const double timeout_;
 229   int next_value_ = 0;
 230
 231 public:
 232   ActivityWaitanySimcall(ActorImpl* actor, const std::vector<activity::ActivityImpl*>& activities, double timeout)
 233       : ResultingSimcall(actor, -1), activities_(activities), timeout_(timeout)
 234   {
 235   }
 236   SimcallObserver* clone() override { return new ActivityWaitanySimcall(get_issuer(), activities_, timeout_); }
 237   bool is_enabled() const override;
 238   bool is_visible() const override { return true; }
 239   void prepare(int times_considered) override;
 240   int get_max_consider() const override;
 241   std::string dot_label(int times_considered) const override;
 242   const std::vector<activity::ActivityImpl*>& get_activities() const { return activities_; }
 243   double get_timeout() const { return timeout_; }
 244   int get_value() const { return next_value_; }
 245 };
 246
 247 class CommIsendSimcall : public SimcallObserver {
 248   activity::MailboxImpl* mbox_;
 249   double payload_size_;
 250   double rate_;
 251   unsigned char* src_buff_;
 252   size_t src_buff_size_;
 253   void* payload_;
 254   bool detached_;
 255
 256 public:
 257   bool (*match_fun_)(void*, void*, activity::CommImpl*);
 258   void (*clean_fun_)(void*); // used to free the synchro in case of problem after a detached send
 259   void (*copy_data_fun_)(activity::CommImpl*, void*, size_t); // used to copy data if not default one
 260
 261   CommIsendSimcall(ActorImpl* actor, activity::MailboxImpl* mbox, double payload_size, double rate,
 262                    unsigned char* src_buff, size_t src_buff_size, bool (*match_fun)(void*, void*, activity::CommImpl*),
 263                    void (*clean_fun)(void*), // used to free the synchro in case of problem after a detached send
 264                    void (*copy_data_fun)(activity::CommImpl*, void*, size_t), // used to copy data if not default one
 265                    void* payload, bool detached)
 266       : SimcallObserver(actor)
 267       , mbox_(mbox)
 268       , payload_size_(payload_size)
 269       , rate_(rate)
 270       , src_buff_(src_buff)
 271       , src_buff_size_(src_buff_size)
 272       , payload_(payload)
 273       , detached_(detached)
 274       , match_fun_(match_fun)
 275       , clean_fun_(clean_fun)
 276       , copy_data_fun_(copy_data_fun)
 277   {
 278   }
 279   void serialize(Simcall& type, char* buffer) override;
 280   CommIsendSimcall* clone() override
 281   {
 282     return new CommIsendSimcall(get_issuer(), mbox_, payload_size_, rate_, src_buff_, src_buff_size_, match_fun_,
 283                                 clean_fun_, copy_data_fun_, payload_, detached_);
 284   }
 285   bool is_visible() const override { return true; }
 286   bool depends(SimcallObserver* other) override;
 287   std::string dot_label(int times_considered) const override
 288   {
 289     return SimcallObserver::dot_label(times_considered) + "iSend";
 290   }
 291   activity::MailboxImpl* get_mailbox() const { return mbox_; }
 292   double get_payload_size() const { return payload_size_; }
 293   double get_rate() const { return rate_; }
 294   unsigned char* get_src_buff() const { return src_buff_; }
 295   size_t get_src_buff_size() const { return src_buff_size_; }
 296   void* get_payload() const { return payload_; }
 297   bool is_detached() const { return detached_; }
 298 };
 299
 300 class CommIrecvSimcall : public SimcallObserver {
 301   activity::MailboxImpl* mbox_;
 302   unsigned char* dst_buff_;
 303   size_t* dst_buff_size_;
 304   void* payload_;
 305   double rate_;
 306
 307 public:
 308   bool (*match_fun_)(void*, void*, activity::CommImpl*);
 309   void (*copy_data_fun_)(activity::CommImpl*, void*, size_t); // used to copy data if not default one
 310
 311   CommIrecvSimcall(ActorImpl* actor, activity::MailboxImpl* mbox, unsigned char* dst_buff, size_t* dst_buff_size,
 312                    bool (*match_fun)(void*, void*, activity::CommImpl*),
 313                    void (*copy_data_fun)(activity::CommImpl*, void*, size_t), void* payload, double rate)
 314       : SimcallObserver(actor)
 315       , mbox_(mbox)
 316       , dst_buff_(dst_buff)
 317       , dst_buff_size_(dst_buff_size)
 318       , payload_(payload)
 319       , rate_(rate)
 320       , match_fun_(match_fun)
 321       , copy_data_fun_(copy_data_fun)
 322   {
 323   }
 324   CommIrecvSimcall* clone() override
 325   {
 326     return new CommIrecvSimcall(get_issuer(), mbox_, dst_buff_, dst_buff_size_, match_fun_, copy_data_fun_, payload_,
 327                                 rate_);
 328   }
 329   void serialize(Simcall& type, char* buffer) override;
 330   bool is_visible() const override { return true; }
 331   bool depends(SimcallObserver* other) override;
 332   std::string dot_label(int times_considered) const override
 333   {
 334     return SimcallObserver::dot_label(times_considered) + "iRecv";
 335   }
 336   activity::MailboxImpl* get_mailbox() const { return mbox_; }
 337   double get_rate() const { return rate_; }
 338   unsigned char* get_dst_buff() const { return dst_buff_; }
 339   size_t* get_dst_buff_size() const { return dst_buff_size_; }
 340   void* get_payload() const { return payload_; }
 341 };
 342
 343 } // namespace actor
 344 } // namespace kernel
 345 } // namespace simgrid
 346
 347 #endif