X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4a6b0a991a67e6f2f67c03fed43529e078da7115..1750409d1aafcec7d8ea213624517fe6ab1fc67e:/src/instr/instr_interface.cpp diff --git a/src/instr/instr_interface.cpp b/src/instr/instr_interface.cpp index 84d70e6a78..758a2568bb 100644 --- a/src/instr/instr_interface.cpp +++ b/src/instr/instr_interface.cpp @@ -5,7 +5,6 @@ * under the terms of the license (GNU LGPL) which comes with this package. */ #include "simgrid_config.h" - #include "src/surf/network_interface.hpp" #include "src/instr/instr_private.h" #include "surf/surf.h" @@ -20,21 +19,21 @@ typedef enum { 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; +xbt_dict_t created_categories = nullptr; +xbt_dict_t declared_marks = nullptr; +xbt_dict_t user_host_variables = nullptr; +xbt_dict_t user_vm_variables = nullptr; +xbt_dict_t user_link_variables = nullptr; extern xbt_dict_t trivaNodeTypes; extern xbt_dict_t trivaEdgeTypes; static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter) { - if (!TRACE_is_enabled()) return NULL; - if (!TRACE_needs_platform()) return NULL; + if (!TRACE_is_enabled()) return nullptr; + if (!TRACE_needs_platform()) return nullptr; xbt_dynar_t ret = xbt_dynar_new (sizeof(char*), &xbt_free_ref); - xbt_dict_cursor_t cursor = NULL; + xbt_dict_cursor_t cursor = nullptr; char *name, *value; xbt_dict_foreach(filter, cursor, name, value) { xbt_dynar_push_as (ret, char*, xbt_strdup(name)); @@ -45,18 +44,13 @@ static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter) /** \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. + * 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 for details on how to trace - * the (categorized) resource utilization. + * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization. * * \param category The name of the new tracing category to be created. * @@ -64,23 +58,20 @@ static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter) */ void TRACE_category(const char *category) { - TRACE_category_with_color (category, NULL); + TRACE_category_with_color (category, nullptr); } /** \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. + * 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 for details on how to trace - * the (categorized) resource utilization. + * See \ref outcomes_vizu 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 to + * \param color The color of the category (see \ref outcomes_vizu to * know how to correctly specify the color) * * \see MSG_task_set_category, SD_task_set_category @@ -90,7 +81,7 @@ void TRACE_category_with_color (const char *category, const char *color) /* safe switch */ if (!TRACE_is_enabled()) return; - if (!(TRACE_categorized() && category != NULL)) return; + if (!(TRACE_categorized() && category != nullptr)) return; /* if platform is not traced, we can't deal with categories */ if (!TRACE_needs_platform()) return; @@ -98,7 +89,7 @@ void TRACE_category_with_color (const char *category, const char *color) //check if category is already created char *created = (char*)xbt_dict_get_or_null(created_categories, category); if (created) return; - xbt_dict_set (created_categories, category, xbt_strdup("1"), NULL); + xbt_dict_set (created_categories, category, xbt_strdup("1"), nullptr); //define final_color char final_color[INSTR_DEFAULT_STR_SIZE]; @@ -118,15 +109,13 @@ 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. + * This function should be used to get categories that were already declared with #TRACE_category or with + * #TRACE_category_with_color. * - * See \ref tracing for details on how to trace - * the (categorized) resource utilization. + * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization. * * \return A dynar with the declared categories, must be freed with xbt_dynar_free. * @@ -134,8 +123,8 @@ void TRACE_category_with_color (const char *category, const char *color) */ xbt_dynar_t TRACE_get_categories (void) { - if (!TRACE_is_enabled()) return NULL; - if (!TRACE_categorized()) return NULL; + if (!TRACE_is_enabled()) return nullptr; + if (!TRACE_categorized()) return nullptr; return instr_dict_to_dynar (created_categories); } @@ -143,11 +132,8 @@ xbt_dynar_t TRACE_get_categories (void) /** \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. + * 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. * @@ -161,7 +147,7 @@ void TRACE_declare_mark(const char *mark_type) /* 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_type) THROWF (tracing_error, 1, "mark_type is nullptr"); //check if mark_type is already declared char *created = (char*)xbt_dict_get_or_null(declared_marks, mark_type); @@ -171,20 +157,17 @@ void TRACE_declare_mark(const char *mark_type) XBT_DEBUG("MARK,declare %s", mark_type); PJ_type_event_new(mark_type, PJ_type_get_root()); - xbt_dict_set (declared_marks, mark_type, xbt_strdup("1"), NULL); + xbt_dict_set (declared_marks, mark_type, xbt_strdup("1"), nullptr); } /** \ingroup TRACE_mark * \brief Declare a new colored value for a previously declared mark type. * - * 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. The color needs to be + * 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. 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"). + * A light-gray color can be specified using "0.7 0.7 0.7" as color. If a nullptr 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. @@ -200,8 +183,8 @@ void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mar /* 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"); + if (!mark_type) THROWF (tracing_error, 1, "mark_type is nullptr"); + if (!mark_value) THROWF (tracing_error, 1, "mark_value is nullptr"); type_t type = PJ_type_get (mark_type, PJ_type_get_root()); if (!type){ @@ -218,12 +201,9 @@ void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mar /** \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. + * 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 nullptr color. * * \param mark_type The name of the new type. * \param mark_value The name of the new value for this type. @@ -232,21 +212,17 @@ void TRACE_declare_mark_value_with_color (const char *mark_type, const char *mar */ void TRACE_declare_mark_value (const char *mark_type, const char *mark_value) { - TRACE_declare_mark_value_with_color (mark_type, mark_value, NULL); + TRACE_declare_mark_value_with_color (mark_type, mark_value, nullptr); } /** * \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. + * 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. @@ -261,8 +237,8 @@ void TRACE_mark(const char *mark_type, const char *mark_value) /* 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"); + if (!mark_type) THROWF (tracing_error, 1, "mark_type is nullptr"); + if (!mark_value) THROWF (tracing_error, 1, "mark_value is nullptr"); //check if mark_type is already declared type_t type = PJ_type_get (mark_type, PJ_type_get_root()); @@ -278,27 +254,19 @@ void TRACE_mark(const char *mark_type, const char *mark_value) /** \ingroup TRACE_mark * \brief Get declared marks * - * This function should be used to get marks that were already - * declared with #TRACE_declare_mark. + * 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; + if (!TRACE_is_enabled()) return nullptr; 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) +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; @@ -309,15 +277,13 @@ static void instr_user_variable(double time, //check if variable is already declared char *created = (char*)xbt_dict_get_or_null(filter, variable); if (what == INSTR_US_DECLARE){ - if (created){ - //already declared + if (created){//already declared return; }else{ - xbt_dict_set (filter, variable, xbt_strdup("1"), NULL); + xbt_dict_set (filter, variable, xbt_strdup("1"), nullptr); } }else{ - if (!created){ - //not declared, ignore + if (!created){//not declared, ignore return; } } @@ -330,61 +296,53 @@ static void instr_user_variable(double time, 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); + { + 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); + { + 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; - } + { + 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) +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_netcard_t src_elm = sg_netcard_by_name_or_null(src); if(!src_elm) xbt_die("Element '%s' not found!",src); sg_netcard_t dst_elm = sg_netcard_by_name_or_null(dst); if(!dst_elm) xbt_die("Element '%s' not found!",dst); - routing_platf->getRouteAndLatency (src_elm, dst_elm, &route,NULL); - unsigned int i; - surf_cpp_resource_t link; - xbt_dynar_foreach (route, i, link) { - char *link_name = (char*)surf_resource_name(link); - instr_user_variable (time, link_name, variable, father_type, value, what, NULL, user_link_variables); - } + std::vector *route = new std::vector(); + routing_platf->getRouteAndLatency (src_elm, dst_elm, route,nullptr); + for (auto link : *route) + instr_user_variable (time, link->getName(), variable, father_type, value, what, nullptr, user_link_variables); + delete route; } /** \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 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. @@ -396,26 +354,23 @@ 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; + if (g == nullptr) return 0; instr_routing_platform_graph_export_graphviz (g, filename); - xbt_graph_free_graph(g, xbt_free_f, xbt_free_f, NULL); + xbt_graph_free_graph(g, xbt_free_f, xbt_free_f, nullptr); 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. + * 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 + * 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. @@ -424,24 +379,22 @@ int TRACE_platform_graph_export_graphviz (const char *filename) */ void TRACE_vm_variable_declare (const char *variable) { - instr_user_variable(0, NULL, variable, "MSG_VM", 0, INSTR_US_DECLARE, NULL, user_vm_variables); + instr_user_variable(0, nullptr, variable, "MSG_VM", 0, INSTR_US_DECLARE, nullptr, 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]. + * 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); + instr_user_variable(0, nullptr, variable, "MSG_VM", 0, INSTR_US_DECLARE, color, user_vm_variables); } /** \ingroup TRACE_user_variables @@ -455,7 +408,6 @@ void TRACE_vm_variable_declare_with_color (const char *variable, const char *col */ 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); } @@ -490,12 +442,10 @@ void TRACE_vm_variable_sub (const char *vm, const char *variable, double 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. + * 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. @@ -506,18 +456,16 @@ void TRACE_vm_variable_sub (const char *vm, const char *variable, double value) */ 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); + instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_SET, nullptr, 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. + * 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. @@ -528,18 +476,16 @@ void TRACE_vm_variable_set_with_time (double time, const char *vm, const char *v */ 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); + instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_ADD, nullptr, 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. + * 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. @@ -550,14 +496,14 @@ void TRACE_vm_variable_add_with_time (double time, const char *vm, const char *v */ 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); + instr_user_variable(time, vm, variable, "MSG_VM", value, INSTR_US_SUB, nullptr, 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. + * 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. */ @@ -566,17 +512,13 @@ 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. + * 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. * @@ -584,24 +526,22 @@ xbt_dynar_t TRACE_get_vm_variables (void) */ void TRACE_host_variable_declare (const char *variable) { - instr_user_variable(0, NULL, variable, "HOST", 0, INSTR_US_DECLARE, NULL, user_host_variables); + instr_user_variable(0, nullptr, variable, "HOST", 0, INSTR_US_DECLARE, nullptr, 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]. + * 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); + instr_user_variable(0, nullptr, variable, "HOST", 0, INSTR_US_DECLARE, color, user_host_variables); } /** \ingroup TRACE_user_variables @@ -649,12 +589,10 @@ void TRACE_host_variable_sub (const char *host, const char *variable, double val /** \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. + * 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. @@ -665,18 +603,16 @@ void TRACE_host_variable_sub (const char *host, const char *variable, double val */ 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); + instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SET, nullptr, 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. + * 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. @@ -687,18 +623,16 @@ void TRACE_host_variable_set_with_time (double time, const char *host, const cha */ 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); + instr_user_variable(time, host, variable, "HOST", value, INSTR_US_ADD, nullptr, 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. + * 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. @@ -709,14 +643,14 @@ void TRACE_host_variable_add_with_time (double time, const char *host, const cha */ 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); + instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SUB, nullptr, 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. + * 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. */ @@ -730,10 +664,8 @@ xbt_dynar_t TRACE_get_host_variables (void) * \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. + * 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. * @@ -741,24 +673,22 @@ xbt_dynar_t TRACE_get_host_variables (void) */ void TRACE_link_variable_declare (const char *variable) { - instr_user_variable (0, NULL, variable, "LINK", 0, INSTR_US_DECLARE, NULL, user_link_variables); + instr_user_variable (0, nullptr, variable, "LINK", 0, INSTR_US_DECLARE, nullptr, 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]. + * 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); + instr_user_variable (0, nullptr, variable, "LINK", 0, INSTR_US_DECLARE, color, user_link_variables); } /** \ingroup TRACE_user_variables @@ -806,12 +736,10 @@ void TRACE_link_variable_sub (const char *link, const char *variable, double val /** \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. + * 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. @@ -822,18 +750,16 @@ void TRACE_link_variable_sub (const char *link, const char *variable, double val */ 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); + instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SET, nullptr, 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. + * 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. @@ -844,18 +770,16 @@ void TRACE_link_variable_set_with_time (double time, const char *link, const cha */ 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); + instr_user_variable (time, link, variable, "LINK", value, INSTR_US_ADD, nullptr, 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. + * 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. @@ -866,17 +790,16 @@ void TRACE_link_variable_add_with_time (double time, const char *link, const cha */ 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); + instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SUB, nullptr, 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. + * 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. @@ -893,11 +816,9 @@ void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const cha /** \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. + * 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. @@ -914,11 +835,9 @@ void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const cha /** \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. + * 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. @@ -935,12 +854,10 @@ void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const cha /** \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. + * 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. @@ -950,7 +867,8 @@ void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const cha * * \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) +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); } @@ -958,12 +876,10 @@ void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, con /** \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. + * 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. @@ -973,20 +889,19 @@ void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, con * * \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) +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. + * \brief Subtract a value from the variable present in the links connecting source and dest. 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. + * 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. @@ -996,7 +911,8 @@ void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, con * * \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) +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); } @@ -1004,8 +920,8 @@ void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, con /** \ingroup TRACE_user_variables * \brief Get declared user link variables * - * This function should be used to get link variables that were already - * declared with #TRACE_link_variable_declare or with #TRACE_link_variable_declare_with_color. + * This function should be used to get link variables that were already declared with #TRACE_link_variable_declare or + * with #TRACE_link_variable_declare_with_color. * * \return A dynar with the declared link variables, must be freed with xbt_dynar_free. */ @@ -1032,8 +948,7 @@ void TRACE_host_state_declare (const char *state) /** \ingroup TRACE_user_variables * \brief Declare a new value for a user state associated to hosts. * - * Declare a value for a state. The color needs to be - * a string with three numbers separated by spaces in the range [0,1]. + * Declare a value for a state. The color needs to be a string with 3 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 state The name of the new state to be declared. @@ -1062,7 +977,7 @@ void TRACE_host_set_state (const char *host, const char *state, const char *valu { container_t container = PJ_container_get(host); type_t type = PJ_type_get (state, container->type); - val_t val = PJ_value_get_or_new (value, NULL, type); /* if user didn't declare a value with a color, user a NULL color */ + val_t val = PJ_value_get_or_new (value, nullptr, type); /* if user didn't declare a value with a color, use nullptr color */ new_pajeSetState(MSG_get_clock(), container, type, val); } @@ -1081,7 +996,7 @@ void TRACE_host_push_state (const char *host, const char *state, const char *val { container_t container = PJ_container_get(host); type_t type = PJ_type_get (state, container->type); - val_t val = PJ_value_get_or_new (value, NULL, type); /* if user didn't declare a value with a color, user a NULL color */ + val_t val = PJ_value_get_or_new (value, nullptr, type); /* if user didn't declare a value with a color, use nullptr color */ new_pajePushState(MSG_get_clock(), container, type, val); } @@ -1122,9 +1037,8 @@ void TRACE_host_reset_state (const char *host, const char *state) /** \ingroup TRACE_API * \brief Get Paje container types that can be mapped to the nodes of a graph. * - * This function can be used to create a user made - * graph configuration file for Triva. Normally, it is - * used with the functions defined in \ref TRACE_user_variables. + * This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the + * functions defined in \ref TRACE_user_variables. * * \return A dynar with the types, must be freed with xbt_dynar_free. */ @@ -1136,9 +1050,8 @@ xbt_dynar_t TRACE_get_node_types (void) /** \ingroup TRACE_API * \brief Get Paje container types that can be mapped to the edges of a graph. * - * This function can be used to create a user made - * graph configuration file for Triva. Normally, it is - * used with the functions defined in \ref TRACE_user_variables. + * This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the + * functions defined in \ref TRACE_user_variables. * * \return A dynar with the types, must be freed with xbt_dynar_free. */