-/* Copyright (c) 2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2017-2020. 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. */
#ifndef SIMGRID_S4U_EXEC_HPP
#define SIMGRID_S4U_EXEC_HPP
-#include "src/kernel/activity/ExecImpl.hpp"
#include <simgrid/forward.h>
-#include <simgrid/s4u/forward.hpp>
+#include <simgrid/s4u/Activity.hpp>
+#include <simgrid/s4u/Actor.hpp>
+#include <xbt/ex.h>
namespace simgrid {
namespace s4u {
-XBT_PUBLIC_CLASS Exec : public Activity
-{
- Exec() : Activity() {}
+/** Computation Activity, representing the asynchronous executions.
+ *
+ * @rst
+ * Most of them are created with :cpp:func:`simgrid::s4u::this_actor::exec_init()` or
+ * :cpp:func:`simgrid::s4u::Host::execute()`, and represent a classical (sequential) execution. This can be used to
+ * simulate some computation occuring in another thread when the calling actor is not blocked during the execution.
+ *
+ * You can also use :cpp:func:`simgrid::s4u::this_actor::parallel_execute()` to create *parallel* executions. These
+ * objects represent distributed computations involving computations on several hosts and communications between them.
+ * Such objects can for example represent a matrix multiplication done with ScaLAPACK on a real system. Once created,
+ * parallel Exec are very similar to the sequential ones. The only difference is that you cannot migrate them, and their
+ * remaining amount of work can only be defined as a ratio. See the doc of :cpp:func:`simgrid::s4u::Exec::get_remaining`
+ * and :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio` for more info.
+ * @endrst
+ */
+class XBT_PUBLIC Exec : public Activity_T<Exec> {
+ double priority_ = 1.0;
+ double bound_ = 0.0;
+ double timeout_ = 0.0;
+
+protected:
+ Exec();
+
public:
- friend void intrusive_ptr_release(simgrid::s4u::Exec * e)
- {
- if (e->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
- std::atomic_thread_fence(std::memory_order_acquire);
- delete e;
- }
- }
-
- friend void intrusive_ptr_add_ref(simgrid::s4u::Exec * e) { e->refcount_.fetch_add(1, std::memory_order_relaxed); }
-
- friend Actor; // Factory of Exec
-
- ~Exec() = default;
-
- void start()
- {
- pimpl_ = simcall_execution_start(nullptr, flops_amount_, 1 / priority_, 0.);
- state_ = started;
- }
- void wait() override { this->wait(-1); }
- void wait(double timeout) override { simcall_execution_wait(pimpl_); }
-
- double getRemains()
- {
- return simgrid::simix::kernelImmediate(
- [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->remains(); });
- }
-
-private:
- smx_actor_t runner_ = nullptr;
+ virtual ~Exec() = default;
+#ifndef DOXYGEN
+ Exec(Exec const&) = delete;
+ Exec& operator=(Exec const&) = delete;
+
+ friend ExecSeq;
+ friend ExecPar;
+#endif
+ static xbt::signal<void(Actor const&, Exec const&)> on_start;
+ static xbt::signal<void(Actor const&, Exec const&)> on_completion;
+
+ Exec* start() override = 0;
+ /** @brief On sequential executions, returns the amount of flops that remain to be done; This cannot be used on
+ * parallel executions. */
+ virtual double get_remaining_ratio() = 0;
+ virtual ExecPtr set_host(Host* host) = 0;
+
+ Exec* wait() override;
+ Exec* wait_for(double timeout) override;
+ /*! take a vector of s4u::ExecPtr and return when one of them is finished.
+ * The return value is the rank of the first finished ExecPtr. */
+ static int wait_any(std::vector<ExecPtr>* execs) { return wait_any_for(execs, -1); }
+ /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
+ static int wait_any_for(std::vector<ExecPtr>* execs, double timeout);
+
+ bool test() override;
+
+ ExecPtr set_bound(double bound);
+ ExecPtr set_priority(double priority);
+ XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") ExecPtr set_timeout(double timeout);
+ Exec* cancel() override;
+ Host* get_host() const;
+ unsigned int get_host_number() const;
+ double get_start_time() const;
+ double get_finish_time() const;
+ double get_cost() const;
+};
+
+class XBT_PUBLIC ExecSeq : public Exec {
double flops_amount_ = 0.0;
- double priority_ = 1.0;
- double bound_ = 0.0;
- std::atomic_int_fast32_t refcount_{0};
-}; // class
-}
-}; // Namespace simgrid::s4u
+ explicit ExecSeq(sg_host_t host, double flops_amount);
+
+public:
+ friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
+
+ ~ExecSeq() = default;
+
+ Exec* start() override;
+
+ ExecPtr set_host(Host* host) override;
+
+ double get_remaining() override;
+ double get_remaining_ratio() override;
+};
+
+class XBT_PUBLIC ExecPar : public Exec {
+ std::vector<s4u::Host*> hosts_;
+ std::vector<double> flops_amounts_;
+ std::vector<double> bytes_amounts_;
+ explicit ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
+ const std::vector<double>& bytes_amounts);
+ ExecPtr set_host(Host*) override { /* parallel exec cannot be moved */ THROW_UNIMPLEMENTED; }
+
+public:
+ ~ExecPar() = default;
+ friend XBT_PUBLIC ExecPtr this_actor::exec_init(const std::vector<s4u::Host*>& hosts,
+ const std::vector<double>& flops_amounts,
+ const std::vector<double>& bytes_amounts);
+ double get_remaining() override;
+ double get_remaining_ratio() override;
+ Exec* start() override;
+};
+
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_EXEC_HPP */
