Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
instr: prefer std::str to char*
[simgrid.git] / src / instr / instr_private.h
index 9220a77..c952056 100644 (file)
@@ -8,12 +8,11 @@
 
 #include <xbt/base.h>
 
-#include "simgrid/instr.h"
 #include "instr/instr_interface.h"
-#include "src/internal_config.h"
+#include "simgrid/instr.h"
 #include "simgrid_config.h"
-
-SG_BEGIN_DECL()
+#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 */
@@ -26,6 +25,8 @@ SG_BEGIN_DECL()
 #include "xbt/graph.h"
 #include "xbt/dict.h"
 
+namespace simgrid {
+namespace instr {
 typedef enum {
   PAJE_DefineContainerType,
   PAJE_DefineVariableType,
@@ -56,33 +57,43 @@ typedef enum {
 } e_entity_types;
 
 //--------------------------------------------------
-class s_type;
-typedef s_type *type_t;
-class s_type {
-  public:
-  char *id;
-  char *name;
-  char *color;
-  e_entity_types kind;
-  s_type *father;
-  xbt_dict_t children;
-  xbt_dict_t values; //valid for all types except variable and container
-};
 
-typedef s_type s_type_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 s_val;
-typedef s_val *val_t;
-
-class s_val {
-  public:
-  char *id;
-  char *name;
-  char *color;
-  type_t 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 s_val s_val_t;
+
 
 //--------------------------------------------------
 typedef enum {
@@ -97,228 +108,167 @@ typedef enum {
 } e_container_types;
 
 //--------------------------------------------------
-class s_container;
-typedef s_container *container_t;
-
-class s_container {
-  public: 
-  sg_netpoint_t netpoint;
-  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 */
-  s_container *father;
-  xbt_dict_t children;
-};
-typedef s_container s_container_t;
 
-//--------------------------------------------------
-class paje_event;
-typedef paje_event *paje_event_t;
-
-class paje_event {
-  public:
-  double timestamp;
-  e_event_type event_type;
-  virtual void print(){};
-  void *data;
-  virtual ~paje_event();
+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_;
 };
-typedef paje_event s_paje_event_t;
-
-class DefineContainerEvent : public paje_event
-{
-  public:
-  type_t type;
-  void print() override;
-  DefineContainerEvent(type_t);
-};
-
-//--------------------------------------------------
-
 
 //--------------------------------------------------
-
-class DefineVariableTypeEvent : public paje_event 
-{
+class PajeEvent {
   public:
-  type_t type;
-   DefineVariableTypeEvent(type_t type);
-   void print() override;
+    double timestamp_;
+    e_event_type eventType_;
+    virtual void print() = 0;
+    virtual ~PajeEvent();
 };
-//--------------------------------------------------
 
-class DefineStateTypeEvent : public paje_event  {
-  type_t type;
-  public:
-  DefineStateTypeEvent(type_t type);
-  void print();// override;
-};
-
-class DefineEventTypeEvent : public paje_event  {
-  type_t type;
-  public: 
-  DefineEventTypeEvent(type_t type);
-  void print() override;
-};
+//--------------------------------------------------
+class SetVariableEvent : public PajeEvent  {
+  private:
+    Container* container;
+    Type* type;
+    double value;
 
-class DefineLinkTypeEvent : public paje_event  {
-  type_t type;
-  type_t source;
-  type_t dest;
   public:
-  DefineLinkTypeEvent(type_t type, type_t source, type_t dest);
-  void print() override;
+    SetVariableEvent(double timestamp, Container* container, Type* type, double value);
+    void print() override;
 };
 
-class DefineEntityValueEvent : public paje_event  {
-  val_t value;
-  public:
-  DefineEntityValueEvent (val_t type);
-  void print() override;
-};
+class AddVariableEvent:public PajeEvent {
+  private:
+    Container* container;
+    Type* type;
+    double value;
 
-class CreateContainerEvent : public paje_event  {
   public:
-  container_t container;
-  explicit CreateContainerEvent (container_t container);
-  void print() override;
+    AddVariableEvent(double timestamp, Container* container, Type* type, double value);
+    void print() override;
 };
+//--------------------------------------------------
 
-class DestroyContainerEvent : public paje_event  {
-  public:
-  container_t container;
-  DestroyContainerEvent (container_t container);
-  void print() override;
-};
 
+class SubVariableEvent : public PajeEvent  {
+  private:
+    Container* container;
+    Type* type;
+    double value;
 
-class SetVariableEvent : public paje_event  {
-  container_t container;
-  type_t type;
-  double value;
   public:
-  SetVariableEvent (double timestamp, container_t container, type_t type, double value);
-  void print() override;
+    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;
 
-class AddVariableEvent:public paje_event {
-  container_t container;
-  type_t type;
-  double value;
   public:
-  AddVariableEvent (double timestamp, container_t container, type_t type, double value);
-  void print() override;
+    SetStateEvent(double timestamp, Container* container, Type* type, Value* val);
+    void print() override;
 };
 
-//--------------------------------------------------
-
 
-class SubVariableEvent : public paje_event  {
-  public:
-  container_t container;
-  type_t type;
-  double value; 
+class PushStateEvent : public PajeEvent  {
   public:
-  SubVariableEvent(double timestamp, container_t container, type_t type, double value);
-  void print() override;
-};
-//--------------------------------------------------
+    Container* container;
+    Type* type;
+    Value* val;
+    int size;
+    const char* filename;
+    int linenumber;
+    void* extra_;
 
-class SetStateEvent : public paje_event  {
   public:
-  container_t container;
-  type_t type;
-  val_t value;
-  const char* filename;
-  int linenumber;
-  public:
-  SetStateEvent (double timestamp, container_t container, type_t type, val_t value);
-  void print() override;
+    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;
 
-class PushStateEvent : public paje_event  {
-  public:
-  container_t container;
-  type_t type;
-  val_t value;
-  int size;
-  const char* filename;
-  int linenumber;
-  void* extra;
-  public:
-  PushStateEvent (double timestamp, container_t container, type_t type, val_t value);
-  PushStateEvent (double timestamp, container_t container, type_t type, val_t value,
-                                             void* extra);
+public:
+  PopStateEvent(double timestamp, Container* container, Type* type);
   void print() override;
 };
 
-class PopStateEvent : public paje_event  {
-  container_t container;
-  type_t type;
-  xbt_dynar_t extra;
-  public:
-  PopStateEvent (double timestamp, container_t container, type_t type);
-  void print() override;
-};
+class ResetStateEvent : public PajeEvent  {
+  Container* container;
+  Type* type;
 
-class ResetStateEvent : public paje_event  {
-  container_t container;
-  type_t type;
-  public:
-  ResetStateEvent (double timestamp, container_t container, type_t type);
+public:
+  ResetStateEvent(double timestamp, Container* container, Type* type);
   void print() override;
 };
 
-class StartLinkEvent : public paje_event  {
-  public:
-  container_t container;
-  type_t type;
-  container_t sourceContainer;
-  char *value;
-  char *key;
-  int size;
-  public:
-  StartLinkEvent (double timestamp, container_t container, type_t type, container_t sourceContainer,
-                                    const char *value, const char *key);
-  StartLinkEvent (double timestamp, container_t container, type_t type,
-                                            container_t sourceContainer, const char *value, const char *key, int size);
+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 paje_event  {
-  container_t container;
-  type_t type;
-  container_t destContainer;
+class EndLinkEvent : public PajeEvent  {
+  Container* container;
+  Type* type;
+  Container* destContainer;
   char *value;
   char *key;
   public:
-  EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
-                                  const char *value, const char *key);
-  void print() override;
+    EndLinkEvent(double timestamp, Container* container, Type* type, Container* destContainer, const char* value,
+                 const char* key);
+    ~EndLinkEvent();
+    void print() override;
 };
 
 
-class NewEvent : public paje_event  {
+class NewEvent : public PajeEvent  {
   public:
-  container_t container;
-  type_t type;
-  val_t value;
-  public:
-  NewEvent (double timestamp, container_t container, type_t type, val_t value);
-  void print() override;
+    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 xbt_dict_t created_categories;
-extern XBT_PRIVATE xbt_dict_t declared_marks;
-extern XBT_PRIVATE xbt_dict_t user_host_variables;
-extern XBT_PRIVATE xbt_dict_t user_vm_variables;
-extern XBT_PRIVATE xbt_dict_t user_link_variables;
+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 */
@@ -373,92 +323,27 @@ XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char
 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
 
 /* instr_paje.c */
-extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
-extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
+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_PRIVATE void PJ_container_alloc ();
-XBT_PRIVATE void PJ_container_release ();
-XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
-XBT_PUBLIC(container_t) PJ_container_get_or_null (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 (container_t container);
 XBT_PUBLIC(void) PJ_container_free_all (void);
 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
 
 /* instr_paje_types.c */
-XBT_PRIVATE void PJ_type_alloc ();
-XBT_PRIVATE void PJ_type_release ();
-XBT_PUBLIC(type_t)  PJ_type_get_root ();
-XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
-XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
-type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
-XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
-XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
-XBT_PUBLIC(type_t)  PJ_type_get (const char *name, const type_t father);
-XBT_PUBLIC(type_t)  PJ_type_get_or_null (const char *name, type_t father);
-void PJ_type_free_all ();
-XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
-
-/* instr_paje_values.c */
-XBT_PUBLIC(val_t)  PJ_value_new (const char *name, const char *color, type_t father);
-XBT_PUBLIC(val_t)  PJ_value_get_or_new (const char *name, const char *color, type_t father);
-XBT_PUBLIC(val_t)  PJ_value_get (const char *name, const type_t father);
-XBT_PRIVATE void PJ_value_free (val_t value);
-
-XBT_PRIVATE void print_pajeDefineContainerType(paje_event_t event);
-XBT_PRIVATE void print_pajeDefineVariableType(paje_event_t event);
-XBT_PRIVATE void print_pajeDefineStateType(paje_event_t event);
-XBT_PRIVATE void print_pajeDefineEventType(paje_event_t event);
-XBT_PRIVATE void print_pajeDefineLinkType(paje_event_t event);
-XBT_PRIVATE void print_pajeDefineEntityValue (paje_event_t event);
-XBT_PRIVATE void print_pajeCreateContainer(paje_event_t event);
-XBT_PRIVATE void print_pajeDestroyContainer(paje_event_t event);
-XBT_PRIVATE void print_pajeSetVariable(paje_event_t event);
-XBT_PRIVATE void print_pajeAddVariable(paje_event_t event);
-XBT_PRIVATE void print_pajeSubVariable(paje_event_t event);
-XBT_PRIVATE void print_pajeSetState(paje_event_t event);
-XBT_PRIVATE void print_pajePushState(paje_event_t event);
-XBT_PRIVATE void print_pajePopState(paje_event_t event);
-XBT_PRIVATE void print_pajeResetState(paje_event_t event);
-XBT_PRIVATE void print_pajeStartLink(paje_event_t event);
-XBT_PRIVATE void print_pajeEndLink(paje_event_t event);
-XBT_PRIVATE void print_pajeNewEvent (paje_event_t event);
-
-XBT_PRIVATE void print_TIPushState(paje_event_t event);
-XBT_PRIVATE void print_TICreateContainer(paje_event_t event);
-XBT_PRIVATE void print_TIDestroyContainer(paje_event_t event);
+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_TI_init();
 
-XBT_PRIVATE void print_NULL (paje_event_t event);
 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);
 
-typedef struct instr_trace_writer {
-  void (*print_DefineContainerType) (paje_event_t event);
-  void (*print_DefineVariableType)(paje_event_t event);
-  void (*print_DefineStateType)(paje_event_t event);
-  void (*print_DefineEventType)(paje_event_t event);
-  void (*print_DefineLinkType)(paje_event_t event);
-  void (*print_DefineEntityValue)(paje_event_t event);
-  void (*print_CreateContainer)(paje_event_t event);
-  void (*print_DestroyContainer)(paje_event_t event);
-  void (*print_SetVariable)(paje_event_t event);
-  void (*print_AddVariable)(paje_event_t event);
-  void (*print_SubVariable)(paje_event_t event);
-  void (*print_SetState)(paje_event_t event);
-  void (*print_PushState)(paje_event_t event);
-  void (*print_PopState)(paje_event_t event);
-  void (*print_ResetState)(paje_event_t event);
-  void (*print_StartLink)(paje_event_t event);
-  void (*print_EndLink)(paje_event_t event);
-  void (*print_NewEvent) (paje_event_t event);
-} s_instr_trace_writer_t;
-
 struct s_instr_extra_data;
 typedef struct s_instr_extra_data *instr_extra_data;
 
@@ -514,6 +399,23 @@ typedef struct s_instr_extra_data {
   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