[trace] fix comment

[simgrid.git] / src / instr / instr_interface.c

diff --git a/src/instr/instr_interface.c b/src/instr/instr_interface.c
index 8c76011..5b21402 100644 (file)
--- a/src/instr/instr_interface.c
+++ b/src/instr/instr_interface.c
@@ -24,6 +24,20 @@ xbt_dict_t declared_marks = NULL;
 xbt_dict_t user_host_variables = NULL;
 xbt_dict_t user_link_variables = NULL;
 
+static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter)
+{
+  if (!TRACE_is_enabled()) return NULL;
+  if (!TRACE_needs_platform()) return NULL;
+
+  xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
+  xbt_dict_cursor_t cursor = NULL;
+  char *name, *value;
+  xbt_dict_foreach(filter, cursor, name, value) {
+    xbt_dynar_push_as (ret, char*, xbt_strdup(name));
+  }
+  return ret;
+}
+
 /** \ingroup TRACE_category
  *  \brief Declare a new category with a random color.
  *
@@ -119,13 +133,7 @@ xbt_dynar_t TRACE_get_categories (void)
   if (!TRACE_is_enabled()) return NULL;
   if (!TRACE_categorized()) return NULL;
 
-  xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
-  xbt_dict_cursor_t cursor = NULL;
-  char *name, *value;
-  xbt_dict_foreach(created_categories, cursor, name, value) {
-    xbt_dynar_push_as (ret, char*, xbt_strdup(name));
-  }
-  return ret;
+  return instr_dict_to_dynar (created_categories);
 }
 
 /** \ingroup TRACE_mark
@@ -211,13 +219,7 @@ xbt_dynar_t TRACE_get_marks (void)
 {
   if (!TRACE_is_enabled()) return NULL;
 
-  xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
-  xbt_dict_cursor_t cursor = NULL;
-  char *name, *value;
-  xbt_dict_foreach(declared_marks, cursor, name, value) {
-    xbt_dynar_push_as (ret, char*, xbt_strdup(name));
-  }
-  return ret;
+  return instr_dict_to_dynar (declared_marks);
 }
 
 static void instr_user_variable(double time,
@@ -483,6 +485,19 @@ void TRACE_host_variable_sub_with_time (double time, const char *host, const cha
   instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SUB, NULL, user_host_variables);
 }
 
+/** \ingroup TRACE_user_variables
+ *  \brief Get declared user host variables
+ *
+ * This function should be used to get host variables that were already
+ * declared with #TRACE_host_variable_declare or with #TRACE_host_variable_declare_with_color.
+ *
+ * \return A dynar with the declared host variables, must be freed with xbt_dynar_free.
+ */
+xbt_dynar_t TRACE_get_host_variables (void)
+{
+  return instr_dict_to_dynar (user_host_variables);
+}
+
 /* for link variables */
 /** \ingroup TRACE_user_variables
  *  \brief Declare a new user variable associated to links.
@@ -759,4 +774,17 @@ void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, con
   instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SUB);
 }
 
+/** \ingroup TRACE_user_variables
+ *  \brief Get declared user link variables
+ *
+ * This function should be used to get link variables that were already
+ * declared with #TRACE_link_variable_declare or with #TRACE_link_variable_declare_with_color.
+ *
+ * \return A dynar with the declared link variables, must be freed with xbt_dynar_free.
+ */
+xbt_dynar_t TRACE_get_link_variables (void)
+{
+  return instr_dict_to_dynar (user_link_variables);
+}
+
 #endif /* HAVE_TRACING */