1 /* Copyright (c) 2006-2023. 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/simix.hpp"
7 #include <simgrid/Exception.hpp>
8 #include <simgrid/exec.h>
9 #include <simgrid/s4u/ActivitySet.hpp>
10 #include <simgrid/s4u/Exec.hpp>
11 #include <simgrid/s4u/Host.hpp>
13 #include "src/kernel/activity/ExecImpl.hpp"
14 #include "src/kernel/actor/ActorImpl.hpp"
15 #include "src/kernel/actor/SimcallObserver.hpp"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
19 namespace simgrid::s4u {
21 Exec::Exec(kernel::activity::ExecImplPtr pimpl)
26 void Exec::reset() const
28 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->reset();
33 auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
34 return ExecPtr(static_cast<Exec*>(pimpl->get_iface()));
37 Exec* Exec::do_start()
39 kernel::actor::simcall_answered([this] {
40 (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
42 .set_tracing_category(get_tracing_category())
49 state_ = State::STARTED;
55 ssize_t Exec::deprecated_wait_any_for(const std::vector<ExecPtr>& execs, double timeout) // XBT_ATTRIB_DEPRECATED_v339
60 for (const auto& exec : execs)
63 auto* ret = set.wait_any_for(timeout).get();
64 for (size_t i = 0; i < execs.size(); i++)
65 if (execs[i].get() == ret)
68 } catch (TimeoutException& e) {
74 /** @brief change the execution bound
75 * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
76 * deliver. Currently, this cannot be changed once the exec started.
78 ExecPtr Exec::set_bound(double bound)
80 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
81 "Cannot change the bound of an exec after its start");
82 kernel::actor::simcall_object_access(pimpl_.get(), [this, bound] {
83 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bound(bound);
88 /** @brief Change the execution priority, don't you think?
90 * An execution with twice the priority will get twice the amount of flops when the resource is shared.
91 * The default priority is 1.
93 * Currently, this cannot be changed once the exec started. */
94 ExecPtr Exec::set_priority(double priority)
96 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
97 "Cannot change the priority of an exec after its start");
98 kernel::actor::simcall_object_access(pimpl_.get(), [this, priority] {
99 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_sharing_penalty(1. / priority);
104 ExecPtr Exec::update_priority(double priority)
106 kernel::actor::simcall_answered([this, priority] {
107 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->update_sharing_penalty(1. / priority);
112 ExecPtr Exec::set_flops_amount(double flops_amount)
114 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
115 "Cannot change the flop_amount of an exec after its start");
116 kernel::actor::simcall_object_access(pimpl_.get(), [this, flops_amount] {
117 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amount(flops_amount);
119 set_remaining(flops_amount);
123 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
125 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
126 "Cannot change the flops_amounts of an exec after its start");
127 kernel::actor::simcall_object_access(pimpl_.get(), [this, flops_amounts] {
128 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amounts(flops_amounts);
134 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
136 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
137 "Cannot change the bytes_amounts of an exec after its start");
138 kernel::actor::simcall_object_access(pimpl_.get(), [this, bytes_amounts] {
139 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bytes_amounts(bytes_amounts);
145 ExecPtr Exec::set_thread_count(int thread_count)
147 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
148 "Cannot change the bytes_amounts of an exec after its start");
149 kernel::actor::simcall_object_access(pimpl_.get(), [this, thread_count] {
150 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_thread_count(thread_count);
155 /** @brief Retrieve the host on which this activity takes place.
156 * If it runs on more than one host, only the first host is returned.
158 Host* Exec::get_host() const
160 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
162 unsigned int Exec::get_host_number() const
164 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
167 int Exec::get_thread_count() const
169 return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_thread_count();
172 /** @brief Change the host on which this activity takes place.
174 * The activity cannot be terminated already (but it may be started). */
175 ExecPtr Exec::set_host(Host* host)
177 xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
178 "Cannot change the host of an exec once it's done (state: %s)", to_c_str(state_));
180 if (state_ == State::STARTED)
181 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
183 kernel::actor::simcall_object_access(
184 pimpl_.get(), [this, host] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host); });
186 if (state_ == State::STARTING)
187 // Setting the host may allow to start the activity, let's try
193 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
195 xbt_assert(state_ == State::INITED || state_ == State::STARTING,
196 "Cannot change the hosts of an exec once it's done (state: %s)", to_c_str(state_));
198 kernel::actor::simcall_object_access(pimpl_.get(), [this, hosts] {
199 boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_hosts(hosts);
203 // Setting the host may allow to start the activity, let's try
204 if (state_ == State::STARTING)
210 ExecPtr Exec::unset_host()
212 if (not is_assigned())
213 throw std::invalid_argument(
214 xbt::string_printf("Exec %s: the activity is not assigned to any host(s)", get_cname()));
218 if (state_ == State::STARTED)
226 double Exec::get_cost() const
228 return (pimpl_->model_action_ == nullptr) ? -1 : pimpl_->model_action_->get_cost();
231 double Exec::get_remaining() const
234 XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
235 return get_remaining_ratio();
237 return kernel::actor::simcall_answered(
238 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
241 /** @brief Returns the ratio of elements that are still to do
243 * The returned value is between 0 (completely done) and 1 (nothing done yet).
245 double Exec::get_remaining_ratio() const
248 return kernel::actor::simcall_answered(
249 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
251 return kernel::actor::simcall_answered(
252 [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
255 bool Exec::is_assigned() const
257 return not boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_hosts().empty();
259 } // namespace simgrid::s4u
261 /* **************************** Public C interface *************************** */
262 int sg_exec_isinstance(sg_activity_t acti)
264 return dynamic_cast<simgrid::s4u::Exec*>(acti) != nullptr;
267 void sg_exec_set_bound(sg_exec_t exec, double bound)
269 exec->set_bound(bound);
272 const char* sg_exec_get_name(const_sg_exec_t exec)
274 return exec->get_cname();
277 void sg_exec_set_name(sg_exec_t exec, const char* name)
279 exec->set_name(name);
282 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
284 exec->set_host(new_host);
287 double sg_exec_get_remaining(const_sg_exec_t exec)
289 return exec->get_remaining();
292 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
294 return exec->get_remaining_ratio();
297 void sg_exec_start(sg_exec_t exec)
302 void sg_exec_cancel(sg_exec_t exec)
308 int sg_exec_test(sg_exec_t exec)
310 bool finished = exec->test();
316 sg_error_t sg_exec_wait(sg_exec_t exec)
318 return sg_exec_wait_for(exec, -1.0);
321 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
323 sg_error_t status = SG_OK;
325 simgrid::s4u::ExecPtr s4u_exec(exec, false);
327 s4u_exec->wait_for(timeout);
328 } catch (const simgrid::TimeoutException&) {
329 s4u_exec->add_ref(); // the wait_for timeouted, keep the exec alive
330 status = SG_ERROR_TIMEOUT;
331 } catch (const simgrid::CancelException&) {
332 status = SG_ERROR_CANCELED;
333 } catch (const simgrid::HostFailureException&) {
334 status = SG_ERROR_HOST;
339 ssize_t sg_exec_wait_any(sg_exec_t* execs, size_t count) // XBT_ATTRIB_DEPRECATED_v339
341 std::vector<simgrid::s4u::ExecPtr> s4u_execs;
342 for (size_t i = 0; i < count; i++)
343 s4u_execs.emplace_back(execs[i], false);
345 ssize_t pos = simgrid::s4u::Exec::deprecated_wait_any_for(s4u_execs, -1.0);
346 for (size_t i = 0; i < count; i++) {
347 if (pos != -1 && static_cast<size_t>(pos) != i)
348 s4u_execs[i]->add_ref();
353 ssize_t sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout) // XBT_ATTRIB_DEPRECATED_v339
355 std::vector<simgrid::s4u::ExecPtr> s4u_execs;
356 for (size_t i = 0; i < count; i++)
357 s4u_execs.emplace_back(execs[i], false);
359 ssize_t pos = simgrid::s4u::Exec::deprecated_wait_any_for(s4u_execs, timeout);
360 for (size_t i = 0; i < count; i++) {
361 if (pos != -1 && static_cast<size_t>(pos) != i)
362 s4u_execs[i]->add_ref();