Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MSG aliasing instead of macro-ization to keep ABI safe
[simgrid.git] / src / simgrid / host.cpp
index c4c9f20..a663add 100644 (file)
-/* Copyright (c) 2013-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2013-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "xbt/dict.h"
+#include <algorithm>
+#include <vector>
+
 #include "simgrid/host.h"
-#include "simgrid/Host.hpp"
-#include "surf/surf.h" // routing_get_network_element_type FIXME:killme
+#include "simgrid/s4u/Engine.hpp"
+#include "simgrid/s4u/Host.hpp"
+#include "xbt/Extendable.hpp"
+#include "xbt/dict.h"
+
+#include "simgrid/kernel/routing/NetPoint.hpp"
+#include "src/simix/smx_host_private.hpp"
+#include "src/surf/HostImpl.hpp"
+#include "src/surf/cpu_interface.hpp"
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sg_host, sd, "Logging specific to sg_hosts");
+
+extern "C" {
 
 size_t sg_host_count()
 {
-  return xbt_dict_length(host_list);
+  return simgrid::s4u::Engine::getInstance()->getHostCount();
 }
+/** @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::getInstance()->getAllHosts();
 
-void* sg_host_get_facet(sg_host_t host, size_t facet)
-{
-  return host->facet(facet);
+  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->id().c_str();
+  return host->getCname();
 }
 
-size_t sg_host_add_level(void(*deleter)(void*))
+void* sg_host_extension_get(sg_host_t host, size_t ext)
 {
-  return simgrid::Host::add_level(deleter);
+  return host->extension(ext);
 }
 
-sg_host_t sg_host_by_name(const char *name)
+size_t sg_host_extension_create(void(*deleter)(void*))
 {
-  return simgrid::Host::by_name_or_null(name);
+  return simgrid::s4u::Host::extension_create(deleter);
 }
 
-sg_host_t sg_host_by_name_or_create(const char *name)
+sg_host_t sg_host_by_name(const char *name)
 {
-  return simgrid::Host::by_name_or_create(name);
+  return simgrid::s4u::Host::by_name_or_null(name);
 }
 
-xbt_dynar_t sg_hosts_as_dynar(void)
+static int hostcmp_voidp(const void* pa, const void* pb)
 {
-       xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t),NULL);
-
-  xbt_dict_cursor_t cursor = nullptr;
-  const char* name = nullptr;
-  simgrid::Host* host = nullptr;
-       xbt_dict_foreach(host_list, cursor, name, host)
-               if(routing_get_network_element_type(name) == SURF_NETWORK_ELEMENT_HOST)
-                       xbt_dynar_push(res, &host);
-       return res;
+  return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->getCname(),
+                (*static_cast<simgrid::s4u::Host* const*>(pb))->getCname());
 }
 
-// ========= Layering madness ==============
-
-int MSG_HOST_LEVEL;
-int SD_HOST_LEVEL;
-int SIMIX_HOST_LEVEL;
-int ROUTING_HOST_LEVEL;
-int USER_HOST_LEVEL;
+xbt_dynar_t sg_hosts_as_dynar()
+{
+  xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t),nullptr);
 
-#include "src/msg/msg_private.h" // MSG_host_priv_free. FIXME: killme
-#include "src/simdag/private.h" // __SD_workstation_destroy. FIXME: killme
-#include "src/simix/smx_host_private.h" // SIMIX_host_destroy. FIXME: killme
-#include "src/surf/cpu_interface.hpp"
-#include "src/surf/surf_routing.hpp"
+  std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::getInstance()->getAllHosts();
 
-static XBT_INLINE void surf_cpu_free(void *r) {
-  delete static_cast<simgrid::surf::Cpu*>(r);
-}
-static XBT_INLINE void routing_asr_host_free(void *p) {
-  delete static_cast<simgrid::surf::RoutingEdge*>(p);
+  for (auto const& host : list) {
+    if (host && host->pimpl_netpoint && host->pimpl_netpoint->isHost())
+      xbt_dynar_push(res, &host);
+  }
+  xbt_dynar_sort(res, hostcmp_voidp);
+  return res;
 }
 
-void sg_host_init()
-{
-  MSG_HOST_LEVEL = simgrid::Host::add_level([](void *p) {
-    __MSG_host_priv_free((msg_host_priv_t) p);
-  });
-  SD_HOST_LEVEL = simgrid::Host::add_level(__SD_workstation_destroy);
-  SIMIX_HOST_LEVEL = simgrid::Host::add_level(SIMIX_host_destroy);
-  simgrid::surf::Cpu::init();
-  ROUTING_HOST_LEVEL = simgrid::Host::add_level(routing_asr_host_free);
-  USER_HOST_LEVEL = simgrid::Host::add_level(NULL);
-}
+// ========= Layering madness ==============*
 
 // ========== User data Layer ==========
 void *sg_host_user(sg_host_t host) {
-  return host->facet(USER_HOST_LEVEL);
+  return host->extension(USER_HOST_LEVEL);
 }
 void sg_host_user_set(sg_host_t host, void* userdata) {
-  host->set_facet(USER_HOST_LEVEL,userdata);
+  host->extension_set(USER_HOST_LEVEL,userdata);
 }
 void sg_host_user_destroy(sg_host_t host) {
-  host->set_facet(USER_HOST_LEVEL, nullptr);
+  host->extension_set(USER_HOST_LEVEL, nullptr);
 }
 
-// ========== MSG Layer ==============
-msg_host_priv_t sg_host_msg(sg_host_t host) {
-       return (msg_host_priv_t) host->facet(MSG_HOST_LEVEL);
-}
-void sg_host_msg_set(sg_host_t host, msg_host_priv_t smx_host) {
-  host->set_facet(MSG_HOST_LEVEL, smx_host);
-}
-void sg_host_msg_destroy(sg_host_t host) {
-  host->set_facet(MSG_HOST_LEVEL, nullptr);
-}
-// ========== SimDag Layer ==============
-SD_workstation_priv_t sg_host_sd(sg_host_t host) {
-  return (SD_workstation_priv_t) host->facet(SD_HOST_LEVEL);
-}
-void sg_host_sd_set(sg_host_t host, SD_workstation_priv_t smx_host) {
-  host->set_facet(SD_HOST_LEVEL, smx_host);
-}
-void sg_host_sd_destroy(sg_host_t host) {
-  host->set_facet(SD_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->getCname(), nullptr);
+  }
 
-// ========== Simix layer =============
-smx_host_priv_t sg_host_simix(sg_host_t host){
-  return (smx_host_priv_t) host->facet(SIMIX_HOST_LEVEL);
-}
-void sg_host_simix_set(sg_host_t host, smx_host_priv_t smx_host) {
-  host->set_facet(SIMIX_HOST_LEVEL, smx_host);
-}
-void sg_host_simix_destroy(sg_host_t host) {
-  host->set_facet(SIMIX_HOST_LEVEL, nullptr);
+  return res;
 }
 
-// ========== SURF CPU ============
-surf_cpu_t sg_host_surfcpu(sg_host_t host) {
-       return host->facet<simgrid::surf::Cpu>();
-}
-void sg_host_surfcpu_set(sg_host_t host, surf_cpu_t cpu) {
-  host->set_facet(simgrid::surf::Cpu::LEVEL, cpu);
-}
-void sg_host_surfcpu_destroy(sg_host_t host) {
-  host->set_facet<simgrid::surf::Cpu>(nullptr);
-}
-// ========== RoutingEdge ============
-surf_RoutingEdge *sg_host_edge(sg_host_t host) {
-       return (surf_RoutingEdge*) host->facet(ROUTING_HOST_LEVEL);
-}
-void sg_host_edge_set(sg_host_t host, surf_RoutingEdge *edge) {
-  host->set_facet(ROUTING_HOST_LEVEL, edge);
-}
-void sg_host_edge_destroy(sg_host_t host, int do_callback) {
-  host->set_facet(ROUTING_HOST_LEVEL, nullptr, do_callback);
+xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host){
+  std::vector<const char*>* storage_vector = new std::vector<const char*>();
+  xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
+  host->getAttachedStorages(storage_vector);
+  for (auto const& name : *storage_vector)
+    xbt_dynar_push(storage_dynar, &name);
+  delete storage_vector;
+  return storage_dynar;
 }
 
 // =========== user-level functions ===============
 // ================================================
-double sg_host_get_speed(sg_host_t host){
-  return surf_host_get_speed(host, 1.0);
+/** @brief Returns the total speed of a host */
+double sg_host_speed(sg_host_t host)
+{
+  return host->getSpeed();
 }
 
-double sg_host_get_available_speed(sg_host_t host){
-  return surf_host_get_available_speed(host);
-}
-/** @brief Returns the number of core of the processor. */
-int sg_host_get_core(sg_host_t host) {
-       return surf_host_get_core(host);
-}
-/** @brief Returns the state of a host.
- *  @return 1 if the host is active or 0 if it has crashed.
+/** \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
  */
-int sg_host_get_state(sg_host_t host) {
-       return surf_host_get_state(surf_host_resource_priv(host));
+double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
+{
+  return host->getPstateSpeed(pstate_index);
 }
 
-/** @brief Returns the total energy consumed by the host (in Joules).
+/** \ingroup m_host_management
+ * \brief Return the number of cores.
  *
- *  See also @ref SURF_plugin_energy.
+ * \param host a host
+ * \return the number of cores
  */
-double sg_host_get_consumed_energy(sg_host_t host) {
-       return surf_host_get_consumed_energy(host);
+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->getAvailableSpeed();
 }
 
 /** @brief Returns the number of power states for a host.
  *
- *  See also @ref SURF_plugin_energy.
+ *  See also @ref plugin_energy.
  */
 int sg_host_get_nb_pstates(sg_host_t host) {
-       return surf_host_get_nb_pstates(host);
+  return host->getPstatesCount();
 }
 
 /** @brief Gets the pstate at which that host currently runs.
  *
- *  See also @ref SURF_plugin_energy.
+ *  See also @ref plugin_energy.
  */
 int sg_host_get_pstate(sg_host_t host) {
-       return surf_host_get_pstate(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();
 }
 
-namespace simgrid {
+/** \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();
+}
 
-Host::Host(std::string const& id)
-  : id_(id)
+/** @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();
 }
 
-Host::~Host()
+/** @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);
 }
 
-Host* Host::by_name_or_null(const char* name)
+void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 {
-  return (Host*) xbt_dict_get_or_null(host_list, name);
+  host->setProperty(name, value);
 }
 
-Host* Host::by_name_or_create(const char* name)
+/**
+ * \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)
 {
-  Host* host = by_name_or_null(name);
-  if (host == nullptr) {
-    host = new Host(name);
-    xbt_dict_set(host_list, name, host, NULL);
+  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->getCname());
+  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);
   }
-  return host;
 }
 
+sg_host_t sg_host_self()
+{
+  smx_actor_t process = SIMIX_process_self();
+  return (process == nullptr) ? nullptr : process->host;
 }
+
+/* ************************** Backward ABI compatibility *************************** */
+xbt_dynar_t MSG_hosts_as_dynar() __attribute__((alias("sg_hosts_as_dynar")));
+
+size_t MSG_get_host_number() __attribute__((alias("sg_host_count")));
+sg_host_t MSG_get_host_by_name(const char* name) __attribute__((alias("sg_host_by_name")));
+sg_host_t MSG_host_by_name(const char* name) __attribute__((alias("sg_host_by_name")));
+
+const char* MSG_host_get_name(sg_host_t host) __attribute__((alias("sg_host_get_name")));
+void* MSG_host_get_data(sg_host_t host) __attribute__((alias("sg_host_user")));
+void MSG_host_set_data(sg_host_t host, void* data) __attribute__((alias("sg_host_user_set")));
+xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host) __attribute__((alias("sg_host_get_mounted_storage_list")));
+xbt_dynar_t MSG_host_get_attached_storage_lists(sg_host_t host)
+    __attribute__((alias("sg_host_get_attached_storage_list")));
+double MSG_host_get_speed(sg_host_t host) __attribute__((alias("sg_host_speed")));
+double MSG_host_get_power_peak_at(sg_host_t host, int pstate_index) __attribute__((alias("sg_host_get_pstate_speed")));
+int MSG_host_get_core_number(sg_host_t host) __attribute__((alias("sg_host_core_count")));
+int MSG_host_get_nb_pstates(sg_host_t host) __attribute__((alias("sg_host_get_nb_pstates")));
+int MSG_host_get_pstate(sg_host_t host) __attribute__((alias("sg_host_get_pstate")));
+void MSG_host_set_pstate(sg_host_t host, int pstate) __attribute__((alias("sg_host_set_pstate")));
+void MSG_host_on(sg_host_t h) __attribute__((alias("sg_host_turn_on")));
+void MSG_host_off(sg_host_t h) __attribute__((alias("sg_host_turn_off")));
+int MSG_host_is_on(sg_host_t h) __attribute__((alias("sg_host_is_on")));
+int MSG_host_is_off(sg_host_t h) __attribute__((alias("sg_host_is_off")));
+xbt_dict_t MSG_host_get_properties(sg_host_t host) __attribute__((alias("sg_host_get_properties")));
+const char* MSG_host_get_property_value(sg_host_t host, const char* name)
+    __attribute__((alias("sg_host_get_property_value")));
+void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value)
+    __attribute__((alias("sg_host_set_property_value")));
+void MSG_host_get_process_list(sg_host_t host, xbt_dynar_t whereto) __attribute__((alias("sg_host_get_actor_list")));
+sg_host_t MSG_host_self() __attribute__((alias("sg_host_self")));
+
+} // extern "C"