-/* Copyright (c) 2010. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2010-2017. 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. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef INSTR_PRIVATE_H_
#define INSTR_PRIVATE_H_
-#include "simgrid_config.h"
+#include <xbt/base.h>
-#ifdef HAVE_TRACING
+#include "instr/instr_interface.h"
+#include "simgrid/instr.h"
+#include "simgrid_config.h"
+#include "src/internal_config.h"
+#include <set>
/* Need to define function drand48 for Windows */
+/* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
#ifdef _WIN32
# define drand48() (rand()/(RAND_MAX + 1.0))
#endif
#define INSTR_DEFAULT_STR_SIZE 500
-#include "instr/instr.h"
-#include "msg/msg.h"
-#include "simdag/private.h"
-#include "simix/smx_private.h"
-#include "xbt/graph_private.h"
+#include "xbt/graph.h"
+#include "xbt/dict.h"
+namespace simgrid {
+namespace instr {
typedef enum {
PAJE_DefineContainerType,
PAJE_DefineVariableType,
TYPE_EVENT
} e_entity_types;
-typedef struct s_type *type_t;
-typedef struct s_type {
- char *id;
- char *name;
- char *color;
- e_entity_types kind;
- struct s_type *father;
- xbt_dict_t children;
- xbt_dict_t values; //valid for all types except variable and container
-}s_type_t;
-
-typedef struct s_val *val_t;
-typedef struct s_val {
- char *id;
- char *name;
- char *color;
- type_t father;
-}s_val_t;
+//--------------------------------------------------
+
+class Type {
+public:
+ char* id_;
+ char* name_;
+ char* color_;
+
+ e_entity_types kind_;
+ Type* father_;
+ xbt_dict_t children_;
+ xbt_dict_t values_; // valid for all types except variable and container
+ Type(const char* typeNameBuff, const char* key, const char* color, e_entity_types kind, Type* father);
+ ~Type();
+ Type* getChild(const char* name);
+ Type* getChildOrNull(const char* name);
+
+ static Type* containerNew(const char* name, Type* father);
+ static Type* eventNew(const char* name, Type* father);
+ static Type* variableNew(const char* name, const char* color, Type* father);
+ static Type* linkNew(const char* name, Type* father, Type* source, Type* dest);
+ static Type* stateNew(const char* name, Type* father);
+};
+
+//--------------------------------------------------
+class Value {
+public:
+ char* id_;
+ char* name_;
+ char* color_;
+ Type* father_;
+ Value(const char* name, const char* color, Type* father);
+ ~Value();
+ static Value* get_or_new(const char* name, const char* color, Type* father);
+ static Value* get(const char* name, Type* father);
+};
+
+
+//--------------------------------------------------
typedef enum {
INSTR_HOST,
INSTR_LINK,
INSTR_MSG_TASK
} e_container_types;
-typedef struct s_container *container_t;
-typedef struct s_container {
- sg_routing_edge_t net_elm;
- char *name; /* Unique name of this container */
- char *id; /* Unique id of this container */
- type_t type; /* Type of this container */
- int level; /* Level in the hierarchy, root level is 0 */
- e_container_types kind; /* This container is of what kind */
- struct s_container *father;
- xbt_dict_t children;
-}s_container_t;
-
-extern xbt_dict_t created_categories;
-extern xbt_dict_t declared_marks;
-extern xbt_dict_t user_host_variables;
-extern xbt_dict_t user_vm_variables;
-extern xbt_dict_t user_link_variables;
-extern double TRACE_last_timestamp_to_dump;
+//--------------------------------------------------
+
+class Container {
+public:
+ Container(const char* name, simgrid::instr::e_container_types kind, Container* father);
+ virtual ~Container();
+
+ sg_netpoint_t netpoint_;
+ char* name_; /* Unique name of this container */
+ char* id_; /* Unique id of this container */
+ Type* type_; /* Type of this container */
+ int level_ = 0; /* Level in the hierarchy, root level is 0 */
+ e_container_types kind_; /* This container is of what kind */
+ Container* father_;
+ xbt_dict_t children_;
+};
+
+//--------------------------------------------------
+class PajeEvent {
+ public:
+ double timestamp_;
+ e_event_type eventType_;
+ virtual void print() = 0;
+ virtual ~PajeEvent();
+};
+
+//--------------------------------------------------
+class SetVariableEvent : public PajeEvent {
+ private:
+ Container* container;
+ Type* type;
+ double value;
+
+ public:
+ SetVariableEvent(double timestamp, Container* container, Type* type, double value);
+ void print() override;
+};
+
+class AddVariableEvent:public PajeEvent {
+ private:
+ Container* container;
+ Type* type;
+ double value;
+
+ public:
+ AddVariableEvent(double timestamp, Container* container, Type* type, double value);
+ void print() override;
+};
+//--------------------------------------------------
+
+
+class SubVariableEvent : public PajeEvent {
+ private:
+ Container* container;
+ Type* type;
+ double value;
+
+ public:
+ SubVariableEvent(double timestamp, Container* container, Type* type, double value);
+ void print() override;
+};
+//--------------------------------------------------
+
+class SetStateEvent : public PajeEvent {
+ private:
+ Container* container;
+ Type* type;
+ Value* val;
+ const char* filename;
+ int linenumber;
+
+ public:
+ SetStateEvent(double timestamp, Container* container, Type* type, Value* val);
+ void print() override;
+};
+
+
+class PushStateEvent : public PajeEvent {
+ public:
+ Container* container;
+ Type* type;
+ Value* val;
+ int size;
+ const char* filename;
+ int linenumber;
+ void* extra_;
+
+ public:
+ PushStateEvent(double timestamp, Container* container, Type* type, Value* val);
+ PushStateEvent(double timestamp, Container* container, Type* type, Value* val, void* extra);
+ void print() override;
+};
+
+class PopStateEvent : public PajeEvent {
+ Container* container;
+ Type* type;
+
+public:
+ PopStateEvent(double timestamp, Container* container, Type* type);
+ void print() override;
+};
+
+class ResetStateEvent : public PajeEvent {
+ Container* container;
+ Type* type;
+
+public:
+ ResetStateEvent(double timestamp, Container* container, Type* type);
+ void print() override;
+};
+
+class StartLinkEvent : public PajeEvent {
+ Container* container_;
+ Type* type_;
+ Container* sourceContainer_;
+ std::string value_;
+ std::string key_;
+ int size_;
+
+public:
+ StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, const char* value,
+ const char* key);
+ StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, const char* value,
+ const char* key, int size);
+ void print() override;
+};
+
+class EndLinkEvent : public PajeEvent {
+ Container* container;
+ Type* type;
+ Container* destContainer;
+ char *value;
+ char *key;
+ public:
+ EndLinkEvent(double timestamp, Container* container, Type* type, Container* destContainer, const char* value,
+ const char* key);
+ ~EndLinkEvent();
+ void print() override;
+};
+
+
+class NewEvent : public PajeEvent {
+ public:
+ Container* container;
+ Type* type;
+ Value* val;
+
+ public:
+ NewEvent(double timestamp, Container* container, Type* type, Value* val);
+ void print() override;
+};
+}
+} // namespace simgrid::instr
+typedef simgrid::instr::Container* container_t;
+
+SG_BEGIN_DECL()
+
+extern XBT_PRIVATE std::set<std::string> created_categories;
+extern XBT_PRIVATE std::set<std::string> declared_marks;
+extern XBT_PRIVATE std::set<std::string> user_host_variables;
+extern XBT_PRIVATE std::set<std::string> user_vm_variables;
+extern XBT_PRIVATE std::set<std::string> user_link_variables;
+extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
/* instr_paje_header.c */
-void TRACE_header(int basic);
+XBT_PRIVATE void TRACE_header(int basic, int size);
/* from paje.c */
-void TRACE_paje_start(void);
-void TRACE_paje_end(void);
-void TRACE_paje_dump_buffer (int force);
-void new_pajeDefineContainerType(type_t type);
-void new_pajeDefineVariableType(type_t type);
-void new_pajeDefineStateType(type_t type);
-void new_pajeDefineEventType(type_t type);
-void new_pajeDefineLinkType(type_t type, type_t source, type_t dest);
-void new_pajeDefineEntityValue (val_t type);
-void new_pajeCreateContainer (container_t container);
-void new_pajeDestroyContainer (container_t container);
-void new_pajeSetVariable (double timestamp, container_t container, type_t type, double value);
-void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value);
-void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value);
-void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value);
-void new_pajePushState (double timestamp, container_t container, type_t type, val_t value);
-void new_pajePopState (double timestamp, container_t container, type_t type);
-void new_pajeResetState (double timestamp, container_t container, type_t type);
-void new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer, const char *value, const char *key);
-void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer, const char *value, const char *key);
-void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value);
-
-/* declaration of instrumentation functions from msg_task_instr.c */
-void TRACE_msg_set_task_category(msg_task_t task, const char *category);
-void TRACE_msg_task_create(msg_task_t task);
-void TRACE_msg_task_execute_start(msg_task_t task);
-void TRACE_msg_task_execute_end(msg_task_t task);
-void TRACE_msg_task_destroy(msg_task_t task);
-void TRACE_msg_task_get_start(void);
-void TRACE_msg_task_get_end(double start_time, msg_task_t task);
-int TRACE_msg_task_put_start(msg_task_t task); //returns TRUE if the task_put_end must be called
-void TRACE_msg_task_put_end(void);
-
-/* declaration of instrumentation functions from msg_process_instr.c */
-char *instr_process_id (msg_process_t proc, char *str, int len);
-char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
-void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host,
- msg_host_t new_host);
-void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
-void TRACE_msg_process_destroy (const char *process_name, int process_pid, msg_host_t host);
-void TRACE_msg_process_kill(msg_process_t process);
-void TRACE_msg_process_suspend(msg_process_t process);
-void TRACE_msg_process_resume(msg_process_t process);
-void TRACE_msg_process_sleep_in(msg_process_t process); //called from msg/gos.c
-void TRACE_msg_process_sleep_out(msg_process_t process);
-void TRACE_msg_process_end(msg_process_t process);
-
-/* declaration of instrumentation functions from instr_msg_vm.c */
-char *instr_vm_id (msg_vm_t vm, char *str, int len);
-char *instr_vm_id_2 (const char *vm_name, char *str, int len);
-void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host,
- msg_host_t new_host);
-void TRACE_msg_vm_create (const char *vm_name, msg_host_t host);
-void TRACE_msg_vm_kill(msg_vm_t process);
-void TRACE_msg_vm_suspend(msg_vm_t vm);
-void TRACE_msg_vm_resume(msg_vm_t vm);
-void TRACE_msg_vm_sleep_in(msg_vm_t vm);
-void TRACE_msg_vm_sleep_out(msg_vm_t vm);
-void TRACE_msg_vm_end(msg_vm_t vm);
-
-/* from surf_instr.c */
-void TRACE_surf_alloc(void);
-void TRACE_surf_release(void);
-void TRACE_surf_host_set_power(double date, const char *resource, double power);
-void TRACE_surf_link_set_bandwidth(double date, const char *resource, double bandwidth);
-void TRACE_surf_link_set_latency(double date, const char *resource, double latency);
-void TRACE_surf_action(surf_action_t surf_action, const char *category);
-
-//for tracing gtnets
-void TRACE_surf_gtnets_communicate(void *action, void *src, void *dst);
-
-/* from smpi_instr.c */
-void TRACE_internal_smpi_set_category (const char *category);
-const char *TRACE_internal_smpi_get_category (void);
-void TRACE_smpi_alloc(void);
-void TRACE_smpi_release(void);
-void TRACE_smpi_init(int rank);
-void TRACE_smpi_finalize(int rank);
-void TRACE_smpi_collective_in(int rank, int root, const char *operation);
-void TRACE_smpi_collective_out(int rank, int root, const char *operation);
-void TRACE_smpi_computing_init(int rank);
-void TRACE_smpi_computing_out(int rank);
-void TRACE_smpi_computing_in(int rank);
-void TRACE_smpi_ptp_in(int rank, int src, int dst, const char *operation);
-void TRACE_smpi_ptp_out(int rank, int src, int dst, const char *operation);
-void TRACE_smpi_send(int rank, int src, int dst);
-void TRACE_smpi_recv(int rank, int src, int dst);
+XBT_PRIVATE void TRACE_paje_start();
+XBT_PRIVATE void TRACE_paje_end();
+XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
+
/* from instr_config.c */
-int TRACE_start (void);
-int TRACE_end (void);
-int TRACE_needs_platform (void);
-int TRACE_is_enabled(void);
-int TRACE_platform(void);
-int TRACE_platform_topology(void);
-int TRACE_is_configured(void);
-int TRACE_smpi_is_enabled(void);
-int TRACE_smpi_is_grouped(void);
-int TRACE_smpi_is_computing(void);
-int TRACE_categorized (void);
-int TRACE_uncategorized (void);
-int TRACE_msg_process_is_enabled(void);
-int TRACE_msg_vm_is_enabled(void);
-int TRACE_buffer (void);
-int TRACE_onelink_only (void);
-int TRACE_disable_destroy (void);
-int TRACE_basic (void);
-char *TRACE_get_comment (void);
-char *TRACE_get_comment_file (void);
-char *TRACE_get_filename(void);
-char *TRACE_get_viva_uncat_conf (void);
-char *TRACE_get_viva_cat_conf (void);
-void TRACE_global_init(int *argc, char **argv);
-void TRACE_help(int detailed);
-void TRACE_generate_viva_uncat_conf (void);
-void TRACE_generate_viva_cat_conf (void);
-void instr_pause_tracing (void);
-void instr_resume_tracing (void);
+XBT_PRIVATE bool TRACE_needs_platform ();
+XBT_PRIVATE bool TRACE_is_enabled();
+XBT_PRIVATE bool TRACE_platform();
+XBT_PRIVATE bool TRACE_platform_topology();
+XBT_PRIVATE bool TRACE_is_configured();
+XBT_PRIVATE bool TRACE_categorized ();
+XBT_PRIVATE bool TRACE_uncategorized ();
+XBT_PRIVATE bool TRACE_msg_process_is_enabled();
+XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
+XBT_PRIVATE bool TRACE_buffer ();
+XBT_PRIVATE bool TRACE_disable_link();
+XBT_PRIVATE bool TRACE_disable_speed();
+XBT_PRIVATE bool TRACE_onelink_only ();
+XBT_PRIVATE bool TRACE_disable_destroy ();
+XBT_PRIVATE bool TRACE_basic ();
+XBT_PRIVATE bool TRACE_display_sizes ();
+XBT_PRIVATE char *TRACE_get_comment ();
+XBT_PRIVATE char *TRACE_get_comment_file ();
+XBT_PRIVATE int TRACE_precision ();
+XBT_PRIVATE char *TRACE_get_filename();
+XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
+XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
+XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
+XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
+XBT_PRIVATE void instr_pause_tracing ();
+XBT_PRIVATE void instr_resume_tracing ();
+
+/* Public functions used in SMPI */
+XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
+XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
+XBT_PUBLIC(bool) TRACE_smpi_is_computing();
+XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
+XBT_PUBLIC(bool) TRACE_smpi_view_internals();
/* from resource_utilization.c */
-void TRACE_surf_host_set_utilization(const char *resource,
- const char *category,
- double value,
- double now,
+XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
double delta);
-void TRACE_surf_link_set_utilization(const char *resource,
- const char *category,
- double value,
- double now,
+XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
double delta);
-void TRACE_surf_resource_utilization_alloc(void);
-void TRACE_surf_resource_utilization_release(void);
+XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
/* instr_paje.c */
-extern xbt_dict_t trivaNodeTypes;
-extern xbt_dict_t trivaEdgeTypes;
-long long int instr_new_paje_id (void);
-void PJ_container_alloc (void);
-void PJ_container_release (void);
-container_t PJ_container_new (const char *name, e_container_types kind, container_t father);
-container_t PJ_container_get (const char *name);
-container_t PJ_container_get_or_null (const char *name);
-container_t PJ_container_get_root (void);
-void PJ_container_set_root (container_t root);
-void PJ_container_free (container_t container);
-void PJ_container_free_all (void);
-void PJ_container_remove_from_parent (container_t container);
+extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
+extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
+XBT_PRIVATE long long int instr_new_paje_id ();
+XBT_PUBLIC(container_t) PJ_container_get (const char *name);
+XBT_PUBLIC(simgrid::instr::Container*) PJ_container_get_or_null(const char* name);
+XBT_PUBLIC(container_t) PJ_container_get_root ();
+XBT_PUBLIC(void) PJ_container_set_root (container_t root);
+XBT_PUBLIC(void) PJ_container_free_all (void);
+XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
/* instr_paje_types.c */
-void PJ_type_alloc (void);
-void PJ_type_release (void);
-type_t PJ_type_get_root (void);
-type_t PJ_type_container_new (const char *name, type_t father);
-type_t PJ_type_event_new (const char *name, type_t father);
-type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
-type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
-type_t PJ_type_state_new (const char *name, type_t father);
-type_t PJ_type_get (const char *name, const type_t father);
-type_t PJ_type_get_or_null (const char *name, type_t father);
-void PJ_type_free (type_t type);
-void PJ_type_free_all (void);
-
-/* instr_paje_values.c */
-val_t PJ_value_new (const char *name, const char *color, type_t father);
-val_t PJ_value_get_or_new (const char *name, const char *color, type_t father);
-val_t PJ_value_get (const char *name, const type_t father);
-void PJ_value_free (val_t value);
-
-/* instr_routing.c */
-void instr_routing_define_callbacks (void);
-void instr_new_variable_type (const char *new_typename, const char *color);
-void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
-void instr_new_user_state_type (const char *father_type, const char *new_typename);
-void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
-int instr_platform_traced (void);
-xbt_graph_t instr_routing_platform_graph (void);
-void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
-
-#endif /* HAVE_TRACING */
-
-#ifdef HAVE_JEDULE
-#include "instr/jedule/jedule_sd_binding.h"
-#endif
+XBT_PUBLIC(simgrid::instr::Type*) PJ_type_get_root();
+
+/* instr_config.c */
+XBT_PRIVATE void TRACE_TI_start();
+XBT_PRIVATE void TRACE_TI_end();
+
+XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
+XBT_PRIVATE void dump_comment_file (const char *filename);
+XBT_PRIVATE void dump_comment (const char *comment);
+
+struct s_instr_extra_data;
+typedef struct s_instr_extra_data *instr_extra_data;
+
+typedef enum{
+ TRACING_INIT,
+ TRACING_FINALIZE,
+ TRACING_COMM_SIZE,
+ TRACING_COMM_SPLIT,
+ TRACING_COMM_DUP,
+ TRACING_SEND,
+ TRACING_ISEND,
+ TRACING_SSEND,
+ TRACING_ISSEND,
+ TRACING_RECV,
+ TRACING_IRECV,
+ TRACING_SENDRECV,
+ TRACING_TEST,
+ TRACING_WAIT,
+ TRACING_WAITALL,
+ TRACING_WAITANY,
+ TRACING_BARRIER,
+ TRACING_BCAST,
+ TRACING_REDUCE,
+ TRACING_ALLREDUCE,
+ TRACING_ALLTOALL,
+ TRACING_ALLTOALLV,
+ TRACING_GATHER,
+ TRACING_GATHERV,
+ TRACING_SCATTER,
+ TRACING_SCATTERV,
+ TRACING_ALLGATHER,
+ TRACING_ALLGATHERV,
+ TRACING_REDUCE_SCATTER,
+ TRACING_COMPUTING,
+ TRACING_SLEEPING,
+ TRACING_SCAN,
+ TRACING_EXSCAN
+} e_caller_type ;
-#endif /* INSTR_PRIVATE_H_ */
+typedef struct s_instr_extra_data {
+ e_caller_type type;
+ int send_size;
+ int recv_size;
+ double comp_size;
+ double sleep_duration;
+ int src;
+ int dst;
+ int root;
+ const char* datatype1;
+ const char* datatype2;
+ int * sendcounts;
+ int * recvcounts;
+ int num_processes;
+} s_instr_extra_data_t;
+
+/* Format of TRACING output.
+ * - paje is the regular format, that we all know
+ * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such trace can easily be replayed with smpi_replay afterward.
+ * This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
+ */
+typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
+extern instr_fmt_type_t instr_fmt_type;
+
+SG_END_DECL()
+
+void LogContainerTypeDefinition(simgrid::instr::Type* type);
+void LogVariableTypeDefinition(simgrid::instr::Type* type);
+void LogStateTypeDefinition(simgrid::instr::Type* type);
+void LogLinkTypeDefinition(simgrid::instr::Type* type, simgrid::instr::Type* source, simgrid::instr::Type* dest);
+void LogEntityValue(simgrid::instr::Value* val);
+void LogContainerCreation (container_t container);
+void LogContainerDestruction (container_t container);
+void LogDefineEventType(simgrid::instr::Type* type);
+
+#endif
