1 /* Copyright (c) 2017-2021. 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>
17 /** Computation Activity, representing the asynchronous executions.
20 * Most of them are created with :cpp:func:`simgrid::s4u::this_actor::exec_init()` or
21 * :cpp:func:`simgrid::s4u::Host::execute()`, and represent a classical (sequential) execution. This can be used to
22 * simulate some computation occurring in another thread when the calling actor is not blocked during the execution.
24 * You can also use :cpp:func:`simgrid::s4u::this_actor::parallel_execute()` to create *parallel* executions. These
25 * objects represent distributed computations involving computations on several hosts and communications between them.
26 * Such objects can for example represent a matrix multiplication done with ScaLAPACK on a real system. Once created,
27 * parallel Exec are very similar to the sequential ones. The only difference is that you cannot migrate them, and their
28 * remaining amount of work can only be defined as a ratio. See the doc of :cpp:func:`simgrid::s4u::Exec::get_remaining`
29 * and :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio` for more info.
32 class XBT_PUBLIC Exec : public Activity_T<Exec> {
33 double priority_ = 1.0;
35 double timeout_ = 0.0;
36 std::vector<double> flops_amounts_;
37 std::vector<double> bytes_amounts_;
38 std::vector<Host*> hosts_;
39 bool parallel_ = false;
43 ~Exec() override = default;
45 Exec(Exec const&) = delete;
46 Exec& operator=(Exec const&) = delete;
49 static xbt::signal<void(Exec const&)> on_start;
50 static xbt::signal<void(Exec const&)> on_completion;
52 static ExecPtr init();
53 Exec* start() override;
54 /** @brief On sequential executions, returns the amount of flops that remain to be done; This cannot be used on
55 * parallel executions. */
56 double get_remaining() const override;
57 double get_remaining_ratio() const;
58 ExecPtr set_host(Host* host);
59 ExecPtr set_hosts(const std::vector<Host*>& hosts);
61 ExecPtr set_flops_amount(double flops_amount);
62 ExecPtr set_flops_amounts(const std::vector<double>& flops_amounts);
63 ExecPtr set_bytes_amounts(const std::vector<double>& bytes_amounts);
65 Exec* wait() override;
66 Exec* wait_for(double timeout) override;
67 /*! take a vector of s4u::ExecPtr and return when one of them is finished.
68 * The return value is the rank of the first finished ExecPtr. */
69 static int wait_any(std::vector<ExecPtr>* execs) { return wait_any_for(execs, -1); }
70 /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
71 static int wait_any_for(std::vector<ExecPtr>* execs, double timeout);
73 ExecPtr set_bound(double bound);
74 ExecPtr set_priority(double priority);
75 XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") ExecPtr set_timeout(double timeout);
77 Exec* cancel() override;
78 Host* get_host() const;
79 unsigned int get_host_number() const;
80 double get_start_time() const;
81 double get_finish_time() const;
82 double get_cost() const;
83 bool is_parallel() const { return parallel_; }
84 bool is_assigned() const override { return not hosts_.empty(); }
88 } // namespace simgrid
90 #endif /* SIMGRID_S4U_EXEC_HPP */