X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ac2b85fd8b1d8e3707f524722f1f7c98faa4beda..d1283facbb31a936d01dd2c14982724aa30d3661:/src/s4u/s4u_Host.cpp diff --git a/src/s4u/s4u_Host.cpp b/src/s4u/s4u_Host.cpp index 906f7a0365..3c5e613344 100644 --- a/src/s4u/s4u_Host.cpp +++ b/src/s4u/s4u_Host.cpp @@ -1,11 +1,12 @@ -/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2019. 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/kernel/routing/NetPoint.hpp" +#include "simgrid/s4u/Actor.hpp" #include "simgrid/s4u/Engine.hpp" -#include "src/simix/smx_host_private.hpp" +#include "simgrid/s4u/Exec.hpp" #include "src/surf/HostImpl.hpp" #include @@ -23,14 +24,14 @@ template class Extendable; namespace s4u { -simgrid::xbt::signal Host::onCreation; -simgrid::xbt::signal Host::onDestruction; -simgrid::xbt::signal Host::onStateChange; -simgrid::xbt::signal Host::onSpeedChange; +simgrid::xbt::signal Host::on_creation; +simgrid::xbt::signal Host::on_destruction; +simgrid::xbt::signal Host::on_state_change; +simgrid::xbt::signal Host::on_speed_change; -Host::Host(const char* name) : name_(name) +Host::Host(std::string name) : name_(name) { - xbt_assert(Host::by_name_or_null(name) == nullptr, "Refusing to create a second host named '%s'.", name); + xbt_assert(Host::by_name_or_null(name) == nullptr, "Refusing to create a second host named '%s'.", name.c_str()); Engine::get_instance()->host_register(std::string(name_), this); new simgrid::surf::HostImpl(this); } @@ -43,12 +44,12 @@ Host::~Host() if (pimpl_netpoint != nullptr) // not removed yet by a children class simgrid::s4u::Engine::get_instance()->netpoint_unregister(pimpl_netpoint); delete pimpl_cpu; - delete mounts; + delete mounts_; } /** @brief Fire the required callbacks and destroy the object * - * Don't delete directly an Host, call h->destroy() instead. + * Don't delete directly a host, call h->destroy() instead. * * This is cumbersome but this is the simplest solution to ensure that the * onDestruction() callback receives a valid object (because of the destructor @@ -58,7 +59,7 @@ void Host::destroy() { if (not currentlyDestroying_) { currentlyDestroying_ = true; - onDestruction(*this); + on_destruction(*this); Engine::get_instance()->host_unregister(std::string(name_)); delete this; } @@ -68,14 +69,6 @@ Host* Host::by_name(std::string name) { return Engine::get_instance()->host_by_name(name); } -Host* Host::by_name(const char* name) -{ - return Engine::get_instance()->host_by_name(std::string(name)); -} -Host* Host::by_name_or_null(const char* name) -{ - return Engine::get_instance()->host_by_name_or_null(std::string(name)); -} Host* Host::by_name_or_null(std::string name) { return Engine::get_instance()->host_by_name_or_null(name); @@ -86,75 +79,97 @@ Host* Host::current() smx_actor_t smx_proc = SIMIX_process_self(); if (smx_proc == nullptr) xbt_die("Cannot call Host::current() from the maestro context"); - return smx_proc->host; + return smx_proc->host_; } -void Host::turnOn() +void Host::turn_on() { - if (isOff()) { - simgrid::simix::kernelImmediate([this] { - this->extension()->turnOn(); + if (is_off()) { + simgrid::simix::simcall([this] { this->pimpl_cpu->turn_on(); - onStateChange(*this); + this->pimpl_->turn_on(); + on_state_change(*this); }); } } -void Host::turnOff() +/** @brief Stop the host if it is on */ +void Host::turn_off() { - if (isOn()) { - smx_actor_t self = SIMIX_process_self(); - simgrid::simix::kernelImmediate([this, self] { - SIMIX_host_off(this, self); - onStateChange(*this); + if (is_on()) { + simgrid::simix::simcall([this] { + this->pimpl_cpu->turn_off(); + this->pimpl_->turn_off(); + + on_state_change(*this); }); } } -bool Host::isOn() +bool Host::is_on() const { return this->pimpl_cpu->is_on(); } -int Host::getPstatesCount() const +int Host::get_pstate_count() const { - return this->pimpl_cpu->getNbPStates(); + return this->pimpl_cpu->get_pstate_count(); } /** - * \brief Return the list of actors attached to an host. + * @brief Return a copy of the list of actors that are executing on this host. * - * \param whereto a vector in which we should push actors living on that host + * Daemons and regular actors are all mixed in this list. */ +std::vector Host::get_all_actors() +{ + return pimpl_->get_all_actors(); +} + +/** @brief Returns how many actors (daemonized or not) have been launched on this host */ +int Host::get_actor_count() +{ + return pimpl_->get_actor_count(); +} + +/** @deprecated */ +void Host::getProcesses(std::vector* list) +{ + auto actors = get_all_actors(); + for (auto& actor : actors) + list->push_back(actor); +} + +/** @deprecated */ void Host::actorList(std::vector* whereto) { - for (auto& actor : this->extension()->process_list) { - whereto->push_back(actor.ciface()); - } + auto actors = get_all_actors(); + for (auto& actor : actors) + whereto->push_back(actor); } /** - * \brief Find a route toward another host + * @brief Find a route toward another host * - * \param dest [IN] where to - * \param links [OUT] where to store the list of links (must exist, cannot be nullptr). - * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested) + * @param dest [IN] where to + * @param links [OUT] where to store the list of links (must exist, cannot be nullptr). + * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested) * It is the caller responsibility to initialize latency to 0 (we add to provided route) - * \pre links!=nullptr + * @pre links!=nullptr * * walk through the routing components tree and find a route between hosts * by calling each "get_route" function in each routing component. */ -void Host::routeTo(Host* dest, std::vector& links, double* latency) +void Host::route_to(Host* dest, std::vector& links, double* latency) { std::vector linkImpls; - this->routeTo(dest, linkImpls, latency); + this->route_to(dest, linkImpls, latency); for (kernel::resource::LinkImpl* const& l : linkImpls) links.push_back(&l->piface_); } /** @brief Just like Host::routeTo, but filling an array of link implementations */ -void Host::routeTo(Host* dest, std::vector& links, double* latency) +void Host::route_to(Host* dest, std::vector& links, double* latency) { simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency); if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) { @@ -166,108 +181,140 @@ void Host::routeTo(Host* dest, std::vector& links, } /** Get the properties assigned to a host */ -std::map* Host::getProperties() +std::unordered_map* Host::get_properties() { - return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); }); + return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); }); } /** Retrieve the property value (or nullptr if not set) */ -const char* Host::getProperty(const char* key) +const char* Host::get_property(std::string key) const { - return this->pimpl_->getProperty(key); + return this->pimpl_->get_property(key); } -void Host::setProperty(std::string key, std::string value) +void Host::set_property(std::string key, std::string value) { - simgrid::simix::kernelImmediate([this, key, value] { this->pimpl_->setProperty(key, value); }); + simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); }); } - -/** Get the processes attached to the host */ -void Host::getProcesses(std::vector* list) +/** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law. + * The profile must contain boolean values. */ +void Host::set_state_profile(kernel::profile::Profile* p) { - for (auto& actor : this->extension()->process_list) { - list->push_back(actor.iface()); - } + return simgrid::simix::simcall([this, p] { pimpl_cpu->set_state_profile(p); }); } - -/** @brief Returns how many actors have been launched on this host */ -// FIXME: Specify whether the user should expect only non-daemon actors here! -int Host::get_actor_count() +/** Specify a profile modeling the external load according to a exhaustive list or a stochastic law. + * + * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate + * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed + * at this pstate level) by the rate coming from the profile. + */ +void Host::set_speed_profile(kernel::profile::Profile* p) { - return this->extension()->process_list.size(); + return simgrid::simix::simcall([this, p] { pimpl_cpu->set_speed_profile(p); }); } /** @brief Get the peak processor speed (in flops/s), at the specified pstate */ -double Host::getPstateSpeed(int pstate_index) +double Host::get_pstate_speed(int pstate_index) const { - return simgrid::simix::kernelImmediate( - [this, pstate_index] { return this->pimpl_cpu->getPstateSpeed(pstate_index); }); + return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->get_pstate_peak_speed(pstate_index); }); } -/** @brief Get the peak processor speed (under full load (=1.0), in flops/s), at the current pstate */ -double Host::getSpeed() +/** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account. + * + * The amount of flops per second available for computing depends on several things: + * - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the + * computing speed you would get at another pstate) + * - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the + * result of get_speed() by get_available_speed() to retrieve what a new computation would get. + * + * The remaining speed is then shared between the executions located on this host. + * You can retrieve the amount of tasks currently running on this host with @ref get_load(). + * + * The host may have multiple cores, and your executions may be able to use more than a single core. + * + * Finally, executions of priority 2 get twice the amount of flops than executions of priority 1. + */ +double Host::get_speed() const { - return pimpl_cpu->getSpeed(1.0); + return this->pimpl_cpu->get_speed(1.0); +} +/** @brief Returns the current computation load (in flops per second) + * + * The external load (coming from an availability trace) is not taken in account. + * You may also be interested in the load plugin. + */ +double Host::get_load() const +{ + return this->pimpl_cpu->get_load(); +} +/** @brief Get the available speed ratio, between 0 and 1. + * + * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()). + */ +double Host::get_available_speed() const +{ + return this->pimpl_cpu->get_speed_ratio(); } /** @brief Returns the number of core of the processor. */ -int Host::getCoreCount() +int Host::get_core_count() const { - return pimpl_cpu->coreCount(); + return this->pimpl_cpu->get_core_count(); } /** @brief Set the pstate at which the host should run */ -void Host::setPstate(int pstate_index) +void Host::set_pstate(int pstate_index) { - simgrid::simix::kernelImmediate([this, pstate_index] { this->pimpl_cpu->setPState(pstate_index); }); + simgrid::simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); }); } /** @brief Retrieve the pstate at which the host is currently running */ -int Host::getPstate() +int Host::get_pstate() const { - return this->pimpl_cpu->getPState(); + return this->pimpl_cpu->get_pstate(); } /** - * \ingroup simix_storage_management - * \brief Returns the list of storages attached to an host. - * \return a vector containing all storages attached to the host + * @ingroup simix_storage_management + * @brief Returns the list of storages attached to a host. + * @return a vector containing all storages attached to the host */ -std::vector Host::get_attached_storages() +std::vector Host::get_attached_storages() const { - return simgrid::simix::kernelImmediate([this] { return this->pimpl_->get_attached_storages(); }); + return simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); }); } void Host::getAttachedStorages(std::vector* storages) { std::vector local_storages = - simgrid::simix::kernelImmediate([this] { return this->pimpl_->get_attached_storages(); }); + simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); }); for (auto elm : local_storages) storages->push_back(elm); } -std::unordered_map const& Host::getMountedStorages() +std::unordered_map const& Host::get_mounted_storages() { - if (mounts == nullptr) { - mounts = new std::unordered_map(); + if (mounts_ == nullptr) { + mounts_ = new std::unordered_map(); for (auto const& m : this->pimpl_->storage_) { - mounts->insert({m.first, &m.second->piface_}); + mounts_->insert({m.first, &m.second->piface_}); } } - return *mounts; + return *mounts_; +} + +ExecPtr Host::exec_async(double flops) +{ + return this_actor::exec_init(flops)->set_host(this); } void Host::execute(double flops) { - Host* host_list[1] = {this}; - double flops_list[1] = {flops}; - smx_activity_t s = simcall_execution_parallel_start(nullptr /*name*/, 1, host_list, flops_list, - nullptr /*comm_sizes */, -1.0, -1 /*timeout*/); - simcall_execution_wait(s); + execute(flops, 1.0 /* priority */); } -double Host::getLoad() +void Host::execute(double flops, double priority) { - return this->pimpl_cpu->get_load(); + this_actor::exec_init(flops)->set_host(this)->set_priority(1 / priority)->start()->wait(); } } // namespace s4u @@ -282,11 +329,11 @@ size_t sg_host_count() * * Uses sg_host_count() to know the array size. * - * \return an array of \ref sg_host_t containing all the hosts in the platform. - * \remark The host order in this array is generally different from the + * @return an array of @ref sg_host_t containing all the hosts in the platform. + * @remark The host order in this array is generally different from the * creation/declaration order in the XML platform (we use a hash table * internally). - * \see sg_host_count() + * @see sg_host_count() */ sg_host_t* sg_host_list() { @@ -360,7 +407,7 @@ xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host) { xbt_assert((host != nullptr), "Invalid parameters"); xbt_dict_t res = xbt_dict_new_homogeneous(nullptr); - for (auto const& elm : host->getMountedStorages()) { + for (auto const& elm : host->get_mounted_storages()) { const char* mount_name = elm.first.c_str(); sg_storage_t storage = elm.second; xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr); @@ -383,34 +430,34 @@ xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host) /** @brief Returns the total speed of a host */ double sg_host_speed(sg_host_t host) { - return host->getSpeed(); + return host->get_speed(); } -/** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy. +/** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy. * - * \param host host to test - * \param pstate_index pstate to test - * \return Returns the processor speed associated with pstate_index + * @param host host to test + * @param pstate_index pstate to test + * @return Returns the processor speed associated with pstate_index */ double sg_host_get_pstate_speed(sg_host_t host, int pstate_index) { - return host->getPstateSpeed(pstate_index); + return host->get_pstate_speed(pstate_index); } -/** \ingroup m_host_management - * \brief Return the number of cores. +/** @ingroup m_host_management + * @brief Return the number of cores. * - * \param host a host - * \return the number of cores + * @param host a host + * @return the number of cores */ int sg_host_core_count(sg_host_t host) { - return host->getCoreCount(); + return host->get_core_count(); } double sg_host_get_available_speed(sg_host_t host) { - return host->pimpl_cpu->get_available_speed(); + return host->get_available_speed(); } /** @brief Returns the number of power states for a host. @@ -419,7 +466,7 @@ double sg_host_get_available_speed(sg_host_t host) */ int sg_host_get_nb_pstates(sg_host_t host) { - return host->getPstatesCount(); + return host->get_pstate_count(); } /** @brief Gets the pstate at which that host currently runs. @@ -428,7 +475,7 @@ int sg_host_get_nb_pstates(sg_host_t host) */ int sg_host_get_pstate(sg_host_t host) { - return host->getPstate(); + return host->get_pstate(); } /** @brief Sets the pstate at which that host should run. * @@ -436,31 +483,31 @@ int sg_host_get_pstate(sg_host_t host) */ void sg_host_set_pstate(sg_host_t host, int pstate) { - host->setPstate(pstate); + host->set_pstate(pstate); } -/** \ingroup m_host_management +/** @ingroup m_host_management * - * \brief Start the host if it is off + * @brief Start the host if it is off * * See also #sg_host_is_on() and #sg_host_is_off() to test the current state of the host and @ref plugin_energy * for more info on DVFS. */ void sg_host_turn_on(sg_host_t host) { - host->turnOn(); + host->turn_on(); } -/** \ingroup m_host_management +/** @ingroup m_host_management * - * \brief Stop the host if it is on + * @brief Stop the host if it is on * * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy * for more info on DVFS. */ void sg_host_turn_off(sg_host_t host) { - host->turnOff(); + host->turn_off(); } /** @ingroup m_host_management @@ -474,7 +521,7 @@ void sg_host_turn_off(sg_host_t host) */ int sg_host_is_on(sg_host_t host) { - return host->isOn(); + return host->is_on(); } /** @ingroup m_host_management @@ -485,14 +532,14 @@ int sg_host_is_on(sg_host_t host) */ int sg_host_is_off(sg_host_t host) { - return host->isOff(); + return host->is_off(); } -/** @brief Get the properties of an host */ +/** @brief Get the properties of a host */ xbt_dict_t sg_host_get_properties(sg_host_t host) { xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f); - std::map* props = host->getProperties(); + std::unordered_map* props = host->get_properties(); if (props == nullptr) return nullptr; for (auto const& elm : *props) { @@ -501,64 +548,64 @@ xbt_dict_t sg_host_get_properties(sg_host_t host) return as_dict; } -/** \ingroup m_host_management - * \brief Returns the value of a given host property +/** @ingroup m_host_management + * @brief Returns the value of a given host property * - * \param host a host - * \param name a property name - * \return value of a property (or nullptr if property not set) -*/ + * @param host a host + * @param name a property name + * @return value of a property (or nullptr if property not set) + */ const char* sg_host_get_property_value(sg_host_t host, const char* name) { - return host->getProperty(name); + return host->get_property(name); } void sg_host_set_property_value(sg_host_t host, const char* name, const char* value) { - host->setProperty(name, value); + host->set_property(name, value); } /** - * \brief Find a route between two hosts + * @brief Find a route between two hosts * - * \param from where from - * \param to where to - * \param links [OUT] where to store the list of links (must exist, cannot be nullptr). + * @param from where from + * @param to where to + * @param links [OUT] where to store the list of links (must exist, cannot be nullptr). */ void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links) { std::vector vlinks; - from->routeTo(to, vlinks, nullptr); + from->route_to(to, vlinks, nullptr); for (auto const& link : vlinks) xbt_dynar_push(links, &link); } /** - * \brief Find the latency of the route between two hosts + * @brief Find the latency of the route between two hosts * - * \param from where from - * \param to where to + * @param from where from + * @param to where to */ double sg_host_route_latency(sg_host_t from, sg_host_t to) { std::vector vlinks; double res = 0; - from->routeTo(to, vlinks, &res); + from->route_to(to, vlinks, &res); return res; } /** - * \brief Find the bandwitdh of the route between two hosts + * @brief Find the bandwitdh of the route between two hosts * - * \param from where from - * \param to where to + * @param from where from + * @param to where to */ double sg_host_route_bandwidth(sg_host_t from, sg_host_t to) { double min_bandwidth = -1.0; std::vector vlinks; - from->routeTo(to, vlinks, nullptr); + from->route_to(to, vlinks, nullptr); for (auto const& link : vlinks) { - double bandwidth = link->bandwidth(); + double bandwidth = link->get_bandwidth(); if (bandwidth < min_bandwidth || min_bandwidth < 0.0) min_bandwidth = bandwidth; } @@ -569,9 +616,9 @@ double sg_host_route_bandwidth(sg_host_t from, sg_host_t to) void sg_host_dump(sg_host_t host) { XBT_INFO("Displaying host %s", host->get_cname()); - XBT_INFO(" - speed: %.0f", host->getSpeed()); + XBT_INFO(" - speed: %.0f", host->get_speed()); XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host)); - std::map* props = host->getProperties(); + std::unordered_map* props = host->get_properties(); if (not props->empty()) { XBT_INFO(" - properties:"); @@ -581,21 +628,25 @@ void sg_host_dump(sg_host_t host) } } -/** \brief Return the list of actors attached to an host. +/** @brief Return the list of actors attached to a host. * - * \param host a host - * \param whereto a dynar in which we should push actors living on that host + * @param host a host + * @param whereto a dynar in which we should push actors living on that host */ void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto) { - for (auto& actor : host->extension()->process_list) { - s4u_Actor* p = actor.ciface(); - xbt_dynar_push(whereto, &p); - } + auto actors = host->get_all_actors(); + for (auto& actor : actors) + xbt_dynar_push(whereto, &actor); } sg_host_t sg_host_self() { smx_actor_t process = SIMIX_process_self(); - return (process == nullptr) ? nullptr : process->host; + return (process == nullptr) ? nullptr : process->host_; +} + +double sg_host_load(sg_host_t host) +{ + return host->get_load(); }