Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[S4U] Host: Add 'const' keyword to getter methods
[simgrid.git] / src / s4u / s4u_Host.cpp
index 9b39fd2..7aab1cf 100644 (file)
@@ -23,10 +23,10 @@ template class Extendable<simgrid::s4u::Host>;
 
 namespace s4u {
 
-simgrid::xbt::signal<void(Host&)> Host::onCreation;
-simgrid::xbt::signal<void(Host&)> Host::onDestruction;
-simgrid::xbt::signal<void(Host&)> Host::onStateChange;
-simgrid::xbt::signal<void(Host&)> Host::onSpeedChange;
+simgrid::xbt::signal<void(Host&)> Host::on_creation;
+simgrid::xbt::signal<void(Host&)> Host::on_destruction;
+simgrid::xbt::signal<void(Host&)> Host::on_state_change;
+simgrid::xbt::signal<void(Host&)> Host::on_speed_change;
 
 Host::Host(const char* name) : name_(name)
 {
@@ -43,7 +43,7 @@ Host::~Host()
   if (pimpl_netpoint != nullptr) // not removed yet by a children class
     simgrid::s4u::Engine::get_instance()->netpoint_unregister(pimpl_netpoint);
   delete pimpl_cpu;
-  delete mounts;
+  delete mounts_;
 }
 
 /** @brief Fire the required callbacks and destroy the object
@@ -58,7 +58,7 @@ void Host::destroy()
 {
   if (not currentlyDestroying_) {
     currentlyDestroying_ = true;
-    onDestruction(*this);
+    on_destruction(*this);
     Engine::get_instance()->host_unregister(std::string(name_));
     delete this;
   }
@@ -89,43 +89,81 @@ Host* Host::current()
   return smx_proc->host;
 }
 
-void Host::turnOn()
+void Host::turn_on()
 {
-  if (isOff()) {
-    simgrid::simix::kernelImmediate([this] {
+  if (is_off()) {
+    simgrid::simix::simcall([this] {
       this->extension<simgrid::simix::Host>()->turnOn();
       this->pimpl_cpu->turn_on();
-      onStateChange(*this);
+      on_state_change(*this);
     });
   }
 }
 
-void Host::turnOff()
+/** @brief Stop the host if it is on */
+void Host::turn_off()
 {
-  if (isOn()) {
+  if (is_on()) {
     smx_actor_t self = SIMIX_process_self();
-    simgrid::simix::kernelImmediate([this, self] {
-      SIMIX_host_off(this, self);
-      onStateChange(*this);
+    simgrid::simix::simcall([this, self] {
+      simgrid::simix::Host* host = this->extension<simgrid::simix::Host>();
+
+      xbt_assert((host != nullptr), "Invalid parameters");
+
+      this->pimpl_cpu->turn_off();
+
+      /* Clean Simulator data */
+      if (not host->process_list.empty()) {
+        for (auto& process : host->process_list) {
+          SIMIX_process_kill(&process, self);
+          XBT_DEBUG("Killing %s@%s on behalf of %s which turned off that host.", process.get_cname(),
+                    process.host->get_cname(), self->get_cname());
+        }
+      }
+
+      on_state_change(*this);
     });
   }
 }
 
-bool Host::isOn()
+bool Host::is_on() const
 {
   return this->pimpl_cpu->is_on();
 }
 
-int Host::getPstatesCount() const
+int Host::get_pstate_count() const
 {
-  return this->pimpl_cpu->getNbPStates();
+  return this->pimpl_cpu->get_pstate_count();
 }
 
 /**
- * \brief Return the list of actors attached to an host.
+ * \brief Return a copy of the list of actors that are executing on this host.
  *
- * \param whereto a vector in which we should push actors living on that host
+ * Daemons and regular actors are all mixed in this list.
  */
+std::vector<ActorPtr> Host::get_all_actors()
+{
+  std::vector<ActorPtr> res;
+  for (auto& actor : this->extension<simgrid::simix::Host>()->process_list)
+    res.push_back(actor.ciface());
+  return res;
+}
+
+/** @brief Returns how many actors (daemonized or not) have been launched on this host */
+int Host::get_actor_count()
+{
+  return this->extension<simgrid::simix::Host>()->process_list.size();
+}
+
+/** @deprecated */
+void Host::getProcesses(std::vector<ActorPtr>* list)
+{
+  for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
+    list->push_back(actor.iface());
+  }
+}
+
+/** @deprecated */
 void Host::actorList(std::vector<ActorPtr>* whereto)
 {
   for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
@@ -145,16 +183,16 @@ void Host::actorList(std::vector<ActorPtr>* whereto)
  * walk through the routing components tree and find a route between hosts
  * by calling each "get_route" function in each routing component.
  */
-void Host::routeTo(Host* dest, std::vector<Link*>& links, double* latency)
+void Host::route_to(Host* dest, std::vector<Link*>& links, double* latency)
 {
   std::vector<kernel::resource::LinkImpl*> linkImpls;
-  this->routeTo(dest, linkImpls, latency);
+  this->route_to(dest, linkImpls, latency);
   for (kernel::resource::LinkImpl* const& l : linkImpls)
     links.push_back(&l->piface_);
 }
 
 /** @brief Just like Host::routeTo, but filling an array of link implementations */
-void Host::routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
+void Host::route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
 {
   simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
@@ -166,64 +204,77 @@ void Host::routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links,
 }
 
 /** Get the properties assigned to a host */
-std::map<std::string, std::string>* Host::getProperties()
+std::unordered_map<std::string, std::string>* Host::get_properties()
 {
-  return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
+  return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
 }
 
 /** Retrieve the property value (or nullptr if not set) */
-const char* Host::getProperty(const char* key)
+const char* Host::get_property(const char* key) const
 {
-  return this->pimpl_->getProperty(key);
+  return this->pimpl_->get_property(key);
 }
 
-void Host::setProperty(std::string key, std::string value)
+void Host::set_property(std::string key, std::string value)
 {
-  simgrid::simix::kernelImmediate([this, key, value] { this->pimpl_->setProperty(key, value); });
+  simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
 }
 
-/** Get the processes attached to the host */
-void Host::getProcesses(std::vector<ActorPtr>* list)
+/** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
+double Host::get_pstate_speed(int pstate_index) const
 {
-  for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
-    list->push_back(actor.iface());
-  }
+  return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->get_pstate_peak_speed(pstate_index); });
 }
 
-/** @brief Returns how many actors (daemonized or not) have been launched on this host */
-int Host::get_actor_count()
+/** @brief Get the peak computing speed in flops/s at the current pstate, taking the external load into account.
+ *
+ *  The amount of flops per second available for computing depends on several things:
+ *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
+ *      computing speed you would get at another pstate)
+ *    - If you declared an external load, then this reduces the available computing speed (see @ref set_speed_trace())
+ *
+ *  The remaining speed is then shared between the executions located on this host.
+ *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
+ *
+ *  The host may have multiple cores, and your executions may be able to use more than a single core.
+ *
+ *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
+ */
+double Host::get_speed() const
 {
-  return this->extension<simgrid::simix::Host>()->process_list.size();
+  return this->pimpl_cpu->get_speed(1.0);
 }
-
-/** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
-double Host::getPstateSpeed(int pstate_index)
+/** @brief Returns the current computation load (in flops per second)
+ * The external load (coming from an availability trace) is not taken in account.
+ */
+double Host::get_load() const
 {
-  return simgrid::simix::kernelImmediate(
-      [this, pstate_index] { return this->pimpl_cpu->getPstateSpeed(pstate_index); });
+  return this->pimpl_cpu->get_load();
 }
-
-/** @brief Get the peak processor speed (under full load (=1.0), in flops/s), at the current pstate */
-double Host::getSpeed()
+/** @brief Get the available speed ratio, between 0 and 1.
+ *
+ * This accounts for external load (see @ref set_speed_trace()).
+ */
+double Host::get_available_speed() const
 {
-  return pimpl_cpu->getSpeed(1.0);
+  return this->pimpl_cpu->get_speed_ratio();
 }
 
 /** @brief Returns the number of core of the processor. */
-int Host::getCoreCount()
+int Host::get_core_count() const
 {
-  return pimpl_cpu->coreCount();
+  return this->pimpl_cpu->get_core_count();
 }
 
 /** @brief Set the pstate at which the host should run */
-void Host::setPstate(int pstate_index)
+void Host::set_pstate(int pstate_index)
 {
-  simgrid::simix::kernelImmediate([this, pstate_index] { this->pimpl_cpu->setPState(pstate_index); });
+  simgrid::simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 }
 /** @brief Retrieve the pstate at which the host is currently running */
-int Host::getPstate()
+int Host::get_pstate() const
 {
-  return this->pimpl_cpu->getPState();
+  return this->pimpl_cpu->get_pstate();
 }
 
 /**
@@ -231,42 +282,38 @@ int Host::getPstate()
  * \brief Returns the list of storages attached to an host.
  * \return a vector containing all storages attached to the host
  */
-std::vector<const char*> Host::get_attached_storages()
+std::vector<const char*> Host::get_attached_storages() const
 {
-  return simgrid::simix::kernelImmediate([this] { return this->pimpl_->get_attached_storages(); });
+  return simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 }
 
 void Host::getAttachedStorages(std::vector<const char*>* storages)
 {
   std::vector<const char*> local_storages =
-      simgrid::simix::kernelImmediate([this] { return this->pimpl_->get_attached_storages(); });
+      simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
   for (auto elm : local_storages)
     storages->push_back(elm);
 }
 
-std::unordered_map<std::string, Storage*> const& Host::getMountedStorages()
+std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
 {
-  if (mounts == nullptr) {
-    mounts = new std::unordered_map<std::string, Storage*>();
+  if (mounts_ == nullptr) {
+    mounts_ = new std::unordered_map<std::string, Storage*>();
     for (auto const& m : this->pimpl_->storage_) {
-      mounts->insert({m.first, &m.second->piface_});
+      mounts_->insert({m.first, &m.second->piface_});
     }
   }
-  return *mounts;
+  return *mounts_;
 }
 
 void Host::execute(double flops)
 {
-  Host* host_list[1]   = {this};
-  double flops_list[1] = {flops};
-  smx_activity_t s     = simcall_execution_parallel_start(nullptr /*name*/, 1, host_list, flops_list,
-                                                      nullptr /*comm_sizes */, -1.0, -1 /*timeout*/);
-  simcall_execution_wait(s);
+  execute(flops, 1.0 /* priority */);
 }
-
-double Host::getLoad()
+void Host::execute(double flops, double priority)
 {
-  return this->pimpl_cpu->get_load();
+  smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, this);
+  simcall_execution_wait(s);
 }
 
 } // namespace s4u
@@ -359,7 +406,7 @@ xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 {
   xbt_assert((host != nullptr), "Invalid parameters");
   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
-  for (auto const& elm : host->getMountedStorages()) {
+  for (auto const& elm : host->get_mounted_storages()) {
     const char* mount_name = elm.first.c_str();
     sg_storage_t storage   = elm.second;
     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
@@ -382,7 +429,7 @@ xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
 /** @brief Returns the total speed of a host */
 double sg_host_speed(sg_host_t host)
 {
-  return host->getSpeed();
+  return host->get_speed();
 }
 
 /** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
@@ -393,7 +440,7 @@ double sg_host_speed(sg_host_t host)
  */
 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
 {
-  return host->getPstateSpeed(pstate_index);
+  return host->get_pstate_speed(pstate_index);
 }
 
 /** \ingroup m_host_management
@@ -404,12 +451,12 @@ double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
  */
 int sg_host_core_count(sg_host_t host)
 {
-  return host->getCoreCount();
+  return host->get_core_count();
 }
 
 double sg_host_get_available_speed(sg_host_t host)
 {
-  return host->pimpl_cpu->get_available_speed();
+  return host->get_available_speed();
 }
 
 /** @brief Returns the number of power states for a host.
@@ -418,7 +465,7 @@ double sg_host_get_available_speed(sg_host_t host)
  */
 int sg_host_get_nb_pstates(sg_host_t host)
 {
-  return host->getPstatesCount();
+  return host->get_pstate_count();
 }
 
 /** @brief Gets the pstate at which that host currently runs.
@@ -427,7 +474,7 @@ int sg_host_get_nb_pstates(sg_host_t host)
  */
 int sg_host_get_pstate(sg_host_t host)
 {
-  return host->getPstate();
+  return host->get_pstate();
 }
 /** @brief Sets the pstate at which that host should run.
  *
@@ -435,7 +482,7 @@ int sg_host_get_pstate(sg_host_t host)
  */
 void sg_host_set_pstate(sg_host_t host, int pstate)
 {
-  host->setPstate(pstate);
+  host->set_pstate(pstate);
 }
 
 /** \ingroup m_host_management
@@ -447,7 +494,7 @@ void sg_host_set_pstate(sg_host_t host, int pstate)
  */
 void sg_host_turn_on(sg_host_t host)
 {
-  host->turnOn();
+  host->turn_on();
 }
 
 /** \ingroup m_host_management
@@ -459,7 +506,7 @@ void sg_host_turn_on(sg_host_t host)
  */
 void sg_host_turn_off(sg_host_t host)
 {
-  host->turnOff();
+  host->turn_off();
 }
 
 /** @ingroup m_host_management
@@ -473,7 +520,7 @@ void sg_host_turn_off(sg_host_t host)
  */
 int sg_host_is_on(sg_host_t host)
 {
-  return host->isOn();
+  return host->is_on();
 }
 
 /** @ingroup m_host_management
@@ -484,14 +531,14 @@ int sg_host_is_on(sg_host_t host)
  */
 int sg_host_is_off(sg_host_t host)
 {
-  return host->isOff();
+  return host->is_off();
 }
 
 /** @brief Get the properties of an host */
 xbt_dict_t sg_host_get_properties(sg_host_t host)
 {
   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
-  std::map<std::string, std::string>* props = host->getProperties();
+  std::unordered_map<std::string, std::string>* props = host->get_properties();
   if (props == nullptr)
     return nullptr;
   for (auto const& elm : *props) {
@@ -509,12 +556,12 @@ xbt_dict_t sg_host_get_properties(sg_host_t host)
 */
 const char* sg_host_get_property_value(sg_host_t host, const char* name)
 {
-  return host->getProperty(name);
+  return host->get_property(name);
 }
 
 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 {
-  host->setProperty(name, value);
+  host->set_property(name, value);
 }
 
 /**
@@ -527,7 +574,7 @@ void sg_host_set_property_value(sg_host_t host, const char* name, const char* va
 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 {
   std::vector<simgrid::s4u::Link*> vlinks;
-  from->routeTo(to, vlinks, nullptr);
+  from->route_to(to, vlinks, nullptr);
   for (auto const& link : vlinks)
     xbt_dynar_push(links, &link);
 }
@@ -541,7 +588,7 @@ double sg_host_route_latency(sg_host_t from, sg_host_t to)
 {
   std::vector<simgrid::s4u::Link*> vlinks;
   double res = 0;
-  from->routeTo(to, vlinks, &res);
+  from->route_to(to, vlinks, &res);
   return res;
 }
 /**
@@ -555,9 +602,9 @@ double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
   double min_bandwidth = -1.0;
 
   std::vector<simgrid::s4u::Link*> vlinks;
-  from->routeTo(to, vlinks, nullptr);
+  from->route_to(to, vlinks, nullptr);
   for (auto const& link : vlinks) {
-    double bandwidth = link->bandwidth();
+    double bandwidth = link->get_bandwidth();
     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
       min_bandwidth = bandwidth;
   }
@@ -568,9 +615,9 @@ double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 void sg_host_dump(sg_host_t host)
 {
   XBT_INFO("Displaying host %s", host->get_cname());
-  XBT_INFO("  - speed: %.0f", host->getSpeed());
+  XBT_INFO("  - speed: %.0f", host->get_speed());
   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
-  std::map<std::string, std::string>* props = host->getProperties();
+  std::unordered_map<std::string, std::string>* props = host->get_properties();
 
   if (not props->empty()) {
     XBT_INFO("  - properties:");