1 /* Copyright (c) 2004-2015. 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/forward.h"
13 #include "simgrid/simix.h"
14 #include "simgrid/platf.h"
18 /* ******************************** Mailbox ************************************ */
20 /** @brief Mailbox datatype
21 * @ingroup msg_task_usage
23 * Object representing a communication rendez-vous point, on which
24 * the sender finds the receiver it wants to communicate with. As a
25 * MSG user, you will only rarely manipulate any of these objects
26 * directly, since most of the public interface (such as
27 * #MSG_task_send and friends) hide this object behind a string
28 * alias. That mean that you don't provide the mailbox on which you
29 * want to send your task, but only the name of this mailbox. */
30 typedef struct s_smx_rvpoint *msg_mailbox_t;
32 /* ******************************** Environment ************************************ */
33 typedef surf_As *msg_as_t;
35 /* ******************************** Host ************************************ */
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 sg_host_t msg_host_t;
49 typedef struct s_msg_host_priv {
52 double dp_updated_by_deleted_tasks;
55 xbt_dict_t affinity_mask_db;
56 xbt_dynar_t file_descriptor_table;
58 #ifdef MSG_USE_DEPRECATED
59 msg_mailbox_t *mailboxes; /**< the channels */
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 */
71 long long int counter; /* task unique identifier for instrumentation */
72 char *category; /* task category for instrumentation */
75 /** @brief Task datatype.
76 @ingroup m_task_management
78 A <em>task</em> may then be defined by a <em>computing
79 amount</em>, a <em>message size</em> and some <em>private
82 typedef struct msg_task *msg_task_t;
84 /* ******************************** VM ************************************* */
85 typedef msg_host_t msg_vm_t;
87 /** ******************************** File ************************************ */
89 /** @brief File datatype.
90 * @ingroup msg_file_management
92 * You should consider this as an opaque object.
94 typedef xbt_dictelm_t msg_file_t;
95 typedef s_xbt_dictelm_t s_msg_file_t;
97 extern int MSG_FILE_LEVEL;
98 typedef struct simdata_file *simdata_file_t;
100 typedef struct msg_file_priv {
109 simdata_file_t simdata;
110 } s_msg_file_priv_t, *msg_file_priv_t;
112 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
113 return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
116 /* ******************************** Storage ************************************ */
117 /* TODO: PV: to comment */
119 extern int MSG_STORAGE_LEVEL;
121 /** @brief Storage datatype.
122 * @ingroup msg_storage_management
124 * You should consider this as an opaque object.
126 typedef xbt_dictelm_t msg_storage_t;
127 typedef s_xbt_dictelm_t s_msg_storage_t;
129 typedef struct msg_storage_priv {
130 const char *hostname;
132 } s_msg_storage_priv_t, *msg_storage_priv_t;
134 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
135 return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
138 /*************** Begin GPU ***************/
139 typedef struct simdata_gpu_task *simdata_gpu_task_t;
141 typedef struct msg_gpu_task {
142 char *name; /**< @brief task name if any */
143 simdata_gpu_task_t simdata; /**< @brief simulator data */
144 long long int counter; /* task unique identifier for instrumentation */
145 char *category; /* task category for instrumentation */
148 /** @brief GPU task datatype.
149 @ingroup m_task_management
151 A <em>task</em> may then be defined by a <em>computing
152 amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
153 \see m_task_management
155 typedef struct msg_gpu_task *msg_gpu_task_t;
156 /*************** End GPU ***************/
159 * \brief @brief Communication action.
160 * \ingroup msg_task_usage
162 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
164 typedef struct msg_comm *msg_comm_t;
166 /** \brief Default value for an uninitialized #msg_task_t.
167 \ingroup m_task_management
169 #define MSG_TASK_UNINITIALIZED NULL
171 /* ****************************** Process *********************************** */
173 /** @brief Process datatype.
174 @ingroup m_process_management
176 A process may be defined as a <em>code</em>, with some
177 <em>private data</em>, executing in a <em>location</em>.
179 You should not access directly to the fields of the pointed
180 structure, but always use the provided API to interact with
183 typedef struct s_smx_process *msg_process_t;
185 #ifdef MSG_USE_DEPRECATED
187 /* Compatibility typedefs */
188 typedef int m_channel_t;
189 typedef msg_gpu_task_t m_gpu_task_t;
190 typedef msg_host_t m_host_t;
191 typedef msg_process_t m_process_t;
192 typedef msg_task_t m_task_t;
193 typedef s_msg_gpu_task_t s_m_gpu_task_t;
194 typedef s_msg_host_t s_m_host_t;
195 typedef s_msg_task_t s_m_task_t;
198 /** @brief Return code of most MSG functions
199 @ingroup msg_simulation
201 /* Keep these code as binary values: java bindings manipulate | of these values */
203 MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
204 MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */
205 MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
206 transfer. Either the network is down or the remote host has been
208 MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are
209 running has just been rebooted. Free your datastructures and
211 MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/
215 /************************** Global ******************************************/
216 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
217 /** \ingroup msg_simulation
218 * \brief Initialize the MSG internal data.
221 * It also check that the link-time and compile-time versions of SimGrid do
222 * match, so you should use this version instead of the #MSG_init_nocheck
223 * function that does the same initializations, but without this check.
225 * We allow to link against compiled versions that differ in the patch level.
227 #define MSG_init(argc,argv) do { \
228 sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
229 MSG_init_nocheck(argc,argv); \
232 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
233 XBT_PUBLIC(msg_error_t) MSG_main(void);
234 XBT_PUBLIC(void) MSG_function_register(const char *name,
235 xbt_main_func_t code);
236 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
237 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
238 XBT_PUBLIC(void) MSG_launch_application(const char *file);
239 /*Bypass the parser */
240 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
241 const char *function_name,
242 xbt_dynar_t arguments);
244 XBT_PUBLIC(double) MSG_get_clock(void);
245 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
247 /************************** Environment ***********************************/
248 XBT_PUBLIC(msg_as_t) MSG_environment_get_routing_root(void);
249 XBT_PUBLIC(const char *) MSG_environment_as_get_name(msg_as_t as);
250 XBT_PUBLIC(msg_as_t) MSG_environment_as_get_by_name(const char * name);
251 XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as);
252 XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name);
253 XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as);
254 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as);
256 /************************** File handling ***********************************/
257 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
258 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
259 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
260 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
261 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
262 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
263 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
264 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
265 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
266 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
267 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
268 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
269 XBT_PUBLIC(void) __MSG_file_priv_free(msg_file_priv_t priv);
270 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
271 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
272 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
273 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
274 /************************** Storage handling ***********************************/
275 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
276 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
277 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
278 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
279 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
280 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn);
281 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
282 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar(void);
283 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
284 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
285 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
286 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
287 XBT_PUBLIC(msg_error_t) MSG_storage_file_move(msg_file_t fd, msg_host_t dest, char* mount, char* fullname);
288 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
289 /************************** AS Router handling ************************************/
290 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
291 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
292 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
294 /************************** Host handling ***********************************/
295 XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
296 #define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
297 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
298 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
299 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
300 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
301 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
302 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
303 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
304 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
305 XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h);
306 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
307 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
308 XBT_PUBLIC(double) MSG_host_get_wattmin_at(msg_host_t host, int pstate);
309 XBT_PUBLIC(double) MSG_host_get_wattmax_at(msg_host_t host, int pstate);
311 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_t host);
313 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
314 XBT_PUBLIC(double) MSG_host_get_current_power_peak(msg_host_t h);
315 XBT_PUBLIC(int) MSG_host_get_nb_pstates(msg_host_t h);
316 XBT_PUBLIC(void) MSG_host_set_pstate(msg_host_t h, int pstate);
317 XBT_PUBLIC(int) MSG_host_get_pstate(msg_host_t host);
318 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
319 XBT_PUBLIC(int) MSG_get_host_number(void);
320 XBT_PUBLIC(void) MSG_host_get_params(msg_host_t ind_pm, vm_params_t params);
321 XBT_PUBLIC(void) MSG_host_set_params(msg_host_t ind_pm, vm_params_t params);
322 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
323 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
324 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
326 XBT_PUBLIC(double) MSG_host_get_consumed_energy(msg_host_t h);
328 /*property handlers*/
329 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
330 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
332 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
333 const char *name, char *value,
334 void_f_pvoid_t free_ctn);
337 XBT_PUBLIC(void) MSG_create_environment(const char *file);
339 /************************** Process handling *********************************/
340 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
341 xbt_main_func_t code,
342 void *data, msg_host_t host);
343 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
349 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
359 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
360 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
361 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
363 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
364 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
366 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
367 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
368 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
369 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
370 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
371 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
372 XBT_PUBLIC(int) MSG_process_self_PID(void);
373 XBT_PUBLIC(int) MSG_process_self_PPID(void);
374 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
375 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
376 XBT_PUBLIC(int) MSG_process_get_number(void);
378 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
380 /*property handlers*/
381 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
382 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
386 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
387 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
388 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
389 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
390 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
392 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
394 /************************** Task handling ************************************/
395 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
397 double bytes_amount, void *data);
398 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
400 double dispatch_latency,
401 double collect_latency);
402 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
404 const msg_host_t * host_list,
405 double *flops_amount,
406 double *bytes_amount,
408 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
409 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
410 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
411 msg_task_t task, msg_process_t src, msg_process_t dst));
412 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
413 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
414 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
415 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
416 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
417 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
419 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
421 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
422 msg_host_t host, double rate);
424 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
425 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
426 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
427 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
428 XBT_PUBLIC(void) MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask);
430 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
431 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
433 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task,
434 double flops_amount);
435 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
436 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task,
437 double bytes_amount);
439 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
440 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
441 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
444 XBT_PUBLIC(msg_error_t)
445 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
448 XBT_PUBLIC(msg_error_t)
449 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
452 XBT_PUBLIC(msg_error_t)
453 MSG_task_receive(msg_task_t * task, const char *alias);
454 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
458 XBT_PUBLIC(msg_error_t)
459 MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
460 msg_host_t host, double rate);
462 XBT_PUBLIC(msg_error_t)
463 MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
464 double timeout, double rate);
466 XBT_PUBLIC(msg_error_t)
467 MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
468 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
470 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
471 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
472 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
474 int (*match_fun)(void*,void*, smx_synchro_t),
477 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
478 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
479 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
480 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
481 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
482 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
483 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
484 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
485 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
487 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
488 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
489 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
491 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
493 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
496 XBT_PUBLIC(msg_error_t)
497 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
500 XBT_PUBLIC(msg_error_t)
501 MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
502 double timeout, double maxrate);
504 XBT_PUBLIC(msg_error_t)
505 MSG_task_send(msg_task_t task, const char *alias);
507 XBT_PUBLIC(msg_error_t)
508 MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
510 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
512 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
513 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
515 /************************** Task handling ************************************/
516 XBT_PUBLIC(msg_error_t)
517 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
518 msg_host_t host, double timeout);
520 XBT_PUBLIC(msg_error_t)
521 MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
522 msg_host_t host, double timeout, double rate);
524 XBT_PUBLIC(msg_error_t)
525 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
528 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
531 /************************** Action handling **********************************/
532 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
533 XBT_PUBLIC(void) MSG_action_init(void);
534 XBT_PUBLIC(void) MSG_action_exit(void);
536 #ifdef MSG_USE_DEPRECATED
538 typedef msg_error_t MSG_error_t;
540 #define MSG_global_init(argc, argv) MSG_init(argc,argv)
541 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
543 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
544 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
546 #define MSG_host_is_avail(h) MSG_host_is_on(h)
548 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
549 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
550 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
551 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
553 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
554 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
556 XBT_PUBLIC(msg_error_t) MSG_clean(void);
558 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
559 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
561 double max_duration);
562 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
563 int channel, msg_host_t host);
564 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
567 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
568 m_channel_t channel);
569 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
573 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
576 double max_duration);
577 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
578 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
579 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
581 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
582 XBT_PUBLIC(int) MSG_get_channel_number(void);
585 /** @brief Opaque type representing a semaphore
586 * @ingroup msg_synchro
589 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
590 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
591 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
592 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
593 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
594 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
595 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
596 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
598 /** @brief Opaque type representing a barrier identifier
599 * @ingroup msg_synchro
603 #define MSG_BARRIER_SERIAL_PROCESS -1
604 typedef struct s_xbt_bar *msg_bar_t;
605 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
606 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
607 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
609 /** @brief Opaque type describing a Virtual Machine.
612 * All this is highly experimental and the interface will probably change in the future.
613 * Please don't depend on this yet (although testing is welcomed if you feel so).
614 * Usual lack of guaranty of any kind applies here, and is even increased.
618 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
619 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
620 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
622 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
623 XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
624 XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
625 XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
628 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
630 // TODO add VDI later
631 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
632 XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
633 int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size, int mig_netspeed, int dp_intensity);
635 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
637 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
639 /* Shutdown the guest operating system. */
640 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
642 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
644 /* Suspend the execution of the VM, but keep its state on memory. */
645 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
646 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
648 /* Save the VM state to a disk. */
649 XBT_PUBLIC(void) MSG_vm_save(msg_vm_t vm);
650 XBT_PUBLIC(void) MSG_vm_restore(msg_vm_t vm);
652 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
653 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
654 XBT_PUBLIC(void) MSG_vm_set_affinity(msg_vm_t vm, msg_host_t pm, unsigned long mask);
656 /* TODO: do we need this? */
657 // XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
660 void* MSG_process_get_property(msg_process_t, char* key)
661 void MSG_process_set_property(msg_process_t, char* key, void* data)
662 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
664 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
665 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
666 // inducedLoad: a percentage (>100 if it loads more than one core;
667 // <100 if it's not CPU intensive)
668 // Required contraints:
669 // HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
670 // VM_coreAmount >= Load of all tasks
674 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
675 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
676 + filtering functions on dynars
678 #include "simgrid/instr.h"
682 /* ****************************************************************************************** */
683 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
684 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);