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(const char* name) : name_(name)
  32 {
  33   xbt_assert(Host::by_name_or_null(name) == nullptr, "Refusing to create a second host named '%s'.", name);
  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(const char* name)
  72 {
  73   return Engine::get_instance()->host_by_name(std::string(name));
  74 }
  75 Host* Host::by_name_or_null(const char* name)
  76 {
  77   return Engine::get_instance()->host_by_name_or_null(std::string(name));
  78 }
  79 Host* Host::by_name_or_null(std::string name)
  80 {
  81   return Engine::get_instance()->host_by_name_or_null(name);
  82 }
  83
  84 Host* Host::current()
  85 {
  86   smx_actor_t smx_proc = SIMIX_process_self();
  87   if (smx_proc == nullptr)
  88     xbt_die("Cannot call Host::current() from the maestro context");
  89   return smx_proc->host_;
  90 }
  91
  92 void Host::turn_on()
  93 {
  94   if (is_off()) {
  95     simgrid::simix::simcall([this] {
  96       this->pimpl_->turn_on();
  97       this->pimpl_cpu->turn_on();
  98       on_state_change(*this);
  99     });
 100   }
 101 }
 102
 103 /** @brief Stop the host if it is on */
 104 void Host::turn_off()
 105 {
 106   if (is_on()) {
 107     simgrid::simix::simcall([this] {
 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 /** @deprecated */
 143 void Host::getProcesses(std::vector<ActorPtr>* list)
 144 {
 145   auto actors = get_all_actors();
 146   for (auto& actor : actors)
 147     list->push_back(actor);
 148 }
 149
 150 /** @deprecated */
 151 void Host::actorList(std::vector<ActorPtr>* whereto)
 152 {
 153   auto actors = get_all_actors();
 154   for (auto& actor : actors)
 155     whereto->push_back(actor);
 156 }
 157
 158 /**
 159  * \brief Find a route toward another host
 160  *
 161  * \param dest [IN] where to
 162  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 163  * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 164  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 165  * \pre links!=nullptr
 166  *
 167  * walk through the routing components tree and find a route between hosts
 168  * by calling each "get_route" function in each routing component.
 169  */
 170 void Host::route_to(Host* dest, std::vector<Link*>& links, double* latency)
 171 {
 172   std::vector<kernel::resource::LinkImpl*> linkImpls;
 173   this->route_to(dest, linkImpls, latency);
 174   for (kernel::resource::LinkImpl* const& l : linkImpls)
 175     links.push_back(&l->piface_);
 176 }
 177
 178 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 179 void Host::route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
 180 {
 181   simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
 182   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 183     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
 184                (latency == nullptr ? -1 : *latency));
 185     for (auto const& link : links)
 186       XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
 187   }
 188 }
 189
 190 /** Get the properties assigned to a host */
 191 std::unordered_map<std::string, std::string>* Host::get_properties()
 192 {
 193   return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
 194 }
 195
 196 /** Retrieve the property value (or nullptr if not set) */
 197 const char* Host::get_property(const char* key) const
 198 {
 199   return this->pimpl_->get_property(key);
 200 }
 201
 202 void Host::set_property(std::string key, std::string value)
 203 {
 204   simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
 205 }
 206
 207 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 208 double Host::get_pstate_speed(int pstate_index) const
 209 {
 210   return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->get_pstate_peak_speed(pstate_index); });
 211 }
 212
 213 /** @brief Get the peak computing speed in flops/s at the current pstate, taking the external load into account.
 214  *
 215  *  The amount of flops per second available for computing depends on several things:
 216  *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
 217  *      computing speed you would get at another pstate)
 218  *    - If you declared an external load, then this reduces the available computing speed
 219  *      (see @ref simgrid::surf::Cpu::set_speed_trace())
 220  *
 221  *  The remaining speed is then shared between the executions located on this host.
 222  *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
 223  *
 224  *  The host may have multiple cores, and your executions may be able to use more than a single core.
 225  *
 226  *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
 227  */
 228 double Host::get_speed() const
 229 {
 230   return this->pimpl_cpu->get_speed(1.0);
 231 }
 232 /** @brief Returns the current computation load (in flops per second)
 233  * The external load (coming from an availability trace) is not taken in account.
 234  */
 235 double Host::get_load() const
 236 {
 237   return this->pimpl_cpu->get_load();
 238 }
 239 /** @brief Get the available speed ratio, between 0 and 1.
 240  *
 241  * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_trace()).
 242  */
 243 double Host::get_available_speed() const
 244 {
 245   return this->pimpl_cpu->get_speed_ratio();
 246 }
 247
 248 /** @brief Returns the number of core of the processor. */
 249 int Host::get_core_count() const
 250 {
 251   return this->pimpl_cpu->get_core_count();
 252 }
 253
 254 /** @brief Set the pstate at which the host should run */
 255 void Host::set_pstate(int pstate_index)
 256 {
 257   simgrid::simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 258 }
 259 /** @brief Retrieve the pstate at which the host is currently running */
 260 int Host::get_pstate() const
 261 {
 262   return this->pimpl_cpu->get_pstate();
 263 }
 264
 265 /**
 266  * \ingroup simix_storage_management
 267  * \brief Returns the list of storages attached to an host.
 268  * \return a vector containing all storages attached to the host
 269  */
 270 std::vector<const char*> Host::get_attached_storages() const
 271 {
 272   return simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 273 }
 274
 275 void Host::getAttachedStorages(std::vector<const char*>* storages)
 276 {
 277   std::vector<const char*> local_storages =
 278       simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 279   for (auto elm : local_storages)
 280     storages->push_back(elm);
 281 }
 282
 283 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
 284 {
 285   if (mounts_ == nullptr) {
 286     mounts_ = new std::unordered_map<std::string, Storage*>();
 287     for (auto const& m : this->pimpl_->storage_) {
 288       mounts_->insert({m.first, &m.second->piface_});
 289     }
 290   }
 291   return *mounts_;
 292 }
 293
 294 void Host::execute(double flops)
 295 {
 296   execute(flops, 1.0 /* priority */);
 297 }
 298 void Host::execute(double flops, double priority)
 299 {
 300   smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, this);
 301   simcall_execution_wait(s);
 302 }
 303
 304 } // namespace s4u
 305 } // namespace simgrid
 306
 307 /* **************************** Public C interface *************************** */
 308 size_t sg_host_count()
 309 {
 310   return simgrid::s4u::Engine::get_instance()->get_host_count();
 311 }
 312 /** @brief Returns the host list
 313  *
 314  * Uses sg_host_count() to know the array size.
 315  *
 316  * \return an array of \ref sg_host_t containing all the hosts in the platform.
 317  * \remark The host order in this array is generally different from the
 318  * creation/declaration order in the XML platform (we use a hash table
 319  * internally).
 320  * \see sg_host_count()
 321  */
 322 sg_host_t* sg_host_list()
 323 {
 324   xbt_assert(sg_host_count() > 0, "There is no host!");
 325   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 326
 327   sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
 328   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 329
 330   return res;
 331 }
 332
 333 const char* sg_host_get_name(sg_host_t host)
 334 {
 335   return host->get_cname();
 336 }
 337
 338 void* sg_host_extension_get(sg_host_t host, size_t ext)
 339 {
 340   return host->extension(ext);
 341 }
 342
 343 size_t sg_host_extension_create(void (*deleter)(void*))
 344 {
 345   return simgrid::s4u::Host::extension_create(deleter);
 346 }
 347
 348 sg_host_t sg_host_by_name(const char* name)
 349 {
 350   return simgrid::s4u::Host::by_name_or_null(name);
 351 }
 352
 353 static int hostcmp_voidp(const void* pa, const void* pb)
 354 {
 355   return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->get_cname(),
 356                 (*static_cast<simgrid::s4u::Host* const*>(pb))->get_cname());
 357 }
 358
 359 xbt_dynar_t sg_hosts_as_dynar()
 360 {
 361   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 362
 363   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 364
 365   for (auto const& host : list) {
 366     if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
 367       xbt_dynar_push(res, &host);
 368   }
 369   xbt_dynar_sort(res, hostcmp_voidp);
 370   return res;
 371 }
 372
 373 // ========= Layering madness ==============*
 374
 375 // ========== User data Layer ==========
 376 void* sg_host_user(sg_host_t host)
 377 {
 378   return host->extension(USER_HOST_LEVEL);
 379 }
 380 void sg_host_user_set(sg_host_t host, void* userdata)
 381 {
 382   host->extension_set(USER_HOST_LEVEL, userdata);
 383 }
 384 void sg_host_user_destroy(sg_host_t host)
 385 {
 386   host->extension_set(USER_HOST_LEVEL, nullptr);
 387 }
 388
 389 // ========= storage related functions ============
 390 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 391 {
 392   xbt_assert((host != nullptr), "Invalid parameters");
 393   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
 394   for (auto const& elm : host->get_mounted_storages()) {
 395     const char* mount_name = elm.first.c_str();
 396     sg_storage_t storage   = elm.second;
 397     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
 398   }
 399
 400   return res;
 401 }
 402
 403 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
 404 {
 405   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
 406   std::vector<const char*> storage_vector = host->get_attached_storages();
 407   for (auto const& name : storage_vector)
 408     xbt_dynar_push(storage_dynar, &name);
 409   return storage_dynar;
 410 }
 411
 412 // =========== user-level functions ===============
 413 // ================================================
 414 /** @brief Returns the total speed of a host */
 415 double sg_host_speed(sg_host_t host)
 416 {
 417   return host->get_speed();
 418 }
 419
 420 /** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 421  *
 422  * \param  host host to test
 423  * \param pstate_index pstate to test
 424  * \return Returns the processor speed associated with pstate_index
 425  */
 426 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
 427 {
 428   return host->get_pstate_speed(pstate_index);
 429 }
 430
 431 /** \ingroup m_host_management
 432  * \brief Return the number of cores.
 433  *
 434  * \param host a host
 435  * \return the number of cores
 436  */
 437 int sg_host_core_count(sg_host_t host)
 438 {
 439   return host->get_core_count();
 440 }
 441
 442 double sg_host_get_available_speed(sg_host_t host)
 443 {
 444   return host->get_available_speed();
 445 }
 446
 447 /** @brief Returns the number of power states for a host.
 448  *
 449  *  See also @ref plugin_energy.
 450  */
 451 int sg_host_get_nb_pstates(sg_host_t host)
 452 {
 453   return host->get_pstate_count();
 454 }
 455
 456 /** @brief Gets the pstate at which that host currently runs.
 457  *
 458  *  See also @ref plugin_energy.
 459  */
 460 int sg_host_get_pstate(sg_host_t host)
 461 {
 462   return host->get_pstate();
 463 }
 464 /** @brief Sets the pstate at which that host should run.
 465  *
 466  *  See also @ref plugin_energy.
 467  */
 468 void sg_host_set_pstate(sg_host_t host, int pstate)
 469 {
 470   host->set_pstate(pstate);
 471 }
 472
 473 /** \ingroup m_host_management
 474  *
 475  * \brief Start the host if it is off
 476  *
 477  * See also #sg_host_is_on() and #sg_host_is_off() to test the current state of the host and @ref plugin_energy
 478  * for more info on DVFS.
 479  */
 480 void sg_host_turn_on(sg_host_t host)
 481 {
 482   host->turn_on();
 483 }
 484
 485 /** \ingroup m_host_management
 486  *
 487  * \brief Stop the host if it is on
 488  *
 489  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
 490  * for more info on DVFS.
 491  */
 492 void sg_host_turn_off(sg_host_t host)
 493 {
 494   host->turn_off();
 495 }
 496
 497 /** @ingroup m_host_management
 498  * @brief Determine if a host is up and running.
 499  *
 500  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 501  * info on DVFS.
 502  *
 503  * @param host host to test
 504  * @return Returns true if the host is up and running, and false if it's currently down
 505  */
 506 int sg_host_is_on(sg_host_t host)
 507 {
 508   return host->is_on();
 509 }
 510
 511 /** @ingroup m_host_management
 512  * @brief Determine if a host is currently off.
 513  *
 514  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 515  * info on DVFS.
 516  */
 517 int sg_host_is_off(sg_host_t host)
 518 {
 519   return host->is_off();
 520 }
 521
 522 /** @brief Get the properties of an host */
 523 xbt_dict_t sg_host_get_properties(sg_host_t host)
 524 {
 525   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 526   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()), nullptr);
 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(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(sg_host_t from, 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(sg_host_t from, 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 bandwitdh of the route between two hosts
 581  *
 582  * \param from where from
 583  * \param to where to
 584  */
 585 double sg_host_route_bandwidth(sg_host_t from, 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 /** @brief Displays debugging information about a host */
 600 void sg_host_dump(sg_host_t host)
 601 {
 602   XBT_INFO("Displaying host %s", host->get_cname());
 603   XBT_INFO("  - speed: %.0f", host->get_speed());
 604   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 605   std::unordered_map<std::string, std::string>* props = host->get_properties();
 606
 607   if (not props->empty()) {
 608     XBT_INFO("  - properties:");
 609     for (auto const& elm : *props) {
 610       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 611     }
 612   }
 613 }
 614
 615 /** \brief Return the list of actors attached to an host.
 616  *
 617  * \param host a host
 618  * \param whereto a dynar in which we should push actors living on that host
 619  */
 620 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
 621 {
 622   auto actors = host->get_all_actors();
 623   for (auto& actor : actors)
 624     xbt_dynar_push(whereto, &actor);
 625 }
 626
 627 sg_host_t sg_host_self()
 628 {
 629   smx_actor_t process = SIMIX_process_self();
 630   return (process == nullptr) ? nullptr : process->host_;
 631 }