Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
separate the energy plugin from surf in the doc + improvements
[simgrid.git] / src / simgrid / host.cpp
index 36a9598..5db33f1 100644 (file)
-/* Copyright (c) 2013-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2013-2017. 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 "surf/surf_routing.h" // SIMIX_HOST_LEVEL and friends FIXME: make private here
-#include "surf/surf.h" // routing_get_network_element_type FIXME:killme
+#include "simgrid/s4u/Host.hpp"
+#include "xbt/Extendable.hpp"
+#include "xbt/dict.h"
 
-sg_host_t sg_host_by_name(const char *name){
-  return xbt_lib_get_elm_or_null(host_lib, name);
-}
+#include "src/kernel/routing/NetPoint.hpp"
+#include "src/simix/smx_host_private.h"
+#include "src/surf/HostImpl.hpp"
+#include "src/surf/cpu_interface.hpp"
 
-sg_host_t sg_host_by_name_or_create(const char *name) {
-       sg_host_t res = xbt_lib_get_elm_or_null(host_lib, name);
-       if (!res) {
-               xbt_lib_set(host_lib,name,0,NULL); // Should only create the bucklet with no data added
-               res = xbt_lib_get_elm_or_null(host_lib, name);
-       }
-       return res;
-}
-xbt_dynar_t sg_hosts_as_dynar(void) {
-       xbt_lib_cursor_t cursor;
-       char *key;
-       void **data;
-       xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t),NULL);
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sg_host, sd, "Logging specific to sg_hosts");
 
-       xbt_lib_foreach(host_lib, cursor, key, data) {
-               if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
-                       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
-                       xbt_dynar_push(res, &elm);
-               }
-       }
-       return res;
+// FIXME: The following duplicates the content of s4u::Host
+namespace simgrid {
+namespace s4u {
+extern std::map<std::string, simgrid::s4u::Host*> host_list;
+}
 }
 
-// ========= Layering madness ==============
+extern "C" {
 
-int MSG_HOST_LEVEL;
-int SD_HOST_LEVEL;
-int SIMIX_HOST_LEVEL;
-int ROUTING_HOST_LEVEL;
-int SURF_CPU_LEVEL;
+void sg_host_exit()
+{
+  /* copy all names to not modify the map while iterating over it.
+   *
+   * Plus, the hosts are destroyed in the lexicographic order to ensure
+   * that the output is reproducible: we don't want to kill them in the
+   * pointer order as it could be platform-dependent, which would break
+   * the tests.
+   */
+  std::vector<std::string> names = std::vector<std::string>();
+  for (auto kv : simgrid::s4u::host_list)
+    names.push_back(kv.second->name());
 
+  std::sort(names.begin(), names.end());
 
-#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"
+  for (auto name : names)
+    simgrid::s4u::host_list.at(name)->destroy();
+
+  // host_list.clear(); This would be sufficient if the dict would contain smart_ptr. It's now useless
+}
 
-static XBT_INLINE void surf_cpu_free(void *r) {
-  delete static_cast<Cpu*>(r);
+size_t sg_host_count()
+{
+  return simgrid::s4u::host_list.size();
 }
-static XBT_INLINE void routing_asr_host_free(void *p) {
-  delete static_cast<RoutingEdge*>(p);
+/** @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!");
+  return (sg_host_t*)xbt_dynar_to_array(sg_hosts_as_dynar());
 }
 
+const char *sg_host_get_name(sg_host_t host)
+{
+  return host->cname();
+}
 
-void sg_host_init() { // FIXME: only add the needed levels
-  MSG_HOST_LEVEL = xbt_lib_add_level(host_lib, (void_f_pvoid_t) __MSG_host_priv_free);
-  SD_HOST_LEVEL = xbt_lib_add_level(host_lib,__SD_workstation_destroy);
+void* sg_host_extension_get(sg_host_t host, size_t ext)
+{
+  return host->extension(ext);
+}
 
-  SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
-  SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_cpu_free);
-  ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,routing_asr_host_free);
+size_t sg_host_extension_create(void(*deleter)(void*))
+{
+  return simgrid::s4u::Host::extension_create(deleter);
 }
 
-// ========== MSG Layer ==============
-msg_host_priv_t sg_host_msg(sg_host_t host) {
-       return (msg_host_priv_t) xbt_lib_get_level(host, MSG_HOST_LEVEL);
+sg_host_t sg_host_by_name(const char *name)
+{
+  return simgrid::s4u::Host::by_name_or_null(name);
 }
-void sg_host_msg_set(sg_host_t host, msg_host_priv_t smx_host) {
-         xbt_lib_set(host_lib,host->key,MSG_HOST_LEVEL,smx_host);
+
+static int hostcmp_voidp(const void* pa, const void* pb)
+{
+  return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->cname(),
+                (*static_cast<simgrid::s4u::Host* const*>(pb))->cname());
 }
-void sg_host_msg_destroy(sg_host_t host) {
-         xbt_lib_unset(host_lib,host->key,MSG_HOST_LEVEL,1);
+
+xbt_dynar_t sg_hosts_as_dynar()
+{
+  xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t),nullptr);
+
+  for (auto kv : simgrid::s4u::host_list) {
+    simgrid::s4u::Host* host = kv.second;
+    if (host && host->pimpl_netpoint && host->pimpl_netpoint->isHost())
+      xbt_dynar_push(res, &host);
+  }
+  xbt_dynar_sort(res, hostcmp_voidp);
+  return res;
 }
-// ========== SimDag Layer ==============
-SD_workstation_priv_t sg_host_sd(sg_host_t host) {
-       return (SD_workstation_priv_t) xbt_lib_get_level(host, SD_HOST_LEVEL);
+
+// ========= Layering madness ==============*
+
+// ========== User data Layer ==========
+void *sg_host_user(sg_host_t host) {
+  return host->extension(USER_HOST_LEVEL);
 }
-void sg_host_sd_set(sg_host_t host, SD_workstation_priv_t smx_host) {
-         xbt_lib_set(host_lib,host->key,SD_HOST_LEVEL,smx_host);
+void sg_host_user_set(sg_host_t host, void* userdata) {
+  host->extension_set(USER_HOST_LEVEL,userdata);
 }
-void sg_host_sd_destroy(sg_host_t host) {
-         xbt_lib_unset(host_lib,host->key,SD_HOST_LEVEL,1);
+void sg_host_user_destroy(sg_host_t host) {
+  host->extension_set(USER_HOST_LEVEL, nullptr);
 }
 
-// ========== Simix layer =============
-smx_host_priv_t sg_host_simix(sg_host_t host){
-  return (smx_host_priv_t) xbt_lib_get_level(host, SIMIX_HOST_LEVEL);
-}
-void sg_host_simix_set(sg_host_t host, smx_host_priv_t smx_host) {
-       xbt_lib_set(host_lib,host->key,SIMIX_HOST_LEVEL,smx_host);
+// ========= 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 elm : host->mountedStorages()) {
+    const char* mount_name = elm.first.c_str();
+    sg_storage_t storage   = elm.second;
+    xbt_dict_set(res, mount_name, (void*)storage->name(), nullptr);
+  }
+
+  return res;
 }
-void sg_host_simix_destroy(sg_host_t host) {
-       xbt_lib_unset(host_lib,host->key,SIMIX_HOST_LEVEL,1);
+
+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->attachedStorages(storage_vector);
+  for (auto name : *storage_vector)
+    xbt_dynar_push(storage_dynar, &name);
+  delete storage_vector;
+  return storage_dynar;
 }
 
-// ========== SURF CPU ============
-surf_cpu_t sg_host_surfcpu(sg_host_t host) {
-       return (surf_cpu_t) xbt_lib_get_level(host, SURF_CPU_LEVEL);
+// =========== user-level functions ===============
+// ================================================
+/** @brief Returns the total speed of a host */
+double sg_host_speed(sg_host_t host)
+{
+  return host->speed();
 }
-void sg_host_surfcpu_set(sg_host_t host, surf_cpu_t cpu) {
-       xbt_lib_set(host_lib, host->key, SURF_CPU_LEVEL, cpu);
+
+double sg_host_get_available_speed(sg_host_t host)
+{
+  return host->pimpl_cpu->getAvailableSpeed();
 }
-void sg_host_surfcpu_destroy(sg_host_t host) {
-       xbt_lib_unset(host_lib,host->key,SURF_CPU_LEVEL,1);
+
+/** @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->pstatesCount();
 }
-// ========== RoutingEdge ============
-RoutingEdge *sg_host_edge(sg_host_t host) {
-       return (RoutingEdge*) xbt_lib_get_level(host, ROUTING_HOST_LEVEL);
+
+/** @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->pstate();
 }
-void sg_host_edge_set(sg_host_t host, RoutingEdge *edge) {
-       xbt_lib_set(host_lib, host->key, ROUTING_HOST_LEVEL, edge);
+/** @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);
 }
-void sg_host_edge_destroy(sg_host_t host, int do_callback) {
-       xbt_lib_unset(host_lib,host->key,ROUTING_HOST_LEVEL,do_callback);
+
+/** @brief Get the properties of an host */
+xbt_dict_t sg_host_get_properties(sg_host_t host) {
+  return host->properties();
 }
 
+/** \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 (const char*) xbt_dict_get_or_null(sg_host_get_properties(host), 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)
+{
+  std::vector<simgrid::s4u::Link*> vlinks;
+  from->routeTo(to, &vlinks, nullptr);
+  for (auto 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;
 
-// =========== user-level functions ===============
-// ================================================
-double sg_host_get_speed(sg_host_t host){
-  return surf_host_get_speed(host, 1.0);
+  std::vector<simgrid::s4u::Link*> vlinks;
+  from->routeTo(to, &vlinks, nullptr);
+  for (auto link : vlinks) {
+    double bandwidth = link->bandwidth();
+    if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
+      min_bandwidth = bandwidth;
+  }
+  return min_bandwidth;
 }
 
-double sg_host_get_available_speed(sg_host_t host){
-  return surf_host_get_available_speed(host);
+/** @brief Displays debugging information about a host */
+void sg_host_dump(sg_host_t host)
+{
+  xbt_dict_t props;
+
+  XBT_INFO("Displaying host %s", host->cname());
+  XBT_INFO("  - speed: %.0f", host->speed());
+  XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
+  props = host->properties();
+
+  if (not xbt_dict_is_empty(props)) {
+    XBT_INFO("  - properties:");
+    xbt_dict_cursor_t cursor = nullptr;
+    char* key;
+    char* data;
+
+    xbt_dict_foreach(props,cursor,key,data) {
+      XBT_INFO("    %s->%s",key,data);
+    }
+  }
 }
+
+} // extern "C"