Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] protecting category field in process structure
[simgrid.git] / include / msg / datatypes.h
index 1debf57..d9d271c 100644 (file)
@@ -1,6 +1,5 @@
-/*     $Id$     */
-
-/* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
+/* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. 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. */
@@ -8,20 +7,20 @@
 #ifndef MSG_DATATYPE_H
 #define MSG_DATATYPE_H
 #include "xbt/misc.h"
+#include "simgrid_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;
 /** @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 */
+  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
@@ -43,9 +42,13 @@ 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 */
+  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,13 +58,14 @@ 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 
 */
 #define MSG_TASK_UNINITIALIZED NULL
 
+typedef struct s_smx_action *msg_comm_t;
 /** @} */
 
 
@@ -71,9 +75,13 @@ 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 */
+  char *name;                   /**< @brief process name if any */
+  simdata_process_t simdata;
+                                /**< @brief simulator data */
+  void *data;                   /**< @brief user data */
+#ifdef HAVE_TRACING
+  char *category;               /* process category for instrumentation */
+#endif
 } s_m_process_t;
 /** @} */
 /** @brief Agent datatype  
@@ -99,12 +107,12 @@ typedef int m_channel_t;
 
 /* ******************************** Mailbox ************************************ */
 
-typedef struct s_msg_mailbox* msg_mailbox_t;
+typedef struct s_smx_rvpoint *msg_mailbox_t;
 /** @brief Mailbox datatype
     @ingroup m_datatypes_management_details @{ */
 
 msg_mailbox_t MSG_mailbox_create(const char *alias);
-void MSG_mailbox_free(voidmailbox);
+void MSG_mailbox_free(void *mailbox);
 
 
 /** @} */
@@ -113,21 +121,18 @@ void MSG_mailbox_free(void* mailbox);
 /* ***************************** Error handling ***************************** */
 /** @brief Error handling 
     @ingroup m_datatypes_management 
-    @{
-*/
+         @{
+*//* 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_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
+  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_TASK_CANCELLED = 8,     /**< @brief Canceled task. This task has been canceled by somebody!*/
 } MSG_error_t;
 /** @} */