1 /* Copyright (c) 2006-2018. 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/kernel/routing/NetPoint.hpp"
7 #include "simgrid/s4u/Engine.hpp"
8 #include "src/simix/smx_host_private.hpp"
9 #include "src/surf/HostImpl.hpp"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
14 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
16 int USER_HOST_LEVEL = -1;
21 template class Extendable<simgrid::s4u::Host>;
26 simgrid::xbt::signal<void(Host&)> Host::onCreation;
27 simgrid::xbt::signal<void(Host&)> Host::onDestruction;
28 simgrid::xbt::signal<void(Host&)> Host::onStateChange;
29 simgrid::xbt::signal<void(Host&)> Host::onSpeedChange;
31 Host::Host(const char* name) : name_(name)
33 xbt_assert(Host::by_name_or_null(name) == nullptr, "Refusing to create a second host named '%s'.", name);
34 Engine::get_instance()->host_register(std::string(name_), this);
35 new simgrid::surf::HostImpl(this);
40 xbt_assert(currentlyDestroying_, "Please call h->destroy() instead of manually deleting it.");
43 if (pimpl_netpoint != nullptr) // not removed yet by a children class
44 simgrid::s4u::Engine::get_instance()->netpoint_unregister(pimpl_netpoint);
49 /** @brief Fire the required callbacks and destroy the object
51 * Don't delete directly an Host, call h->destroy() instead.
53 * This is cumbersome but this is the simplest solution to ensure that the
54 * onDestruction() callback receives a valid object (because of the destructor
55 * order in a class hierarchy).
59 if (not currentlyDestroying_) {
60 currentlyDestroying_ = true;
62 Engine::get_instance()->host_unregister(std::string(name_));
67 Host* Host::by_name(std::string name)
69 return Engine::get_instance()->host_by_name(name);
71 Host* Host::by_name(const char* name)
73 return Engine::get_instance()->host_by_name(std::string(name));
75 Host* Host::by_name_or_null(const char* name)
77 return Engine::get_instance()->host_by_name_or_null(std::string(name));
79 Host* Host::by_name_or_null(std::string name)
81 return Engine::get_instance()->host_by_name_or_null(name);
86 smx_actor_t smx_proc = SIMIX_process_self();
87 if (smx_proc == nullptr)
88 xbt_die("Cannot call Host::current() from the maestro context");
89 return smx_proc->host;
95 simgrid::simix::kernelImmediate([this] {
96 this->extension<simgrid::simix::Host>()->turnOn();
97 this->pimpl_cpu->turn_on();
106 smx_actor_t self = SIMIX_process_self();
107 simgrid::simix::kernelImmediate([this, self] {
108 SIMIX_host_off(this, self);
109 onStateChange(*this);
116 return this->pimpl_cpu->is_on();
119 int Host::getPstatesCount() const
121 return this->pimpl_cpu->getNbPStates();
125 * \brief Return the list of actors attached to an host.
127 * \param whereto a vector in which we should push actors living on that host
129 void Host::actorList(std::vector<ActorPtr>* whereto)
131 for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
132 whereto->push_back(actor.ciface());
137 * \brief Find a route toward another host
139 * \param dest [IN] where to
140 * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
141 * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
142 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
143 * \pre links!=nullptr
145 * walk through the routing components tree and find a route between hosts
146 * by calling each "get_route" function in each routing component.
148 void Host::routeTo(Host* dest, std::vector<Link*>& links, double* latency)
150 std::vector<kernel::resource::LinkImpl*> linkImpls;
151 this->routeTo(dest, linkImpls, latency);
152 for (kernel::resource::LinkImpl* const& l : linkImpls)
153 links.push_back(&l->piface_);
156 /** @brief Just like Host::routeTo, but filling an array of link implementations */
157 void Host::routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
159 simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
160 if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
161 XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
162 (latency == nullptr ? -1 : *latency));
163 for (auto const& link : links)
164 XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
168 /** Get the properties assigned to a host */
169 std::map<std::string, std::string>* Host::getProperties()
171 return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
174 /** Retrieve the property value (or nullptr if not set) */
175 const char* Host::getProperty(const char* key)
177 return this->pimpl_->getProperty(key);
180 void Host::setProperty(std::string key, std::string value)
182 simgrid::simix::kernelImmediate([this, key, value] { this->pimpl_->setProperty(key, value); });
185 /** Get the processes attached to the host */
186 void Host::getProcesses(std::vector<ActorPtr>* list)
188 for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
189 list->push_back(actor.iface());
193 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
194 int Host::get_actor_count()
196 return this->extension<simgrid::simix::Host>()->process_list.size();
199 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
200 double Host::getPstateSpeed(int pstate_index)
202 return simgrid::simix::kernelImmediate(
203 [this, pstate_index] { return this->pimpl_cpu->getPstateSpeed(pstate_index); });
206 /** @brief Get the peak processor speed (under full load (=1.0), in flops/s), at the current pstate */
207 double Host::getSpeed()
209 return pimpl_cpu->getSpeed(1.0);
212 /** @brief Returns the number of core of the processor. */
213 int Host::getCoreCount()
215 return pimpl_cpu->coreCount();
218 /** @brief Set the pstate at which the host should run */
219 void Host::setPstate(int pstate_index)
221 simgrid::simix::kernelImmediate([this, pstate_index] { this->pimpl_cpu->setPState(pstate_index); });
223 /** @brief Retrieve the pstate at which the host is currently running */
224 int Host::getPstate()
226 return this->pimpl_cpu->getPState();
230 * \ingroup simix_storage_management
231 * \brief Returns the list of storages attached to an host.
232 * \return a vector containing all storages attached to the host
234 std::vector<const char*> Host::get_attached_storages()
236 return simgrid::simix::kernelImmediate([this] { return this->pimpl_->get_attached_storages(); });
239 void Host::getAttachedStorages(std::vector<const char*>* storages)
241 std::vector<const char*> local_storages =
242 simgrid::simix::kernelImmediate([this] { return this->pimpl_->get_attached_storages(); });
243 for (auto elm : local_storages)
244 storages->push_back(elm);
247 std::unordered_map<std::string, Storage*> const& Host::getMountedStorages()
249 if (mounts == nullptr) {
250 mounts = new std::unordered_map<std::string, Storage*>();
251 for (auto const& m : this->pimpl_->storage_) {
252 mounts->insert({m.first, &m.second->piface_});
258 void Host::execute(double flops)
260 Host* host_list[1] = {this};
261 double flops_list[1] = {flops};
262 smx_activity_t s = simcall_execution_parallel_start(nullptr /*name*/, 1, host_list, flops_list,
263 nullptr /*comm_sizes */, -1.0, -1 /*timeout*/);
264 simcall_execution_wait(s);
267 double Host::getLoad()
269 return this->pimpl_cpu->get_load();
273 } // namespace simgrid
275 /* **************************** Public C interface *************************** */
276 size_t sg_host_count()
278 return simgrid::s4u::Engine::get_instance()->get_host_count();
280 /** @brief Returns the host list
282 * Uses sg_host_count() to know the array size.
284 * \return an array of \ref sg_host_t containing all the hosts in the platform.
285 * \remark The host order in this array is generally different from the
286 * creation/declaration order in the XML platform (we use a hash table
288 * \see sg_host_count()
290 sg_host_t* sg_host_list()
292 xbt_assert(sg_host_count() > 0, "There is no host!");
293 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
295 sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
296 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
301 const char* sg_host_get_name(sg_host_t host)
303 return host->get_cname();
306 void* sg_host_extension_get(sg_host_t host, size_t ext)
308 return host->extension(ext);
311 size_t sg_host_extension_create(void (*deleter)(void*))
313 return simgrid::s4u::Host::extension_create(deleter);
316 sg_host_t sg_host_by_name(const char* name)
318 return simgrid::s4u::Host::by_name_or_null(name);
321 static int hostcmp_voidp(const void* pa, const void* pb)
323 return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->get_cname(),
324 (*static_cast<simgrid::s4u::Host* const*>(pb))->get_cname());
327 xbt_dynar_t sg_hosts_as_dynar()
329 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
331 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
333 for (auto const& host : list) {
334 if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
335 xbt_dynar_push(res, &host);
337 xbt_dynar_sort(res, hostcmp_voidp);
341 // ========= Layering madness ==============*
343 // ========== User data Layer ==========
344 void* sg_host_user(sg_host_t host)
346 return host->extension(USER_HOST_LEVEL);
348 void sg_host_user_set(sg_host_t host, void* userdata)
350 host->extension_set(USER_HOST_LEVEL, userdata);
352 void sg_host_user_destroy(sg_host_t host)
354 host->extension_set(USER_HOST_LEVEL, nullptr);
357 // ========= storage related functions ============
358 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
360 xbt_assert((host != nullptr), "Invalid parameters");
361 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
362 for (auto const& elm : host->getMountedStorages()) {
363 const char* mount_name = elm.first.c_str();
364 sg_storage_t storage = elm.second;
365 xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
371 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
373 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
374 std::vector<const char*> storage_vector = host->get_attached_storages();
375 for (auto const& name : storage_vector)
376 xbt_dynar_push(storage_dynar, &name);
377 return storage_dynar;
380 // =========== user-level functions ===============
381 // ================================================
382 /** @brief Returns the total speed of a host */
383 double sg_host_speed(sg_host_t host)
385 return host->getSpeed();
388 /** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
390 * \param host host to test
391 * \param pstate_index pstate to test
392 * \return Returns the processor speed associated with pstate_index
394 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
396 return host->getPstateSpeed(pstate_index);
399 /** \ingroup m_host_management
400 * \brief Return the number of cores.
403 * \return the number of cores
405 int sg_host_core_count(sg_host_t host)
407 return host->getCoreCount();
410 double sg_host_get_available_speed(sg_host_t host)
412 return host->pimpl_cpu->get_available_speed();
415 /** @brief Returns the number of power states for a host.
417 * See also @ref plugin_energy.
419 int sg_host_get_nb_pstates(sg_host_t host)
421 return host->getPstatesCount();
424 /** @brief Gets the pstate at which that host currently runs.
426 * See also @ref plugin_energy.
428 int sg_host_get_pstate(sg_host_t host)
430 return host->getPstate();
432 /** @brief Sets the pstate at which that host should run.
434 * See also @ref plugin_energy.
436 void sg_host_set_pstate(sg_host_t host, int pstate)
438 host->setPstate(pstate);
441 /** \ingroup m_host_management
443 * \brief Start the host if it is off
445 * See also #sg_host_is_on() and #sg_host_is_off() to test the current state of the host and @ref plugin_energy
446 * for more info on DVFS.
448 void sg_host_turn_on(sg_host_t host)
453 /** \ingroup m_host_management
455 * \brief Stop the host if it is on
457 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
458 * for more info on DVFS.
460 void sg_host_turn_off(sg_host_t host)
465 /** @ingroup m_host_management
466 * @brief Determine if a host is up and running.
468 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
471 * @param host host to test
472 * @return Returns true if the host is up and running, and false if it's currently down
474 int sg_host_is_on(sg_host_t host)
479 /** @ingroup m_host_management
480 * @brief Determine if a host is currently off.
482 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
485 int sg_host_is_off(sg_host_t host)
487 return host->isOff();
490 /** @brief Get the properties of an host */
491 xbt_dict_t sg_host_get_properties(sg_host_t host)
493 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
494 std::map<std::string, std::string>* props = host->getProperties();
495 if (props == nullptr)
497 for (auto const& elm : *props) {
498 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
503 /** \ingroup m_host_management
504 * \brief Returns the value of a given host property
507 * \param name a property name
508 * \return value of a property (or nullptr if property not set)
510 const char* sg_host_get_property_value(sg_host_t host, const char* name)
512 return host->getProperty(name);
515 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
517 host->setProperty(name, value);
521 * \brief Find a route between two hosts
523 * \param from where from
525 * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
527 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
529 std::vector<simgrid::s4u::Link*> vlinks;
530 from->routeTo(to, vlinks, nullptr);
531 for (auto const& link : vlinks)
532 xbt_dynar_push(links, &link);
535 * \brief Find the latency of the route between two hosts
537 * \param from where from
540 double sg_host_route_latency(sg_host_t from, sg_host_t to)
542 std::vector<simgrid::s4u::Link*> vlinks;
544 from->routeTo(to, vlinks, &res);
548 * \brief Find the bandwitdh of the route between two hosts
550 * \param from where from
553 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
555 double min_bandwidth = -1.0;
557 std::vector<simgrid::s4u::Link*> vlinks;
558 from->routeTo(to, vlinks, nullptr);
559 for (auto const& link : vlinks) {
560 double bandwidth = link->bandwidth();
561 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
562 min_bandwidth = bandwidth;
564 return min_bandwidth;
567 /** @brief Displays debugging information about a host */
568 void sg_host_dump(sg_host_t host)
570 XBT_INFO("Displaying host %s", host->get_cname());
571 XBT_INFO(" - speed: %.0f", host->getSpeed());
572 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
573 std::map<std::string, std::string>* props = host->getProperties();
575 if (not props->empty()) {
576 XBT_INFO(" - properties:");
577 for (auto const& elm : *props) {
578 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
583 /** \brief Return the list of actors attached to an host.
586 * \param whereto a dynar in which we should push actors living on that host
588 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
590 for (auto& actor : host->extension<simgrid::simix::Host>()->process_list) {
591 s4u_Actor* p = actor.ciface();
592 xbt_dynar_push(whereto, &p);
596 sg_host_t sg_host_self()
598 smx_actor_t process = SIMIX_process_self();
599 return (process == nullptr) ? nullptr : process->host;