src/s4u/s4u_Host.cpp

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