Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use functions from ActorImpl when available.
[simgrid.git] / src / s4u / s4u_Exec.cpp
1 /* Copyright (c) 2006-2021. 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/Exception.hpp"
7 #include "simgrid/exec.h"
8 #include "simgrid/s4u/Actor.hpp"
9 #include "simgrid/s4u/Exec.hpp"
10 #include "src/kernel/activity/ExecImpl.hpp"
11 #include "src/kernel/actor/ActorImpl.hpp"
12 #include "xbt/log.h"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
15
16 namespace simgrid {
17 namespace s4u {
18 xbt::signal<void(Exec const&)> Exec::on_start;
19 xbt::signal<void(Exec const&)> Exec::on_completion;
20
21 Exec::Exec(kernel::activity::ExecImplPtr pimpl)
22 {
23   pimpl_ = pimpl;
24 }
25
26 ExecPtr Exec::init()
27 {
28   auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
29   return ExecPtr(pimpl->get_iface());
30 }
31
32 Exec* Exec::wait()
33 {
34   return this->wait_for(-1);
35 }
36
37 Exec* Exec::wait_for(double timeout)
38 {
39   if (state_ == State::INITED)
40     vetoable_start();
41
42   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
43   kernel::actor::simcall_blocking<void>([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
44   state_ = State::FINISHED;
45   on_completion(*this);
46   this->release_dependencies();
47   return this;
48 }
49
50 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
51 {
52   std::vector<kernel::activity::ExecImpl*> rexecs(execs->size());
53   std::transform(begin(*execs), end(*execs), begin(rexecs),
54                  [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
55
56   int changed_pos = simcall_execution_waitany_for(rexecs.data(), rexecs.size(), timeout);
57   if (changed_pos != -1) {
58     on_completion(*(execs->at(changed_pos)));
59     execs->at(changed_pos)->release_dependencies();
60   }
61   return changed_pos;
62 }
63
64 Exec* Exec::cancel()
65 {
66   kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
67   state_ = State::CANCELED;
68   on_completion(*this);
69   return this;
70 }
71
72 /** @brief change the execution bound
73  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
74  * deliver. Currently, this cannot be changed once the exec started.
75  */
76 ExecPtr Exec::set_bound(double bound)
77 {
78   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
79       "Cannot change the bound of an exec after its start");
80   bound_ = bound;
81   return this;
82 }
83 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
84 {
85   xbt_assert(state_ == State::INITED|| state_ == State::STARTING,
86       "Cannot change the bound of an exec after its start");
87   timeout_ = timeout;
88   return this;
89 }
90
91 ExecPtr Exec::set_flops_amount(double flops_amount)
92 {
93   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
94       "Cannot change the flop_amount of an exec after its start");
95   flops_amounts_.assign(1, flops_amount);
96   Activity::set_remaining(flops_amounts_.front());
97   return this;
98 }
99
100 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
101 {
102   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
103       "Cannot change the flops_amounts of an exec after its start");
104   flops_amounts_ = flops_amounts;
105   parallel_      = true;
106   return this;
107 }
108
109 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
110 {
111   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
112       "Cannot change the bytes_amounts of an exec after its start");
113   bytes_amounts_ = bytes_amounts;
114   parallel_      = true;
115   return this;
116 }
117
118 /** @brief Retrieve the host on which this activity takes place.
119  *  If it runs on more than one host, only the first host is returned.
120  */
121 Host* Exec::get_host() const
122 {
123   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
124 }
125 unsigned int Exec::get_host_number() const
126 {
127   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
128 }
129 double Exec::get_cost() const
130 {
131   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
132 }
133
134 /** @brief  Change the execution priority, don't you think?
135  *
136  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
137  * The default priority is 1.
138  *
139  * Currently, this cannot be changed once the exec started. */
140 ExecPtr Exec::set_priority(double priority)
141 {
142   xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
143   priority_ = priority;
144   return this;
145 }
146
147 /** @brief Change the host on which this activity takes place.
148  *
149  * The activity cannot be terminated already (but it may be started). */
150 ExecPtr Exec::set_host(Host* host)
151 {
152   xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
153              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
154   hosts_.assign(1, host);
155
156   if (state_ == State::STARTED)
157     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
158
159   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
160
161   if (state_ == State::STARTING)
162   // Setting the host may allow to start the activity, let's try
163     vetoable_start();
164
165   return this;
166 }
167
168 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
169 {
170   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
171       "Cannot change the hosts of an exec once it's done (state: %d)", (int)state_);
172
173   hosts_    = hosts;
174   parallel_ = true;
175
176   // Setting the host may allow to start the activity, let's try
177   if (state_ == State::STARTING)
178      vetoable_start();
179
180   return this;
181 }
182
183 Exec* Exec::start()
184 {
185   if (is_parallel())
186     kernel::actor::simcall([this] {
187       (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
188           .set_hosts(hosts_)
189           .set_timeout(timeout_)
190           .set_flops_amounts(flops_amounts_)
191           .set_bytes_amounts(bytes_amounts_)
192           .start();
193     });
194   else
195     kernel::actor::simcall([this] {
196       (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
197           .set_name(get_name())
198           .set_tracing_category(get_tracing_category())
199           .set_sharing_penalty(1. / priority_)
200           .set_bound(bound_)
201           .set_flops_amount(flops_amounts_.front())
202           .start();
203     });
204
205   if (suspended_)
206     pimpl_->suspend();
207
208   state_ = State::STARTED;
209   start_time_ = pimpl_->surf_action_->get_start_time();
210   on_start(*this);
211   return this;
212 }
213
214 double Exec::get_remaining() const
215 {
216   if (is_parallel()) {
217     XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
218     return get_remaining_ratio();
219   } else
220     return kernel::actor::simcall(
221         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
222 }
223
224 /** @brief Returns the ratio of elements that are still to do
225  *
226  * The returned value is between 0 (completely done) and 1 (nothing done yet).
227  */
228 double Exec::get_remaining_ratio() const
229 {
230   if (is_parallel())
231     return kernel::actor::simcall(
232         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
233   else
234     return kernel::actor::simcall(
235         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
236 }
237
238 } // namespace s4u
239 } // namespace simgrid
240
241 /* **************************** Public C interface *************************** */
242 void sg_exec_set_bound(sg_exec_t exec, double bound)
243 {
244   exec->set_bound(bound);
245 }
246
247 const char* sg_exec_get_name(const_sg_exec_t exec)
248 {
249   return exec->get_cname();
250 }
251
252 void sg_exec_set_name(sg_exec_t exec, const char* name)
253 {
254   exec->set_name(name);
255 }
256
257 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
258 {
259   exec->set_host(new_host);
260 }
261
262 double sg_exec_get_remaining(const_sg_exec_t exec)
263 {
264   return exec->get_remaining();
265 }
266
267 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
268 {
269   return exec->get_remaining_ratio();
270 }
271
272 void sg_exec_start(sg_exec_t exec)
273 {
274   exec->vetoable_start();
275 }
276
277 void sg_exec_cancel(sg_exec_t exec)
278 {
279   exec->cancel();
280   exec->unref();
281 }
282
283 int sg_exec_test(sg_exec_t exec)
284 {
285   bool finished = exec->test();
286   if (finished)
287     exec->unref();
288   return finished;
289 }
290
291 sg_error_t sg_exec_wait(sg_exec_t exec)
292 {
293   sg_error_t status = SG_OK;
294
295   simgrid::s4u::ExecPtr s4u_exec(exec, false);
296   try {
297     s4u_exec->wait_for(-1);
298   } catch (const simgrid::TimeoutException&) {
299     status = SG_ERROR_TIMEOUT;
300   } catch (const simgrid::CancelException&) {
301     status = SG_ERROR_CANCELED;
302   } catch (const simgrid::HostFailureException&) {
303     status = SG_ERROR_HOST;
304   }
305   return status;
306 }
307
308 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
309 {
310   sg_error_t status = SG_OK;
311
312   simgrid::s4u::ExecPtr s4u_exec(exec, false);
313   try {
314     s4u_exec->wait_for(timeout);
315   } catch (const simgrid::TimeoutException&) {
316     status = SG_ERROR_TIMEOUT;
317   } catch (const simgrid::CancelException&) {
318     status = SG_ERROR_CANCELED;
319   } catch (const simgrid::HostFailureException&) {
320     status = SG_ERROR_HOST;
321   }
322   return status;
323 }
324
325 int sg_exec_wait_any(sg_exec_t* execs, size_t count)
326 {
327   return sg_exec_wait_any_for(execs, count, -1);
328 }
329
330 int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
331 {
332   std::vector<simgrid::s4u::ExecPtr> s4u_execs;
333   for (unsigned int i = 0; i < count; i++)
334     s4u_execs.emplace_back(execs[i], false);
335
336   int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
337   for (unsigned i = 0; i < count; i++) {
338     if (pos != -1 && static_cast<unsigned>(pos) != i)
339       s4u_execs[i]->add_ref();
340   }
341   return pos;
342 }