X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3dd753cd9e46d794e00629d03183250aec4a17e4..3f9b311ec56db95ec539001a860ae3c838c48312:/src/kernel/actor/SimcallObserver.hpp diff --git a/src/kernel/actor/SimcallObserver.hpp b/src/kernel/actor/SimcallObserver.hpp index a009e6be7f..de3f4fc27c 100644 --- 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. */ @@ -7,17 +7,20 @@ #define SIMGRID_MC_SIMCALL_OBSERVER_HPP #include "simgrid/forward.h" +#include "src/mc/transition/Transition.hpp" #include "xbt/asserts.h" #include +#include -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_; } @@ -26,10 +29,11 @@ public: * 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 @@ -49,30 +53,31 @@ public: { /* Nothing to do by default */ } - /** We need to save the observer of simcalls as they get executed to later compute their dependencies in classical - * DPOR */ - virtual SimcallObserver* clone() = 0; + /** Serialize to the given string buffer, to send over the network */ + virtual void serialize(std::stringstream& stream) const = 0; - /** Computes the dependency relation */ - virtual bool depends(SimcallObserver* other); + /** 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; } - virtual std::string to_string(int times_considered) const = 0; - virtual std::string dot_label(int times_considered) const = 0; }; template class ResultingSimcall : public SimcallObserver { T result_; +protected: + ~ResultingSimcall() = default; + public: 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; @@ -80,266 +85,63 @@ class RandomSimcall : public SimcallObserver { public: RandomSimcall(ActorImpl* actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max) { - xbt_assert(min < max); - } - SimcallObserver* clone() override - { - auto res = new RandomSimcall(get_issuer(), min_, max_); - res->next_value_ = next_value_; - return res; + 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; - std::string to_string(int times_considered) const override; - std::string dot_label(int times_considered) const override; int get_value() const { return next_value_; } - bool depends(SimcallObserver* other) override; -}; - -class MutexSimcall : public SimcallObserver { - activity::MutexImpl* const mutex_; - -public: - MutexSimcall(ActorImpl* actor, activity::MutexImpl* mutex) : SimcallObserver(actor), mutex_(mutex) {} - activity::MutexImpl* get_mutex() const { return mutex_; } - bool depends(SimcallObserver* other) override; }; -class MutexUnlockSimcall : public MutexSimcall { - using MutexSimcall::MutexSimcall; - -public: - SimcallObserver* clone() override { return new MutexUnlockSimcall(get_issuer(), get_mutex()); } - std::string to_string(int times_considered) const override; - std::string dot_label(int times_considered) const override; -}; - -class MutexLockSimcall : public MutexSimcall { - const bool blocking_; - -public: - MutexLockSimcall(ActorImpl* actor, activity::MutexImpl* mutex, bool blocking = true) - : MutexSimcall(actor, mutex), blocking_(blocking) - { - } - SimcallObserver* clone() override { return new MutexLockSimcall(get_issuer(), get_mutex(), blocking_); } - bool is_enabled() const override; - std::string to_string(int times_considered) const override; - std::string dot_label(int times_considered) const override; -}; - -class ConditionWaitSimcall : public ResultingSimcall { - 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) - { - } - SimcallObserver* clone() override { return new ConditionWaitSimcall(get_issuer(), cond_, mutex_, 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(int times_considered) const override; - activity::ConditionVariableImpl* get_cond() const { return cond_; } - activity::MutexImpl* get_mutex() const { return mutex_; } - double get_timeout() const { return timeout_; } -}; - -class SemAcquireSimcall : public ResultingSimcall { - activity::SemaphoreImpl* const sem_; - const double timeout_; - -public: - SemAcquireSimcall(ActorImpl* actor, activity::SemaphoreImpl* sem, double timeout = -1.0) - : ResultingSimcall(actor, false), sem_(sem), timeout_(timeout) - { - } - SimcallObserver* clone() override { return new SemAcquireSimcall(get_issuer(), sem_, 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(int times_considered) const override; - activity::SemaphoreImpl* get_sem() const { return sem_; } - double get_timeout() const { return timeout_; } -}; - -class ActivityTestSimcall : public ResultingSimcall { - activity::ActivityImpl* const activity_; - -public: - ActivityTestSimcall(ActorImpl* actor, activity::ActivityImpl* activity) - : ResultingSimcall(actor, true), activity_(activity) - { - } - SimcallObserver* clone() override { return new ActivityTestSimcall(get_issuer(), activity_); } - bool is_visible() const override { return true; } - bool depends(SimcallObserver* other) override; - std::string to_string(int times_considered) const override; - std::string dot_label(int times_considered) const override; - activity::ActivityImpl* get_activity() const { return activity_; } -}; - -class ActivityTestanySimcall : public ResultingSimcall { - const std::vector& activities_; - int next_value_ = 0; - -public: - ActivityTestanySimcall(ActorImpl* actor, const std::vector& activities) - : ResultingSimcall(actor, -1), activities_(activities) - { - } - SimcallObserver* clone() override { return new ActivityTestanySimcall(get_issuer(), activities_); } - bool is_visible() const override { return true; } - 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(int times_considered) const override; - const std::vector& get_activities() const { return activities_; } - int get_value() const { return next_value_; } -}; + 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 ActivityWaitSimcall : public ResultingSimcall { - activity::ActivityImpl* activity_; - const double timeout_; - -public: - ActivityWaitSimcall(ActorImpl* actor, activity::ActivityImpl* activity, double timeout) - : ResultingSimcall(actor, false), activity_(activity), timeout_(timeout) - { - } - SimcallObserver* clone() override { return new ActivityWaitSimcall(get_issuer(), activity_, timeout_); } - bool is_visible() const override { return true; } - bool is_enabled() const override; - bool depends(SimcallObserver* other) override; - std::string to_string(int times_considered) const override; - std::string dot_label(int times_considered) const override; - activity::ActivityImpl* get_activity() const { return activity_; } - void set_activity(activity::ActivityImpl* activity) { activity_ = activity; } + s4u::ActorPtr get_other_actor() const { return other_; } double get_timeout() const { return timeout_; } }; -class ActivityWaitanySimcall : public ResultingSimcall { - const std::vector& activities_; - const double timeout_; - int next_value_ = 0; +class ActorSleepSimcall final : public SimcallObserver { public: - ActivityWaitanySimcall(ActorImpl* actor, const std::vector& activities, double timeout) - : ResultingSimcall(actor, -1), activities_(activities), timeout_(timeout) - { - } - SimcallObserver* clone() override { return new ActivityWaitanySimcall(get_issuer(), activities_, timeout_); } - bool is_enabled() const override; - bool is_visible() const override { return true; } - void prepare(int times_considered) override; - int get_max_consider() const override; - std::string to_string(int times_considered) const override; - std::string dot_label(int times_considered) const override; - const std::vector& get_activities() const { return activities_; } - double get_timeout() const { return timeout_; } - int get_value() const { return next_value_; } + explicit ActorSleepSimcall(ActorImpl* actor) : SimcallObserver(actor) {} + void serialize(std::stringstream& stream) const override; + std::string to_string() const override; }; -class CommIsendSimcall : public ResultingSimcall { - activity::MailboxImpl* mbox_; - size_t payload_size_; - double rate_; - unsigned char* src_buff_; - size_t src_buff_size_; - void* payload_; - bool detached_; +class ObjectAccessSimcallObserver final : public SimcallObserver { + ObjectAccessSimcallItem* const object_; public: - bool (*match_fun_)(void*, void*, activity::CommImpl*); - void (*clean_fun_)(void*); // used to free the synchro in case of problem after a detached send - void (*copy_data_fun_)(activity::CommImpl*, void*, size_t); // used to copy data if not default one - - CommIsendSimcall(ActorImpl* actor, activity::MailboxImpl* mbox, size_t payload_size, double rate, - unsigned char* src_buff, size_t src_buff_size, bool (*match_fun)(void*, void*, activity::CommImpl*), - void (*clean_fun)(void*), // used to free the synchro in case of problem after a detached send - void (*copy_data_fun)(activity::CommImpl*, void*, size_t), // used to copy data if not default one - void* payload, bool detached) - : ResultingSimcall(actor, nullptr) - , mbox_(mbox) - , payload_size_(payload_size) - , rate_(rate) - , src_buff_(src_buff) - , src_buff_size_(src_buff_size) - , payload_(payload) - , detached_(detached) - , match_fun_(match_fun) - , clean_fun_(clean_fun) - , copy_data_fun_(copy_data_fun) + ObjectAccessSimcallObserver(ActorImpl* actor, ObjectAccessSimcallItem* object) + : SimcallObserver(actor), object_(object) { } - CommIsendSimcall* clone() override - { - return new CommIsendSimcall(get_issuer(), mbox_, payload_size_, rate_, src_buff_, src_buff_size_, match_fun_, - clean_fun_, copy_data_fun_, payload_, detached_); - } - bool is_visible() const override { return true; } - std::string to_string(int times_considered) const override; - std::string dot_label(int times_considered) const override - { - return SimcallObserver::dot_label(times_considered) + "iSend"; - } - activity::MailboxImpl* get_mailbox() const { return mbox_; } - size_t get_payload_size() const { return payload_size_; } - double get_rate() const { return rate_; } - unsigned char* get_src_buff() const { return src_buff_; } - size_t get_src_buff_size() const { return src_buff_size_; } - void* get_payload() const { return payload_; } - bool is_detached() const { return detached_; } -}; + void serialize(std::stringstream& stream) const override; + std::string to_string() const override; + bool is_visible() const override; + bool is_enabled() override { return true; } -class CommIrecvSimcall : public ResultingSimcall { - activity::MailboxImpl* mbox_; - unsigned char* dst_buff_; - size_t* dst_buff_size_; - void* payload_; - double rate_; - -public: - bool (*match_fun_)(void*, void*, activity::CommImpl*); - void (*copy_data_fun_)(activity::CommImpl*, void*, size_t); // used to copy data if not default one - - CommIrecvSimcall(ActorImpl* actor, activity::MailboxImpl* mbox, unsigned char* dst_buff, size_t* dst_buff_size, - bool (*match_fun)(void*, void*, activity::CommImpl*), - void (*copy_data_fun)(activity::CommImpl*, void*, size_t), void* payload, double rate) - : ResultingSimcall(actor, nullptr) - , mbox_(mbox) - , dst_buff_(dst_buff) - , dst_buff_size_(dst_buff_size) - , payload_(payload) - , rate_(rate) - , match_fun_(match_fun) - , copy_data_fun_(copy_data_fun) - { - } - CommIrecvSimcall* clone() override - { - return new CommIrecvSimcall(get_issuer(), mbox_, dst_buff_, dst_buff_size_, match_fun_, copy_data_fun_, payload_, - rate_); - } - bool is_visible() const override { return true; } - std::string to_string(int times_considered) const override; - std::string dot_label(int times_considered) const override - { - return SimcallObserver::dot_label(times_considered) + "iRecv"; - } - activity::MailboxImpl* get_mailbox() const { return mbox_; } - double get_rate() const { return rate_; } - unsigned char* get_dst_buff() const { return dst_buff_; } - size_t* get_dst_buff_size() const { return dst_buff_size_; } - void* get_payload() const { return payload_; } + ActorImpl* get_owner() const; }; -} // namespace actor -} // namespace kernel -} // namespace simgrid +/* Semi private template used by the to_string methods of various observer classes */ +template static std::string ptr_to_id(A* ptr) +{ + static std::unordered_map 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