1 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved. */
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. */
10 #include "simgrid/simix.h"
11 #include "simgrid_config.h" // for HAVE_TRACING
15 /* ******************************** Mailbox ************************************ */
17 /** @brief Mailbox datatype
18 * @ingroup msg_task_usage
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;
29 /* ******************************** Environment ************************************ */
30 typedef struct s_as *msg_as_t;
32 /* ******************************** Host ************************************ */
34 extern int MSG_HOST_LEVEL;
36 /** @brief Host datatype.
37 @ingroup m_host_management
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
46 typedef xbt_dictelm_t msg_host_t;
47 typedef s_xbt_dictelm_t s_msg_host_t;
49 typedef struct msg_host_priv {
51 #ifdef MSG_USE_DEPRECATED
52 msg_mailbox_t *mailboxes; /**< the channels */
54 } s_msg_host_priv_t, *msg_host_priv_t;
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);
62 /* ******************************** Task ************************************ */
64 typedef struct simdata_task *simdata_task_t;
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 */
71 long long int counter; /* task unique identifier for instrumentation */
72 char *category; /* task category for instrumentation */
76 /** @brief Task datatype.
77 @ingroup m_task_management
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
83 typedef struct msg_task *msg_task_t;
85 /* ******************************** VM ************************************* */
86 typedef struct msg_vm *msg_vm_t;
89 msg_vm_state_suspended, msg_vm_state_running, msg_vm_state_migrating
92 typedef struct msg_vm {
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;
102 /* ******************************** File ************************************ */
103 typedef struct simdata_file *simdata_file_t;
105 typedef struct msg_file {
106 char *fullname; /**< @brief file full name (path+name)*/
107 simdata_file_t simdata; /**< @brief simulator data */
108 void *data; /**< @brief user data */
111 /** @brief File datatype.
112 @ingroup msg_file_management
114 You should consider this as an opaque object.
117 typedef struct msg_file *msg_file_t;
119 /* ******************************** Storage ************************************ */
120 typedef struct simdata_storage *simdata_storage_t;
122 typedef struct msg_storage {
127 xbt_dict_t properties;
128 simdata_storage_t simdata; /**< @brief simulator data */
129 void *data; /**< @brief user data */
132 typedef struct msg_storage *msg_storage_t;
134 /*************** Begin GPU ***************/
135 typedef struct simdata_gpu_task *simdata_gpu_task_t;
137 typedef struct msg_gpu_task {
138 char *name; /**< @brief task name if any */
139 simdata_gpu_task_t simdata; /**< @brief simulator data */
141 long long int counter; /* task unique identifier for instrumentation */
142 char *category; /* task category for instrumentation */
146 /** @brief GPU task datatype.
147 @ingroup m_task_management
149 A <em>task</em> may then be defined by a <em>computing
150 amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
151 \see m_task_management
153 typedef struct msg_gpu_task *msg_gpu_task_t;
154 /*************** End GPU ***************/
157 * \brief @brief Communication action.
158 * \ingroup msg_task_usage
160 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
162 typedef struct msg_comm *msg_comm_t;
164 /** \brief Default value for an uninitialized #msg_task_t.
165 \ingroup m_task_management
167 #define MSG_TASK_UNINITIALIZED NULL
169 /* ****************************** Process *********************************** */
171 /** @brief Process datatype.
172 @ingroup m_process_management
174 A process may be defined as a <em>code</em>, with some
175 <em>private data</em>, executing in a <em>location</em>.
177 You should not access directly to the fields of the pointed
178 structure, but always use the provided API to interact with
181 typedef struct s_smx_process *msg_process_t;
183 #ifdef MSG_USE_DEPRECATED
185 /* Compatibility typedefs */
186 typedef int m_channel_t;
187 typedef msg_gpu_task_t m_gpu_task_t;
188 typedef msg_host_t m_host_t;
189 typedef msg_process_t m_process_t;
190 typedef msg_task_t m_task_t;
191 typedef s_msg_gpu_task_t s_m_gpu_task_t;
192 typedef s_msg_host_t s_m_host_t;
193 typedef s_msg_task_t s_m_task_t;