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)
29 auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
30 return ExecPtr(pimpl->get_iface());
35 kernel::actor::simcall([this] {
36 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
38 .set_tracing_category(get_tracing_category())
45 state_ = State::STARTED;
46 start_time_ = pimpl_->surf_action_->get_start_time();
53 return this->wait_for(-1);
56 Exec* Exec::wait_for(double timeout)
58 if (state_ == State::INITED)
61 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
62 kernel::actor::simcall_blocking([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
63 state_ = State::FINISHED;
65 this->release_dependencies();
69 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
71 std::vector<kernel::activity::ExecImpl*> rexecs(execs->size());
72 std::transform(begin(*execs), end(*execs), begin(rexecs),
73 [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
75 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
76 kernel::actor::ExecutionWaitanySimcall observer{issuer, rexecs, timeout};
77 int changed_pos = kernel::actor::simcall_blocking(
79 kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(), observer.get_timeout());
82 if (changed_pos != -1) {
83 on_completion(*(execs->at(changed_pos)));
84 execs->at(changed_pos)->release_dependencies();
91 kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
92 state_ = State::CANCELED;
97 /** @brief change the execution bound
98 * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
99 * deliver. Currently, this cannot be changed once the exec started.
101 ExecPtr Exec::set_bound(double bound)
103 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
104 "Cannot change the bound of an exec after its start");
105 kernel::actor::simcall(
106 [this, bound] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bound(bound); });
110 /** @brief Change the execution priority, don't you think?
112 * An execution with twice the priority will get twice the amount of flops when the resource is shared.
113 * The default priority is 1.
115 * Currently, this cannot be changed once the exec started. */
116 ExecPtr Exec::set_priority(double priority)
118 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
119 "Cannot change the priority of an exec after its start");
120 kernel::actor::simcall([this, priority] {
121 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_sharing_penalty(1. / priority);
126 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
128 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
129 "Cannot change the bound of an exec after its start");
130 kernel::actor::simcall(
131 [this, timeout] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_timeout(timeout); });
135 ExecPtr Exec::set_flops_amount(double flops_amount)
137 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
138 "Cannot change the flop_amount of an exec after its start");
139 kernel::actor::simcall([this, flops_amount] {
140 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amount(flops_amount);
142 Activity::set_remaining(flops_amount);
146 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
148 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
149 "Cannot change the flops_amounts of an exec after its start");
150 kernel::actor::simcall([this, flops_amounts] {
151 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amounts(flops_amounts);
157 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
159 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
160 "Cannot change the bytes_amounts of an exec after its start");
161 kernel::actor::simcall([this, bytes_amounts] {
162 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bytes_amounts(bytes_amounts);
168 /** @brief Retrieve the host on which this activity takes place.
169 * If it runs on more than one host, only the first host is returned.
171 Host* Exec::get_host() const
173 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
175 unsigned int Exec::get_host_number() const
177 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
180 /** @brief Change the host on which this activity takes place.
182 * The activity cannot be terminated already (but it may be started). */
183 ExecPtr Exec::set_host(Host* host)
185 xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
186 "Cannot change the host of an exec once it's done (state: %s)", to_c_str(state_));
188 if (state_ == State::STARTED)
189 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
191 kernel::actor::simcall(
192 [this, host] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host); });
194 if (state_ == State::STARTING)
195 // Setting the host may allow to start the activity, let's try
201 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
203 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
204 "Cannot change the hosts of an exec once it's done (state: %s)", to_c_str(state_));
206 kernel::actor::simcall(
207 [this, hosts] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_hosts(hosts); });
210 // Setting the host may allow to start the activity, let's try
211 if (state_ == State::STARTING)
217 double Exec::get_cost() const
219 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
222 double Exec::get_remaining() const
225 XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
226 return get_remaining_ratio();
228 return kernel::actor::simcall(
229 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
232 /** @brief Returns the ratio of elements that are still to do
234 * The returned value is between 0 (completely done) and 1 (nothing done yet).
236 double Exec::get_remaining_ratio() const
239 return kernel::actor::simcall(
240 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
242 return kernel::actor::simcall(
243 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
246 bool Exec::is_assigned() const
248 return not boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_hosts().empty();
251 } // namespace simgrid
253 /* **************************** Public C interface *************************** */
254 void sg_exec_set_bound(sg_exec_t exec, double bound)
256 exec->set_bound(bound);
259 const char* sg_exec_get_name(const_sg_exec_t exec)
261 return exec->get_cname();
264 void sg_exec_set_name(sg_exec_t exec, const char* name)
266 exec->set_name(name);
269 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
271 exec->set_host(new_host);
274 double sg_exec_get_remaining(const_sg_exec_t exec)
276 return exec->get_remaining();
279 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
281 return exec->get_remaining_ratio();
284 void sg_exec_start(sg_exec_t exec)
286 exec->vetoable_start();
289 void sg_exec_cancel(sg_exec_t exec)
295 int sg_exec_test(sg_exec_t exec)
297 bool finished = exec->test();
303 sg_error_t sg_exec_wait(sg_exec_t exec)
305 sg_error_t status = SG_OK;
307 simgrid::s4u::ExecPtr s4u_exec(exec, false);
309 s4u_exec->wait_for(-1);
310 } catch (const simgrid::TimeoutException&) {
311 status = SG_ERROR_TIMEOUT;
312 } catch (const simgrid::CancelException&) {
313 status = SG_ERROR_CANCELED;
314 } catch (const simgrid::HostFailureException&) {
315 status = SG_ERROR_HOST;
320 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
322 sg_error_t status = SG_OK;
324 simgrid::s4u::ExecPtr s4u_exec(exec, false);
326 s4u_exec->wait_for(timeout);
327 } catch (const simgrid::TimeoutException&) {
328 status = SG_ERROR_TIMEOUT;
329 } catch (const simgrid::CancelException&) {
330 status = SG_ERROR_CANCELED;
331 } catch (const simgrid::HostFailureException&) {
332 status = SG_ERROR_HOST;
337 int sg_exec_wait_any(sg_exec_t* execs, size_t count)
339 return sg_exec_wait_any_for(execs, count, -1);
342 int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
344 std::vector<simgrid::s4u::ExecPtr> s4u_execs;
345 for (unsigned int i = 0; i < count; i++)
346 s4u_execs.emplace_back(execs[i], false);
348 int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
349 for (unsigned i = 0; i < count; i++) {
350 if (pos != -1 && static_cast<unsigned>(pos) != i)
351 s4u_execs[i]->add_ref();