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::on_start;
16 xbt::signal<void(Actor 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());
51 Exec* Exec::wait_for(double)
58 simix::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
59 state_ = State::CANCELED;
63 void intrusive_ptr_release(simgrid::s4u::Exec* e)
65 if (e->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
66 std::atomic_thread_fence(std::memory_order_acquire);
71 void intrusive_ptr_add_ref(simgrid::s4u::Exec* e)
73 e->refcount_.fetch_add(1, std::memory_order_relaxed);
76 /** @brief change the execution bound
77 * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
78 * deliver. Currently, this cannot be changed once the exec started.
80 ExecPtr Exec::set_bound(double bound)
82 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
86 ExecPtr Exec::set_timeout(double timeout)
88 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
93 ExecPtr Exec::set_name(const std::string& name)
95 xbt_assert(state_ == State::INITED, "Cannot change the name of an exec after its start");
100 /** @brief Change the execution priority, don't you think?
102 * An execution with twice the priority will get twice the amount of flops when the resource is shared.
103 * The default priority is 1.
105 * Currently, this cannot be changed once the exec started. */
106 ExecPtr Exec::set_priority(double priority)
108 xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
109 priority_ = priority;
113 ExecPtr Exec::set_tracing_category(const std::string& category)
115 xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start");
116 tracing_category_ = category;
120 ///////////// SEQUENTIAL EXECUTIONS ////////
121 ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
123 Activity::set_remaining(flops_amount_);
124 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->set_host(host);
127 Exec* ExecSeq::start()
129 simix::simcall([this] {
130 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)
132 ->set_tracing_category(tracing_category_)
133 ->start(flops_amount_, 1. / priority_, bound_);
135 state_ = State::STARTED;
136 on_start(*Actor::self());
140 /** @brief Returns whether the state of the exec is finished */
141 /** @brief Change the host on which this activity takes place.
143 * The activity cannot be terminated already (but it may be started). */
144 ExecPtr ExecSeq::set_host(Host* host)
146 xbt_assert(state_ == State::INITED || state_ == State::STARTED,
147 "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
148 if (state_ == State::STARTED)
149 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->migrate(host);
151 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->host_ = host;
156 /** @brief Retrieve the host on which this activity takes place. */
157 Host* ExecSeq::get_host()
162 /** @brief Returns the amount of flops that remain to be done */
163 double ExecSeq::get_remaining()
165 return simgrid::simix::simcall(
166 [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
169 /** @brief Returns the ratio of elements that are still to do
171 * The returned value is between 0 (completely done) and 1 (nothing done yet).
173 double ExecSeq::get_remaining_ratio()
175 return simgrid::simix::simcall([this]() {
176 return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio();
180 ///////////// PARALLEL EXECUTIONS ////////
181 ExecPar::ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
182 const std::vector<double>& bytes_amounts)
183 : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts)
185 // For parallel executions, we need a special host to run the timeout detector.
186 host_ = hosts.front();
187 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->host_ = host_;
190 Exec* ExecPar::start()
192 simix::simcall([this] {
193 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_timeout(timeout_);
194 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->start(hosts_, flops_amounts_, bytes_amounts_);
196 state_ = State::STARTED;
197 on_start(*Actor::self());
200 double ExecPar::get_remaining_ratio()
202 return simix::simcall(
203 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
206 double ExecPar::get_remaining()
208 XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
209 return get_remaining_ratio();
212 } // namespace simgrid