-/* Copyright (c) 2019-2021. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2019-2022. 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>
* 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 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() const { return 1; }
+ virtual int get_max_consider() { return 1; }
/** Prepares the simcall to be used.
*
{ /* Nothing to do by default */
}
- /** Some simcalls may only be observable under some circumstances.
+ /** Computes the dependency relation */
+ virtual bool depends(SimcallObserver* other);
+
+ /** Serialize to the given string buffer */
+ virtual void serialize(std::stringstream& stream) const;
+
+ /** 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. */
virtual bool is_visible() const { return true; }
- virtual std::string to_string(int times_considered) const = 0;
- virtual std::string dot_label() const = 0;
};
template <class T> class ResultingSimcall : public SimcallObserver {
T result_;
public:
- ResultingSimcall(smx_actor_t actor, T default_result) : SimcallObserver(actor), result_(default_result) {}
+ 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_; }
};
int next_value_ = 0;
public:
- RandomSimcall(smx_actor_t actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max) {}
- int get_max_consider() const override;
+ RandomSimcall(ActorImpl* actor, int min, int max) : SimcallObserver(actor), min_(min), max_(max)
+ {
+ xbt_assert(min < max);
+ }
+ void serialize(std::stringstream& stream) const override;
+ int get_max_consider() 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_; }
+ bool depends(SimcallObserver* other) override;
};
-class MutexUnlockSimcall : public SimcallObserver {
- using SimcallObserver::SimcallObserver;
+class MutexSimcall : public SimcallObserver {
+ activity::MutexImpl* const mutex_;
public:
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
+ MutexSimcall(ActorImpl* actor, activity::MutexImpl* mutex) : SimcallObserver(actor), mutex_(mutex) {}
+ activity::MutexImpl* get_mutex() const { return mutex_; }
+ bool depends(SimcallObserver* other) override;
};
-class MutexLockSimcall : public SimcallObserver {
- activity::MutexImpl* const mutex_;
+class MutexUnlockSimcall : public MutexSimcall {
+ using MutexSimcall::MutexSimcall;
+};
+
+class MutexLockSimcall : public MutexSimcall {
const bool blocking_;
public:
- MutexLockSimcall(smx_actor_t actor, activity::MutexImpl* mutex, bool blocking = true)
- : SimcallObserver(actor), mutex_(mutex), blocking_(blocking)
+ MutexLockSimcall(ActorImpl* actor, activity::MutexImpl* mutex, bool blocking = true)
+ : MutexSimcall(actor, mutex), blocking_(blocking)
{
}
- bool is_enabled() const override;
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
- activity::MutexImpl* get_mutex() const { return mutex_; }
+ bool is_enabled() override;
};
class ConditionWaitSimcall : public ResultingSimcall<bool> {
const double timeout_;
public:
- ConditionWaitSimcall(smx_actor_t actor, activity::ConditionVariableImpl* cond, activity::MutexImpl* mutex,
+ ConditionWaitSimcall(ActorImpl* actor, activity::ConditionVariableImpl* cond, activity::MutexImpl* mutex,
double timeout = -1.0)
: ResultingSimcall(actor, false), cond_(cond), mutex_(mutex), timeout_(timeout)
{
}
- bool is_enabled() const override;
+ bool is_enabled() override;
bool is_visible() const override { return false; }
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
activity::ConditionVariableImpl* get_cond() const { return cond_; }
activity::MutexImpl* get_mutex() const { return mutex_; }
double get_timeout() const { return timeout_; }
const double timeout_;
public:
- SemAcquireSimcall(smx_actor_t actor, activity::SemaphoreImpl* sem, double timeout = -1.0)
+ SemAcquireSimcall(ActorImpl* actor, activity::SemaphoreImpl* sem, double timeout = -1.0)
: ResultingSimcall(actor, false), sem_(sem), timeout_(timeout)
{
}
- bool is_enabled() const override;
+ bool is_enabled() override;
bool is_visible() const override { return false; }
- std::string to_string(int times_considered) const override;
- std::string dot_label() const override;
activity::SemaphoreImpl* get_sem() const { return sem_; }
double get_timeout() const { return timeout_; }
};
-class ExecutionWaitanySimcall : public ResultingSimcall<int> {
- const std::vector<activity::ExecImpl*>& execs_;
+class ActivityTestSimcall : public ResultingSimcall<bool> {
+ activity::ActivityImpl* const activity_;
+
+public:
+ ActivityTestSimcall(ActorImpl* actor, activity::ActivityImpl* activity)
+ : ResultingSimcall(actor, true), activity_(activity)
+ {
+ }
+ bool is_visible() const override { return true; }
+ activity::ActivityImpl* get_activity() const { return activity_; }
+ void serialize(std::stringstream& stream) const override;
+};
+
+class ActivityTestanySimcall : public ResultingSimcall<ssize_t> {
+ const std::vector<activity::ActivityImpl*>& activities_;
+ std::vector<int> indexes_; // indexes in activities_ pointing to ready activities (=whose test() is positive)
+ int next_value_ = 0;
+
+public:
+ ActivityTestanySimcall(ActorImpl* actor, const std::vector<activity::ActivityImpl*>& activities);
+ bool is_visible() const override { return true; }
+ bool is_enabled() override { return true; /* can return -1 if no activity is ready */ }
+ void serialize(std::stringstream& stream) const override;
+ int get_max_consider() override;
+ void prepare(int times_considered) override;
+ const std::vector<activity::ActivityImpl*>& get_activities() const { return activities_; }
+ int get_value() const { return next_value_; }
+};
+
+class ActivityWaitSimcall : public ResultingSimcall<bool> {
+ activity::ActivityImpl* activity_;
const double timeout_;
public:
- ExecutionWaitanySimcall(smx_actor_t actor, const std::vector<activity::ExecImpl*>& execs, double timeout)
- : ResultingSimcall(actor, -1), execs_(execs), timeout_(timeout)
+ ActivityWaitSimcall(ActorImpl* actor, activity::ActivityImpl* activity, double timeout)
+ : ResultingSimcall(actor, false), activity_(activity), timeout_(timeout)
{
}
- 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<activity::ExecImpl*>& get_execs() const { return execs_; }
+ void serialize(std::stringstream& stream) const override;
+ bool is_visible() const override { return true; }
+ bool is_enabled() override;
+ activity::ActivityImpl* get_activity() const { return activity_; }
+ void set_activity(activity::ActivityImpl* activity) { activity_ = activity; }
double get_timeout() const { return timeout_; }
};
-class IoWaitanySimcall : public ResultingSimcall<int> {
- const std::vector<activity::IoImpl*>& ios_;
+class ActivityWaitanySimcall : public ResultingSimcall<ssize_t> {
+ const std::vector<activity::ActivityImpl*>& activities_;
+ std::vector<int> indexes_; // indexes in activities_ pointing to ready activities (=whose test() is positive)
const double timeout_;
+ int next_value_ = 0;
public:
- IoWaitanySimcall(smx_actor_t actor, const std::vector<activity::IoImpl*>& ios, double timeout)
- : ResultingSimcall(actor, -1), ios_(ios), timeout_(timeout)
+ ActivityWaitanySimcall(ActorImpl* actor, const std::vector<activity::ActivityImpl*>& activities, double timeout);
+ bool is_enabled() override;
+ void serialize(std::stringstream& stream) const override;
+ bool is_visible() const override { return true; }
+ void prepare(int times_considered) override;
+ int get_max_consider() override;
+ const std::vector<activity::ActivityImpl*>& get_activities() const { return activities_; }
+ double get_timeout() const { return timeout_; }
+ int get_value() const { return next_value_; }
+};
+
+class CommIsendSimcall : public SimcallObserver {
+ activity::MailboxImpl* mbox_;
+ double payload_size_;
+ double rate_;
+ unsigned char* src_buff_;
+ size_t src_buff_size_;
+ void* payload_;
+ bool detached_;
+ activity::CommImpl* comm_;
+ int tag_;
+
+ 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
+
+public:
+ CommIsendSimcall(ActorImpl* actor, activity::MailboxImpl* mbox, double 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)
+ : SimcallObserver(actor)
+ , 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)
{
}
- 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<activity::IoImpl*>& get_ios() const { return ios_; }
- double get_timeout() const { return timeout_; }
+ void serialize(std::stringstream& stream) const override;
+ bool is_visible() const override { return true; }
+ activity::MailboxImpl* get_mailbox() const { return mbox_; }
+ double 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 set_comm(activity::CommImpl* comm) { comm_ = comm; }
+ void set_tag(int tag) { tag_ = tag; }
+
+ auto get_match_fun() const { return match_fun_; }
+ auto get_clean_fun() const { return clean_fun_; }
+ auto get_copy_data_fun() const { return copy_data_fun_; }
};
+
+class CommIrecvSimcall : public SimcallObserver {
+ activity::MailboxImpl* mbox_;
+ unsigned char* dst_buff_;
+ size_t* dst_buff_size_;
+ void* payload_;
+ double rate_;
+ int tag_;
+ activity::CommImpl* comm_;
+
+ bool (*match_fun_)(void*, void*, activity::CommImpl*);
+ void (*copy_data_fun_)(activity::CommImpl*, void*, size_t); // used to copy data if not default one
+
+public:
+ 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)
+ : SimcallObserver(actor)
+ , 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)
+ {
+ }
+ void serialize(std::stringstream& stream) const override;
+ bool is_visible() const override { return true; }
+ 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_; }
+ void set_comm(activity::CommImpl* comm) { comm_ = comm; }
+ void set_tag(int tag) { tag_ = tag; }
+
+ auto get_match_fun() const { return match_fun_; };
+ auto get_copy_data_fun() const { return copy_data_fun_; }
+};
+
} // namespace actor
} // namespace kernel
} // namespace simgrid
