Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] function is no longer public
[simgrid.git] / include / instr / instr.h
1 /* Copyright (c) 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef INSTR_H_
8 #define INSTR_H_
9
10 #include "simgrid_config.h"
11
12 #ifdef HAVE_TRACING
13
14 #include "xbt.h"
15 #include "xbt/graph.h"
16 #include "msg/msg.h"
17 #include "simdag/simdag.h"
18
19 /*
20  * Functions to manage tracing categories
21  */
22 XBT_PUBLIC(void) TRACE_category(const char *category);
23 XBT_PUBLIC(void) TRACE_category_with_color (const char *category, const char *color);
24 XBT_PUBLIC(void) TRACE_smpi_set_category(const char *category);
25 XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task, const char *category);
26
27 /*
28  * Functions to manage tracing marks (used for trace comparison experiments)
29  */
30 XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type);
31 XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value);
32
33 /*
34  * Function used by graphicator (transform a SimGrid platform
35  * file in a graphviz dot file with the network topology)
36  */
37 XBT_PUBLIC(int) TRACE_platform_graph_export_graphviz (const char *filename);
38
39 /*
40  * User-variables related functions
41  */
42 /* for host variables */
43 XBT_PUBLIC(void) TRACE_host_variable_declare (const char *var);
44 XBT_PUBLIC(void) TRACE_host_variable_declare_with_color (const char *var, const char *color);
45 XBT_PUBLIC(void) TRACE_host_variable_set (const char *host, const char *variable, double value);
46 XBT_PUBLIC(void) TRACE_host_variable_add (const char *host, const char *variable, double value);
47 XBT_PUBLIC(void) TRACE_host_variable_sub (const char *host, const char *variable, double value);
48 XBT_PUBLIC(void) TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value);
49 XBT_PUBLIC(void) TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value);
50 XBT_PUBLIC(void) TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value);
51
52 /* for link variables */
53 XBT_PUBLIC(void) TRACE_link_variable_declare (const char *var);
54 XBT_PUBLIC(void) TRACE_link_variable_declare_with_color (const char *var, const char *color);
55 XBT_PUBLIC(void) TRACE_link_variable_set (const char *link, const char *variable, double value);
56 XBT_PUBLIC(void) TRACE_link_variable_add (const char *link, const char *variable, double value);
57 XBT_PUBLIC(void) TRACE_link_variable_sub (const char *link, const char *variable, double value);
58 XBT_PUBLIC(void) TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value);
59 XBT_PUBLIC(void) TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value);
60 XBT_PUBLIC(void) TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value);
61
62 /* for link variables, but with src and dst used for get_route */
63 XBT_PUBLIC(void) TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value);
64 XBT_PUBLIC(void) TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value);
65 XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value);
66 XBT_PUBLIC(void) TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value);
67 XBT_PUBLIC(void) TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value);
68 XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value);
69
70 #else                           /* HAVE_TRACING */
71
72 #define TRACE_category(category)
73 #define TRACE_category_with_color(category,color)
74 #define TRACE_msg_set_task_category(task,category)
75 #define TRACE_smpi_set_category(category)
76 #define TRACE_sd_set_task_category(task,category)
77
78 #define TRACE_declare_mark(mark_type)
79 #define TRACE_mark(mark_type,mark_value)
80
81 #define TRACE_platform_graph_export_graphviz(filename)
82
83 #define TRACE_host_variable_declare(var)
84 #define TRACE_host_variable_declare_with_color(var,color)
85 #define TRACE_host_variable_set(host,var,value)
86 #define TRACE_host_variable_add(host,var,value)
87 #define TRACE_host_variable_sub(host,var,value)
88 #define TRACE_host_variable_set_with_time(time,host,var,value)
89 #define TRACE_host_variable_add_with_time(time,host,var,value)
90 #define TRACE_host_variable_sub_with_time(time,host,var,value)
91
92 #define TRACE_link_variable_declare(var)
93 #define TRACE_link_variable_declare_with_color(var,color)
94 #define TRACE_link_variable_set(link,var,value)
95 #define TRACE_link_variable_add(link,var,value)
96 #define TRACE_link_variable_sub(link,var,value)
97 #define TRACE_link_variable_set_with_time(time,link,var,value)
98 #define TRACE_link_variable_add_with_time(time,link,var,value)
99 #define TRACE_link_variable_sub_with_time(time,link,var,value)
100
101 #define TRACE_link_srcdst_variable_set(src,dst,var,value)
102 #define TRACE_link_srcdst_variable_add(src,dst,var,value)
103 #define TRACE_link_srcdst_variable_sub(src,dst,var,value)
104 #define TRACE_link_srcdst_variable_set_with_time(time,src,dst,var,value)
105 #define TRACE_link_srcdst_variable_add_with_time(time,src,dst,var,value)
106 #define TRACE_link_srcdst_variable_sub_with_time(time,src,dst,var,value)
107
108 #endif                          /* HAVE_TRACING */
109
110 #endif                          /* INSTR_H_ */