include/simgrid/instr.h

   1 /* Copyright (c) 2010-2018. 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 SG_BEGIN_DECL()
  12
  13 /* Functions to manage tracing categories */
  14 XBT_PUBLIC void TRACE_category(const char* category);
  15 XBT_PUBLIC void TRACE_category_with_color(const char* category, const char* color);
  16 XBT_PUBLIC xbt_dynar_t TRACE_get_categories();
  17 XBT_PUBLIC void TRACE_smpi_set_category(const char* category);
  18
  19 /*  Functions to manage tracing marks (used for trace comparison experiments) */
  20 XBT_PUBLIC void TRACE_declare_mark(const char* mark_type);
  21 XBT_PUBLIC void TRACE_declare_mark_value_with_color(const char* mark_type, const char* mark_value,
  22                                                     const char* mark_color);
  23 XBT_PUBLIC void TRACE_declare_mark_value(const char* mark_type, const char* mark_value);
  24 XBT_PUBLIC void TRACE_mark(const char* mark_type, const char* mark_value);
  25 XBT_PUBLIC xbt_dynar_t TRACE_get_marks();
  26
  27 /* Function used by graphicator (transform a SimGrid platform file in a graphviz dot file with the network topology) */
  28 XBT_PUBLIC int TRACE_platform_graph_export_graphviz(const char* filename);
  29
  30 /* User-variables related functions*/
  31 /* for VM variables */
  32 XBT_PUBLIC void TRACE_vm_variable_declare(const char* variable);
  33 XBT_PUBLIC void TRACE_vm_variable_declare_with_color(const char* variable, const char* color);
  34 XBT_PUBLIC void TRACE_vm_variable_set(const char* vm, const char* variable, double value);
  35 XBT_PUBLIC void TRACE_vm_variable_add(const char* vm, const char* variable, double value);
  36 XBT_PUBLIC void TRACE_vm_variable_sub(const char* vm, const char* variable, double value);
  37 XBT_PUBLIC void TRACE_vm_variable_set_with_time(double time, const char* vm, const char* variable, double value);
  38 XBT_PUBLIC void TRACE_vm_variable_add_with_time(double time, const char* vm, const char* variable, double value);
  39 XBT_PUBLIC void TRACE_vm_variable_sub_with_time(double time, const char* vm, const char* variable, double value);
  40
  41 /* for host variables */
  42 XBT_PUBLIC void TRACE_host_variable_declare(const char* variable);
  43 XBT_PUBLIC void TRACE_host_variable_declare_with_color(const char* variable, const char* color);
  44 XBT_PUBLIC void TRACE_host_variable_set(const char* host, const char* variable, double value);
  45 XBT_PUBLIC void TRACE_host_variable_add(const char* host, const char* variable, double value);
  46 XBT_PUBLIC void TRACE_host_variable_sub(const char* host, const char* variable, double value);
  47 XBT_PUBLIC void TRACE_host_variable_set_with_time(double time, const char* host, const char* variable, double value);
  48 XBT_PUBLIC void TRACE_host_variable_add_with_time(double time, const char* host, const char* variable, double value);
  49 XBT_PUBLIC void TRACE_host_variable_sub_with_time(double time, const char* host, const char* variable, double value);
  50 XBT_PUBLIC xbt_dynar_t TRACE_get_host_variables();
  51
  52 /* for link variables */
  53 XBT_PUBLIC void TRACE_link_variable_declare(const char* var);
  54 XBT_PUBLIC void TRACE_link_variable_declare_with_color(const char* var, const char* color);
  55 XBT_PUBLIC void TRACE_link_variable_set(const char* link, const char* variable, double value);
  56 XBT_PUBLIC void TRACE_link_variable_add(const char* link, const char* variable, double value);
  57 XBT_PUBLIC void TRACE_link_variable_sub(const char* link, const char* variable, double value);
  58 XBT_PUBLIC void TRACE_link_variable_set_with_time(double time, const char* link, const char* variable, double value);
  59 XBT_PUBLIC void TRACE_link_variable_add_with_time(double time, const char* link, const char* variable, double value);
  60 XBT_PUBLIC void TRACE_link_variable_sub_with_time(double time, const char* link, const char* variable, double value);
  61
  62 /* for link variables, but with src and dst used for get_route */
  63 XBT_PUBLIC void TRACE_link_srcdst_variable_set(const char* src, const char* dst, const char* variable, double value);
  64 XBT_PUBLIC void TRACE_link_srcdst_variable_add(const char* src, const char* dst, const char* variable, double value);
  65 XBT_PUBLIC void TRACE_link_srcdst_variable_sub(const char* src, const char* dst, const char* variable, double value);
  66 XBT_PUBLIC void TRACE_link_srcdst_variable_set_with_time(double time, const char* src, const char* dst,
  67                                                          const char* variable, double value);
  68 XBT_PUBLIC void TRACE_link_srcdst_variable_add_with_time(double time, const char* src, const char* dst,
  69                                                          const char* variable, double value);
  70 XBT_PUBLIC void TRACE_link_srcdst_variable_sub_with_time(double time, const char* src, const char* dst,
  71                                                          const char* variable, double value);
  72 XBT_PUBLIC xbt_dynar_t TRACE_get_link_variables();
  73 XBT_PUBLIC void TRACE_host_state_declare(const char* state);
  74 XBT_PUBLIC void TRACE_host_state_declare_value(const char* state, const char* value, const char* color);
  75 XBT_PUBLIC void TRACE_host_set_state(const char* host, const char* state, const char* value);
  76 XBT_PUBLIC void TRACE_host_push_state(const char* host, const char* state, const char* value);
  77 XBT_PUBLIC void TRACE_host_pop_state(const char* host, const char* state);
  78
  79 /* for creating graph configuration files for Viva by hand */
  80 XBT_PUBLIC xbt_dynar_t TRACE_get_node_types();
  81 XBT_PUBLIC xbt_dynar_t TRACE_get_edge_types();
  82
  83 SG_END_DECL()
  84
  85 #endif                          /* INSTR_H_ */