X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a5c102f3397e8112b97c27981bfdbcaac76d79f6..HEAD:/src/s4u/s4u_Exec.cpp diff --git a/src/s4u/s4u_Exec.cpp b/src/s4u/s4u_Exec.cpp index 89f738684c..caa7466e2c 100644 --- a/src/s4u/s4u_Exec.cpp +++ b/src/s4u/s4u_Exec.cpp @@ -1,76 +1,74 @@ -/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2023. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -#include "simgrid/s4u/Actor.hpp" -#include "simgrid/s4u/Exec.hpp" +#include "simgrid/simix.hpp" +#include +#include +#include +#include +#include + #include "src/kernel/activity/ExecImpl.hpp" -#include "xbt/log.h" +#include "src/kernel/actor/ActorImpl.hpp" +#include "src/kernel/actor/SimcallObserver.hpp" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions"); -namespace simgrid { -namespace s4u { -xbt::signal Exec::on_start; -xbt::signal Exec::on_completion; +namespace simgrid::s4u { -Exec::Exec() +Exec::Exec(kernel::activity::ExecImplPtr pimpl) { - pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl()); + pimpl_ = pimpl; } -bool Exec::test() +void Exec::reset() const { - xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED); - - if (state_ == State::FINISHED) - return true; - - if (state_ == State::INITED) - this->start(); - - if (simcall_execution_test(pimpl_)) { - state_ = State::FINISHED; - return true; - } - - return false; + boost::static_pointer_cast(pimpl_)->reset(); } -Exec* Exec::wait() +ExecPtr Exec::init() { - if (state_ == State::INITED) - start(); - simcall_execution_wait(pimpl_); - state_ = State::FINISHED; - on_completion(*Actor::self()); - return this; + auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl()); + return ExecPtr(static_cast(pimpl->get_iface())); } -Exec* Exec::wait_for(double) +Exec* Exec::do_start() { - THROW_UNIMPLEMENTED; -} + kernel::actor::simcall_answered([this] { + (*boost::static_pointer_cast(pimpl_)) + .set_name(get_name()) + .set_tracing_category(get_tracing_category()) + .start(); + }); -Exec* Exec::cancel() -{ - simix::simcall([this] { boost::static_pointer_cast(pimpl_)->cancel(); }); - state_ = State::CANCELED; + if (suspended_) + pimpl_->suspend(); + + state_ = State::STARTED; + fire_on_start(); + fire_on_this_start(); return this; } -void intrusive_ptr_release(simgrid::s4u::Exec* e) +ssize_t Exec::deprecated_wait_any_for(const std::vector& execs, double timeout) // XBT_ATTRIB_DEPRECATED_v339 { - if (e->refcount_.fetch_sub(1, std::memory_order_release) == 1) { - std::atomic_thread_fence(std::memory_order_acquire); - delete e; - } -} + if (execs.empty()) + return -1; + ActivitySet set; + for (const auto& exec : execs) + set.push(exec); + try { + auto* ret = set.wait_any_for(timeout).get(); + for (size_t i = 0; i < execs.size(); i++) + if (execs[i].get() == ret) + return i; -void intrusive_ptr_add_ref(simgrid::s4u::Exec* e) -{ - e->refcount_.fetch_add(1, std::memory_order_relaxed); + } catch (TimeoutException& e) { + return -1; + } + return -1; } /** @brief change the execution bound @@ -79,21 +77,11 @@ void intrusive_ptr_add_ref(simgrid::s4u::Exec* e) */ ExecPtr Exec::set_bound(double bound) { - xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start"); - bound_ = bound; - return this; -} -ExecPtr Exec::set_timeout(double timeout) -{ - xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start"); - timeout_ = timeout; - return this; -} - -ExecPtr Exec::set_name(const std::string& name) -{ - xbt_assert(state_ == State::INITED, "Cannot change the name of an exec after its start"); - name_ = name; + xbt_assert(state_ == State::INITED || state_ == State::STARTING, + "Cannot change the bound of an exec after its start"); + kernel::actor::simcall_object_access(pimpl_.get(), [this, bound] { + boost::static_pointer_cast(pimpl_)->set_bound(bound); + }); return this; } @@ -105,108 +93,273 @@ ExecPtr Exec::set_name(const std::string& name) * Currently, this cannot be changed once the exec started. */ ExecPtr Exec::set_priority(double priority) { - xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start"); - priority_ = priority; + xbt_assert(state_ == State::INITED || state_ == State::STARTING, + "Cannot change the priority of an exec after its start"); + kernel::actor::simcall_object_access(pimpl_.get(), [this, priority] { + boost::static_pointer_cast(pimpl_)->set_sharing_penalty(1. / priority); + }); return this; } -ExecPtr Exec::set_tracing_category(const std::string& category) +ExecPtr Exec::update_priority(double priority) { - xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start"); - tracing_category_ = category; + kernel::actor::simcall_answered([this, priority] { + boost::static_pointer_cast(pimpl_)->update_sharing_penalty(1. / priority); + }); return this; } -///////////// SEQUENTIAL EXECUTIONS //////// -ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount) +ExecPtr Exec::set_flops_amount(double flops_amount) { - Activity::set_remaining(flops_amount_); - boost::static_pointer_cast(pimpl_)->set_host(host); + xbt_assert(state_ == State::INITED || state_ == State::STARTING, + "Cannot change the flop_amount of an exec after its start"); + kernel::actor::simcall_object_access(pimpl_.get(), [this, flops_amount] { + boost::static_pointer_cast(pimpl_)->set_flops_amount(flops_amount); + }); + set_remaining(flops_amount); + return this; } -Exec* ExecSeq::start() +ExecPtr Exec::set_flops_amounts(const std::vector& flops_amounts) { - simix::simcall([this] { - boost::static_pointer_cast(pimpl_) - ->set_name(name_) - ->set_tracing_category(tracing_category_) - ->start(flops_amount_, 1. / priority_, bound_); + xbt_assert(state_ == State::INITED || state_ == State::STARTING, + "Cannot change the flops_amounts of an exec after its start"); + kernel::actor::simcall_object_access(pimpl_.get(), [this, flops_amounts] { + boost::static_pointer_cast(pimpl_)->set_flops_amounts(flops_amounts); }); - state_ = State::STARTED; - on_start(*Actor::self()); + parallel_ = true; return this; } -/** @brief Returns whether the state of the exec is finished */ +ExecPtr Exec::set_bytes_amounts(const std::vector& bytes_amounts) +{ + xbt_assert(state_ == State::INITED || state_ == State::STARTING, + "Cannot change the bytes_amounts of an exec after its start"); + kernel::actor::simcall_object_access(pimpl_.get(), [this, bytes_amounts] { + boost::static_pointer_cast(pimpl_)->set_bytes_amounts(bytes_amounts); + }); + parallel_ = true; + return this; +} + +ExecPtr Exec::set_thread_count(int thread_count) +{ + xbt_assert(state_ == State::INITED || state_ == State::STARTING, + "Cannot change the bytes_amounts of an exec after its start"); + kernel::actor::simcall_object_access(pimpl_.get(), [this, thread_count] { + boost::static_pointer_cast(pimpl_)->set_thread_count(thread_count); + }); + return this; +} + +/** @brief Retrieve the host on which this activity takes place. + * If it runs on more than one host, only the first host is returned. + */ +Host* Exec::get_host() const +{ + return static_cast(pimpl_.get())->get_host(); +} +unsigned int Exec::get_host_number() const +{ + return static_cast(pimpl_.get())->get_host_number(); +} + +int Exec::get_thread_count() const +{ + return static_cast(pimpl_.get())->get_thread_count(); +} + /** @brief Change the host on which this activity takes place. * * The activity cannot be terminated already (but it may be started). */ -ExecPtr ExecSeq::set_host(Host* host) +ExecPtr Exec::set_host(Host* host) { - xbt_assert(state_ == State::INITED || state_ == State::STARTED, - "Cannot change the host of an exec once it's done (state: %d)", (int)state_); + xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED, + "Cannot change the host of an exec once it's done (state: %s)", to_c_str(state_)); + if (state_ == State::STARTED) - boost::static_pointer_cast(pimpl_)->migrate(host); - host_ = host; - boost::static_pointer_cast(pimpl_)->host_ = host; + boost::static_pointer_cast(pimpl_)->migrate(host); + + kernel::actor::simcall_object_access( + pimpl_.get(), [this, host] { boost::static_pointer_cast(pimpl_)->set_host(host); }); + + if (state_ == State::STARTING) + // Setting the host may allow to start the activity, let's try + start(); + return this; } +ExecPtr Exec::set_hosts(const std::vector& hosts) +{ + xbt_assert(state_ == State::INITED || state_ == State::STARTING, + "Cannot change the hosts of an exec once it's done (state: %s)", to_c_str(state_)); + + kernel::actor::simcall_object_access(pimpl_.get(), [this, hosts] { + boost::static_pointer_cast(pimpl_)->set_hosts(hosts); + }); + parallel_ = true; -/** @brief Retrieve the host on which this activity takes place. */ -Host* ExecSeq::get_host() + // Setting the host may allow to start the activity, let's try + if (state_ == State::STARTING) + start(); + + return this; +} + +ExecPtr Exec::unset_host() +{ + if (not is_assigned()) + throw std::invalid_argument( + xbt::string_printf("Exec %s: the activity is not assigned to any host(s)", get_cname())); + else { + reset(); + + if (state_ == State::STARTED) + cancel(); + start(); + + return this; + } +} + +double Exec::get_cost() const { - return host_; + return (pimpl_->model_action_ == nullptr) ? -1 : pimpl_->model_action_->get_cost(); } -/** @brief Returns the amount of flops that remain to be done */ -double ExecSeq::get_remaining() +double Exec::get_remaining() const { - return simgrid::simix::simcall( - [this]() { return boost::static_pointer_cast(pimpl_)->get_remaining(); }); + if (is_parallel()) { + XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead."); + return get_remaining_ratio(); + } else + return kernel::actor::simcall_answered( + [this]() { return boost::static_pointer_cast(pimpl_)->get_remaining(); }); } -/** @brief Returns the ratio of elements that are still to do +/** @brief Returns the ratio of elements that are still to do * * The returned value is between 0 (completely done) and 1 (nothing done yet). */ -double ExecSeq::get_remaining_ratio() +double Exec::get_remaining_ratio() const { - return simgrid::simix::simcall([this]() { - return boost::static_pointer_cast(pimpl_)->get_seq_remaining_ratio(); - }); + if (is_parallel()) + return kernel::actor::simcall_answered( + [this]() { return boost::static_pointer_cast(pimpl_)->get_par_remaining_ratio(); }); + else + return kernel::actor::simcall_answered( + [this]() { return boost::static_pointer_cast(pimpl_)->get_seq_remaining_ratio(); }); } -///////////// PARALLEL EXECUTIONS //////// -ExecPar::ExecPar(const std::vector& hosts, const std::vector& flops_amounts, - const std::vector& bytes_amounts) - : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts) +bool Exec::is_assigned() const { - // For parallel executions, we need a special host to run the timeout detector. - host_ = hosts.front(); - boost::static_pointer_cast(pimpl_)->host_ = host_; + return not boost::static_pointer_cast(pimpl_)->get_hosts().empty(); } +} // namespace simgrid::s4u -Exec* ExecPar::start() +/* **************************** Public C interface *************************** */ +int sg_exec_isinstance(sg_activity_t acti) { - simix::simcall([this] { - boost::static_pointer_cast(pimpl_)->set_timeout(timeout_); - boost::static_pointer_cast(pimpl_)->start(hosts_, flops_amounts_, bytes_amounts_); - }); - state_ = State::STARTED; - on_start(*Actor::self()); - return this; + return dynamic_cast(acti) != nullptr; +} + +void sg_exec_set_bound(sg_exec_t exec, double bound) +{ + exec->set_bound(bound); +} + +const char* sg_exec_get_name(const_sg_exec_t exec) +{ + return exec->get_cname(); +} + +void sg_exec_set_name(sg_exec_t exec, const char* name) +{ + exec->set_name(name); +} + +void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host) +{ + exec->set_host(new_host); +} + +double sg_exec_get_remaining(const_sg_exec_t exec) +{ + return exec->get_remaining(); +} + +double sg_exec_get_remaining_ratio(const_sg_exec_t exec) +{ + return exec->get_remaining_ratio(); +} + +void sg_exec_start(sg_exec_t exec) +{ + exec->start(); } -double ExecPar::get_remaining_ratio() + +void sg_exec_cancel(sg_exec_t exec) { - return simix::simcall( - [this]() { return boost::static_pointer_cast(pimpl_)->get_par_remaining_ratio(); }); + exec->cancel(); + exec->unref(); } -double ExecPar::get_remaining() +int sg_exec_test(sg_exec_t exec) { - XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead."); - return get_remaining_ratio(); + bool finished = exec->test(); + if (finished) + exec->unref(); + return finished; +} + +sg_error_t sg_exec_wait(sg_exec_t exec) +{ + return sg_exec_wait_for(exec, -1.0); +} + +sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout) +{ + sg_error_t status = SG_OK; + + simgrid::s4u::ExecPtr s4u_exec(exec, false); + try { + s4u_exec->wait_for(timeout); + } catch (const simgrid::TimeoutException&) { + s4u_exec->add_ref(); // the wait_for timeouted, keep the exec alive + status = SG_ERROR_TIMEOUT; + } catch (const simgrid::CancelException&) { + status = SG_ERROR_CANCELED; + } catch (const simgrid::HostFailureException&) { + status = SG_ERROR_HOST; + } + return status; +} + +ssize_t sg_exec_wait_any(sg_exec_t* execs, size_t count) // XBT_ATTRIB_DEPRECATED_v339 +{ + std::vector s4u_execs; + for (size_t i = 0; i < count; i++) + s4u_execs.emplace_back(execs[i], false); + + ssize_t pos = simgrid::s4u::Exec::deprecated_wait_any_for(s4u_execs, -1.0); + for (size_t i = 0; i < count; i++) { + if (pos != -1 && static_cast(pos) != i) + s4u_execs[i]->add_ref(); + } + return pos; +} + +ssize_t sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout) // XBT_ATTRIB_DEPRECATED_v339 +{ + std::vector s4u_execs; + for (size_t i = 0; i < count; i++) + s4u_execs.emplace_back(execs[i], false); + + ssize_t pos = simgrid::s4u::Exec::deprecated_wait_any_for(s4u_execs, timeout); + for (size_t i = 0; i < count; i++) { + if (pos != -1 && static_cast(pos) != i) + s4u_execs[i]->add_ref(); + } + return pos; } -} // namespace s4u -} // namespace simgrid