src/s4u/s4u_Host.cpp

   1 /* Copyright (c) 2006-2021. 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/host.h"
   7 #include "simgrid/kernel/routing/NetPoint.hpp"
   8 #include "simgrid/s4u/Actor.hpp"
   9 #include "simgrid/s4u/Comm.hpp"
  10 #include "simgrid/s4u/Engine.hpp"
  11 #include "simgrid/s4u/Exec.hpp"
  12 #include "simgrid/s4u/VirtualMachine.hpp"
  13 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  14 #include "src/surf/HostImpl.hpp"
  15
  16 #include <algorithm>
  17 #include <string>
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
  20 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
  21
  22 namespace simgrid {
  23
  24 template class xbt::Extendable<s4u::Host>;
  25
  26 namespace s4u {
  27
  28 xbt::signal<void(Host&)> Host::on_creation;
  29 xbt::signal<void(Host const&)> Host::on_destruction;
  30 xbt::signal<void(Host const&)> Host::on_state_change;
  31 xbt::signal<void(Host const&)> Host::on_speed_change;
  32
  33 Host::Host(const std::string& name) : name_(name)
  34 {
  35   xbt_assert(Host::by_name_or_null(name_) == nullptr, "Refusing to create a second host named '%s'.", get_cname());
  36   Engine::get_instance()->host_register(name_, this);
  37   new surf::HostImpl(this);
  38 }
  39
  40 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
  41 {
  42   pimpl_netpoint_ = netpoint;
  43   return this;
  44 }
  45
  46 Host::~Host()
  47 {
  48   delete pimpl_;
  49   if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
  50     Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
  51   delete pimpl_cpu;
  52 }
  53
  54 /** @brief Fire the required callbacks and destroy the object
  55  *
  56  * Don't delete directly a host, call h->destroy() instead.
  57  *
  58  * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
  59  * object (because of the destructor order in a class hierarchy).
  60  */
  61 void Host::destroy()
  62 {
  63   on_destruction(*this);
  64   Engine::get_instance()->host_unregister(std::string(name_));
  65   delete this;
  66 }
  67
  68 Host* Host::by_name(const std::string& name)
  69 {
  70   return Engine::get_instance()->host_by_name(name);
  71 }
  72 Host* Host::by_name_or_null(const std::string& name)
  73 {
  74   return Engine::get_instance()->host_by_name_or_null(name);
  75 }
  76
  77 Host* Host::current()
  78 {
  79   kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
  80   if (self == nullptr)
  81     xbt_die("Cannot call Host::current() from the maestro context");
  82   return self->get_host();
  83 }
  84
  85 void Host::turn_on()
  86 {
  87   if (not is_on()) {
  88     kernel::actor::simcall([this] {
  89       this->pimpl_cpu->turn_on();
  90       this->pimpl_->turn_on();
  91       on_state_change(*this);
  92     });
  93   }
  94 }
  95
  96 /** @brief Stop the host if it is on */
  97 void Host::turn_off()
  98 {
  99   if (is_on()) {
 100     const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
 101     kernel::actor::simcall([this, self] {
 102       for (VirtualMachine* const& vm : vm::VirtualMachineImpl::allVms_)
 103         if (vm->get_pm() == this) {
 104           vm->shutdown();
 105           vm->turn_off();
 106         }
 107       this->pimpl_cpu->turn_off();
 108       this->pimpl_->turn_off(self);
 109
 110       on_state_change(*this);
 111     });
 112   }
 113 }
 114
 115 bool Host::is_on() const
 116 {
 117   return this->pimpl_cpu->is_on();
 118 }
 119
 120 int Host::get_pstate_count() const
 121 {
 122   return this->pimpl_cpu->get_pstate_count();
 123 }
 124
 125 /**
 126  * @brief Return a copy of the list of actors that are executing on this host.
 127  *
 128  * Daemons and regular actors are all mixed in this list.
 129  */
 130 std::vector<ActorPtr> Host::get_all_actors() const
 131 {
 132   return pimpl_->get_all_actors();
 133 }
 134
 135 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
 136 int Host::get_actor_count() const
 137 {
 138   return pimpl_->get_actor_count();
 139 }
 140
 141 /**
 142  * @brief Find a route toward another host
 143  *
 144  * @param dest [IN] where to
 145  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 146  * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 147  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 148  * @pre links!=nullptr
 149  *
 150  * walk through the routing components tree and find a route between hosts
 151  * by calling each "get_route" function in each routing component.
 152  */
 153 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
 154 {
 155   std::vector<kernel::resource::LinkImpl*> linkImpls;
 156   this->route_to(dest, linkImpls, latency);
 157   for (auto* l : linkImpls)
 158     links.push_back(l->get_iface());
 159 }
 160
 161 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 162 void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const
 163 {
 164   kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
 165   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 166     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
 167                (latency == nullptr ? -1 : *latency));
 168     for (auto const* link : links)
 169       XBT_CDEBUG(surf_route, "  Link '%s'", link->get_cname());
 170   }
 171 }
 172
 173 /** @brief Returns the networking zone englobing that host */
 174 NetZone* Host::get_englobing_zone()
 175 {
 176   return pimpl_netpoint_->get_englobing_zone()->get_iface();
 177 }
 178
 179 void Host::sendto(Host* dest, double byte_amount)
 180 {
 181   sendto_async(dest, byte_amount)->wait();
 182 }
 183
 184 CommPtr Host::sendto_async(Host* dest, double byte_amount)
 185 {
 186   return Comm::sendto_async(this, dest, byte_amount);
 187 }
 188
 189 /** Get the properties assigned to a host */
 190 const std::unordered_map<std::string, std::string>* Host::get_properties() const
 191 {
 192   return this->pimpl_->get_properties();
 193 }
 194
 195 /** Retrieve the property value (or nullptr if not set) */
 196 const char* Host::get_property(const std::string& key) const
 197 {
 198   return this->pimpl_->get_property(key);
 199 }
 200
 201 Host* Host::set_property(const std::string& key, const std::string& value)
 202 {
 203   kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
 204   return this;
 205 }
 206
 207 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
 208 {
 209   kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
 210   return this;
 211 }
 212
 213 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
 214  * The profile must contain boolean values. */
 215 void Host::set_state_profile(kernel::profile::Profile* p)
 216 {
 217   return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
 218 }
 219 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
 220  *
 221  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
 222  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
 223  * at this pstate level) by the rate coming from the profile.
 224  */
 225 void Host::set_speed_profile(kernel::profile::Profile* p)
 226 {
 227   return kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
 228 }
 229
 230 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 231 double Host::get_pstate_speed(int pstate_index) const
 232 {
 233   return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
 234 }
 235
 236 double Host::get_speed() const
 237 {
 238   return this->pimpl_cpu->get_speed(1.0);
 239 }
 240 double Host::get_load() const
 241 {
 242   return this->pimpl_cpu->get_load();
 243 }
 244 double Host::get_available_speed() const
 245 {
 246   return this->pimpl_cpu->get_speed_ratio();
 247 }
 248
 249 int Host::get_core_count() const
 250 {
 251   return this->pimpl_cpu->get_core_count();
 252 }
 253
 254 /** @brief Set the pstate at which the host should run */
 255 void Host::set_pstate(int pstate_index)
 256 {
 257   kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 258 }
 259 /** @brief Retrieve the pstate at which the host is currently running */
 260 int Host::get_pstate() const
 261 {
 262   return this->pimpl_cpu->get_pstate();
 263 }
 264
 265 std::vector<Disk*> Host::get_disks() const
 266 {
 267   return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
 268 }
 269
 270 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
 271 {
 272   auto pimpl = surf_disk_model->create_disk(name, read_bandwidth, write_bandwidth);
 273   pimpl->set_host(this);
 274   return pimpl->get_iface();
 275 }
 276
 277 void Host::add_disk(const Disk* disk)
 278 {
 279   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
 280 }
 281
 282 void Host::remove_disk(const std::string& disk_name)
 283 {
 284   kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
 285 }
 286
 287 ExecPtr Host::exec_init(double flops) const
 288 {
 289   return this_actor::exec_init(flops);
 290 }
 291
 292 ExecPtr Host::exec_async(double flops) const
 293 {
 294   return this_actor::exec_async(flops);
 295 }
 296
 297 void Host::execute(double flops) const
 298 {
 299   execute(flops, 1.0 /* priority */);
 300 }
 301
 302 void Host::execute(double flops, double priority) const
 303 {
 304   this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
 305 }
 306
 307 } // namespace s4u
 308 } // namespace simgrid
 309
 310 /* **************************** Public C interface *************************** */
 311 size_t sg_host_count()
 312 {
 313   return simgrid::s4u::Engine::get_instance()->get_host_count();
 314 }
 315 sg_host_t* sg_host_list()
 316 {
 317   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
 318   size_t host_count       = e->get_host_count();
 319   xbt_assert(host_count > 0, "There is no host!");
 320   std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
 321
 322   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
 323   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 324
 325   return res;
 326 }
 327
 328 const char* sg_host_get_name(const_sg_host_t host)
 329 {
 330   return host->get_cname();
 331 }
 332
 333 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
 334 {
 335   return host->extension(ext);
 336 }
 337
 338 size_t sg_host_extension_create(void (*deleter)(void*))
 339 {
 340   return simgrid::s4u::Host::extension_create(deleter);
 341 }
 342
 343 sg_host_t sg_host_by_name(const char* name)
 344 {
 345   return simgrid::s4u::Host::by_name_or_null(name);
 346 }
 347
 348 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
 349 {
 350   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 351
 352   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
 353     return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
 354   });
 355   std::sort(begin(list), last,
 356             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
 357
 358   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 359   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
 360   return res;
 361 }
 362
 363 // ========= Layering madness ==============*
 364
 365 // ========== User data Layer ==========
 366 void* sg_host_get_data(const_sg_host_t host)
 367 {
 368   return host->get_data();
 369 }
 370 void sg_host_set_data(sg_host_t host, void* userdata)
 371 {
 372   host->set_data(userdata);
 373 }
 374 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 375 {
 376   return sg_host_get_data(host);
 377 }
 378 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
 379 {
 380   sg_host_set_data(host, userdata);
 381 }
 382 void* sg_host_user(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
 383 {
 384   return host->get_data();
 385 }
 386 void sg_host_user_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v328
 387 {
 388   host->set_data(userdata);
 389 }
 390 void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
 391 {
 392   host->set_data(nullptr);
 393 }
 394
 395 // ========= Disk related functions ============
 396 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
 397 {
 398   std::vector<sg_disk_t> list = host->get_disks();
 399   *disk_count                 = list.size();
 400   *disks                      = static_cast<sg_disk_t*>(xbt_malloc(sizeof(sg_disk_t) * (*disk_count)));
 401   for (size_t i = 0; i < *disk_count; i++)
 402     (*disks)[i] = list[i];
 403 }
 404
 405 // =========== user-level functions ===============
 406 // ================================================
 407 /** @brief Returns the total speed of a host */
 408 double sg_host_get_speed(const_sg_host_t host)
 409 {
 410   return host->get_speed();
 411 }
 412
 413 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 414 {
 415   return sg_host_get_speed(host);
 416 }
 417
 418 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 419  *
 420  * @param  host host to test
 421  * @param pstate_index pstate to test
 422  * @return Returns the processor speed associated with pstate_index
 423  */
 424 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
 425 {
 426   return host->get_pstate_speed(pstate_index);
 427 }
 428
 429 /** @ingroup m_host_management
 430  * @brief Return the number of cores.
 431  *
 432  * @param host a host
 433  * @return the number of cores
 434  */
 435 int sg_host_core_count(const_sg_host_t host)
 436 {
 437   return host->get_core_count();
 438 }
 439
 440 double sg_host_get_available_speed(const_sg_host_t host)
 441 {
 442   return host->get_available_speed();
 443 }
 444
 445 /** @brief Returns the number of power states for a host.
 446  *
 447  *  See also @ref plugin_energy.
 448  */
 449 int sg_host_get_nb_pstates(const_sg_host_t host)
 450 {
 451   return host->get_pstate_count();
 452 }
 453
 454 /** @brief Gets the pstate at which that host currently runs.
 455  *
 456  *  See also @ref plugin_energy.
 457  */
 458 int sg_host_get_pstate(const_sg_host_t host)
 459 {
 460   return host->get_pstate();
 461 }
 462 /** @brief Sets the pstate at which that host should run.
 463  *
 464  *  See also @ref plugin_energy.
 465  */
 466 void sg_host_set_pstate(sg_host_t host, int pstate)
 467 {
 468   host->set_pstate(pstate);
 469 }
 470
 471 /** @ingroup m_host_management
 472  *
 473  * @brief Start the host if it is off
 474  *
 475  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
 476  * for more info on DVFS.
 477  */
 478 void sg_host_turn_on(sg_host_t host)
 479 {
 480   host->turn_on();
 481 }
 482
 483 /** @ingroup m_host_management
 484  *
 485  * @brief Stop the host if it is on
 486  *
 487  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
 488  * for more info on DVFS.
 489  */
 490 void sg_host_turn_off(sg_host_t host)
 491 {
 492   host->turn_off();
 493 }
 494
 495 /** @ingroup m_host_management
 496  * @brief Determine if a host is up and running.
 497  *
 498  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 499  * info on DVFS.
 500  *
 501  * @param host host to test
 502  * @return Returns true if the host is up and running, and false if it's currently down
 503  */
 504 int sg_host_is_on(const_sg_host_t host)
 505 {
 506   return host->is_on();
 507 }
 508
 509 /** @brief Get the properties of a host */
 510 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
 511 {
 512   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 513   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 514   if (props == nullptr)
 515     return nullptr;
 516   for (auto const& elm : *props) {
 517     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
 518   }
 519   return as_dict;
 520 }
 521
 522 /** @ingroup m_host_management
 523  * @brief Returns the value of a given host property
 524  *
 525  * @param host a host
 526  * @param name a property name
 527  * @return value of a property (or nullptr if property not set)
 528  */
 529 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
 530 {
 531   return host->get_property(name);
 532 }
 533
 534 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 535 {
 536   host->set_property(name, value);
 537 }
 538
 539 /**
 540  * @brief Find a route between two hosts
 541  *
 542  * @param from where from
 543  * @param to where to
 544  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 545  */
 546 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
 547 {
 548   std::vector<simgrid::s4u::Link*> vlinks;
 549   from->route_to(to, vlinks, nullptr);
 550   for (auto const& link : vlinks)
 551     xbt_dynar_push(links, &link);
 552 }
 553 /**
 554  * @brief Find the latency of the route between two hosts
 555  *
 556  * @param from where from
 557  * @param to where to
 558  */
 559 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
 560 {
 561   std::vector<simgrid::s4u::Link*> vlinks;
 562   double res = 0;
 563   from->route_to(to, vlinks, &res);
 564   return res;
 565 }
 566 /**
 567  * @brief Find the bandwidth of the route between two hosts
 568  *
 569  * @param from where from
 570  * @param to where to
 571  */
 572 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
 573 {
 574   double min_bandwidth = -1.0;
 575
 576   std::vector<simgrid::s4u::Link*> vlinks;
 577   from->route_to(to, vlinks, nullptr);
 578   for (auto const& link : vlinks) {
 579     double bandwidth = link->get_bandwidth();
 580     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 581       min_bandwidth = bandwidth;
 582   }
 583   return min_bandwidth;
 584 }
 585
 586 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
 587 {
 588   sg_host_get_route(from, to, links);
 589 }
 590
 591 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
 592 {
 593   return sg_host_get_route_latency(from, to);
 594 }
 595
 596 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
 597 {
 598   return sg_host_get_route_bandwidth(from, to);
 599 }
 600
 601 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
 602 {
 603   from->sendto(to, byte_amount);
 604 }
 605
 606 /** @brief Displays debugging information about a host */
 607 void sg_host_dump(const_sg_host_t host)
 608 {
 609   XBT_INFO("Displaying host %s", host->get_cname());
 610   XBT_INFO("  - speed: %.0f", host->get_speed());
 611   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 612   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 613
 614   if (not props->empty()) {
 615     XBT_INFO("  - properties:");
 616     for (auto const& elm : *props) {
 617       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 618     }
 619   }
 620 }
 621
 622 /** @brief Return the list of actors attached to a host.
 623  *
 624  * @param host a host
 625  * @param whereto a dynar in which we should push actors living on that host
 626  */
 627 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
 628 {
 629   auto const actors = host->get_all_actors();
 630   for (auto const& actor : actors)
 631     xbt_dynar_push(whereto, &actor);
 632 }
 633
 634 sg_host_t sg_host_self()
 635 {
 636   return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
 637 }
 638
 639 /* needs to be public and without simcall for exceptions and logging events */
 640 const char* sg_host_self_get_name()
 641 {
 642   const char* res = "";
 643   if (not SIMIX_is_maestro()) {
 644     const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
 645     if (host != nullptr)
 646       res = host->get_cname();
 647   }
 648   return res;
 649 }
 650
 651 double sg_host_get_load(const_sg_host_t host)
 652 {
 653   return host->get_load();
 654 }
 655
 656 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 657 {
 658   return sg_host_get_load(host);
 659 }