src/s4u/s4u_Host.cpp

   1 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   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"
  10
  11 #include <string>
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
  14 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
  15
  16 int USER_HOST_LEVEL = -1;
  17
  18 namespace simgrid {
  19
  20 namespace xbt {
  21 template class Extendable<simgrid::s4u::Host>;
  22 }
  23
  24 namespace s4u {
  25
  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;
  30
  31 Host::Host(const char* name) : name_(name)
  32 {
  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);
  36 }
  37
  38 Host::~Host()
  39 {
  40   xbt_assert(currentlyDestroying_, "Please call h->destroy() instead of manually deleting it.");
  41
  42   delete pimpl_;
  43   if (pimpl_netpoint != nullptr) // not removed yet by a children class
  44     simgrid::s4u::Engine::get_instance()->netpoint_unregister(pimpl_netpoint);
  45   delete pimpl_cpu;
  46   delete mounts_;
  47 }
  48
  49 /** @brief Fire the required callbacks and destroy the object
  50  *
  51  * Don't delete directly an Host, call h->destroy() instead.
  52  *
  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).
  56  */
  57 void Host::destroy()
  58 {
  59   if (not currentlyDestroying_) {
  60     currentlyDestroying_ = true;
  61     on_destruction(*this);
  62     Engine::get_instance()->host_unregister(std::string(name_));
  63     delete this;
  64   }
  65 }
  66
  67 Host* Host::by_name(std::string name)
  68 {
  69   return Engine::get_instance()->host_by_name(name);
  70 }
  71 Host* Host::by_name(const char* name)
  72 {
  73   return Engine::get_instance()->host_by_name(std::string(name));
  74 }
  75 Host* Host::by_name_or_null(const char* name)
  76 {
  77   return Engine::get_instance()->host_by_name_or_null(std::string(name));
  78 }
  79 Host* Host::by_name_or_null(std::string name)
  80 {
  81   return Engine::get_instance()->host_by_name_or_null(name);
  82 }
  83
  84 Host* Host::current()
  85 {
  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_;
  90 }
  91
  92 void Host::turn_on()
  93 {
  94   if (is_off()) {
  95     simgrid::simix::simcall([this] {
  96       this->pimpl_->turn_on();
  97       this->pimpl_cpu->turn_on();
  98       on_state_change(*this);
  99     });
 100   }
 101 }
 102
 103 /** @brief Stop the host if it is on */
 104 void Host::turn_off()
 105 {
 106   if (is_on()) {
 107     smx_actor_t self = SIMIX_process_self();
 108     simgrid::simix::simcall([this, self] {
 109       this->pimpl_cpu->turn_off();
 110       this->pimpl_->turn_off();
 111
 112       on_state_change(*this);
 113     });
 114   }
 115 }
 116
 117 bool Host::is_on() const
 118 {
 119   return this->pimpl_cpu->is_on();
 120 }
 121
 122 int Host::get_pstate_count() const
 123 {
 124   return this->pimpl_cpu->get_pstate_count();
 125 }
 126
 127 /**
 128  * \brief Return a copy of the list of actors that are executing on this host.
 129  *
 130  * Daemons and regular actors are all mixed in this list.
 131  */
 132 std::vector<ActorPtr> Host::get_all_actors()
 133 {
 134   return pimpl_->get_all_actors();
 135 }
 136
 137 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
 138 int Host::get_actor_count()
 139 {
 140   return pimpl_->get_actor_count();
 141 }
 142
 143 /** @deprecated */
 144 void Host::getProcesses(std::vector<ActorPtr>* list)
 145 {
 146   auto actors = get_all_actors();
 147   for (auto& actor : actors)
 148     list->push_back(actor);
 149 }
 150
 151 /** @deprecated */
 152 void Host::actorList(std::vector<ActorPtr>* whereto)
 153 {
 154   auto actors = get_all_actors();
 155   for (auto& actor : actors)
 156     whereto->push_back(actor);
 157 }
 158
 159 /**
 160  * \brief Find a route toward another host
 161  *
 162  * \param dest [IN] where to
 163  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 164  * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 165  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 166  * \pre links!=nullptr
 167  *
 168  * walk through the routing components tree and find a route between hosts
 169  * by calling each "get_route" function in each routing component.
 170  */
 171 void Host::route_to(Host* dest, std::vector<Link*>& links, double* latency)
 172 {
 173   std::vector<kernel::resource::LinkImpl*> linkImpls;
 174   this->route_to(dest, linkImpls, latency);
 175   for (kernel::resource::LinkImpl* const& l : linkImpls)
 176     links.push_back(&l->piface_);
 177 }
 178
 179 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 180 void Host::route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
 181 {
 182   simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
 183   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 184     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
 185                (latency == nullptr ? -1 : *latency));
 186     for (auto const& link : links)
 187       XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
 188   }
 189 }
 190
 191 /** Get the properties assigned to a host */
 192 std::unordered_map<std::string, std::string>* Host::get_properties()
 193 {
 194   return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
 195 }
 196
 197 /** Retrieve the property value (or nullptr if not set) */
 198 const char* Host::get_property(const char* key) const
 199 {
 200   return this->pimpl_->get_property(key);
 201 }
 202
 203 void Host::set_property(std::string key, std::string value)
 204 {
 205   simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
 206 }
 207
 208 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 209 double Host::get_pstate_speed(int pstate_index) const
 210 {
 211   return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->get_pstate_peak_speed(pstate_index); });
 212 }
 213
 214 /** @brief Get the peak computing speed in flops/s at the current pstate, taking the external load into account.
 215  *
 216  *  The amount of flops per second available for computing depends on several things:
 217  *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
 218  *      computing speed you would get at another pstate)
 219  *    - If you declared an external load, then this reduces the available computing speed
 220  *      (see @ref simgrid::surf::Cpu::set_speed_trace())
 221  *
 222  *  The remaining speed is then shared between the executions located on this host.
 223  *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
 224  *
 225  *  The host may have multiple cores, and your executions may be able to use more than a single core.
 226  *
 227  *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
 228  */
 229 double Host::get_speed() const
 230 {
 231   return this->pimpl_cpu->get_speed(1.0);
 232 }
 233 /** @brief Returns the current computation load (in flops per second)
 234  * The external load (coming from an availability trace) is not taken in account.
 235  */
 236 double Host::get_load() const
 237 {
 238   return this->pimpl_cpu->get_load();
 239 }
 240 /** @brief Get the available speed ratio, between 0 and 1.
 241  *
 242  * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_trace()).
 243  */
 244 double Host::get_available_speed() const
 245 {
 246   return this->pimpl_cpu->get_speed_ratio();
 247 }
 248
 249 /** @brief Returns the number of core of the processor. */
 250 int Host::get_core_count() const
 251 {
 252   return this->pimpl_cpu->get_core_count();
 253 }
 254
 255 /** @brief Set the pstate at which the host should run */
 256 void Host::set_pstate(int pstate_index)
 257 {
 258   simgrid::simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 259 }
 260 /** @brief Retrieve the pstate at which the host is currently running */
 261 int Host::get_pstate() const
 262 {
 263   return this->pimpl_cpu->get_pstate();
 264 }
 265
 266 /**
 267  * \ingroup simix_storage_management
 268  * \brief Returns the list of storages attached to an host.
 269  * \return a vector containing all storages attached to the host
 270  */
 271 std::vector<const char*> Host::get_attached_storages() const
 272 {
 273   return simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 274 }
 275
 276 void Host::getAttachedStorages(std::vector<const char*>* storages)
 277 {
 278   std::vector<const char*> local_storages =
 279       simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 280   for (auto elm : local_storages)
 281     storages->push_back(elm);
 282 }
 283
 284 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
 285 {
 286   if (mounts_ == nullptr) {
 287     mounts_ = new std::unordered_map<std::string, Storage*>();
 288     for (auto const& m : this->pimpl_->storage_) {
 289       mounts_->insert({m.first, &m.second->piface_});
 290     }
 291   }
 292   return *mounts_;
 293 }
 294
 295 void Host::execute(double flops)
 296 {
 297   execute(flops, 1.0 /* priority */);
 298 }
 299 void Host::execute(double flops, double priority)
 300 {
 301   smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, this);
 302   simcall_execution_wait(s);
 303 }
 304
 305 } // namespace s4u
 306 } // namespace simgrid
 307
 308 /* **************************** Public C interface *************************** */
 309 size_t sg_host_count()
 310 {
 311   return simgrid::s4u::Engine::get_instance()->get_host_count();
 312 }
 313 /** @brief Returns the host list
 314  *
 315  * Uses sg_host_count() to know the array size.
 316  *
 317  * \return an array of \ref sg_host_t containing all the hosts in the platform.
 318  * \remark The host order in this array is generally different from the
 319  * creation/declaration order in the XML platform (we use a hash table
 320  * internally).
 321  * \see sg_host_count()
 322  */
 323 sg_host_t* sg_host_list()
 324 {
 325   xbt_assert(sg_host_count() > 0, "There is no host!");
 326   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 327
 328   sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
 329   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 330
 331   return res;
 332 }
 333
 334 const char* sg_host_get_name(sg_host_t host)
 335 {
 336   return host->get_cname();
 337 }
 338
 339 void* sg_host_extension_get(sg_host_t host, size_t ext)
 340 {
 341   return host->extension(ext);
 342 }
 343
 344 size_t sg_host_extension_create(void (*deleter)(void*))
 345 {
 346   return simgrid::s4u::Host::extension_create(deleter);
 347 }
 348
 349 sg_host_t sg_host_by_name(const char* name)
 350 {
 351   return simgrid::s4u::Host::by_name_or_null(name);
 352 }
 353
 354 static int hostcmp_voidp(const void* pa, const void* pb)
 355 {
 356   return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->get_cname(),
 357                 (*static_cast<simgrid::s4u::Host* const*>(pb))->get_cname());
 358 }
 359
 360 xbt_dynar_t sg_hosts_as_dynar()
 361 {
 362   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 363
 364   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 365
 366   for (auto const& host : list) {
 367     if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
 368       xbt_dynar_push(res, &host);
 369   }
 370   xbt_dynar_sort(res, hostcmp_voidp);
 371   return res;
 372 }
 373
 374 // ========= Layering madness ==============*
 375
 376 // ========== User data Layer ==========
 377 void* sg_host_user(sg_host_t host)
 378 {
 379   return host->extension(USER_HOST_LEVEL);
 380 }
 381 void sg_host_user_set(sg_host_t host, void* userdata)
 382 {
 383   host->extension_set(USER_HOST_LEVEL, userdata);
 384 }
 385 void sg_host_user_destroy(sg_host_t host)
 386 {
 387   host->extension_set(USER_HOST_LEVEL, nullptr);
 388 }
 389
 390 // ========= storage related functions ============
 391 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 392 {
 393   xbt_assert((host != nullptr), "Invalid parameters");
 394   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
 395   for (auto const& elm : host->get_mounted_storages()) {
 396     const char* mount_name = elm.first.c_str();
 397     sg_storage_t storage   = elm.second;
 398     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
 399   }
 400
 401   return res;
 402 }
 403
 404 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
 405 {
 406   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
 407   std::vector<const char*> storage_vector = host->get_attached_storages();
 408   for (auto const& name : storage_vector)
 409     xbt_dynar_push(storage_dynar, &name);
 410   return storage_dynar;
 411 }
 412
 413 // =========== user-level functions ===============
 414 // ================================================
 415 /** @brief Returns the total speed of a host */
 416 double sg_host_speed(sg_host_t host)
 417 {
 418   return host->get_speed();
 419 }
 420
 421 /** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 422  *
 423  * \param  host host to test
 424  * \param pstate_index pstate to test
 425  * \return Returns the processor speed associated with pstate_index
 426  */
 427 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
 428 {
 429   return host->get_pstate_speed(pstate_index);
 430 }
 431
 432 /** \ingroup m_host_management
 433  * \brief Return the number of cores.
 434  *
 435  * \param host a host
 436  * \return the number of cores
 437  */
 438 int sg_host_core_count(sg_host_t host)
 439 {
 440   return host->get_core_count();
 441 }
 442
 443 double sg_host_get_available_speed(sg_host_t host)
 444 {
 445   return host->get_available_speed();
 446 }
 447
 448 /** @brief Returns the number of power states for a host.
 449  *
 450  *  See also @ref plugin_energy.
 451  */
 452 int sg_host_get_nb_pstates(sg_host_t host)
 453 {
 454   return host->get_pstate_count();
 455 }
 456
 457 /** @brief Gets the pstate at which that host currently runs.
 458  *
 459  *  See also @ref plugin_energy.
 460  */
 461 int sg_host_get_pstate(sg_host_t host)
 462 {
 463   return host->get_pstate();
 464 }
 465 /** @brief Sets the pstate at which that host should run.
 466  *
 467  *  See also @ref plugin_energy.
 468  */
 469 void sg_host_set_pstate(sg_host_t host, int pstate)
 470 {
 471   host->set_pstate(pstate);
 472 }
 473
 474 /** \ingroup m_host_management
 475  *
 476  * \brief Start the host if it is off
 477  *
 478  * See also #sg_host_is_on() and #sg_host_is_off() to test the current state of the host and @ref plugin_energy
 479  * for more info on DVFS.
 480  */
 481 void sg_host_turn_on(sg_host_t host)
 482 {
 483   host->turn_on();
 484 }
 485
 486 /** \ingroup m_host_management
 487  *
 488  * \brief Stop the host if it is on
 489  *
 490  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
 491  * for more info on DVFS.
 492  */
 493 void sg_host_turn_off(sg_host_t host)
 494 {
 495   host->turn_off();
 496 }
 497
 498 /** @ingroup m_host_management
 499  * @brief Determine if a host is up and running.
 500  *
 501  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 502  * info on DVFS.
 503  *
 504  * @param host host to test
 505  * @return Returns true if the host is up and running, and false if it's currently down
 506  */
 507 int sg_host_is_on(sg_host_t host)
 508 {
 509   return host->is_on();
 510 }
 511
 512 /** @ingroup m_host_management
 513  * @brief Determine if a host is currently off.
 514  *
 515  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 516  * info on DVFS.
 517  */
 518 int sg_host_is_off(sg_host_t host)
 519 {
 520   return host->is_off();
 521 }
 522
 523 /** @brief Get the properties of an host */
 524 xbt_dict_t sg_host_get_properties(sg_host_t host)
 525 {
 526   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 527   std::unordered_map<std::string, std::string>* props = host->get_properties();
 528   if (props == nullptr)
 529     return nullptr;
 530   for (auto const& elm : *props) {
 531     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 532   }
 533   return as_dict;
 534 }
 535
 536 /** \ingroup m_host_management
 537  * \brief Returns the value of a given host property
 538  *
 539  * \param host a host
 540  * \param name a property name
 541  * \return value of a property (or nullptr if property not set)
 542 */
 543 const char* sg_host_get_property_value(sg_host_t host, const char* name)
 544 {
 545   return host->get_property(name);
 546 }
 547
 548 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 549 {
 550   host->set_property(name, value);
 551 }
 552
 553 /**
 554  * \brief Find a route between two hosts
 555  *
 556  * \param from where from
 557  * \param to where to
 558  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 559  */
 560 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 561 {
 562   std::vector<simgrid::s4u::Link*> vlinks;
 563   from->route_to(to, vlinks, nullptr);
 564   for (auto const& link : vlinks)
 565     xbt_dynar_push(links, &link);
 566 }
 567 /**
 568  * \brief Find the latency of the route between two hosts
 569  *
 570  * \param from where from
 571  * \param to where to
 572  */
 573 double sg_host_route_latency(sg_host_t from, sg_host_t to)
 574 {
 575   std::vector<simgrid::s4u::Link*> vlinks;
 576   double res = 0;
 577   from->route_to(to, vlinks, &res);
 578   return res;
 579 }
 580 /**
 581  * \brief Find the bandwitdh of the route between two hosts
 582  *
 583  * \param from where from
 584  * \param to where to
 585  */
 586 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 587 {
 588   double min_bandwidth = -1.0;
 589
 590   std::vector<simgrid::s4u::Link*> vlinks;
 591   from->route_to(to, vlinks, nullptr);
 592   for (auto const& link : vlinks) {
 593     double bandwidth = link->get_bandwidth();
 594     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 595       min_bandwidth = bandwidth;
 596   }
 597   return min_bandwidth;
 598 }
 599
 600 /** @brief Displays debugging information about a host */
 601 void sg_host_dump(sg_host_t host)
 602 {
 603   XBT_INFO("Displaying host %s", host->get_cname());
 604   XBT_INFO("  - speed: %.0f", host->get_speed());
 605   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 606   std::unordered_map<std::string, std::string>* props = host->get_properties();
 607
 608   if (not props->empty()) {
 609     XBT_INFO("  - properties:");
 610     for (auto const& elm : *props) {
 611       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 612     }
 613   }
 614 }
 615
 616 /** \brief Return the list of actors attached to an host.
 617  *
 618  * \param host a host
 619  * \param whereto a dynar in which we should push actors living on that host
 620  */
 621 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
 622 {
 623   auto actors = host->get_all_actors();
 624   for (auto& actor : actors)
 625     xbt_dynar_push(whereto, &actor);
 626 }
 627
 628 sg_host_t sg_host_self()
 629 {
 630   smx_actor_t process = SIMIX_process_self();
 631   return (process == nullptr) ? nullptr : process->host_;
 632 }