Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleanups and simplifications to our build system
[simgrid.git] / include / simgrid / instr.h
diff --git a/include/simgrid/instr.h b/include/simgrid/instr.h
new file mode 100644 (file)
index 0000000..23ff768
--- /dev/null
@@ -0,0 +1,99 @@
+/* Copyright (c) 2010-2014. The SimGrid Team.
+ * All rights reserved.                                                     */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#ifndef INSTR_H_
+#define INSTR_H_
+
+#include "simgrid_config.h"
+
+#include "xbt.h"
+#include "xbt/graph.h"
+#include "msg/msg.h"
+#include "simdag/simdag.h"
+
+/*
+ * Functions to manage tracing categories
+ */
+XBT_PUBLIC(void) TRACE_category(const char *category);
+XBT_PUBLIC(void) TRACE_category_with_color (const char *category, const char *color);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_categories (void);
+XBT_PUBLIC(void) TRACE_smpi_set_category(const char *category);
+XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task,
+    const char *category);
+
+/*
+ * Functions to manage tracing marks (used for trace comparison experiments)
+ */
+XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type);
+XBT_PUBLIC(void) TRACE_declare_mark_value_with_color (const char *mark_type, const char *mark_value, const char *mark_color);
+XBT_PUBLIC(void) TRACE_declare_mark_value (const char *mark_type, const char *mark_value);
+XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_marks (void);
+
+/*
+ * Function used by graphicator (transform a SimGrid platform
+ * file in a graphviz dot file with the network topology)
+ */
+XBT_PUBLIC(int) TRACE_platform_graph_export_graphviz (const char *filename);
+
+/*
+ * User-variables related functions
+ */
+/* for VM variables */
+XBT_PUBLIC(void) TRACE_vm_variable_declare (const char *variable);
+XBT_PUBLIC(void) TRACE_vm_variable_declare_with_color (const char *variable, const char *color);
+XBT_PUBLIC(void) TRACE_vm_variable_set (const char *vm, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_vm_variable_add (const char *vm, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_vm_variable_sub (const char *vm, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_vm_variables (void);
+
+
+/* for host variables */
+XBT_PUBLIC(void) TRACE_host_variable_declare (const char *variable);
+XBT_PUBLIC(void) TRACE_host_variable_declare_with_color (const char *variable, const char *color);
+XBT_PUBLIC(void) TRACE_host_variable_set (const char *host, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_host_variable_add (const char *host, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_host_variable_sub (const char *host, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_host_variables (void);
+
+/* for link variables */
+XBT_PUBLIC(void) TRACE_link_variable_declare (const char *var);
+XBT_PUBLIC(void) TRACE_link_variable_declare_with_color (const char *var, const char *color);
+XBT_PUBLIC(void) TRACE_link_variable_set (const char *link, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_variable_add (const char *link, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_variable_sub (const char *link, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value);
+
+/* for link variables, but with src and dst used for get_route */
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(void) TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_link_variables (void);
+XBT_PUBLIC(void) TRACE_host_state_declare (const char *state);
+XBT_PUBLIC(void) TRACE_host_state_declare_value (const char *state, const char *value, const char *color);
+XBT_PUBLIC(void) TRACE_host_set_state (const char *host, const char *state, const char *value);
+XBT_PUBLIC(void) TRACE_host_push_state (const char *host, const char *state, const char *value);
+XBT_PUBLIC(void) TRACE_host_pop_state (const char *host, const char *state);
+XBT_PUBLIC(void) TRACE_host_reset_state (const char *host, const char *state);
+
+/* for creating graph configuration files for Viva by hand */
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_node_types (void);
+XBT_PUBLIC(xbt_dynar_t) TRACE_get_edge_types (void);
+XBT_PUBLIC(void) TRACE_pause (void);
+XBT_PUBLIC(void) TRACE_resume (void);
+
+#endif                          /* INSTR_H_ */