src/s4u/s4u_Host.cpp

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