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
1 /* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef MSG_DATATYPE_H
8 #define MSG_DATATYPE_H
9 #include "xbt/misc.h"
10 #include "simgrid_config.h"     // for HAVE_TRACING
11
12 SG_BEGIN_DECL()
13
14 /* ******************************** Host ************************************ */
15
16 /** @defgroup m_datatypes_management_details Details on MSG datatypes
17     @ingroup  m_datatypes_management*/
18 typedef struct simdata_host *simdata_host_t;
19
20 /** @brief Host datatype 
21     @ingroup m_datatypes_management_details */
22 typedef struct m_host {
23   char *name;                   /**< @brief host name if any */
24   simdata_host_t simdata;       /**< @brief simulator data */
25   void *data;                   /**< @brief user data */
26 } s_m_host_t;
27
28 /** @brief Host datatype  
29     @ingroup m_datatypes_management
30
31     A <em>location</em> (or <em>host</em>) is any possible place where
32     a process may run. Thus it is represented as a <em>physical
33     resource with computing capabilities</em>, some <em>mailboxes</em>
34     to enable running process to communicate with remote ones, and
35     some <em>private data</em> that can be only accessed by local
36     process.
37
38     \see m_host_management
39   @{ */
40 typedef struct m_host *m_host_t;
41 /** @} */
42
43
44 /* ******************************** File ************************************ */
45 /** @brief File datatype
46     @ingroup m_datatypes_management_details */
47 typedef struct m_file {
48   char *name;                   /**< @brief file name */
49   void *data;                   /**< @brief user data */
50 } s_m_file_t;
51
52 typedef struct m_file *m_file_t;
53
54
55 /* ******************************** Task ************************************ */
56
57 typedef struct simdata_task *simdata_task_t;
58
59 /** @brief Task datatype 
60     @ingroup m_datatypes_management_details */
61 typedef struct m_task {
62   char *name;                   /**< @brief task name if any */
63   simdata_task_t simdata;       /**< @brief simulator data */
64   void *data;                   /**< @brief user data */
65 #ifdef HAVE_TRACING
66   long long int counter;        /* task unique identifier for instrumentation */
67   char *category;               /* task category for instrumentation */
68 #endif
69 } s_m_task_t;
70
71 /** @brief Task datatype  
72     @ingroup m_datatypes_management 
73
74     A <em>task</em> may then be defined by a <em>computing
75     amount</em>, a <em>message size</em> and some <em>private
76     data</em>.
77     \see m_task_management
78   @{ */
79 typedef struct m_task *m_task_t;
80
81
82 /*************** Begin GPU ***************/
83 typedef struct simdata_gpu_task *simdata_gpu_task_t;
84
85 /** @brief GPU task datatype
86     @ingroup m_datatypes_management_details */
87 typedef struct m_gpu_task {
88   char *name;                   /**< @brief task name if any */
89   simdata_gpu_task_t simdata;       /**< @brief simulator data */
90 #ifdef HAVE_TRACING
91   long long int counter;        /* task unique identifier for instrumentation */
92   char *category;               /* task category for instrumentation */
93 #endif
94 } s_m_gpu_task_t;
95
96 /** @brief GPU task datatype
97     @ingroup m_datatypes_management
98
99     A <em>task</em> may then be defined by a <em>computing
100     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
101     \see m_task_management
102   @{ */
103 typedef struct m_gpu_task *m_gpu_task_t;
104 /*************** End GPU ***************/
105
106 /**
107  * \brief @brief Communication action
108  * \ingroup m_datatypes_management
109  *
110  * Communication actions transfer tasks between processes.
111  * For a given task, the sender and the receiver have distinct objects.
112  */
113 typedef struct msg_comm *msg_comm_t;
114
115 /** \brief Default value for an uninitialized #m_task_t.
116     \ingroup m_datatypes_management 
117 */
118 #define MSG_TASK_UNINITIALIZED NULL
119
120 /** @} */
121
122 /* ****************************** Process *********************************** */
123
124 /** @brief Process datatype
125     @ingroup m_datatypes_management 
126
127     A process may be defined as a <em>code</em>, with some <em>private
128     data</em>, executing in a <em>location</em>.
129     \see m_process_management
130   @{ */
131 typedef struct s_smx_process *m_process_t;
132 /** @} */
133
134 #ifdef MSG_USE_DEPRECATED
135 /* ********************************* Channel ******************************** */
136 /** @brief Channel datatype  
137     @ingroup m_datatypes_management 
138
139     A <em>channel</em>  is a number and identifies a mailbox type (just as a 
140     port number does).
141     \see m_channel_management
142    @{ */
143 typedef int m_channel_t;
144 /** @} */
145 #endif
146
147 /* ******************************** Mailbox ************************************ */
148
149 typedef struct s_smx_rvpoint *msg_mailbox_t;
150 /** @brief Mailbox datatype
151     @ingroup m_datatypes_management_details @{ */
152
153 void MSG_mailbox_free(void *mailbox);
154
155
156 /** @} */
157
158
159 /* ***************************** Error handling ***************************** */
160 /** @brief Error handling 
161     @ingroup m_datatypes_management 
162          @{
163 *//* Keep these code as binary values: java bindings manipulate | of these values */
164 typedef enum {
165   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
166   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
167   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
168       transfer. Either the network is down or the remote host has been
169       shutdown. */
170   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
171       running has just been rebooted. Free your datastructures and
172       return now !*/
173   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
174 } MSG_error_t;
175 /** @} */
176
177
178 SG_END_DECL()
179 #endif