X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f9df6a0ce7023e4e22d83bb6c50f27bd21fab329..a707ad979be7c88d7581f403661c67598d320d55:/include/simgrid/instr.h diff --git a/include/simgrid/instr.h b/include/simgrid/instr.h index f8d60be53f..b44eaf3305 100644 --- a/include/simgrid/instr.h +++ b/include/simgrid/instr.h @@ -1,5 +1,4 @@ -/* Copyright (c) 2010-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2010-2022. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -7,85 +6,165 @@ #ifndef INSTR_H_ #define INSTR_H_ -#include "simgrid_config.h" +#include -#include "xbt.h" -#include "xbt/graph.h" -#include "simgrid/msg.h" -#include "simgrid/simdag.h" +#ifdef __cplusplus +#include +#include -SG_BEGIN_DECL() +namespace simgrid { +namespace instr { +/* User-variables related functions*/ +/* for host variables */ +XBT_PUBLIC void declare_host_variable(const std::string& variable, const std::string& color = std::string("")); +XBT_PUBLIC void set_host_variable(const std::string& host, const std::string& variable, double value, + double time = simgrid_get_clock()); +XBT_PUBLIC void add_host_variable(const std::string& host, const std::string& variable, double value, + double time = simgrid_get_clock()); +XBT_PUBLIC void sub_host_variable(const std::string& host, const std::string& variable, double value, + double time = simgrid_get_clock()); +XBT_PUBLIC const std::set>& get_host_variables(); -/* Functions to manage tracing categories */ -XBT_PUBLIC(void) TRACE_category(const char *category); -XBT_PUBLIC(void) TRACE_category_with_color (const char *category, const char *color); -XBT_PUBLIC(xbt_dynar_t) TRACE_get_categories (); -XBT_PUBLIC(void) TRACE_smpi_set_category(const char *category); +/* for link variables */ +XBT_PUBLIC void declare_link_variable(const std::string& variable, const std::string& color = std::string("")); +XBT_PUBLIC void set_link_variable(const std::string& link, const std::string& variable, double value, + double time = simgrid_get_clock()); +XBT_PUBLIC void add_link_variable(const std::string& link, const std::string& variable, double value, + double time = simgrid_get_clock()); +XBT_PUBLIC void sub_link_variable(const std::string& link, const std::string& variable, double value, + double time = simgrid_get_clock()); +/* for link variables, but with src and dst used for get_route */ +XBT_PUBLIC void set_link_variable(const std::string& src, const std::string& dst, const std::string& variable, + double value, double time = simgrid_get_clock()); +XBT_PUBLIC void add_link_variable(const std::string& src, const std::string& dst, const std::string& variable, + double value, double time = simgrid_get_clock()); +XBT_PUBLIC void sub_link_variable(const std::string& src, const std::string& dst, const std::string& variable, + double value, double time = simgrid_get_clock()); +XBT_PUBLIC const std::set>& get_link_variables(); + +/* for VM variables */ +XBT_PUBLIC void declare_vm_variable(const std::string& variable, const std::string& color = std::string("")); +XBT_PUBLIC void set_vm_variable(const std::string& vm, const std::string& variable, double value, + double time = simgrid_get_clock()); +XBT_PUBLIC void add_vm_variable(const std::string& vm, const std::string& variable, double value, + double time = simgrid_get_clock()); +XBT_PUBLIC void sub_vm_variable(const std::string& vm, const std::string& variable, double value, + double time = simgrid_get_clock()); +XBT_PUBLIC const std::set>& get_vm_variables(); /* Functions to manage tracing marks (used for trace comparison experiments) */ -XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type); -XBT_PUBLIC(void) TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color); -XBT_PUBLIC(void) TRACE_declare_mark_value (const char *mark_type, const char *mark_value); -XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value); -XBT_PUBLIC(xbt_dynar_t) TRACE_get_marks (); +XBT_PUBLIC void declare_mark(const std::string& mark_type); +XBT_PUBLIC void declare_mark_value(const std::string& mark_type, const std::string& mark_value, + const std::string& mark_color = std::string("1 1 1")); +XBT_PUBLIC void mark(const std::string& mark_type, const std::string& mark_value); +XBT_PUBLIC const std::set>& get_marks(); + +XBT_PUBLIC void declare_tracing_category(const std::string& name, const std::string& color = ""); +XBT_PUBLIC const std::set>& get_tracing_categories(); /* Function used by graphicator (transform a SimGrid platform file in a graphviz dot file with the network topology) */ -XBT_PUBLIC(int) TRACE_platform_graph_export_graphviz (const char *filename); +XBT_PUBLIC void platform_graph_export_graphviz(const std::string& output_filename); +} // namespace instr +} // namespace simgrid -/* User-variables related functions*/ -/* for VM variables */ -XBT_PUBLIC(void) TRACE_vm_variable_declare (const char *variable); -XBT_PUBLIC(void) TRACE_vm_variable_declare_with_color (const char *variable, const char *color); -XBT_PUBLIC(void) TRACE_vm_variable_set (const char *vm, const char *variable, double value); -XBT_PUBLIC(void) TRACE_vm_variable_add (const char *vm, const char *variable, double value); -XBT_PUBLIC(void) TRACE_vm_variable_sub (const char *vm, const char *variable, double value); -XBT_PUBLIC(void) TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value); -XBT_PUBLIC(void) TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value); -XBT_PUBLIC(void) TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value); -XBT_PUBLIC(xbt_dynar_t) TRACE_get_vm_variables (); +#endif +SG_BEGIN_DECL -/* for host variables */ -XBT_PUBLIC(void) TRACE_host_variable_declare (const char *variable); -XBT_PUBLIC(void) TRACE_host_variable_declare_with_color (const char *variable, const char *color); -XBT_PUBLIC(void) TRACE_host_variable_set (const char *host, const char *variable, double value); -XBT_PUBLIC(void) TRACE_host_variable_add (const char *host, const char *variable, double value); -XBT_PUBLIC(void) TRACE_host_variable_sub (const char *host, const char *variable, double value); -XBT_PUBLIC(void) TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value); -XBT_PUBLIC(void) TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value); -XBT_PUBLIC(void) TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value); -XBT_PUBLIC(xbt_dynar_t) TRACE_get_host_variables (); +/* Functions to manage tracing categories */ +XBT_PUBLIC void TRACE_smpi_set_category(const char* category); -/* for link variables */ -XBT_PUBLIC(void) TRACE_link_variable_declare (const char *var); -XBT_PUBLIC(void) TRACE_link_variable_declare_with_color (const char *var, const char *color); -XBT_PUBLIC(void) TRACE_link_variable_set (const char *link, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_variable_add (const char *link, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_variable_sub (const char *link, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value); +XBT_PUBLIC void TRACE_host_state_declare(const char* state); +XBT_PUBLIC void TRACE_host_state_declare_value(const char* state, const char* value, const char* color); +XBT_PUBLIC void TRACE_host_set_state(const char* host, const char* state, const char* value); +XBT_PUBLIC void TRACE_host_push_state(const char* host, const char* state, const char* value); +XBT_PUBLIC void TRACE_host_pop_state(const char* host, const char* state); -/* for link variables, but with src and dst used for get_route */ -XBT_PUBLIC(void) TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value); -XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value); -XBT_PUBLIC(xbt_dynar_t) TRACE_get_link_variables (); -XBT_PUBLIC(void) TRACE_host_state_declare (const char *state); -XBT_PUBLIC(void) TRACE_host_state_declare_value (const char *state, const char *value, const char *color); -XBT_PUBLIC(void) TRACE_host_set_state (const char *host, const char *state, const char *value); -XBT_PUBLIC(void) TRACE_host_push_state (const char *host, const char *state, const char *value); -XBT_PUBLIC(void) TRACE_host_pop_state (const char *host, const char *state); -XBT_PUBLIC(void) TRACE_host_reset_state (const char *host, const char *state); - -/* for creating graph configuration files for Viva by hand */ -XBT_PUBLIC(xbt_dynar_t) TRACE_get_node_types (); -XBT_PUBLIC(xbt_dynar_t) TRACE_get_edge_types (); -XBT_PUBLIC(void) TRACE_pause (); -XBT_PUBLIC(void) TRACE_resume (); - -SG_END_DECL() - -#endif /* INSTR_H_ */ +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::platform_graph_export_graphviz") XBT_PUBLIC + int TRACE_platform_graph_export_graphviz(const char* filename); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_tracing_category") XBT_PUBLIC + void TRACE_category(const char* category); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_tracing_category") XBT_PUBLIC + void TRACE_category_with_color(const char* category, const char* color); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_tracing_categories") XBT_PUBLIC xbt_dynar_t + TRACE_get_categories(); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark") XBT_PUBLIC + void TRACE_declare_mark(const char* mark_type); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark_value") XBT_PUBLIC + void TRACE_declare_mark_value_with_color(const char* mark_type, const char* mark_value, const char* mark_color); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark_value") XBT_PUBLIC + void TRACE_declare_mark_value(const char* mark_type, const char* mark_value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::mark") XBT_PUBLIC + void TRACE_mark(const char* mark_type, const char* mark_value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_marks") XBT_PUBLIC xbt_dynar_t TRACE_get_marks(); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_vm_variable") XBT_PUBLIC + void TRACE_vm_variable_declare(const char* variable); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_vm_variable") XBT_PUBLIC + void TRACE_vm_variable_declare_with_color(const char* variable, const char* color); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_vm_variable") XBT_PUBLIC + void TRACE_vm_variable_set(const char* vm, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_vm_variable") XBT_PUBLIC + void TRACE_vm_variable_add(const char* vm, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_vm_variable") XBT_PUBLIC + void TRACE_vm_variable_sub(const char* vm, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_vm_variable") XBT_PUBLIC + void TRACE_vm_variable_set_with_time(double time, const char* vm, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_vm_variable") XBT_PUBLIC + void TRACE_vm_variable_add_with_time(double time, const char* vm, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_vm_variable") XBT_PUBLIC + void TRACE_vm_variable_sub_with_time(double time, const char* vm, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_host_variable") XBT_PUBLIC + void TRACE_host_variable_declare(const char* variable); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_host_variable") XBT_PUBLIC + void TRACE_host_variable_declare_with_color(const char* variable, const char* color); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_host_variable") XBT_PUBLIC + void TRACE_host_variable_set(const char* host, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_host_variable") XBT_PUBLIC + void TRACE_host_variable_add(const char* host, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_host_variable") XBT_PUBLIC + void TRACE_host_variable_sub(const char* host, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_host_variable") XBT_PUBLIC + void TRACE_host_variable_set_with_time(double time, const char* host, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_host_variable") XBT_PUBLIC + void TRACE_host_variable_add_with_time(double time, const char* host, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_host_variable") XBT_PUBLIC + void TRACE_host_variable_sub_with_time(double time, const char* host, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_host_variables") XBT_PUBLIC xbt_dynar_t + TRACE_get_host_variables(); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_link_variable") XBT_PUBLIC + void TRACE_link_variable_declare(const char* var); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_link_variable") XBT_PUBLIC + void TRACE_link_variable_declare_with_color(const char* var, const char* color); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC + void TRACE_link_variable_set(const char* link, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC + void TRACE_link_variable_add(const char* link, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_link_variable") XBT_PUBLIC + void TRACE_link_variable_sub(const char* link, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC + void TRACE_link_variable_set_with_time(double time, const char* link, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC + void TRACE_link_variable_add_with_time(double time, const char* link, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_link_variable") XBT_PUBLIC + void TRACE_link_variable_sub_with_time(double time, const char* link, const char* variable, double value); + +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC + void TRACE_link_srcdst_variable_set(const char* src, const char* dst, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC + void TRACE_link_srcdst_variable_add(const char* src, const char* dst, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr:sub_link_variable") XBT_PUBLIC + void TRACE_link_srcdst_variable_sub(const char* src, const char* dst, const char* variable, double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC + void TRACE_link_srcdst_variable_set_with_time(double time, const char* src, const char* dst, const char* variable, + double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC + void TRACE_link_srcdst_variable_add_with_time(double time, const char* src, const char* dst, const char* variable, + double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr:sub_link_variable") XBT_PUBLIC + void TRACE_link_srcdst_variable_sub_with_time(double time, const char* src, const char* dst, const char* variable, + double value); +XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_link_variables") XBT_PUBLIC xbt_dynar_t + TRACE_get_link_variables(); + +SG_END_DECL + +#endif /* INSTR_H_ */