1 /* Copyright (c) 2006-2019. 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/s4u/Actor.hpp"
7 #include "simgrid/s4u/Exec.hpp"
8 #include "src/kernel/activity/ExecImpl.hpp"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
15 xbt::signal<void(Actor const&, Exec const&)> Exec::on_start;
16 xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion;
20 pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
25 xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
27 if (state_ == State::FINISHED)
30 if (state_ == State::INITED)
33 if (simcall_execution_test(pimpl_)) {
34 state_ = State::FINISHED;
43 if (state_ == State::INITED)
45 simcall_execution_wait(pimpl_);
46 state_ = State::FINISHED;
47 on_completion(*Actor::self(), *this);
51 Exec* Exec::wait_for(double)
56 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
58 std::unique_ptr<kernel::activity::ExecImpl* []> rexecs(new kernel::activity::ExecImpl*[execs->size()]);
59 std::transform(begin(*execs), end(*execs), rexecs.get(),
60 [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
61 return simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
66 kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
67 state_ = State::CANCELED;
71 void intrusive_ptr_release(simgrid::s4u::Exec* e)
73 if (e->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
74 std::atomic_thread_fence(std::memory_order_acquire);
79 void intrusive_ptr_add_ref(simgrid::s4u::Exec* e)
81 e->refcount_.fetch_add(1, std::memory_order_relaxed);
84 /** @brief change the execution bound
85 * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
86 * deliver. Currently, this cannot be changed once the exec started.
88 ExecPtr Exec::set_bound(double bound)
90 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
94 ExecPtr Exec::set_timeout(double timeout)
96 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
101 ExecPtr Exec::set_name(const std::string& name)
103 xbt_assert(state_ == State::INITED, "Cannot change the name of an exec after its start");
108 Host* Exec::get_host() const
110 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
112 unsigned int Exec::get_host_number() const
114 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
116 double Exec::get_start_time() const
118 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
120 double Exec::get_finish_time() const
122 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
124 double Exec::get_cost() const
126 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
129 /** @brief Change the execution priority, don't you think?
131 * An execution with twice the priority will get twice the amount of flops when the resource is shared.
132 * The default priority is 1.
134 * Currently, this cannot be changed once the exec started. */
135 ExecPtr Exec::set_priority(double priority)
137 xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
138 priority_ = priority;
142 ExecPtr Exec::set_tracing_category(const std::string& category)
144 xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start");
145 tracing_category_ = category;
149 ///////////// SEQUENTIAL EXECUTIONS ////////
150 ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
152 Activity::set_remaining(flops_amount_);
153 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->set_host(host);
156 Exec* ExecSeq::start()
158 kernel::actor::simcall([this] {
159 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
161 .set_tracing_category(tracing_category_)
162 .set_sharing_penalty(1. / priority_)
164 .set_flops_amount(flops_amount_)
167 state_ = State::STARTED;
168 on_start(*Actor::self(), *this);
172 /** @brief Returns whether the state of the exec is finished */
173 /** @brief Change the host on which this activity takes place.
175 * The activity cannot be terminated already (but it may be started). */
176 ExecPtr ExecSeq::set_host(Host* host)
178 xbt_assert(state_ == State::INITED || state_ == State::STARTED,
179 "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
180 if (state_ == State::STARTED)
181 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->migrate(host);
183 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->set_host(host);
188 /** @brief Retrieve the host on which this activity takes place. */
189 Host* ExecSeq::get_host()
194 /** @brief Returns the amount of flops that remain to be done */
195 double ExecSeq::get_remaining()
197 return simgrid::kernel::actor::simcall(
198 [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
201 /** @brief Returns the ratio of elements that are still to do
203 * The returned value is between 0 (completely done) and 1 (nothing done yet).
205 double ExecSeq::get_remaining_ratio()
207 return simgrid::kernel::actor::simcall([this]() {
208 return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio();
212 ///////////// PARALLEL EXECUTIONS ////////
213 ExecPar::ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
214 const std::vector<double>& bytes_amounts)
215 : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts)
219 Exec* ExecPar::start()
221 kernel::actor::simcall([this] {
222 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
224 .set_timeout(timeout_)
225 .set_flops_amounts(flops_amounts_)
226 .set_bytes_amounts(bytes_amounts_)
229 state_ = State::STARTED;
230 on_start(*Actor::self(), *this);
234 double ExecPar::get_remaining_ratio()
236 return kernel::actor::simcall(
237 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
240 double ExecPar::get_remaining()
242 XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
243 return get_remaining_ratio();
246 } // namespace simgrid