Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
b76e6c3006d21316341b36ed265b3c0bbfd177d6
[simgrid.git] / include / msg / datatypes.h
1 /* Copyright (c) 2004-2014. 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 "xbt/lib.h"
11 #include "simgrid/simix.h"
12 #include "simgrid_config.h"     // for HAVE_TRACING
13
14 SG_BEGIN_DECL()
15
16 /* ******************************** Mailbox ************************************ */
17
18 /** @brief Mailbox datatype
19  *  @ingroup msg_task_usage
20  *
21  * Object representing a communication rendez-vous point, on which
22  * the sender finds the receiver it wants to communicate with. As a
23  * MSG user, you will only rarely manipulate any of these objects
24  * directly, since most of the public interface (such as
25  * #MSG_task_send and friends) hide this object behind a string
26  * alias. That mean that you don't provide the mailbox on which you
27  * want to send your task, but only the name of this mailbox. */
28 typedef struct s_smx_rvpoint *msg_mailbox_t;
29
30 /* ******************************** Environment ************************************ */
31 typedef struct As *msg_as_t;
32
33 /* ******************************** Host ************************************ */
34
35 extern int MSG_HOST_LEVEL;
36
37 /** @brief Host datatype.
38     @ingroup m_host_management
39
40     A <em>location</em> (or <em>host</em>) is any possible place where
41     a process may run. Thus it is represented as a <em>physical
42     resource with computing capabilities</em>, some <em>mailboxes</em>
43     to enable running process to communicate with remote ones, and
44     some <em>private data</em> that can be only accessed by local
45     process.
46  */
47 typedef xbt_dictelm_t msg_host_t;
48 typedef s_xbt_dictelm_t s_msg_host_t;
49
50 typedef struct msg_host_priv {
51   int        dp_enabled;
52   xbt_dict_t dp_objs;
53   double     dp_updated_by_deleted_tasks;
54
55   xbt_dict_t affinity_mask_db;
56
57 #ifdef MSG_USE_DEPRECATED
58   msg_mailbox_t *mailboxes;     /**< the channels  */
59 #endif
60 } s_msg_host_priv_t, *msg_host_priv_t;
61
62 static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
63   return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
64 }
65
66
67
68 /* ******************************** Task ************************************ */
69
70 typedef struct simdata_task *simdata_task_t;
71
72 typedef struct msg_task {
73   char *name;                   /**< @brief task name if any */
74   simdata_task_t simdata;       /**< @brief simulator data */
75   void *data;                   /**< @brief user data */
76 #ifdef HAVE_TRACING
77   long long int counter;        /* task unique identifier for instrumentation */
78   char *category;               /* task category for instrumentation */
79 #endif
80 } s_msg_task_t;
81
82 /** @brief Task datatype.
83     @ingroup m_task_management 
84
85     A <em>task</em> may then be defined by a <em>computing
86     amount</em>, a <em>message size</em> and some <em>private
87     data</em>.
88  */
89 typedef struct msg_task *msg_task_t;
90
91 /* ******************************** VM ************************************* */
92 typedef msg_host_t msg_vm_t;
93 typedef msg_host_priv_t msg_vm_priv_t;
94
95 static inline msg_vm_priv_t MSG_vm_priv(msg_vm_t vm){
96   return (msg_vm_priv_t) xbt_lib_get_level(vm, MSG_HOST_LEVEL);
97 }
98
99 /** ******************************** File ************************************ */
100
101 /** @brief File datatype.
102 *  @ingroup msg_file_management
103 *
104 *  You should consider this as an opaque object.
105 */
106 typedef xbt_dictelm_t msg_file_t;
107 typedef s_xbt_dictelm_t s_msg_file_t;
108
109 extern int MSG_FILE_LEVEL;
110 typedef struct simdata_file *simdata_file_t;
111
112 typedef struct msg_file_priv  {
113   char *fullpath;
114   sg_size_t size;
115   char* mount_point;
116   char* storageId;
117   char* storage_type;
118   char* content_type;
119   void *data;
120   simdata_file_t simdata;
121 } s_msg_file_priv_t, *msg_file_priv_t;
122
123 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
124   return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
125 }
126
127 /* ******************************** Storage ************************************ */
128 /* TODO: PV: to comment */
129
130 extern int MSG_STORAGE_LEVEL;
131
132 /** @brief Storage datatype.
133  *  @ingroup msg_storage_management
134  *
135  *  You should consider this as an opaque object.
136  */
137 typedef xbt_dictelm_t msg_storage_t;
138 typedef s_xbt_dictelm_t s_msg_storage_t;
139
140 typedef struct msg_storage_priv  {
141   const char *host;
142   void *data;
143 } s_msg_storage_priv_t, *msg_storage_priv_t;
144
145 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
146   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
147 }
148
149 /*************** Begin GPU ***************/
150 typedef struct simdata_gpu_task *simdata_gpu_task_t;
151
152 typedef struct msg_gpu_task {
153   char *name;                   /**< @brief task name if any */
154   simdata_gpu_task_t simdata;       /**< @brief simulator data */
155 #ifdef HAVE_TRACING
156   long long int counter;        /* task unique identifier for instrumentation */
157   char *category;               /* task category for instrumentation */
158 #endif
159 } s_msg_gpu_task_t;
160
161 /** @brief GPU task datatype.
162     @ingroup m_task_management
163
164     A <em>task</em> may then be defined by a <em>computing
165     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
166     \see m_task_management
167 */
168 typedef struct msg_gpu_task *msg_gpu_task_t;
169 /*************** End GPU ***************/
170
171 /**
172  * \brief @brief Communication action.
173  * \ingroup msg_task_usage
174  *
175  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
176  */
177 typedef struct msg_comm *msg_comm_t;
178
179 /** \brief Default value for an uninitialized #msg_task_t.
180     \ingroup m_task_management 
181 */
182 #define MSG_TASK_UNINITIALIZED NULL
183
184 /* ****************************** Process *********************************** */
185
186 /** @brief Process datatype.
187     @ingroup m_process_management
188
189     A process may be defined as a <em>code</em>, with some
190     <em>private data</em>, executing in a <em>location</em>. 
191  
192     You should not access directly to the fields of the pointed
193     structure, but always use the provided API to interact with
194     processes.
195  */
196 typedef struct s_smx_process *msg_process_t;
197
198 #ifdef MSG_USE_DEPRECATED
199
200 /* Compatibility typedefs */
201 typedef int                     m_channel_t;
202 typedef msg_gpu_task_t          m_gpu_task_t;
203 typedef msg_host_t              m_host_t;
204 typedef msg_process_t           m_process_t;
205 typedef msg_task_t              m_task_t;
206 typedef s_msg_gpu_task_t        s_m_gpu_task_t;
207 typedef s_msg_host_t            s_m_host_t;
208 typedef s_msg_task_t            s_m_task_t;
209 #endif
210
211 SG_END_DECL()
212 #endif