1 /* Copyright (c) 2010-2020. 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. */
6 #include "simgrid/Exception.hpp"
7 #include "simgrid/kernel/routing/NetPoint.hpp"
8 #include "src/instr/instr_private.hpp"
9 #include "src/surf/network_interface.hpp"
10 #include "src/surf/surf_private.hpp"
11 #include "surf/surf.hpp"
16 enum class InstrUserVariable { DECLARE, SET, ADD, SUB };
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
20 std::set<std::string> created_categories;
21 std::set<std::string> declared_marks;
22 std::set<std::string> user_host_variables;
23 std::set<std::string> user_vm_variables;
24 std::set<std::string> user_link_variables;
25 extern std::set<std::string> trivaNodeTypes;
26 extern std::set<std::string> trivaEdgeTypes;
28 static xbt_dynar_t instr_set_to_dynar(const std::set<std::string>& filter)
30 if (not TRACE_is_enabled() || not TRACE_needs_platform())
33 xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
34 for (auto const& name : filter)
35 xbt_dynar_push_as(ret, char*, xbt_strdup(name.c_str()));
40 /** @ingroup TRACE_category
41 * @brief Declare a new category with a random color.
43 * This function should be used to define a user category. The category can be used to differentiate the tasks that
44 * are created during the simulation (for example, tasks from server1, server2, or request tasks, computation tasks,
45 * communication tasks). All resource utilization (host power and link bandwidth) will be classified according to the
46 * task category. Tasks that do not belong to a category are not traced. The color for the category that is being
47 * declared is random. This function has no effect if a category with the same name has been already declared.
49 * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
51 * @param category The name of the new tracing category to be created.
53 * @see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
55 void TRACE_category(const char *category)
57 TRACE_category_with_color (category, nullptr);
60 /** @ingroup TRACE_category
61 * @brief Declare a new category with a color.
63 * Same as #TRACE_category, but let user specify a color encoded as a RGB-like string with three floats from 0 to 1.
64 * So, to specify a red color, pass "1 0 0" as color parameter. A light-gray color can be specified using "0.7 0.7 0.7"
65 * as color. This function has no effect if a category with the same name has been already declared.
67 * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
69 * @param category The name of the new tracing category to be created.
70 * @param color The color of the category (see @ref outcomes_vizu to
71 * know how to correctly specify the color)
73 * @see MSG_task_set_category, SD_task_set_category
75 void TRACE_category_with_color (const char *category, const char *color)
77 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with categories */
78 if (not TRACE_is_enabled() || not TRACE_needs_platform())
81 if (not(TRACE_categorized() && category != nullptr))
84 //check if category is already created
85 if (created_categories.find(category) != created_categories.end())
88 created_categories.insert(category);
91 std::string final_color;
93 //generate a random color
94 static std::default_random_engine rnd_engine;
95 std::uniform_real_distribution<double> prng(0.0, std::nextafter(1.0, 2.0));
96 double red = prng(rnd_engine);
97 double green = prng(rnd_engine);
98 double blue = prng(rnd_engine);
99 final_color = std::to_string(red) + " " + std::to_string(green) + " " + std::to_string(blue);
101 final_color = std::string(color);
104 XBT_DEBUG("CAT,declare %s, \"%s\" \"%s\"", category, color, final_color.c_str());
106 //define the type of this category on top of hosts and links
107 instr_new_variable_type (category, final_color);
110 /** @ingroup TRACE_category
111 * @brief Get declared categories
113 * This function should be used to get categories that were already declared with #TRACE_category or with
114 * #TRACE_category_with_color.
116 * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
118 * @return A dynar with the declared categories, must be freed with xbt_dynar_free.
120 * @see MSG_task_set_category, SD_task_set_category
122 xbt_dynar_t TRACE_get_categories ()
124 if (not TRACE_is_enabled() || not TRACE_categorized())
126 return instr_set_to_dynar(created_categories);
129 /** @ingroup TRACE_mark
130 * @brief Declare a new type for tracing mark.
132 * This function declares a new Paje event type in the trace file that can be used by simulators to declare
133 * application-level marks. This function is independent of which API is used in SimGrid.
135 * @param mark_type The name of the new type.
139 void TRACE_declare_mark(const char *mark_type)
141 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
142 if (not TRACE_is_enabled() || not TRACE_needs_platform())
145 xbt_assert(mark_type, "mark_type is nullptr");
147 //check if mark_type is already declared
148 if (declared_marks.find(mark_type) != declared_marks.end()) {
149 throw simgrid::TracingError(XBT_THROW_POINT,
150 simgrid::xbt::string_printf("mark_type with name (%s) is already declared", mark_type));
153 XBT_DEBUG("MARK,declare %s", mark_type);
154 simgrid::instr::Container::get_root()->type_->by_name_or_create<simgrid::instr::EventType>(mark_type);
155 declared_marks.insert(mark_type);
158 /** @ingroup TRACE_mark
159 * @brief Declare a new colored value for a previously declared mark type.
161 * This function declares a new colored value for a Paje event type in the trace file that can be used by simulators to
162 * declare application-level marks. This function is independent of which API is used in SimGrid. The color needs to be
163 * a string with three numbers separated by spaces in the range [0,1].
164 * A light-gray color can be specified using "0.7 0.7 0.7" as color. If a nullptr color is provided, the color used will
165 * be white ("1 1 1").
167 * @param mark_type The name of the new type.
168 * @param mark_value The name of the new value for this type.
169 * @param mark_color The color of the new value for this type.
173 void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color)
175 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
176 if (not TRACE_is_enabled() || not TRACE_needs_platform())
179 xbt_assert(mark_type, "mark_type is nullptr");
180 xbt_assert(mark_value, "mark_value is nullptr");
182 simgrid::instr::EventType* type =
183 static_cast<simgrid::instr::EventType*>(simgrid::instr::Container::get_root()->type_->by_name(mark_type));
185 throw simgrid::TracingError(XBT_THROW_POINT,
186 simgrid::xbt::string_printf("mark_type with name (%s) is not declared", mark_type));
189 mark_color = "1.0 1.0 1.0" /*white*/;
191 XBT_DEBUG("MARK,declare_value %s %s %s", mark_type, mark_value, mark_color);
192 type->add_entity_value(mark_value, mark_color);
196 /** @ingroup TRACE_mark
197 * @brief Declare a new value for a previously declared mark type.
199 * This function declares a new value for a Paje event type in the trace file that can be used by simulators to declare
200 * application-level marks. This function is independent of which API is used in SimGrid. Calling this function is the
201 * same as calling @ref TRACE_declare_mark_value_with_color with a nullptr color.
203 * @param mark_type The name of the new type.
204 * @param mark_value The name of the new value for this type.
208 void TRACE_declare_mark_value (const char *mark_type, const char *mark_value)
210 TRACE_declare_mark_value_with_color (mark_type, mark_value, nullptr);
214 * @ingroup TRACE_mark
215 * @brief Create a new instance of a tracing mark type.
217 * This function creates a mark in the trace file. The first parameter had to be previously declared using
218 * #TRACE_declare_mark, the second is the identifier for this mark instance. We recommend that the mark_value is a
219 * unique value for the whole simulation. Nevertheless, this is not a strong requirement: the trace will be valid even
220 * if there are multiple mark identifiers for the same trace.
222 * @param mark_type The name of the type for which the new instance will belong.
223 * @param mark_value The name of the new instance mark.
225 * @see TRACE_declare_mark
227 void TRACE_mark(const char *mark_type, const char *mark_value)
229 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
230 if (not TRACE_is_enabled() || not TRACE_needs_platform())
233 xbt_assert(mark_type, "mark_type is nullptr");
234 xbt_assert(mark_value, "mark_value is nullptr");
236 //check if mark_type is already declared
237 simgrid::instr::EventType* type =
238 static_cast<simgrid::instr::EventType*>(simgrid::instr::Container::get_root()->type_->by_name(mark_type));
240 throw simgrid::TracingError(XBT_THROW_POINT,
241 simgrid::xbt::string_printf("mark_type with name (%s) is not declared", mark_type));
243 XBT_DEBUG("MARK %s %s", mark_type, mark_value);
244 new simgrid::instr::NewEvent(MSG_get_clock(), simgrid::instr::Container::get_root(), type,
245 type->get_entity_value(mark_value));
249 /** @ingroup TRACE_mark
250 * @brief Get declared marks
252 * This function should be used to get marks that were already declared with #TRACE_declare_mark.
254 * @return A dynar with the declared marks, must be freed with xbt_dynar_free.
256 xbt_dynar_t TRACE_get_marks ()
258 if (not TRACE_is_enabled())
261 return instr_set_to_dynar(declared_marks);
264 static void instr_user_variable(double time, const char* resource, const char* variable_name, const char* father_type,
265 double value, InstrUserVariable what, const char* color, std::set<std::string>* filter)
267 /* safe switches. tracing has to be activated and if platform is not traced, we don't allow user variables */
268 if (not TRACE_is_enabled() || not TRACE_needs_platform())
271 //check if variable is already declared
272 auto created = filter->find(variable_name);
273 if (what == InstrUserVariable::DECLARE) {
274 if (created == filter->end()) { // not declared yet
275 filter->insert(variable_name);
276 instr_new_user_variable_type(father_type, variable_name, color == nullptr ? "" : color);
279 if (created != filter->end()) { // declared, let's work
280 simgrid::instr::VariableType* variable =
281 simgrid::instr::Container::by_name(resource)->get_variable(variable_name);
283 case InstrUserVariable::SET:
284 variable->set_event(time, value);
286 case InstrUserVariable::ADD:
287 variable->add_event(time, value);
289 case InstrUserVariable::SUB:
290 variable->sub_event(time, value);
299 static void instr_user_srcdst_variable(double time, const char *src, const char *dst, const char *variable,
300 const char *father_type, double value, InstrUserVariable what)
302 simgrid::kernel::routing::NetPoint* src_elm = sg_netpoint_by_name_or_null(src);
304 xbt_die("Element '%s' not found!",src);
306 simgrid::kernel::routing::NetPoint* dst_elm = sg_netpoint_by_name_or_null(dst);
308 xbt_die("Element '%s' not found!",dst);
310 std::vector<simgrid::kernel::resource::LinkImpl*> route;
311 simgrid::kernel::routing::NetZoneImpl::get_global_route(src_elm, dst_elm, route, nullptr);
312 for (auto const& link : route)
313 instr_user_variable(time, link->get_cname(), variable, father_type, value, what, nullptr, &user_link_variables);
316 /** @ingroup TRACE_API
317 * @brief Creates a file with the topology of the platform file used for the simulator.
319 * The graph topology will have the following properties: all hosts, links and routers of the platform file are mapped
320 * to graph nodes; routes are mapped to edges.
321 * The platform's AS are not represented in the output.
323 * @param filename The name of the file that will hold the graph.
325 * @return 1 of successful, 0 otherwise.
327 int TRACE_platform_graph_export_graphviz (const char *filename)
329 /* returns 1 if successful, 0 otherwise */
330 if (not TRACE_is_enabled())
332 xbt_graph_t g = instr_routing_platform_graph();
335 instr_routing_platform_graph_export_graphviz (g, filename);
336 xbt_graph_free_graph(g, xbt_free_f, xbt_free_f, nullptr);
341 * Derived functions that use instr_user_variable and TRACE_user_srcdst_variable. They were previously defined as
342 * pre-processors directives, but were transformed into functions so the user can track them using gdb.
345 /* for VM variables */
346 /** @ingroup TRACE_user_variables
347 * @brief Declare a new user variable associated to VMs.
349 * Declare a user variable that will be associated to VMs. A user vm variable can be used to trace user variables
350 * such as the number of tasks in a VM, the number of clients in an application (for VMs), and so on. The color
351 * associated to this new variable will be random.
353 * @param variable The name of the new variable to be declared.
355 * @see TRACE_vm_variable_declare_with_color
357 void TRACE_vm_variable_declare (const char *variable)
359 instr_user_variable(0, nullptr, variable, "VM", 0, InstrUserVariable::DECLARE, nullptr, &user_vm_variables);
362 /** @ingroup TRACE_user_variables
363 * @brief Declare a new user variable associated to VMs with a color.
365 * Same as #TRACE_vm_variable_declare, but associated a color to the newly created user host variable. The color needs
366 * to be a string with three numbers separated by spaces in the range [0,1].
367 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
369 * @param variable The name of the new variable to be declared.
370 * @param color The color for the new variable.
372 void TRACE_vm_variable_declare_with_color (const char *variable, const char *color)
374 instr_user_variable(0, nullptr, variable, "VM", 0, InstrUserVariable::DECLARE, color, &user_vm_variables);
377 /** @ingroup TRACE_user_variables
378 * @brief Set the value of a variable of a host.
380 * @param vm The name of the VM to be considered.
381 * @param variable The name of the variable to be considered.
382 * @param value The new value of the variable.
384 * @see TRACE_vm_variable_declare, TRACE_vm_variable_add, TRACE_vm_variable_sub
386 void TRACE_vm_variable_set (const char *vm, const char *variable, double value)
388 TRACE_vm_variable_set_with_time (MSG_get_clock(), vm, variable, value);
391 /** @ingroup TRACE_user_variables
392 * @brief Add a value to a variable of a VM.
394 * @param vm The name of the VM to be considered.
395 * @param variable The name of the variable to be considered.
396 * @param value The value to be added to the variable.
398 * @see TRACE_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_sub
400 void TRACE_vm_variable_add (const char *vm, const char *variable, double value)
402 TRACE_vm_variable_add_with_time (MSG_get_clock(), vm, variable, value);
405 /** @ingroup TRACE_user_variables
406 * @brief Subtract a value from a variable of a VM.
408 * @param vm The name of the vm to be considered.
409 * @param variable The name of the variable to be considered.
410 * @param value The value to be subtracted from the variable.
412 * @see TRACE_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_add
414 void TRACE_vm_variable_sub (const char *vm, const char *variable, double value)
416 TRACE_vm_variable_sub_with_time (MSG_get_clock(), vm, variable, value);
419 /** @ingroup TRACE_user_variables
420 * @brief Set the value of a variable of a VM at a given timestamp.
422 * Same as #TRACE_vm_variable_set, but let user specify the time used to trace it. Users can specify a time that
423 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
424 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
427 * @param time The timestamp to be used to tag this change of value.
428 * @param vm The name of the VM to be considered.
429 * @param variable The name of the variable to be considered.
430 * @param value The new value of the variable.
432 * @see TRACE_vm_variable_declare, TRACE_vm_variable_add_with_time, TRACE_vm_variable_sub_with_time
434 void TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value)
436 instr_user_variable(time, vm, variable, "VM", value, InstrUserVariable::SET, nullptr, &user_vm_variables);
439 /** @ingroup TRACE_user_variables
440 * @brief Add a value to a variable of a VM at a given timestamp.
442 * Same as #TRACE_vm_variable_add, but let user specify the time used to trace it. Users can specify a time that
443 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
444 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
447 * @param time The timestamp to be used to tag this change of value.
448 * @param vm The name of the VM to be considered.
449 * @param variable The name of the variable to be considered.
450 * @param value The value to be added to the variable.
452 * @see TRACE_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_sub_with_time
454 void TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value)
456 instr_user_variable(time, vm, variable, "VM", value, InstrUserVariable::ADD, nullptr, &user_vm_variables);
459 /** @ingroup TRACE_user_variables
460 * @brief Subtract a value from a variable of a VM at a given timestamp.
462 * Same as #TRACE_vm_variable_sub, but let user specify the time used to trace it. Users can specify a time that
463 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
464 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
467 * @param time The timestamp to be used to tag this change of value.
468 * @param vm The name of the VM to be considered.
469 * @param variable The name of the variable to be considered.
470 * @param value The value to be subtracted from the variable.
472 * @see TRACE_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_add_with_time
474 void TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value)
476 instr_user_variable(time, vm, variable, "VM", value, InstrUserVariable::SUB, nullptr, &user_vm_variables);
479 /* for host variables */
480 /** @ingroup TRACE_user_variables
481 * @brief Declare a new user variable associated to hosts.
483 * Declare a user variable that will be associated to hosts.
484 * A user host variable can be used to trace user variables such as the number of tasks in a server, the number of
485 * clients in an application (for hosts), and so on. The color associated to this new variable will be random.
487 * @param variable The name of the new variable to be declared.
489 * @see TRACE_host_variable_declare_with_color
491 void TRACE_host_variable_declare (const char *variable)
493 instr_user_variable(0, nullptr, variable, "HOST", 0, InstrUserVariable::DECLARE, nullptr, &user_host_variables);
496 /** @ingroup TRACE_user_variables
497 * @brief Declare a new user variable associated to hosts with a color.
499 * Same as #TRACE_host_variable_declare, but associated a color to the newly created user host variable. The color
500 * needs to be a string with three numbers separated by spaces in the range [0,1].
501 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
503 * @param variable The name of the new variable to be declared.
504 * @param color The color for the new variable.
506 void TRACE_host_variable_declare_with_color (const char *variable, const char *color)
508 instr_user_variable(0, nullptr, variable, "HOST", 0, InstrUserVariable::DECLARE, color, &user_host_variables);
511 /** @ingroup TRACE_user_variables
512 * @brief Set the value of a variable of a host.
514 * @param host The name of the host to be considered.
515 * @param variable The name of the variable to be considered.
516 * @param value The new value of the variable.
518 * @see TRACE_host_variable_declare, TRACE_host_variable_add, TRACE_host_variable_sub
520 void TRACE_host_variable_set (const char *host, const char *variable, double value)
522 TRACE_host_variable_set_with_time (MSG_get_clock(), host, variable, value);
525 /** @ingroup TRACE_user_variables
526 * @brief Add a value to a variable of a host.
528 * @param host The name of the host to be considered.
529 * @param variable The name of the variable to be considered.
530 * @param value The value to be added to the variable.
532 * @see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_sub
534 void TRACE_host_variable_add (const char *host, const char *variable, double value)
536 TRACE_host_variable_add_with_time (MSG_get_clock(), host, variable, value);
539 /** @ingroup TRACE_user_variables
540 * @brief Subtract a value from a variable of a host.
542 * @param host The name of the host to be considered.
543 * @param variable The name of the variable to be considered.
544 * @param value The value to be subtracted from the variable.
546 * @see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_add
548 void TRACE_host_variable_sub (const char *host, const char *variable, double value)
550 TRACE_host_variable_sub_with_time (MSG_get_clock(), host, variable, value);
553 /** @ingroup TRACE_user_variables
554 * @brief Set the value of a variable of a host at a given timestamp.
556 * Same as #TRACE_host_variable_set, but let user specify the time used to trace it. Users can specify a time that
557 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
558 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
561 * @param time The timestamp to be used to tag this change of value.
562 * @param host The name of the host to be considered.
563 * @param variable The name of the variable to be considered.
564 * @param value The new value of the variable.
566 * @see TRACE_host_variable_declare, TRACE_host_variable_add_with_time, TRACE_host_variable_sub_with_time
568 void TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value)
570 instr_user_variable(time, host, variable, "HOST", value, InstrUserVariable::SET, nullptr, &user_host_variables);
573 /** @ingroup TRACE_user_variables
574 * @brief Add a value to a variable of a host at a given timestamp.
576 * Same as #TRACE_host_variable_add, but let user specify the time used to trace it. Users can specify a time that
577 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
578 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
581 * @param time The timestamp to be used to tag this change of value.
582 * @param host The name of the host to be considered.
583 * @param variable The name of the variable to be considered.
584 * @param value The value to be added to the variable.
586 * @see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_sub_with_time
588 void TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value)
590 instr_user_variable(time, host, variable, "HOST", value, InstrUserVariable::ADD, nullptr, &user_host_variables);
593 /** @ingroup TRACE_user_variables
594 * @brief Subtract a value from a variable of a host at a given timestamp.
596 * Same as #TRACE_host_variable_sub, but let user specify the time used to trace it. Users can specify a time that
597 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
598 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
601 * @param time The timestamp to be used to tag this change of value.
602 * @param host The name of the host to be considered.
603 * @param variable The name of the variable to be considered.
604 * @param value The value to be subtracted from the variable.
606 * @see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_add_with_time
608 void TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value)
610 instr_user_variable(time, host, variable, "HOST", value, InstrUserVariable::SUB, nullptr, &user_host_variables);
613 /** @ingroup TRACE_user_variables
614 * @brief Get declared user host variables
616 * This function should be used to get host variables that were already declared with #TRACE_host_variable_declare or
617 * with #TRACE_host_variable_declare_with_color.
619 * @return A dynar with the declared host variables, must be freed with xbt_dynar_free.
621 xbt_dynar_t TRACE_get_host_variables ()
623 return instr_set_to_dynar(user_host_variables);
626 /* for link variables */
627 /** @ingroup TRACE_user_variables
628 * @brief Declare a new user variable associated to links.
630 * Declare a user variable that will be associated to links.
631 * A user link variable can be used, for example, to trace user variables such as the number of messages being
632 * transferred through network links. The color associated to this new variable will be random.
634 * @param variable The name of the new variable to be declared.
636 * @see TRACE_link_variable_declare_with_color
638 void TRACE_link_variable_declare (const char *variable)
640 instr_user_variable(0, nullptr, variable, "LINK", 0, InstrUserVariable::DECLARE, nullptr, &user_link_variables);
643 /** @ingroup TRACE_user_variables
644 * @brief Declare a new user variable associated to links with a color.
646 * Same as #TRACE_link_variable_declare, but associated a color to the newly created user link variable. The color
647 * needs to be a string with three numbers separated by spaces in the range [0,1].
648 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
650 * @param variable The name of the new variable to be declared.
651 * @param color The color for the new variable.
653 void TRACE_link_variable_declare_with_color (const char *variable, const char *color)
655 instr_user_variable(0, nullptr, variable, "LINK", 0, InstrUserVariable::DECLARE, color, &user_link_variables);
658 /** @ingroup TRACE_user_variables
659 * @brief Set the value of a variable of a link.
661 * @param link The name of the link to be considered.
662 * @param variable The name of the variable to be considered.
663 * @param value The new value of the variable.
665 * @see TRACE_link_variable_declare, TRACE_link_variable_add, TRACE_link_variable_sub
667 void TRACE_link_variable_set (const char *link, const char *variable, double value)
669 TRACE_link_variable_set_with_time (MSG_get_clock(), link, variable, value);
672 /** @ingroup TRACE_user_variables
673 * @brief Add a value to a variable of a link.
675 * @param link The name of the link to be considered.
676 * @param variable The name of the variable to be considered.
677 * @param value The value to be added to the variable.
679 * @see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_sub
681 void TRACE_link_variable_add (const char *link, const char *variable, double value)
683 TRACE_link_variable_add_with_time (MSG_get_clock(), link, variable, value);
686 /** @ingroup TRACE_user_variables
687 * @brief Subtract a value from a variable of a link.
689 * @param link The name of the link to be considered.
690 * @param variable The name of the variable to be considered.
691 * @param value The value to be subtracted from the variable.
693 * @see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_add
695 void TRACE_link_variable_sub (const char *link, const char *variable, double value)
697 TRACE_link_variable_sub_with_time (MSG_get_clock(), link, variable, value);
700 /** @ingroup TRACE_user_variables
701 * @brief Set the value of a variable of a link at a given timestamp.
703 * Same as #TRACE_link_variable_set, but let user specify the time used to trace it. Users can specify a time that
704 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
705 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
708 * @param time The timestamp to be used to tag this change of value.
709 * @param link The name of the link to be considered.
710 * @param variable The name of the variable to be considered.
711 * @param value The new value of the variable.
713 * @see TRACE_link_variable_declare, TRACE_link_variable_add_with_time, TRACE_link_variable_sub_with_time
715 void TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value)
717 instr_user_variable(time, link, variable, "LINK", value, InstrUserVariable::SET, nullptr, &user_link_variables);
720 /** @ingroup TRACE_user_variables
721 * @brief Add a value to a variable of a link at a given timestamp.
723 * Same as #TRACE_link_variable_add, but let user specify the time used to trace it. Users can specify a time that
724 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
725 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
728 * @param time The timestamp to be used to tag this change of value.
729 * @param link The name of the link to be considered.
730 * @param variable The name of the variable to be considered.
731 * @param value The value to be added to the variable.
733 * @see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_sub_with_time
735 void TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value)
737 instr_user_variable(time, link, variable, "LINK", value, InstrUserVariable::ADD, nullptr, &user_link_variables);
740 /** @ingroup TRACE_user_variables
741 * @brief Subtract a value from a variable of a link at a given timestamp.
743 * Same as #TRACE_link_variable_sub, but let user specify the time used to trace it. Users can specify a time that
744 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
745 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
748 * @param time The timestamp to be used to tag this change of value.
749 * @param link The name of the link to be considered.
750 * @param variable The name of the variable to be considered.
751 * @param value The value to be subtracted from the variable.
753 * @see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_add_with_time
755 void TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value)
757 instr_user_variable(time, link, variable, "LINK", value, InstrUserVariable::SUB, nullptr, &user_link_variables);
760 /* for link variables, but with src and dst used for get_route */
761 /** @ingroup TRACE_user_variables
762 * @brief Set the value of the variable present in the links connecting source and destination.
764 * Same as #TRACE_link_variable_set, but instead of providing the name of link to be considered, provide the source
765 * and destination hosts. All links that are part of the route between source and destination will have the variable
766 * set to the provided value.
768 * @param src The name of the source host for get route.
769 * @param dst The name of the destination host for get route.
770 * @param variable The name of the variable to be considered.
771 * @param value The new value of the variable.
773 * @see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add, TRACE_link_srcdst_variable_sub
775 void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value)
777 TRACE_link_srcdst_variable_set_with_time (MSG_get_clock(), src, dst, variable, value);
780 /** @ingroup TRACE_user_variables
781 * @brief Add a value to the variable present in the links connecting source and destination.
783 * Same as #TRACE_link_variable_add, but instead of providing the name of link to be considered, provide the source
784 * and destination hosts. All links that are part of the route between source and destination will have the value
785 * passed as parameter added to the current value of the variable name to be considered.
787 * @param src The name of the source host for get route.
788 * @param dst The name of the destination host for get route.
789 * @param variable The name of the variable to be considered.
790 * @param value The value to be added to the variable.
792 * @see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_sub
794 void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value)
796 TRACE_link_srcdst_variable_add_with_time (MSG_get_clock(), src, dst, variable, value);
799 /** @ingroup TRACE_user_variables
800 * @brief Subtract a value from the variable present in the links connecting source and destination.
802 * Same as #TRACE_link_variable_sub, but instead of providing the name of link to be considered, provide the source
803 * and destination hosts. All links that are part of the route between source and destination will have the value
804 * passed as parameter subtracted from the current value of the variable name to be considered.
806 * @param src The name of the source host for get route.
807 * @param dst The name of the destination host for get route.
808 * @param variable The name of the variable to be considered.
809 * @param value The value to be subtracted from the variable.
811 * @see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_add
813 void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value)
815 TRACE_link_srcdst_variable_sub_with_time (MSG_get_clock(), src, dst, variable, value);
818 /** @ingroup TRACE_user_variables
819 * @brief Set the value of the variable present in the links connecting source and destination at a given timestamp.
821 * Same as #TRACE_link_srcdst_variable_set, but let user specify the time used to trace it. Users can specify a time
822 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
823 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
826 * @param time The timestamp to be used to tag this change of value.
827 * @param src The name of the source host for get route.
828 * @param dst The name of the destination host for get route.
829 * @param variable The name of the variable to be considered.
830 * @param value The new value of the variable.
832 * @see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add_with_time, TRACE_link_srcdst_variable_sub_with_time
834 void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable,
837 instr_user_srcdst_variable(time, src, dst, variable, "LINK", value, InstrUserVariable::SET);
840 /** @ingroup TRACE_user_variables
841 * @brief Add a value to the variable present in the links connecting source and destination at a given timestamp.
843 * Same as #TRACE_link_srcdst_variable_add, but let user specify the time used to trace it. Users can specify a time
844 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
845 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
848 * @param time The timestamp to be used to tag this change of value.
849 * @param src The name of the source host for get route.
850 * @param dst The name of the destination host for get route.
851 * @param variable The name of the variable to be considered.
852 * @param value The value to be added to the variable.
854 * @see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_sub_with_time
856 void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable,
859 instr_user_srcdst_variable(time, src, dst, variable, "LINK", value, InstrUserVariable::ADD);
862 /** @ingroup TRACE_user_variables
863 * @brief Subtract a value from the variable present in the links connecting source and dest. at a given timestamp.
865 * Same as #TRACE_link_srcdst_variable_sub, but let user specify the time used to trace it. Users can specify a time
866 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
867 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
870 * @param time The timestamp to be used to tag this change of value.
871 * @param src The name of the source host for get route.
872 * @param dst The name of the destination host for get route.
873 * @param variable The name of the variable to be considered.
874 * @param value The value to be subtracted from the variable.
876 * @see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_add_with_time
878 void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable,
881 instr_user_srcdst_variable(time, src, dst, variable, "LINK", value, InstrUserVariable::SUB);
884 /** @ingroup TRACE_user_variables
885 * @brief Get declared user link variables
887 * This function should be used to get link variables that were already declared with #TRACE_link_variable_declare or
888 * with #TRACE_link_variable_declare_with_color.
890 * @return A dynar with the declared link variables, must be freed with xbt_dynar_free.
892 xbt_dynar_t TRACE_get_link_variables ()
894 return instr_set_to_dynar(user_link_variables);
897 /** @ingroup TRACE_user_variables
898 * @brief Declare a new user state associated to hosts.
900 * Declare a user state that will be associated to hosts.
901 * A user host state can be used to trace application states.
903 * @param state The name of the new state to be declared.
905 * @see TRACE_host_state_declare_value
907 void TRACE_host_state_declare (const char *state)
909 instr_new_user_state_type("HOST", state);
912 /** @ingroup TRACE_user_variables
913 * @brief Declare a new value for a user state associated to hosts.
915 * Declare a value for a state. The color needs to be a string with 3 numbers separated by spaces in the range [0,1].
916 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
918 * @param state The name of the new state to be declared.
919 * @param value The name of the value
920 * @param color The color of the value
922 * @see TRACE_host_state_declare
924 void TRACE_host_state_declare_value (const char *state, const char *value, const char *color)
926 instr_new_value_for_user_state_type (state, value, color);
929 /** @ingroup TRACE_user_variables
930 * @brief Set the user state to the given value.
932 * Change a user state previously declared to the given value.
934 * @param host The name of the host to be considered.
935 * @param state_name The name of the state previously declared.
936 * @param value_name The new value of the state.
938 * @see TRACE_host_state_declare, TRACE_host_push_state, TRACE_host_pop_state, TRACE_host_reset_state
940 void TRACE_host_set_state(const char* host, const char* state_name, const char* value_name)
942 simgrid::instr::StateType* state = simgrid::instr::Container::by_name(host)->get_state(state_name);
943 state->add_entity_value(value_name);
944 state->set_event(value_name);
947 /** @ingroup TRACE_user_variables
948 * @brief Push a new value for a state of a given host.
950 * Change a user state previously declared by pushing the new value to the state.
952 * @param host The name of the host to be considered.
953 * @param state_name The name of the state previously declared.
954 * @param value_name The value to be pushed.
956 * @see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_pop_state, TRACE_host_reset_state
958 void TRACE_host_push_state(const char* host, const char* state_name, const char* value_name)
960 simgrid::instr::Container::by_name(host)->get_state(state_name)->push_event(value_name);
963 /** @ingroup TRACE_user_variables
964 * @brief Pop the last value of a state of a given host.
966 * Change a user state previously declared by removing the last value of the state.
968 * @param host The name of the host to be considered.
969 * @param state_name The name of the state to be popped.
971 * @see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_reset_state
973 void TRACE_host_pop_state(const char* host, const char* state_name)
975 simgrid::instr::Container::by_name(host)->get_state(state_name)->pop_event();
978 /** @ingroup TRACE_API
979 * @brief Get Paje container types that can be mapped to the nodes of a graph.
981 * This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the
982 * functions defined in @ref TRACE_user_variables.
984 * @return A dynar with the types, must be freed with xbt_dynar_free.
986 xbt_dynar_t TRACE_get_node_types ()
988 return instr_set_to_dynar(trivaNodeTypes);
991 /** @ingroup TRACE_API
992 * @brief Get Paje container types that can be mapped to the edges of a graph.
994 * This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the
995 * functions defined in @ref TRACE_user_variables.
997 * @return A dynar with the types, must be freed with xbt_dynar_free.
999 xbt_dynar_t TRACE_get_edge_types ()
1001 return instr_set_to_dynar(trivaEdgeTypes);