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     kernel::actor::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     kernel::actor::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 /** @brief Returns the networking zone englobing that host */
 175 NetZone* Host::get_englobing_zone()
 176 {
 177   return pimpl_netpoint->get_englobing_zone()->get_iface();
 178 }
 179
 180 void Host::send_to(Host* dest, double byte_amount)
 181 {
 182   std::vector<Host*> m_host_list   = {this, dest};
 183   std::vector<double> flops_amount = {0, 0};
 184   std::vector<double> bytes_amount = {0, byte_amount, 0, 0};
 185   this_actor::parallel_execute(m_host_list, flops_amount, bytes_amount);
 186 }
 187
 188 /** Get the properties assigned to a host */
 189 const std::unordered_map<std::string, std::string>* Host::get_properties() const
 190 {
 191   return this->pimpl_->get_properties();
 192 }
 193
 194 /** Retrieve the property value (or nullptr if not set) */
 195 const char* Host::get_property(const std::string& key) const
 196 {
 197   return this->pimpl_->get_property(key);
 198 }
 199
 200 void Host::set_property(const std::string& key, const std::string& value)
 201 {
 202   kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
 203 }
 204
 205 void Host::set_properties(const std::map<std::string, std::string>& properties)
 206 {
 207   kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
 208 }
 209
 210 /** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law.
 211  * The profile must contain boolean values. */
 212 void Host::set_state_profile(kernel::profile::Profile* p)
 213 {
 214   return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
 215 }
 216 /** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
 217  *
 218  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
 219  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
 220  * at this pstate level) by the rate coming from the profile.
 221  */
 222 void Host::set_speed_profile(kernel::profile::Profile* p)
 223 {
 224   return kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
 225 }
 226
 227 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 228 double Host::get_pstate_speed(int pstate_index) const
 229 {
 230   return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
 231 }
 232
 233 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
 234  *
 235  *  The amount of flops per second available for computing depends on several things:
 236  *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
 237  *      computing speed you would get at another pstate)
 238  *    - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
 239  * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
 240  *
 241  *  The remaining speed is then shared between the executions located on this host.
 242  *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
 243  *
 244  *  The host may have multiple cores, and your executions may be able to use more than a single core.
 245  *
 246  *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
 247  */
 248 double Host::get_speed() const
 249 {
 250   return this->pimpl_cpu->get_speed(1.0);
 251 }
 252 /** @brief Returns the current computation load (in flops per second)
 253  *
 254  * The external load (coming from an availability trace) is not taken in account.
 255  * You may also be interested in the load plugin.
 256  */
 257 double Host::get_load() const
 258 {
 259   return this->pimpl_cpu->get_load();
 260 }
 261 /** @brief Get the available speed ratio, between 0 and 1.
 262  *
 263  * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
 264  */
 265 double Host::get_available_speed() const
 266 {
 267   return this->pimpl_cpu->get_speed_ratio();
 268 }
 269
 270 /** @brief Returns the number of core of the processor. */
 271 int Host::get_core_count() const
 272 {
 273   return this->pimpl_cpu->get_core_count();
 274 }
 275
 276 /** @brief Set the pstate at which the host should run */
 277 void Host::set_pstate(int pstate_index)
 278 {
 279   kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 280 }
 281 /** @brief Retrieve the pstate at which the host is currently running */
 282 int Host::get_pstate() const
 283 {
 284   return this->pimpl_cpu->get_pstate();
 285 }
 286
 287 std::vector<Disk*> Host::get_disks() const
 288 {
 289   return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
 290 }
 291
 292 void Host::add_disk(Disk* disk)
 293 {
 294   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
 295 }
 296 void Host::remove_disk(std::string disk_name)
 297 {
 298   kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
 299 }
 300 /**
 301  * @ingroup simix_storage_management
 302  * @brief Returns the list of storages attached to a host.
 303  * @return a vector containing all storages attached to the host
 304  */
 305 std::vector<const char*> Host::get_attached_storages() const
 306 {
 307   return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
 308 }
 309
 310 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
 311 {
 312   if (mounts_ == nullptr) {
 313     mounts_ = new std::unordered_map<std::string, Storage*>();
 314     for (auto const& m : this->pimpl_->storage_) {
 315       mounts_->insert({m.first, &m.second->piface_});
 316     }
 317   }
 318   return *mounts_;
 319 }
 320
 321 ExecPtr Host::exec_async(double flops)
 322 {
 323   return this_actor::exec_init(flops);
 324 }
 325
 326 void Host::execute(double flops)
 327 {
 328   execute(flops, 1.0 /* priority */);
 329 }
 330
 331 void Host::execute(double flops, double priority)
 332 {
 333   this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
 334 }
 335
 336 } // namespace s4u
 337 } // namespace simgrid
 338
 339 /* **************************** Public C interface *************************** */
 340 size_t sg_host_count()
 341 {
 342   return simgrid::s4u::Engine::get_instance()->get_host_count();
 343 }
 344 /** @brief Returns the host list
 345  *
 346  * Uses sg_host_count() to know the array size.
 347  *
 348  * @return an array of @ref sg_host_t containing all the hosts in the platform.
 349  * @remark The host order in this array is generally different from the
 350  * creation/declaration order in the XML platform (we use a hash table
 351  * internally).
 352  * @see sg_host_count()
 353  */
 354 sg_host_t* sg_host_list()
 355 {
 356   xbt_assert(sg_host_count() > 0, "There is no host!");
 357   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 358
 359   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
 360   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 361
 362   return res;
 363 }
 364
 365 const char* sg_host_get_name(sg_host_t host)
 366 {
 367   return host->get_cname();
 368 }
 369
 370 void* sg_host_extension_get(sg_host_t host, size_t ext)
 371 {
 372   return host->extension(ext);
 373 }
 374
 375 size_t sg_host_extension_create(void (*deleter)(void*))
 376 {
 377   return simgrid::s4u::Host::extension_create(deleter);
 378 }
 379
 380 sg_host_t sg_host_by_name(const char* name)
 381 {
 382   return simgrid::s4u::Host::by_name_or_null(name);
 383 }
 384
 385 xbt_dynar_t sg_hosts_as_dynar()
 386 {
 387   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 388
 389   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
 390     return not host || not host->pimpl_netpoint || not host->pimpl_netpoint->is_host();
 391   });
 392   std::sort(begin(list), last,
 393             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
 394
 395   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 396   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
 397   return res;
 398 }
 399
 400 // ========= Layering madness ==============*
 401
 402 // ========== User data Layer ==========
 403 void* sg_host_user(sg_host_t host)
 404 {
 405   return host->extension(USER_HOST_LEVEL);
 406 }
 407 void sg_host_user_set(sg_host_t host, void* userdata)
 408 {
 409   host->extension_set(USER_HOST_LEVEL, userdata);
 410 }
 411 void sg_host_user_destroy(sg_host_t host)
 412 {
 413   host->extension_set(USER_HOST_LEVEL, nullptr);
 414 }
 415
 416 // ========= storage related functions ============
 417 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 418 {
 419   xbt_assert((host != nullptr), "Invalid parameters");
 420   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
 421   for (auto const& elm : host->get_mounted_storages()) {
 422     const char* mount_name = elm.first.c_str();
 423     sg_storage_t storage   = elm.second;
 424     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
 425   }
 426
 427   return res;
 428 }
 429
 430 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
 431 {
 432   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
 433   std::vector<const char*> storage_vector = host->get_attached_storages();
 434   for (auto const& name : storage_vector)
 435     xbt_dynar_push(storage_dynar, &name);
 436   return storage_dynar;
 437 }
 438
 439 // =========== user-level functions ===============
 440 // ================================================
 441 /** @brief Returns the total speed of a host */
 442 double sg_host_speed(sg_host_t host)
 443 {
 444   return host->get_speed();
 445 }
 446
 447 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 448  *
 449  * @param  host host to test
 450  * @param pstate_index pstate to test
 451  * @return Returns the processor speed associated with pstate_index
 452  */
 453 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
 454 {
 455   return host->get_pstate_speed(pstate_index);
 456 }
 457
 458 /** @ingroup m_host_management
 459  * @brief Return the number of cores.
 460  *
 461  * @param host a host
 462  * @return the number of cores
 463  */
 464 int sg_host_core_count(sg_host_t host)
 465 {
 466   return host->get_core_count();
 467 }
 468
 469 double sg_host_get_available_speed(sg_host_t host)
 470 {
 471   return host->get_available_speed();
 472 }
 473
 474 /** @brief Returns the number of power states for a host.
 475  *
 476  *  See also @ref plugin_energy.
 477  */
 478 int sg_host_get_nb_pstates(sg_host_t host)
 479 {
 480   return host->get_pstate_count();
 481 }
 482
 483 /** @brief Gets the pstate at which that host currently runs.
 484  *
 485  *  See also @ref plugin_energy.
 486  */
 487 int sg_host_get_pstate(sg_host_t host)
 488 {
 489   return host->get_pstate();
 490 }
 491 /** @brief Sets the pstate at which that host should run.
 492  *
 493  *  See also @ref plugin_energy.
 494  */
 495 void sg_host_set_pstate(sg_host_t host, int pstate)
 496 {
 497   host->set_pstate(pstate);
 498 }
 499
 500 /** @ingroup m_host_management
 501  *
 502  * @brief Start the host if it is off
 503  *
 504  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
 505  * for more info on DVFS.
 506  */
 507 void sg_host_turn_on(sg_host_t host)
 508 {
 509   host->turn_on();
 510 }
 511
 512 /** @ingroup m_host_management
 513  *
 514  * @brief Stop the host if it is on
 515  *
 516  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
 517  * for more info on DVFS.
 518  */
 519 void sg_host_turn_off(sg_host_t host)
 520 {
 521   host->turn_off();
 522 }
 523
 524 /** @ingroup m_host_management
 525  * @brief Determine if a host is up and running.
 526  *
 527  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 528  * info on DVFS.
 529  *
 530  * @param host host to test
 531  * @return Returns true if the host is up and running, and false if it's currently down
 532  */
 533 int sg_host_is_on(sg_host_t host)
 534 {
 535   return host->is_on();
 536 }
 537
 538 /** @deprecated */
 539 int sg_host_is_off(sg_host_t host)
 540 {
 541   return not host->is_on();
 542 }
 543
 544 /** @brief Get the properties of a host */
 545 xbt_dict_t sg_host_get_properties(sg_host_t host)
 546 {
 547   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 548   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 549   if (props == nullptr)
 550     return nullptr;
 551   for (auto const& elm : *props) {
 552     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 553   }
 554   return as_dict;
 555 }
 556
 557 /** @ingroup m_host_management
 558  * @brief Returns the value of a given host property
 559  *
 560  * @param host a host
 561  * @param name a property name
 562  * @return value of a property (or nullptr if property not set)
 563  */
 564 const char* sg_host_get_property_value(sg_host_t host, const char* name)
 565 {
 566   return host->get_property(name);
 567 }
 568
 569 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 570 {
 571   host->set_property(name, value);
 572 }
 573
 574 /**
 575  * @brief Find a route between two hosts
 576  *
 577  * @param from where from
 578  * @param to where to
 579  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 580  */
 581 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 582 {
 583   std::vector<simgrid::s4u::Link*> vlinks;
 584   from->route_to(to, vlinks, nullptr);
 585   for (auto const& link : vlinks)
 586     xbt_dynar_push(links, &link);
 587 }
 588 /**
 589  * @brief Find the latency of the route between two hosts
 590  *
 591  * @param from where from
 592  * @param to where to
 593  */
 594 double sg_host_route_latency(sg_host_t from, sg_host_t to)
 595 {
 596   std::vector<simgrid::s4u::Link*> vlinks;
 597   double res = 0;
 598   from->route_to(to, vlinks, &res);
 599   return res;
 600 }
 601 /**
 602  * @brief Find the bandwitdh of the route between two hosts
 603  *
 604  * @param from where from
 605  * @param to where to
 606  */
 607 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 608 {
 609   double min_bandwidth = -1.0;
 610
 611   std::vector<simgrid::s4u::Link*> vlinks;
 612   from->route_to(to, vlinks, nullptr);
 613   for (auto const& link : vlinks) {
 614     double bandwidth = link->get_bandwidth();
 615     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 616       min_bandwidth = bandwidth;
 617   }
 618   return min_bandwidth;
 619 }
 620
 621 void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
 622 {
 623   from->send_to(to, byte_amount);
 624 }
 625
 626 /** @brief Displays debugging information about a host */
 627 void sg_host_dump(sg_host_t host)
 628 {
 629   XBT_INFO("Displaying host %s", host->get_cname());
 630   XBT_INFO("  - speed: %.0f", host->get_speed());
 631   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 632   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 633
 634   if (not props->empty()) {
 635     XBT_INFO("  - properties:");
 636     for (auto const& elm : *props) {
 637       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 638     }
 639   }
 640 }
 641
 642 /** @brief Return the list of actors attached to a host.
 643  *
 644  * @param host a host
 645  * @param whereto a dynar in which we should push actors living on that host
 646  */
 647 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
 648 {
 649   auto actors = host->get_all_actors();
 650   for (auto& actor : actors)
 651     xbt_dynar_push(whereto, &actor);
 652 }
 653
 654 sg_host_t sg_host_self()
 655 {
 656   smx_actor_t process = SIMIX_process_self();
 657   return (process == nullptr) ? nullptr : process->get_host();
 658 }
 659
 660 /* needs to be public and without simcall for exceptions and logging events */
 661 const char* sg_host_self_get_name()
 662 {
 663   sg_host_t host = sg_host_self();
 664   if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
 665     return "";
 666
 667   return host->get_cname();
 668 }
 669
 670 double sg_host_load(sg_host_t host)
 671 {
 672   return host->get_load();
 673 }