X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d3ff5bc1abcc24a092161f238c69447a72201746..7672ae43c2b49a7dcdc0976cc89a05cc87ae534c:/src/s4u/s4u_Exec.cpp diff --git a/src/s4u/s4u_Exec.cpp b/src/s4u/s4u_Exec.cpp index a0d3cc5302..24946989ec 100644 --- a/src/s4u/s4u_Exec.cpp +++ b/src/s4u/s4u_Exec.cpp @@ -1,94 +1,150 @@ -/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2022. 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 "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 { +xbt::signal Exec::on_start; + +Exec::Exec(kernel::activity::ExecImplPtr pimpl) +{ + pimpl_ = pimpl; +} -Exec::Exec() +void Exec::reset() const { - pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl()); + boost::static_pointer_cast(pimpl_)->reset(); } -bool Exec::test() +ExecPtr Exec::init() { - xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING || - state_ == State::FINISHED); + auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl()); + unsigned int cb_id = Host::on_state_change.connect([pimpl](s4u::Host const& h) { + if (not h.is_on() && pimpl->get_state() == kernel::activity::State::RUNNING && + std::find(pimpl->get_hosts().begin(), pimpl->get_hosts().end(), &h) != pimpl->get_hosts().end()) { + pimpl->set_state(kernel::activity::State::FAILED); + pimpl->post(); + } + }); + pimpl->set_cb_id(cb_id); + return ExecPtr(static_cast(pimpl->get_iface())); +} - if (state_ == State::FINISHED) - return true; +Exec* Exec::start() +{ + kernel::actor::simcall_answered([this] { + (*boost::static_pointer_cast(pimpl_)) + .set_name(get_name()) + .set_tracing_category(get_tracing_category()) + .start(); + }); - if (state_ == State::INITED || state_ == State::STARTING) - this->vetoable_start(); + if (suspended_) + pimpl_->suspend(); - if (simcall_execution_test(pimpl_)) { - state_ = State::FINISHED; - this->release_dependencies(); - return true; - } + state_ = State::STARTED; + on_start(*this); + return this; +} - return false; +ssize_t Exec::wait_any_for(const std::vector& execs, double timeout) +{ + std::vector activities; + for (const auto& exec : execs) + activities.push_back(boost::dynamic_pointer_cast(exec)); + return Activity::wait_any_for(activities, timeout); } -Exec* Exec::wait() +/** @brief change the execution bound + * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may + * deliver. Currently, this cannot be changed once the exec started. + */ +ExecPtr Exec::set_bound(double bound) { - return this->wait_for(-1); + 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; } -Exec* Exec::wait_for(double timeout) +/** @brief Change the execution priority, don't you think? + * + * An execution with twice the priority will get twice the amount of flops when the resource is shared. + * The default priority is 1. + * + * Currently, this cannot be changed once the exec started. */ +ExecPtr Exec::set_priority(double priority) { - if (state_ == State::INITED) - vetoable_start(); - simcall_execution_wait(pimpl_, timeout); - state_ = State::FINISHED; - on_completion(*Actor::self(), *this); - this->release_dependencies(); + 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; } -int Exec::wait_any_for(std::vector* execs, double timeout) +ExecPtr Exec::update_priority(double priority) { - std::unique_ptr rexecs(new kernel::activity::ExecImpl*[execs->size()]); - std::transform(begin(*execs), end(*execs), rexecs.get(), - [](const ExecPtr& exec) { return static_cast(exec->pimpl_.get()); }); + kernel::actor::simcall_answered([this, priority] { + boost::static_pointer_cast(pimpl_)->update_sharing_penalty(1. / priority); + }); + return this; +} - int changed_pos = simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout); - if (changed_pos != -1) - execs->at(changed_pos)->release_dependencies(); - return changed_pos; +ExecPtr Exec::set_flops_amount(double flops_amount) +{ + 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* Exec::cancel() +ExecPtr Exec::set_flops_amounts(const std::vector& flops_amounts) { - kernel::actor::simcall([this] { boost::static_pointer_cast(pimpl_)->cancel(); }); - state_ = State::CANCELED; + 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); + }); + parallel_ = true; return this; } -/** @brief change the execution bound - * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may - * deliver. Currently, this cannot be changed once the exec started. - */ -ExecPtr Exec::set_bound(double bound) +ExecPtr Exec::set_bytes_amounts(const std::vector& bytes_amounts) { - xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start"); - bound_ = bound; + 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_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329 + +ExecPtr Exec::set_thread_count(int thread_count) { - xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start"); - timeout_ = timeout; + 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; } @@ -103,118 +159,189 @@ unsigned int Exec::get_host_number() const { return static_cast(pimpl_.get())->get_host_number(); } -double Exec::get_start_time() const + +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 Exec::set_host(Host* host) +{ + 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); + + 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 + vetoable_start(); + + return this; +} + +ExecPtr Exec::set_hosts(const std::vector& hosts) { - return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time(); + 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; + + // Setting the host may allow to start the activity, let's try + if (state_ == State::STARTING) + vetoable_start(); + + return this; } -double Exec::get_finish_time() const + +ExecPtr Exec::unset_host() { - return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time(); + 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(); + vetoable_start(); + + return this; + } } + double Exec::get_cost() const { return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost(); } -/** @brief Change the execution priority, don't you think? - * - * An execution with twice the priority will get twice the amount of flops when the resource is shared. - * The default priority is 1. +double Exec::get_remaining() const +{ + 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 * - * Currently, this cannot be changed once the exec started. */ -ExecPtr Exec::set_priority(double priority) + * The returned value is between 0 (completely done) and 1 (nothing done yet). + */ +double Exec::get_remaining_ratio() const { - xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start"); - priority_ = priority; - return this; + 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(); }); } -///////////// SEQUENTIAL EXECUTIONS //////// -ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount) +bool Exec::is_assigned() const { - Activity::set_remaining(flops_amount_); - boost::static_pointer_cast(pimpl_)->set_host(host); + return not boost::static_pointer_cast(pimpl_)->get_hosts().empty(); } +} // namespace simgrid::s4u -Exec* ExecSeq::start() +/* **************************** Public C interface *************************** */ +void sg_exec_set_bound(sg_exec_t exec, double bound) { - kernel::actor::simcall([this] { - (*boost::static_pointer_cast(pimpl_)) - .set_name(get_name()) - .set_tracing_category(get_tracing_category()) - .set_sharing_penalty(1. / priority_) - .set_bound(bound_) - .set_flops_amount(flops_amount_) - .start(); - }); - state_ = State::STARTED; - on_start(*Actor::self(), *this); - return this; + exec->set_bound(bound); } -/** @brief Returns whether the state of the exec is finished */ -/** @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) +const char* sg_exec_get_name(const_sg_exec_t exec) { - xbt_assert(state_ == State::INITED || state_ == State::STARTED, - "Cannot change the host of an exec once it's done (state: %d)", (int)state_); - if (state_ == State::STARTED) - boost::static_pointer_cast(pimpl_)->migrate(host); - boost::static_pointer_cast(pimpl_)->set_host(host); - return this; + return exec->get_cname(); } -/** @brief Returns the amount of flops that remain to be done */ -double ExecSeq::get_remaining() +void sg_exec_set_name(sg_exec_t exec, const char* name) { - return kernel::actor::simcall( - [this]() { return boost::static_pointer_cast(pimpl_)->get_remaining(); }); + exec->set_name(name); } -/** @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() +void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host) { - return kernel::actor::simcall( - [this]() { return boost::static_pointer_cast(pimpl_)->get_seq_remaining_ratio(); }); + exec->set_host(new_host); } -///////////// 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) +double sg_exec_get_remaining(const_sg_exec_t exec) { + return exec->get_remaining(); } -Exec* ExecPar::start() +double sg_exec_get_remaining_ratio(const_sg_exec_t exec) { - kernel::actor::simcall([this] { - (*boost::static_pointer_cast(pimpl_)) - .set_hosts(hosts_) - .set_timeout(timeout_) - .set_flops_amounts(flops_amounts_) - .set_bytes_amounts(bytes_amounts_) - .start(); - }); - state_ = State::STARTED; - on_start(*Actor::self(), *this); - return this; + return exec->get_remaining_ratio(); +} + +void sg_exec_start(sg_exec_t exec) +{ + exec->vetoable_start(); } -double ExecPar::get_remaining_ratio() +void sg_exec_cancel(sg_exec_t exec) { - return kernel::actor::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) +{ + return sg_exec_wait_any_for(execs, count, -1.0); +} + +ssize_t sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout) +{ + 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::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