include/simgrid/instr.h

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