+ /* safe switch */
+ if (!TRACE_is_enabled()) return;
+
+ /* if platform is not traced, we don't allow marks */
+ if (!TRACE_needs_platform()) return;
+
+ if (!mark_type) THROWF (tracing_error, 1, "mark_type is NULL");
+ if (!mark_value) THROWF (tracing_error, 1, "mark_value is NULL");
+
+ //check if mark_type is already declared
+ type_t type = PJ_type_get (mark_type, PJ_type_get_root());
+ if (!type){
+ THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type);
+ }
+
+ val_t value = PJ_value_get (mark_value, type);
+ XBT_DEBUG("MARK %s %s", mark_type, mark_value);
+ new_pajeNewEvent (MSG_get_clock(), PJ_container_get_root(), type, value);
+}
+
+/** \ingroup TRACE_mark
+ * \brief Get declared marks
+ *
+ * This function should be used to get marks that were already
+ * declared with #TRACE_declare_mark.
+ *
+ * \return A dynar with the declared marks, must be freed with xbt_dynar_free.
+ *
+ */
+xbt_dynar_t TRACE_get_marks (void)
+{
+ if (!TRACE_is_enabled()) return NULL;
+
+ return instr_dict_to_dynar (declared_marks);
+}
+
+static void instr_user_variable(double time,
+ const char *resource,
+ const char *variable,
+ const char *father_type,
+ double value,
+ InstrUserVariable what,
+ const char *color,
+ xbt_dict_t filter)
+{
+ /* safe switch */
+ if (!TRACE_is_enabled()) return;
+
+ /* if platform is not traced, we don't allow user variables */
+ if (!TRACE_needs_platform()) return;
+
+ //check if variable is already declared
+ char *created = xbt_dict_get_or_null(filter, variable);
+ if (what == INSTR_US_DECLARE){
+ if (created){
+ //already declared
+ return;
+ }else{
+ xbt_dict_set (filter, variable, xbt_strdup("1"), NULL);
+ }
+ }else{
+ if (!created){
+ //not declared, ignore
+ 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;
+ }
+}
+
+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;
+ sg_routing_edge_t src_elm = sg_routing_edge_by_name_or_null(src);
+ if(!src_elm) xbt_die("Element '%s' not found!",src);
+
+ sg_routing_edge_t dst_elm = sg_routing_edge_by_name_or_null(dst);
+ 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, user_link_variables);
+ }
+}
+
+/** \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, user_host_variables);
+}
+
+/** \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, user_host_variables);
+}
+
+/** \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)
+{
+ TRACE_host_variable_set_with_time (MSG_get_clock(), host, variable, value);
+}
+
+/** \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);
+}
+
+/** \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);
+}
+
+/** \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)
+{
+ instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SET, NULL, user_host_variables);
+}
+
+/** \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)
+{
+ instr_user_variable(time, host, variable, "HOST", value, INSTR_US_ADD, NULL, user_host_variables);
+}
+
+/** \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, user_host_variables);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Get declared user host variables
+ *
+ * This function should be used to get host variables that were already
+ * declared with #TRACE_host_variable_declare or with #TRACE_host_variable_declare_with_color.
+ *
+ * \return A dynar with the declared host variables, must be freed with xbt_dynar_free.
+ */
+xbt_dynar_t TRACE_get_host_variables (void)
+{
+ return instr_dict_to_dynar (user_host_variables);
+}
+
+/* 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)
+{
+ instr_user_variable (0, NULL, variable, "LINK", 0, INSTR_US_DECLARE, NULL, user_link_variables);
+}
+
+/** \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, user_link_variables);
+}
+
+/** \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);
+}
+
+/** \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)
+{
+ TRACE_link_variable_add_with_time (MSG_get_clock(), link, variable, value);
+}
+
+/** \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)
+{
+ TRACE_link_variable_sub_with_time (MSG_get_clock(), link, variable, value);
+}
+
+/** \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, user_link_variables);
+}
+
+/** \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, user_link_variables);
+}
+
+/** \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, user_link_variables);
+}
+
+/* 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);
+}
+
+/** \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);
+}
+
+/** \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)
+{
+ TRACE_link_srcdst_variable_sub_with_time (MSG_get_clock(), src, dst, variable, value);
+}