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 c1200be..a663add 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2013-2017. 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. */
@@ -12,7 +12,7 @@
 #include "xbt/Extendable.hpp"
 #include "xbt/dict.h"
 
-#include "src/kernel/routing/NetPoint.hpp"
+#include "simgrid/kernel/routing/NetPoint.hpp"
 #include "src/simix/smx_host_private.hpp"
 #include "src/surf/HostImpl.hpp"
 #include "src/surf/cpu_interface.hpp"
@@ -37,8 +37,12 @@ size_t 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();
 
-  return (sg_host_t*)xbt_dynar_to_array(sg_hosts_as_dynar());
+  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)
@@ -71,8 +75,7 @@ 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::getInstance()->getHostList(&list);
+  std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::getInstance()->getAllHosts();
 
   for (auto const& host : list) {
     if (host && host->pimpl_netpoint && host->pimpl_netpoint->isHost())
@@ -126,6 +129,28 @@ 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->getAvailableSpeed();
@@ -154,6 +179,55 @@ 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);
@@ -246,4 +320,54 @@ void sg_host_dump(sg_host_t host)
   }
 }
 
+/** \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;
+}
+
+/* ************************** 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"