Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] remove function from tracing interface, should be internal
[simgrid.git] / include / instr / instr.h
index 9c15d52..2da6af8 100644 (file)
 #ifdef HAVE_TRACING
 
 #include "xbt.h"
+#include "xbt/graph.h"
 #include "msg/msg.h"
 #include "simdag/simdag.h"
 
-/* Trace error codes (used in exceptions) */
-#define TRACE_ERROR_COMPLEX_ROUTES 100
-#define TRACE_ERROR_TYPE_NOT_DEFINED 200
-#define TRACE_ERROR_TYPE_ALREADY_DEFINED 201
-#define TRACE_ERROR_CATEGORY_NOT_DEFINED 300
-#define TRACE_ERROR_CATEGORY_ALREADY_DEFINED 301
-#define TRACE_ERROR_MASK 400
-#define TRACE_ERROR_FILE_OPEN 401
-#define TRACE_ERROR_START 500
-#define TRACE_ERROR_ALREADY_ACTIVE 501
-
-XBT_PUBLIC(int) TRACE_category(const char *category);
-XBT_PUBLIC(int) TRACE_category_with_color (const char *category, const char *color);
-XBT_PUBLIC(void) TRACE_define_type(const char *type,
-                                   const char *parent_type, int final);
-XBT_PUBLIC(int) TRACE_create_category(const char *category,
-                                      const char *type,
-                                      const char *parent_category);
-XBT_PUBLIC(int) TRACE_create_category_with_color(const char *category,
-                          const char *type,
-                          const char *parent_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);
-XBT_PUBLIC(void) TRACE_set_mask(int mask);
-XBT_PUBLIC(void) TRACE_user_host_variable(double time,
-                                          const char *variable,
-                                          double value, const char *what);
-XBT_PUBLIC(void) TRACE_user_link_variable(double time, const char *src,
-                                          const char *dst,
-                                          const char *variable,
-                                          double value, const char *what);
-XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type);
-XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value);
+/*
+ * 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_smpi_set_category(const char *category);
-XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task,
-                                            const char *category);
-
-#define TRACE_host_variable_declare(var) \
-       TRACE_user_host_variable(0,var,0,"declare");
-
-#define TRACE_host_variable_set_with_time(time,var,value) \
-       TRACE_user_host_variable(time,var,value,"set");
-
-#define TRACE_host_variable_add_with_time(time,var,value) \
-       TRACE_user_host_variable(time,var,value,"add");
-
-#define TRACE_host_variable_sub_with_time(time,var,value) \
-       TRACE_user_host_variable(time,var,value,"sub");
-
-#define TRACE_host_variable_set(var,value) \
-       TRACE_user_host_variable(MSG_get_clock(),var,value,"set");
-
-#define TRACE_host_variable_add(var,value) \
-       TRACE_user_host_variable(MSG_get_clock(),var,value,"add");
-
-#define TRACE_host_variable_sub(var,value) \
-       TRACE_user_host_variable(MSG_get_clock(),var,value,"sub");
+XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task, const char *category);
 
-#define TRACE_link_variable_declare(var) \
-       TRACE_user_link_variable(0,NULL,NULL,var,0,"declare");
-
-#define TRACE_link_variable_set_with_time(time,src,dst,var,value) \
-       TRACE_user_link_variable(time,src,dst,var,value,"set");
-
-#define TRACE_link_variable_add_with_time(time,src,dst,var,value) \
-       TRACE_user_link_variable(time,src,dst,var,value,"add");
-
-#define TRACE_link_variable_sub_with_time(time,src,dst,var,value) \
-       TRACE_user_link_variable(time,src,dst,var,value,"sub");
+/*
+ * 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);
 
-#define TRACE_link_variable_set(src,dst,var,value) \
-       TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"set");
+/*
+ * Functions used by graphicator (transform a SimGrid platform
+ * file in a graphviz dot file with the network topology)
+ */
+XBT_PUBLIC(xbt_graph_t) TRACE_platform_graph (void);
+XBT_PUBLIC(void) TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
+
+/*
+ * User-variables related functions
+ */
+/* 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);
+XBT_PUBLIC(void) TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value);
+
+/* 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);
+XBT_PUBLIC(void) TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value);
+
+/* for link variables, but with src and dst used for get_route */
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value);
 
-#define TRACE_link_variable_add(src,dst,var,value) \
-       TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"add");
+#else                           /* HAVE_TRACING */
 
-#define TRACE_link_variable_sub(src,dst,var,value) \
-       TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"sub");
+#define TRACE_category(category)
+#define TRACE_category_with_color(category,color)
+#define TRACE_msg_set_task_category(task,category)
+#define TRACE_smpi_set_category(category)
+#define TRACE_sd_set_task_category(task,category)
 
-#else                           /* HAVE_TRACING */
+#define TRACE_declare_mark(mark_type)
+#define TRACE_mark(mark_type,mark_value)
 
-#define TRACE_category(cat)
-#define TRACE_category_with_color(cat,color)
-#define TRACE_define_type(cat,supercat,final)
-#define TRACE_create_category(inst,cat)
-#define TRACE_msg_set_task_category(task,cat)
-#define TRACE_msg_set_process_category(proc,cat)
-#define TRACE_set_mask(mask)
+#define TRACE_platform_graph(void)
+#define TRACE_platform_graph_export_graphviz(g,filename)
 
 #define TRACE_host_variable_declare(var)
-#define TRACE_host_variable_set_with_time(time,var,value)
-#define TRACE_host_variable_add_with_time(time,var,value)
-#define TRACE_host_variable_sub_with_time(time,var,value)
-#define TRACE_host_variable_set(var,value)
-#define TRACE_host_variable_add(var,value)
-#define TRACE_host_variable_sub(var,value)
+#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)
+#define TRACE_host_variable_set_with_time(time,host,var,value)
+#define TRACE_host_variable_add_with_time(time,host,var,value)
+#define TRACE_host_variable_sub_with_time(time,host,var,value)
+
 #define TRACE_link_variable_declare(var)
-#define TRACE_link_variable_set_with_time(time,src,dst,var,value)
-#define TRACE_link_variable_add_with_time(time,src,dst,var,value)
-#define TRACE_link_variable_sub_with_time(time,src,dst,var,value)
-#define TRACE_link_variable_set(src,dst,var,value)
-#define TRACE_link_variable_add(src,dst,var,value)
-#define TRACE_link_variable_sub(src,dst,var,value)
-#define TRACE_declare_mark(type)
-#define TRACE_mark(type,value)
-#define TRACE_smpi_set_category(cat)
-#define TRACE_sd_set_task_category(task,cat)
+#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)
+#define TRACE_link_variable_set_with_time(time,link,var,value)
+#define TRACE_link_variable_add_with_time(time,link,var,value)
+#define TRACE_link_variable_sub_with_time(time,link,var,value)
+
+#define TRACE_link_srcdst_variable_set(src,dst,var,value)
+#define TRACE_link_srcdst_variable_add(src,dst,var,value)
+#define TRACE_link_srcdst_variable_sub(src,dst,var,value)
+#define TRACE_link_srcdst_variable_set_with_time(time,src,dst,var,value)
+#define TRACE_link_srcdst_variable_add_with_time(time,src,dst,var,value)
+#define TRACE_link_srcdst_variable_sub_with_time(time,src,dst,var,value)
 
 #endif                          /* HAVE_TRACING */