Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rename the plugins from the command line, and document it
[simgrid.git] / src / s4u / s4u_Host.cpp
index 17f9d90..ba215f5 100644 (file)
@@ -89,9 +89,9 @@ Host* Host::current()
   return smx_proc->host;
 }
 
-void Host::turnOn()
+void Host::turn_on()
 {
-  if (isOff()) {
+  if (is_off()) {
     simgrid::simix::simcall([this] {
       this->extension<simgrid::simix::Host>()->turnOn();
       this->pimpl_cpu->turn_on();
@@ -100,32 +100,70 @@ void Host::turnOn()
   }
 }
 
-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::simcall([this, self] {
-      SIMIX_host_off(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()
 {
   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)) {
@@ -168,65 +206,58 @@ 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()
 {
-  return simgrid::simix::simcall([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)
-{
-  return this->pimpl_->getProperty(key);
-}
-
-void Host::setProperty(std::string key, std::string value)
+const char* Host::get_property(const char* key)
 {
-  simgrid::simix::simcall([this, key, value] { this->pimpl_->setProperty(key, value); });
+  return this->pimpl_->get_property(key);
 }
 
-/** Get the processes attached to the host */
-void Host::getProcesses(std::vector<ActorPtr>* list)
+void Host::set_property(std::string key, std::string value)
 {
-  for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
-    list->push_back(actor.iface());
-  }
-}
-
-/** @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();
+  simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
 }
 
 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 double Host::getPstateSpeed(int pstate_index)
 {
-  return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->getPstateSpeed(pstate_index); });
+  return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->get_pstate_peak_speed(pstate_index); });
 }
 
-/** @brief Get the peak processor speed (under full load (=1.0), in flops/s), at the current pstate */
+/** @brief Get the peak processor speed in flops/s, (under full load (=1.0), at the current pstate)
+ *
+ *  The result also takes the external load into account.
+ */
 double Host::getSpeed()
 {
-  return pimpl_cpu->getSpeed(1.0);
+  return this->pimpl_cpu->get_speed(1.0);
 }
+/** @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()
 {
-  return pimpl_cpu->get_available_speed();
+  return this->pimpl_cpu->get_speed_ratio();
 }
 
 /** @brief Returns the number of core of the processor. */
-int Host::getCoreCount()
+int Host::get_core_count()
 {
-  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::simcall([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()
 {
-  return this->pimpl_cpu->getPState();
+  return this->pimpl_cpu->get_pstate();
 }
 
 /**
@@ -408,7 +439,7 @@ 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)
@@ -422,7 +453,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.
@@ -431,7 +462,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.
  *
@@ -439,7 +470,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
@@ -451,7 +482,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
@@ -463,7 +494,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
@@ -477,7 +508,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
@@ -488,7 +519,7 @@ 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 */
@@ -513,12 +544,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);
 }
 
 /**
@@ -531,7 +562,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);
 }
@@ -545,7 +576,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;
 }
 /**
@@ -559,7 +590,7 @@ 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->get_bandwidth();
     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)