X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c5ad8ca1a68bbaa9152471c8d0eeb99d762f0d86..d8eaff2fe775b7f7b807ce9aee69ab76caea39d1:/src/instr/instr_interface.c diff --git a/src/instr/instr_interface.c b/src/instr/instr_interface.c index 9c82256ab4..8795d59977 100644 --- a/src/instr/instr_interface.c +++ b/src/instr/instr_interface.c @@ -7,7 +7,6 @@ #include "simgrid_config.h" #ifdef HAVE_TRACING - #include "instr/instr_private.h" #include "surf/network_private.h" @@ -15,16 +14,54 @@ typedef enum { INSTR_US_DECLARE, INSTR_US_SET, INSTR_US_ADD, - INSTR_US_SUB, + INSTR_US_SUB } InstrUserVariable; XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API"); +/** \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 + */ void TRACE_category(const char *category) { TRACE_category_with_color (category, NULL); } +/** \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 + */ void TRACE_category_with_color (const char *category, const char *color) { /* safe switch */ @@ -58,6 +95,19 @@ void TRACE_category_with_color (const char *category, const char *color) instr_new_variable_type (category, final_color); } +/** \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 */ @@ -69,6 +119,24 @@ void TRACE_declare_mark(const char *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 */ @@ -145,7 +213,15 @@ static void instr_user_srcdst_variable(double time, InstrUserVariable what) { xbt_dynar_t route=NULL; - routing_get_route_and_latency (src, dst, &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) { @@ -154,25 +230,17 @@ static void instr_user_srcdst_variable(double time, } } -const char *TRACE_node_name (xbt_node_t node) -{ - void *data = xbt_graph_node_get_data(node); - char *str = (char*)data; - return str; -} - -xbt_graph_t TRACE_platform_graph (void) -{ - if (!TRACE_is_enabled()) return NULL; - return instr_routing_platform_graph (); -} - -void TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char *filename) +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 @@ -180,14 +248,14 @@ void TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char *filename) */ /* for host variables */ -void TRACE_host_variable_declare (const char *var) +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) +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); } void TRACE_host_variable_set (const char *host, const char *variable, double value)