1 /* Copyright (c) 2010-2022. 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/msg.h>
17 XBT_PUBLIC void declare_host_variable(const std::string& variable, const std::string& color = std::string(""));
18 XBT_PUBLIC void set_host_variable(const s4u::Host* host, const std::string& variable, double value,
19 double time = simgrid_get_clock());
20 XBT_PUBLIC void add_host_variable(const s4u::Host* host, const std::string& variable, double value,
21 double time = simgrid_get_clock());
22 XBT_PUBLIC void sub_host_variable(const s4u::Host* host, const std::string& variable, double value,
23 double time = simgrid_get_clock());
24 XBT_PUBLIC const std::set<std::string, std::less<>>& get_host_variables();
26 XBT_PUBLIC void declare_link_variable(const std::string& variable, const std::string& color = std::string(""));
27 XBT_PUBLIC void set_link_variable(const s4u::Link* link, const std::string& variable, double value,
28 double time = simgrid_get_clock());
29 XBT_PUBLIC void set_link_variable(const s4u::Host* src, const s4u::Host* dst, const std::string& variable, double value,
30 double time = simgrid_get_clock());
31 XBT_PUBLIC void add_link_variable(const s4u::Link* link, const std::string& variable, double value,
32 double time = simgrid_get_clock());
33 XBT_PUBLIC void add_link_variable(const s4u::Host* src, const s4u::Host* dst, const std::string& variable, double value,
34 double time = simgrid_get_clock());
35 XBT_PUBLIC void sub_link_variable(const s4u::Link* link, const std::string& variable, double value,
36 double time = simgrid_get_clock());
37 XBT_PUBLIC void sub_link_variable(const s4u::Host* src, const s4u::Host* dst, const std::string& variable, double value,
38 double time = simgrid_get_clock());
39 XBT_PUBLIC const std::set<std::string, std::less<>>& get_link_variables();
41 XBT_PUBLIC void declare_vm_variable(const std::string& variable, const std::string& color = std::string(""));
42 XBT_PUBLIC void set_vm_variable(const s4u::VirtualMachine* vm, const std::string& variable, double value,
43 double time = simgrid_get_clock());
44 XBT_PUBLIC void add_vm_variable(const s4u::VirtualMachine* vm, const std::string& variable, double value,
45 double time = simgrid_get_clock());
46 XBT_PUBLIC void sub_vm_variable(const s4u::VirtualMachine* vm, const std::string& variable, double value,
47 double time = simgrid_get_clock());
48 XBT_PUBLIC const std::set<std::string, std::less<>>& get_vm_variables();
50 /* Functions to manage tracing marks (used for trace comparison experiments) */
51 XBT_PUBLIC void declare_mark(const std::string& mark_type);
52 XBT_PUBLIC void declare_mark_value(const std::string& mark_type, const std::string& mark_value,
53 const std::string& mark_color = std::string("1 1 1"));
54 XBT_PUBLIC void mark(const std::string& mark_type, const std::string& mark_value);
55 XBT_PUBLIC const std::set<std::string, std::less<>>& get_marks();
57 XBT_PUBLIC void declare_tracing_category(const std::string& name, const std::string& color = "");
58 XBT_PUBLIC const std::set<std::string, std::less<>>& get_tracing_categories();
60 /* Function used by graphicator (transform a SimGrid platform file in a graphviz dot file with the network topology) */
61 XBT_PUBLIC void platform_graph_export_graphviz(const std::string& output_filename);
63 } // namespace simgrid
68 /* Functions to manage tracing categories */
69 XBT_PUBLIC void TRACE_smpi_set_category(const char* category);
71 /* User-variables related functions*/
72 /* for VM variables */
73 XBT_PUBLIC void TRACE_vm_variable_set(const char* vm, const char* variable, double value);
74 /* for host variables */
75 XBT_PUBLIC void TRACE_host_variable_set(const char* host, const char* variable, double value);
76 XBT_PUBLIC void TRACE_host_variable_add(const char* host, const char* variable, double value);
77 XBT_PUBLIC void TRACE_host_variable_sub(const char* host, const char* variable, double value);
78 /* for link variables */
79 XBT_PUBLIC void TRACE_link_variable_set(const char* link, const char* variable, double value);
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);
83 XBT_PUBLIC void TRACE_host_state_declare(const char* state);
84 XBT_PUBLIC void TRACE_host_state_declare_value(const char* state, const char* value, const char* color);
85 XBT_PUBLIC void TRACE_host_set_state(const char* host, const char* state, const char* value);
86 XBT_PUBLIC void TRACE_host_push_state(const char* host, const char* state, const char* value);
87 XBT_PUBLIC void TRACE_host_pop_state(const char* host, const char* state);
89 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::platform_graph_export_graphviz") XBT_PUBLIC
90 int TRACE_platform_graph_export_graphviz(const char* filename);
91 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_tracing_category") XBT_PUBLIC
92 void TRACE_category(const char* category);
93 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_tracing_category") XBT_PUBLIC
94 void TRACE_category_with_color(const char* category, const char* color);
95 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::get_tracing_categories") XBT_PUBLIC xbt_dynar_t
96 TRACE_get_categories();
97 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_mark") XBT_PUBLIC
98 void TRACE_declare_mark(const char* mark_type);
99 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_mark_value") XBT_PUBLIC
100 void TRACE_declare_mark_value_with_color(const char* mark_type, const char* mark_value, const char* mark_color);
101 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_mark_value") XBT_PUBLIC
102 void TRACE_declare_mark_value(const char* mark_type, const char* mark_value);
103 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::mark") XBT_PUBLIC
104 void TRACE_mark(const char* mark_type, const char* mark_value);
105 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::get_marks") XBT_PUBLIC xbt_dynar_t TRACE_get_marks();
106 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_vm_variable") XBT_PUBLIC
107 void TRACE_vm_variable_declare(const char* variable);
108 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_vm_variable") XBT_PUBLIC
109 void TRACE_vm_variable_declare_with_color(const char* variable, const char* color);
110 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::add_vm_variable") XBT_PUBLIC
111 void TRACE_vm_variable_add(const char* vm, const char* variable, double value);
112 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::sub_vm_variable") XBT_PUBLIC
113 void TRACE_vm_variable_sub(const char* vm, const char* variable, double value);
114 XBT_ATTRIB_DEPRECATED_v333("Please use TRACE_vm_variable_set") XBT_PUBLIC
115 void TRACE_vm_variable_set_with_time(double time, const char* vm, const char* variable, double value);
116 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::add_vm_variable") XBT_PUBLIC
117 void TRACE_vm_variable_add_with_time(double time, const char* vm, const char* variable, double value);
118 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::sub_vm_variable") XBT_PUBLIC
119 void TRACE_vm_variable_sub_with_time(double time, const char* vm, const char* variable, double value);
120 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_host_variable") XBT_PUBLIC
121 void TRACE_host_variable_declare(const char* variable);
122 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_host_variable") XBT_PUBLIC
123 void TRACE_host_variable_declare_with_color(const char* variable, const char* color);
124 XBT_ATTRIB_DEPRECATED_v333("Please use TRACE_host_variable_set") XBT_PUBLIC
125 void TRACE_host_variable_set_with_time(double time, const char* host, const char* variable, double value);
126 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::add_host_variable") XBT_PUBLIC
127 void TRACE_host_variable_add_with_time(double time, const char* host, const char* variable, double value);
128 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::sub_host_variable") XBT_PUBLIC
129 void TRACE_host_variable_sub_with_time(double time, const char* host, const char* variable, double value);
130 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::get_host_variables") XBT_PUBLIC xbt_dynar_t
131 TRACE_get_host_variables();
132 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_link_variable") XBT_PUBLIC
133 void TRACE_link_variable_declare(const char* var);
134 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::declare_link_variable") XBT_PUBLIC
135 void TRACE_link_variable_declare_with_color(const char* var, const char* color);
136 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
137 void TRACE_link_variable_add(const char* link, const char* variable, double value);
138 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::sub_link_variable") XBT_PUBLIC
139 void TRACE_link_variable_sub(const char* link, const char* variable, double value);
140 XBT_ATTRIB_DEPRECATED_v333("Please use TRACE_link_variable_set") XBT_PUBLIC
141 void TRACE_link_variable_set_with_time(double time, const char* link, const char* variable, double value);
142 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
143 void TRACE_link_variable_add_with_time(double time, const char* link, const char* variable, double value);
144 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::sub_link_variable") XBT_PUBLIC
145 void TRACE_link_variable_sub_with_time(double time, const char* link, const char* variable, double value);
147 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
148 void TRACE_link_srcdst_variable_add(const char* src, const char* dst, const char* variable, double value);
149 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr:sub_link_variable") XBT_PUBLIC
150 void TRACE_link_srcdst_variable_sub(const char* src, const char* dst, const char* variable, double value);
151 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
152 void TRACE_link_srcdst_variable_set_with_time(double time, const char* src, const char* dst, const char* variable,
154 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
155 void TRACE_link_srcdst_variable_add_with_time(double time, const char* src, const char* dst, const char* variable,
157 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr:sub_link_variable") XBT_PUBLIC
158 void TRACE_link_srcdst_variable_sub_with_time(double time, const char* src, const char* dst, const char* variable,
160 XBT_ATTRIB_DEPRECATED_v333("Please use simgrid::instr::get_link_variables") XBT_PUBLIC xbt_dynar_t
161 TRACE_get_link_variables();
165 #endif /* INSTR_H_ */