src/s4u/s4u_Host.cpp

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