-/* 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. */
#include "xbt/asserts.h"
#include <string>
+#include <unordered_map>
-namespace simgrid {
-namespace kernel {
-namespace actor {
+namespace simgrid::kernel::actor {
class SimcallObserver {
ActorImpl* const issuer_;
+protected:
+ ~SimcallObserver() = default;
+
public:
explicit SimcallObserver(ActorImpl* issuer) : issuer_(issuer) {}
ActorImpl* get_issuer() const { return issuer_; }
/** Returns the amount of time that this transition can be used.
*
+ * If it's 0, the transition is not enabled.
* If it's 1 (as with send/wait), there is no need to fork the state space exploration on this point.
* If it's more than one (as with mc_random or waitany), we need to consider this transition several times to start
* differing branches
*/
- virtual int get_max_consider() { return 1; }
+ virtual int get_max_consider() const { return 1; }
/** Prepares the simcall to be used.
*
{ /* Nothing to do by default */
}
- /** Computes the dependency relation */
- virtual bool depends(SimcallObserver* other);
+ /** Serialize to the given string buffer, to send over the network */
+ virtual void serialize(std::stringstream& stream) const = 0;
- /** Serialize to the given string buffer */
- virtual void serialize(std::stringstream& stream) const;
+ /** Used to debug (to display the simcall on which each actor is blocked when displaying it */
+ virtual std::string to_string() const = 0;
- /** Some simcalls may only be observable under some conditions.
- * Most simcalls are not visible from the MC because they don't have an observer at all. */
+ /** 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. */
virtual bool is_visible() const { return true; }
};
template <class T> class ResultingSimcall : public SimcallObserver {
T result_;
+protected:
+ ~ResultingSimcall() = default;
+
public:
- ResultingSimcall() = default;
ResultingSimcall(ActorImpl* actor, T default_result) : SimcallObserver(actor), result_(default_result) {}
void set_result(T res) { result_ = res; }
T get_result() const { return result_; }
};
-class RandomSimcall : public SimcallObserver {
+class RandomSimcall final : public SimcallObserver {
const int min_;
const int max_;
int next_value_ = 0;
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;
- int get_max_consider() 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_; }
- bool depends(SimcallObserver* other) override;
};
-class MutexSimcall : public SimcallObserver {
- 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:
- MutexSimcall(ActorImpl* actor, activity::MutexImpl* mutex) : SimcallObserver(actor), mutex_(mutex) {}
- activity::MutexImpl* get_mutex() const { return mutex_; }
- bool depends(SimcallObserver* other) override;
-};
+ 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;
-class MutexUnlockSimcall : public MutexSimcall {
- using MutexSimcall::MutexSimcall;
+ s4u::ActorPtr get_other_actor() const { return other_; }
+ double get_timeout() const { return timeout_; }
};
-class MutexLockSimcall : public MutexSimcall {
- const bool blocking_;
+class ActorSleepSimcall final : public SimcallObserver {
public:
- MutexLockSimcall(ActorImpl* actor, activity::MutexImpl* mutex, bool blocking = true)
- : MutexSimcall(actor, mutex), blocking_(blocking)
- {
- }
- bool is_enabled() override;
+ explicit ActorSleepSimcall(ActorImpl* actor) : SimcallObserver(actor) {}
+ void serialize(std::stringstream& stream) const override;
+ std::string to_string() const override;
};
-class ConditionWaitSimcall : public ResultingSimcall<bool> {
- activity::ConditionVariableImpl* const cond_;
- activity::MutexImpl* const mutex_;
- const double timeout_;
+class ObjectAccessSimcallObserver final : public SimcallObserver {
+ ObjectAccessSimcallItem* const object_;
public:
- ConditionWaitSimcall(ActorImpl* actor, activity::ConditionVariableImpl* cond, activity::MutexImpl* mutex,
- double timeout = -1.0)
- : ResultingSimcall(actor, false), cond_(cond), mutex_(mutex), timeout_(timeout)
+ ObjectAccessSimcallObserver(ActorImpl* actor, ObjectAccessSimcallItem* object)
+ : SimcallObserver(actor), object_(object)
{
}
- bool is_enabled() override;
- bool is_visible() const override { return false; }
- activity::ConditionVariableImpl* get_cond() const { return cond_; }
- activity::MutexImpl* get_mutex() const { return mutex_; }
- double get_timeout() const { return timeout_; }
-};
-
-class SemAcquireSimcall : public ResultingSimcall<bool> {
- activity::SemaphoreImpl* const sem_;
- const double timeout_;
+ void serialize(std::stringstream& stream) const override;
+ std::string to_string() const override;
+ bool is_visible() const override;
+ bool is_enabled() override { return true; }
-public:
- SemAcquireSimcall(ActorImpl* actor, activity::SemaphoreImpl* sem, double timeout = -1.0)
- : ResultingSimcall(actor, false), sem_(sem), timeout_(timeout)
- {
- }
- bool is_enabled() override;
- bool is_visible() const override { return false; }
- activity::SemaphoreImpl* get_sem() const { return sem_; }
- double get_timeout() const { return timeout_; }
+ ActorImpl* get_owner() const;
};
-} // namespace actor
-} // namespace kernel
-} // namespace simgrid
+/* 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
