1 /* Copyright (c) 2006-2020. 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 return this->wait_for(-1);
28 Exec* Exec::wait_for(double timeout)
30 if (state_ == State::INITED)
33 kernel::actor::ActorImpl* issuer = Actor::self()->get_impl();
34 kernel::actor::simcall_blocking<void>([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
35 state_ = State::FINISHED;
36 on_completion(*Actor::self(), *this);
37 this->release_dependencies();
41 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
43 std::unique_ptr<kernel::activity::ExecImpl* []> rexecs(new kernel::activity::ExecImpl*[execs->size()]);
44 std::transform(begin(*execs), end(*execs), rexecs.get(),
45 [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
47 int changed_pos = simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
48 if (changed_pos != -1)
49 execs->at(changed_pos)->release_dependencies();
55 kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
56 state_ = State::CANCELED;
60 /** @brief change the execution bound
61 * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
62 * deliver. Currently, this cannot be changed once the exec started.
64 ExecPtr Exec::set_bound(double bound)
66 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
70 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
72 xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
77 /** @brief Retrieve the host on which this activity takes place.
78 * If it runs on more than one host, only the first host is returned.
80 Host* Exec::get_host() const
82 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
84 unsigned int Exec::get_host_number() const
86 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
88 double Exec::get_start_time() const
90 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
92 double Exec::get_finish_time() const
94 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
96 double Exec::get_cost() const
98 return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
101 /** @brief Change the execution priority, don't you think?
103 * An execution with twice the priority will get twice the amount of flops when the resource is shared.
104 * The default priority is 1.
106 * Currently, this cannot be changed once the exec started. */
107 ExecPtr Exec::set_priority(double priority)
109 xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
110 priority_ = priority;
114 ///////////// SEQUENTIAL EXECUTIONS ////////
115 ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
117 Activity::set_remaining(flops_amount_);
118 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
121 Exec* ExecSeq::start()
123 kernel::actor::simcall([this] {
124 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
125 .set_name(get_name())
126 .set_tracing_category(get_tracing_category())
127 .set_sharing_penalty(1. / priority_)
129 .set_flops_amount(flops_amount_)
132 state_ = State::STARTED;
133 on_start(*Actor::self(), *this);
137 /** @brief Returns whether the state of the exec is finished */
138 /** @brief Change the host on which this activity takes place.
140 * The activity cannot be terminated already (but it may be started). */
141 ExecPtr ExecSeq::set_host(Host* host)
143 xbt_assert(state_ == State::INITED || state_ == State::STARTED,
144 "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
145 if (state_ == State::STARTED)
146 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
147 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
151 double ExecSeq::get_remaining() const
153 return kernel::actor::simcall(
154 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
157 /** @brief Returns the ratio of elements that are still to do
159 * The returned value is between 0 (completely done) and 1 (nothing done yet).
161 double ExecSeq::get_remaining_ratio() const
163 return kernel::actor::simcall(
164 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
167 ///////////// PARALLEL EXECUTIONS ////////
168 ExecPar::ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
169 const std::vector<double>& bytes_amounts)
170 : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts)
174 Exec* ExecPar::start()
176 kernel::actor::simcall([this] {
177 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
179 .set_timeout(timeout_)
180 .set_flops_amounts(flops_amounts_)
181 .set_bytes_amounts(bytes_amounts_)
184 state_ = State::STARTED;
185 on_start(*Actor::self(), *this);
189 double ExecPar::get_remaining_ratio() const
191 return kernel::actor::simcall(
192 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
195 double ExecPar::get_remaining() const
197 XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
198 return get_remaining_ratio();
201 } // namespace simgrid