1 /* Copyright (c) 2017-2019. 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.
19 * They are generated from this_actor::exec_init() or Host::execute(), and can be used to model pools of threads or
22 class XBT_PUBLIC Exec : public Activity_T<Exec> {
23 double priority_ = 1.0;
25 double timeout_ = 0.0;
31 virtual ~Exec() = default;
33 Exec(Exec const&) = delete;
34 Exec& operator=(Exec const&) = delete;
39 static xbt::signal<void(Actor const&, Exec const&)> on_start;
40 static xbt::signal<void(Actor const&, Exec const&)> on_completion;
42 virtual Exec* start() override = 0;
43 virtual double get_remaining_ratio() = 0;
44 virtual ExecPtr set_host(Host* host) = 0;
46 Exec* wait() override;
47 Exec* wait_for(double timeout) override;
48 /*! take a vector of s4u::ExecPtr and return when one of them is finished.
49 * The return value is the rank of the first finished ExecPtr. */
50 static int wait_any(std::vector<ExecPtr>* execs) { return wait_any_for(execs, -1); }
51 /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
52 static int wait_any_for(std::vector<ExecPtr>* execs, double timeout);
56 ExecPtr set_bound(double bound);
57 ExecPtr set_priority(double priority);
58 ExecPtr set_timeout(double timeout);
59 Exec* cancel() override;
60 Host* get_host() const;
61 unsigned int get_host_number() const;
62 double get_start_time() const;
63 double get_finish_time() const;
64 double get_cost() const;
67 class XBT_PUBLIC ExecSeq : public Exec {
68 double flops_amount_ = 0.0;
70 explicit ExecSeq(sg_host_t host, double flops_amount);
73 friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
77 Exec* start() override;
79 ExecPtr set_host(Host* host) override;
81 double get_remaining() override;
82 double get_remaining_ratio() override;
85 class XBT_PUBLIC ExecPar : public Exec {
86 std::vector<s4u::Host*> hosts_;
87 std::vector<double> flops_amounts_;
88 std::vector<double> bytes_amounts_;
89 explicit ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
90 const std::vector<double>& bytes_amounts);
91 ExecPtr set_host(Host*) override { /* parallel exec cannot be moved */ THROW_UNIMPLEMENTED; }
95 friend XBT_PUBLIC ExecPtr this_actor::exec_init(const std::vector<s4u::Host*>& hosts,
96 const std::vector<double>& flops_amounts,
97 const std::vector<double>& bytes_amounts);
98 double get_remaining() override;
99 double get_remaining_ratio() override;
100 Exec* start() override;
104 } // namespace simgrid
106 #endif /* SIMGRID_S4U_EXEC_HPP */