1 /* Copyright (c) 2010-2018. 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/kernel/routing/NetPoint.hpp"
7 #include "simgrid_config.h"
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"
14 enum class InstrUserVariable { DECLARE, SET, ADD, SUB };
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
18 std::set<std::string> created_categories;
19 std::set<std::string> declared_marks;
20 std::set<std::string> user_host_variables;
21 std::set<std::string> user_vm_variables;
22 std::set<std::string> user_link_variables;
23 extern std::set<std::string> trivaNodeTypes;
24 extern std::set<std::string> trivaEdgeTypes;
26 static xbt_dynar_t instr_set_to_dynar(std::set<std::string>* filter)
28 if (not TRACE_is_enabled() || not TRACE_needs_platform())
31 xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
32 for (auto const& name : *filter)
33 xbt_dynar_push_as(ret, char*, xbt_strdup(name.c_str()));
38 /** \ingroup TRACE_category
39 * \brief Declare a new category with a random color.
41 * This function should be used to define a user category. The category can be used to differentiate the tasks that
42 * are created during the simulation (for example, tasks from server1, server2, or request tasks, computation tasks,
43 * communication tasks). All resource utilization (host power and link bandwidth) will be classified according to the
44 * task category. Tasks that do not belong to a category are not traced. The color for the category that is being
45 * declared is random. This function has no effect if a category with the same name has been already declared.
47 * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
49 * \param category The name of the new tracing category to be created.
51 * \see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
53 void TRACE_category(const char *category)
55 TRACE_category_with_color (category, nullptr);
58 /** \ingroup TRACE_category
59 * \brief Declare a new category with a color.
61 * Same as #TRACE_category, but let user specify a color encoded as a RGB-like string with three floats from 0 to 1.
62 * 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"
63 * as color. This function has no effect if a category with the same name has been already declared.
65 * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
67 * \param category The name of the new tracing category to be created.
68 * \param color The color of the category (see \ref outcomes_vizu to
69 * know how to correctly specify the color)
71 * \see MSG_task_set_category, SD_task_set_category
73 void TRACE_category_with_color (const char *category, const char *color)
75 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with categories */
76 if (not TRACE_is_enabled() || not TRACE_needs_platform())
79 if (not(TRACE_categorized() && category != nullptr))
82 //check if category is already created
83 if (created_categories.find(category) != created_categories.end())
86 created_categories.insert(category);
89 std::string final_color;
91 //generate a random color
92 double red = drand48();
93 double green = drand48();
94 double blue = drand48();
95 final_color = std::to_string(red) + " " + std::to_string(green) + " " + std::to_string(blue);
97 final_color = std::string(color);
100 XBT_DEBUG("CAT,declare %s, \"%s\" \"%s\"", category, color, final_color.c_str());
102 //define the type of this category on top of hosts and links
103 instr_new_variable_type (category, final_color);
106 /** \ingroup TRACE_category
107 * \brief Get declared categories
109 * This function should be used to get categories that were already declared with #TRACE_category or with
110 * #TRACE_category_with_color.
112 * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
114 * \return A dynar with the declared categories, must be freed with xbt_dynar_free.
116 * \see MSG_task_set_category, SD_task_set_category
118 xbt_dynar_t TRACE_get_categories ()
120 if (not TRACE_is_enabled() || not TRACE_categorized())
122 return instr_set_to_dynar(&created_categories);
125 /** \ingroup TRACE_mark
126 * \brief Declare a new type for tracing mark.
128 * This function declares a new Paje event type in the trace file that can be used by simulators to declare
129 * application-level marks. This function is independent of which API is used in SimGrid.
131 * \param mark_type The name of the new type.
135 void TRACE_declare_mark(const char *mark_type)
137 /* safe switchs. tracing has to be activated and if platform is not traced, we can't deal with marks */
138 if (not TRACE_is_enabled() || not TRACE_needs_platform())
142 THROWF (tracing_error, 1, "mark_type is nullptr");
144 //check if mark_type is already declared
145 if (declared_marks.find(mark_type) != declared_marks.end()) {
146 THROWF (tracing_error, 1, "mark_type with name (%s) is already declared", mark_type);
149 XBT_DEBUG("MARK,declare %s", mark_type);
150 simgrid::instr::Container::getRoot()->type_->getOrCreateEventType(mark_type);
151 declared_marks.insert(mark_type);
154 /** \ingroup TRACE_mark
155 * \brief Declare a new colored value for a previously declared mark type.
157 * This function declares a new colored value for a Paje event type in the trace file that can be used by simulators to
158 * declare application-level marks. This function is independent of which API is used in SimGrid. The color needs to be
159 * a string with three numbers separated by spaces in the range [0,1].
160 * 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
161 * be white ("1 1 1").
163 * \param mark_type The name of the new type.
164 * \param mark_value The name of the new value for this type.
165 * \param mark_color The color of the new value for this type.
169 void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color)
171 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
172 if (not TRACE_is_enabled() || not TRACE_needs_platform())
176 THROWF (tracing_error, 1, "mark_type is nullptr");
178 THROWF (tracing_error, 1, "mark_value is nullptr");
180 simgrid::instr::EventType* type =
181 static_cast<simgrid::instr::EventType*>(simgrid::instr::Container::getRoot()->type_->byName(mark_type));
183 THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
186 mark_color = "1.0 1.0 1.0" /*white*/;
188 XBT_DEBUG("MARK,declare_value %s %s %s", mark_type, mark_value, mark_color);
189 type->addEntityValue(mark_value, mark_color);
193 /** \ingroup TRACE_mark
194 * \brief Declare a new value for a previously declared mark type.
196 * This function declares a new value for a Paje event type in the trace file that can be used by simulators to declare
197 * application-level marks. This function is independent of which API is used in SimGrid. Calling this function is the
198 * same as calling \ref TRACE_declare_mark_value_with_color with a nullptr color.
200 * \param mark_type The name of the new type.
201 * \param mark_value The name of the new value for this type.
205 void TRACE_declare_mark_value (const char *mark_type, const char *mark_value)
207 TRACE_declare_mark_value_with_color (mark_type, mark_value, nullptr);
211 * \ingroup TRACE_mark
212 * \brief Create a new instance of a tracing mark type.
214 * This function creates a mark in the trace file. The first parameter had to be previously declared using
215 * #TRACE_declare_mark, the second is the identifier for this mark instance. We recommend that the mark_value is a
216 * unique value for the whole simulation. Nevertheless, this is not a strong requirement: the trace will be valid even
217 * if there are multiple mark identifiers for the same trace.
219 * \param mark_type The name of the type for which the new instance will belong.
220 * \param mark_value The name of the new instance mark.
222 * \see TRACE_declare_mark
224 void TRACE_mark(const char *mark_type, const char *mark_value)
226 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
227 if (not TRACE_is_enabled() || not TRACE_needs_platform())
231 THROWF (tracing_error, 1, "mark_type is nullptr");
233 THROWF (tracing_error, 1, "mark_value is nullptr");
235 //check if mark_type is already declared
236 simgrid::instr::EventType* type =
237 static_cast<simgrid::instr::EventType*>(simgrid::instr::Container::getRoot()->type_->byName(mark_type));
239 THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
241 XBT_DEBUG("MARK %s %s", mark_type, mark_value);
242 new simgrid::instr::NewEvent(MSG_get_clock(), simgrid::instr::Container::getRoot(), type,
243 type->getEntityValue(mark_value));
247 /** \ingroup TRACE_mark
248 * \brief Get declared marks
250 * This function should be used to get marks that were already declared with #TRACE_declare_mark.
252 * \return A dynar with the declared marks, must be freed with xbt_dynar_free.
254 xbt_dynar_t TRACE_get_marks ()
256 if (not TRACE_is_enabled())
259 return instr_set_to_dynar(&declared_marks);
262 static void instr_user_variable(double time, const char* resource, const char* variable_name, const char* father_type,
263 double value, InstrUserVariable what, const char* color, std::set<std::string>* filter)
265 /* safe switches. tracing has to be activated and if platform is not traced, we don't allow user variables */
266 if (not TRACE_is_enabled() || not TRACE_needs_platform())
269 //check if variable is already declared
270 auto created = filter->find(variable_name);
271 if (what == InstrUserVariable::DECLARE) {
272 if (created == filter->end()) { // not declared yet
273 filter->insert(variable_name);
274 instr_new_user_variable_type(father_type, variable_name, color == nullptr ? "" : color);
277 if (created != filter->end()) { // declared, let's work
278 simgrid::instr::VariableType* variable = simgrid::instr::Container::byName(resource)->getVariable(variable_name);
280 case InstrUserVariable::SET:
281 variable->setEvent(time, value);
283 case InstrUserVariable::ADD:
284 variable->addEvent(time, value);
286 case InstrUserVariable::SUB:
287 variable->subEvent(time, value);
297 static void instr_user_srcdst_variable(double time, const char *src, const char *dst, const char *variable,
298 const char *father_type, double value, InstrUserVariable what)
300 simgrid::kernel::routing::NetPoint* src_elm = sg_netpoint_by_name_or_null(src);
302 xbt_die("Element '%s' not found!",src);
304 simgrid::kernel::routing::NetPoint* dst_elm = sg_netpoint_by_name_or_null(dst);
306 xbt_die("Element '%s' not found!",dst);
308 std::vector<simgrid::kernel::resource::LinkImpl*> route;
309 simgrid::kernel::routing::NetZoneImpl::get_global_route(src_elm, dst_elm, route, nullptr);
310 for (auto const& link : route)
311 instr_user_variable(time, link->get_cname(), variable, father_type, value, what, nullptr, &user_link_variables);
314 /** \ingroup TRACE_API
315 * \brief Creates a file with the topology of the platform file used for the simulator.
317 * The graph topology will have the following properties: all hosts, links and routers of the platform file are mapped
318 * to graph nodes; routes are mapped to edges.
319 * The platform's AS are not represented in the output.
321 * \param filename The name of the file that will hold the graph.
323 * \return 1 of successful, 0 otherwise.
325 int TRACE_platform_graph_export_graphviz (const char *filename)
327 /* returns 1 if successful, 0 otherwise */
328 if (not TRACE_is_enabled())
330 xbt_graph_t g = instr_routing_platform_graph();
333 instr_routing_platform_graph_export_graphviz (g, filename);
334 xbt_graph_free_graph(g, xbt_free_f, xbt_free_f, nullptr);
339 * Derived functions that use instr_user_variable and TRACE_user_srcdst_variable. They were previously defined as
340 * pre-processors directives, but were transformed into functions so the user can track them using gdb.
343 /* for VM variables */
344 /** \ingroup TRACE_user_variables
345 * \brief Declare a new user variable associated to VMs.
347 * Declare a user variable that will be associated to VMs. A user vm variable can be used to trace user variables
348 * such as the number of tasks in a VM, the number of clients in an application (for VMs), and so on. The color
349 * associated to this new variable will be random.
351 * \param variable The name of the new variable to be declared.
353 * \see TRACE_vm_variable_declare_with_color
355 void TRACE_vm_variable_declare (const char *variable)
357 instr_user_variable(0, nullptr, variable, "MSG_VM", 0, InstrUserVariable::DECLARE, nullptr, &user_vm_variables);
360 /** \ingroup TRACE_user_variables
361 * \brief Declare a new user variable associated to VMs with a color.
363 * Same as #TRACE_vm_variable_declare, but associated a color to the newly created user host variable. The color needs
364 * to be a string with three numbers separated by spaces in the range [0,1].
365 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
367 * \param variable The name of the new variable to be declared.
368 * \param color The color for the new variable.
370 void TRACE_vm_variable_declare_with_color (const char *variable, const char *color)
372 instr_user_variable(0, nullptr, variable, "MSG_VM", 0, InstrUserVariable::DECLARE, color, &user_vm_variables);
375 /** \ingroup TRACE_user_variables
376 * \brief Set the value of a variable of a host.
378 * \param vm The name of the VM to be considered.
379 * \param variable The name of the variable to be considered.
380 * \param value The new value of the variable.
382 * \see TRACE_vm_variable_declare, TRACE_vm_variable_add, TRACE_vm_variable_sub
384 void TRACE_vm_variable_set (const char *vm, const char *variable, double value)
386 TRACE_vm_variable_set_with_time (MSG_get_clock(), vm, variable, value);
389 /** \ingroup TRACE_user_variables
390 * \brief Add a value to a variable of a VM.
392 * \param vm The name of the VM to be considered.
393 * \param variable The name of the variable to be considered.
394 * \param value The value to be added to the variable.
396 * \see TRACE_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_sub
398 void TRACE_vm_variable_add (const char *vm, const char *variable, double value)
400 TRACE_vm_variable_add_with_time (MSG_get_clock(), vm, variable, value);
403 /** \ingroup TRACE_user_variables
404 * \brief Subtract a value from a variable of a VM.
406 * \param vm The name of the vm to be considered.
407 * \param variable The name of the variable to be considered.
408 * \param value The value to be subtracted from the variable.
410 * \see TRACE_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_add
412 void TRACE_vm_variable_sub (const char *vm, const char *variable, double value)
414 TRACE_vm_variable_sub_with_time (MSG_get_clock(), vm, variable, value);
417 /** \ingroup TRACE_user_variables
418 * \brief Set the value of a variable of a VM at a given timestamp.
420 * Same as #TRACE_vm_variable_set, but let user specify the time used to trace it. Users can specify a time that
421 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
422 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
425 * \param time The timestamp to be used to tag this change of value.
426 * \param vm The name of the VM to be considered.
427 * \param variable The name of the variable to be considered.
428 * \param value The new value of the variable.
430 * \see TRACE_vm_variable_declare, TRACE_vm_variable_add_with_time, TRACE_vm_variable_sub_with_time
432 void TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value)
434 instr_user_variable(time, vm, variable, "MSG_VM", value, InstrUserVariable::SET, nullptr, &user_vm_variables);
437 /** \ingroup TRACE_user_variables
438 * \brief Add a value to a variable of a VM at a given timestamp.
440 * Same as #TRACE_vm_variable_add, but let user specify the time used to trace it. Users can specify a time that
441 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
442 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
445 * \param time The timestamp to be used to tag this change of value.
446 * \param vm The name of the VM to be considered.
447 * \param variable The name of the variable to be considered.
448 * \param value The value to be added to the variable.
450 * \see TRACE_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_sub_with_time
452 void TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value)
454 instr_user_variable(time, vm, variable, "MSG_VM", value, InstrUserVariable::ADD, nullptr, &user_vm_variables);
457 /** \ingroup TRACE_user_variables
458 * \brief Subtract a value from a variable of a VM at a given timestamp.
460 * Same as #TRACE_vm_variable_sub, but let user specify the time used to trace it. Users can specify a time that
461 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
462 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
465 * \param time The timestamp to be used to tag this change of value.
466 * \param vm The name of the VM to be considered.
467 * \param variable The name of the variable to be considered.
468 * \param value The value to be subtracted from the variable.
470 * \see TRACE_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_add_with_time
472 void TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value)
474 instr_user_variable(time, vm, variable, "MSG_VM", value, InstrUserVariable::SUB, nullptr, &user_vm_variables);
477 /* for host variables */
478 /** \ingroup TRACE_user_variables
479 * \brief Declare a new user variable associated to hosts.
481 * Declare a user variable that will be associated to hosts.
482 * A user host variable can be used to trace user variables such as the number of tasks in a server, the number of
483 * clients in an application (for hosts), and so on. The color associated to this new variable will be random.
485 * \param variable The name of the new variable to be declared.
487 * \see TRACE_host_variable_declare_with_color
489 void TRACE_host_variable_declare (const char *variable)
491 instr_user_variable(0, nullptr, variable, "HOST", 0, InstrUserVariable::DECLARE, nullptr, &user_host_variables);
494 /** \ingroup TRACE_user_variables
495 * \brief Declare a new user variable associated to hosts with a color.
497 * Same as #TRACE_host_variable_declare, but associated a color to the newly created user host variable. The color
498 * needs to be a string with three numbers separated by spaces in the range [0,1].
499 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
501 * \param variable The name of the new variable to be declared.
502 * \param color The color for the new variable.
504 void TRACE_host_variable_declare_with_color (const char *variable, const char *color)
506 instr_user_variable(0, nullptr, variable, "HOST", 0, InstrUserVariable::DECLARE, color, &user_host_variables);
509 /** \ingroup TRACE_user_variables
510 * \brief Set the value of a variable of a host.
512 * \param host The name of the host to be considered.
513 * \param variable The name of the variable to be considered.
514 * \param value The new value of the variable.
516 * \see TRACE_host_variable_declare, TRACE_host_variable_add, TRACE_host_variable_sub
518 void TRACE_host_variable_set (const char *host, const char *variable, double value)
520 TRACE_host_variable_set_with_time (MSG_get_clock(), host, variable, value);
523 /** \ingroup TRACE_user_variables
524 * \brief Add a value to a variable of a host.
526 * \param host The name of the host to be considered.
527 * \param variable The name of the variable to be considered.
528 * \param value The value to be added to the variable.
530 * \see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_sub
532 void TRACE_host_variable_add (const char *host, const char *variable, double value)
534 TRACE_host_variable_add_with_time (MSG_get_clock(), host, variable, value);
537 /** \ingroup TRACE_user_variables
538 * \brief Subtract a value from a variable of a host.
540 * \param host The name of the host to be considered.
541 * \param variable The name of the variable to be considered.
542 * \param value The value to be subtracted from the variable.
544 * \see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_add
546 void TRACE_host_variable_sub (const char *host, const char *variable, double value)
548 TRACE_host_variable_sub_with_time (MSG_get_clock(), host, variable, value);
551 /** \ingroup TRACE_user_variables
552 * \brief Set the value of a variable of a host at a given timestamp.
554 * Same as #TRACE_host_variable_set, but let user specify the time used to trace it. Users can specify a time that
555 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
556 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
559 * \param time The timestamp to be used to tag this change of value.
560 * \param host The name of the host to be considered.
561 * \param variable The name of the variable to be considered.
562 * \param value The new value of the variable.
564 * \see TRACE_host_variable_declare, TRACE_host_variable_add_with_time, TRACE_host_variable_sub_with_time
566 void TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value)
568 instr_user_variable(time, host, variable, "HOST", value, InstrUserVariable::SET, nullptr, &user_host_variables);
571 /** \ingroup TRACE_user_variables
572 * \brief Add a value to a variable of a host at a given timestamp.
574 * Same as #TRACE_host_variable_add, but let user specify the time used to trace it. Users can specify a time that
575 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
576 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
579 * \param time The timestamp to be used to tag this change of value.
580 * \param host The name of the host to be considered.
581 * \param variable The name of the variable to be considered.
582 * \param value The value to be added to the variable.
584 * \see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_sub_with_time
586 void TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value)
588 instr_user_variable(time, host, variable, "HOST", value, InstrUserVariable::ADD, nullptr, &user_host_variables);
591 /** \ingroup TRACE_user_variables
592 * \brief Subtract a value from a variable of a host at a given timestamp.
594 * Same as #TRACE_host_variable_sub, but let user specify the time used to trace it. Users can specify a time that
595 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
596 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
599 * \param time The timestamp to be used to tag this change of value.
600 * \param host The name of the host to be considered.
601 * \param variable The name of the variable to be considered.
602 * \param value The value to be subtracted from the variable.
604 * \see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_add_with_time
606 void TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value)
608 instr_user_variable(time, host, variable, "HOST", value, InstrUserVariable::SUB, nullptr, &user_host_variables);
611 /** \ingroup TRACE_user_variables
612 * \brief Get declared user host variables
614 * This function should be used to get host variables that were already declared with #TRACE_host_variable_declare or
615 * with #TRACE_host_variable_declare_with_color.
617 * \return A dynar with the declared host variables, must be freed with xbt_dynar_free.
619 xbt_dynar_t TRACE_get_host_variables ()
621 return instr_set_to_dynar(&user_host_variables);
624 /* for link variables */
625 /** \ingroup TRACE_user_variables
626 * \brief Declare a new user variable associated to links.
628 * Declare a user variable that will be associated to links.
629 * A user link variable can be used, for example, to trace user variables such as the number of messages being
630 * transferred through network links. The color associated to this new variable will be random.
632 * \param variable The name of the new variable to be declared.
634 * \see TRACE_link_variable_declare_with_color
636 void TRACE_link_variable_declare (const char *variable)
638 instr_user_variable(0, nullptr, variable, "LINK", 0, InstrUserVariable::DECLARE, nullptr, &user_link_variables);
641 /** \ingroup TRACE_user_variables
642 * \brief Declare a new user variable associated to links with a color.
644 * Same as #TRACE_link_variable_declare, but associated a color to the newly created user link variable. The color
645 * needs to be a string with three numbers separated by spaces in the range [0,1].
646 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
648 * \param variable The name of the new variable to be declared.
649 * \param color The color for the new variable.
651 void TRACE_link_variable_declare_with_color (const char *variable, const char *color)
653 instr_user_variable(0, nullptr, variable, "LINK", 0, InstrUserVariable::DECLARE, color, &user_link_variables);
656 /** \ingroup TRACE_user_variables
657 * \brief Set the value of a variable of a link.
659 * \param link The name of the link to be considered.
660 * \param variable The name of the variable to be considered.
661 * \param value The new value of the variable.
663 * \see TRACE_link_variable_declare, TRACE_link_variable_add, TRACE_link_variable_sub
665 void TRACE_link_variable_set (const char *link, const char *variable, double value)
667 TRACE_link_variable_set_with_time (MSG_get_clock(), link, variable, value);
670 /** \ingroup TRACE_user_variables
671 * \brief Add a value to a variable of a link.
673 * \param link The name of the link to be considered.
674 * \param variable The name of the variable to be considered.
675 * \param value The value to be added to the variable.
677 * \see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_sub
679 void TRACE_link_variable_add (const char *link, const char *variable, double value)
681 TRACE_link_variable_add_with_time (MSG_get_clock(), link, variable, value);
684 /** \ingroup TRACE_user_variables
685 * \brief Subtract a value from a variable of a link.
687 * \param link The name of the link to be considered.
688 * \param variable The name of the variable to be considered.
689 * \param value The value to be subtracted from the variable.
691 * \see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_add
693 void TRACE_link_variable_sub (const char *link, const char *variable, double value)
695 TRACE_link_variable_sub_with_time (MSG_get_clock(), link, variable, value);
698 /** \ingroup TRACE_user_variables
699 * \brief Set the value of a variable of a link at a given timestamp.
701 * Same as #TRACE_link_variable_set, but let user specify the time used to trace it. Users can specify a time that
702 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
703 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
706 * \param time The timestamp to be used to tag this change of value.
707 * \param link The name of the link to be considered.
708 * \param variable The name of the variable to be considered.
709 * \param value The new value of the variable.
711 * \see TRACE_link_variable_declare, TRACE_link_variable_add_with_time, TRACE_link_variable_sub_with_time
713 void TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value)
715 instr_user_variable(time, link, variable, "LINK", value, InstrUserVariable::SET, nullptr, &user_link_variables);
718 /** \ingroup TRACE_user_variables
719 * \brief Add a value to a variable of a link at a given timestamp.
721 * Same as #TRACE_link_variable_add, but let user specify the time used to trace it. Users can specify a time that
722 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
723 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
726 * \param time The timestamp to be used to tag this change of value.
727 * \param link The name of the link to be considered.
728 * \param variable The name of the variable to be considered.
729 * \param value The value to be added to the variable.
731 * \see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_sub_with_time
733 void TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value)
735 instr_user_variable(time, link, variable, "LINK", value, InstrUserVariable::ADD, nullptr, &user_link_variables);
738 /** \ingroup TRACE_user_variables
739 * \brief Subtract a value from a variable of a link at a given timestamp.
741 * Same as #TRACE_link_variable_sub, but let user specify the time used to trace it. Users can specify a time that
742 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
743 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
746 * \param time The timestamp to be used to tag this change of value.
747 * \param link The name of the link to be considered.
748 * \param variable The name of the variable to be considered.
749 * \param value The value to be subtracted from the variable.
751 * \see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_add_with_time
753 void TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value)
755 instr_user_variable(time, link, variable, "LINK", value, InstrUserVariable::SUB, nullptr, &user_link_variables);
758 /* for link variables, but with src and dst used for get_route */
759 /** \ingroup TRACE_user_variables
760 * \brief Set the value of the variable present in the links connecting source and destination.
762 * Same as #TRACE_link_variable_set, but instead of providing the name of link to be considered, provide the source
763 * and destination hosts. All links that are part of the route between source and destination will have the variable
764 * set to the provided value.
766 * \param src The name of the source host for get route.
767 * \param dst The name of the destination host for get route.
768 * \param variable The name of the variable to be considered.
769 * \param value The new value of the variable.
771 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add, TRACE_link_srcdst_variable_sub
773 void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value)
775 TRACE_link_srcdst_variable_set_with_time (MSG_get_clock(), src, dst, variable, value);
778 /** \ingroup TRACE_user_variables
779 * \brief Add a value to the variable present in the links connecting source and destination.
781 * Same as #TRACE_link_variable_add, but instead of providing the name of link to be considered, provide the source
782 * and destination hosts. All links that are part of the route between source and destination will have the value
783 * passed as parameter added to the current value of the variable name to be considered.
785 * \param src The name of the source host for get route.
786 * \param dst The name of the destination host for get route.
787 * \param variable The name of the variable to be considered.
788 * \param value The value to be added to the variable.
790 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_sub
792 void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value)
794 TRACE_link_srcdst_variable_add_with_time (MSG_get_clock(), src, dst, variable, value);
797 /** \ingroup TRACE_user_variables
798 * \brief Subtract a value from the variable present in the links connecting source and destination.
800 * Same as #TRACE_link_variable_sub, but instead of providing the name of link to be considered, provide the source
801 * and destination hosts. All links that are part of the route between source and destination will have the value
802 * passed as parameter subtracted from the current value of the variable name to be considered.
804 * \param src The name of the source host for get route.
805 * \param dst The name of the destination host for get route.
806 * \param variable The name of the variable to be considered.
807 * \param value The value to be subtracted from the variable.
809 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_add
811 void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value)
813 TRACE_link_srcdst_variable_sub_with_time (MSG_get_clock(), src, dst, variable, value);
816 /** \ingroup TRACE_user_variables
817 * \brief Set the value of the variable present in the links connecting source and destination at a given timestamp.
819 * Same as #TRACE_link_srcdst_variable_set, but let user specify the time used to trace it. Users can specify a time
820 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
821 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
824 * \param time The timestamp to be used to tag this change of value.
825 * \param src The name of the source host for get route.
826 * \param dst The name of the destination host for get route.
827 * \param variable The name of the variable to be considered.
828 * \param value The new value of the variable.
830 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add_with_time, TRACE_link_srcdst_variable_sub_with_time
832 void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable,
835 instr_user_srcdst_variable(time, src, dst, variable, "LINK", value, InstrUserVariable::SET);
838 /** \ingroup TRACE_user_variables
839 * \brief Add a value to the variable present in the links connecting source and destination at a given timestamp.
841 * Same as #TRACE_link_srcdst_variable_add, but let user specify the time used to trace it. Users can specify a time
842 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
843 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
846 * \param time The timestamp to be used to tag this change of value.
847 * \param src The name of the source host for get route.
848 * \param dst The name of the destination host for get route.
849 * \param variable The name of the variable to be considered.
850 * \param value The value to be added to the variable.
852 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_sub_with_time
854 void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable,
857 instr_user_srcdst_variable(time, src, dst, variable, "LINK", value, InstrUserVariable::ADD);
860 /** \ingroup TRACE_user_variables
861 * \brief Subtract a value from the variable present in the links connecting source and dest. at a given timestamp.
863 * Same as #TRACE_link_srcdst_variable_sub, but let user specify the time used to trace it. Users can specify a time
864 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
865 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
868 * \param time The timestamp to be used to tag this change of value.
869 * \param src The name of the source host for get route.
870 * \param dst The name of the destination host for get route.
871 * \param variable The name of the variable to be considered.
872 * \param value The value to be subtracted from the variable.
874 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_add_with_time
876 void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable,
879 instr_user_srcdst_variable(time, src, dst, variable, "LINK", value, InstrUserVariable::SUB);
882 /** \ingroup TRACE_user_variables
883 * \brief Get declared user link variables
885 * This function should be used to get link variables that were already declared with #TRACE_link_variable_declare or
886 * with #TRACE_link_variable_declare_with_color.
888 * \return A dynar with the declared link variables, must be freed with xbt_dynar_free.
890 xbt_dynar_t TRACE_get_link_variables ()
892 return instr_set_to_dynar(&user_link_variables);
895 /** \ingroup TRACE_user_variables
896 * \brief Declare a new user state associated to hosts.
898 * Declare a user state that will be associated to hosts.
899 * A user host state can be used to trace application states.
901 * \param state The name of the new state to be declared.
903 * \see TRACE_host_state_declare_value
905 void TRACE_host_state_declare (const char *state)
907 instr_new_user_state_type("HOST", state);
910 /** \ingroup TRACE_user_variables
911 * \brief Declare a new value for a user state associated to hosts.
913 * Declare a value for a state. The color needs to be a string with 3 numbers separated by spaces in the range [0,1].
914 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
916 * \param state The name of the new state to be declared.
917 * \param value The name of the value
918 * \param color The color of the value
920 * \see TRACE_host_state_declare
922 void TRACE_host_state_declare_value (const char *state, const char *value, const char *color)
924 instr_new_value_for_user_state_type (state, value, color);
927 /** \ingroup TRACE_user_variables
928 * \brief Set the user state to the given value.
930 * Change a user state previously declared to the given value.
932 * \param host The name of the host to be considered.
933 * \param state The name of the state previously declared.
934 * \param value The new value of the state.
936 * \see TRACE_host_state_declare, TRACE_host_push_state, TRACE_host_pop_state, TRACE_host_reset_state
938 void TRACE_host_set_state(const char* host, const char* state_name, const char* value_name)
940 simgrid::instr::StateType* state = simgrid::instr::Container::byName(host)->getState(state_name);
941 state->addEntityValue(value_name);
942 state->setEvent(value_name);
945 /** \ingroup TRACE_user_variables
946 * \brief Push a new value for a state of a given host.
948 * Change a user state previously declared by pushing the new value to the state.
950 * \param host The name of the host to be considered.
951 * \param state_name The name of the state previously declared.
952 * \param value_name The value to be pushed.
954 * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_pop_state, TRACE_host_reset_state
956 void TRACE_host_push_state(const char* host, const char* state_name, const char* value_name)
958 simgrid::instr::Container::byName(host)->getState(state_name)->pushEvent(value_name);
961 /** \ingroup TRACE_user_variables
962 * \brief Pop the last value of a state of a given host.
964 * Change a user state previously declared by removing the last value of the state.
966 * \param host The name of the host to be considered.
967 * \param state_name The name of the state to be popped.
969 * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_reset_state
971 void TRACE_host_pop_state(const char* host, const char* state_name)
973 simgrid::instr::Container::byName(host)->getState(state_name)->popEvent();
976 /** \ingroup TRACE_API
977 * \brief Get Paje container types that can be mapped to the nodes of a graph.
979 * This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the
980 * functions defined in \ref TRACE_user_variables.
982 * \return A dynar with the types, must be freed with xbt_dynar_free.
984 xbt_dynar_t TRACE_get_node_types ()
986 return instr_set_to_dynar(&trivaNodeTypes);
989 /** \ingroup TRACE_API
990 * \brief Get Paje container types that can be mapped to the edges of a graph.
992 * This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the
993 * functions defined in \ref TRACE_user_variables.
995 * \return A dynar with the types, must be freed with xbt_dynar_free.
997 xbt_dynar_t TRACE_get_edge_types ()
999 return instr_set_to_dynar(&trivaEdgeTypes);