Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] let code compile without tracing
[simgrid.git] / include / instr / instr.h
index 7938d17..c85831c 100644 (file)
 #ifndef INSTR_H_
 #define INSTR_H_
 
-#ifdef HAVE_TRACING
+#include "simgrid_config.h"
 
-#define NO_TRACE               0
-#define TRACE_PLATFORM  1
-#define TRACE_PROCESS   2
-#define TRACE_TASK      4
-#define TRACE_VOLUME    8
+#ifdef HAVE_TRACING
 
 #include "xbt.h"
+#include "xbt/graph.h"
 #include "msg/msg.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
-
-XBT_PUBLIC(int) TRACE_start_with_mask (const char *filename, int mask);
-XBT_PUBLIC(int) TRACE_start (const char *filename);
-XBT_PUBLIC(int) TRACE_end (void);
-XBT_PUBLIC(int) TRACE_category (const char *category);
-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(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_host_variable (double time, const char *variable, double value, const char *what);
-XBT_PUBLIC(void) __TRACE_link_variable (double time, const char *src, const char *dst, const char *variable, double value, const char *what);
-
-#define TRACE_host_variable_declare(var) \
-       __TRACE_host_variable(0,var,0,"declare");
-
-#define TRACE_host_variable_set_with_time(time,var,value) \
-       __TRACE_host_variable(time,var,value,"set");
-
-#define TRACE_host_variable_add_with_time(time,var,value) \
-       __TRACE_host_variable(time,var,value,"add");
-
-#define TRACE_host_variable_sub_with_time(time,var,value) \
-       __TRACE_host_variable(time,var,value,"sub");
-
-#define TRACE_host_variable_set(var,value) \
-       __TRACE_host_variable(MSG_get_clock(),var,value,"set");
-
-#define TRACE_host_variable_add(var,value) \
-       __TRACE_host_variable(MSG_get_clock(),var,value,"add");
-
-#define TRACE_host_variable_sub(var,value) \
-       __TRACE_host_variable(MSG_get_clock(),var,value,"sub");
-
-#define TRACE_link_variable_declare(var) \
-       __TRACE_link_variable(0,NULL,NULL,var,0,"declare");
-
-#define TRACE_link_variable_set_with_time(time,src,dst,var,value) \
-       __TRACE_link_variable(time,src,dst,var,value,"set");
-
-#define TRACE_link_variable_add_with_time(time,src,dst,var,value) \
-       __TRACE_link_variable(time,src,dst,var,value,"add");
-
-#define TRACE_link_variable_sub_with_time(time,src,dst,var,value) \
-       __TRACE_link_variable(time,src,dst,var,value,"sub");
-
-#define TRACE_link_variable_set(src,dst,var,value) \
-       __TRACE_link_variable(MSG_get_clock(),src,dst,var,value,"set");
-
-#define TRACE_link_variable_add(src,dst,var,value) \
-       __TRACE_link_variable(MSG_get_clock(),src,dst,var,value,"add");
-
-#define TRACE_link_variable_sub(src,dst,var,value) \
-       __TRACE_link_variable(MSG_get_clock(),src,dst,var,value,"sub");
-
-#else /* HAVE_TRACING */
-
-#define TRACE_start(filename)
-#define TRACE_start_with_mask(filename,mask)
-#define TRACE_end()
-#define TRACE_category(cat)
-#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)
+#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(xbt_dynar_t) TRACE_get_categories (void);
+XBT_PUBLIC(void) TRACE_smpi_set_category(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);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_marks (void);
+
+/*
+ * Function used by graphicator (transform a SimGrid platform
+ * file in a graphviz dot file with the network topology)
+ */
+XBT_PUBLIC(int) TRACE_platform_graph_export_graphviz (const char *filename);
+
+/*
+ * User-variables related functions
+ */
+/* for host variables */
+XBT_PUBLIC(void) TRACE_host_variable_declare (const char *variable);
+XBT_PUBLIC(void) TRACE_host_variable_declare_with_color (const char *variable, 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);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_host_variables (void);
+
+/* 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);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_link_variables (void);
+
+#else                           /* HAVE_TRACING */
+
+#define TRACE_category(category)
+#define TRACE_category_with_color(category,color)
+#define TRACE_get_categories()
+#define TRACE_smpi_set_category(category)
+
+#define TRACE_declare_mark(mark_type)
+#define TRACE_mark(mark_type,mark_value)
+#define TRACE_get_marks()
+
+#define TRACE_platform_graph_export_graphviz(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_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_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_get_host_variables()
 
-#endif /* HAVE_TRACING */
-
-#endif /* INSTR_H_ */
+#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)
+#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)
+#define TRACE_get_host_variables()
+
+#endif                          /* HAVE_TRACING */
+
+#endif                          /* INSTR_H_ */