[trace] move categories dictionary declaration to interface file

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

diff --git a/src/instr/instr_interface.c b/src/instr/instr_interface.c
index 83ce6be..5532a6b 100644 (file)
--- a/src/instr/instr_interface.c
+++ b/src/instr/instr_interface.c
@@ -19,6 +19,7 @@ typedef enum {
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
 
+xbt_dict_t created_categories = NULL;
 /** \ingroup TRACE_category
  *  \brief Declare a new category with a random color.
  *
@@ -37,7 +38,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
  *
  *  \param category The name of the new tracing category to be created.
  *
- *  \see TRACE_category_with_color, MSG_task_set_category
+ *  \see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
  */
 void TRACE_category(const char *category)
 {
@@ -60,7 +61,7 @@ void TRACE_category(const char *category)
  *  \param color The color of the category (see \ref tracing_tracing to
  *  know how to correctly specify the color)
  *
- *  \see MSG_task_set_category
+ *  \see MSG_task_set_category, SD_task_set_category
  */
 void TRACE_category_with_color (const char *category, const char *color)
 {
@@ -95,6 +96,34 @@ void TRACE_category_with_color (const char *category, const char *color)
   instr_new_variable_type (category, final_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.
+ *
+ * See \ref tracing_tracing 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
+ */
+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;
+}
+
 /** \ingroup TRACE_mark
  * \brief Declare a new type for tracing mark.
  *
@@ -230,6 +259,17 @@ static void instr_user_srcdst_variable(double time,
   }
 }
 
+/** \ingroup TRACE_API
+ *  \brief Creates a file with the topology of the platform file used for the simulator.
+ *
+ *  The graph topology will have the following properties: all hosts, links and routers
+ *  of the platform file are mapped to graph nodes; routes are mapped to edges.
+ *  The platform's AS are not represented in the output.
+ *
+ *  \param filename The name of the file that will hold the graph.
+ *
+ *  \return 1 of successful, 0 otherwise.
+ */
 int TRACE_platform_graph_export_graphviz (const char *filename)
 {
   /* returns 1 if successful, 0 otherwise */