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. */
12 #include "simgrid/simix.h"
13 #include "simgrid/platf.h"
17 /* ******************************** Mailbox ************************************ */
19 /** @brief Mailbox datatype
20 * @ingroup msg_task_usage
22 * Object representing a communication rendez-vous point, on which
23 * the sender finds the receiver it wants to communicate with. As a
24 * MSG user, you will only rarely manipulate any of these objects
25 * directly, since most of the public interface (such as
26 * #MSG_task_send and friends) hide this object behind a string
27 * alias. That mean that you don't provide the mailbox on which you
28 * want to send your task, but only the name of this mailbox. */
29 typedef struct s_smx_rvpoint *msg_mailbox_t;
31 /* ******************************** Environment ************************************ */
32 typedef struct As *msg_as_t;
34 /* ******************************** Host ************************************ */
36 extern int MSG_HOST_LEVEL;
38 /** @brief Host datatype.
39 @ingroup m_host_management
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
48 typedef xbt_dictelm_t msg_host_t;
49 typedef s_xbt_dictelm_t s_msg_host_t;
51 typedef struct msg_host_priv {
54 double dp_updated_by_deleted_tasks;
57 xbt_dict_t affinity_mask_db;
59 #ifdef MSG_USE_DEPRECATED
60 msg_mailbox_t *mailboxes; /**< the channels */
62 } s_msg_host_priv_t, *msg_host_priv_t;
64 static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
65 return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
70 /* ******************************** Task ************************************ */
72 typedef struct simdata_task *simdata_task_t;
74 typedef struct msg_task {
75 char *name; /**< @brief task name if any */
76 simdata_task_t simdata; /**< @brief simulator data */
77 void *data; /**< @brief user data */
78 long long int counter; /* task unique identifier for instrumentation */
79 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 ************************************ */
101 /** @brief File datatype.
102 * @ingroup msg_file_management
104 * You should consider this as an opaque object.
106 typedef xbt_dictelm_t msg_file_t;
107 typedef s_xbt_dictelm_t s_msg_file_t;
109 extern int MSG_FILE_LEVEL;
110 typedef struct simdata_file *simdata_file_t;
112 typedef struct msg_file_priv {
120 simdata_file_t simdata;
121 } s_msg_file_priv_t, *msg_file_priv_t;
123 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
124 return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
127 /* ******************************** Storage ************************************ */
128 /* TODO: PV: to comment */
130 extern int MSG_STORAGE_LEVEL;
132 /** @brief Storage datatype.
133 * @ingroup msg_storage_management
135 * You should consider this as an opaque object.
137 typedef xbt_dictelm_t msg_storage_t;
138 typedef s_xbt_dictelm_t s_msg_storage_t;
140 typedef struct msg_storage_priv {
141 const char *hostname;
143 } s_msg_storage_priv_t, *msg_storage_priv_t;
145 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
146 return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
149 /*************** Begin GPU ***************/
150 typedef struct simdata_gpu_task *simdata_gpu_task_t;
152 typedef struct msg_gpu_task {
153 char *name; /**< @brief task name if any */
154 simdata_gpu_task_t simdata; /**< @brief simulator data */
155 long long int counter; /* task unique identifier for instrumentation */
156 char *category; /* task category for instrumentation */
159 /** @brief GPU task datatype.
160 @ingroup m_task_management
162 A <em>task</em> may then be defined by a <em>computing
163 amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
164 \see m_task_management
166 typedef struct msg_gpu_task *msg_gpu_task_t;
167 /*************** End GPU ***************/
170 * \brief @brief Communication action.
171 * \ingroup msg_task_usage
173 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
175 typedef struct msg_comm *msg_comm_t;
177 /** \brief Default value for an uninitialized #msg_task_t.
178 \ingroup m_task_management
180 #define MSG_TASK_UNINITIALIZED NULL
182 /* ****************************** Process *********************************** */
184 /** @brief Process datatype.
185 @ingroup m_process_management
187 A process may be defined as a <em>code</em>, with some
188 <em>private data</em>, executing in a <em>location</em>.
190 You should not access directly to the fields of the pointed
191 structure, but always use the provided API to interact with
194 typedef struct s_smx_process *msg_process_t;
196 #ifdef MSG_USE_DEPRECATED
198 /* Compatibility typedefs */
199 typedef int m_channel_t;
200 typedef msg_gpu_task_t m_gpu_task_t;
201 typedef msg_host_t m_host_t;
202 typedef msg_process_t m_process_t;
203 typedef msg_task_t m_task_t;
204 typedef s_msg_gpu_task_t s_m_gpu_task_t;
205 typedef s_msg_host_t s_m_host_t;
206 typedef s_msg_task_t s_m_task_t;
209 /** @brief Return code of most MSG functions
210 @ingroup msg_simulation
212 /* Keep these code as binary values: java bindings manipulate | of these values */
214 MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
215 MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */
216 MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
217 transfer. Either the network is down or the remote host has been
219 MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are
220 running has just been rebooted. Free your datastructures and
222 MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/
226 /************************** Global ******************************************/
227 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
228 /** \ingroup msg_simulation
229 * \brief Initialize the MSG internal data.
232 * It also check that the link-time and compile-time versions of SimGrid do
233 * match, so you should use this version instead of the #MSG_init_nocheck
234 * function that does the same initializations, but without this check.
236 * We allow to link against compiled versions that differ in the patch level.
238 #define MSG_init(argc,argv) { \
239 int ver_major,ver_minor,ver_patch; \
240 sg_version(&ver_major,&ver_minor,&ver_patch); \
241 if ((ver_major != SIMGRID_VERSION_MAJOR) || \
242 (ver_minor != SIMGRID_VERSION_MINOR)) { \
243 fprintf(stderr,"FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, and then linked against SimGrid %d.%d.%d. Please fix this.\n", \
244 SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,ver_major,ver_minor,ver_patch); \
246 MSG_init_nocheck(argc,argv); \
249 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
250 XBT_PUBLIC(msg_error_t) MSG_main(void);
251 XBT_PUBLIC(void) MSG_function_register(const char *name,
252 xbt_main_func_t code);
253 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
254 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
255 XBT_PUBLIC(void) MSG_launch_application(const char *file);
256 /*Bypass the parser */
257 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
258 const char *function_name,
259 xbt_dynar_t arguments);
261 XBT_PUBLIC(double) MSG_get_clock(void);
262 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
264 /************************** Environment ***********************************/
265 XBT_PUBLIC(msg_as_t) MSG_environment_get_routing_root(void);
266 XBT_PUBLIC(const char *) MSG_environment_as_get_name(msg_as_t as);
267 XBT_PUBLIC(msg_as_t) MSG_environment_as_get_by_name(const char * name);
268 XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as);
269 XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name);
270 XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as);
271 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as);
273 /************************** File handling ***********************************/
274 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
275 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
276 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
277 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
278 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
279 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
280 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
281 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
282 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
283 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
284 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
285 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
286 XBT_PUBLIC(void) __MSG_file_priv_free(msg_file_priv_t priv);
287 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t storage);
288 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
289 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
290 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
291 /************************** Storage handling ***********************************/
292 XBT_PUBLIC(msg_host_t) MSG_get_storage_by_name(const char *name);
293 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
294 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
295 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
296 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
297 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
298 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn);
299 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
300 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar(void);
301 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
302 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
303 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
304 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
305 XBT_PUBLIC(msg_error_t) MSG_storage_file_move(msg_file_t fd, msg_host_t dest, char* mount, char* fullname);
306 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
307 /************************** AS Router handling ************************************/
308 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
309 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
310 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
312 /************************** Host handling ***********************************/
313 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
314 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
315 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
316 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
317 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
318 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
319 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
320 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
321 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
322 XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h);
323 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
324 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
325 XBT_PUBLIC(void) __MSG_host_priv_free(msg_host_priv_t priv);
326 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_t host);
328 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
329 XBT_PUBLIC(double) MSG_host_get_current_power_peak(msg_host_t h);
330 XBT_PUBLIC(int) MSG_host_get_pstate_number(msg_host_t h);
331 XBT_PUBLIC(void) MSG_host_set_pstate(msg_host_t h, int pstate);
332 XBT_PUBLIC(double) MSG_host_get_consumed_energy(msg_host_t h);
334 /*property handlers*/
335 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
336 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
338 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
339 const char *name, char *value,
340 void_f_pvoid_t free_ctn);
343 XBT_PUBLIC(void) MSG_create_environment(const char *file);
345 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
346 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
347 XBT_PUBLIC(int) MSG_get_host_number(void);
348 XBT_PUBLIC(void) MSG_host_get_params(msg_host_t ind_pm, ws_params_t params);
349 XBT_PUBLIC(void) MSG_host_set_params(msg_host_t ind_pm, ws_params_t params);
350 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
351 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
352 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
353 /************************** Process handling *********************************/
354 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
355 xbt_main_func_t code,
356 void *data, msg_host_t host);
357 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
363 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
373 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
374 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
375 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
377 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
378 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
380 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
381 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
382 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
383 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
384 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
385 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
386 XBT_PUBLIC(int) MSG_process_self_PID(void);
387 XBT_PUBLIC(int) MSG_process_self_PPID(void);
388 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
389 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
390 XBT_PUBLIC(int) MSG_process_get_number(void);
392 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
394 /*property handlers*/
395 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
396 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
400 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
401 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
402 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
403 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
404 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
406 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
408 /************************** Task handling ************************************/
409 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
411 double bytes_amount, void *data);
412 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
414 double dispatch_latency,
415 double collect_latency);
416 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
418 const msg_host_t * host_list,
419 double *flops_amount,
420 double *bytes_amount,
422 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
423 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
424 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
425 msg_task_t task, msg_process_t src, msg_process_t dst));
426 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
427 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
428 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
429 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
430 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
431 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
433 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
435 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
436 msg_host_t host, double rate);
438 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
439 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
440 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
441 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
442 XBT_PUBLIC(void) MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask);
444 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
445 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
447 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task,
448 double flops_amount);
449 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
450 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task,
451 double bytes_amount);
453 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
454 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
455 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
458 XBT_PUBLIC(msg_error_t)
459 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
462 XBT_PUBLIC(msg_error_t)
463 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
466 XBT_PUBLIC(msg_error_t)
467 MSG_task_receive(msg_task_t * task, const char *alias);
468 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
472 XBT_PUBLIC(msg_error_t)
473 MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
474 msg_host_t host, double rate);
476 XBT_PUBLIC(msg_error_t)
477 MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
478 double timeout, double rate);
480 XBT_PUBLIC(msg_error_t)
481 MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
482 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
484 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
485 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
486 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
488 int (*match_fun)(void*,void*, smx_synchro_t),
491 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
492 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
493 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
494 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
495 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
496 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
497 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
498 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
499 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
501 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
502 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
503 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
505 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
507 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
510 XBT_PUBLIC(msg_error_t)
511 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
514 XBT_PUBLIC(msg_error_t)
515 MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
516 double timeout, double maxrate);
518 XBT_PUBLIC(msg_error_t)
519 MSG_task_send(msg_task_t task, const char *alias);
521 XBT_PUBLIC(msg_error_t)
522 MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
524 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
526 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
527 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
529 /************************** Task handling ************************************/
530 XBT_PUBLIC(msg_error_t)
531 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
532 msg_host_t host, double timeout);
534 XBT_PUBLIC(msg_error_t)
535 MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
536 msg_host_t host, double timeout, double rate);
538 XBT_PUBLIC(msg_error_t)
539 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
542 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
545 /************************** Action handling **********************************/
546 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
547 XBT_PUBLIC(void) MSG_action_init(void);
548 XBT_PUBLIC(void) MSG_action_exit(void);
550 #ifdef MSG_USE_DEPRECATED
552 typedef msg_error_t MSG_error_t;
554 #define MSG_global_init(argc, argv) MSG_init(argc,argv)
555 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
557 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
558 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
560 #define MSG_host_is_avail(h) MSG_host_is_on(h)
562 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
563 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
564 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
565 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
567 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
568 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
570 XBT_PUBLIC(msg_error_t) MSG_clean(void);
572 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
573 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
575 double max_duration);
576 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
577 int channel, msg_host_t host);
578 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
581 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
582 m_channel_t channel);
583 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
587 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
590 double max_duration);
591 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
592 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
593 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
595 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
596 XBT_PUBLIC(int) MSG_get_channel_number(void);
599 /** @brief Opaque type representing a semaphore
600 * @ingroup msg_synchro
603 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
604 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
605 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
606 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
607 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
608 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
609 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
610 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
612 /** @brief Opaque type representing a barrier identifier
613 * @ingroup msg_synchro
617 #define MSG_BARRIER_SERIAL_PROCESS -1
618 typedef struct s_xbt_bar *msg_bar_t;
619 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
620 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
621 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
623 /** @brief Opaque type describing a Virtual Machine.
626 * All this is highly experimental and the interface will probably change in the future.
627 * Please don't depend on this yet (although testing is welcomed if you feel so).
628 * Usual lack of guaranty of any kind applies here, and is even increased.
632 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
633 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
634 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
636 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
637 XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
638 XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
639 XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
642 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
644 // TODO add VDI later
645 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
646 XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
647 int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size, int mig_netspeed, int dp_intensity);
649 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
651 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
653 /* Shutdown the guest operating system. */
654 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
656 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
658 /* Suspend the execution of the VM, but keep its state on memory. */
659 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
660 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
662 /* Save the VM state to a disk. */
663 XBT_PUBLIC(void) MSG_vm_save(msg_vm_t vm);
664 XBT_PUBLIC(void) MSG_vm_restore(msg_vm_t vm);
666 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
667 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
668 XBT_PUBLIC(void) MSG_vm_set_affinity(msg_vm_t vm, msg_host_t pm, unsigned long mask);
670 /* TODO: do we need this? */
671 // XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
674 void* MSG_process_get_property(msg_process_t, char* key)
675 void MSG_process_set_property(msg_process_t, char* key, void* data)
676 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
678 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
679 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
680 // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
681 // <100 si c'est pas CPU intensive)
682 // Contraintes à poser:
683 // HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
684 // VM_coreAmount >= Load de toutes les tasks
688 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
689 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
690 + des fonctions de filtrage sur les dynar
692 #include "simgrid/instr.h"
696 /* ****************************************************************************************** */
697 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
698 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);