Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
remove a few smells in instrumentation
[simgrid.git] / src / instr / instr_interface.cpp
index 758a256..5ed606f 100644 (file)
@@ -5,10 +5,11 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "simgrid_config.h"
-#include "src/surf/network_interface.hpp"
 #include "src/instr/instr_private.h"
-#include "surf/surf.h"
+#include "src/kernel/routing/NetCard.hpp"
+#include "src/surf/network_interface.hpp"
 #include "src/surf/surf_private.h"
+#include "surf/surf.h"
 
 typedef enum {
   INSTR_US_DECLARE,
@@ -29,12 +30,13 @@ extern xbt_dict_t trivaEdgeTypes;
 
 static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter)
 {
-  if (!TRACE_is_enabled()) return nullptr;
-  if (!TRACE_needs_platform()) return nullptr;
+  if (!TRACE_is_enabled() || !TRACE_needs_platform())
+    return nullptr;
 
   xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
   xbt_dict_cursor_t cursor = nullptr;
-  char *name, *value;
+  char *name;
+  char *value;
   xbt_dict_foreach(filter, cursor, name, value) {
     xbt_dynar_push_as (ret, char*, xbt_strdup(name));
   }
@@ -54,7 +56,7 @@ static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter)
  *
  *  \param category The name of the new tracing category to be created.
  *
- *  \see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
+ *  \see TRACE_category_with_color, MSG_task_set_category
  */
 void TRACE_category(const char *category)
 {
@@ -74,31 +76,28 @@ void TRACE_category(const char *category)
  *  \param color The color of the category (see \ref outcomes_vizu to
  *  know how to correctly specify the color)
  *
- *  \see MSG_task_set_category, SD_task_set_category
+ *  \see MSG_task_set_category
  */
 void TRACE_category_with_color (const char *category, const char *color)
 {
-  /* safe switch */
-  if (!TRACE_is_enabled()) return;
-
-  if (!(TRACE_categorized() && category != nullptr)) return;
+  /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with categories */
+  if (!TRACE_is_enabled() || !TRACE_needs_platform())
+    return;
 
-  /* if platform is not traced, we can't deal with categories */
-  if (!TRACE_needs_platform()) return;
+  if (!(TRACE_categorized() && category != nullptr))
+    return;
 
   //check if category is already created
-  char *created = (char*)xbt_dict_get_or_null(created_categories, category);
-  if (created) return;
+  if (xbt_dict_get_or_null(created_categories, category) != nullptr)
+    return;
+
   xbt_dict_set (created_categories, category, xbt_strdup("1"), nullptr);
 
   //define final_color
   char final_color[INSTR_DEFAULT_STR_SIZE];
   if (!color){
     //generate a random color
-    double red = drand48();
-    double green = drand48();
-    double blue = drand48();
-    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", red, green, blue);
+    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", /*red*/drand48(), /*green*/drand48(), /*blue*/drand48());
   }else{
     snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color);
   }
@@ -112,19 +111,18 @@ void TRACE_category_with_color (const char *category, const char *color)
 /** \ingroup TRACE_category
  *  \brief Get declared categories
  *
- * This function should be used to get categories that were already declared with #TRACE_category or with
- * #TRACE_category_with_color.
+ * This function should be used to get categories declared with #TRACE_category or with #TRACE_category_with_color.
  *
  * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
  *
  * \return A dynar with the declared categories, must be freed with xbt_dynar_free.
  *
- *  \see MSG_task_set_category, SD_task_set_category
+ *  \see MSG_task_set_category
  */
-xbt_dynar_t TRACE_get_categories (void)
+xbt_dynar_t TRACE_get_categories ()
 {
-  if (!TRACE_is_enabled()) return nullptr;
-  if (!TRACE_categorized()) return nullptr;
+  if (!TRACE_is_enabled() || !TRACE_categorized())
+    return nullptr;
 
   return instr_dict_to_dynar (created_categories);
 }
@@ -141,19 +139,16 @@ xbt_dynar_t TRACE_get_categories (void)
  */
 void TRACE_declare_mark(const char *mark_type)
 {
-  /* safe switch */
-  if (!TRACE_is_enabled()) return;
+  /* safe switchs. tracing has to be activated and if platform is not traced, we can't deal with marks */
+  if (!TRACE_is_enabled() || !TRACE_needs_platform())
+    return;
 
-  /* if platform is not traced, we don't allow marks */
-  if (!TRACE_needs_platform()) return;
-
-  if (!mark_type) THROWF (tracing_error, 1, "mark_type is nullptr");
+  if (!mark_type)
+    THROWF (tracing_error, 1, "mark_type is nullptr");
 
   //check if mark_type is already declared
-  char *created = (char*)xbt_dict_get_or_null(declared_marks, mark_type);
-  if (created) {
+  if (xbt_dict_get_or_null(declared_marks, mark_type) != nullptr)
     THROWF (tracing_error, 1, "mark_type with name (%s) is already declared", mark_type);
-  }
 
   XBT_DEBUG("MARK,declare %s", mark_type);
   PJ_type_event_new(mark_type, PJ_type_get_root());
@@ -165,9 +160,8 @@ void TRACE_declare_mark(const char *mark_type)
  *
  * This function declares a new colored value for a Paje event type in the trace file that can be used by simulators to
  * declare application-level marks. This function is independent of which API is used in SimGrid. The color needs to be
- * a string with three numbers separated by spaces in the range [0,1].
- * A light-gray color can be specified using "0.7 0.7 0.7" as color. If a nullptr color is provided, the color used will
- * be white ("1 1 1").
+ * a string with three numbers separated by spaces in the range [0,1]. A light-gray color can be specified using
+ * "0.7 0.7 0.7" as color. If a nullptr color is provided, the color used will be white ("1 1 1").
  *
  * \param mark_type The name of the new type.
  * \param mark_value The name of the new value for this type.
@@ -177,22 +171,22 @@ void TRACE_declare_mark(const char *mark_type)
  */
 void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color)
 {
-  /* safe switch */
-  if (!TRACE_is_enabled()) return;
-
-  /* if platform is not traced, we don't allow marks */
-  if (!TRACE_needs_platform()) return;
+  /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
+  if (!TRACE_is_enabled() || !TRACE_needs_platform())
+    return;
 
-  if (!mark_type) THROWF (tracing_error, 1, "mark_type is nullptr");
-  if (!mark_value) THROWF (tracing_error, 1, "mark_value is nullptr");
+  if (!mark_type)
+    THROWF (tracing_error, 1, "mark_type is nullptr");
+  if (!mark_value)
+    THROWF (tracing_error, 1, "mark_value is nullptr");
 
   type_t type = PJ_type_get (mark_type, PJ_type_get_root());
-  if (!type){
+  if (!type)
     THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
-  }
 
   char white[INSTR_DEFAULT_STR_SIZE] = "1.0 1.0 1.0";
-  if (!mark_color) mark_color = white;
+  if (!mark_color)
+    mark_color = white;
 
   XBT_DEBUG("MARK,declare_value %s %s %s", mark_type, mark_value, mark_color);
   PJ_value_new (mark_value, mark_color, type);
@@ -202,8 +196,7 @@ void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mar
  * \brief Declare a new value for a previously declared mark type.
  *
  * This function declares a new value for a Paje event type in the trace file that can be used by simulators to declare
- * application-level marks. This function is independent of which API is used in SimGrid. Calling this function is the
- * same as calling \ref TRACE_declare_mark_value_with_color with a nullptr color.
+ * application-level marks. This function is independent of which API is used in SimGrid.
  *
  * \param mark_type The name of the new type.
  * \param mark_value The name of the new value for this type.
@@ -231,20 +224,19 @@ void TRACE_declare_mark_value (const char *mark_type, const char *mark_value)
  */
 void TRACE_mark(const char *mark_type, const char *mark_value)
 {
-  /* safe switch */
-  if (!TRACE_is_enabled()) return;
-
-  /* if platform is not traced, we don't allow marks */
-  if (!TRACE_needs_platform()) return;
+  /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
+  if (!TRACE_is_enabled() || !TRACE_needs_platform())
+    return;
 
-  if (!mark_type) THROWF (tracing_error, 1, "mark_type is nullptr");
-  if (!mark_value) THROWF (tracing_error, 1, "mark_value is nullptr");
+  if (!mark_type)
+    THROWF (tracing_error, 1, "mark_type is nullptr");
+  if (!mark_value)
+    THROWF (tracing_error, 1, "mark_value is nullptr");
 
   //check if mark_type is already declared
   type_t type = PJ_type_get (mark_type, PJ_type_get_root());
-  if (!type){
+  if (!type)
     THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
-  }
 
   val_t value = PJ_value_get (mark_value, type);
   XBT_DEBUG("MARK %s %s", mark_type, mark_value);
@@ -258,9 +250,10 @@ void TRACE_mark(const char *mark_type, const char *mark_value)
  *
  * \return A dynar with the declared marks, must be freed with xbt_dynar_free.
  */
-xbt_dynar_t TRACE_get_marks (void)
+xbt_dynar_t TRACE_get_marks ()
 {
-  if (!TRACE_is_enabled()) return nullptr;
+  if (!TRACE_is_enabled())
+    return nullptr;
 
   return instr_dict_to_dynar (declared_marks);
 }
@@ -268,11 +261,9 @@ xbt_dynar_t TRACE_get_marks (void)
 static void instr_user_variable(double time, const char *resource, const char *variable, const char *father_type,
                          double value, InstrUserVariable what, const char *color, xbt_dict_t filter)
 {
-  /* safe switch */
-  if (!TRACE_is_enabled()) return;
-
-  /* if platform is not traced, we don't allow user variables */
-  if (!TRACE_needs_platform()) return;
+  /* safe switches. tracing has to be activated and if platform is not traced, we don't allow user variables */
+  if (!TRACE_is_enabled() || !TRACE_needs_platform())
+    return;
 
   //check if variable is already declared
   char *created = (char*)xbt_dict_get_or_null(filter, variable);
@@ -281,44 +272,31 @@ static void instr_user_variable(double time, const char *resource, const char *v
       return;
     }else{
       xbt_dict_set (filter, variable, xbt_strdup("1"), nullptr);
+      instr_new_user_variable_type (father_type, variable, color);
     }
   }else{
     if (!created){//not declared, ignore
       return;
-    }
-  }
-
-  char valuestr[100];
-  snprintf(valuestr, 100, "%g", value);
-
-  switch (what){
-  case INSTR_US_DECLARE:
-    instr_new_user_variable_type (father_type, variable, color);
-    break;
-  case INSTR_US_SET:
-    {
-      container_t container = PJ_container_get(resource);
-      type_t type = PJ_type_get (variable, container->type);
-      new_pajeSetVariable(time, container, type, value);
-    }
-    break;
-  case INSTR_US_ADD:
-    {
-      container_t container = PJ_container_get(resource);
-      type_t type = PJ_type_get (variable, container->type);
-      new_pajeAddVariable(time, container, type, value);
-    }
-    break;
-  case INSTR_US_SUB:
-    {
+    } else {
+      char valuestr[100];
+      snprintf(valuestr, 100, "%g", value);
       container_t container = PJ_container_get(resource);
       type_t type = PJ_type_get (variable, container->type);
-      new_pajeSubVariable(time, container, type, value);
+      switch (what){
+      case INSTR_US_SET:
+        new_pajeSetVariable(time, container, type, value);
+        break;
+      case INSTR_US_ADD:
+        new_pajeAddVariable(time, container, type, value);
+        break;
+      case INSTR_US_SUB:
+        new_pajeSubVariable(time, container, type, value);
+        break;
+      default:
+        THROW_IMPOSSIBLE;
+        break;
+      }
     }
-     break;
-  default:
-    //TODO: launch exception
-    break;
   }
 }
 
@@ -326,16 +304,17 @@ static void instr_user_srcdst_variable(double time, const char *src, const char
                               const char *father_type, double value, InstrUserVariable what)
 {
   sg_netcard_t src_elm = sg_netcard_by_name_or_null(src);
-  if(!src_elm) xbt_die("Element '%s' not found!",src);
+  if(!src_elm)
+    xbt_die("Element '%s' not found!",src);
 
   sg_netcard_t dst_elm = sg_netcard_by_name_or_null(dst);
-  if(!dst_elm) xbt_die("Element '%s' not found!",dst);
+  if(!dst_elm)
+    xbt_die("Element '%s' not found!",dst);
 
-  std::vector<Link*> *route = new std::vector<Link*>();
-  routing_platf->getRouteAndLatency (src_elm, dst_elm, route,nullptr);
-  for (auto link : *route)
+  std::vector<Link*> route;
+  simgrid::kernel::routing::NetZoneImpl::getGlobalRoute(src_elm, dst_elm, &route, nullptr);
+  for (auto link : route)
     instr_user_variable (time, link->getName(), variable, father_type, value, what, nullptr, user_link_variables);
-  delete route;
 }
 
 /** \ingroup TRACE_API
@@ -352,9 +331,11 @@ static void instr_user_srcdst_variable(double time, const char *src, const char
 int TRACE_platform_graph_export_graphviz (const char *filename)
 {
   /* returns 1 if successful, 0 otherwise */
-  if (!TRACE_is_enabled()) return 0;
+  if (!TRACE_is_enabled())
+    return 0;
   xbt_graph_t g = instr_routing_platform_graph();
-  if (g == nullptr) return 0;
+  if (g == nullptr)
+    return 0;
   instr_routing_platform_graph_export_graphviz (g, filename);
   xbt_graph_free_graph(g, xbt_free_f, xbt_free_f, nullptr);
   return 1;
@@ -507,7 +488,7 @@ void TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *v
  *
  * \return A dynar with the declared host variables, must be freed with xbt_dynar_free.
  */
-xbt_dynar_t TRACE_get_vm_variables (void)
+xbt_dynar_t TRACE_get_vm_variables ()
 {
   return instr_dict_to_dynar (user_vm_variables);
 }
@@ -654,7 +635,7 @@ void TRACE_host_variable_sub_with_time (double time, const char *host, const cha
  *
  * \return A dynar with the declared host variables, must be freed with xbt_dynar_free.
  */
-xbt_dynar_t TRACE_get_host_variables (void)
+xbt_dynar_t TRACE_get_host_variables ()
 {
   return instr_dict_to_dynar (user_host_variables);
 }
@@ -925,7 +906,7 @@ void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, con
  *
  * \return A dynar with the declared link variables, must be freed with xbt_dynar_free.
  */
-xbt_dynar_t TRACE_get_link_variables (void)
+xbt_dynar_t TRACE_get_link_variables ()
 {
   return instr_dict_to_dynar (user_link_variables);
 }
@@ -1042,7 +1023,7 @@ void TRACE_host_reset_state (const char *host, const char *state)
  *
  *  \return A dynar with the types, must be freed with xbt_dynar_free.
  */
-xbt_dynar_t TRACE_get_node_types (void)
+xbt_dynar_t TRACE_get_node_types ()
 {
   return instr_dict_to_dynar (trivaNodeTypes);
 }
@@ -1055,7 +1036,7 @@ xbt_dynar_t TRACE_get_node_types (void)
  *
  *  \return A dynar with the types, must be freed with xbt_dynar_free.
  */
-xbt_dynar_t TRACE_get_edge_types (void)
+xbt_dynar_t TRACE_get_edge_types ()
 {
   return instr_dict_to_dynar (trivaEdgeTypes);
 }
@@ -1064,7 +1045,7 @@ xbt_dynar_t TRACE_get_edge_types (void)
  *  \brief Pauses all tracing activities.
  *  \see TRACE_resume
  */
-void TRACE_pause (void)
+void TRACE_pause ()
 {
   instr_pause_tracing();
 }
@@ -1073,7 +1054,7 @@ void TRACE_pause (void)
  *  \brief Resumes all tracing activities.
  *  \see TRACE_pause
  */
-void TRACE_resume (void)
+void TRACE_resume ()
 {
   instr_resume_tracing();
 }