Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix of pastry
[simgrid.git] / include / msg / datatypes.h
1 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef MSG_DATATYPE_H
7 #define MSG_DATATYPE_H
8 #include "xbt/misc.h"
9 #include "xbt/lib.h"
10 #include "simgrid/simix.h"
11 #include "simgrid_config.h"     // for HAVE_TRACING
12
13 SG_BEGIN_DECL()
14
15 /* ******************************** Mailbox ************************************ */
16
17 /** @brief Mailbox datatype
18  *  @ingroup msg_task_usage
19  *
20  * Object representing a communication rendez-vous point, on which
21  * the sender finds the receiver it wants to communicate with. As a
22  * MSG user, you will only rarely manipulate any of these objects
23  * directly, since most of the public interface (such as
24  * #MSG_task_send and friends) hide this object behind a string
25  * alias. That mean that you don't provide the mailbox on which you
26  * want to send your task, but only the name of this mailbox. */
27 typedef struct s_smx_rvpoint *msg_mailbox_t;
28
29 /* ******************************** Environment ************************************ */
30 typedef struct s_as *msg_as_t;
31
32 /* ******************************** Host ************************************ */
33
34 extern int MSG_HOST_LEVEL;
35
36 /** @brief Host datatype.
37     @ingroup m_host_management
38
39     A <em>location</em> (or <em>host</em>) is any possible place where
40     a process may run. Thus it is represented as a <em>physical
41     resource with computing capabilities</em>, some <em>mailboxes</em>
42     to enable running process to communicate with remote ones, and
43     some <em>private data</em> that can be only accessed by local
44     process.
45  */
46 typedef xbt_dictelm_t msg_host_t;
47 typedef s_xbt_dictelm_t s_msg_host_t;
48
49 typedef struct msg_host_priv {
50   xbt_swag_t vms;
51 #ifdef MSG_USE_DEPRECATED
52   msg_mailbox_t *mailboxes;     /**< the channels  */
53 #endif
54 } s_msg_host_priv_t, *msg_host_priv_t;
55
56 static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
57   return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
58 }
59
60
61
62 /* ******************************** Task ************************************ */
63
64 typedef struct simdata_task *simdata_task_t;
65
66 typedef struct msg_task {
67   char *name;                   /**< @brief task name if any */
68   simdata_task_t simdata;       /**< @brief simulator data */
69   void *data;                   /**< @brief user data */
70 #ifdef HAVE_TRACING
71   long long int counter;        /* task unique identifier for instrumentation */
72   char *category;               /* task category for instrumentation */
73 #endif
74 } s_msg_task_t;
75
76 /** @brief Task datatype.
77     @ingroup m_task_management 
78
79     A <em>task</em> may then be defined by a <em>computing
80     amount</em>, a <em>message size</em> and some <em>private
81     data</em>.
82  */
83 typedef struct msg_task *msg_task_t;
84
85 /* ********************************  VM ************************************* */
86 typedef struct msg_vm *msg_vm_t;
87
88 typedef enum {
89   msg_vm_state_suspended, msg_vm_state_running, msg_vm_state_migrating
90 } e_msg_vm_state_t;
91
92 typedef struct msg_vm {
93   char *name;
94   s_xbt_swag_hookup_t all_vms_hookup;
95   s_xbt_swag_hookup_t host_vms_hookup;
96   xbt_dynar_t processes;
97   e_msg_vm_state_t state;
98   msg_host_t location;
99   int coreAmount;
100 } s_msg_vm_t;
101
102 /* ******************************** File ************************************ */
103 typedef struct simdata_file *simdata_file_t;
104
105 typedef struct msg_file {
106   char *name;                   /**< @brief file name */
107   size_t size;
108   simdata_file_t simdata;                /**< @brief simulator data  */
109   void *data;                   /**< @brief user data */
110 } s_msg_file_t;
111
112 /** @brief File datatype.
113     @ingroup msg_file_management 
114  
115     You should consider this as an opaque object.
116  */
117 typedef struct msg_file *msg_file_t;
118
119 /*************** Begin GPU ***************/
120 typedef struct simdata_gpu_task *simdata_gpu_task_t;
121
122 typedef struct msg_gpu_task {
123   char *name;                   /**< @brief task name if any */
124   simdata_gpu_task_t simdata;       /**< @brief simulator data */
125 #ifdef HAVE_TRACING
126   long long int counter;        /* task unique identifier for instrumentation */
127   char *category;               /* task category for instrumentation */
128 #endif
129 } s_msg_gpu_task_t;
130
131 /** @brief GPU task datatype.
132     @ingroup m_task_management
133
134     A <em>task</em> may then be defined by a <em>computing
135     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
136     \see m_task_management
137 */
138 typedef struct msg_gpu_task *msg_gpu_task_t;
139 /*************** End GPU ***************/
140
141 /**
142  * \brief @brief Communication action.
143  * \ingroup msg_task_usage
144  *
145  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
146  */
147 typedef struct msg_comm *msg_comm_t;
148
149 /** \brief Default value for an uninitialized #msg_task_t.
150     \ingroup m_task_management 
151 */
152 #define MSG_TASK_UNINITIALIZED NULL
153
154 /* ****************************** Process *********************************** */
155
156 /** @brief Process datatype.
157     @ingroup m_process_management
158
159     A process may be defined as a <em>code</em>, with some
160     <em>private data</em>, executing in a <em>location</em>. 
161  
162     You should not access directly to the fields of the pointed
163     structure, but always use the provided API to interact with
164     processes.
165  */
166 typedef struct s_smx_process *msg_process_t;
167
168 #ifdef MSG_USE_DEPRECATED
169
170 /* Compatibility typedefs */
171 typedef int                     m_channel_t;
172 typedef msg_gpu_task_t          m_gpu_task_t;
173 typedef msg_host_t              m_host_t;
174 typedef msg_process_t           m_process_t;
175 typedef msg_task_t              m_task_t;
176 typedef s_msg_gpu_task_t        s_m_gpu_task_t;
177 typedef s_msg_host_t            s_m_host_t;
178 typedef s_msg_task_t            s_m_task_t;
179 #endif
180
181 SG_END_DECL()
182 #endif