Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
227ab302c3dd7e1a704af33d5bbc9325e7793693
[simgrid.git] / src / s4u / s4u_Exec.cpp
1 /* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "simgrid/s4u/Actor.hpp"
7 #include "simgrid/s4u/Exec.hpp"
8 #include "src/kernel/activity/ExecImpl.hpp"
9 #include "xbt/log.h"
10
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
12
13 namespace simgrid {
14 namespace s4u {
15 xbt::signal<void(Actor const&, Exec const&)> Exec::on_start;
16 xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion;
17
18 Exec::Exec()
19 {
20   pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
21 }
22
23 Exec* Exec::wait()
24 {
25   return this->wait_for(-1);
26 }
27
28 Exec* Exec::wait_for(double timeout)
29 {
30   if (state_ == State::INITED)
31     vetoable_start();
32
33   kernel::actor::ActorImpl* issuer = Actor::self()->get_impl();
34   kernel::actor::simcall_blocking<void>([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
35   state_ = State::FINISHED;
36   on_completion(*Actor::self(), *this);
37   this->release_dependencies();
38   return this;
39 }
40
41 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
42 {
43   std::unique_ptr<kernel::activity::ExecImpl* []> rexecs(new kernel::activity::ExecImpl*[execs->size()]);
44   std::transform(begin(*execs), end(*execs), rexecs.get(),
45                  [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
46
47   int changed_pos = simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
48   if (changed_pos != -1)
49     execs->at(changed_pos)->release_dependencies();
50   return changed_pos;
51 }
52
53 Exec* Exec::cancel()
54 {
55   kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
56   state_ = State::CANCELED;
57   return this;
58 }
59
60 /** @brief change the execution bound
61  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
62  * deliver. Currently, this cannot be changed once the exec started.
63  */
64 ExecPtr Exec::set_bound(double bound)
65 {
66   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
67   bound_ = bound;
68   return this;
69 }
70 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
71 {
72   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
73   timeout_ = timeout;
74   return this;
75 }
76
77 /** @brief Retrieve the host on which this activity takes place.
78  *  If it runs on more than one host, only the first host is returned.
79  */
80 Host* Exec::get_host() const
81 {
82   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
83 }
84 unsigned int Exec::get_host_number() const
85 {
86   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
87 }
88 double Exec::get_start_time() const
89 {
90   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
91 }
92 double Exec::get_finish_time() const
93 {
94   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
95 }
96 double Exec::get_cost() const
97 {
98   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
99 }
100
101 /** @brief  Change the execution priority, don't you think?
102  *
103  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
104  * The default priority is 1.
105  *
106  * Currently, this cannot be changed once the exec started. */
107 ExecPtr Exec::set_priority(double priority)
108 {
109   xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
110   priority_ = priority;
111   return this;
112 }
113
114 ///////////// SEQUENTIAL EXECUTIONS ////////
115 ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
116 {
117   Activity::set_remaining(flops_amount_);
118   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
119 }
120
121 Exec* ExecSeq::start()
122 {
123   kernel::actor::simcall([this] {
124     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
125         .set_name(get_name())
126         .set_tracing_category(get_tracing_category())
127         .set_sharing_penalty(1. / priority_)
128         .set_bound(bound_)
129         .set_flops_amount(flops_amount_)
130         .start();
131   });
132   state_ = State::STARTED;
133   on_start(*Actor::self(), *this);
134   return this;
135 }
136
137 /** @brief Returns whether the state of the exec is finished */
138 /** @brief Change the host on which this activity takes place.
139  *
140  * The activity cannot be terminated already (but it may be started). */
141 ExecPtr ExecSeq::set_host(Host* host)
142 {
143   xbt_assert(state_ == State::INITED || state_ == State::STARTED,
144              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
145   if (state_ == State::STARTED)
146     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
147   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
148   return this;
149 }
150
151 double ExecSeq::get_remaining() const
152 {
153   return kernel::actor::simcall(
154       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
155 }
156
157 /** @brief Returns the ratio of elements that are still to do
158  *
159  * The returned value is between 0 (completely done) and 1 (nothing done yet).
160  */
161 double ExecSeq::get_remaining_ratio() const
162 {
163   return kernel::actor::simcall(
164       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
165 }
166
167 ///////////// PARALLEL EXECUTIONS ////////
168 ExecPar::ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
169                  const std::vector<double>& bytes_amounts)
170     : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts)
171 {
172 }
173
174 Exec* ExecPar::start()
175 {
176   kernel::actor::simcall([this] {
177     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
178         .set_hosts(hosts_)
179         .set_timeout(timeout_)
180         .set_flops_amounts(flops_amounts_)
181         .set_bytes_amounts(bytes_amounts_)
182         .start();
183   });
184   state_ = State::STARTED;
185   on_start(*Actor::self(), *this);
186   return this;
187 }
188
189 double ExecPar::get_remaining_ratio() const
190 {
191   return kernel::actor::simcall(
192       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
193 }
194
195 double ExecPar::get_remaining() const
196 {
197   XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
198   return get_remaining_ratio();
199 }
200 } // namespace s4u
201 } // namespace simgrid