src/simgrid/host.cpp

   1 /* Copyright (c) 2013-2016. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <vector>
   8
   9 #include "xbt/dict.h"
  10 #include "simgrid/host.h"
  11 #include <xbt/Extendable.hpp>
  12 #include <simgrid/s4u/host.hpp>
  13
  14 #include "src/kernel/routing/NetPoint.hpp"
  15 #include "src/simix/smx_host_private.h"
  16 #include "src/surf/HostImpl.hpp"
  17 #include "src/surf/cpu_interface.hpp"
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sg_host, sd, "Logging specific to sg_hosts");
  20
  21 // FIXME: The following duplicates the content of s4u::Host
  22 namespace simgrid {
  23 namespace s4u {
  24 extern std::map<std::string, simgrid::s4u::Host*> host_list;
  25 }
  26 }
  27
  28 extern "C" {
  29
  30 void sg_host_exit()
  31 {
  32   /* copy all names to not modify the map while iterating over it.
  33    *
  34    * Plus, the hosts are destroyed in the lexicographic order to ensure
  35    * that the output is reproducible: we don't want to kill them in the
  36    * pointer order as it could be platform-dependent, which would break
  37    * the tests.
  38    */
  39   std::vector<std::string> names = std::vector<std::string>();
  40   for (auto kv : simgrid::s4u::host_list)
  41     names.push_back(kv.second->name());
  42
  43   std::sort(names.begin(), names.end());
  44
  45   for (auto name : names)
  46     simgrid::s4u::host_list.at(name)->destroy();
  47
  48   // host_list.clear(); This would be sufficient if the dict would contain smart_ptr. It's now useless
  49 }
  50
  51 size_t sg_host_count()
  52 {
  53   return simgrid::s4u::host_list.size();
  54 }
  55 /** @brief Returns the host list
  56  *
  57  * Uses sg_host_count() to know the array size.
  58  *
  59  * \return an array of \ref sg_host_t containing all the hosts in the platform.
  60  * \remark The host order in this array is generally different from the
  61  * creation/declaration order in the XML platform (we use a hash table
  62  * internally).
  63  * \see sg_host_count()
  64  */
  65 sg_host_t *sg_host_list() {
  66   xbt_assert(sg_host_count() > 0, "There is no host!");
  67   return (sg_host_t*)xbt_dynar_to_array(sg_hosts_as_dynar());
  68 }
  69
  70 const char *sg_host_get_name(sg_host_t host)
  71 {
  72   return host->cname();
  73 }
  74
  75 void* sg_host_extension_get(sg_host_t host, size_t ext)
  76 {
  77   return host->extension(ext);
  78 }
  79
  80 size_t sg_host_extension_create(void(*deleter)(void*))
  81 {
  82   return simgrid::s4u::Host::extension_create(deleter);
  83 }
  84
  85 sg_host_t sg_host_by_name(const char *name)
  86 {
  87   return simgrid::s4u::Host::by_name_or_null(name);
  88 }
  89
  90 static int hostcmp_voidp(const void* pa, const void* pb)
  91 {
  92   return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->cname(),
  93                 (*static_cast<simgrid::s4u::Host* const*>(pb))->cname());
  94 }
  95
  96 xbt_dynar_t sg_hosts_as_dynar()
  97 {
  98   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t),nullptr);
  99
 100   for (auto kv : simgrid::s4u::host_list) {
 101     simgrid::s4u::Host* host = kv.second;
 102     if (host && host->pimpl_netpoint && host->pimpl_netpoint->isHost())
 103       xbt_dynar_push(res, &host);
 104   }
 105   xbt_dynar_sort(res, hostcmp_voidp);
 106   return res;
 107 }
 108
 109 // ========= Layering madness ==============*
 110
 111 // ========== User data Layer ==========
 112 void *sg_host_user(sg_host_t host) {
 113   return host->extension(USER_HOST_LEVEL);
 114 }
 115 void sg_host_user_set(sg_host_t host, void* userdata) {
 116   host->extension_set(USER_HOST_LEVEL,userdata);
 117 }
 118 void sg_host_user_destroy(sg_host_t host) {
 119   host->extension_set(USER_HOST_LEVEL, nullptr);
 120 }
 121
 122 // ========= storage related functions ============
 123 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host){
 124   return host->pimpl_->getMountedStorageList();
 125 }
 126
 127 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host){
 128   std::vector<const char*>* storage_vector = new std::vector<const char*>();
 129   xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
 130   host->attachedStorages(storage_vector);
 131   for (auto name : *storage_vector)
 132     xbt_dynar_push(storage_dynar, &name);
 133   delete storage_vector;
 134   return storage_dynar;
 135 }
 136
 137 // =========== user-level functions ===============
 138 // ================================================
 139 /** @brief Returns the total speed of a host */
 140 double sg_host_speed(sg_host_t host)
 141 {
 142   return host->speed();
 143 }
 144
 145 double sg_host_get_available_speed(sg_host_t host)
 146 {
 147   return host->pimpl_cpu->getAvailableSpeed();
 148 }
 149
 150 /** @brief Returns the number of power states for a host.
 151  *
 152  *  See also @ref SURF_plugin_energy.
 153  */
 154 int sg_host_get_nb_pstates(sg_host_t host) {
 155   return host->pstatesCount();
 156 }
 157
 158 /** @brief Gets the pstate at which that host currently runs.
 159  *
 160  *  See also @ref SURF_plugin_energy.
 161  */
 162 int sg_host_get_pstate(sg_host_t host) {
 163   return host->pstate();
 164 }
 165 /** @brief Sets the pstate at which that host should run.
 166  *
 167  *  See also @ref SURF_plugin_energy.
 168  */
 169 void sg_host_set_pstate(sg_host_t host,int pstate) {
 170   host->setPstate(pstate);
 171 }
 172
 173 /** @brief Get the properties of an host */
 174 xbt_dict_t sg_host_get_properties(sg_host_t host) {
 175   return host->properties();
 176 }
 177
 178 /** \ingroup m_host_management
 179  * \brief Returns the value of a given host property
 180  *
 181  * \param host a host
 182  * \param name a property name
 183  * \return value of a property (or nullptr if property not set)
 184 */
 185 const char *sg_host_get_property_value(sg_host_t host, const char *name)
 186 {
 187   return (const char*) xbt_dict_get_or_null(sg_host_get_properties(host), name);
 188 }
 189 /**
 190  * \brief Find a route between two hosts
 191  *
 192  * \param from where from
 193  * \param to where to
 194  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 195  */
 196 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 197 {
 198   std::vector<simgrid::s4u::Link*> vlinks;
 199   from->routeTo(to, &vlinks, nullptr);
 200   for (auto link : vlinks)
 201     xbt_dynar_push(links, &link);
 202 }
 203 /**
 204  * \brief Find the latency of the route between two hosts
 205  *
 206  * \param from where from
 207  * \param to where to
 208  */
 209 double sg_host_route_latency(sg_host_t from, sg_host_t to)
 210 {
 211   std::vector<simgrid::s4u::Link*> vlinks;
 212   double res = 0;
 213   from->routeTo(to, &vlinks, &res);
 214   return res;
 215 }
 216 /**
 217  * \brief Find the bandwitdh of the route between two hosts
 218  *
 219  * \param from where from
 220  * \param to where to
 221  */
 222 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 223 {
 224   double min_bandwidth = -1.0;
 225
 226   std::vector<simgrid::s4u::Link*> vlinks;
 227   from->routeTo(to, &vlinks, nullptr);
 228   for (auto link : vlinks) {
 229     double bandwidth = link->bandwidth();
 230     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 231       min_bandwidth = bandwidth;
 232   }
 233   return min_bandwidth;
 234 }
 235
 236 /** @brief Displays debugging information about a host */
 237 void sg_host_dump(sg_host_t host)
 238 {
 239   xbt_dict_t props;
 240   xbt_dict_cursor_t cursor=nullptr;
 241   char *key,*data;
 242
 243   XBT_INFO("Displaying host %s", host->cname());
 244   XBT_INFO("  - speed: %.0f", host->speed());
 245   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 246   props = host->properties();
 247
 248   if (!xbt_dict_is_empty(props)){
 249     XBT_INFO("  - properties:");
 250
 251     xbt_dict_foreach(props,cursor,key,data) {
 252       XBT_INFO("    %s->%s",key,data);
 253     }
 254   }
 255 }
 256
 257 } // extern "C"