1 /* Copyright (c) 2010. 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"
10 #include "instr/instr_private.h"
11 #include "surf/network_private.h"
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
22 xbt_dict_t created_categories = NULL;
23 xbt_dict_t declared_marks = NULL;
24 xbt_dict_t user_host_variables = NULL;
25 xbt_dict_t user_link_variables = NULL;
26 extern xbt_dict_t trivaNodeTypes;
27 extern xbt_dict_t trivaEdgeTypes;
29 static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter)
31 if (!TRACE_is_enabled()) return NULL;
32 if (!TRACE_needs_platform()) return NULL;
34 xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
35 xbt_dict_cursor_t cursor = NULL;
37 xbt_dict_foreach(filter, cursor, name, value) {
38 xbt_dynar_push_as (ret, char*, xbt_strdup(name));
43 /** \ingroup TRACE_category
44 * \brief Declare a new category with a random color.
46 * This function should be used to define a user category. The
47 * category can be used to differentiate the tasks that are created
48 * during the simulation (for example, tasks from server1, server2,
49 * or request tasks, computation tasks, communication tasks). All
50 * resource utilization (host power and link bandwidth) will be
51 * classified according to the task category. Tasks that do not
52 * belong to a category are not traced. The color for the category
53 * that is being declared is random. This function has no effect
54 * if a category with the same name has been already declared.
56 * See \ref tracing_tracing for details on how to trace
57 * the (categorized) resource utilization.
59 * \param category The name of the new tracing category to be created.
61 * \see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
63 void TRACE_category(const char *category)
65 TRACE_category_with_color (category, NULL);
68 /** \ingroup TRACE_category
69 * \brief Declare a new category with a color.
71 * Same as #TRACE_category, but let user specify a color encoded as a
72 * RGB-like string with three floats from 0 to 1. So, to specify a
73 * red color, pass "1 0 0" as color parameter. A light-gray color
74 * can be specified using "0.7 0.7 0.7" as color. This function has
75 * no effect if a category with the same name has been already declared.
77 * See \ref tracing_tracing for details on how to trace
78 * the (categorized) resource utilization.
80 * \param category The name of the new tracing category to be created.
81 * \param color The color of the category (see \ref tracing_tracing to
82 * know how to correctly specify the color)
84 * \see MSG_task_set_category, SD_task_set_category
86 void TRACE_category_with_color (const char *category, const char *color)
89 if (!TRACE_is_enabled()) return;
91 if (!(TRACE_categorized() && category != NULL)) return;
93 /* if platform is not traced, we can't deal with categories */
94 if (!TRACE_needs_platform()) return;
96 //check if category is already created
97 char *created = xbt_dict_get_or_null(created_categories, category);
99 xbt_dict_set (created_categories, category, xbt_strdup("1"), NULL);
102 char final_color[INSTR_DEFAULT_STR_SIZE];
104 //generate a random color
105 double red = drand48();
106 double green = drand48();
107 double blue = drand48();
108 snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", red, green, blue);
110 snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color);
113 XBT_DEBUG("CAT,declare %s, %s", category, final_color);
115 //define the type of this category on top of hosts and links
116 instr_new_variable_type (category, final_color);
120 /** \ingroup TRACE_category
121 * \brief Get declared categories
123 * This function should be used to get categories that were already
124 * declared with #TRACE_category or with #TRACE_category_with_color.
126 * See \ref tracing_tracing for details on how to trace
127 * the (categorized) resource utilization.
129 * \return A dynar with the declared categories, must be freed with xbt_dynar_free.
131 * \see MSG_task_set_category, SD_task_set_category
133 xbt_dynar_t TRACE_get_categories (void)
135 if (!TRACE_is_enabled()) return NULL;
136 if (!TRACE_categorized()) return NULL;
138 return instr_dict_to_dynar (created_categories);
141 /** \ingroup TRACE_mark
142 * \brief Declare a new type for tracing mark.
144 * This function declares a new Paje event
145 * type in the trace file that can be used by
146 * simulators to declare application-level
147 * marks. This function is independent of
148 * which API is used in SimGrid.
150 * \param mark_type The name of the new type.
154 void TRACE_declare_mark(const char *mark_type)
157 if (!TRACE_is_enabled()) return;
159 /* if platform is not traced, we don't allow marks */
160 if (!TRACE_needs_platform()) return;
162 if (!mark_type) THROWF (tracing_error, 1, "mark_type is NULL");
164 //check if mark_type is already declared
165 char *created = xbt_dict_get_or_null(declared_marks, mark_type);
167 THROWF (tracing_error, 1, "mark_type with name (%s) is already declared", mark_type);
170 XBT_DEBUG("MARK,declare %s", mark_type);
171 PJ_type_event_new(mark_type, NULL, PJ_type_get_root());
172 xbt_dict_set (declared_marks, mark_type, xbt_strdup("1"), NULL);
176 /** \ingroup TRACE_mark
177 * \brief Declare a new value for a previously declared mark type.
179 * This function declares a new value for a Paje event
180 * type in the trace file that can be used by
181 * simulators to declare application-level
182 * marks. This function is independent of
183 * which API is used in SimGrid.
185 * \param mark_type The name of the new type.
186 * \param mark_value The name of the new value for this type.
190 void TRACE_declare_mark_value (const char *mark_type, const char *mark_value)
193 if (!TRACE_is_enabled()) return;
195 /* if platform is not traced, we don't allow marks */
196 if (!TRACE_needs_platform()) return;
198 if (!mark_type) THROWF (tracing_error, 1, "mark_type is NULL");
199 if (!mark_value) THROWF (tracing_error, 1, "mark_value is NULL");
201 type_t type = PJ_type_get (mark_type, PJ_type_get_root());
203 THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
206 XBT_DEBUG("MARK,declare_value %s %s", mark_type, mark_value);
207 PJ_value_new (mark_value, NULL, type);
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
215 * first parameter had to be previously declared using
216 * #TRACE_declare_mark, the second is the identifier
217 * for this mark instance. We recommend that the
218 * mark_value is a unique value for the whole simulation.
219 * Nevertheless, this is not a strong requirement: the
220 * trace will be valid even if there are multiple mark
221 * identifiers for the same trace.
223 * \param mark_type The name of the type for which the new instance will belong.
224 * \param mark_value The name of the new instance mark.
226 * \see TRACE_declare_mark
228 void TRACE_mark(const char *mark_type, const char *mark_value)
231 if (!TRACE_is_enabled()) return;
233 /* if platform is not traced, we don't allow marks */
234 if (!TRACE_needs_platform()) return;
236 if (!mark_type) THROWF (tracing_error, 1, "mark_type is NULL");
237 if (!mark_value) THROWF (tracing_error, 1, "mark_value is NULL");
239 //check if mark_type is already declared
240 type_t type = PJ_type_get (mark_type, PJ_type_get_root());
242 THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
245 val_t value = PJ_value_get (mark_value, type);
246 XBT_DEBUG("MARK %s %s", mark_type, mark_value);
247 new_pajeNewEvent (MSG_get_clock(), PJ_container_get_root(), type, value);
250 /** \ingroup TRACE_mark
251 * \brief Get declared marks
253 * This function should be used to get marks that were already
254 * declared with #TRACE_declare_mark.
256 * \return A dynar with the declared marks, must be freed with xbt_dynar_free.
259 xbt_dynar_t TRACE_get_marks (void)
261 if (!TRACE_is_enabled()) return NULL;
263 return instr_dict_to_dynar (declared_marks);
266 static void instr_user_variable(double time,
267 const char *resource,
268 const char *variable,
269 const char *father_type,
271 InstrUserVariable what,
276 if (!TRACE_is_enabled()) return;
278 /* if platform is not traced, we don't allow user variables */
279 if (!TRACE_needs_platform()) return;
281 //check if variable is already declared
282 char *created = xbt_dict_get_or_null(filter, variable);
283 if (what == INSTR_US_DECLARE){
288 xbt_dict_set (filter, variable, xbt_strdup("1"), NULL);
292 //not declared, ignore
298 snprintf(valuestr, 100, "%g", value);
301 case INSTR_US_DECLARE:
302 instr_new_user_variable_type (father_type, variable, color);
306 container_t container = PJ_container_get(resource);
307 type_t type = PJ_type_get (variable, container->type);
308 new_pajeSetVariable(time, container, type, value);
313 container_t container = PJ_container_get(resource);
314 type_t type = PJ_type_get (variable, container->type);
315 new_pajeAddVariable(time, container, type, value);
320 container_t container = PJ_container_get(resource);
321 type_t type = PJ_type_get (variable, container->type);
322 new_pajeSubVariable(time, container, type, value);
326 //TODO: launch exception
331 static void instr_user_srcdst_variable(double time,
334 const char *variable,
335 const char *father_type,
337 InstrUserVariable what)
339 xbt_dynar_t route=NULL;
340 sg_routing_edge_t src_elm = sg_routing_edge_by_name_or_null(src);
341 if(!src_elm) xbt_die("Element '%s' not found!",src);
343 sg_routing_edge_t dst_elm = sg_routing_edge_by_name_or_null(dst);
344 if(!dst_elm) xbt_die("Element '%s' not found!",dst);
346 routing_get_route_and_latency (src_elm, dst_elm, &route,NULL);
349 xbt_dynar_foreach (route, i, link) {
350 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
351 instr_user_variable (time, link_name, variable, father_type, value, what, NULL, user_link_variables);
355 /** \ingroup TRACE_API
356 * \brief Creates a file with the topology of the platform file used for the simulator.
358 * The graph topology will have the following properties: all hosts, links and routers
359 * of the platform file are mapped to graph nodes; routes are mapped to edges.
360 * The platform's AS are not represented in the output.
362 * \param filename The name of the file that will hold the graph.
364 * \return 1 of successful, 0 otherwise.
366 int TRACE_platform_graph_export_graphviz (const char *filename)
368 /* returns 1 if successful, 0 otherwise */
369 if (!TRACE_is_enabled()) return 0;
370 xbt_graph_t g = instr_routing_platform_graph();
371 if (g == NULL) return 0;
372 instr_routing_platform_graph_export_graphviz (g, filename);
373 xbt_graph_free_graph (g, xbt_free, xbt_free, NULL);
378 * Derived functions that use instr_user_variable and TRACE_user_srcdst_variable.
379 * They were previously defined as pre-processors directives, but were transformed
380 * into functions so the user can track them using gdb.
383 /* for host variables */
384 /** \ingroup TRACE_user_variables
385 * \brief Declare a new user variable associated to hosts.
387 * Declare a user variable that will be associated to hosts.
388 * A user host variable can be used to trace user variables
389 * such as the number of tasks in a server, the number of
390 * clients in an application (for hosts), and so on. The color
391 * associated to this new variable will be random.
393 * \param variable The name of the new variable to be declared.
395 * \see TRACE_host_variable_declare_with_color
397 void TRACE_host_variable_declare (const char *variable)
399 instr_user_variable(0, NULL, variable, "HOST", 0, INSTR_US_DECLARE, NULL, user_host_variables);
402 /** \ingroup TRACE_user_variables
403 * \brief Declare a new user variable associated to hosts with a color.
405 * Same as #TRACE_host_variable_declare, but associated a color
406 * to the newly created user host variable. The color needs to be
407 * a string with three numbers separated by spaces in the range [0,1].
408 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
410 * \param variable The name of the new variable to be declared.
411 * \param color The color for the new variable.
414 void TRACE_host_variable_declare_with_color (const char *variable, const char *color)
416 instr_user_variable(0, NULL, variable, "HOST", 0, INSTR_US_DECLARE, color, user_host_variables);
419 /** \ingroup TRACE_user_variables
420 * \brief Set the value of a variable of a host.
422 * \param host The name of the host to be considered.
423 * \param variable The name of the variable to be considered.
424 * \param value The new value of the variable.
426 * \see TRACE_host_variable_declare, TRACE_host_variable_add, TRACE_host_variable_sub
428 void TRACE_host_variable_set (const char *host, const char *variable, double value)
430 TRACE_host_variable_set_with_time (MSG_get_clock(), host, variable, value);
433 /** \ingroup TRACE_user_variables
434 * \brief Add a value to a variable of a host.
436 * \param host The name of the host to be considered.
437 * \param variable The name of the variable to be considered.
438 * \param value The value to be added to the variable.
440 * \see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_sub
442 void TRACE_host_variable_add (const char *host, const char *variable, double value)
444 TRACE_host_variable_add_with_time (MSG_get_clock(), host, variable, value);
447 /** \ingroup TRACE_user_variables
448 * \brief Subtract a value from a variable of a host.
450 * \param host The name of the host to be considered.
451 * \param variable The name of the variable to be considered.
452 * \param value The value to be subtracted from the variable.
454 * \see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_add
456 void TRACE_host_variable_sub (const char *host, const char *variable, double value)
458 TRACE_host_variable_sub_with_time (MSG_get_clock(), host, variable, value);
461 /** \ingroup TRACE_user_variables
462 * \brief Set the value of a variable of a host at a given timestamp.
464 * Same as #TRACE_host_variable_set, but let user specify
465 * the time used to trace it. Users can specify a time that
466 * is not the simulated clock time as defined by the core
467 * simulator. This allows a fine-grain control of time
468 * definition, but should be used with caution since the trace
469 * can be inconsistent if resource utilization traces are also traced.
471 * \param time The timestamp to be used to tag this change of value.
472 * \param host The name of the host to be considered.
473 * \param variable The name of the variable to be considered.
474 * \param value The new value of the variable.
476 * \see TRACE_host_variable_declare, TRACE_host_variable_add_with_time, TRACE_host_variable_sub_with_time
478 void TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value)
480 instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SET, NULL, user_host_variables);
483 /** \ingroup TRACE_user_variables
484 * \brief Add a value to a variable of a host at a given timestamp.
486 * Same as #TRACE_host_variable_add, but let user specify
487 * the time used to trace it. Users can specify a time that
488 * is not the simulated clock time as defined by the core
489 * simulator. This allows a fine-grain control of time
490 * definition, but should be used with caution since the trace
491 * can be inconsistent if resource utilization traces are also traced.
493 * \param time The timestamp to be used to tag this change of value.
494 * \param host The name of the host to be considered.
495 * \param variable The name of the variable to be considered.
496 * \param value The value to be added to the variable.
498 * \see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_sub_with_time
500 void TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value)
502 instr_user_variable(time, host, variable, "HOST", value, INSTR_US_ADD, NULL, user_host_variables);
505 /** \ingroup TRACE_user_variables
506 * \brief Subtract a value from a variable of a host at a given timestamp.
508 * Same as #TRACE_host_variable_sub, but let user specify
509 * the time used to trace it. Users can specify a time that
510 * is not the simulated clock time as defined by the core
511 * simulator. This allows a fine-grain control of time
512 * definition, but should be used with caution since the trace
513 * can be inconsistent if resource utilization traces are also traced.
515 * \param time The timestamp to be used to tag this change of value.
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 value to be subtracted from the variable.
520 * \see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_add_with_time
522 void TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value)
524 instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SUB, NULL, user_host_variables);
527 /** \ingroup TRACE_user_variables
528 * \brief Get declared user host variables
530 * This function should be used to get host variables that were already
531 * declared with #TRACE_host_variable_declare or with #TRACE_host_variable_declare_with_color.
533 * \return A dynar with the declared host variables, must be freed with xbt_dynar_free.
535 xbt_dynar_t TRACE_get_host_variables (void)
537 return instr_dict_to_dynar (user_host_variables);
540 /* for link variables */
541 /** \ingroup TRACE_user_variables
542 * \brief Declare a new user variable associated to links.
544 * Declare a user variable that will be associated to links.
545 * A user link variable can be used, for example, to trace
546 * user variables such as the number of messages being
547 * transferred through network links. The color
548 * associated to this new variable will be random.
550 * \param variable The name of the new variable to be declared.
552 * \see TRACE_link_variable_declare_with_color
554 void TRACE_link_variable_declare (const char *variable)
556 instr_user_variable (0, NULL, variable, "LINK", 0, INSTR_US_DECLARE, NULL, user_link_variables);
559 /** \ingroup TRACE_user_variables
560 * \brief Declare a new user variable associated to links with a color.
562 * Same as #TRACE_link_variable_declare, but associated a color
563 * to the newly created user link variable. The color needs to be
564 * a string with three numbers separated by spaces in the range [0,1].
565 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
567 * \param variable The name of the new variable to be declared.
568 * \param color The color for the new variable.
571 void TRACE_link_variable_declare_with_color (const char *variable, const char *color)
573 instr_user_variable (0, NULL, variable, "LINK", 0, INSTR_US_DECLARE, color, user_link_variables);
576 /** \ingroup TRACE_user_variables
577 * \brief Set the value of a variable of a link.
579 * \param link The name of the link to be considered.
580 * \param variable The name of the variable to be considered.
581 * \param value The new value of the variable.
583 * \see TRACE_link_variable_declare, TRACE_link_variable_add, TRACE_link_variable_sub
585 void TRACE_link_variable_set (const char *link, const char *variable, double value)
587 TRACE_link_variable_set_with_time (MSG_get_clock(), link, variable, value);
590 /** \ingroup TRACE_user_variables
591 * \brief Add a value to a variable of a link.
593 * \param link The name of the link to be considered.
594 * \param variable The name of the variable to be considered.
595 * \param value The value to be added to the variable.
597 * \see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_sub
599 void TRACE_link_variable_add (const char *link, const char *variable, double value)
601 TRACE_link_variable_add_with_time (MSG_get_clock(), link, variable, value);
604 /** \ingroup TRACE_user_variables
605 * \brief Subtract a value from a variable of a link.
607 * \param link The name of the link to be considered.
608 * \param variable The name of the variable to be considered.
609 * \param value The value to be subtracted from the variable.
611 * \see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_add
613 void TRACE_link_variable_sub (const char *link, const char *variable, double value)
615 TRACE_link_variable_sub_with_time (MSG_get_clock(), link, variable, value);
618 /** \ingroup TRACE_user_variables
619 * \brief Set the value of a variable of a link at a given timestamp.
621 * Same as #TRACE_link_variable_set, but let user specify
622 * the time used to trace it. Users can specify a time that
623 * is not the simulated clock time as defined by the core
624 * simulator. This allows a fine-grain control of time
625 * definition, but should be used with caution since the trace
626 * can be inconsistent if resource utilization traces are also traced.
628 * \param time The timestamp to be used to tag this change of value.
629 * \param link The name of the link to be considered.
630 * \param variable The name of the variable to be considered.
631 * \param value The new value of the variable.
633 * \see TRACE_link_variable_declare, TRACE_link_variable_add_with_time, TRACE_link_variable_sub_with_time
635 void TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value)
637 instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SET, NULL, user_link_variables);
640 /** \ingroup TRACE_user_variables
641 * \brief Add a value to a variable of a link at a given timestamp.
643 * Same as #TRACE_link_variable_add, but let user specify
644 * the time used to trace it. Users can specify a time that
645 * is not the simulated clock time as defined by the core
646 * simulator. This allows a fine-grain control of time
647 * definition, but should be used with caution since the trace
648 * can be inconsistent if resource utilization traces are also traced.
650 * \param time The timestamp to be used to tag this change of value.
651 * \param link The name of the link to be considered.
652 * \param variable The name of the variable to be considered.
653 * \param value The value to be added to the variable.
655 * \see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_sub_with_time
657 void TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value)
659 instr_user_variable (time, link, variable, "LINK", value, INSTR_US_ADD, NULL, user_link_variables);
662 /** \ingroup TRACE_user_variables
663 * \brief Subtract a value from a variable of a link at a given timestamp.
665 * Same as #TRACE_link_variable_sub, but let user specify
666 * the time used to trace it. Users can specify a time that
667 * is not the simulated clock time as defined by the core
668 * simulator. This allows a fine-grain control of time
669 * definition, but should be used with caution since the trace
670 * can be inconsistent if resource utilization traces are also traced.
672 * \param time The timestamp to be used to tag this change of value.
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 subtracted from the variable.
677 * \see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_add_with_time
679 void TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value)
681 instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SUB, NULL, user_link_variables);
684 /* for link variables, but with src and dst used for get_route */
685 /** \ingroup TRACE_user_variables
686 * \brief Set the value of the variable present in the links connecting source and destination.
688 * Same as #TRACE_link_variable_set, but instead of providing the
689 * name of link to be considered, provide the source and destination
690 * hosts. All links that are part of the route between source and
691 * destination will have the variable set to the provided value.
693 * \param src The name of the source host for get route.
694 * \param dst The name of the destination host for get route.
695 * \param variable The name of the variable to be considered.
696 * \param value The new value of the variable.
698 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add, TRACE_link_srcdst_variable_sub
700 void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value)
702 TRACE_link_srcdst_variable_set_with_time (MSG_get_clock(), src, dst, variable, value);
705 /** \ingroup TRACE_user_variables
706 * \brief Add a value to the variable present in the links connecting source and destination.
708 * Same as #TRACE_link_variable_add, but instead of providing the
709 * name of link to be considered, provide the source and destination
710 * hosts. All links that are part of the route between source and
711 * destination will have the value passed as parameter added to
712 * the current value of the variable name to be considered.
714 * \param src The name of the source host for get route.
715 * \param dst The name of the destination host for get route.
716 * \param variable The name of the variable to be considered.
717 * \param value The value to be added to the variable.
719 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_sub
721 void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value)
723 TRACE_link_srcdst_variable_add_with_time (MSG_get_clock(), src, dst, variable, value);
726 /** \ingroup TRACE_user_variables
727 * \brief Subtract a value from the variable present in the links connecting source and destination.
729 * Same as #TRACE_link_variable_sub, but instead of providing the
730 * name of link to be considered, provide the source and destination
731 * hosts. All links that are part of the route between source and
732 * destination will have the value passed as parameter subtracted from
733 * the current value of the variable name to be considered.
735 * \param src The name of the source host for get route.
736 * \param dst The name of the destination host for get route.
737 * \param variable The name of the variable to be considered.
738 * \param value The value to be subtracted from the variable.
740 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_add
742 void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value)
744 TRACE_link_srcdst_variable_sub_with_time (MSG_get_clock(), src, dst, variable, value);
747 /** \ingroup TRACE_user_variables
748 * \brief Set the value of the variable present in the links connecting source and destination at a given timestamp.
750 * Same as #TRACE_link_srcdst_variable_set, but let user specify
751 * the time used to trace it. Users can specify a time that
752 * is not the simulated clock time as defined by the core
753 * simulator. This allows a fine-grain control of time
754 * definition, but should be used with caution since the trace
755 * can be inconsistent if resource utilization traces are also traced.
757 * \param time The timestamp to be used to tag this change of value.
758 * \param src The name of the source host for get route.
759 * \param dst The name of the destination host for get route.
760 * \param variable The name of the variable to be considered.
761 * \param value The new value of the variable.
763 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add_with_time, TRACE_link_srcdst_variable_sub_with_time
765 void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value)
767 instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SET);
770 /** \ingroup TRACE_user_variables
771 * \brief Add a value to the variable present in the links connecting source and destination at a given timestamp.
773 * Same as #TRACE_link_srcdst_variable_add, but let user specify
774 * the time used to trace it. Users can specify a time that
775 * is not the simulated clock time as defined by the core
776 * simulator. This allows a fine-grain control of time
777 * definition, but should be used with caution since the trace
778 * can be inconsistent if resource utilization traces are also traced.
780 * \param time The timestamp to be used to tag this change of value.
781 * \param src The name of the source host for get route.
782 * \param dst The name of the destination host for get route.
783 * \param variable The name of the variable to be considered.
784 * \param value The value to be added to the variable.
786 * \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_sub_with_time
788 void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value)
790 instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_ADD);
793 /** \ingroup TRACE_user_variables
794 * \brief Subtract a value from the variable present in the links connecting source and destination at a given timestamp.
796 * Same as #TRACE_link_srcdst_variable_sub, but let user specify
797 * the time used to trace it. Users can specify a time that
798 * is not the simulated clock time as defined by the core
799 * simulator. This allows a fine-grain control of time
800 * definition, but should be used with caution since the trace
801 * can be inconsistent if resource utilization traces are also traced.
803 * \param time The timestamp to be used to tag this change of value.
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_with_time, TRACE_link_srcdst_variable_add_with_time
811 void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value)
813 instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SUB);
816 /** \ingroup TRACE_user_variables
817 * \brief Get declared user link variables
819 * This function should be used to get link variables that were already
820 * declared with #TRACE_link_variable_declare or with #TRACE_link_variable_declare_with_color.
822 * \return A dynar with the declared link variables, must be freed with xbt_dynar_free.
824 xbt_dynar_t TRACE_get_link_variables (void)
826 return instr_dict_to_dynar (user_link_variables);
829 /** \ingroup TRACE_user_variables
830 * \brief Declare a new user state associated to hosts.
832 * Declare a user state that will be associated to hosts.
833 * A user host state can be used to trace application states.
835 * \param state The name of the new state to be declared.
837 * \see TRACE_host_state_declare_value
839 void TRACE_host_state_declare (const char *state)
841 instr_new_user_state_type("HOST", state);
844 /** \ingroup TRACE_user_variables
845 * \brief Declare a new value for a user state associated to hosts.
847 * Declare a value for a state. The color needs to be
848 * a string with three numbers separated by spaces in the range [0,1].
849 * A light-gray color can be specified using "0.7 0.7 0.7" as color.
851 * \param state The name of the new state to be declared.
852 * \param value The name of the value
853 * \param color The color of the value
855 * \see TRACE_host_state_declare
857 void TRACE_host_state_declare_value (const char *state, const char *value, const char *color)
859 instr_new_value_for_user_state_type (state, value, color);
862 /** \ingroup TRACE_user_variables
863 * \brief Set the user state to the given value.
865 * Change a user state previously declared to the given value.
867 * \param host The name of the host to be considered.
868 * \param state The name of the state previously declared.
869 * \param value The new value of the state.
871 * \see TRACE_host_state_declare, TRACE_host_push_state, TRACE_host_pop_state, TRACE_host_reset_state
873 void TRACE_host_set_state (const char *host, const char *state, const char *value)
875 container_t container = PJ_container_get(host);
876 type_t type = PJ_type_get (state, container->type);
877 val_t val = PJ_value_get_or_new (value, NULL, type); /* if user didn't declare a value with a color, user a NULL color */
878 new_pajeSetState(MSG_get_clock(), container, type, val);
881 /** \ingroup TRACE_user_variables
882 * \brief Push a new value for a state of a given host.
884 * Change a user state previously declared by pushing the new value to the state.
886 * \param host The name of the host to be considered.
887 * \param state The name of the state previously declared.
888 * \param value The value to be pushed.
890 * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_pop_state, TRACE_host_reset_state
892 void TRACE_host_push_state (const char *host, const char *state, const char *value)
894 container_t container = PJ_container_get(host);
895 type_t type = PJ_type_get (state, container->type);
896 val_t val = PJ_value_get_or_new (value, NULL, type); /* if user didn't declare a value with a color, user a NULL color */
897 new_pajePushState(MSG_get_clock(), container, type, val);
900 /** \ingroup TRACE_user_variables
901 * \brief Pop the last value of a state of a given host.
903 * Change a user state previously declared by removing the last value of the state.
905 * \param host The name of the host to be considered.
906 * \param state The name of the state to be popped.
908 * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_reset_state
910 void TRACE_host_pop_state (const char *host, const char *state)
912 container_t container = PJ_container_get(host);
913 type_t type = PJ_type_get (state, container->type);
914 new_pajePopState(MSG_get_clock(), container, type);
917 /** \ingroup TRACE_user_variables
918 * \brief Reset the state of a given host.
920 * Clear all previous values of a user state.
922 * \param host The name of the host to be considered.
923 * \param state The name of the state to be cleared.
925 * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_pop_state
927 void TRACE_host_reset_state (const char *host, const char *state)
929 container_t container = PJ_container_get(host);
930 type_t type = PJ_type_get (state, container->type);
931 new_pajeResetState(MSG_get_clock(), container, type);
934 /** \ingroup TRACE_API
935 * \brief Get Paje container types that can be mapped to the nodes of a graph.
937 * This function can be used to create a user made
938 * graph configuration file for Triva. Normally, it is
939 * used with the functions defined in \ref TRACE_user_variables.
941 * \return A dynar with the types, must be freed with xbt_dynar_free.
943 xbt_dynar_t TRACE_get_node_types (void)
945 return instr_dict_to_dynar (trivaNodeTypes);
948 /** \ingroup TRACE_API
949 * \brief Get Paje container types that can be mapped to the edges of a graph.
951 * This function can be used to create a user made
952 * graph configuration file for Triva. Normally, it is
953 * used with the functions defined in \ref TRACE_user_variables.
955 * \return A dynar with the types, must be freed with xbt_dynar_free.
957 xbt_dynar_t TRACE_get_edge_types (void)
959 return instr_dict_to_dynar (trivaEdgeTypes);
962 #endif /* HAVE_TRACING */