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) // deprecated 331
 180 {
 181   Comm::sendto_async(this, dest, byte_amount)->wait();
 182 }
 183
 184 CommPtr Host::sendto_async(Host* dest, double byte_amount) // deprecated 331
 185 {
 186   return Comm::sendto_async(this, dest, byte_amount);
 187 }
 188
 189 void Host::send_to(Host* dest, double byte_amount) // deprecated 330
 190 {
 191   Comm::sendto(this, dest, byte_amount);
 192 }
 193
 194 /** Get the properties assigned to a host */
 195 const std::unordered_map<std::string, std::string>* Host::get_properties() const
 196 {
 197   return this->pimpl_->get_properties();
 198 }
 199
 200 /** Retrieve the property value (or nullptr if not set) */
 201 const char* Host::get_property(const std::string& key) const
 202 {
 203   return this->pimpl_->get_property(key);
 204 }
 205
 206 Host* Host::set_property(const std::string& key, const std::string& value)
 207 {
 208   kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
 209   return this;
 210 }
 211
 212 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
 213 {
 214   kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
 215   return this;
 216 }
 217
 218 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
 219  * The profile must contain boolean values. */
 220 Host* Host::set_state_profile(kernel::profile::Profile* p)
 221 {
 222   kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
 223   return this;
 224 }
 225 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
 226  *
 227  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
 228  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
 229  * at this pstate level) by the rate coming from the profile.
 230  */
 231 Host* Host::set_speed_profile(kernel::profile::Profile* p)
 232 {
 233   kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
 234   return this;
 235 }
 236
 237 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 238 double Host::get_pstate_speed(int pstate_index) const
 239 {
 240   return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
 241 }
 242
 243 double Host::get_speed() const
 244 {
 245   return this->pimpl_cpu->get_speed(1.0);
 246 }
 247 double Host::get_load() const
 248 {
 249   return this->pimpl_cpu->get_load();
 250 }
 251 double Host::get_available_speed() const
 252 {
 253   return this->pimpl_cpu->get_speed_ratio();
 254 }
 255
 256 int Host::get_core_count() const
 257 {
 258   return this->pimpl_cpu->get_core_count();
 259 }
 260
 261 Host* Host::set_core_count(int core_count)
 262 {
 263   kernel::actor::simcall([this, core_count] { this->pimpl_cpu->set_core_count(core_count); });
 264   return this;
 265 }
 266
 267 /** @brief Set the pstate at which the host should run */
 268 Host* Host::set_pstate(int pstate_index)
 269 {
 270   kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 271   return this;
 272 }
 273
 274 /** @brief Retrieve the pstate at which the host is currently running */
 275 int Host::get_pstate() const
 276 {
 277   return this->pimpl_cpu->get_pstate();
 278 }
 279
 280 std::vector<Disk*> Host::get_disks() const
 281 {
 282   return this->pimpl_->get_disks();
 283 }
 284
 285 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
 286 {
 287   auto disk =
 288       this->get_netpoint()->get_englobing_zone()->get_disk_model()->create_disk(name, read_bandwidth, write_bandwidth);
 289   return disk->set_host(this)->get_iface();
 290 }
 291
 292 void Host::add_disk(const Disk* disk)
 293 {
 294   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
 295 }
 296
 297 void Host::remove_disk(const std::string& disk_name)
 298 {
 299   kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
 300 }
 301
 302 ExecPtr Host::exec_init(double flops) const
 303 {
 304   return this_actor::exec_init(flops);
 305 }
 306
 307 ExecPtr Host::exec_async(double flops) const
 308 {
 309   return this_actor::exec_async(flops);
 310 }
 311
 312 void Host::execute(double flops) const
 313 {
 314   execute(flops, 1.0 /* priority */);
 315 }
 316
 317 void Host::execute(double flops, double priority) const
 318 {
 319   this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
 320 }
 321
 322 } // namespace s4u
 323 } // namespace simgrid
 324
 325 /* **************************** Public C interface *************************** */
 326 size_t sg_host_count()
 327 {
 328   return simgrid::s4u::Engine::get_instance()->get_host_count();
 329 }
 330 sg_host_t* sg_host_list()
 331 {
 332   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
 333   size_t host_count             = e->get_host_count();
 334
 335   xbt_assert(host_count > 0, "There is no host!");
 336   std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
 337
 338   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
 339   std::copy(begin(hosts), end(hosts), res);
 340
 341   return res;
 342 }
 343
 344 const char* sg_host_get_name(const_sg_host_t host)
 345 {
 346   return host->get_cname();
 347 }
 348
 349 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
 350 {
 351   return host->extension(ext);
 352 }
 353
 354 size_t sg_host_extension_create(void (*deleter)(void*))
 355 {
 356   return simgrid::s4u::Host::extension_create(deleter);
 357 }
 358
 359 sg_host_t sg_host_by_name(const char* name)
 360 {
 361   return simgrid::s4u::Host::by_name_or_null(name);
 362 }
 363
 364 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
 365 {
 366   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 367
 368   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
 369     return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
 370   });
 371   std::sort(begin(list), last,
 372             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
 373
 374   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 375   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
 376   return res;
 377 }
 378
 379 // ========= Layering madness ==============*
 380
 381 // ========== User data Layer ==========
 382 void* sg_host_get_data(const_sg_host_t host)
 383 {
 384   return host->get_data();
 385 }
 386 void sg_host_set_data(sg_host_t host, void* userdata)
 387 {
 388   host->set_data(userdata);
 389 }
 390 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 391 {
 392   return sg_host_get_data(host);
 393 }
 394 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
 395 {
 396   sg_host_set_data(host, userdata);
 397 }
 398 void* sg_host_user(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
 399 {
 400   return host->get_data();
 401 }
 402 void sg_host_user_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v328
 403 {
 404   host->set_data(userdata);
 405 }
 406 void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
 407 {
 408   host->set_data(nullptr);
 409 }
 410
 411 // ========= Disk related functions ============
 412 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
 413 {
 414   std::vector<sg_disk_t> list = host->get_disks();
 415   *disk_count                 = list.size();
 416   *disks                      = xbt_new(sg_disk_t, list.size());
 417   std::copy(begin(list), end(list), *disks);
 418 }
 419
 420 // =========== user-level functions ===============
 421 // ================================================
 422 /** @brief Returns the total speed of a host */
 423 double sg_host_get_speed(const_sg_host_t host)
 424 {
 425   return host->get_speed();
 426 }
 427
 428 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 429 {
 430   return sg_host_get_speed(host);
 431 }
 432
 433 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 434  *
 435  * @param  host host to test
 436  * @param pstate_index pstate to test
 437  * @return Returns the processor speed associated with pstate_index
 438  */
 439 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
 440 {
 441   return host->get_pstate_speed(pstate_index);
 442 }
 443
 444 /** @ingroup m_host_management
 445  * @brief Return the number of cores.
 446  *
 447  * @param host a host
 448  * @return the number of cores
 449  */
 450 int sg_host_core_count(const_sg_host_t host)
 451 {
 452   return host->get_core_count();
 453 }
 454
 455 double sg_host_get_available_speed(const_sg_host_t host)
 456 {
 457   return host->get_available_speed();
 458 }
 459
 460 /** @brief Returns the number of power states for a host.
 461  *
 462  *  See also @ref plugin_energy.
 463  */
 464 int sg_host_get_nb_pstates(const_sg_host_t host)
 465 {
 466   return host->get_pstate_count();
 467 }
 468
 469 /** @brief Gets the pstate at which that host currently runs.
 470  *
 471  *  See also @ref plugin_energy.
 472  */
 473 int sg_host_get_pstate(const_sg_host_t host)
 474 {
 475   return host->get_pstate();
 476 }
 477 /** @brief Sets the pstate at which that host should run.
 478  *
 479  *  See also @ref plugin_energy.
 480  */
 481 void sg_host_set_pstate(sg_host_t host, int pstate)
 482 {
 483   host->set_pstate(pstate);
 484 }
 485
 486 /** @ingroup m_host_management
 487  *
 488  * @brief Start the host if it is off
 489  *
 490  * See also #sg_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_on(sg_host_t host)
 494 {
 495   host->turn_on();
 496 }
 497
 498 /** @ingroup m_host_management
 499  *
 500  * @brief Stop the host if it is on
 501  *
 502  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
 503  * for more info on DVFS.
 504  */
 505 void sg_host_turn_off(sg_host_t host)
 506 {
 507   host->turn_off();
 508 }
 509
 510 /** @ingroup m_host_management
 511  * @brief Determine if a host is up and running.
 512  *
 513  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 514  * info on DVFS.
 515  *
 516  * @param host host to test
 517  * @return Returns true if the host is up and running, and false if it's currently down
 518  */
 519 int sg_host_is_on(const_sg_host_t host)
 520 {
 521   return host->is_on();
 522 }
 523
 524 /** @brief Get the properties of a host */
 525 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
 526 {
 527   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 528   xbt_dict_t as_dict                                        = xbt_dict_new_homogeneous(xbt_free_f);
 529
 530   if (props == nullptr)
 531     return nullptr;
 532   for (auto const& elm : *props) {
 533     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
 534   }
 535   return as_dict;
 536 }
 537
 538 /** @ingroup m_host_management
 539  * @brief Returns the value of a given host property
 540  *
 541  * @param host a host
 542  * @param name a property name
 543  * @return value of a property (or nullptr if property not set)
 544  */
 545 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
 546 {
 547   return host->get_property(name);
 548 }
 549
 550 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 551 {
 552   host->set_property(name, value);
 553 }
 554
 555 /**
 556  * @brief Find a route between two hosts
 557  *
 558  * @param from where from
 559  * @param to where to
 560  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 561  */
 562 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
 563 {
 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);
 568 }
 569 /**
 570  * @brief Find the latency of the route between two hosts
 571  *
 572  * @param from where from
 573  * @param to where to
 574  */
 575 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
 576 {
 577   std::vector<simgrid::s4u::Link*> vlinks;
 578   double res = 0;
 579   from->route_to(to, vlinks, &res);
 580   return res;
 581 }
 582 /**
 583  * @brief Find the bandwidth of the route between two hosts
 584  *
 585  * @param from where from
 586  * @param to where to
 587  */
 588 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
 589 {
 590   double min_bandwidth = -1.0;
 591
 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;
 598   }
 599   return min_bandwidth;
 600 }
 601
 602 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
 603 {
 604   sg_host_get_route(from, to, links);
 605 }
 606
 607 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
 608 {
 609   return sg_host_get_route_latency(from, to);
 610 }
 611
 612 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
 613 {
 614   return sg_host_get_route_bandwidth(from, to);
 615 }
 616
 617 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
 618 {
 619   simgrid::s4u::Comm::sendto(from, to, byte_amount);
 620 }
 621
 622 /** @brief Displays debugging information about a host */
 623 void sg_host_dump(const_sg_host_t host)
 624 {
 625   XBT_INFO("Displaying host %s", host->get_cname());
 626   XBT_INFO("  - speed: %.0f", host->get_speed());
 627   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 628   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 629
 630   if (not props->empty()) {
 631     XBT_INFO("  - properties:");
 632     for (auto const& elm : *props) {
 633       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 634     }
 635   }
 636 }
 637
 638 /** @brief Return the list of actors attached to a host.
 639  *
 640  * @param host a host
 641  * @param whereto a dynar in which we should push actors living on that host
 642  */
 643 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
 644 {
 645   auto const actors = host->get_all_actors();
 646   for (auto const& actor : actors)
 647     xbt_dynar_push(whereto, &actor);
 648 }
 649
 650 sg_host_t sg_host_self()
 651 {
 652   return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
 653 }
 654
 655 /* needs to be public and without simcall for exceptions and logging events */
 656 const char* sg_host_self_get_name()
 657 {
 658   const char* res = "";
 659   if (not SIMIX_is_maestro()) {
 660     const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
 661     if (host != nullptr)
 662       res = host->get_cname();
 663   }
 664   return res;
 665 }
 666
 667 double sg_host_get_load(const_sg_host_t host)
 668 {
 669   return host->get_load();
 670 }
 671
 672 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 673 {
 674   return sg_host_get_load(host);
 675 }