1 /* Copyright (c) 2010-2017. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "simgrid_config.h"
8 #include "src/instr/instr_private.hpp"
9 #include "src/kernel/routing/NetPoint.hpp"
10 #include "src/surf/network_interface.hpp"
11 #include "src/surf/surf_private.hpp"
12 #include "surf/surf.h"
15 enum InstrUserVariable { INSTR_US_DECLARE, INSTR_US_SET, INSTR_US_ADD, INSTR_US_SUB };
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
19 std::set<std::string> created_categories;
20 std::set<std::string> declared_marks;
21 std::set<std::string> user_host_variables;
22 std::set<std::string> user_vm_variables;
23 std::set<std::string> user_link_variables;
24 extern std::set<std::string> trivaNodeTypes;
25 extern std::set<std::string> trivaEdgeTypes;
27 static xbt_dynar_t instr_set_to_dynar(std::set<std::string>* filter)
29 if (not TRACE_is_enabled() || not TRACE_needs_platform())
32 xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
33 for (auto const& name : *filter)
34 xbt_dynar_push_as(ret, char*, xbt_strdup(name.c_str()));
39 /** \ingroup TRACE_category
40 * \brief Declare a new category with a random color.
42 * This function should be used to define a user category. The category can be used to differentiate the tasks that
43 * are created during the simulation (for example, tasks from server1, server2, or request tasks, computation tasks,
44 * communication tasks). All resource utilization (host power and link bandwidth) will be classified according to the
45 * task category. Tasks that do not belong to a category are not traced. The color for the category that is being
46 * declared is random. This function has no effect if a category with the same name has been already declared.
48 * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
50 * \param category The name of the new tracing category to be created.
52 * \see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
54 void TRACE_category(const char *category)
56 TRACE_category_with_color (category, nullptr);
59 /** \ingroup TRACE_category
60 * \brief Declare a new category with a color.
62 * Same as #TRACE_category, but let user specify a color encoded as a RGB-like string with three floats from 0 to 1.
63 * 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"
64 * as color. This function has no effect if a category with the same name has been already declared.
66 * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
68 * \param category The name of the new tracing category to be created.
69 * \param color The color of the category (see \ref outcomes_vizu to
70 * know how to correctly specify the color)
72 * \see MSG_task_set_category, SD_task_set_category
74 void TRACE_category_with_color (const char *category, const char *color)
76 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with categories */
77 if (not TRACE_is_enabled() || not TRACE_needs_platform())
80 if (not(TRACE_categorized() && category != nullptr))
83 //check if category is already created
84 if (created_categories.find(category) != created_categories.end())
87 created_categories.insert(category);
90 std::string final_color;
92 //generate a random color
93 double red = drand48();
94 double green = drand48();
95 double blue = drand48();
96 final_color = std::to_string(red) + " " + std::to_string(green) + " " + std::to_string(blue);
98 final_color = std::string(color);
101 XBT_DEBUG("CAT,declare %s, \"%s\" \"%s\"", category, color, final_color.c_str());
103 //define the type of this category on top of hosts and links
104 instr_new_variable_type (category, final_color);
107 /** \ingroup TRACE_category
108 * \brief Get declared categories
110 * This function should be used to get categories that were already declared with #TRACE_category or with
111 * #TRACE_category_with_color.
113 * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
115 * \return A dynar with the declared categories, must be freed with xbt_dynar_free.
117 * \see MSG_task_set_category, SD_task_set_category
119 xbt_dynar_t TRACE_get_categories ()
121 if (not TRACE_is_enabled() || not TRACE_categorized())
123 return instr_set_to_dynar(&created_categories);
126 /** \ingroup TRACE_mark
127 * \brief Declare a new type for tracing mark.
129 * This function declares a new Paje event type in the trace file that can be used by simulators to declare
130 * application-level marks. This function is independent of which API is used in SimGrid.
132 * \param mark_type The name of the new type.
136 void TRACE_declare_mark(const char *mark_type)
138 /* safe switchs. tracing has to be activated and if platform is not traced, we can't deal with marks */
139 if (not TRACE_is_enabled() || not TRACE_needs_platform())
143 THROWF (tracing_error, 1, "mark_type is nullptr");
145 //check if mark_type is already declared
146 if (declared_marks.find(mark_type) != declared_marks.end()) {
147 THROWF (tracing_error, 1, "mark_type with name (%s) is already declared", mark_type);
150 XBT_DEBUG("MARK,declare %s", mark_type);
151 simgrid::instr::Type::getRootType()->getOrCreateEventType(mark_type);
152 declared_marks.insert(mark_type);
155 /** \ingroup TRACE_mark
156 * \brief Declare a new colored value for a previously declared mark type.
158 * This function declares a new colored value for a Paje event type in the trace file that can be used by simulators to
159 * declare application-level marks. This function is independent of which API is used in SimGrid. The color needs to be
160 * a string with three numbers separated by spaces in the range [0,1].
161 * 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
162 * be white ("1 1 1").
164 * \param mark_type The name of the new type.
165 * \param mark_value The name of the new value for this type.
166 * \param mark_color The color of the new value for this type.
170 void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color)
172 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
173 if (not TRACE_is_enabled() || not TRACE_needs_platform())
177 THROWF (tracing_error, 1, "mark_type is nullptr");
179 THROWF (tracing_error, 1, "mark_value is nullptr");
181 simgrid::instr::EventType* type =
182 static_cast<simgrid::instr::EventType*>(simgrid::instr::Type::getRootType()->byName(mark_type));
184 THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
187 mark_color = "1.0 1.0 1.0" /*white*/;
189 XBT_DEBUG("MARK,declare_value %s %s %s", mark_type, mark_value, mark_color);
190 type->addEntityValue(mark_value, mark_color);
194 /** \ingroup TRACE_mark
195 * \brief Declare a new value for a previously declared mark type.
197 * This function declares a new value for a Paje event type in the trace file that can be used by simulators to declare
198 * application-level marks. This function is independent of which API is used in SimGrid. Calling this function is the
199 * same as calling \ref TRACE_declare_mark_value_with_color with a nullptr color.
201 * \param mark_type The name of the new type.
202 * \param mark_value The name of the new value for this type.
206 void TRACE_declare_mark_value (const char *mark_type, const char *mark_value)
208 TRACE_declare_mark_value_with_color (mark_type, mark_value, nullptr);
212 * \ingroup TRACE_mark
213 * \brief Create a new instance of a tracing mark type.
215 * This function creates a mark in the trace file. The first parameter had to be previously declared using
216 * #TRACE_declare_mark, the second is the identifier for this mark instance. We recommend that the mark_value is a
217 * unique value for the whole simulation. Nevertheless, this is not a strong requirement: the trace will be valid even
218 * if there are multiple mark identifiers for the same trace.
220 * \param mark_type The name of the type for which the new instance will belong.
221 * \param mark_value The name of the new instance mark.
223 * \see TRACE_declare_mark
225 void TRACE_mark(const char *mark_type, const char *mark_value)
227 /* safe switches. tracing has to be activated and if platform is not traced, we can't deal with marks */
228 if (not TRACE_is_enabled() || not TRACE_needs_platform())
232 THROWF (tracing_error, 1, "mark_type is nullptr");
234 THROWF (tracing_error, 1, "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::Type::getRootType()->byName(mark_type));
240 THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
242 XBT_DEBUG("MARK %s %s", mark_type, mark_value);
243 new simgrid::instr::NewEvent(MSG_get_clock(), simgrid::instr::Container::getRootContainer(), type,
244 type->getEntityValue(mark_value));
248 /** \ingroup TRACE_mark
249 * \brief Get declared marks
251 * This function should be used to get marks that were already declared with #TRACE_declare_mark.
253 * \return A dynar with the declared marks, must be freed with xbt_dynar_free.
255 xbt_dynar_t TRACE_get_marks ()
257 if (not TRACE_is_enabled())
260 return instr_set_to_dynar(&declared_marks);
263 static void instr_user_variable(double time, const char* resource, const char* variable, const char* father_type,
264 double value, InstrUserVariable what, const char* color, std::set<std::string>* filter)
266 /* safe switches. tracing has to be activated and if platform is not traced, we don't allow user variables */
267 if (not TRACE_is_enabled() || not TRACE_needs_platform())
270 //check if variable is already declared
271 auto created = filter->find(variable);
272 if (what == INSTR_US_DECLARE){
273 if (created == filter->end()) { // not declared yet
274 filter->insert(variable);
275 instr_new_user_variable_type(father_type, variable, color == nullptr ? "" : color);
278 if (created != filter->end()) { // declared, let's work
280 snprintf(valuestr, 100, "%g", value);
281 container_t container = simgrid::instr::Container::byName(resource);
282 simgrid::instr::Type* type = container->type_->byName(variable);
285 new simgrid::instr::SetVariableEvent(time, container, type, value);
288 new simgrid::instr::AddVariableEvent(time, container, type, value);
291 new simgrid::instr::SubVariableEvent(time, container, type, value);
301 static void instr_user_srcdst_variable(double time, const char *src, const char *dst, const char *variable,
302 const char *father_type, double value, InstrUserVariable what)
304 sg_netpoint_t src_elm = sg_netpoint_by_name_or_null(src);
306 xbt_die("Element '%s' not found!",src);
308 sg_netpoint_t dst_elm = sg_netpoint_by_name_or_null(dst);
310 xbt_die("Element '%s' not found!",dst);
312 std::vector<simgrid::surf::LinkImpl*> route;
313 simgrid::kernel::routing::NetZoneImpl::getGlobalRoute(src_elm, dst_elm, &route, nullptr);
314 for (auto const& link : route)
315 instr_user_variable(time, link->getCname(), variable, father_type, value, what, nullptr, &user_link_variables);
318 /** \ingroup TRACE_API
319 * \brief Creates a file with the topology of the platform file used for the simulator.
321 * The graph topology will have the following properties: all hosts, links and routers of the platform file are mapped
322 * to graph nodes; routes are mapped to edges.
323 * The platform's AS are not represented in the output.
325 * \param filename The name of the file that will hold the graph.
327 * \return 1 of successful, 0 otherwise.
329 int TRACE_platform_graph_export_graphviz (const char *filename)
331 /* returns 1 if successful, 0 otherwise */
332 if (not TRACE_is_enabled())
334 xbt_graph_t g = instr_routing_platform_graph();
337 instr_routing_platform_graph_export_graphviz (g, filename);
338 xbt_graph_free_graph(g, xbt_free_f, xbt_free_f, nullptr);
343 * Derived functions that use instr_user_variable and TRACE_user_srcdst_variable. They were previously defined as
344 * pre-processors directives, but were transformed into functions so the user can track them using gdb.
347 /* for VM variables */
348 /** \ingroup TRACE_user_variables
349 * \brief Declare a new user variable associated to VMs.
351 * Declare a user variable that will be associated to VMs. A user vm variable can be used to trace user variables
352 * such as the number of tasks in a VM, the number of clients in an application (for VMs), and so on. The color
353 * associated to this new variable will be random.
355 * \param variable The name of the new variable to be declared.
357 * \see TRACE_vm_variable_declare_with_color
359 void TRACE_vm_variable_declare (const char *variable)
361 instr_user_variable(0, nullptr, variable, "MSG_VM", 0, INSTR_US_DECLARE, nullptr, &user_vm_variables);
364 /** \ingroup TRACE_user_variables
365 * \brief Declare a new user variable associated to VMs with a color.
367 * Same as #TRACE_vm_variable_declare, but associated a color to the newly created user host variable. The color needs
368 * to be a string with three numbers separated by spaces in the range [0,1].
369 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
371 * \param variable The name of the new variable to be declared.
372 * \param color The color for the new variable.
374 void TRACE_vm_variable_declare_with_color (const char *variable, const char *color)
376 instr_user_variable(0, nullptr, variable, "MSG_VM", 0, INSTR_US_DECLARE, color, &user_vm_variables);
379 /** \ingroup TRACE_user_variables
380 * \brief Set the value of a variable of a host.
382 * \param vm The name of the VM to be considered.
383 * \param variable The name of the variable to be considered.
384 * \param value The new value of the variable.
386 * \see TRACE_vm_variable_declare, TRACE_vm_variable_add, TRACE_vm_variable_sub
388 void TRACE_vm_variable_set (const char *vm, const char *variable, double value)
390 TRACE_vm_variable_set_with_time (MSG_get_clock(), vm, variable, value);
393 /** \ingroup TRACE_user_variables
394 * \brief Add a value to a variable of a VM.
396 * \param vm The name of the VM to be considered.
397 * \param variable The name of the variable to be considered.
398 * \param value The value to be added to the variable.
400 * \see TRACE_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_sub
402 void TRACE_vm_variable_add (const char *vm, const char *variable, double value)
404 TRACE_vm_variable_add_with_time (MSG_get_clock(), vm, variable, value);
407 /** \ingroup TRACE_user_variables
408 * \brief Subtract a value from a variable of a VM.
410 * \param vm The name of the vm to be considered.
411 * \param variable The name of the variable to be considered.
412 * \param value The value to be subtracted from the variable.
414 * \see TRACE_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_add
416 void TRACE_vm_variable_sub (const char *vm, const char *variable, double value)
418 TRACE_vm_variable_sub_with_time (MSG_get_clock(), vm, variable, value);
421 /** \ingroup TRACE_user_variables
422 * \brief Set the value of a variable of a VM at a given timestamp.
424 * Same as #TRACE_vm_variable_set, but let user specify the time used to trace it. Users can specify a time that
425 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
426 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
429 * \param time The timestamp to be used to tag this change of value.
430 * \param vm The name of the VM to be considered.
431 * \param variable The name of the variable to be considered.
432 * \param value The new value of the variable.
434 * \see TRACE_vm_variable_declare, TRACE_vm_variable_add_with_time, TRACE_vm_variable_sub_with_time
436 void TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value)
438 instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_SET, nullptr, &user_vm_variables);
441 /** \ingroup TRACE_user_variables
442 * \brief Add a value to a variable of a VM at a given timestamp.
444 * Same as #TRACE_vm_variable_add, but let user specify the time used to trace it. Users can specify a time that
445 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
446 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
449 * \param time The timestamp to be used to tag this change of value.
450 * \param vm The name of the VM to be considered.
451 * \param variable The name of the variable to be considered.
452 * \param value The value to be added to the variable.
454 * \see TRACE_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_sub_with_time
456 void TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value)
458 instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_ADD, nullptr, &user_vm_variables);
461 /** \ingroup TRACE_user_variables
462 * \brief Subtract a value from a variable of a VM at a given timestamp.
464 * Same as #TRACE_vm_variable_sub, but let user specify the time used to trace it. Users can specify a time that
465 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
466 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
469 * \param time The timestamp to be used to tag this change of value.
470 * \param vm The name of the VM to be considered.
471 * \param variable The name of the variable to be considered.
472 * \param value The value to be subtracted from the variable.
474 * \see TRACE_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_add_with_time
476 void TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value)
478 instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_SUB, nullptr, &user_vm_variables);
481 /* for host variables */
482 /** \ingroup TRACE_user_variables
483 * \brief Declare a new user variable associated to hosts.
485 * Declare a user variable that will be associated to hosts.
486 * A user host variable can be used to trace user variables such as the number of tasks in a server, the number of
487 * clients in an application (for hosts), and so on. The color associated to this new variable will be random.
489 * \param variable The name of the new variable to be declared.
491 * \see TRACE_host_variable_declare_with_color
493 void TRACE_host_variable_declare (const char *variable)
495 instr_user_variable(0, nullptr, variable, "HOST", 0, INSTR_US_DECLARE, nullptr, &user_host_variables);
498 /** \ingroup TRACE_user_variables
499 * \brief Declare a new user variable associated to hosts with a color.
501 * Same as #TRACE_host_variable_declare, but associated a color to the newly created user host variable. The color
502 * needs to be a string with three numbers separated by spaces in the range [0,1].
503 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
505 * \param variable The name of the new variable to be declared.
506 * \param color The color for the new variable.
508 void TRACE_host_variable_declare_with_color (const char *variable, const char *color)
510 instr_user_variable(0, nullptr, variable, "HOST", 0, INSTR_US_DECLARE, color, &user_host_variables);
513 /** \ingroup TRACE_user_variables
514 * \brief Set the value of a variable of a host.
516 * \param host The name of the host to be considered.
517 * \param variable The name of the variable to be considered.
518 * \param value The new value of the variable.
520 * \see TRACE_host_variable_declare, TRACE_host_variable_add, TRACE_host_variable_sub
522 void TRACE_host_variable_set (const char *host, const char *variable, double value)
524 TRACE_host_variable_set_with_time (MSG_get_clock(), host, variable, value);
527 /** \ingroup TRACE_user_variables
528 * \brief Add a value to a variable of a host.
530 * \param host The name of the host to be considered.
531 * \param variable The name of the variable to be considered.
532 * \param value The value to be added to the variable.
534 * \see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_sub
536 void TRACE_host_variable_add (const char *host, const char *variable, double value)
538 TRACE_host_variable_add_with_time (MSG_get_clock(), host, variable, value);
541 /** \ingroup TRACE_user_variables
542 * \brief Subtract a value from a variable of a host.
544 * \param host The name of the host to be considered.
545 * \param variable The name of the variable to be considered.
546 * \param value The value to be subtracted from the variable.
548 * \see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_add
550 void TRACE_host_variable_sub (const char *host, const char *variable, double value)
552 TRACE_host_variable_sub_with_time (MSG_get_clock(), host, variable, value);
555 /** \ingroup TRACE_user_variables
556 * \brief Set the value of a variable of a host at a given timestamp.
558 * Same as #TRACE_host_variable_set, but let user specify the time used to trace it. Users can specify a time that
559 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
560 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
563 * \param time The timestamp to be used to tag this change of value.
564 * \param host The name of the host to be considered.
565 * \param variable The name of the variable to be considered.
566 * \param value The new value of the variable.
568 * \see TRACE_host_variable_declare, TRACE_host_variable_add_with_time, TRACE_host_variable_sub_with_time
570 void TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value)
572 instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SET, nullptr, &user_host_variables);
575 /** \ingroup TRACE_user_variables
576 * \brief Add a value to a variable of a host at a given timestamp.
578 * Same as #TRACE_host_variable_add, but let user specify the time used to trace it. Users can specify a time that
579 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
580 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
583 * \param time The timestamp to be used to tag this change of value.
584 * \param host The name of the host to be considered.
585 * \param variable The name of the variable to be considered.
586 * \param value The value to be added to the variable.
588 * \see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_sub_with_time
590 void TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value)
592 instr_user_variable(time, host, variable, "HOST", value, INSTR_US_ADD, nullptr, &user_host_variables);
595 /** \ingroup TRACE_user_variables
596 * \brief Subtract a value from a variable of a host at a given timestamp.
598 * Same as #TRACE_host_variable_sub, but let user specify the time used to trace it. Users can specify a time that
599 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
600 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
603 * \param time The timestamp to be used to tag this change of value.
604 * \param host The name of the host to be considered.
605 * \param variable The name of the variable to be considered.
606 * \param value The value to be subtracted from the variable.
608 * \see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_add_with_time
610 void TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value)
612 instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SUB, nullptr, &user_host_variables);
615 /** \ingroup TRACE_user_variables
616 * \brief Get declared user host variables
618 * This function should be used to get host variables that were already declared with #TRACE_host_variable_declare or
619 * with #TRACE_host_variable_declare_with_color.
621 * \return A dynar with the declared host variables, must be freed with xbt_dynar_free.
623 xbt_dynar_t TRACE_get_host_variables ()
625 return instr_set_to_dynar(&user_host_variables);
628 /* for link variables */
629 /** \ingroup TRACE_user_variables
630 * \brief Declare a new user variable associated to links.
632 * Declare a user variable that will be associated to links.
633 * A user link variable can be used, for example, to trace user variables such as the number of messages being
634 * transferred through network links. The color associated to this new variable will be random.
636 * \param variable The name of the new variable to be declared.
638 * \see TRACE_link_variable_declare_with_color
640 void TRACE_link_variable_declare (const char *variable)
642 instr_user_variable(0, nullptr, variable, "LINK", 0, INSTR_US_DECLARE, nullptr, &user_link_variables);
645 /** \ingroup TRACE_user_variables
646 * \brief Declare a new user variable associated to links with a color.
648 * Same as #TRACE_link_variable_declare, but associated a color to the newly created user link variable. The color
649 * needs to be a string with three numbers separated by spaces in the range [0,1].
650 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
652 * \param variable The name of the new variable to be declared.
653 * \param color The color for the new variable.
655 void TRACE_link_variable_declare_with_color (const char *variable, const char *color)
657 instr_user_variable(0, nullptr, variable, "LINK", 0, INSTR_US_DECLARE, color, &user_link_variables);
660 /** \ingroup TRACE_user_variables
661 * \brief Set the value of a variable of a link.
663 * \param link The name of the link to be considered.
664 * \param variable The name of the variable to be considered.
665 * \param value The new value of the variable.
667 * \see TRACE_link_variable_declare, TRACE_link_variable_add, TRACE_link_variable_sub
669 void TRACE_link_variable_set (const char *link, const char *variable, double value)
671 TRACE_link_variable_set_with_time (MSG_get_clock(), link, variable, value);
674 /** \ingroup TRACE_user_variables
675 * \brief Add a value to a variable of a link.
677 * \param link The name of the link to be considered.
678 * \param variable The name of the variable to be considered.
679 * \param value The value to be added to the variable.
681 * \see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_sub
683 void TRACE_link_variable_add (const char *link, const char *variable, double value)
685 TRACE_link_variable_add_with_time (MSG_get_clock(), link, variable, value);
688 /** \ingroup TRACE_user_variables
689 * \brief Subtract a value from a variable of a link.
691 * \param link The name of the link to be considered.
692 * \param variable The name of the variable to be considered.
693 * \param value The value to be subtracted from the variable.
695 * \see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_add
697 void TRACE_link_variable_sub (const char *link, const char *variable, double value)
699 TRACE_link_variable_sub_with_time (MSG_get_clock(), link, variable, value);
702 /** \ingroup TRACE_user_variables
703 * \brief Set the value of a variable of a link at a given timestamp.
705 * Same as #TRACE_link_variable_set, but let user specify the time used to trace it. Users can specify a time that
706 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
707 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
710 * \param time The timestamp to be used to tag this change of value.
711 * \param link The name of the link to be considered.
712 * \param variable The name of the variable to be considered.
713 * \param value The new value of the variable.
715 * \see TRACE_link_variable_declare, TRACE_link_variable_add_with_time, TRACE_link_variable_sub_with_time
717 void TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value)
719 instr_user_variable(time, link, variable, "LINK", value, INSTR_US_SET, nullptr, &user_link_variables);
722 /** \ingroup TRACE_user_variables
723 * \brief Add a value to a variable of a link at a given timestamp.
725 * Same as #TRACE_link_variable_add, but let user specify the time used to trace it. Users can specify a time that
726 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
727 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
730 * \param time The timestamp to be used to tag this change of value.
731 * \param link The name of the link to be considered.
732 * \param variable The name of the variable to be considered.
733 * \param value The value to be added to the variable.
735 * \see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_sub_with_time
737 void TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value)
739 instr_user_variable(time, link, variable, "LINK", value, INSTR_US_ADD, nullptr, &user_link_variables);
742 /** \ingroup TRACE_user_variables
743 * \brief Subtract a value from a variable of a link at a given timestamp.
745 * Same as #TRACE_link_variable_sub, but let user specify the time used to trace it. Users can specify a time that
746 * is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
747 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
750 * \param time The timestamp to be used to tag this change of value.
751 * \param link The name of the link to be considered.
752 * \param variable The name of the variable to be considered.
753 * \param value The value to be subtracted from the variable.
755 * \see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_add_with_time
757 void TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value)
759 instr_user_variable(time, link, variable, "LINK", value, INSTR_US_SUB, nullptr, &user_link_variables);
762 /* for link variables, but with src and dst used for get_route */
763 /** \ingroup TRACE_user_variables
764 * \brief Set the value of the variable present in the links connecting source and destination.
766 * Same as #TRACE_link_variable_set, but instead of providing the name of link to be considered, provide the source
767 * and destination hosts. All links that are part of the route between source and destination will have the variable
768 * set to the provided value.
770 * \param src The name of the source host for get route.
771 * \param dst The name of the destination host for get route.
772 * \param variable The name of the variable to be considered.
773 * \param value The new value of the variable.
775 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add, TRACE_link_srcdst_variable_sub
777 void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value)
779 TRACE_link_srcdst_variable_set_with_time (MSG_get_clock(), src, dst, variable, value);
782 /** \ingroup TRACE_user_variables
783 * \brief Add a value to the variable present in the links connecting source and destination.
785 * Same as #TRACE_link_variable_add, but instead of providing the name of link to be considered, provide the source
786 * and destination hosts. All links that are part of the route between source and destination will have the value
787 * passed as parameter added to the current value of the variable name to be considered.
789 * \param src The name of the source host for get route.
790 * \param dst The name of the destination host for get route.
791 * \param variable The name of the variable to be considered.
792 * \param value The value to be added to the variable.
794 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_sub
796 void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value)
798 TRACE_link_srcdst_variable_add_with_time (MSG_get_clock(), src, dst, variable, value);
801 /** \ingroup TRACE_user_variables
802 * \brief Subtract a value from the variable present in the links connecting source and destination.
804 * Same as #TRACE_link_variable_sub, but instead of providing the name of link to be considered, provide the source
805 * and destination hosts. All links that are part of the route between source and destination will have the value
806 * passed as parameter subtracted from the current value of the variable name to be considered.
808 * \param src The name of the source host for get route.
809 * \param dst The name of the destination host for get route.
810 * \param variable The name of the variable to be considered.
811 * \param value The value to be subtracted from the variable.
813 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_add
815 void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value)
817 TRACE_link_srcdst_variable_sub_with_time (MSG_get_clock(), src, dst, variable, value);
820 /** \ingroup TRACE_user_variables
821 * \brief Set the value of the variable present in the links connecting source and destination at a given timestamp.
823 * Same as #TRACE_link_srcdst_variable_set, but let user specify the time used to trace it. Users can specify a time
824 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
825 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
828 * \param time The timestamp to be used to tag this change of value.
829 * \param src The name of the source host for get route.
830 * \param dst The name of the destination host for get route.
831 * \param variable The name of the variable to be considered.
832 * \param value The new value of the variable.
834 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add_with_time, TRACE_link_srcdst_variable_sub_with_time
836 void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable,
839 instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SET);
842 /** \ingroup TRACE_user_variables
843 * \brief Add a value to the variable present in the links connecting source and destination at a given timestamp.
845 * Same as #TRACE_link_srcdst_variable_add, but let user specify the time used to trace it. Users can specify a time
846 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
847 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
850 * \param time The timestamp to be used to tag this change of value.
851 * \param src The name of the source host for get route.
852 * \param dst The name of the destination host for get route.
853 * \param variable The name of the variable to be considered.
854 * \param value The value to be added to the variable.
856 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_sub_with_time
858 void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable,
861 instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_ADD);
864 /** \ingroup TRACE_user_variables
865 * \brief Subtract a value from the variable present in the links connecting source and dest. at a given timestamp.
867 * Same as #TRACE_link_srcdst_variable_sub, but let user specify the time used to trace it. Users can specify a time
868 * that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time
869 * definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are
872 * \param time The timestamp to be used to tag this change of value.
873 * \param src The name of the source host for get route.
874 * \param dst The name of the destination host for get route.
875 * \param variable The name of the variable to be considered.
876 * \param value The value to be subtracted from the variable.
878 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_add_with_time
880 void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable,
883 instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SUB);
886 /** \ingroup TRACE_user_variables
887 * \brief Get declared user link variables
889 * This function should be used to get link variables that were already declared with #TRACE_link_variable_declare or
890 * with #TRACE_link_variable_declare_with_color.
892 * \return A dynar with the declared link variables, must be freed with xbt_dynar_free.
894 xbt_dynar_t TRACE_get_link_variables ()
896 return instr_set_to_dynar(&user_link_variables);
899 /** \ingroup TRACE_user_variables
900 * \brief Declare a new user state associated to hosts.
902 * Declare a user state that will be associated to hosts.
903 * A user host state can be used to trace application states.
905 * \param state The name of the new state to be declared.
907 * \see TRACE_host_state_declare_value
909 void TRACE_host_state_declare (const char *state)
911 instr_new_user_state_type("HOST", state);
914 /** \ingroup TRACE_user_variables
915 * \brief Declare a new value for a user state associated to hosts.
917 * Declare a value for a state. The color needs to be a string with 3 numbers separated by spaces in the range [0,1].
918 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
920 * \param state The name of the new state to be declared.
921 * \param value The name of the value
922 * \param color The color of the value
924 * \see TRACE_host_state_declare
926 void TRACE_host_state_declare_value (const char *state, const char *value, const char *color)
928 instr_new_value_for_user_state_type (state, value, color);
931 /** \ingroup TRACE_user_variables
932 * \brief Set the user state to the given value.
934 * Change a user state previously declared to the given value.
936 * \param host The name of the host to be considered.
937 * \param state The name of the state previously declared.
938 * \param value The new value of the state.
940 * \see TRACE_host_state_declare, TRACE_host_push_state, TRACE_host_pop_state, TRACE_host_reset_state
942 void TRACE_host_set_state(const char* host, const char* state_name, const char* value_name)
944 container_t container = simgrid::instr::Container::byName(host);
945 simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName(state_name));
946 state->addEntityValue(value_name);
947 new simgrid::instr::SetStateEvent(MSG_get_clock(), container, state, state->getEntityValue(value_name));
950 /** \ingroup TRACE_user_variables
951 * \brief Push a new value for a state of a given host.
953 * Change a user state previously declared by pushing the new value to the state.
955 * \param host The name of the host to be considered.
956 * \param state The name of the state previously declared.
957 * \param value The value to be pushed.
959 * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_pop_state, TRACE_host_reset_state
961 void TRACE_host_push_state(const char* host, const char* state_name, const char* value_name)
963 container_t container = simgrid::instr::Container::byName(host);
964 simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName(state_name));
965 state->addEntityValue(value_name);
966 new simgrid::instr::PushStateEvent(MSG_get_clock(), container, state, state->getEntityValue(value_name));
969 /** \ingroup TRACE_user_variables
970 * \brief Pop the last value of a state of a given host.
972 * Change a user state previously declared by removing the last value of the state.
974 * \param host The name of the host to be considered.
975 * \param state The name of the state to be popped.
977 * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_reset_state
979 void TRACE_host_pop_state (const char *host, const char *state)
981 container_t container = simgrid::instr::Container::byName(host);
982 simgrid::instr::Type* type = container->type_->byName(state);
983 new simgrid::instr::PopStateEvent(MSG_get_clock(), container, type);
986 /** \ingroup TRACE_API
987 * \brief Get Paje container types that can be mapped to the nodes of a graph.
989 * This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the
990 * functions defined in \ref TRACE_user_variables.
992 * \return A dynar with the types, must be freed with xbt_dynar_free.
994 xbt_dynar_t TRACE_get_node_types ()
996 return instr_set_to_dynar(&trivaNodeTypes);
999 /** \ingroup TRACE_API
1000 * \brief Get Paje container types that can be mapped to the edges of a graph.
1002 * This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the
1003 * functions defined in \ref TRACE_user_variables.
1005 * \return A dynar with the types, must be freed with xbt_dynar_free.
1007 xbt_dynar_t TRACE_get_edge_types ()
1009 return instr_set_to_dynar(&trivaEdgeTypes);