1 /* Copyright (c) 2006-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 #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 "src/kernel/actor/SimcallObserver.hpp"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
19 xbt::signal<void(Exec const&)> Exec::on_start;
20 xbt::signal<void(Exec const&)> Exec::on_completion;
22 Exec::Exec(kernel::activity::ExecImplPtr pimpl)
27 void Exec::complete(Activity::State state)
29 Activity::complete(state);
35 auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
36 return ExecPtr(pimpl->get_iface());
41 kernel::actor::simcall([this] {
42 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
44 .set_tracing_category(get_tracing_category())
51 state_ = State::STARTED;
56 ssize_t Exec::wait_any_for(const std::vector<ExecPtr>& execs, double timeout)
58 std::vector<kernel::activity::ExecImpl*> rexecs(execs.size());
59 std::transform(begin(execs), end(execs), begin(rexecs),
60 [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
62 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
63 kernel::actor::ExecutionWaitanySimcall observer{issuer, rexecs, timeout};
64 ssize_t changed_pos = kernel::actor::simcall_blocking(
66 kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(), observer.get_timeout());
69 if (changed_pos != -1)
70 execs.at(changed_pos)->complete(State::FINISHED);
74 /** @brief change the execution bound
75 * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
76 * deliver. Currently, this cannot be changed once the exec started.
78 ExecPtr Exec::set_bound(double bound)
80 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
81 "Cannot change the bound of an exec after its start");
82 kernel::actor::simcall(
83 [this, bound] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bound(bound); });
87 /** @brief Change the execution priority, don't you think?
89 * An execution with twice the priority will get twice the amount of flops when the resource is shared.
90 * The default priority is 1.
92 * Currently, this cannot be changed once the exec started. */
93 ExecPtr Exec::set_priority(double priority)
95 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
96 "Cannot change the priority of an exec after its start");
97 kernel::actor::simcall([this, priority] {
98 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_sharing_penalty(1. / priority);
103 ExecPtr Exec::set_flops_amount(double flops_amount)
105 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
106 "Cannot change the flop_amount of an exec after its start");
107 kernel::actor::simcall([this, flops_amount] {
108 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amount(flops_amount);
110 Activity::set_remaining(flops_amount);
114 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
116 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
117 "Cannot change the flops_amounts of an exec after its start");
118 kernel::actor::simcall([this, flops_amounts] {
119 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amounts(flops_amounts);
125 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
127 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
128 "Cannot change the bytes_amounts of an exec after its start");
129 kernel::actor::simcall([this, bytes_amounts] {
130 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bytes_amounts(bytes_amounts);
136 /** @brief Retrieve the host on which this activity takes place.
137 * If it runs on more than one host, only the first host is returned.
139 Host* Exec::get_host() const
141 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
143 unsigned int Exec::get_host_number() const
145 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
148 double Exec::get_start_time() const
150 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_start_time();
153 double Exec::get_finish_time() const
155 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_finish_time();
158 /** @brief Change the host on which this activity takes place.
160 * The activity cannot be terminated already (but it may be started). */
161 ExecPtr Exec::set_host(Host* host)
163 xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
164 "Cannot change the host of an exec once it's done (state: %s)", to_c_str(state_));
166 if (state_ == State::STARTED)
167 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
169 kernel::actor::simcall(
170 [this, host] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host); });
172 if (state_ == State::STARTING)
173 // Setting the host may allow to start the activity, let's try
179 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
181 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
182 "Cannot change the hosts of an exec once it's done (state: %s)", to_c_str(state_));
184 kernel::actor::simcall(
185 [this, hosts] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_hosts(hosts); });
188 // Setting the host may allow to start the activity, let's try
189 if (state_ == State::STARTING)
195 double Exec::get_cost() const
197 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
200 double Exec::get_remaining() const
203 XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
204 return get_remaining_ratio();
206 return kernel::actor::simcall(
207 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
210 /** @brief Returns the ratio of elements that are still to do
212 * The returned value is between 0 (completely done) and 1 (nothing done yet).
214 double Exec::get_remaining_ratio() const
217 return kernel::actor::simcall(
218 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
220 return kernel::actor::simcall(
221 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
224 bool Exec::is_assigned() const
226 return not boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_hosts().empty();
229 } // namespace simgrid
231 /* **************************** Public C interface *************************** */
232 void sg_exec_set_bound(sg_exec_t exec, double bound)
234 exec->set_bound(bound);
237 const char* sg_exec_get_name(const_sg_exec_t exec)
239 return exec->get_cname();
242 void sg_exec_set_name(sg_exec_t exec, const char* name)
244 exec->set_name(name);
247 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
249 exec->set_host(new_host);
252 double sg_exec_get_remaining(const_sg_exec_t exec)
254 return exec->get_remaining();
257 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
259 return exec->get_remaining_ratio();
262 void sg_exec_start(sg_exec_t exec)
264 exec->vetoable_start();
267 void sg_exec_cancel(sg_exec_t exec)
273 int sg_exec_test(sg_exec_t exec)
275 bool finished = exec->test();
281 sg_error_t sg_exec_wait(sg_exec_t exec)
283 return sg_exec_wait_for(exec, -1.0);
286 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
288 sg_error_t status = SG_OK;
290 simgrid::s4u::ExecPtr s4u_exec(exec, false);
292 s4u_exec->wait_for(timeout);
293 } catch (const simgrid::TimeoutException&) {
294 s4u_exec->add_ref(); // the wait_for timeouted, keep the exec alive
295 status = SG_ERROR_TIMEOUT;
296 } catch (const simgrid::CancelException&) {
297 status = SG_ERROR_CANCELED;
298 } catch (const simgrid::HostFailureException&) {
299 status = SG_ERROR_HOST;
304 ssize_t sg_exec_wait_any(sg_exec_t* execs, size_t count)
306 return sg_exec_wait_any_for(execs, count, -1.0);
309 ssize_t sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
311 std::vector<simgrid::s4u::ExecPtr> s4u_execs;
312 for (size_t i = 0; i < count; i++)
313 s4u_execs.emplace_back(execs[i], false);
315 ssize_t pos = simgrid::s4u::Exec::wait_any_for(s4u_execs, timeout);
316 for (size_t i = 0; i < count; i++) {
317 if (pos != -1 && static_cast<size_t>(pos) != i)
318 s4u_execs[i]->add_ref();