include/simgrid/instr.h

   1 /* Copyright (c) 2010-2023. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef INSTR_H_
   7 #define INSTR_H_
   8
   9 #include <simgrid/engine.h>
  10 #include <xbt/dynar.h> // XBT_ATTRIB_DEPRECATED_v334
  11
  12 #ifdef __cplusplus
  13 #include <set>
  14 #include <string>
  15
  16 namespace simgrid {
  17 namespace instr {
  18 /* User-variables related functions*/
  19 /* for host variables */
  20 XBT_PUBLIC void declare_host_variable(const std::string& variable, const std::string& color = "");
  21 XBT_PUBLIC void set_host_variable(const std::string& host, const std::string& variable, double value,
  22                                   double time = simgrid_get_clock());
  23 XBT_PUBLIC void add_host_variable(const std::string& host, const std::string& variable, double value,
  24                                   double time = simgrid_get_clock());
  25 XBT_PUBLIC void sub_host_variable(const std::string& host, const std::string& variable, double value,
  26                                   double time = simgrid_get_clock());
  27 XBT_PUBLIC const std::set<std::string, std::less<>>& get_host_variables();
  28
  29 /* for link variables */
  30 XBT_PUBLIC void declare_link_variable(const std::string& variable, const std::string& color = "");
  31 XBT_PUBLIC void set_link_variable(const std::string& link, const std::string& variable, double value,
  32                                   double time = simgrid_get_clock());
  33 XBT_PUBLIC void add_link_variable(const std::string& link, const std::string& variable, double value,
  34                                   double time = simgrid_get_clock());
  35 XBT_PUBLIC void sub_link_variable(const std::string& link, const std::string& variable, double value,
  36                                   double time = simgrid_get_clock());
  37 /* for link variables, but with src and dst used for get_route */
  38 XBT_PUBLIC void set_link_variable(const std::string& src, const std::string& dst, const std::string& variable,
  39                                   double value, double time = simgrid_get_clock());
  40 XBT_PUBLIC void add_link_variable(const std::string& src, const std::string& dst, const std::string& variable,
  41                                   double value, double time = simgrid_get_clock());
  42 XBT_PUBLIC void sub_link_variable(const std::string& src, const std::string& dst, const std::string& variable,
  43                                   double value, double time = simgrid_get_clock());
  44 XBT_PUBLIC const std::set<std::string, std::less<>>& get_link_variables();
  45
  46 /* for VM variables */
  47 XBT_PUBLIC void declare_vm_variable(const std::string& variable, const std::string& color = "");
  48 XBT_PUBLIC void set_vm_variable(const std::string& vm, const std::string& variable, double value,
  49                                 double time = simgrid_get_clock());
  50 XBT_PUBLIC void add_vm_variable(const std::string& vm, const std::string& variable, double value,
  51                                 double time = simgrid_get_clock());
  52 XBT_PUBLIC void sub_vm_variable(const std::string& vm, const std::string& variable, double value,
  53                                 double time = simgrid_get_clock());
  54 XBT_PUBLIC const std::set<std::string, std::less<>>& get_vm_variables();
  55
  56 /*  Functions to manage tracing marks (used for trace comparison experiments) */
  57 XBT_PUBLIC void declare_mark(const std::string& mark_type);
  58 XBT_PUBLIC void declare_mark_value(const std::string& mark_type, const std::string& mark_value,
  59                                    const std::string& mark_color = "1 1 1");
  60 XBT_PUBLIC void mark(const std::string& mark_type, const std::string& mark_value);
  61 XBT_PUBLIC const std::set<std::string, std::less<>>& get_marks();
  62
  63 XBT_PUBLIC void declare_tracing_category(const std::string& name, const std::string& color = "");
  64 XBT_PUBLIC const std::set<std::string, std::less<>>& get_tracing_categories();
  65
  66 /* Function used by graphicator (transform a SimGrid platform file in a graphviz dot file with the network topology) */
  67 XBT_PUBLIC void platform_graph_export_graphviz(const std::string& output_filename);
  68 /* Function used by graphicator (transform a SimGrid platform file in a CSV file with the network topology) */
  69 XBT_PUBLIC void platform_graph_export_csv(const std::string& output_filename);
  70 } // namespace instr
  71 } // namespace simgrid
  72
  73 #endif
  74 SG_BEGIN_DECL
  75
  76 /* Functions to manage tracing categories */
  77 XBT_PUBLIC void TRACE_smpi_set_category(const char* category);
  78
  79 XBT_PUBLIC void TRACE_host_state_declare(const char* state);
  80 XBT_PUBLIC void TRACE_host_state_declare_value(const char* state, const char* value, const char* color);
  81 XBT_PUBLIC void TRACE_host_set_state(const char* host, const char* state, const char* value);
  82 XBT_PUBLIC void TRACE_host_push_state(const char* host, const char* state, const char* value);
  83 XBT_PUBLIC void TRACE_host_pop_state(const char* host, const char* state);
  84
  85 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::platform_graph_export_graphviz") XBT_PUBLIC
  86     int TRACE_platform_graph_export_graphviz(const char* filename);
  87 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_tracing_category") XBT_PUBLIC
  88     void TRACE_category(const char* category);
  89 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_tracing_category") XBT_PUBLIC
  90     void TRACE_category_with_color(const char* category, const char* color);
  91 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_tracing_categories") XBT_PUBLIC xbt_dynar_t
  92     TRACE_get_categories();
  93 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark") XBT_PUBLIC
  94     void TRACE_declare_mark(const char* mark_type);
  95 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark_value") XBT_PUBLIC
  96     void TRACE_declare_mark_value_with_color(const char* mark_type, const char* mark_value, const char* mark_color);
  97 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_mark_value") XBT_PUBLIC
  98     void TRACE_declare_mark_value(const char* mark_type, const char* mark_value);
  99 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::mark") XBT_PUBLIC
 100     void TRACE_mark(const char* mark_type, const char* mark_value);
 101 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_marks") XBT_PUBLIC xbt_dynar_t TRACE_get_marks();
 102 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_vm_variable") XBT_PUBLIC
 103     void TRACE_vm_variable_declare(const char* variable);
 104 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_vm_variable") XBT_PUBLIC
 105     void TRACE_vm_variable_declare_with_color(const char* variable, const char* color);
 106 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_vm_variable") XBT_PUBLIC
 107     void TRACE_vm_variable_set(const char* vm, const char* variable, double value);
 108 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_vm_variable") XBT_PUBLIC
 109     void TRACE_vm_variable_add(const char* vm, const char* variable, double value);
 110 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_vm_variable") XBT_PUBLIC
 111     void TRACE_vm_variable_sub(const char* vm, const char* variable, double value);
 112 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_vm_variable") XBT_PUBLIC
 113     void TRACE_vm_variable_set_with_time(double time, const char* vm, const char* variable, double value);
 114 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_vm_variable") XBT_PUBLIC
 115     void TRACE_vm_variable_add_with_time(double time, const char* vm, const char* variable, double value);
 116 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_vm_variable") XBT_PUBLIC
 117     void TRACE_vm_variable_sub_with_time(double time, const char* vm, const char* variable, double value);
 118 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_host_variable") XBT_PUBLIC
 119     void TRACE_host_variable_declare(const char* variable);
 120 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_host_variable") XBT_PUBLIC
 121     void TRACE_host_variable_declare_with_color(const char* variable, const char* color);
 122 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_host_variable") XBT_PUBLIC
 123     void TRACE_host_variable_set(const char* host, const char* variable, double value);
 124 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_host_variable") XBT_PUBLIC
 125     void TRACE_host_variable_add(const char* host, const char* variable, double value);
 126 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_host_variable") XBT_PUBLIC
 127     void TRACE_host_variable_sub(const char* host, const char* variable, double value);
 128 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_host_variable") XBT_PUBLIC
 129     void TRACE_host_variable_set_with_time(double time, const char* host, const char* variable, double value);
 130 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_host_variable") XBT_PUBLIC
 131     void TRACE_host_variable_add_with_time(double time, const char* host, const char* variable, double value);
 132 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_host_variable") XBT_PUBLIC
 133     void TRACE_host_variable_sub_with_time(double time, const char* host, const char* variable, double value);
 134 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_host_variables") XBT_PUBLIC xbt_dynar_t
 135     TRACE_get_host_variables();
 136 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_link_variable") XBT_PUBLIC
 137     void TRACE_link_variable_declare(const char* var);
 138 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::declare_link_variable") XBT_PUBLIC
 139     void TRACE_link_variable_declare_with_color(const char* var, const char* color);
 140 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
 141     void TRACE_link_variable_set(const char* link, const char* variable, double value);
 142 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
 143     void TRACE_link_variable_add(const char* link, const char* variable, double value);
 144 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_link_variable") XBT_PUBLIC
 145     void TRACE_link_variable_sub(const char* link, const char* variable, double value);
 146 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
 147     void TRACE_link_variable_set_with_time(double time, const char* link, const char* variable, double value);
 148 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
 149     void TRACE_link_variable_add_with_time(double time, const char* link, const char* variable, double value);
 150 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::sub_link_variable") XBT_PUBLIC
 151     void TRACE_link_variable_sub_with_time(double time, const char* link, const char* variable, double value);
 152
 153 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
 154     void TRACE_link_srcdst_variable_set(const char* src, const char* dst, const char* variable, double value);
 155 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
 156     void TRACE_link_srcdst_variable_add(const char* src, const char* dst, const char* variable, double value);
 157 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr:sub_link_variable") XBT_PUBLIC
 158     void TRACE_link_srcdst_variable_sub(const char* src, const char* dst, const char* variable, double value);
 159 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::set_link_variable") XBT_PUBLIC
 160     void TRACE_link_srcdst_variable_set_with_time(double time, const char* src, const char* dst, const char* variable,
 161                                                   double value);
 162 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::add_link_variable") XBT_PUBLIC
 163     void TRACE_link_srcdst_variable_add_with_time(double time, const char* src, const char* dst, const char* variable,
 164                                                   double value);
 165 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr:sub_link_variable") XBT_PUBLIC
 166     void TRACE_link_srcdst_variable_sub_with_time(double time, const char* src, const char* dst, const char* variable,
 167                                                   double value);
 168 XBT_ATTRIB_DEPRECATED_v334("Please use simgrid::instr::get_link_variables") XBT_PUBLIC xbt_dynar_t
 169     TRACE_get_link_variables();
 170
 171 SG_END_DECL
 172
 173 #endif /* INSTR_H_ */