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.
*
*
* \param category The name of the new tracing category to be created.
*
- * \see TRACE_category_with_color, MSG_task_set_category
+ * \see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
*/
void TRACE_category(const char *category)
{
* \param color The color of the category (see \ref tracing_tracing to
* know how to correctly specify the color)
*
- * \see MSG_task_set_category
+ * \see MSG_task_set_category, SD_task_set_category
*/
void TRACE_category_with_color (const char *category, const char *color)
{
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;
+}
+
/** \ingroup TRACE_mark
* \brief Declare a new type for tracing mark.
*
}
}
+/** \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 */
*/
/* for host variables */
-void TRACE_host_variable_declare (const char *var)
+/** \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, var, "HOST", 0, INSTR_US_DECLARE, NULL);
+ instr_user_variable(0, NULL, variable, "HOST", 0, INSTR_US_DECLARE, NULL);
}
-void TRACE_host_variable_declare_with_color (const char *var, const char *color)
+/** \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, var, "HOST", 0, INSTR_US_DECLARE, color);
+ instr_user_variable(0, NULL, variable, "HOST", 0, INSTR_US_DECLARE, color);
}
+/** \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);
}
+/** \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);
}
+/** \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);
}
/* for link variables */
-void TRACE_link_variable_declare (const char *var)
+/** \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, var, "LINK", 0, INSTR_US_DECLARE, NULL);
+ instr_user_variable (0, NULL, variable, "LINK", 0, INSTR_US_DECLARE, NULL);
}
-void TRACE_link_variable_declare_with_color (const char *var, const char *color)
+/** \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, var, "LINK", 0, INSTR_US_DECLARE, color);
+ instr_user_variable (0, NULL, variable, "LINK", 0, INSTR_US_DECLARE, color);
}
+/** \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);
}
+/** \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);
}
+/** \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 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);
}
+/** \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);
}
+/** \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)
{
instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_ADD);
}
+/** \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);
