Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Making MSG fade away (part 1)
authorFrederic Suter <frederic.suter@cc.in2p3.fr>
Tue, 23 Jan 2018 11:24:37 +0000 (12:24 +0100)
committerFrederic Suter <frederic.suter@cc.in2p3.fr>
Tue, 23 Jan 2018 11:24:37 +0000 (12:24 +0100)
most of the MSG_host functions already have a sg_host equivalent.
Don't duplicate the code or multiply the layer and use #define in
include/simgrid/host.h to guarantee backward compatibility

include/simgrid/host.h
include/simgrid/msg.h
src/msg/msg_host.cpp
src/msg/msg_process.cpp
teshsuite/msg/app-token-ring/app-token-ring.c
teshsuite/msg/platform-properties/platform-properties.c

index 3c869c3..8e76b05 100644 (file)
 
 SG_BEGIN_DECL()
 
-XBT_PUBLIC(size_t) sg_host_count();
 XBT_PUBLIC(sg_host_t *) sg_host_list();
 
+/** \ingroup m_host_management
+ * \brief Return the current number MSG hosts.
+ */
+XBT_PUBLIC(size_t) sg_host_count();
+#define MSG_get_host_number() sg_host_count()
+
+/** \ingroup m_host_management
+ * \brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
+ * \remark The host order in the returned array is generally different from the host creation/declaration order in the
+ *         XML platform (we use a hash table internally)
+ */
+XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar();
+#define MSG_hosts_as_dynar() sg_hosts_as_dynar()
+
 XBT_PUBLIC(size_t) sg_host_extension_create(void(*deleter)(void*));
 XBT_PUBLIC(void*) sg_host_extension_get(sg_host_t host, size_t rank);
+
+/** \ingroup m_host_management
+ * \brief Finds a msg_host_t using its name.
+ *
+ * This is a name directory service
+ * \param name the name of an host.
+ * \return the corresponding host
+ */
 XBT_PUBLIC(sg_host_t) sg_host_by_name(const char *name);
+#define MSG_host_by_name(name) sg_host_by_name(name)
+#define MSG_get_host_by_name(n) sg_host_by_name(n) /* Rewrite the old name into the new one transparently */
+
 XBT_PUBLIC(const char*) sg_host_get_name(sg_host_t host);
-XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar();
 
 // ========== User Data ==============
 XBT_PUBLIC(void*) sg_host_user(sg_host_t host);
@@ -31,20 +54,82 @@ XBT_PUBLIC(void) sg_host_user_set(sg_host_t host, void* userdata);
 XBT_PUBLIC(void) sg_host_user_destroy(sg_host_t host);
 
 // ========= storage related functions ============
+/** \ingroup m_host_management
+ * \brief Return the list of mount point names on an host.
+ * \param host a host
+ * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
+ */
 XBT_PUBLIC(xbt_dict_t) sg_host_get_mounted_storage_list(sg_host_t host);
+#define MSG_host_get_mounted_storage_list(host) sg_host_get_mounted_storage_list(host)
+
+/** \ingroup m_host_management
+ * \brief Return the list of storages attached to an host.
+ * \param host a host
+ * \return a dynar containing all storages (name) attached to the host
+ */
 XBT_PUBLIC(xbt_dynar_t) sg_host_get_attached_storage_list(sg_host_t host);
+#define MSG_host_get_attached_storage_list(host) host_get_attached_storage_list(host)
+
 // =========== user-level functions ===============
+/** \ingroup m_host_management
+ * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
+ */
 XBT_PUBLIC(double) sg_host_speed(sg_host_t host);
+#define MSG_host_get_speed(host) sg_host_speed(host)
 XBT_PUBLIC(double) sg_host_get_available_speed(sg_host_t host);
 
+/** \ingroup m_process_management
+ * \brief Return the location on which a process is running.
+ * \param process a process (nullptr means the current one)
+ * \return the msg_host_t corresponding to the location on which \a process is running.
+ */
 XBT_PUBLIC(sg_host_t) sg_host_self();
+#define MSG_host_self() sg_host_self()
+
 XBT_PUBLIC(const char*) sg_host_self_get_name();
+
+/** \ingroup m_host_management
+ * \brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
+ *
+ * \param  host host to test
+ */
 XBT_PUBLIC(int) sg_host_get_nb_pstates(sg_host_t host);
+#define MSG_host_get_nb_pstates(host) sg_host_get_nb_pstates(host)
+
 XBT_PUBLIC(int) sg_host_get_pstate(sg_host_t host);
+#define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* users don't know that MSG is the C version of SimGrid */
 XBT_PUBLIC(void) sg_host_set_pstate(sg_host_t host,int pstate);
+#define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* (same here) */
+
+/** \ingroup m_host_management
+ * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
+ *
+ * \param host a host
+ * \return a dict containing the properties
+ */
 XBT_PUBLIC(xbt_dict_t) sg_host_get_properties(sg_host_t host);
+#define MSG_host_get_properties(host) sg_host_get_properties(host)
+
+/** \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)
+ */
 XBT_PUBLIC(const char*) sg_host_get_property_value(sg_host_t host, const char* name);
+#define MSG_host_get_property_value(host, name) sg_host_get_property_value(host, name)
+
+/** \ingroup m_host_management
+ * \brief Change the value of a given host property
+ *
+ * \param host a host
+ * \param name a property name
+ * \param value what to change the property to
+ */
 XBT_PUBLIC(void) sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
+#define MSG_host_set_property_value(host, name, value) sg_host_set_property_value(host, name, value)
+
 XBT_PUBLIC(void) sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links);
 XBT_PUBLIC(double) sg_host_route_latency(sg_host_t from, sg_host_t to);
 XBT_PUBLIC(double) sg_host_route_bandwidth(sg_host_t from, sg_host_t to);
index c3fdd25..dd20c30 100644 (file)
@@ -183,8 +183,6 @@ XBT_PUBLIC(sg_size_t) MSG_storage_read(msg_storage_t storage, sg_size_t size);
 XBT_PUBLIC(sg_size_t) MSG_storage_write(msg_storage_t storage, sg_size_t size);
 
 /************************** Host handling ***********************************/
-XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
-#define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
 /** \ingroup m_host_management
@@ -193,8 +191,6 @@ XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
 #define MSG_host_get_name(host) sg_host_get_name(host)
 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
-XBT_PUBLIC(msg_host_t) MSG_host_self();
-XBT_PUBLIC(double) MSG_host_get_speed(msg_host_t h);
 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
 XBT_PUBLIC(void) MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto);
 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
@@ -207,18 +203,6 @@ XBT_ATTRIB_DEPRECATED_v320("Use MSG_host_get_speed(): v3.20 will drop MSG_host_g
 }
 
 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
-XBT_PUBLIC(int)    MSG_host_get_nb_pstates(msg_host_t h);
-#define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* users don't know that MSG is the C version of SimGrid */
-#define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* (same here) */
-XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar();
-XBT_PUBLIC(int) MSG_get_host_number();
-XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
-XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
-
-/*property handlers*/
-XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
-XBT_PUBLIC(const char*) MSG_host_get_property_value(msg_host_t host, const char* name);
-XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host, const char* name, char* value);
 
 XBT_PUBLIC(void) MSG_create_environment(const char *file);
 
index 3857879..48fab18 100644 (file)
@@ -23,18 +23,6 @@ extern "C" {
  */
 
 /********************************* Host **************************************/
-/** \ingroup m_host_management
- * \brief Finds a msg_host_t using its name.
- *
- * This is a name directory service
- * \param name the name of an host.
- * \return the corresponding host
- */
-msg_host_t MSG_host_by_name(const char *name)
-{
-  return simgrid::s4u::Host::by_name_or_null(name);
-}
-
 /** \ingroup m_host_management
  *
  * \brief Set the user data of a #msg_host_t.
@@ -56,15 +44,6 @@ void *MSG_host_get_data(msg_host_t host) {
   return sg_host_user(host);
 }
 
-/** \ingroup m_host_management
- *
- * \brief Return the location on which the current process is executed.
- */
-msg_host_t MSG_host_self()
-{
-  return MSG_process_get_host(nullptr);
-}
-
 /** \ingroup m_host_management
  *
  * \brief Start the host if it is off
@@ -89,29 +68,6 @@ void MSG_host_off(msg_host_t host)
   host->turnOff();
 }
 
-/** \ingroup m_host_management
- * \brief Return the current number MSG hosts.
- */
-int MSG_get_host_number()
-{
-  return sg_host_count();
-}
-
-/** \ingroup m_host_management
- * \brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
- * \remark The host order in the returned array is generally different from the host creation/declaration order in the
- *         XML platform (we use a hash table internally)
- */
-xbt_dynar_t MSG_hosts_as_dynar() {
-  return sg_hosts_as_dynar();
-}
-
-/** \ingroup m_host_management
- * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
- */
-double MSG_host_get_speed(msg_host_t host) {
-  return host->getSpeed();
-}
 
 /** \ingroup m_host_management
  * \brief Return the number of cores.
@@ -138,49 +94,6 @@ void MSG_host_get_process_list(msg_host_t host, xbt_dynar_t whereto)
   }
 }
 
-/** \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 *MSG_host_get_property_value(msg_host_t host, const char *name)
-{
-  return host->getProperty(name);
-}
-
-/** \ingroup m_host_management
- * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
- *
- * \param host a host
- * \return a dict containing the properties
- */
-xbt_dict_t MSG_host_get_properties(msg_host_t host)
-{
-  xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
-  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 Change the value of a given host property
- *
- * \param host a host
- * \param name a property name
- * \param value what to change the property to
- */
-void MSG_host_set_property_value(msg_host_t host, const char* name, char* value)
-{
-  host->setProperty(name, value);
-}
-
 /** @ingroup m_host_management
  * @brief Determine if a host is up and running.
  *
@@ -218,33 +131,6 @@ double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
   return host->getPstateSpeed(pstate_index);
 }
 
-/** \ingroup m_host_management
- * \brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
- *
- * \param  host host to test
- */
-int MSG_host_get_nb_pstates(msg_host_t host) {
-  return sg_host_get_nb_pstates(host);
-}
 
-/** \ingroup m_host_management
- * \brief Return the list of mount point names on an host.
- * \param host a host
- * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
- */
-xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
-{
-  return sg_host_get_mounted_storage_list(host);
-}
-
-/** \ingroup m_host_management
- * \brief Return the list of storages attached to an host.
- * \param host a host
- * \return a dynar containing all storages (name) attached to the host
- */
-xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
-{
-  return sg_host_get_attached_storage_list(host);
-}
 
 }
index 29ac2fd..78ea89d 100644 (file)
@@ -276,11 +276,6 @@ XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
   msg_global->process_data_cleanup = data_cleanup;
 }
 
-/** \ingroup m_process_management
- * \brief Return the location on which a process is running.
- * \param process a process (nullptr means the current one)
- * \return the msg_host_t corresponding to the location on which \a process is running.
- */
 msg_host_t MSG_process_get_host(msg_process_t process)
 {
   if (process == nullptr) {
index c5d7118..4316fd6 100644 (file)
@@ -53,7 +53,7 @@ int main(int argc, char* argv[])
   MSG_create_environment(argv[1]); /* - Load the platform description */
   xbt_dynar_t hosts = MSG_hosts_as_dynar();
 
-  XBT_INFO("Number of hosts '%d'", MSG_get_host_number());
+  XBT_INFO("Number of hosts '%lu'", MSG_get_host_number());
   unsigned int i;
   msg_host_t h;
   xbt_dynar_foreach (hosts, i,
index 7a3dbeb..b87f640 100644 (file)
@@ -114,7 +114,7 @@ int main(int argc, char* argv[])
 
   MSG_create_environment(argv[1]);
 
-  XBT_INFO("There are %d hosts in the environment", MSG_get_host_number());
+  XBT_INFO("There are %lu hosts in the environment", MSG_get_host_number());
 
   xbt_dynar_t hosts = MSG_hosts_as_dynar();
   xbt_dynar_foreach (hosts, i, host) {