-/* Copyright (c) 2019-2021. 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. */
#define SIMGRID_MC_SIMCALL_OBSERVER_HPP
#include "simgrid/forward.h"
+#include "src/mc/transition/Transition.hpp"
+#include "xbt/asserts.h"
#include <string>
+#include <unordered_map>
-namespace simgrid {
-namespace kernel {
-namespace actor {
+namespace simgrid::kernel::actor {
class SimcallObserver {
- kernel::actor::ActorImpl* const issuer_;
+ ActorImpl* const issuer_;
+
+protected:
+ ~SimcallObserver() = default;
public:
- explicit SimcallObserver(kernel::actor::ActorImpl* issuer) : issuer_(issuer) {}
- kernel::actor::ActorImpl* get_issuer() const { return issuer_; }
+ explicit SimcallObserver(ActorImpl* issuer) : issuer_(issuer) {}
+ ActorImpl* get_issuer() const { return issuer_; }
/** Whether this transition can currently be taken without blocking.
*
* For example, a mutex_lock is not enabled when the mutex is not free.
* A comm_receive is not enabled before the corresponding send has been issued.
*/
- virtual bool is_enabled() const { return true; }
+ virtual bool is_enabled() { return true; }
/** 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
{ /* Nothing to do by default */
}
- /** Some simcalls may only be observable under some circumstances.
- * Most simcalls are not visible from the MC because they don't have an observer at all. */
- virtual bool is_visible() const { return true; }
- virtual std::string to_string(int times_considered) const = 0;
- virtual std::string dot_label() const = 0;
-};
+ /** Serialize to the given string buffer, to send over the network */
+ virtual void serialize(std::stringstream& stream) const = 0;
-class RandomSimcall : public SimcallObserver {
- const int min_;
- const int max_;
- int next_value_ = 0;
+ /** Used to debug (to display the simcall on which each actor is blocked when displaying it */
+ virtual std::string to_string() const = 0;
-public:
- RandomSimcall(smx_actor_t actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max) {}
- int get_max_consider() const override;
- void prepare(int times_considered) override;
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
- int get_value() const { return next_value_; }
+ /** 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; }
};
-class MutexUnlockSimcall : public SimcallObserver {
- using SimcallObserver::SimcallObserver;
+template <class T> class ResultingSimcall : public SimcallObserver {
+ T result_;
+
+protected:
+ ~ResultingSimcall() = default;
public:
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
+ 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 MutexLockSimcall : public SimcallObserver {
- kernel::activity::MutexImpl* const mutex_;
- const bool blocking_;
+class RandomSimcall final : public SimcallObserver {
+ const int min_;
+ const int max_;
+ int next_value_ = 0;
public:
- MutexLockSimcall(smx_actor_t actor, kernel::activity::MutexImpl* mutex, bool blocking = true)
- : SimcallObserver(actor), mutex_(mutex), blocking_(blocking)
+ RandomSimcall(ActorImpl* actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max)
{
+ xbt_assert(min <= max);
}
- bool is_enabled() const override;
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
- kernel::activity::MutexImpl* get_mutex() const { return mutex_; }
+ 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 : public SimcallObserver {
- friend kernel::activity::ConditionVariableImpl;
-
- kernel::activity::ConditionVariableImpl* const cond_;
- kernel::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_;
- bool result_ = false; // default result for simcall, will be set to 'true' on timeout
-
- void set_result(bool res) { result_ = res; }
public:
- ConditionWaitSimcall(smx_actor_t actor, kernel::activity::ConditionVariableImpl* cond,
- kernel::activity::MutexImpl* mutex, double timeout = -1.0)
- : SimcallObserver(actor), cond_(cond), mutex_(mutex), timeout_(timeout)
- {
- }
- bool is_enabled() const override;
- bool is_visible() const override { return false; }
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
- kernel::activity::ConditionVariableImpl* get_cond() const { return cond_; }
- kernel::activity::MutexImpl* get_mutex() const { return mutex_; }
- double get_timeout() const { return 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;
- bool get_result() const { return result_; }
+ s4u::ActorPtr get_other_actor() const { return other_; }
+ double get_timeout() const { return timeout_; }
};
-class SemAcquireSimcall : public SimcallObserver {
- friend kernel::activity::SemaphoreImpl;
-
- kernel::activity::SemaphoreImpl* const sem_;
- const double timeout_;
- bool result_ = false; // default result for simcall, will be set to 'true' on timeout
-
- void set_result(bool res) { result_ = res; }
+class ActorSleepSimcall final : public SimcallObserver {
public:
- SemAcquireSimcall(smx_actor_t actor, kernel::activity::SemaphoreImpl* sem, double timeout = -1.0)
- : SimcallObserver(actor), sem_(sem), timeout_(timeout)
- {
- }
- bool is_enabled() const override;
- bool is_visible() const override { return false; }
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
- kernel::activity::SemaphoreImpl* get_sem() const { return sem_; }
- double get_timeout() const { return timeout_; }
-
- bool get_result() const { return result_; }
+ explicit ActorSleepSimcall(ActorImpl* actor) : SimcallObserver(actor) {}
+ void serialize(std::stringstream& stream) const override;
+ std::string to_string() const override;
};
-class ExecutionWaitanySimcall : public SimcallObserver {
- friend kernel::activity::ExecImpl;
-
- const std::vector<kernel::activity::ExecImpl*>* const execs_;
- const double timeout_;
- int result_ = -1; // default result for simcall
-
- void set_result(int res) { result_ = res; }
+class ObjectAccessSimcallObserver final : public SimcallObserver {
+ ObjectAccessSimcallItem* const object_;
public:
- ExecutionWaitanySimcall(smx_actor_t actor, const std::vector<kernel::activity::ExecImpl*>* execs, double timeout)
- : SimcallObserver(actor), execs_(execs), timeout_(timeout)
+ ObjectAccessSimcallObserver(ActorImpl* actor, ObjectAccessSimcallItem* object)
+ : SimcallObserver(actor), object_(object)
{
}
- bool is_visible() const override { return false; }
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
- const std::vector<kernel::activity::ExecImpl*>* get_execs() const { return execs_; }
- double get_timeout() const { return 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; }
- int get_result() const { return result_; }
+ 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
