X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/da1a88299f91798046c12cd7568b87f55e4fab94..1ee0ed6b44e3639fcfcbb37a43e8709aa95a2db5:/src/instr/instr_interface.c diff --git a/src/instr/instr_interface.c b/src/instr/instr_interface.c index bd00ccaad3..e18be1f617 100644 --- a/src/instr/instr_interface.c +++ b/src/instr/instr_interface.c @@ -22,6 +22,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API"); xbt_dict_t created_categories = NULL; xbt_dict_t declared_marks = NULL; xbt_dict_t user_host_variables = NULL; +xbt_dict_t user_vm_variables = NULL; xbt_dict_t user_link_variables = NULL; extern xbt_dict_t trivaNodeTypes; extern xbt_dict_t trivaEdgeTypes; @@ -53,7 +54,7 @@ static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter) * 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 + * See \ref tracing for details on how to trace * the (categorized) resource utilization. * * \param category The name of the new tracing category to be created. @@ -74,11 +75,11 @@ void TRACE_category(const char *category) * 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 + * See \ref 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 + * \param color The color of the category (see \ref tracing to * know how to correctly specify the color) * * \see MSG_task_set_category, SD_task_set_category @@ -110,7 +111,7 @@ void TRACE_category_with_color (const char *category, const char *color) snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color); } - XBT_DEBUG("CAT,declare %s, %s", category, final_color); + XBT_DEBUG("CAT,declare %s, \"%s\" \"%s\"", category, color, final_color); //define the type of this category on top of hosts and links instr_new_variable_type (category, final_color); @@ -123,7 +124,7 @@ void TRACE_category_with_color (const char *category, const char *color) * 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 + * See \ref 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. @@ -168,26 +169,29 @@ void TRACE_declare_mark(const char *mark_type) } XBT_DEBUG("MARK,declare %s", mark_type); - PJ_type_event_new(mark_type, NULL, PJ_type_get_root()); + PJ_type_event_new(mark_type, PJ_type_get_root()); xbt_dict_set (declared_marks, mark_type, xbt_strdup("1"), NULL); } - /** \ingroup TRACE_mark - * \brief Declare a new value for a previously declared mark type. + * \brief Declare a new colored value for a previously declared mark type. * - * This function declares a new value for a Paje event + * This function declares a new colored value for a 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. + * which API is used in SimGrid. 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. + * If a NULL color is provided, the color used will be white ("1 1 1"). * * \param mark_type The name of the new type. * \param mark_value The name of the new value for this type. + * \param mark_color The color of the new value for this type. * * \see TRACE_mark */ -void TRACE_declare_mark_value (const char *mark_type, const char *mark_value) +void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color) { /* safe switch */ if (!TRACE_is_enabled()) return; @@ -203,8 +207,31 @@ void TRACE_declare_mark_value (const char *mark_type, const char *mark_value) THROWF (tracing_error, 1, "mark_type with name (%s) is not declared", mark_type); } - XBT_DEBUG("MARK,declare_value %s %s", mark_type, mark_value); - PJ_value_new (mark_value, NULL, type); + char white[INSTR_DEFAULT_STR_SIZE] = "1.0 1.0 1.0"; + if (!mark_color) mark_color = white; + + XBT_DEBUG("MARK,declare_value %s %s %s", mark_type, mark_value, mark_color); + PJ_value_new (mark_value, mark_color, type); +} + +/** \ingroup TRACE_mark + * \brief Declare a new value for a previously declared mark type. + * + * This function declares a new value for a 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. Calling this function is the same + * as calling \ref TRACE_declare_mark_value_with_color with a NULL color. + * + * \param mark_type The name of the new type. + * \param mark_value The name of the new value for this type. + * + * \see TRACE_mark + */ +void TRACE_declare_mark_value (const char *mark_type, const char *mark_value) +{ + TRACE_declare_mark_value_with_color (mark_type, mark_value, NULL); } /** @@ -380,6 +407,166 @@ int TRACE_platform_graph_export_graphviz (const char *filename) * 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. @@ -959,4 +1146,22 @@ xbt_dynar_t TRACE_get_edge_types (void) return instr_dict_to_dynar (trivaEdgeTypes); } +/** \ingroup TRACE_API + * \brief Pauses all tracing activities. + * \see TRACE_resume + */ +void TRACE_pause (void) +{ + instr_pause_tracing(); +} + +/** \ingroup TRACE_API + * \brief Resumes all tracing activities. + * \see TRACE_pause + */ +void TRACE_resume (void) +{ + instr_resume_tracing(); +} + #endif /* HAVE_TRACING */