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::on_creation;
27 simgrid::xbt::signal<void(Host&)> Host::on_destruction;
28 simgrid::xbt::signal<void(Host&)> Host::on_state_change;
29 simgrid::xbt::signal<void(Host&)> Host::on_speed_change;
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;
61 on_destruction(*this);
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::simcall([this] {
96 this->extension<simgrid::simix::Host>()->turnOn();
97 this->pimpl_cpu->turn_on();
98 on_state_change(*this);
103 /** @brief Stop the host if it is on */
104 void Host::turn_off()
107 smx_actor_t self = SIMIX_process_self();
108 simgrid::simix::simcall([this, self] {
109 simgrid::simix::Host* host = this->extension<simgrid::simix::Host>();
111 xbt_assert((host != nullptr), "Invalid parameters");
113 this->pimpl_cpu->turn_off();
115 /* Clean Simulator data */
116 if (not host->process_list.empty()) {
117 for (auto& process : host->process_list) {
118 SIMIX_process_kill(&process, self);
119 XBT_DEBUG("Killing %s@%s on behalf of %s which turned off that host.", process.get_cname(),
120 process.host->get_cname(), self->get_cname());
124 on_state_change(*this);
131 return this->pimpl_cpu->is_on();
134 int Host::get_pstate_count() const
136 return this->pimpl_cpu->get_pstate_count();
140 * \brief Return a copy of the list of actors that are executing on this host.
142 * Daemons and regular actors are all mixed in this list.
144 std::vector<ActorPtr> Host::get_all_actors()
146 std::vector<ActorPtr> res;
147 for (auto& actor : this->extension<simgrid::simix::Host>()->process_list)
148 res.push_back(actor.ciface());
152 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
153 int Host::get_actor_count()
155 return this->extension<simgrid::simix::Host>()->process_list.size();
159 void Host::getProcesses(std::vector<ActorPtr>* list)
161 for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
162 list->push_back(actor.iface());
167 void Host::actorList(std::vector<ActorPtr>* whereto)
169 for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
170 whereto->push_back(actor.ciface());
175 * \brief Find a route toward another host
177 * \param dest [IN] where to
178 * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
179 * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
180 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
181 * \pre links!=nullptr
183 * walk through the routing components tree and find a route between hosts
184 * by calling each "get_route" function in each routing component.
186 void Host::route_to(Host* dest, std::vector<Link*>& links, double* latency)
188 std::vector<kernel::resource::LinkImpl*> linkImpls;
189 this->route_to(dest, linkImpls, latency);
190 for (kernel::resource::LinkImpl* const& l : linkImpls)
191 links.push_back(&l->piface_);
194 /** @brief Just like Host::routeTo, but filling an array of link implementations */
195 void Host::route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
197 simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
198 if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
199 XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
200 (latency == nullptr ? -1 : *latency));
201 for (auto const& link : links)
202 XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
206 /** Get the properties assigned to a host */
207 std::map<std::string, std::string>* Host::getProperties()
209 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
212 /** Retrieve the property value (or nullptr if not set) */
213 const char* Host::get_property(const char* key)
215 return this->pimpl_->get_property(key);
218 void Host::set_property(std::string key, std::string value)
220 simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
223 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
224 double Host::getPstateSpeed(int pstate_index)
226 return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->get_pstate_peak_speed(pstate_index); });
229 /** @brief Get the peak processor speed in flops/s, (under full load (=1.0), at the current pstate)
231 * The result also takes the external load into account.
233 double Host::getSpeed()
235 return this->pimpl_cpu->get_speed(1.0);
237 /** @brief Get the available speed ratio, between 0 and 1.
239 * This accounts for external load (see @ref set_speed_trace()).
241 double Host::get_available_speed()
243 return this->pimpl_cpu->get_speed_ratio();
246 /** @brief Returns the number of core of the processor. */
247 int Host::get_core_count()
249 return this->pimpl_cpu->get_core_count();
252 /** @brief Set the pstate at which the host should run */
253 void Host::set_pstate(int pstate_index)
255 simgrid::simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
257 /** @brief Retrieve the pstate at which the host is currently running */
258 int Host::get_pstate()
260 return this->pimpl_cpu->get_pstate();
264 * \ingroup simix_storage_management
265 * \brief Returns the list of storages attached to an host.
266 * \return a vector containing all storages attached to the host
268 std::vector<const char*> Host::get_attached_storages()
270 return simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
273 void Host::getAttachedStorages(std::vector<const char*>* storages)
275 std::vector<const char*> local_storages =
276 simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
277 for (auto elm : local_storages)
278 storages->push_back(elm);
281 std::unordered_map<std::string, Storage*> const& Host::getMountedStorages()
283 if (mounts_ == nullptr) {
284 mounts_ = new std::unordered_map<std::string, Storage*>();
285 for (auto const& m : this->pimpl_->storage_) {
286 mounts_->insert({m.first, &m.second->piface_});
292 void Host::execute(double flops)
294 execute(flops, 1.0 /* priority */);
296 void Host::execute(double flops, double priority)
298 smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, this);
299 simcall_execution_wait(s);
302 double Host::getLoad()
304 return this->pimpl_cpu->get_load();
308 } // namespace simgrid
310 /* **************************** Public C interface *************************** */
311 size_t sg_host_count()
313 return simgrid::s4u::Engine::get_instance()->get_host_count();
315 /** @brief Returns the host list
317 * Uses sg_host_count() to know the array size.
319 * \return an array of \ref sg_host_t containing all the hosts in the platform.
320 * \remark The host order in this array is generally different from the
321 * creation/declaration order in the XML platform (we use a hash table
323 * \see sg_host_count()
325 sg_host_t* sg_host_list()
327 xbt_assert(sg_host_count() > 0, "There is no host!");
328 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
330 sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
331 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
336 const char* sg_host_get_name(sg_host_t host)
338 return host->get_cname();
341 void* sg_host_extension_get(sg_host_t host, size_t ext)
343 return host->extension(ext);
346 size_t sg_host_extension_create(void (*deleter)(void*))
348 return simgrid::s4u::Host::extension_create(deleter);
351 sg_host_t sg_host_by_name(const char* name)
353 return simgrid::s4u::Host::by_name_or_null(name);
356 static int hostcmp_voidp(const void* pa, const void* pb)
358 return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->get_cname(),
359 (*static_cast<simgrid::s4u::Host* const*>(pb))->get_cname());
362 xbt_dynar_t sg_hosts_as_dynar()
364 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
366 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
368 for (auto const& host : list) {
369 if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
370 xbt_dynar_push(res, &host);
372 xbt_dynar_sort(res, hostcmp_voidp);
376 // ========= Layering madness ==============*
378 // ========== User data Layer ==========
379 void* sg_host_user(sg_host_t host)
381 return host->extension(USER_HOST_LEVEL);
383 void sg_host_user_set(sg_host_t host, void* userdata)
385 host->extension_set(USER_HOST_LEVEL, userdata);
387 void sg_host_user_destroy(sg_host_t host)
389 host->extension_set(USER_HOST_LEVEL, nullptr);
392 // ========= storage related functions ============
393 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
395 xbt_assert((host != nullptr), "Invalid parameters");
396 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
397 for (auto const& elm : host->getMountedStorages()) {
398 const char* mount_name = elm.first.c_str();
399 sg_storage_t storage = elm.second;
400 xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
406 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
408 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
409 std::vector<const char*> storage_vector = host->get_attached_storages();
410 for (auto const& name : storage_vector)
411 xbt_dynar_push(storage_dynar, &name);
412 return storage_dynar;
415 // =========== user-level functions ===============
416 // ================================================
417 /** @brief Returns the total speed of a host */
418 double sg_host_speed(sg_host_t host)
420 return host->getSpeed();
423 /** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
425 * \param host host to test
426 * \param pstate_index pstate to test
427 * \return Returns the processor speed associated with pstate_index
429 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
431 return host->getPstateSpeed(pstate_index);
434 /** \ingroup m_host_management
435 * \brief Return the number of cores.
438 * \return the number of cores
440 int sg_host_core_count(sg_host_t host)
442 return host->get_core_count();
445 double sg_host_get_available_speed(sg_host_t host)
447 return host->get_available_speed();
450 /** @brief Returns the number of power states for a host.
452 * See also @ref plugin_energy.
454 int sg_host_get_nb_pstates(sg_host_t host)
456 return host->get_pstate_count();
459 /** @brief Gets the pstate at which that host currently runs.
461 * See also @ref plugin_energy.
463 int sg_host_get_pstate(sg_host_t host)
465 return host->get_pstate();
467 /** @brief Sets the pstate at which that host should run.
469 * See also @ref plugin_energy.
471 void sg_host_set_pstate(sg_host_t host, int pstate)
473 host->set_pstate(pstate);
476 /** \ingroup m_host_management
478 * \brief Start the host if it is off
480 * See also #sg_host_is_on() and #sg_host_is_off() to test the current state of the host and @ref plugin_energy
481 * for more info on DVFS.
483 void sg_host_turn_on(sg_host_t host)
488 /** \ingroup m_host_management
490 * \brief Stop the host if it is on
492 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
493 * for more info on DVFS.
495 void sg_host_turn_off(sg_host_t host)
500 /** @ingroup m_host_management
501 * @brief Determine if a host is up and running.
503 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
506 * @param host host to test
507 * @return Returns true if the host is up and running, and false if it's currently down
509 int sg_host_is_on(sg_host_t host)
511 return host->is_on();
514 /** @ingroup m_host_management
515 * @brief Determine if a host is currently off.
517 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
520 int sg_host_is_off(sg_host_t host)
522 return host->is_off();
525 /** @brief Get the properties of an host */
526 xbt_dict_t sg_host_get_properties(sg_host_t host)
528 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
529 std::map<std::string, std::string>* props = host->getProperties();
530 if (props == nullptr)
532 for (auto const& elm : *props) {
533 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
538 /** \ingroup m_host_management
539 * \brief Returns the value of a given host property
542 * \param name a property name
543 * \return value of a property (or nullptr if property not set)
545 const char* sg_host_get_property_value(sg_host_t host, const char* name)
547 return host->get_property(name);
550 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
552 host->set_property(name, value);
556 * \brief Find a route between two hosts
558 * \param from where from
560 * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
562 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
564 std::vector<simgrid::s4u::Link*> vlinks;
565 from->route_to(to, vlinks, nullptr);
566 for (auto const& link : vlinks)
567 xbt_dynar_push(links, &link);
570 * \brief Find the latency of the route between two hosts
572 * \param from where from
575 double sg_host_route_latency(sg_host_t from, sg_host_t to)
577 std::vector<simgrid::s4u::Link*> vlinks;
579 from->route_to(to, vlinks, &res);
583 * \brief Find the bandwitdh of the route between two hosts
585 * \param from where from
588 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
590 double min_bandwidth = -1.0;
592 std::vector<simgrid::s4u::Link*> vlinks;
593 from->route_to(to, vlinks, nullptr);
594 for (auto const& link : vlinks) {
595 double bandwidth = link->get_bandwidth();
596 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
597 min_bandwidth = bandwidth;
599 return min_bandwidth;
602 /** @brief Displays debugging information about a host */
603 void sg_host_dump(sg_host_t host)
605 XBT_INFO("Displaying host %s", host->get_cname());
606 XBT_INFO(" - speed: %.0f", host->getSpeed());
607 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
608 std::map<std::string, std::string>* props = host->getProperties();
610 if (not props->empty()) {
611 XBT_INFO(" - properties:");
612 for (auto const& elm : *props) {
613 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
618 /** \brief Return the list of actors attached to an host.
621 * \param whereto a dynar in which we should push actors living on that host
623 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
625 for (auto& actor : host->extension<simgrid::simix::Host>()->process_list) {
626 s4u_Actor* p = actor.ciface();
627 xbt_dynar_push(whereto, &p);
631 sg_host_t sg_host_self()
633 smx_actor_t process = SIMIX_process_self();
634 return (process == nullptr) ? nullptr : process->host;