1 /* Copyright (c) 2017-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_S4U_EXEC_HPP
7 #define SIMGRID_S4U_EXEC_HPP
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Activity.hpp>
11 #include <simgrid/s4u/Actor.hpp>
14 namespace simgrid::s4u {
16 /** Computation Activity, representing the asynchronous executions.
19 * Most of them are created with :cpp:func:`simgrid::s4u::this_actor::exec_init()` or
20 * :cpp:func:`simgrid::s4u::Host::execute()`, and represent a classical (sequential) execution. This can be used to
21 * simulate some computation occurring in another thread when the calling actor is not blocked during the execution.
23 * You can also use :cpp:func:`simgrid::s4u::this_actor::parallel_execute()` to create *parallel* executions. These
24 * objects represent distributed computations involving computations on several hosts and communications between them.
25 * Such objects can for example represent a matrix multiplication done with ScaLAPACK on a real system. Once created,
26 * parallel Exec are very similar to the sequential ones. The only difference is that you cannot migrate them, and their
27 * remaining amount of work can only be defined as a ratio. See the doc of :cpp:func:`simgrid::s4u::Exec::get_remaining`
28 * and :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio` for more info.
31 class XBT_PUBLIC Exec : public Activity_T<Exec> {
33 friend kernel::activity::ExecImpl;
34 friend kernel::EngineImpl; // Auto-completes the execs of maestro (in simDAG)
37 bool parallel_ = false;
40 explicit Exec(kernel::activity::ExecImplPtr pimpl);
41 Exec* do_start() override;
45 static xbt::signal<void(Exec const&)> on_start;
46 void fire_on_completion() const override { on_completion(*this); }
47 void fire_on_veto() const override { on_veto(const_cast<Exec&>(*this)); }
48 void fire_on_suspend() const override { on_suspend(*this); }
49 void fire_on_resume() const override { on_resume(*this); }
53 Exec(Exec const&) = delete;
54 Exec& operator=(Exec const&) = delete;
56 /*! Signal fired each time that an execution actually starts (no veto) */
57 static void on_start_cb(const std::function<void(Exec const&)>& cb) { on_start.connect(cb); }
59 static ExecPtr init();
61 /*! take a vector of s4u::ExecPtr and return when one of them is finished.
62 * The return value is the rank of the first finished ExecPtr. */
63 static ssize_t wait_any(const std::vector<ExecPtr>& execs) { return wait_any_for(execs, -1); }
64 /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
65 static ssize_t wait_any_for(const std::vector<ExecPtr>& execs, double timeout);
67 /** @brief On sequential executions, returns the amount of flops that remain to be done; This cannot be used on
68 * parallel executions. */
69 double get_remaining() const override;
70 double get_remaining_ratio() const;
71 ExecPtr set_host(Host* host);
72 ExecPtr set_hosts(const std::vector<Host*>& hosts);
74 ExecPtr unset_hosts() { return unset_host(); }
76 ExecPtr set_flops_amount(double flops_amount);
77 ExecPtr set_flops_amounts(const std::vector<double>& flops_amounts);
78 ExecPtr set_bytes_amounts(const std::vector<double>& bytes_amounts);
80 ExecPtr set_thread_count(int thread_count);
82 ExecPtr set_bound(double bound);
83 ExecPtr set_priority(double priority);
84 ExecPtr update_priority(double priority);
86 Host* get_host() const;
87 unsigned int get_host_number() const;
88 int get_thread_count() const;
89 double get_cost() const;
90 bool is_parallel() const { return parallel_; }
91 bool is_assigned() const override;
94 } // namespace simgrid::s4u
96 #endif /* SIMGRID_S4U_EXEC_HPP */