Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill a broken deprecation macro: MSG_mailbox_front() does not exist either
[simgrid.git] / include / simgrid / msg.h
1 /* Copyright (c) 2004-2017. 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_H
7 #define MSG_H
8
9 #include "simgrid/datatypes.h"
10 #include "simgrid/forward.h"
11 #include "simgrid/host.h"
12
13 #include "xbt/base.h"
14 #include "xbt/dict.h"
15 #include "xbt/dynar.h"
16
17 #ifdef __cplusplus
18 #include "simgrid/simix.h"
19 #include <map>
20 namespace simgrid {
21 namespace msg {
22 class Comm;
23 }
24 }
25 typedef simgrid::msg::Comm sg_msg_Comm;
26 #else
27 typedef struct msg_Comm sg_msg_Comm;
28 #endif
29
30 SG_BEGIN_DECL()
31
32 /* *************************** Network Zones ******************************** */
33 #define msg_as_t msg_netzone_t /* portability macro */
34 typedef s4u_NetZone* msg_netzone_t;
35
36 /* ******************************** Host ************************************ */
37
38 /** @brief Host datatype.
39     @ingroup m_host_management
40
41     A <em>location</em> (or <em>host</em>) is any possible place where
42     a process may run. Thus it is represented as a <em>physical
43     resource with computing capabilities</em>, some <em>mailboxes</em>
44     to enable running process to communicate with remote ones, and
45     some <em>private data</em> that can be only accessed by local
46     process.
47  */
48 typedef sg_host_t msg_host_t;
49
50
51 XBT_PUBLIC_DATA(int) sg_storage_max_file_descriptors;
52 /* ******************************** Task ************************************ */
53
54 typedef struct simdata_task *simdata_task_t;
55
56 typedef struct msg_task {
57   char *name;                   /**< @brief task name if any */
58   simdata_task_t simdata;       /**< @brief simulator data */
59   void *data;                   /**< @brief user data */
60   long long int counter;        /* task unique identifier for instrumentation */
61   char *category;               /* task category for instrumentation */
62 } s_msg_task_t;
63
64 /** @brief Task datatype.
65     @ingroup m_task_management
66
67     A <em>task</em> may then be defined by a <em>computing
68     amount</em>, a <em>message size</em> and some <em>private
69     data</em>.
70  */
71 typedef struct msg_task *msg_task_t;
72
73 /* ******************************** VM ************************************* */
74 typedef sg_vm_t msg_vm_t;
75
76 /* ******************************** File ************************************ */
77 typedef sg_file_t msg_file_t;
78
79 /* ******************************** Storage ************************************ */
80
81 /** @brief Storage datatype.
82  *  @ingroup msg_storage_management
83  *
84  *  You should consider this as an opaque object.
85  */
86 typedef sg_storage_t msg_storage_t;
87
88 /**
89  * \brief @brief Communication action.
90  * \ingroup msg_task_usage
91  *
92  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
93  */
94 typedef sg_msg_Comm* msg_comm_t;
95
96 /** \brief Default value for an uninitialized #msg_task_t.
97     \ingroup m_task_management
98 */
99 #define MSG_TASK_UNINITIALIZED NULL
100
101 /* ****************************** Process *********************************** */
102
103 /** @brief Process datatype.
104     @ingroup m_process_management
105
106     A process may be defined as a <em>code</em>, with some
107     <em>private data</em>, executing in a <em>location</em>.
108
109     You should not access directly to the fields of the pointed
110     structure, but always use the provided API to interact with
111     processes.
112  */
113 typedef s4u_Actor* msg_process_t;
114
115 /** @brief Return code of most MSG functions
116     @ingroup msg_simulation
117     @{ */
118 /* Keep these code as binary values: java bindings manipulate | of these values */
119 typedef enum {
120   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
121   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
122   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
123       transfer. Either the network is down or the remote host has been
124       shutdown. */
125   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
126       running has just been rebooted. Free your datastructures and
127       return now !*/
128   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
129 } msg_error_t;
130 /** @} */
131
132 /************************** Global ******************************************/
133 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
134 /** \ingroup msg_simulation
135  *  \brief Initialize the MSG internal data.
136  *  \hideinitializer
137  *
138  *  It also check that the link-time and compile-time versions of SimGrid do
139  *  match, so you should use this version instead of the #MSG_init_nocheck
140  *  function that does the same initializations, but without this check.
141  *
142  *  We allow to link against compiled versions that differ in the patch level.
143  */
144 #define MSG_init(argc,argv)  do {                                                          \
145   sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
146     MSG_init_nocheck(argc,argv);                                                        \
147   } while (0)
148
149 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
150 XBT_PUBLIC(msg_error_t) MSG_main();;
151 XBT_PUBLIC(void) MSG_function_register(const char *name,
152                                        xbt_main_func_t code);
153 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
154 XBT_PUBLIC(void) MSG_launch_application(const char *file);
155 /*Bypass the parser */
156 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
157                                   const char *function_name,
158                                   xbt_dynar_t arguments);
159
160 XBT_PUBLIC(double) MSG_get_clock();
161 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg();
162
163 /************************** Net Zones ***********************************/
164 XBT_PUBLIC(msg_netzone_t) MSG_zone_get_root();
165 XBT_PUBLIC(const char*) MSG_zone_get_name(msg_netzone_t zone);
166 XBT_PUBLIC(msg_netzone_t) MSG_zone_get_by_name(const char* name);
167 XBT_PUBLIC(void) MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto);
168 XBT_PUBLIC(const char*) MSG_zone_get_property_value(msg_netzone_t as, const char* name);
169 XBT_PUBLIC(void) MSG_zone_set_property_value(msg_netzone_t netzone, const char* name, char* value);
170 XBT_PUBLIC(void) MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto);
171
172 static inline XBT_ATTRIB_DEPRECATED_v319("Use MSG_zone_get_root() instead: v3.19 will turn this warning into an error.")
173     msg_netzone_t MSG_environment_get_routing_root()
174 {
175   return MSG_zone_get_root();
176 }
177 static inline XBT_ATTRIB_DEPRECATED_v319("Use MSG_zone_get_name() instead: v3.19 will turn this warning into an error.")
178     const char* MSG_environment_as_get_name(msg_netzone_t zone)
179 {
180   return MSG_zone_get_name(zone);
181 }
182 static inline XBT_ATTRIB_DEPRECATED_v319(
183     "Use MSG_zone_get_by_name() instead: v3.19 will turn this warning into an error.") msg_netzone_t
184     MSG_environment_as_get_by_name(const char* name)
185 {
186   return MSG_zone_get_by_name(name);
187 }
188 static inline XBT_ATTRIB_DEPRECATED_v319("Use MSG_zone_get_sons() instead: v3.19 will turn this warning into an error.")
189     xbt_dict_t MSG_environment_as_get_routing_sons(msg_netzone_t zone)
190 {
191   xbt_dict_t res = xbt_dict_new_homogeneous(NULL);
192   MSG_zone_get_sons(zone, res);
193   return res;
194 }
195 static inline XBT_ATTRIB_DEPRECATED_v319(
196     "Use MSG_zone_get_property_value() instead: v3.19 will turn this warning into an error.") const
197     char* MSG_environment_as_get_property_value(msg_netzone_t zone, const char* name)
198 {
199   return MSG_zone_get_property_value(zone, name);
200 }
201 static inline XBT_ATTRIB_DEPRECATED_v319(
202     "Use MSG_zone_set_property_value() instead: v3.19 will remove MSG_environment_as_set_property_value() "
203     "completely.") void MSG_environment_as_set_property_value(msg_netzone_t zone, const char* name, char* value)
204 {
205   MSG_zone_set_property_value(zone, name, value);
206 }
207 static inline XBT_ATTRIB_DEPRECATED_v319(
208     "Use MSG_zone_get_hosts() instead: v3.19 will remove MSG_environment_as_get_hosts() completely.") xbt_dynar_t
209     MSG_environment_as_get_hosts(msg_netzone_t zone)
210 {
211   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), NULL);
212   MSG_zone_get_hosts(zone, res);
213   return res;
214 }
215
216 /************************** File handling ***********************************/
217 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
218 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
219 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
220 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
221 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
222 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
223 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
224 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
225 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
226 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
227 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
228 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
229 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
230 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
231 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
232 /************************** Storage handling ***********************************/
233 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
234 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
235 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
236 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
237 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
238 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value);
239 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
240 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar();
241 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
242 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
243 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
244 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
245 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
246
247 /************************** Host handling ***********************************/
248 XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
249 #define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
250 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
251 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
252 /** \ingroup m_host_management
253  *
254  * \brief Return the name of the #msg_host_t. */
255 #define MSG_host_get_name(host) sg_host_get_name(host)
256 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
257 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
258 XBT_PUBLIC(msg_host_t) MSG_host_self();
259 XBT_PUBLIC(double) MSG_host_get_speed(msg_host_t h);
260 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
261 XBT_PUBLIC(void) MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto);
262 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
263 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
264
265 static inline double
266     XBT_ATTRIB_DEPRECATED_v319("Use MSG_host_get_speed(): v3.19 will drop MSG_get_host_speed() completely.")
267         MSG_get_host_speed(msg_host_t host)
268 {
269   return MSG_host_get_speed(host);
270 }
271 static inline double XBT_ATTRIB_DEPRECATED_v320(
272     "Use MSG_host_get_speed(): v3.20 will drop MSG_host_get_current_power_peak() completely.")
273     MSG_host_get_current_power_peak(msg_host_t host)
274 {
275   return MSG_host_get_speed(host);
276 }
277
278 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
279 XBT_PUBLIC(int)    MSG_host_get_nb_pstates(msg_host_t h);
280 #define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* users don't know that MSG is the C version of SimGrid */
281 #define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* (same here) */
282 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar();
283 XBT_PUBLIC(int) MSG_get_host_number();
284 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
285 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
286 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
287
288 /*property handlers*/
289 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
290 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
291                                                      const char *name);
292 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host, const char* name, char* value);
293
294 XBT_PUBLIC(void) MSG_create_environment(const char *file);
295
296 /************************** Process handling *********************************/
297 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
298                                            xbt_main_func_t code,
299                                            void *data, msg_host_t host);
300 XBT_PUBLIC(msg_process_t)
301 MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
302                                   char** argv);
303 XBT_PUBLIC(msg_process_t)
304 MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
305                                     char** argv, xbt_dict_t properties);
306
307 XBT_PUBLIC(msg_process_t) MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
308 XBT_PUBLIC(void) MSG_process_detach();
309
310 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
311 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
312 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
313 XBT_PUBLIC(void) MSG_process_yield();
314
315 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
316 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
317                                              void *data);
318 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
319 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
320 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
321 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
322 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
323 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
324 XBT_PUBLIC(int) MSG_process_self_PID();
325 XBT_PUBLIC(int) MSG_process_self_PPID();
326 XBT_PUBLIC(const char*) MSG_process_self_name();
327 XBT_PUBLIC(msg_process_t) MSG_process_self();
328 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar();
329 XBT_PUBLIC(int) MSG_process_get_number();
330
331 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
332
333 /*property handlers*/
334 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
335 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
336                                                         process,
337                                                         const char *name);
338
339 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
340 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
341 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
342 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
343 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
344
345 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process);
346 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
347 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process);
348 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process);
349
350 /************************** Task handling ************************************/
351 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
352                                      double flops_amount,
353                                      double bytes_amount, void *data);
354 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
355                                               int host_nb,
356                                               const msg_host_t * host_list,
357                                               double *flops_amount,
358                                               double *bytes_amount,
359                                               void *data);
360 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
361 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
362 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
363     msg_task_t task, msg_process_t src, msg_process_t dst));
364 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
365 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
366 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
367 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
368 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
369 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
370
371 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
372 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
373 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
374 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
375 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
376
377 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
378 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
379
380 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task, double flops_amount);
381 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
382 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount);
383
384 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
385 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
386 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
387
388 XBT_PUBLIC(msg_error_t) MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host);
389
390 XBT_PUBLIC(msg_error_t) MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout);
391
392 XBT_PUBLIC(msg_error_t) MSG_task_receive(msg_task_t* task, const char* alias);
393 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
394
395 XBT_PUBLIC(msg_error_t)
396 MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, double timeout, msg_host_t host, double rate);
397
398 XBT_PUBLIC(msg_error_t)
399 MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout, double rate);
400 XBT_PUBLIC(msg_error_t) MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
401 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
402
403 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
404 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
405 XBT_PUBLIC(msg_comm_t)
406 MSG_task_isend_with_matching(msg_task_t task, const char* alias, int (*match_fun)(void*, void*, void*),
407                              void* match_data);
408
409 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
410 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
411 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
412 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
413 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
414 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
415 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
416 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
417 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout);
418 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
419 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
420 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
421
422 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
423 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout);
424 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate);
425 XBT_PUBLIC(msg_error_t) MSG_task_send(msg_task_t task, const char *alias);
426 XBT_PUBLIC(msg_error_t) MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
427 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
428 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
429 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
430
431 /************************** Mailbox handling ************************************/
432
433 /* @brief MSG_mailbox_set_async - set a mailbox as eager
434  * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
435  * is issued, without waiting for the corresponding receive.
436  * This call should be done before issuing any receive, and on the receiver's side only
437  * @param alias    The alias of the mailbox to modify.
438  */
439 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
440
441 /************************** Action handling **********************************/
442 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
443 XBT_PUBLIC(void) MSG_action_init();
444 XBT_PUBLIC(void) MSG_action_exit();
445
446 /** @brief Opaque type representing a semaphore
447  *  @ingroup msg_synchro
448  *  @hideinitializer
449  */
450 typedef struct s_smx_sem *msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be declared here
451 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
452 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
453 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
454 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
455 XBT_PUBLIC(int) MSG_sem_get_capacity(msg_sem_t sem);
456 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
457 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
458
459 /** @brief Opaque type representing a barrier identifier
460  *  @ingroup msg_synchro
461  *  @hideinitializer
462  */
463
464 #define MSG_BARRIER_SERIAL_PROCESS -1
465 typedef struct s_msg_bar* msg_bar_t;
466 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
467 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
468 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
469
470 /** @brief Opaque type describing a Virtual Machine.
471  *  @ingroup msg_VMs
472  *
473  * All this is highly experimental and the interface will probably change in the future.
474  * Please don't depend on this yet (although testing is welcomed if you feel so).
475  * Usual lack of guaranty of any kind applies here, and is even increased.
476  *
477  */
478
479 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm);
480 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm);
481 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t vm);
482 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm);
483
484 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t vm);
485 XBT_PUBLIC(void) MSG_vm_get_params(msg_vm_t vm, vm_params_t params);
486 XBT_PUBLIC(void) MSG_vm_set_params(msg_vm_t vm, vm_params_t params);
487
488 // TODO add VDI later
489 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
490 XBT_PUBLIC(msg_vm_t) MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount);
491 XBT_PUBLIC(msg_vm_t)
492 MSG_vm_create(msg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity);
493
494 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
495
496 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm);
497
498 /* Shutdown the guest operating system. */
499 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
500
501 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
502
503 /* Suspend the execution of the VM, but keep its state on memory. */
504 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
505 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
506
507 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
508 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
509
510 #include "simgrid/instr.h"
511
512 /* ****************************************************************************************** */
513 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
514 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
515
516 SG_END_DECL()
517
518 #ifdef __cplusplus
519 XBT_PUBLIC(msg_process_t)
520 MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
521                                 std::map<std::string, std::string>* properties);
522 #endif
523
524 #endif