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