1 /* Copyright (c) 2004-2013. 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 s_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 {
52 #ifdef MSG_USE_DEPRECATED
53 msg_mailbox_t *mailboxes; /**< the channels */
55 } s_msg_host_priv_t, *msg_host_priv_t;
57 static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
58 return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
63 /* ******************************** Task ************************************ */
65 typedef struct simdata_task *simdata_task_t;
67 typedef struct msg_task {
68 char *name; /**< @brief task name if any */
69 simdata_task_t simdata; /**< @brief simulator data */
70 void *data; /**< @brief user data */
72 long long int counter; /* task unique identifier for instrumentation */
73 char *category; /* task category for instrumentation */
77 /** @brief Task datatype.
78 @ingroup m_task_management
80 A <em>task</em> may then be defined by a <em>computing
81 amount</em>, a <em>message size</em> and some <em>private
84 typedef struct msg_task *msg_task_t;
86 /* ******************************** VM ************************************* */
87 typedef struct msg_vm *msg_vm_t;
90 msg_vm_state_suspended, msg_vm_state_running, msg_vm_state_migrating
93 typedef struct msg_vm {
95 s_xbt_swag_hookup_t all_vms_hookup;
96 s_xbt_swag_hookup_t host_vms_hookup;
97 xbt_dynar_t processes;
98 e_msg_vm_state_t state;
103 /* ******************************** File ************************************ */
104 typedef struct simdata_file *simdata_file_t;
106 typedef struct s_msg_file_info {
107 sg_storage_size_t size;
112 } s_msg_file_info_t, *msg_file_info_t;
114 typedef struct msg_file {
115 char *fullname; /**< @brief file full name (path+name)*/
116 simdata_file_t simdata; /**< @brief simulator data */
117 msg_file_info_t info;
120 /** @brief File datatype.
121 * @ingroup msg_file_management
123 * You should consider this as an opaque object.
126 typedef struct msg_file *msg_file_t;
128 /* ******************************** Storage ************************************ */
129 /* TODO: PV: to comment */
131 extern int MSG_STORAGE_LEVEL;
133 /** @brief Storage datatype.
134 * @ingroup msg_storage_management
136 * You should consider this as an opaque object.
138 typedef xbt_dictelm_t msg_storage_t;
139 typedef s_xbt_dictelm_t s_msg_storage_t;
141 typedef struct msg_storage_priv {
142 // TODO PV: fill it (or not) !
144 } s_msg_storage_priv_t, *msg_storage_priv_t;
146 /*************** Begin GPU ***************/
147 typedef struct simdata_gpu_task *simdata_gpu_task_t;
149 typedef struct msg_gpu_task {
150 char *name; /**< @brief task name if any */
151 simdata_gpu_task_t simdata; /**< @brief simulator data */
153 long long int counter; /* task unique identifier for instrumentation */
154 char *category; /* task category for instrumentation */
158 /** @brief GPU task datatype.
159 @ingroup m_task_management
161 A <em>task</em> may then be defined by a <em>computing
162 amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
163 \see m_task_management
165 typedef struct msg_gpu_task *msg_gpu_task_t;
166 /*************** End GPU ***************/
169 * \brief @brief Communication action.
170 * \ingroup msg_task_usage
172 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
174 typedef struct msg_comm *msg_comm_t;
176 /** \brief Default value for an uninitialized #msg_task_t.
177 \ingroup m_task_management
179 #define MSG_TASK_UNINITIALIZED NULL
181 /* ****************************** Process *********************************** */
183 /** @brief Process datatype.
184 @ingroup m_process_management
186 A process may be defined as a <em>code</em>, with some
187 <em>private data</em>, executing in a <em>location</em>.
189 You should not access directly to the fields of the pointed
190 structure, but always use the provided API to interact with
193 typedef struct s_smx_process *msg_process_t;
195 #ifdef MSG_USE_DEPRECATED
197 /* Compatibility typedefs */
198 typedef int m_channel_t;
199 typedef msg_gpu_task_t m_gpu_task_t;
200 typedef msg_host_t m_host_t;
201 typedef msg_process_t m_process_t;
202 typedef msg_task_t m_task_t;
203 typedef s_msg_gpu_task_t s_m_gpu_task_t;
204 typedef s_msg_host_t s_m_host_t;
205 typedef s_msg_task_t s_m_task_t;