include/simgrid/instr.h

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