Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix a FIXME
[simgrid.git] / src / s4u / s4u_Host.cpp
index efc4cc3..9b39fd2 100644 (file)
@@ -10,6 +10,7 @@
 
 #include <string>
 
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
 
 int USER_HOST_LEVEL = -1;
@@ -189,8 +190,7 @@ void Host::getProcesses(std::vector<ActorPtr>* list)
   }
 }
 
-/** @brief Returns how many actors have been launched on this host */
-// FIXME: Specify whether the user should expect only non-daemon actors here!
+/** @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();
@@ -271,3 +271,330 @@ double Host::getLoad()
 
 } // namespace s4u
 } // namespace simgrid
+
+/* **************************** Public C interface *************************** */
+size_t sg_host_count()
+{
+  return simgrid::s4u::Engine::get_instance()->get_host_count();
+}
+/** @brief Returns the host list
+ *
+ * Uses sg_host_count() to know the array size.
+ *
+ * \return an array of \ref sg_host_t containing all the hosts in the platform.
+ * \remark The host order in this array is generally different from the
+ * creation/declaration order in the XML platform (we use a hash table
+ * internally).
+ * \see sg_host_count()
+ */
+sg_host_t* sg_host_list()
+{
+  xbt_assert(sg_host_count() > 0, "There is no host!");
+  std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
+
+  sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
+  memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
+
+  return res;
+}
+
+const char* sg_host_get_name(sg_host_t host)
+{
+  return host->get_cname();
+}
+
+void* sg_host_extension_get(sg_host_t host, size_t ext)
+{
+  return host->extension(ext);
+}
+
+size_t sg_host_extension_create(void (*deleter)(void*))
+{
+  return simgrid::s4u::Host::extension_create(deleter);
+}
+
+sg_host_t sg_host_by_name(const char* name)
+{
+  return simgrid::s4u::Host::by_name_or_null(name);
+}
+
+static int hostcmp_voidp(const void* pa, const void* pb)
+{
+  return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->get_cname(),
+                (*static_cast<simgrid::s4u::Host* const*>(pb))->get_cname());
+}
+
+xbt_dynar_t sg_hosts_as_dynar()
+{
+  xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
+
+  std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
+
+  for (auto const& host : list) {
+    if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
+      xbt_dynar_push(res, &host);
+  }
+  xbt_dynar_sort(res, hostcmp_voidp);
+  return res;
+}
+
+// ========= Layering madness ==============*
+
+// ========== User data Layer ==========
+void* sg_host_user(sg_host_t host)
+{
+  return host->extension(USER_HOST_LEVEL);
+}
+void sg_host_user_set(sg_host_t host, void* userdata)
+{
+  host->extension_set(USER_HOST_LEVEL, userdata);
+}
+void sg_host_user_destroy(sg_host_t host)
+{
+  host->extension_set(USER_HOST_LEVEL, nullptr);
+}
+
+// ========= storage related functions ============
+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()) {
+    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);
+  }
+
+  return res;
+}
+
+xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
+{
+  xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
+  std::vector<const char*> storage_vector = host->get_attached_storages();
+  for (auto const& name : storage_vector)
+    xbt_dynar_push(storage_dynar, &name);
+  return storage_dynar;
+}
+
+// =========== user-level functions ===============
+// ================================================
+/** @brief Returns the total speed of a host */
+double sg_host_speed(sg_host_t host)
+{
+  return host->getSpeed();
+}
+
+/** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
+ *
+ * \param  host host to test
+ * \param pstate_index pstate to test
+ * \return Returns the processor speed associated with pstate_index
+ */
+double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
+{
+  return host->getPstateSpeed(pstate_index);
+}
+
+/** \ingroup m_host_management
+ * \brief Return the number of cores.
+ *
+ * \param host a host
+ * \return the number of cores
+ */
+int sg_host_core_count(sg_host_t host)
+{
+  return host->getCoreCount();
+}
+
+double sg_host_get_available_speed(sg_host_t host)
+{
+  return host->pimpl_cpu->get_available_speed();
+}
+
+/** @brief Returns the number of power states for a host.
+ *
+ *  See also @ref plugin_energy.
+ */
+int sg_host_get_nb_pstates(sg_host_t host)
+{
+  return host->getPstatesCount();
+}
+
+/** @brief Gets the pstate at which that host currently runs.
+ *
+ *  See also @ref plugin_energy.
+ */
+int sg_host_get_pstate(sg_host_t host)
+{
+  return host->getPstate();
+}
+/** @brief Sets the pstate at which that host should run.
+ *
+ *  See also @ref plugin_energy.
+ */
+void sg_host_set_pstate(sg_host_t host, int pstate)
+{
+  host->setPstate(pstate);
+}
+
+/** \ingroup m_host_management
+ *
+ * \brief Start the host if it is off
+ *
+ * See also #sg_host_is_on() and #sg_host_is_off() to test the current state of the host and @ref plugin_energy
+ * for more info on DVFS.
+ */
+void sg_host_turn_on(sg_host_t host)
+{
+  host->turnOn();
+}
+
+/** \ingroup m_host_management
+ *
+ * \brief Stop the host if it is on
+ *
+ * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
+ * for more info on DVFS.
+ */
+void sg_host_turn_off(sg_host_t host)
+{
+  host->turnOff();
+}
+
+/** @ingroup m_host_management
+ * @brief Determine if a host is up and running.
+ *
+ * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
+ * info on DVFS.
+ *
+ * @param host host to test
+ * @return Returns true if the host is up and running, and false if it's currently down
+ */
+int sg_host_is_on(sg_host_t host)
+{
+  return host->isOn();
+}
+
+/** @ingroup m_host_management
+ * @brief Determine if a host is currently off.
+ *
+ * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
+ * info on DVFS.
+ */
+int sg_host_is_off(sg_host_t host)
+{
+  return host->isOff();
+}
+
+/** @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();
+  if (props == nullptr)
+    return nullptr;
+  for (auto const& elm : *props) {
+    xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
+  }
+  return as_dict;
+}
+
+/** \ingroup m_host_management
+ * \brief Returns the value of a given host property
+ *
+ * \param host a host
+ * \param name a property name
+ * \return value of a property (or nullptr if property not set)
+*/
+const char* sg_host_get_property_value(sg_host_t host, const char* name)
+{
+  return host->getProperty(name);
+}
+
+void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
+{
+  host->setProperty(name, value);
+}
+
+/**
+ * \brief Find a route between two hosts
+ *
+ * \param from where from
+ * \param to where to
+ * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
+ */
+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);
+  for (auto const& link : vlinks)
+    xbt_dynar_push(links, &link);
+}
+/**
+ * \brief Find the latency of the route between two hosts
+ *
+ * \param from where from
+ * \param to where to
+ */
+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);
+  return res;
+}
+/**
+ * \brief Find the bandwitdh of the route between two hosts
+ *
+ * \param from where from
+ * \param to where to
+ */
+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);
+  for (auto const& link : vlinks) {
+    double bandwidth = link->bandwidth();
+    if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
+      min_bandwidth = bandwidth;
+  }
+  return min_bandwidth;
+}
+
+/** @brief Displays debugging information about a host */
+void sg_host_dump(sg_host_t host)
+{
+  XBT_INFO("Displaying host %s", host->get_cname());
+  XBT_INFO("  - speed: %.0f", host->getSpeed());
+  XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
+  std::map<std::string, std::string>* props = host->getProperties();
+
+  if (not props->empty()) {
+    XBT_INFO("  - properties:");
+    for (auto const& elm : *props) {
+      XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
+    }
+  }
+}
+
+/** \brief Return the list of actors attached to an host.
+ *
+ * \param host a host
+ * \param whereto a dynar in which we should push actors living on that host
+ */
+void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
+{
+  for (auto& actor : host->extension<simgrid::simix::Host>()->process_list) {
+    s4u_Actor* p = actor.ciface();
+    xbt_dynar_push(whereto, &p);
+  }
+}
+
+sg_host_t sg_host_self()
+{
+  smx_actor_t process = SIMIX_process_self();
+  return (process == nullptr) ? nullptr : process->host;
+}