[trace] add some comments, cosmetics

[simgrid.git] / include / instr / instr.h

diff --git a/include/instr/instr.h b/include/instr/instr.h
index 1c97865..3daca52 100644 (file)
--- a/include/instr/instr.h
+++ b/include/instr/instr.h
@@ -16,16 +16,25 @@
 #include "msg/msg.h"
 #include "simdag/simdag.h"
 
+/*
+ * Functions to manage tracing categories
+ */
 XBT_PUBLIC(void) TRACE_category(const char *category);
 XBT_PUBLIC(void) TRACE_category_with_color (const char *category, const char *color);
 XBT_PUBLIC(void) TRACE_msg_set_task_category(m_task_t task, const char *category);
-XBT_PUBLIC(void) TRACE_msg_set_process_category(m_process_t process, const char *category, const char *color);
 XBT_PUBLIC(void) TRACE_smpi_set_category(const char *category);
 XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task, const char *category);
 
+/*
+ * Functions to manage tracing marks (used for trace comparison experiments)
+ */
 XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type);
 XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value);
 
+/*
+ * Functions used by graphicator (transform a SimGrid platform
+ * file in a graphviz dot file with the network topology)
+ */
 XBT_PUBLIC(const char *) TRACE_node_name (xbt_node_t node);
 XBT_PUBLIC(xbt_graph_t) TRACE_platform_graph (void);
 XBT_PUBLIC(void) TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
@@ -35,6 +44,7 @@ XBT_PUBLIC(void) TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char
  */
 /* for host variables */
 XBT_PUBLIC(void) TRACE_host_variable_declare (const char *var);
+XBT_PUBLIC(void) TRACE_host_variable_declare_with_color (const char *var, const char *color);
 XBT_PUBLIC(void) TRACE_host_variable_set (const char *host, const char *variable, double value);
 XBT_PUBLIC(void) TRACE_host_variable_add (const char *host, const char *variable, double value);
 XBT_PUBLIC(void) TRACE_host_variable_sub (const char *host, const char *variable, double value);
@@ -44,6 +54,7 @@ XBT_PUBLIC(void) TRACE_host_variable_sub_with_time (double time, const char *hos
 
 /* for link variables */
 XBT_PUBLIC(void) TRACE_link_variable_declare (const char *var);
+XBT_PUBLIC(void) TRACE_link_variable_declare_with_color (const char *var, const char *color);
 XBT_PUBLIC(void) TRACE_link_variable_set (const char *link, const char *variable, double value);
 XBT_PUBLIC(void) TRACE_link_variable_add (const char *link, const char *variable, double value);
 XBT_PUBLIC(void) TRACE_link_variable_sub (const char *link, const char *variable, double value);
@@ -64,7 +75,6 @@ XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub_with_time (double time, const ch
 #define TRACE_category(category)
 #define TRACE_category_with_color(category,color)
 #define TRACE_msg_set_task_category(task,category)
-#define TRACE_msg_set_process_category(process,category,color)
 #define TRACE_smpi_set_category(category)
 #define TRACE_sd_set_task_category(task,category)
 
@@ -76,6 +86,7 @@ XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub_with_time (double time, const ch
 #define TRACE_platform_graph_export_graphviz(g,filename)
 
 #define TRACE_host_variable_declare(var)
+#define TRACE_host_variable_declare_with_color(var,color)
 #define TRACE_host_variable_set(host,var,value)
 #define TRACE_host_variable_add(host,var,value)
 #define TRACE_host_variable_sub(host,var,value)
@@ -84,6 +95,7 @@ XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub_with_time (double time, const ch
 #define TRACE_host_variable_sub_with_time(time,host,var,value)
 
 #define TRACE_link_variable_declare(var)
+#define TRACE_link_variable_declare_with_color(var,color)
 #define TRACE_link_variable_set(link,var,value)
 #define TRACE_link_variable_add(link,var,value)
 #define TRACE_link_variable_sub(link,var,value)