X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f662ce711906542b692b60585abd0946866e649b..926d5ddef86348602520f2a40cb5764306aa24c1:/src/instr/instr_interface.c

diff --git a/src/instr/instr_interface.c b/src/instr/instr_interface.c
index 5f137acc1b..5532a6b276 100644
--- a/src/instr/instr_interface.c
+++ b/src/instr/instr_interface.c
@@ -7,242 +7,704 @@
 #include "simgrid_config.h"
 
 #ifdef HAVE_TRACING
-
 #include "instr/instr_private.h"
+#include "surf/network_private.h"
+
+typedef enum {
+  INSTR_US_DECLARE,
+  INSTR_US_SET,
+  INSTR_US_ADD,
+  INSTR_US_SUB
+} InstrUserVariable;
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
+
+xbt_dict_t created_categories = NULL;
+/** \ingroup TRACE_category
+ *  \brief Declare a new category with a random color.
+ *
+ *  This function should be used to define a user category. The
+ *  category can be used to differentiate the tasks that are created
+ *  during the simulation (for example, tasks from server1, server2,
+ *  or request tasks, computation tasks, communication tasks). All
+ *  resource utilization (host power and link bandwidth) will be
+ *  classified according to the task category. Tasks that do not
+ *  belong to a category are not traced. The color for the category
+ *  that is being declared is random. This function has no effect
+ *  if a category with the same name has been already declared.
+ *
+ * See \ref tracing_tracing for details on how to trace
+ * the (categorized) resource utilization.
+ *
+ *  \param category The name of the new tracing category to be created.
+ *
+ *  \see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
+ */
+void TRACE_category(const char *category)
+{
+  TRACE_category_with_color (category, NULL);
+}
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(tracing, "Tracing Interface");
+/** \ingroup TRACE_category
+ *  \brief Declare a new category with a color.
+ *
+ *  Same as #TRACE_category, but let user specify a color encoded as a
+ *  RGB-like string with three floats from 0 to 1. 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" as color. This function has
+ *  no effect if a category with the same name has been already declared.
+ *
+ * See \ref tracing_tracing for details on how to trace
+ * the (categorized) resource utilization.
+ *
+ *  \param category The name of the new tracing category to be created.
+ *  \param color The color of the category (see \ref tracing_tracing to
+ *  know how to correctly specify the color)
+ *
+ *  \see MSG_task_set_category, SD_task_set_category
+ */
+void TRACE_category_with_color (const char *category, const char *color)
+{
+  /* safe switch */
+  if (!TRACE_is_enabled()) return;
 
-static xbt_dict_t defined_types;
-static xbt_dict_t created_categories;
+  if (!(TRACE_categorized() && category != NULL)) return;
 
-int TRACE_start()
-{
-  // tracing system must be:
-  //    - enabled (with --cfg=tracing:1)
-  //    - already configured (TRACE_global_init already called)
-  if (!(TRACE_is_enabled() && TRACE_is_configured())){
-    return 0;
-  }
+  /* if platform is not traced, we can't deal with categories */
+  if (!TRACE_needs_platform()) return;
 
-  /* open the trace file */
-  TRACE_paje_start();
-
-  /* activate trace */
-  TRACE_activate ();
-
-  /* output header */
-  TRACE_paje_create_header();
-
-  /* define paje hierarchy for tracing */
-  pajeDefineContainerType("PLATFORM", "0", "platform");
-  pajeDefineContainerType("HOST", "PLATFORM", "HOST");
-  pajeDefineContainerType("LINK", "PLATFORM", "LINK");
-  pajeDefineVariableType("power", "HOST", "power");
-  pajeDefineVariableType("bandwidth", "LINK", "bandwidth");
-  pajeDefineVariableType("latency", "LINK", "latency");
-  pajeDefineEventType("source", "LINK", "source");
-  pajeDefineEventType("destination", "LINK", "destination");
-
-  if (TRACE_platform_is_enabled()) {
-    if (TRACE_uncategorized()){
-      pajeDefineVariableType("power_used", "HOST", "power_used");
-      pajeDefineVariableType("bandwidth_used", "LINK", "bandwidth_used");
-    }
-  }
+  //check if category is already created
+  char *created = xbt_dict_get_or_null(created_categories, category);
+  if (created) return;
+  xbt_dict_set (created_categories, category, xbt_strdup("1"), NULL);
 
-  if (TRACE_msg_process_is_enabled() || TRACE_msg_volume_is_enabled()) {
-    //processes grouped by host
-    pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
+  //define final_color
+  char final_color[INSTR_DEFAULT_STR_SIZE];
+  if (!color){
+    //generate a random color
+    double red = drand48();
+    double green = drand48();
+    double blue = drand48();
+    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", red, green, blue);
+  }else{
+    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color);
   }
 
-  if (TRACE_msg_process_is_enabled()) {
-    pajeDefineStateType("category", "PROCESS", "category");
-    pajeDefineStateType("presence", "PROCESS", "presence");
+  XBT_DEBUG("CAT,declare %s, %s", category, final_color);
+
+  //define the type of this category on top of hosts and links
+  instr_new_variable_type (category, final_color);
+}
+
+
+/** \ingroup TRACE_category
+ *  \brief Get declared categories
+ *
+ * This function should be used to get categories that were already
+ * declared with #TRACE_category or with #TRACE_category_with_color.
+ *
+ * See \ref tracing_tracing for details on how to trace
+ * the (categorized) resource utilization.
+ *
+ * \return A dynar with the declared categories, must be freed with xbt_dynar_free.
+ *
+ *  \see MSG_task_set_category, SD_task_set_category
+ */
+xbt_dynar_t TRACE_get_categories (void)
+{
+  if (!TRACE_is_enabled()) return NULL;
+  if (!TRACE_categorized()) return NULL;
+
+  xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
+  xbt_dict_cursor_t cursor = NULL;
+  char *name, *value;
+  xbt_dict_foreach(created_categories, cursor, name, value) {
+    xbt_dynar_push_as (ret, char*, xbt_strdup(name));
   }
+  return ret;
+}
 
-  if (TRACE_msg_volume_is_enabled()) {
-    pajeDefineLinkType("volume", "0", "PROCESS", "PROCESS", "volume");
+/** \ingroup TRACE_mark
+ * \brief Declare a new type for tracing mark.
+ *
+ * This function declares a new Paje event
+ * type in the trace file that can be used by
+ * simulators to declare application-level
+ * marks. This function is independent of
+ * which API is used in SimGrid.
+ *
+ * \param mark_type The name of the new type.
+ *
+ * \see TRACE_mark
+ */
+void TRACE_declare_mark(const char *mark_type)
+{
+  /* safe switch */
+  if (!TRACE_is_enabled()) return;
+
+  if (!mark_type) return;
+
+  XBT_DEBUG("MARK,declare %s", mark_type);
+  PJ_type_event_new(mark_type, NULL, PJ_type_get_root());
+}
+
+/**
+ * \ingroup TRACE_mark
+ * \brief Create a new instance of a tracing mark type.
+ *
+ * This function creates a mark in the trace file. The
+ * first parameter had to be previously declared using
+ * #TRACE_declare_mark, the second is the identifier
+ * for this mark instance. We recommend that the
+ * mark_value is a unique value for the whole simulation.
+ * Nevertheless, this is not a strong requirement: the
+ * trace will be valid even if there are multiple mark
+ * identifiers for the same trace.
+ *
+ * \param mark_type The name of the type for which the new instance will belong.
+ * \param mark_value The name of the new instance mark.
+ *
+ * \see TRACE_declare_mark
+ */
+void TRACE_mark(const char *mark_type, const char *mark_value)
+{
+  /* safe switch */
+  if (!TRACE_is_enabled()) return;
+
+  if (!mark_type || !mark_value) return;
+
+  XBT_DEBUG("MARK %s %s", mark_type, mark_value);
+  type_t type = PJ_type_get (mark_type, PJ_type_get_root());
+  if (type == NULL){
+    THROWF (tracing_error, 1, "mark_type with name (%s) not declared before", mark_type);
   }
+  val_t value = PJ_value_get (mark_value, type);
+  if (value == NULL){
+    value = PJ_value_new (mark_value, NULL, type);
+  }
+  new_pajeNewEvent (MSG_get_clock(), PJ_container_get_root(), type, value);
+}
 
-  if (TRACE_msg_task_is_enabled()) {
-    //tasks grouped by host
-    pajeDefineContainerType("TASK", "HOST", "TASK");
-    pajeDefineStateType("category", "TASK", "category");
-    pajeDefineStateType("presence", "TASK", "presence");
+static void instr_user_variable(double time,
+                         const char *resource,
+                         const char *variable,
+                         const char *father_type,
+                         double value,
+                         InstrUserVariable what,
+                         const char *color)
+{
+  /* safe switch */
+  if (!TRACE_is_enabled()) return;
+
+  /* if platform is not traced, we can't deal user variables */
+  if (!TRACE_needs_platform()) return;
+
+  char valuestr[100];
+  snprintf(valuestr, 100, "%g", value);
+
+  switch (what){
+  case INSTR_US_DECLARE:
+    instr_new_user_variable_type (father_type, variable, color);
+    break;
+  case INSTR_US_SET:
+  {
+    container_t container = PJ_container_get(resource);
+    type_t type = PJ_type_get (variable, container->type);
+    new_pajeSetVariable(time, container, type, value);
+    break;
+  }
+  case INSTR_US_ADD:
+  {
+    container_t container = PJ_container_get(resource);
+    type_t type = PJ_type_get (variable, container->type);
+    new_pajeAddVariable(time, container, type, value);
+    break;
+  }
+  case INSTR_US_SUB:
+  {
+    container_t container = PJ_container_get(resource);
+    type_t type = PJ_type_get (variable, container->type);
+    new_pajeSubVariable(time, container, type, value);
+    break;
   }
+  default:
+    //TODO: launch exception
+    break;
+  }
+}
 
-  if (TRACE_smpi_is_enabled()) {
-    if (TRACE_smpi_is_grouped()){
-      pajeDefineContainerType("MPI_PROCESS", "HOST", "MPI_PROCESS");
-    }else{
-      pajeDefineContainerType("MPI_PROCESS", "PLATFORM", "MPI_PROCESS");
-    }
-    pajeDefineStateType("MPI_STATE", "MPI_PROCESS", "MPI_STATE");
-    pajeDefineLinkType("MPI_LINK", "0", "MPI_PROCESS", "MPI_PROCESS",
-                       "MPI_LINK");
+static void instr_user_srcdst_variable(double time,
+                              const char *src,
+                              const char *dst,
+                              const char *variable,
+                              const char *father_type,
+                              double value,
+                              InstrUserVariable what)
+{
+  xbt_dynar_t route=NULL;
+  network_element_t src_elm = xbt_lib_get_or_null(host_lib,src,ROUTING_HOST_LEVEL);
+  if(!src_elm) src_elm = xbt_lib_get_or_null(as_router_lib,src,ROUTING_ASR_LEVEL);
+  if(!src_elm) xbt_die("Element '%s' not found!",src);
+
+  network_element_t dst_elm = xbt_lib_get_or_null(host_lib,dst,ROUTING_HOST_LEVEL);
+  if(!dst_elm) dst_elm = xbt_lib_get_or_null(as_router_lib,dst,ROUTING_ASR_LEVEL);
+  if(!dst_elm) xbt_die("Element '%s' not found!",dst);
+
+  routing_get_route_and_latency (src_elm, dst_elm, &route,NULL);
+  unsigned int i;
+  void *link;
+  xbt_dynar_foreach (route, i, link) {
+    char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
+    instr_user_variable (time, link_name, variable, father_type, value, what, NULL);
   }
+}
 
-  /* creating the platform */
-  pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0",
-                      "simgrid-platform");
+/** \ingroup TRACE_API
+ *  \brief Creates a file with the topology of the platform file used for the simulator.
+ *
+ *  The graph topology will have the following properties: all hosts, links and routers
+ *  of the platform file are mapped to graph nodes; routes are mapped to edges.
+ *  The platform's AS are not represented in the output.
+ *
+ *  \param filename The name of the file that will hold the graph.
+ *
+ *  \return 1 of successful, 0 otherwise.
+ */
+int TRACE_platform_graph_export_graphviz (const char *filename)
+{
+  /* returns 1 if successful, 0 otherwise */
+  if (!TRACE_is_enabled()) return 0;
+  xbt_graph_t g = instr_routing_platform_graph();
+  if (g == NULL) return 0;
+  instr_routing_platform_graph_export_graphviz (g, filename);
+  xbt_graph_free_graph (g, xbt_free, xbt_free, NULL);
+  return 1;
+}
+
+/*
+ * Derived functions that use instr_user_variable and TRACE_user_srcdst_variable.
+ * They were previously defined as pre-processors directives, but were transformed
+ * into functions so the user can track them using gdb.
+ */
+
+/* for host variables */
+/** \ingroup TRACE_user_variables
+ *  \brief Declare a new user variable associated to hosts.
+ *
+ *  Declare a user variable that will be associated to hosts.
+ *  A user host variable can be used to trace user variables
+ *  such as the number of tasks in a server, the number of
+ *  clients in an application (for hosts), and so on. The color
+ *  associated to this new variable will be random.
+ *
+ *  \param variable The name of the new variable to be declared.
+ *
+ *  \see TRACE_host_variable_declare_with_color
+ */
+void TRACE_host_variable_declare (const char *variable)
+{
+  instr_user_variable(0, NULL, variable, "HOST", 0, INSTR_US_DECLARE, NULL);
+}
 
-  /* other trace initialization */
-  defined_types = xbt_dict_new();
-  created_categories = xbt_dict_new();
-  TRACE_msg_task_alloc();
-  TRACE_category_alloc();
-  TRACE_surf_alloc();
-  TRACE_msg_process_alloc();
-  TRACE_smpi_alloc();
-  return 0;
+/** \ingroup TRACE_user_variables
+ *  \brief Declare a new user variable associated to hosts with a color.
+ *
+ *  Same as #TRACE_host_variable_declare, but associated a color
+ *  to the newly created user host variable. The color needs to be
+ *  a string with three numbers separated by spaces in the range [0,1].
+ *  A light-gray color can be specified using "0.7 0.7 0.7" as color.
+ *
+ *  \param variable The name of the new variable to be declared.
+ *  \param color The color for the new variable.
+ *
+ */
+void TRACE_host_variable_declare_with_color (const char *variable, const char *color)
+{
+  instr_user_variable(0, NULL, variable, "HOST", 0, INSTR_US_DECLARE, color);
 }
 
-int TRACE_end()
+/** \ingroup TRACE_user_variables
+ *  \brief Set the value of a variable of a host.
+ *
+ *  \param host The name of the host to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The new value of the variable.
+ *
+ *  \see TRACE_host_variable_declare, TRACE_host_variable_add, TRACE_host_variable_sub
+ */
+void TRACE_host_variable_set (const char *host, const char *variable, double value)
 {
-  if (!TRACE_is_active())
-    return 1;
+  TRACE_host_variable_set_with_time (MSG_get_clock(), host, variable, value);
+}
 
-  /* close the trace file */
-  TRACE_paje_end();
+/** \ingroup TRACE_user_variables
+ *  \brief Add a value to a variable of a host.
+ *
+ *  \param host The name of the host to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be added to the variable.
+ *
+ *  \see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_sub
+ */
+void TRACE_host_variable_add (const char *host, const char *variable, double value)
+{
+  TRACE_host_variable_add_with_time (MSG_get_clock(), host, variable, value);
+}
 
-  /* activate trace */
-  TRACE_desactivate ();
-  return 0;
+/** \ingroup TRACE_user_variables
+ *  \brief Subtract a value from a variable of a host.
+ *
+ *  \param host The name of the host to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be subtracted from the variable.
+ *
+ *  \see TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_add
+ */
+void TRACE_host_variable_sub (const char *host, const char *variable, double value)
+{
+  TRACE_host_variable_sub_with_time (MSG_get_clock(), host, variable, value);
 }
 
-int TRACE_category(const char *category)
+/** \ingroup TRACE_user_variables
+ *  \brief Set the value of a variable of a host at a given timestamp.
+ *
+ *  Same as #TRACE_host_variable_set, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param host The name of the host to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The new value of the variable.
+ *
+ *  \see TRACE_host_variable_declare, TRACE_host_variable_add_with_time, TRACE_host_variable_sub_with_time
+ */
+void TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value)
 {
-  return TRACE_category_with_color (category, NULL);
+  instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SET, NULL);
 }
 
-int TRACE_category_with_color (const char *category, const char *color)
+/** \ingroup TRACE_user_variables
+ *  \brief Add a value to a variable of a host at a given timestamp.
+ *
+ *  Same as #TRACE_host_variable_add, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param host The name of the host to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be added to the variable.
+ *
+ *  \see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_sub_with_time
+ */
+void TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value)
 {
-  static int first_time = 1;
-  if (!TRACE_is_active())
-    return 1;
+  instr_user_variable(time, host, variable, "HOST", value, INSTR_US_ADD, NULL);
+}
 
-  if (first_time) {
-    TRACE_define_type("user_type", "0", 1);
-    first_time = 0;
-  }
-  return TRACE_create_category_with_color(category, "user_type", "0", color);
+/** \ingroup TRACE_user_variables
+ *  \brief Subtract a value from a variable of a host at a given timestamp.
+ *
+ *  Same as #TRACE_host_variable_sub, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param host The name of the host to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be subtracted from the variable.
+ *
+ *  \see TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_add_with_time
+ */
+void TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value)
+{
+  instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SUB, NULL);
 }
 
-void TRACE_define_type(const char *type,
-                       const char *parent_type, int final)
+/* for link variables */
+/** \ingroup TRACE_user_variables
+ *  \brief Declare a new user variable associated to links.
+ *
+ *  Declare a user variable that will be associated to links.
+ *  A user link variable can be used, for example, to trace
+ *  user variables such as the number of messages being
+ *  transferred through network links. The color
+ *  associated to this new variable will be random.
+ *
+ *  \param variable The name of the new variable to be declared.
+ *
+ *  \see TRACE_link_variable_declare_with_color
+ */
+void TRACE_link_variable_declare (const char *variable)
 {
-  char *val_one = NULL;
-  if (!TRACE_is_active())
-    return;
+  instr_user_variable (0, NULL, variable, "LINK", 0, INSTR_US_DECLARE, NULL);
+}
 
-  //check if type is already defined
-  if (xbt_dict_get_or_null(defined_types, type)) {
-    THROW1(tracing_error, TRACE_ERROR_TYPE_ALREADY_DEFINED,
-           "Type %s is already defined", type);
-  }
-  //check if parent_type is already defined
-  if (strcmp(parent_type, "0")
-      && !xbt_dict_get_or_null(defined_types, parent_type)) {
-    THROW1(tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED,
-           "Type (used as parent) %s is not defined", parent_type);
-  }
+/** \ingroup TRACE_user_variables
+ *  \brief Declare a new user variable associated to links with a color.
+ *
+ *  Same as #TRACE_link_variable_declare, but associated a color
+ *  to the newly created user link variable. The color needs to be
+ *  a string with three numbers separated by spaces in the range [0,1].
+ *  A light-gray color can be specified using "0.7 0.7 0.7" as color.
+ *
+ *  \param variable The name of the new variable to be declared.
+ *  \param color The color for the new variable.
+ *
+ */
+void TRACE_link_variable_declare_with_color (const char *variable, const char *color)
+{
+  instr_user_variable (0, NULL, variable, "LINK", 0, INSTR_US_DECLARE, color);
+}
 
-  pajeDefineContainerType(type, parent_type, type);
-  if (final) {
-    //for m_process_t
-    if (TRACE_msg_process_is_enabled())
-      pajeDefineContainerType("process", type, "process");
-    if (TRACE_msg_process_is_enabled())
-      pajeDefineStateType("process-state", "process", "process-state");
-
-    if (TRACE_msg_task_is_enabled())
-      pajeDefineContainerType("task", type, "task");
-    if (TRACE_msg_task_is_enabled())
-      pajeDefineStateType("task-state", "task", "task-state");
-  }
-  val_one = xbt_strdup("1");
-  xbt_dict_set(defined_types, type, &val_one, xbt_free);
+/** \ingroup TRACE_user_variables
+ *  \brief Set the value of a variable of a link.
+ *
+ *  \param link The name of the link to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The new value of the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_variable_add, TRACE_link_variable_sub
+ */
+void TRACE_link_variable_set (const char *link, const char *variable, double value)
+{
+  TRACE_link_variable_set_with_time (MSG_get_clock(), link, variable, value);
 }
 
-int TRACE_create_category(const char *category,
-                          const char *type, const char *parent_category)
+/** \ingroup TRACE_user_variables
+ *  \brief Add a value to a variable of a link.
+ *
+ *  \param link The name of the link to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be added to the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_sub
+ */
+void TRACE_link_variable_add (const char *link, const char *variable, double value)
 {
-  return TRACE_create_category_with_color (category, type, parent_category, NULL);
+  TRACE_link_variable_add_with_time (MSG_get_clock(), link, variable, value);
 }
 
-int TRACE_create_category_with_color(const char *category,
-                          const char *type,
-                          const char *parent_category,
-                          const char *color)
+/** \ingroup TRACE_user_variables
+ *  \brief Subtract a value from a variable of a link.
+ *
+ *  \param link The name of the link to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be subtracted from the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_add
+ */
+void TRACE_link_variable_sub (const char *link, const char *variable, double value)
 {
-  char state[100];
-  char *val_one = NULL;
-  if (!TRACE_is_active())
-    return 1;
+  TRACE_link_variable_sub_with_time (MSG_get_clock(), link, variable, value);
+}
 
-  //check if type is defined
-  if (!xbt_dict_get_or_null(defined_types, type)) {
-    THROW1(tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED,
-           "Type %s is not defined", type);
-    return 1;
-  }
-  //check if parent_category exists
-  if (strcmp(parent_category, "0")
-      && !xbt_dict_get_or_null(created_categories, parent_category)) {
-    THROW1(tracing_error, TRACE_ERROR_CATEGORY_NOT_DEFINED,
-           "Category (used as parent) %s is not created", parent_category);
-    return 1;
-  }
-  //check if category is created
-  if (xbt_dict_get_or_null(created_categories, category)) {
-    return 1;
-  }
+/** \ingroup TRACE_user_variables
+ *  \brief Set the value of a variable of a link at a given timestamp.
+ *
+ *  Same as #TRACE_link_variable_set, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param link The name of the link to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The new value of the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_variable_add_with_time, TRACE_link_variable_sub_with_time
+ */
+void TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value)
+{
+  instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SET, NULL);
+}
 
-  pajeCreateContainer(MSG_get_clock(), category, type, parent_category,
-                      category);
+/** \ingroup TRACE_user_variables
+ *  \brief Add a value to a variable of a link at a given timestamp.
+ *
+ *  Same as #TRACE_link_variable_add, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param link The name of the link to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be added to the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_sub_with_time
+ */
+void TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value)
+{
+  instr_user_variable (time, link, variable, "LINK", value, INSTR_US_ADD, NULL);
+}
 
-  char final_color[INSTR_DEFAULT_STR_SIZE];
-  if (!color){
-    //generate a random color
-    double red = drand48();
-    double green = drand48();
-    double blue = drand48();
-    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", red, green, blue);
-  }else{
-    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color);
-  }
+/** \ingroup TRACE_user_variables
+ *  \brief Subtract a value from a variable of a link at a given timestamp.
+ *
+ *  Same as #TRACE_link_variable_sub, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param link The name of the link to be considered.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be subtracted from the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_add_with_time
+ */
+void TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value)
+{
+  instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SUB, NULL);
+}
 
-  /* for registering application categories on top of platform */
-  snprintf(state, 100, "b%s", category);
-  if (TRACE_platform_is_enabled())
-    pajeDefineVariableTypeWithColor(state, "LINK", state, final_color);
-  snprintf(state, 100, "p%s", category);
-  if (TRACE_platform_is_enabled())
-    pajeDefineVariableTypeWithColor(state, "HOST", state, final_color);
+/* for link variables, but with src and dst used for get_route */
+/** \ingroup TRACE_user_variables
+ *  \brief Set the value of the variable present in the links connecting source and destination.
+ *
+ *  Same as #TRACE_link_variable_set, but instead of providing the
+ *  name of link to be considered, provide the source and destination
+ *  hosts. All links that are part of the route between source and
+ *  destination will have the variable set to the provided value.
+ *
+ *  \param src The name of the source host for get route.
+ *  \param dst The name of the destination host for get route.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The new value of the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add, TRACE_link_srcdst_variable_sub
+ */
+void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value)
+{
+  TRACE_link_srcdst_variable_set_with_time (MSG_get_clock(), src, dst, variable, value);
+}
 
-  val_one = xbt_strdup("1");
-  xbt_dict_set(created_categories, category, &val_one, xbt_free);
-  return 0;
+/** \ingroup TRACE_user_variables
+ *  \brief Add a value to the variable present in the links connecting source and destination.
+ *
+ *  Same as #TRACE_link_variable_add, but instead of providing the
+ *  name of link to be considered, provide the source and destination
+ *  hosts. All links that are part of the route between source and
+ *  destination will have the value passed as parameter added to
+ *  the current value of the variable name to be considered.
+ *
+ *  \param src The name of the source host for get route.
+ *  \param dst The name of the destination host for get route.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be added to the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_sub
+ */
+void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value)
+{
+  TRACE_link_srcdst_variable_add_with_time (MSG_get_clock(), src, dst, variable, value);
 }
 
-void TRACE_declare_mark(const char *mark_type)
+/** \ingroup TRACE_user_variables
+ *  \brief Subtract a value from the variable present in the links connecting source and destination.
+ *
+ *  Same as #TRACE_link_variable_sub, but instead of providing the
+ *  name of link to be considered, provide the source and destination
+ *  hosts. All links that are part of the route between source and
+ *  destination will have the value passed as parameter subtracted from
+ *  the current value of the variable name to be considered.
+ *
+ *  \param src The name of the source host for get route.
+ *  \param dst The name of the destination host for get route.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be subtracted from the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_add
+ */
+void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value)
 {
-  if (!TRACE_is_active())
-    return;
-  if (!mark_type)
-    return;
+  TRACE_link_srcdst_variable_sub_with_time (MSG_get_clock(), src, dst, variable, value);
+}
 
-  pajeDefineEventType(mark_type, "0", mark_type);
+/** \ingroup TRACE_user_variables
+ *  \brief Set the value of the variable present in the links connecting source and destination at a given timestamp.
+ *
+ *  Same as #TRACE_link_srcdst_variable_set, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param src The name of the source host for get route.
+ *  \param dst The name of the destination host for get route.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The new value of the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_add_with_time, TRACE_link_srcdst_variable_sub_with_time
+ */
+void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value)
+{
+  instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SET);
 }
 
-void TRACE_mark(const char *mark_type, const char *mark_value)
+/** \ingroup TRACE_user_variables
+ *  \brief Add a value to the variable present in the links connecting source and destination at a given timestamp.
+ *
+ *  Same as #TRACE_link_srcdst_variable_add, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param src The name of the source host for get route.
+ *  \param dst The name of the destination host for get route.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be added to the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_sub_with_time
+ */
+void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value)
 {
-  if (!TRACE_is_active())
-    return;
-  if (!mark_type || !mark_value)
-    return;
+  instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_ADD);
+}
 
-  pajeNewEvent(MSG_get_clock(), mark_type, "0", mark_value);
+/** \ingroup TRACE_user_variables
+ *  \brief Subtract a value from the variable present in the links connecting source and destination at a given timestamp.
+ *
+ *  Same as #TRACE_link_srcdst_variable_sub, but let user specify
+ *  the time used to trace it. Users can specify a time that
+ *  is not the simulated clock time as defined by the core
+ *  simulator. This allows a fine-grain control of time
+ *  definition, but should be used with caution since the trace
+ *  can be inconsistent if resource utilization traces are also traced.
+ *
+ *  \param time The timestamp to be used to tag this change of value.
+ *  \param src The name of the source host for get route.
+ *  \param dst The name of the destination host for get route.
+ *  \param variable The name of the variable to be considered.
+ *  \param value The value to be subtracted from the variable.
+ *
+ *  \see TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_add_with_time
+ */
+void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value)
+{
+  instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SUB);
 }
 
 #endif /* HAVE_TRACING */