Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
proper use of the HAVE_TRACING variable defined by Cmake through -Dtracing=on
[simgrid.git] / include / msg / datatypes.h
index 1debf57..255b155 100644 (file)
@@ -8,21 +8,21 @@
 #ifndef MSG_DATATYPE_H
 #define MSG_DATATYPE_H
 #include "xbt/misc.h"
+#include "instr/tracing_config.h" // for HAVE_TRACING
 
 SG_BEGIN_DECL()
 
 /* ******************************** Host ************************************ */
 /** @defgroup m_datatypes_management_details Details on MSG datatypes
     @ingroup  m_datatypes_management*/
-
-typedef struct simdata_host *simdata_host_t;
+     typedef struct simdata_host *simdata_host_t;
 /** @brief Host datatype 
     @ingroup m_datatypes_management_details */
-typedef struct m_host {
-  char *name;                  /**< @brief host name if any */
-  simdata_host_t simdata;      /**< @brief simulator data */
-  void *data;                  /**< @brief user data */
-} s_m_host_t;
+     typedef struct m_host {
+       char *name;              /**< @brief host name if any */
+       simdata_host_t simdata;  /**< @brief simulator data */
+       void *data;              /**< @brief user data */
+     } s_m_host_t;
 /** @brief Host datatype  
     @ingroup m_datatypes_management
 
@@ -35,18 +35,22 @@ typedef struct m_host {
 
     \see m_host_management
   @{ */
-typedef struct m_host *m_host_t;
+     typedef struct m_host *m_host_t;
 /** @} */
 /* ******************************** Task ************************************ */
 
-typedef struct simdata_task *simdata_task_t;
+     typedef struct simdata_task *simdata_task_t;
 /** @brief Task datatype 
     @ingroup m_datatypes_management_details */
-typedef struct m_task {
-  char *name;                  /**< @brief task name if any */
-  simdata_task_t simdata;      /**< @brief simulator data */
-  void *data;                  /**< @brief user data */
-} s_m_task_t;
+     typedef struct m_task {
+       char *name;              /**< @brief task name if any */
+       simdata_task_t simdata;  /**< @brief simulator data */
+       void *data;              /**< @brief user data */
+#ifdef HAVE_TRACING
+       long long int counter;   /* task unique identifier for instrumentation */
+       char *category;      /* task category for instrumentation */
+#endif
+     } s_m_task_t;
 /** @brief Task datatype  
     @ingroup m_datatypes_management 
 
@@ -55,7 +59,7 @@ typedef struct m_task {
     data</em>.
     \see m_task_management
   @{ */
-typedef struct m_task  *m_task_t;
+     typedef struct m_task *m_task_t;
 
 /** \brief Default value for an uninitialized #m_task_t.
     \ingroup m_datatypes_management 
@@ -67,14 +71,16 @@ typedef struct m_task  *m_task_t;
 
 
 /* ****************************** Process *********************************** */
-typedef struct simdata_process *simdata_process_t;
+     typedef struct simdata_process *simdata_process_t;
 /** @brief Process datatype 
     @ingroup m_datatypes_management_details @{ */
-typedef struct m_process {
-  char *name;                  /**< @brief process name if any */
-  simdata_process_t simdata;   /**< @brief simulator data */
-  void *data;                  /**< @brief user data */
-} s_m_process_t;
+     typedef struct m_process {
+       char *name;              /**< @brief process name if any */
+       simdata_process_t simdata;
+                                /**< @brief simulator data */
+       void *data;              /**< @brief user data */
+       char *category;      /* process category for instrumentation */
+     } s_m_process_t;
 /** @} */
 /** @brief Agent datatype  
     @ingroup m_datatypes_management 
@@ -83,7 +89,7 @@ typedef struct m_process {
     data</em>, executing in a <em>location</em>.
     \see m_process_management
   @{ */
-typedef struct m_process *m_process_t;
+     typedef struct m_process *m_process_t;
 /** @} */
 
 /* ********************************* Channel ******************************** */
@@ -94,17 +100,17 @@ typedef struct m_process *m_process_t;
     port number does).
     \see m_channel_management
    @{ */
-typedef int m_channel_t;
+     typedef int m_channel_t;
 /** @} */
 
 /* ******************************** Mailbox ************************************ */
 
-typedef struct s_msg_mailbox* msg_mailbox_t;
+     typedef struct s_msg_mailbox *msg_mailbox_t;
 /** @brief Mailbox datatype
     @ingroup m_datatypes_management_details @{ */
 
-msg_mailbox_t MSG_mailbox_create(const char *alias);
-void MSG_mailbox_free(void* mailbox);
+     msg_mailbox_t MSG_mailbox_create(const char *alias);
+     void MSG_mailbox_free(void *mailbox);
 
 
 /** @} */
@@ -114,21 +120,18 @@ void MSG_mailbox_free(void* mailbox);
 /** @brief Error handling 
     @ingroup m_datatypes_management 
     @{
-*/
-typedef enum {
-  MSG_OK = 0,  /**< @brief Everything is right. Keep on going this way ! */
-  MSG_WARNING, /**< @brief Mmmh! Something must be not perfectly clean. But I
-      may be a paranoid freak... ! */
-  MSG_TRANSFER_FAILURE, /**< @brief There has been a problem during you task
+*/ /* Keep these code as binary values: java bindings manipulate | of these values */
+     typedef enum {
+       MSG_OK = 0,            /**< @brief Everything is right. Keep on going this way ! */
+       MSG_TIMEOUT=1,         /**< @brief nothing good happened before the timer you provided elapsed */
+       MSG_TRANSFER_FAILURE=2,/**< @brief There has been a problem during you task
       transfer. Either the network is down or the remote host has been
       shutdown. */
-  MSG_HOST_FAILURE, /**< @brief System shutdown. The host on which you are
+       MSG_HOST_FAILURE=4,    /**< @brief System shutdown. The host on which you are
       running has just been rebooted. Free your datastructures and
       return now !*/
-  MSG_TASK_CANCELLED, /**< @brief Cancelled task. This task has been cancelled 
-                       by somebody!*/
-  MSG_FATAL /**< @brief You've done something wrong. You'd better look at it... */
-} MSG_error_t;
+       MSG_TASK_CANCELLED=8,  /**< @brief Canceled task. This task has been canceled by somebody!*/
+     } MSG_error_t;
 /** @} */
 
 SG_END_DECL()