Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add tesh files to test all new collectives
[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(xbt_dynar_t) TRACE_get_categories (void);
25 XBT_PUBLIC(void) TRACE_smpi_set_category(const char *category);
26 XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task,
27     const char *category);
28
29 /*
30  * Functions to manage tracing marks (used for trace comparison experiments)
31  */
32 XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type);
33 XBT_PUBLIC(void) TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color);
34 XBT_PUBLIC(void) TRACE_declare_mark_value (const char *mark_type, const char *mark_value);
35 XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value);
36 XBT_PUBLIC(xbt_dynar_t) TRACE_get_marks (void);
37
38 /*
39  * Function used by graphicator (transform a SimGrid platform
40  * file in a graphviz dot file with the network topology)
41  */
42 XBT_PUBLIC(int) TRACE_platform_graph_export_graphviz (const char *filename);
43
44 /*
45  * User-variables related functions
46  */
47 /* for VM variables */
48 XBT_PUBLIC(void) TRACE_vm_variable_declare (const char *variable);
49 XBT_PUBLIC(void) TRACE_vm_variable_declare_with_color (const char *variable, const char *color);
50 XBT_PUBLIC(void) TRACE_vm_variable_set (const char *vm, const char *variable, double value);
51 XBT_PUBLIC(void) TRACE_vm_variable_add (const char *vm, const char *variable, double value);
52 XBT_PUBLIC(void) TRACE_vm_variable_sub (const char *vm, const char *variable, double value);
53 XBT_PUBLIC(void) TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value);
54 XBT_PUBLIC(void) TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value);
55 XBT_PUBLIC(void) TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value);
56 XBT_PUBLIC(xbt_dynar_t) TRACE_get_vm_variables (void);
57
58
59 /* for host variables */
60 XBT_PUBLIC(void) TRACE_host_variable_declare (const char *variable);
61 XBT_PUBLIC(void) TRACE_host_variable_declare_with_color (const char *variable, const char *color);
62 XBT_PUBLIC(void) TRACE_host_variable_set (const char *host, const char *variable, double value);
63 XBT_PUBLIC(void) TRACE_host_variable_add (const char *host, const char *variable, double value);
64 XBT_PUBLIC(void) TRACE_host_variable_sub (const char *host, const char *variable, double value);
65 XBT_PUBLIC(void) TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value);
66 XBT_PUBLIC(void) TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value);
67 XBT_PUBLIC(void) TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value);
68 XBT_PUBLIC(xbt_dynar_t) TRACE_get_host_variables (void);
69
70 /* for link variables */
71 XBT_PUBLIC(void) TRACE_link_variable_declare (const char *var);
72 XBT_PUBLIC(void) TRACE_link_variable_declare_with_color (const char *var, const char *color);
73 XBT_PUBLIC(void) TRACE_link_variable_set (const char *link, const char *variable, double value);
74 XBT_PUBLIC(void) TRACE_link_variable_add (const char *link, const char *variable, double value);
75 XBT_PUBLIC(void) TRACE_link_variable_sub (const char *link, const char *variable, double value);
76 XBT_PUBLIC(void) TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value);
77 XBT_PUBLIC(void) TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value);
78 XBT_PUBLIC(void) TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value);
79
80 /* for link variables, but with src and dst used for get_route */
81 XBT_PUBLIC(void) TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value);
82 XBT_PUBLIC(void) TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value);
83 XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value);
84 XBT_PUBLIC(void) TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value);
85 XBT_PUBLIC(void) TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value);
86 XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value);
87 XBT_PUBLIC(xbt_dynar_t) TRACE_get_link_variables (void);
88 XBT_PUBLIC(void) TRACE_host_state_declare (const char *state);
89 XBT_PUBLIC(void) TRACE_host_state_declare_value (const char *state, const char *value, const char *color);
90 XBT_PUBLIC(void) TRACE_host_set_state (const char *host, const char *state, const char *value);
91 XBT_PUBLIC(void) TRACE_host_push_state (const char *host, const char *state, const char *value);
92 XBT_PUBLIC(void) TRACE_host_pop_state (const char *host, const char *state);
93 XBT_PUBLIC(void) TRACE_host_reset_state (const char *host, const char *state);
94
95 /* for creating graph configuration files for Viva by hand */
96 XBT_PUBLIC(xbt_dynar_t) TRACE_get_node_types (void);
97 XBT_PUBLIC(xbt_dynar_t) TRACE_get_edge_types (void);
98 XBT_PUBLIC(void) TRACE_pause (void);
99 XBT_PUBLIC(void) TRACE_resume (void);
100
101
102 #else                           /* HAVE_TRACING */
103
104 #define TRACE_category(category)
105 #define TRACE_category_with_color(category,color)
106 #define TRACE_get_categories()
107 #define TRACE_smpi_set_category(category)
108
109 #define TRACE_declare_mark(mark_type)
110 #define TRACE_mark(mark_type,mark_value)
111 #define TRACE_get_marks()
112
113 #define TRACE_platform_graph_export_graphviz(filename)
114
115 #define TRACE_vm_variable_declare(var)
116 #define TRACE_vm_variable_declare_with_color(var,color)
117 #define TRACE_vm_variable_set(vm,var,value)
118 #define TRACE_vm_variable_add(vm,var,value)
119 #define TRACE_vm_variable_sub(vm,var,value)
120 #define TRACE_vm_variable_set_with_time(time,vm,var,value)
121 #define TRACE_vm_variable_add_with_time(time,vm,var,value)
122 #define TRACE_vm_variable_sub_with_time(time,vm,var,value)
123 #define TRACE_get_vm_variables()
124
125 #define TRACE_host_variable_declare(var)
126 #define TRACE_host_variable_declare_with_color(var,color)
127 #define TRACE_host_variable_set(host,var,value)
128 #define TRACE_host_variable_add(host,var,value)
129 #define TRACE_host_variable_sub(host,var,value)
130 #define TRACE_host_variable_set_with_time(time,host,var,value)
131 #define TRACE_host_variable_add_with_time(time,host,var,value)
132 #define TRACE_host_variable_sub_with_time(time,host,var,value)
133 #define TRACE_get_host_variables()
134
135 #define TRACE_link_variable_declare(var)
136 #define TRACE_link_variable_declare_with_color(var,color)
137 #define TRACE_link_variable_set(link,var,value)
138 #define TRACE_link_variable_add(link,var,value)
139 #define TRACE_link_variable_sub(link,var,value)
140 #define TRACE_link_variable_set_with_time(time,link,var,value)
141 #define TRACE_link_variable_add_with_time(time,link,var,value)
142 #define TRACE_link_variable_sub_with_time(time,link,var,value)
143
144 #define TRACE_link_srcdst_variable_set(src,dst,var,value)
145 #define TRACE_link_srcdst_variable_add(src,dst,var,value)
146 #define TRACE_link_srcdst_variable_sub(src,dst,var,value)
147 #define TRACE_link_srcdst_variable_set_with_time(time,src,dst,var,value)
148 #define TRACE_link_srcdst_variable_add_with_time(time,src,dst,var,value)
149 #define TRACE_link_srcdst_variable_sub_with_time(time,src,dst,var,value)
150 #define TRACE_get_host_variables()
151
152 #define TRACE_get_node_types()
153 #define TRACE_get_edge_types()
154
155 #endif                          /* HAVE_TRACING */
156
157 #endif                          /* INSTR_H_ */