+/** \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 VM variables */
+/** \ingroup TRACE_user_variables
+ * \brief Declare a new user variable associated to VMs.
+ *
+ * Declare a user variable that will be associated to VMs.
+ * A user vm variable can be used to trace user variables
+ * such as the number of tasks in a VM, the number of
+ * clients in an application (for VMs), 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_vm_variable_declare_with_color
+ */
+void TRACE_vm_variable_declare (const char *variable)
+{
+ instr_user_variable(0, NULL, variable, "MSG_VM", 0, INSTR_US_DECLARE, NULL, user_vm_variables);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Declare a new user variable associated to VMs with a color.
+ *
+ * Same as #TRACE_vm_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_vm_variable_declare_with_color (const char *variable, const char *color)
+{
+ instr_user_variable(0, NULL, variable, "MSG_VM", 0, INSTR_US_DECLARE, color, user_vm_variables);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Set the value of a variable of a host.
+ *
+ * \param vm The name of the VM to be considered.
+ * \param variable The name of the variable to be considered.
+ * \param value The new value of the variable.
+ *
+ * \see TRACE_vm_variable_declare, TRACE_vm_variable_add, TRACE_vm_variable_sub
+ */
+void TRACE_vm_variable_set (const char *vm, const char *variable, double value)
+{
+
+ TRACE_vm_variable_set_with_time (MSG_get_clock(), vm, variable, value);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Add a value to a variable of a VM.
+ *
+ * \param vm The name of the VM 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_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_sub
+ */
+void TRACE_vm_variable_add (const char *vm, const char *variable, double value)
+{
+ TRACE_vm_variable_add_with_time (MSG_get_clock(), vm, variable, value);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Subtract a value from a variable of a VM.
+ *
+ * \param vm The name of the vm 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_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_add
+ */
+void TRACE_vm_variable_sub (const char *vm, const char *variable, double value)
+{
+ TRACE_vm_variable_sub_with_time (MSG_get_clock(), vm, variable, value);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Set the value of a variable of a VM at a given timestamp.
+ *
+ * Same as #TRACE_vm_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 vm The name of the VM to be considered.
+ * \param variable The name of the variable to be considered.
+ * \param value The new value of the variable.
+ *
+ * \see TRACE_vm_variable_declare, TRACE_vm_variable_add_with_time, TRACE_vm_variable_sub_with_time
+ */
+void TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value)
+{
+ instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_SET, NULL, user_vm_variables);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Add a value to a variable of a VM at a given timestamp.
+ *
+ * Same as #TRACE_vm_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 vm The name of the VM 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_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_sub_with_time
+ */
+void TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value)
+{
+ instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_ADD, NULL, user_vm_variables);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Subtract a value from a variable of a VM at a given timestamp.
+ *
+ * Same as #TRACE_vm_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 vm The name of the VM 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_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_add_with_time
+ */
+void TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value)
+{
+ instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_SUB, NULL, user_vm_variables);
+}
+
+/** \ingroup TRACE_user_variables
+ * \brief Get declared user vm variables
+ *
+ * This function should be used to get VM variables that were already
+ * declared with #TRACE_vm_variable_declare or with #TRACE_vm_variable_declare_with_color.
+ *
+ * \return A dynar with the declared host variables, must be freed with xbt_dynar_free.
+ */
+xbt_dynar_t TRACE_get_vm_variables (void)
+{
+ return instr_dict_to_dynar (user_vm_variables);
+}
+
+
+
+/* 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)