1 /* Copyright (c) 2006-2020. 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 #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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
17 xbt::signal<void(Actor const&, Exec const&)> Exec::on_start;
18 xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion;
22 pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
27 return this->wait_for(-1);
30 Exec* Exec::wait_for(double timeout)
32 if (state_ == State::INITED)
35 kernel::actor::ActorImpl* issuer = Actor::self()->get_impl();
36 kernel::actor::simcall_blocking<void>([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
37 state_ = State::FINISHED;
38 on_completion(*Actor::self(), *this);
39 this->release_dependencies();
43 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
45 auto rexecs = std::make_unique<kernel::activity::ExecImpl*[]>(execs->size());
46 std::transform(begin(*execs), end(*execs), rexecs.get(),
47 [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
49 int changed_pos = simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
50 if (changed_pos != -1)
51 execs->at(changed_pos)->release_dependencies();
57 kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
58 state_ = State::CANCELED;
62 /** @brief change the execution bound
63 * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
64 * deliver. Currently, this cannot be changed once the exec started.
66 ExecPtr Exec::set_bound(double bound)
68 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
72 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
74 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
79 ExecPtr Exec::set_flops_amount(double flops_amount)
81 xbt_assert(state_ == State::INITED, "Cannot change the flop_amount of an exec after its start");
82 flops_amounts_.assign(1, flops_amount);
83 Activity::set_remaining(flops_amounts_.front());
87 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
89 xbt_assert(state_ == State::INITED, "Cannot change the flops_amounts of an exec after its start");
90 flops_amounts_ = flops_amounts;
95 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
97 xbt_assert(state_ == State::INITED, "Cannot change the bytes_amounts of an exec after its start");
98 bytes_amounts_ = bytes_amounts;
103 /** @brief Retrieve the host on which this activity takes place.
104 * If it runs on more than one host, only the first host is returned.
106 Host* Exec::get_host() const
108 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
110 unsigned int Exec::get_host_number() const
112 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
114 double Exec::get_start_time() const
116 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
118 double Exec::get_finish_time() const
120 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
122 double Exec::get_cost() const
124 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
127 /** @brief Change the execution priority, don't you think?
129 * An execution with twice the priority will get twice the amount of flops when the resource is shared.
130 * The default priority is 1.
132 * Currently, this cannot be changed once the exec started. */
133 ExecPtr Exec::set_priority(double priority)
135 xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
136 priority_ = priority;
140 /** @brief Change the host on which this activity takes place.
142 * The activity cannot be terminated already (but it may be started). */
143 ExecPtr Exec::set_host(Host* host)
145 xbt_assert(state_ == State::INITED || state_ == State::STARTED,
146 "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
147 if (state_ == State::STARTED)
148 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
149 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
153 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
155 xbt_assert(state_ == State::INITED, "Cannot change the hosts of an exec once it's done (state: %d)", (int)state_);
161 ///////////// SEQUENTIAL EXECUTIONS ////////
165 kernel::actor::simcall([this] {
166 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
168 .set_timeout(timeout_)
169 .set_flops_amounts(flops_amounts_)
170 .set_bytes_amounts(bytes_amounts_)
174 kernel::actor::simcall([this] {
175 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
176 .set_name(get_name())
177 .set_tracing_category(get_tracing_category())
178 .set_sharing_penalty(1. / priority_)
180 .set_flops_amount(flops_amounts_.front())
187 state_ = State::STARTED;
188 on_start(*Actor::self(), *this);
192 double Exec::get_remaining() const
195 XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
196 return get_remaining_ratio();
198 return kernel::actor::simcall(
199 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
202 /** @brief Returns the ratio of elements that are still to do
204 * The returned value is between 0 (completely done) and 1 (nothing done yet).
206 double Exec::get_remaining_ratio() const
209 return kernel::actor::simcall(
210 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
212 return kernel::actor::simcall(
213 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
217 } // namespace simgrid
218 /* **************************** Public C interface *************************** */
219 void sg_exec_set_bound(sg_exec_t exec, double bound)
221 exec->set_bound(bound);
224 const char* sg_exec_get_name(const_sg_exec_t exec)
226 return exec->get_cname();
229 void sg_exec_set_name(sg_exec_t exec, const char* name)
231 exec->set_name(name);
234 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
236 exec->set_host(new_host);
239 double sg_exec_get_remaining(const_sg_exec_t exec)
241 return exec->get_remaining();
244 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
246 return exec->get_remaining_ratio();
249 void sg_exec_start(sg_exec_t exec)
254 void sg_exec_cancel(sg_exec_t exec)
260 int sg_exec_test(sg_exec_t exec)
262 bool finished = exec->test();
268 sg_error_t sg_exec_wait(sg_exec_t exec)
270 sg_error_t status = SG_OK;
272 simgrid::s4u::ExecPtr s4u_exec(exec, false);
274 s4u_exec->wait_for(-1);
275 } catch (const simgrid::TimeoutException&) {
276 status = SG_ERROR_TIMEOUT;
277 } catch (const simgrid::CancelException&) {
278 status = SG_ERROR_CANCELED;
279 } catch (const simgrid::HostFailureException&) {
280 status = SG_ERROR_HOST;
285 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
287 sg_error_t status = SG_OK;
289 simgrid::s4u::ExecPtr s4u_exec(exec, false);
291 s4u_exec->wait_for(timeout);
292 } catch (const simgrid::TimeoutException&) {
293 status = SG_ERROR_TIMEOUT;
294 } catch (const simgrid::CancelException&) {
295 status = SG_ERROR_CANCELED;
296 } catch (const simgrid::HostFailureException&) {
297 status = SG_ERROR_HOST;
302 int sg_exec_wait_any(sg_exec_t* execs, size_t count)
304 return sg_exec_wait_any_for(execs, count, -1);
307 int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
309 std::vector<simgrid::s4u::ExecPtr> s4u_execs;
310 for (unsigned int i = 0; i < count; i++)
311 s4u_execs.emplace_back(execs[i], false);
313 int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
314 for (unsigned i = 0; i < count; i++) {
315 if (pos != -1 && static_cast<unsigned>(pos) != i)
316 s4u_execs[i]->add_ref();