Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Started the gpu model by adding the MSG_gpu_task_create function, also added a simple...
[simgrid.git] / include / msg / datatypes.h
index d6d9afb..099e21f 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,21 +7,24 @@
 #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
 
@@ -37,16 +39,35 @@ typedef struct m_host {
   @{ */
 typedef struct m_host *m_host_t;
 /** @} */
+
+
+/* ******************************** File ************************************ */
+/** @brief File datatype
+    @ingroup m_datatypes_management_details */
+typedef struct m_file {
+  char *name;                   /**< @brief file name */
+  void *data;                   /**< @brief user data */
+} s_m_file_t;
+
+typedef struct m_file *m_file_t;
+
+
 /* ******************************** Task ************************************ */
 
 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,7 +76,41 @@ typedef struct m_task {
     data</em>.
     \see m_task_management
   @{ */
-typedef struct m_task  *m_task_t;
+typedef struct m_task *m_task_t;
+
+
+/*************** Begin GPU ***************/
+typedef struct simdata_gpu_task *simdata_gpu_task_t;
+
+/** @brief GPU task datatype
+    @ingroup m_datatypes_management_details */
+typedef struct m_gpu_task {
+  char *name;                   /**< @brief task name if any */
+  simdata_gpu_task_t simdata;       /**< @brief simulator data */
+#ifdef HAVE_TRACING
+  long long int counter;        /* task unique identifier for instrumentation */
+  char *category;               /* task category for instrumentation */
+#endif
+} s_m_gpu_task_t;
+
+/** @brief GPU task datatype
+    @ingroup m_datatypes_management
+
+    A <em>task</em> may then be defined by a <em>computing
+    amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
+    \see m_task_management
+  @{ */
+typedef struct m_gpu_task *m_gpu_task_t;
+/*************** End GPU ***************/
+
+/**
+ * \brief @brief Communication action
+ * \ingroup m_datatypes_management
+ *
+ * Communication actions transfer tasks between processes.
+ * For a given task, the sender and the receiver have distinct objects.
+ */
+typedef struct msg_comm *msg_comm_t;
 
 /** \brief Default value for an uninitialized #m_task_t.
     \ingroup m_datatypes_management 
@@ -65,34 +120,18 @@ typedef struct m_task  *m_task_t;
 /** @} */
 
 /* ****************************** Process *********************************** */
-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;
-/** @} */
-/** @brief Agent datatype  
+
+/** @brief Process datatype
     @ingroup m_datatypes_management 
 
-    An agent may be defined as a <em>code</em>, with some <em>private
+    A process may be defined as a <em>code</em>, with some <em>private
     data</em>, executing in a <em>location</em>.
     \see m_process_management
   @{ */
-typedef struct m_process *m_process_t;
-/** @} */
-
-/** @brief Agent code
-    @ingroup m_datatypes_management 
-    The code of an agent is a m_process_code_t, i.e. a function with no arguments 
-    returning no value.
-    \see m_process_management
-  @{ */
-typedef int(*m_process_code_t)(int argc,char *argv[]) ;
+typedef struct s_smx_process *m_process_t;
 /** @} */
 
+#ifdef MSG_USE_DEPRECATED
 /* ********************************* Channel ******************************** */
 /** @brief Channel datatype  
     @ingroup m_datatypes_management 
@@ -103,27 +142,38 @@ typedef int(*m_process_code_t)(int argc,char *argv[]) ;
    @{ */
 typedef int m_channel_t;
 /** @} */
+#endif
+
+/* ******************************** Mailbox ************************************ */
+
+typedef struct s_smx_rvpoint *msg_mailbox_t;
+/** @brief Mailbox datatype
+    @ingroup m_datatypes_management_details @{ */
+
+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_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
 } MSG_error_t;
 /** @} */
 
+
 SG_END_DECL()
 #endif