-/* Copyright (c) 2017-2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2017-2021. 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 <simgrid/forward.h>
#include <simgrid/s4u/Activity.hpp>
+#include <simgrid/s4u/Actor.hpp>
#include <xbt/ex.h>
-#include <atomic>
-
namespace simgrid {
namespace s4u {
/** Computation Activity, representing the asynchronous executions.
*
- * They are generated from this_actor::exec_init() or Host::execute(), and can be used to model pools of threads or
- * similar mechanisms.
+ * @beginrst
+ * 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 occurring 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 {
- std::string name_ = "";
- double priority_ = 1.0;
- double bound_ = 0.0;
- double timeout_ = 0.0;
- std::string tracing_category_ = "";
- std::atomic_int_fast32_t refcount_{0};
- Host* host_ = nullptr;
+class XBT_PUBLIC Exec : public Activity_T<Exec> {
+ friend kernel::activity::ExecImpl;
+ bool parallel_ = false;
+ double start_time_ = -1.0;
+ double finish_time_ = -1.0;
protected:
- Exec();
- virtual ~Exec() = default;
+ explicit Exec(kernel::activity::ExecImplPtr pimpl);
+
+ void complete(Activity::State state) override;
public:
#ifndef DOXYGEN
Exec(Exec const&) = delete;
Exec& operator=(Exec const&) = delete;
#endif
+ static xbt::signal<void(Exec const&)> on_start;
+ static xbt::signal<void(Exec const&)> on_completion;
- friend ExecSeq;
- friend ExecPar;
- friend XBT_PUBLIC void intrusive_ptr_release(Exec* e);
- friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
- static xbt::signal<void(ActorPtr)> on_start;
- static xbt::signal<void(ActorPtr)> on_completion;
-
- virtual Exec* start() override = 0;
- virtual double get_remaining_ratio() = 0;
- virtual ExecPtr set_host(Host* host) = 0;
-
- Exec* wait() override;
- Exec* wait_for(double timeout) override;
- bool test() override;
-
- ExecPtr set_bound(double bound);
- ExecPtr set_name(const std::string& name);
- ExecPtr set_priority(double priority);
- ExecPtr set_tracing_category(const std::string& category);
- ExecPtr set_timeout(double timeout);
- Exec* cancel() override;
-
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_priority()") ExecPtr setPriority(double priority)
- {
- return set_priority(priority);
- }
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); }
- XBT_ATTRIB_DEPRECATED_v324("Please use Exec::wait_for()") void wait(double t) override { wait_for(t); }
-};
-
-class XBT_PUBLIC ExecSeq : public Exec {
- double flops_amount_ = 0.0;
-
- explicit ExecSeq(sg_host_t host, double flops_amount);
-
-public:
- friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
-
- ~ExecSeq() = default;
-
+ static ExecPtr init();
Exec* start() override;
- ExecPtr set_host(Host* host) override;
- Host* get_host();
+ /*! 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);
- double get_remaining() override;
- double get_remaining_ratio() override;
+ /** @brief On sequential executions, returns the amount of flops that remain to be done; This cannot be used on
+ * parallel executions. */
+ double get_remaining() const override;
+ double get_remaining_ratio() const;
+ ExecPtr set_host(Host* host);
+ ExecPtr set_hosts(const std::vector<Host*>& hosts);
-#ifndef DOXYGEN
- //////////////// Deprecated functions
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); }
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); }
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio()
- {
- return get_remaining_ratio();
- }
-#endif
-};
+ ExecPtr set_flops_amount(double flops_amount);
+ ExecPtr set_flops_amounts(const std::vector<double>& flops_amounts);
+ ExecPtr set_bytes_amounts(const std::vector<double>& bytes_amounts);
-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* host) override { return this; }
-
-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;
+ 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);
+
+ Host* get_host() const;
+ unsigned int get_host_number() const;
+ double get_start_time() const { return start_time_; }
+ double get_finish_time() const { return finish_time_; }
+ void set_finish_time(double finish_time) { finish_time_ = finish_time; }
+ double get_cost() const;
+ bool is_parallel() const { return parallel_; }
+ bool is_assigned() const override;
};
} // namespace s4u