include/simgrid/instr.h

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