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