1 /* Copyright (c) 2004-2014. The SimGrid Team.
2 * All rights reserved. */
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. */
11 #include "simgrid/simix.h"
12 #include "simgrid_config.h" // for HAVE_TRACING
16 /* ******************************** Mailbox ************************************ */
18 /** @brief Mailbox datatype
19 * @ingroup msg_task_usage
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;
30 /* ******************************** Environment ************************************ */
31 typedef struct As *msg_as_t;
33 /* ******************************** Host ************************************ */
35 extern int MSG_HOST_LEVEL;
37 /** @brief Host datatype.
38 @ingroup m_host_management
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
47 typedef xbt_dictelm_t msg_host_t;
48 typedef s_xbt_dictelm_t s_msg_host_t;
50 typedef struct msg_host_priv {
53 double dp_updated_by_deleted_tasks;
55 xbt_dict_t affinity_mask_db;
57 #ifdef MSG_USE_DEPRECATED
58 msg_mailbox_t *mailboxes; /**< the channels */
60 } s_msg_host_priv_t, *msg_host_priv_t;
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);
68 /* ******************************** Task ************************************ */
70 typedef struct simdata_task *simdata_task_t;
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 */
77 long long int counter; /* task unique identifier for instrumentation */
78 char *category; /* task category for instrumentation */
82 /** @brief Task datatype.
83 @ingroup m_task_management
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
89 typedef struct msg_task *msg_task_t;
91 /* ******************************** VM ************************************* */
92 typedef msg_host_t msg_vm_t;
93 typedef msg_host_priv_t msg_vm_priv_t;
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);
99 /* ******************************** File ************************************ */
100 typedef struct simdata_file *simdata_file_t;
102 typedef struct s_msg_file_info {
108 } s_msg_file_info_t, *msg_file_info_t;
110 typedef struct msg_file {
111 char *fullname; /**< @brief file full name (path+name)*/
112 simdata_file_t simdata; /**< @brief simulator data */
113 msg_file_info_t info;
116 /** @brief File datatype.
117 * @ingroup msg_file_management
119 * You should consider this as an opaque object.
122 typedef struct msg_file *msg_file_t;
124 /* ******************************** Storage ************************************ */
125 /* TODO: PV: to comment */
127 extern int MSG_STORAGE_LEVEL;
129 /** @brief Storage datatype.
130 * @ingroup msg_storage_management
132 * You should consider this as an opaque object.
134 typedef xbt_dictelm_t msg_storage_t;
135 typedef s_xbt_dictelm_t s_msg_storage_t;
137 typedef struct msg_storage_priv {
138 // TODO PV: fill it (or not) !
140 } s_msg_storage_priv_t, *msg_storage_priv_t;
142 /*************** Begin GPU ***************/
143 typedef struct simdata_gpu_task *simdata_gpu_task_t;
145 typedef struct msg_gpu_task {
146 char *name; /**< @brief task name if any */
147 simdata_gpu_task_t simdata; /**< @brief simulator data */
149 long long int counter; /* task unique identifier for instrumentation */
150 char *category; /* task category for instrumentation */
154 /** @brief GPU task datatype.
155 @ingroup m_task_management
157 A <em>task</em> may then be defined by a <em>computing
158 amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
159 \see m_task_management
161 typedef struct msg_gpu_task *msg_gpu_task_t;
162 /*************** End GPU ***************/
165 * \brief @brief Communication action.
166 * \ingroup msg_task_usage
168 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
170 typedef struct msg_comm *msg_comm_t;
172 /** \brief Default value for an uninitialized #msg_task_t.
173 \ingroup m_task_management
175 #define MSG_TASK_UNINITIALIZED NULL
177 /* ****************************** Process *********************************** */
179 /** @brief Process datatype.
180 @ingroup m_process_management
182 A process may be defined as a <em>code</em>, with some
183 <em>private data</em>, executing in a <em>location</em>.
185 You should not access directly to the fields of the pointed
186 structure, but always use the provided API to interact with
189 typedef struct s_smx_process *msg_process_t;
191 #ifdef MSG_USE_DEPRECATED
193 /* Compatibility typedefs */
194 typedef int m_channel_t;
195 typedef msg_gpu_task_t m_gpu_task_t;
196 typedef msg_host_t m_host_t;
197 typedef msg_process_t m_process_t;
198 typedef msg_task_t m_task_t;
199 typedef s_msg_gpu_task_t s_m_gpu_task_t;
200 typedef s_msg_host_t s_m_host_t;
201 typedef s_msg_task_t s_m_task_t;