Various sonar cleanups

[simgrid.git] / src / kernel / actor / SimcallObserver.hpp

diff --git a/src/kernel/actor/SimcallObserver.hpp b/src/kernel/actor/SimcallObserver.hpp
index 909ebd1..de3f4fc 100644 (file)
--- a/src/kernel/actor/SimcallObserver.hpp
+++ b/src/kernel/actor/SimcallObserver.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2019-2022. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2019-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -11,6 +11,7 @@
 #include "xbt/asserts.h"
 
 #include <string>
+#include <unordered_map>
 
 namespace simgrid::kernel::actor {
 
@@ -52,9 +53,12 @@ public:
   { /* Nothing to do by default */
   }
 
-  /** Serialize to the given string buffer */
+  /** Serialize to the given string buffer, to send over the network */
   virtual void serialize(std::stringstream& stream) const = 0;
 
+  /** Used to debug (to display the simcall on which each actor is blocked when displaying it */
+  virtual std::string to_string() const = 0;
+
   /** Whether the MC should see this simcall.
    * Simcall that don't have an observer (ie, most of them) are not visible from the MC, but if there is an observer,
    * they are observable by default. */
@@ -81,44 +85,63 @@ class RandomSimcall final : public SimcallObserver {
 public:
   RandomSimcall(ActorImpl* actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max)
   {
-    xbt_assert(min < max);
+    xbt_assert(min <= max);
   }
   void serialize(std::stringstream& stream) const override;
+  std::string to_string() const override;
   int get_max_consider() const override;
   void prepare(int times_considered) override;
   int get_value() const { return next_value_; }
 };
 
-class ConditionWaitSimcall final : public ResultingSimcall<bool> {
-  activity::ConditionVariableImpl* const cond_;
-  activity::MutexImpl* const mutex_;
+class ActorJoinSimcall final : public SimcallObserver {
+  s4u::ActorPtr const other_; // We need a Ptr to ensure access to the actor after its end, but Ptr requires s4u
   const double timeout_;
 
 public:
-  ConditionWaitSimcall(ActorImpl* actor, activity::ConditionVariableImpl* cond, activity::MutexImpl* mutex,
-                       double timeout = -1.0)
-      : ResultingSimcall(actor, false), cond_(cond), mutex_(mutex), timeout_(timeout)
-  {
-  }
+  ActorJoinSimcall(ActorImpl* actor, ActorImpl* other, double timeout = -1.0);
   void serialize(std::stringstream& stream) const override;
+  std::string to_string() const override;
   bool is_enabled() override;
-  activity::ConditionVariableImpl* get_cond() const { return cond_; }
-  activity::MutexImpl* get_mutex() const { return mutex_; }
+
+  s4u::ActorPtr get_other_actor() const { return other_; }
   double get_timeout() const { return timeout_; }
 };
 
-class ActorJoinSimcall final : public SimcallObserver {
-  s4u::ActorPtr const other_; // We need a Ptr to ensure access to the actor after its end, but Ptr requires s4u
-  const double timeout_;
+class ActorSleepSimcall final : public SimcallObserver {
 
 public:
-  ActorJoinSimcall(ActorImpl* actor, ActorImpl* other, double timeout = -1.0);
+  explicit ActorSleepSimcall(ActorImpl* actor) : SimcallObserver(actor) {}
   void serialize(std::stringstream& stream) const override;
-  bool is_enabled() override;
+  std::string to_string() const override;
+};
 
-  s4u::ActorPtr get_other_actor() const { return other_; }
-  double get_timeout() const { return timeout_; }
+class ObjectAccessSimcallObserver final : public SimcallObserver {
+  ObjectAccessSimcallItem* const object_;
+
+public:
+  ObjectAccessSimcallObserver(ActorImpl* actor, ObjectAccessSimcallItem* object)
+      : SimcallObserver(actor), object_(object)
+  {
+  }
+  void serialize(std::stringstream& stream) const override;
+  std::string to_string() const override;
+  bool is_visible() const override;
+  bool is_enabled() override { return true; }
+
+  ActorImpl* get_owner() const;
 };
+
+/* Semi private template used by the to_string methods of various observer classes */
+template <typename A> static std::string ptr_to_id(A* ptr)
+{
+  static std::unordered_map<A*, std::string> map({{nullptr, "-"}});
+  auto [elm, inserted] = map.try_emplace(ptr);
+  if (inserted)
+    elm->second = std::to_string(map.size() - 1);
+  return elm->second;
+}
+
 } // namespace simgrid::kernel::actor
 
 #endif