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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
17 xbt::signal<void(Exec const&)> Exec::on_start;
18 xbt::signal<void(Exec const&)> Exec::on_completion;
22 pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
27 return ExecPtr(new Exec());
32 return this->wait_for(-1);
35 Exec* Exec::wait_for(double timeout)
37 if (state_ == State::INITED)
40 kernel::actor::ActorImpl* issuer = Actor::self()->get_impl();
41 kernel::actor::simcall_blocking<void>([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
42 state_ = State::FINISHED;
44 this->release_dependencies();
48 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
50 std::vector<kernel::activity::ExecImpl*> rexecs(execs->size());
51 std::transform(begin(*execs), end(*execs), begin(rexecs),
52 [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
54 int changed_pos = simcall_execution_waitany_for(rexecs.data(), rexecs.size(), timeout);
55 if (changed_pos != -1)
56 execs->at(changed_pos)->release_dependencies();
62 kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
63 state_ = State::CANCELED;
67 /** @brief change the execution bound
68 * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
69 * deliver. Currently, this cannot be changed once the exec started.
71 ExecPtr Exec::set_bound(double bound)
73 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
77 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
79 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
84 ExecPtr Exec::set_flops_amount(double flops_amount)
86 xbt_assert(state_ == State::INITED, "Cannot change the flop_amount of an exec after its start");
87 flops_amounts_.assign(1, flops_amount);
88 Activity::set_remaining(flops_amounts_.front());
92 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
94 xbt_assert(state_ == State::INITED, "Cannot change the flops_amounts of an exec after its start");
95 flops_amounts_ = flops_amounts;
100 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
102 xbt_assert(state_ == State::INITED, "Cannot change the bytes_amounts of an exec after its start");
103 bytes_amounts_ = bytes_amounts;
108 /** @brief Retrieve the host on which this activity takes place.
109 * If it runs on more than one host, only the first host is returned.
111 Host* Exec::get_host() const
113 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
115 unsigned int Exec::get_host_number() const
117 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
119 double Exec::get_start_time() const
121 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
123 double Exec::get_finish_time() const
125 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
127 double Exec::get_cost() const
129 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
132 /** @brief Change the execution priority, don't you think?
134 * An execution with twice the priority will get twice the amount of flops when the resource is shared.
135 * The default priority is 1.
137 * Currently, this cannot be changed once the exec started. */
138 ExecPtr Exec::set_priority(double priority)
140 xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
141 priority_ = priority;
145 /** @brief Change the host on which this activity takes place.
147 * The activity cannot be terminated already (but it may be started). */
148 ExecPtr Exec::set_host(Host* host)
150 xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
151 "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
152 hosts_.assign(1, host);
154 if (state_ == State::STARTED)
155 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
157 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
159 if (state_ == State::STARTING)
160 // Setting the host may allow to start the activity, let's try
166 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
168 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
169 "Cannot change the hosts of an exec once it's done (state: %d)", (int)state_);
174 // Setting the host may allow to start the activity, let's try
175 if (state_ == State::STARTING)
181 ///////////// SEQUENTIAL EXECUTIONS ////////
185 kernel::actor::simcall([this] {
186 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
188 .set_timeout(timeout_)
189 .set_flops_amounts(flops_amounts_)
190 .set_bytes_amounts(bytes_amounts_)
194 kernel::actor::simcall([this] {
195 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
196 .set_name(get_name())
197 .set_tracing_category(get_tracing_category())
198 .set_sharing_penalty(1. / priority_)
200 .set_flops_amount(flops_amounts_.front())
207 state_ = State::STARTED;
212 double Exec::get_remaining() const
215 XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
216 return get_remaining_ratio();
218 return kernel::actor::simcall(
219 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
222 /** @brief Returns the ratio of elements that are still to do
224 * The returned value is between 0 (completely done) and 1 (nothing done yet).
226 double Exec::get_remaining_ratio() const
229 return kernel::actor::simcall(
230 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
232 return kernel::actor::simcall(
233 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
237 } // namespace simgrid
238 /* **************************** Public C interface *************************** */
239 void sg_exec_set_bound(sg_exec_t exec, double bound)
241 exec->set_bound(bound);
244 const char* sg_exec_get_name(const_sg_exec_t exec)
246 return exec->get_cname();
249 void sg_exec_set_name(sg_exec_t exec, const char* name)
251 exec->set_name(name);
254 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
256 exec->set_host(new_host);
259 double sg_exec_get_remaining(const_sg_exec_t exec)
261 return exec->get_remaining();
264 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
266 return exec->get_remaining_ratio();
269 void sg_exec_start(sg_exec_t exec)
274 void sg_exec_cancel(sg_exec_t exec)
280 int sg_exec_test(sg_exec_t exec)
282 bool finished = exec->test();
288 sg_error_t sg_exec_wait(sg_exec_t exec)
290 sg_error_t status = SG_OK;
292 simgrid::s4u::ExecPtr s4u_exec(exec, false);
294 s4u_exec->wait_for(-1);
295 } catch (const simgrid::TimeoutException&) {
296 status = SG_ERROR_TIMEOUT;
297 } catch (const simgrid::CancelException&) {
298 status = SG_ERROR_CANCELED;
299 } catch (const simgrid::HostFailureException&) {
300 status = SG_ERROR_HOST;
305 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
307 sg_error_t status = SG_OK;
309 simgrid::s4u::ExecPtr s4u_exec(exec, false);
311 s4u_exec->wait_for(timeout);
312 } catch (const simgrid::TimeoutException&) {
313 status = SG_ERROR_TIMEOUT;
314 } catch (const simgrid::CancelException&) {
315 status = SG_ERROR_CANCELED;
316 } catch (const simgrid::HostFailureException&) {
317 status = SG_ERROR_HOST;
322 int sg_exec_wait_any(sg_exec_t* execs, size_t count)
324 return sg_exec_wait_any_for(execs, count, -1);
327 int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
329 std::vector<simgrid::s4u::ExecPtr> s4u_execs;
330 for (unsigned int i = 0; i < count; i++)
331 s4u_execs.emplace_back(execs[i], false);
333 int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
334 for (unsigned i = 0; i < count; i++) {
335 if (pos != -1 && static_cast<unsigned>(pos) != i)
336 s4u_execs[i]->add_ref();