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