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 Host* Host::set_core_count(int core_count)
 255 {
 256   this->pimpl_cpu->set_core_count(core_count);
 257   return this;
 258 }
 259
 260 /** @brief Set the pstate at which the host should run */
 261 void Host::set_pstate(int pstate_index)
 262 {
 263   kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 264 }
 265 /** @brief Retrieve the pstate at which the host is currently running */
 266 int Host::get_pstate() const
 267 {
 268   return this->pimpl_cpu->get_pstate();
 269 }
 270
 271 std::vector<Disk*> Host::get_disks() const
 272 {
 273   return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
 274 }
 275
 276 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
 277 {
 278   return surf_disk_model->create_disk(name, read_bandwidth, write_bandwidth)->set_host(this)->get_iface();
 279 }
 280
 281 void Host::add_disk(const Disk* disk)
 282 {
 283   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
 284 }
 285
 286 void Host::remove_disk(const std::string& disk_name)
 287 {
 288   kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
 289 }
 290
 291 ExecPtr Host::exec_init(double flops) const
 292 {
 293   return this_actor::exec_init(flops);
 294 }
 295
 296 ExecPtr Host::exec_async(double flops) const
 297 {
 298   return this_actor::exec_async(flops);
 299 }
 300
 301 void Host::execute(double flops) const
 302 {
 303   execute(flops, 1.0 /* priority */);
 304 }
 305
 306 void Host::execute(double flops, double priority) const
 307 {
 308   this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
 309 }
 310
 311 } // namespace s4u
 312 } // namespace simgrid
 313
 314 /* **************************** Public C interface *************************** */
 315 size_t sg_host_count()
 316 {
 317   return simgrid::s4u::Engine::get_instance()->get_host_count();
 318 }
 319 sg_host_t* sg_host_list()
 320 {
 321   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
 322   size_t host_count       = e->get_host_count();
 323   xbt_assert(host_count > 0, "There is no host!");
 324   std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
 325
 326   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
 327   std::copy(begin(hosts), end(hosts), res);
 328
 329   return res;
 330 }
 331
 332 const char* sg_host_get_name(const_sg_host_t host)
 333 {
 334   return host->get_cname();
 335 }
 336
 337 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
 338 {
 339   return host->extension(ext);
 340 }
 341
 342 size_t sg_host_extension_create(void (*deleter)(void*))
 343 {
 344   return simgrid::s4u::Host::extension_create(deleter);
 345 }
 346
 347 sg_host_t sg_host_by_name(const char* name)
 348 {
 349   return simgrid::s4u::Host::by_name_or_null(name);
 350 }
 351
 352 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
 353 {
 354   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 355
 356   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
 357     return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
 358   });
 359   std::sort(begin(list), last,
 360             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
 361
 362   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 363   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
 364   return res;
 365 }
 366
 367 // ========= Layering madness ==============*
 368
 369 // ========== User data Layer ==========
 370 void* sg_host_get_data(const_sg_host_t host)
 371 {
 372   return host->get_data();
 373 }
 374 void sg_host_set_data(sg_host_t host, void* userdata)
 375 {
 376   host->set_data(userdata);
 377 }
 378 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 379 {
 380   return sg_host_get_data(host);
 381 }
 382 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
 383 {
 384   sg_host_set_data(host, userdata);
 385 }
 386 void* sg_host_user(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
 387 {
 388   return host->get_data();
 389 }
 390 void sg_host_user_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v328
 391 {
 392   host->set_data(userdata);
 393 }
 394 void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
 395 {
 396   host->set_data(nullptr);
 397 }
 398
 399 // ========= Disk related functions ============
 400 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
 401 {
 402   std::vector<sg_disk_t> list = host->get_disks();
 403   *disk_count                 = list.size();
 404   *disks                      = xbt_new(sg_disk_t, list.size());
 405   std::copy(begin(list), end(list), *disks);
 406 }
 407
 408 // =========== user-level functions ===============
 409 // ================================================
 410 /** @brief Returns the total speed of a host */
 411 double sg_host_get_speed(const_sg_host_t host)
 412 {
 413   return host->get_speed();
 414 }
 415
 416 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 417 {
 418   return sg_host_get_speed(host);
 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(const_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(const_sg_host_t host)
 439 {
 440   return host->get_core_count();
 441 }
 442
 443 double sg_host_get_available_speed(const_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(const_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(const_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() 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() 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(const_sg_host_t host)
 508 {
 509   return host->is_on();
 510 }
 511
 512 /** @brief Get the properties of a host */
 513 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
 514 {
 515   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 516   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 517   if (props == nullptr)
 518     return nullptr;
 519   for (auto const& elm : *props) {
 520     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
 521   }
 522   return as_dict;
 523 }
 524
 525 /** @ingroup m_host_management
 526  * @brief Returns the value of a given host property
 527  *
 528  * @param host a host
 529  * @param name a property name
 530  * @return value of a property (or nullptr if property not set)
 531  */
 532 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
 533 {
 534   return host->get_property(name);
 535 }
 536
 537 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 538 {
 539   host->set_property(name, value);
 540 }
 541
 542 /**
 543  * @brief Find a route between two hosts
 544  *
 545  * @param from where from
 546  * @param to where to
 547  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 548  */
 549 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
 550 {
 551   std::vector<simgrid::s4u::Link*> vlinks;
 552   from->route_to(to, vlinks, nullptr);
 553   for (auto const& link : vlinks)
 554     xbt_dynar_push(links, &link);
 555 }
 556 /**
 557  * @brief Find the latency of the route between two hosts
 558  *
 559  * @param from where from
 560  * @param to where to
 561  */
 562 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
 563 {
 564   std::vector<simgrid::s4u::Link*> vlinks;
 565   double res = 0;
 566   from->route_to(to, vlinks, &res);
 567   return res;
 568 }
 569 /**
 570  * @brief Find the bandwidth of the route between two hosts
 571  *
 572  * @param from where from
 573  * @param to where to
 574  */
 575 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
 576 {
 577   double min_bandwidth = -1.0;
 578
 579   std::vector<simgrid::s4u::Link*> vlinks;
 580   from->route_to(to, vlinks, nullptr);
 581   for (auto const& link : vlinks) {
 582     double bandwidth = link->get_bandwidth();
 583     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 584       min_bandwidth = bandwidth;
 585   }
 586   return min_bandwidth;
 587 }
 588
 589 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
 590 {
 591   sg_host_get_route(from, to, links);
 592 }
 593
 594 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
 595 {
 596   return sg_host_get_route_latency(from, to);
 597 }
 598
 599 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
 600 {
 601   return sg_host_get_route_bandwidth(from, to);
 602 }
 603
 604 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
 605 {
 606   from->sendto(to, byte_amount);
 607 }
 608
 609 /** @brief Displays debugging information about a host */
 610 void sg_host_dump(const_sg_host_t host)
 611 {
 612   XBT_INFO("Displaying host %s", host->get_cname());
 613   XBT_INFO("  - speed: %.0f", host->get_speed());
 614   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 615   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 616
 617   if (not props->empty()) {
 618     XBT_INFO("  - properties:");
 619     for (auto const& elm : *props) {
 620       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 621     }
 622   }
 623 }
 624
 625 /** @brief Return the list of actors attached to a host.
 626  *
 627  * @param host a host
 628  * @param whereto a dynar in which we should push actors living on that host
 629  */
 630 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
 631 {
 632   auto const actors = host->get_all_actors();
 633   for (auto const& actor : actors)
 634     xbt_dynar_push(whereto, &actor);
 635 }
 636
 637 sg_host_t sg_host_self()
 638 {
 639   return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
 640 }
 641
 642 /* needs to be public and without simcall for exceptions and logging events */
 643 const char* sg_host_self_get_name()
 644 {
 645   const char* res = "";
 646   if (not SIMIX_is_maestro()) {
 647     const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
 648     if (host != nullptr)
 649       res = host->get_cname();
 650   }
 651   return res;
 652 }
 653
 654 double sg_host_get_load(const_sg_host_t host)
 655 {
 656   return host->get_load();
 657 }
 658
 659 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 660 {
 661   return sg_host_get_load(host);
 662 }