1 /* Copyright (c) 2010-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include <simgrid/engine.h>
10 #include <xbt/dynar.h> // XBT_ATTRIB_DEPRECATED_v334
16 namespace simgrid::instr {
17 /* User-variables related functions*/
18 /* for host variables */
19 XBT_PUBLIC void declare_host_variable(const std::string& variable, const std::string& color = "");
20 XBT_PUBLIC void set_host_variable(const std::string& host, const std::string& variable, double value,
21 double time = simgrid_get_clock());
22 XBT_PUBLIC void add_host_variable(const std::string& host, const std::string& variable, double value,
23 double time = simgrid_get_clock());
24 XBT_PUBLIC void sub_host_variable(const std::string& host, const std::string& variable, double value,
25 double time = simgrid_get_clock());
26 XBT_PUBLIC const std::set<std::string, std::less<>>& get_host_variables();
28 /* for link variables */
29 XBT_PUBLIC void declare_link_variable(const std::string& variable, const std::string& color = "");
30 XBT_PUBLIC void set_link_variable(const std::string& link, const std::string& variable, double value,
31 double time = simgrid_get_clock());
32 XBT_PUBLIC void add_link_variable(const std::string& link, const std::string& variable, double value,
33 double time = simgrid_get_clock());
34 XBT_PUBLIC void sub_link_variable(const std::string& link, const std::string& variable, double value,
35 double time = simgrid_get_clock());
36 /* for link variables, but with src and dst used for get_route */
37 XBT_PUBLIC void set_link_variable(const std::string& src, const std::string& dst, const std::string& variable,
38 double value, double time = simgrid_get_clock());
39 XBT_PUBLIC void add_link_variable(const std::string& src, const std::string& dst, const std::string& variable,
40 double value, double time = simgrid_get_clock());
41 XBT_PUBLIC void sub_link_variable(const std::string& src, const std::string& dst, const std::string& variable,
42 double value, double time = simgrid_get_clock());
43 XBT_PUBLIC const std::set<std::string, std::less<>>& get_link_variables();
45 /* for VM variables */
46 XBT_PUBLIC void declare_vm_variable(const std::string& variable, const std::string& color = "");
47 XBT_PUBLIC void set_vm_variable(const std::string& vm, const std::string& variable, double value,
48 double time = simgrid_get_clock());
49 XBT_PUBLIC void add_vm_variable(const std::string& vm, const std::string& variable, double value,
50 double time = simgrid_get_clock());
51 XBT_PUBLIC void sub_vm_variable(const std::string& vm, const std::string& variable, double value,
52 double time = simgrid_get_clock());
53 XBT_PUBLIC const std::set<std::string, std::less<>>& get_vm_variables();
55 /* Functions to manage tracing marks (used for trace comparison experiments) */
56 XBT_PUBLIC void declare_mark(const std::string& mark_type);
57 XBT_PUBLIC void declare_mark_value(const std::string& mark_type, const std::string& mark_value,
58 const std::string& mark_color = "1 1 1");
59 XBT_PUBLIC void mark(const std::string& mark_type, const std::string& mark_value);
60 XBT_PUBLIC const std::set<std::string, std::less<>>& get_marks();
62 XBT_PUBLIC void declare_tracing_category(const std::string& name, const std::string& color = "");
63 XBT_PUBLIC const std::set<std::string, std::less<>>& get_tracing_categories();
65 /* Function used by graphicator (transform a SimGrid platform file in a graphviz dot file with the network topology) */
66 XBT_PUBLIC void platform_graph_export_graphviz(const std::string& output_filename);
67 /* Function used by graphicator (transform a SimGrid platform file in a CSV file with the network topology) */
68 XBT_PUBLIC void platform_graph_export_csv(const std::string& output_filename);
69 } // namespace simgrid::instr
74 /* Functions to manage tracing categories */
75 XBT_PUBLIC void TRACE_smpi_set_category(const char* category);
77 XBT_PUBLIC void TRACE_host_state_declare(const char* state);
78 XBT_PUBLIC void TRACE_host_state_declare_value(const char* state, const char* value, const char* color);
79 XBT_PUBLIC void TRACE_host_set_state(const char* host, const char* state, const char* value);
80 XBT_PUBLIC void TRACE_host_push_state(const char* host, const char* state, const char* value);
81 XBT_PUBLIC void TRACE_host_pop_state(const char* host, const char* state);
83 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::platform_graph_export_graphviz") XBT_PUBLIC
84 int TRACE_platform_graph_export_graphviz(const char* filename);
85 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_tracing_category") XBT_PUBLIC
86 void TRACE_category(const char* category);
87 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_tracing_category") XBT_PUBLIC
88 void TRACE_category_with_color(const char* category, const char* color);
89 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_tracing_categories") XBT_PUBLIC xbt_dynar_t
90 TRACE_get_categories();
91 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark") XBT_PUBLIC
92 void TRACE_declare_mark(const char* mark_type);
93 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark_value") XBT_PUBLIC
94 void TRACE_declare_mark_value_with_color(const char* mark_type, const char* mark_value, const char* mark_color);
95 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark_value") XBT_PUBLIC
96 void TRACE_declare_mark_value(const char* mark_type, const char* mark_value);
97 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::mark") XBT_PUBLIC
98 void TRACE_mark(const char* mark_type, const char* mark_value);
99 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_marks") XBT_PUBLIC xbt_dynar_t TRACE_get_marks();
100 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_vm_variable") XBT_PUBLIC
101 void TRACE_vm_variable_declare(const char* variable);
102 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_vm_variable") XBT_PUBLIC
103 void TRACE_vm_variable_declare_with_color(const char* variable, const char* color);
104 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_vm_variable") XBT_PUBLIC
105 void TRACE_vm_variable_set(const char* vm, const char* variable, double value);
106 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_vm_variable") XBT_PUBLIC
107 void TRACE_vm_variable_add(const char* vm, const char* variable, double value);
108 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_vm_variable") XBT_PUBLIC
109 void TRACE_vm_variable_sub(const char* vm, const char* variable, double value);
110 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_vm_variable") XBT_PUBLIC
111 void TRACE_vm_variable_set_with_time(double time, const char* vm, const char* variable, double value);
112 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_vm_variable") XBT_PUBLIC
113 void TRACE_vm_variable_add_with_time(double time, const char* vm, const char* variable, double value);
114 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_vm_variable") XBT_PUBLIC
115 void TRACE_vm_variable_sub_with_time(double time, const char* vm, const char* variable, double value);
116 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_host_variable") XBT_PUBLIC
117 void TRACE_host_variable_declare(const char* variable);
118 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_host_variable") XBT_PUBLIC
119 void TRACE_host_variable_declare_with_color(const char* variable, const char* color);
120 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_host_variable") XBT_PUBLIC
121 void TRACE_host_variable_set(const char* host, const char* variable, double value);
122 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_host_variable") XBT_PUBLIC
123 void TRACE_host_variable_add(const char* host, const char* variable, double value);
124 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_host_variable") XBT_PUBLIC
125 void TRACE_host_variable_sub(const char* host, const char* variable, double value);
126 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_host_variable") XBT_PUBLIC
127 void TRACE_host_variable_set_with_time(double time, const char* host, const char* variable, double value);
128 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_host_variable") XBT_PUBLIC
129 void TRACE_host_variable_add_with_time(double time, const char* host, const char* variable, double value);
130 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_host_variable") XBT_PUBLIC
131 void TRACE_host_variable_sub_with_time(double time, const char* host, const char* variable, double value);
132 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_host_variables") XBT_PUBLIC xbt_dynar_t
133 TRACE_get_host_variables();
134 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_link_variable") XBT_PUBLIC
135 void TRACE_link_variable_declare(const char* var);
136 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_link_variable") XBT_PUBLIC
137 void TRACE_link_variable_declare_with_color(const char* var, const char* color);
138 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
139 void TRACE_link_variable_set(const char* link, const char* variable, double value);
140 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
141 void TRACE_link_variable_add(const char* link, const char* variable, double value);
142 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_link_variable") XBT_PUBLIC
143 void TRACE_link_variable_sub(const char* link, const char* variable, double value);
144 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
145 void TRACE_link_variable_set_with_time(double time, const char* link, const char* variable, double value);
146 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
147 void TRACE_link_variable_add_with_time(double time, const char* link, const char* variable, double value);
148 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_link_variable") XBT_PUBLIC
149 void TRACE_link_variable_sub_with_time(double time, const char* link, const char* variable, double value);
151 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
152 void TRACE_link_srcdst_variable_set(const char* src, const char* dst, const char* variable, double value);
153 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
154 void TRACE_link_srcdst_variable_add(const char* src, const char* dst, const char* variable, double value);
155 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr:sub_link_variable") XBT_PUBLIC
156 void TRACE_link_srcdst_variable_sub(const char* src, const char* dst, const char* variable, double value);
157 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
158 void TRACE_link_srcdst_variable_set_with_time(double time, const char* src, const char* dst, const char* variable,
160 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
161 void TRACE_link_srcdst_variable_add_with_time(double time, const char* src, const char* dst, const char* variable,
163 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr:sub_link_variable") XBT_PUBLIC
164 void TRACE_link_srcdst_variable_sub_with_time(double time, const char* src, const char* dst, const char* variable,
166 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_link_variables") XBT_PUBLIC xbt_dynar_t
167 TRACE_get_link_variables();
171 #endif /* INSTR_H_ */