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. */
11 #include "msg/datatypes.h"
13 #include "simgrid/simix.h"
17 /** @brief Return code of most MSG functions
18 @ingroup msg_simulation
20 /* Keep these code as binary values: java bindings manipulate | of these values */
22 MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
23 MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */
24 MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
25 transfer. Either the network is down or the remote host has been
27 MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are
28 running has just been rebooted. Free your datastructures and
30 MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/
34 /************************** Global ******************************************/
35 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
36 /** \ingroup msg_simulation
37 * \brief Initialize the MSG internal data.
40 * It also check that the link-time and compile-time versions of SimGrid do
41 * match, so you should use this version instead of the #MSG_init_nocheck
42 * function that does the same initializations, but without this check.
44 * We allow to link against compiled versions that differ in the patch level.
46 #define MSG_init(argc,argv) { \
47 int ver_major,ver_minor,ver_patch; \
48 sg_version(&ver_major,&ver_minor,&ver_patch); \
49 if ((ver_major != SIMGRID_VERSION_MAJOR) || \
50 (ver_minor != SIMGRID_VERSION_MINOR)) { \
51 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", \
52 SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,ver_major,ver_minor,ver_patch); \
54 MSG_init_nocheck(argc,argv); \
57 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
58 XBT_PUBLIC(msg_error_t) MSG_main(void);
59 XBT_PUBLIC(void) MSG_function_register(const char *name,
60 xbt_main_func_t code);
61 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
62 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
63 XBT_PUBLIC(void) MSG_launch_application(const char *file);
64 /*Bypass the parser */
65 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
66 const char *function_name,
67 xbt_dynar_t arguments);
69 XBT_PUBLIC(double) MSG_get_clock(void);
70 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
72 /************************** Environment ***********************************/
73 XBT_PUBLIC(msg_as_t) MSG_environment_get_routing_root(void);
74 XBT_PUBLIC(const char *) MSG_environment_as_get_name(msg_as_t as);
75 XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as);
76 XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name);
77 XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as);
78 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as);
80 /************************** File handling ***********************************/
81 XBT_PUBLIC(size_t) MSG_file_read(size_t size, msg_file_t fd);
82 XBT_PUBLIC(size_t) MSG_file_write(size_t size, msg_file_t fd);
83 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* mount, const char* path);
84 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
85 XBT_PUBLIC(size_t) MSG_file_get_size(msg_file_t fd);
87 XBT_PUBLIC(int) MSG_file_unlink(msg_file_t fd);
88 XBT_PUBLIC(xbt_dict_t) MSG_file_ls(const char *mount, const char *path);
90 /************************** AS Router handling ************************************/
91 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
92 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
93 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
95 /************************** Host handling ***********************************/
96 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
97 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
98 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
99 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
100 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
101 /* int MSG_get_msgload(void); This function lacks specification; discard it */
102 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
103 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
104 XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h);
105 XBT_PUBLIC(int) MSG_host_is_avail(msg_host_t h);
106 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_priv_t host);
108 XBT_PUBLIC(double) MSG_get_host_power_peak_at(msg_host_t h, int pstate_index);
109 XBT_PUBLIC(double) MSG_get_host_current_power_peak(msg_host_t h);
110 XBT_PUBLIC(int) MSG_get_host_nb_pstates(msg_host_t h);
111 XBT_PUBLIC(void) MSG_set_host_power_peak_at(msg_host_t h, int pstate);
112 XBT_PUBLIC(double) MSG_get_host_consumed_energy(msg_host_t h);
114 /*property handlers*/
115 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
116 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
118 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
119 const char *name, char *value,
120 void_f_pvoid_t free_ctn);
123 XBT_PUBLIC(void) MSG_create_environment(const char *file);
125 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
126 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
127 XBT_PUBLIC(int) MSG_get_host_number(void);
129 /************************** Process handling *********************************/
130 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
131 xbt_main_func_t code,
132 void *data, msg_host_t host);
133 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
139 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
149 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
150 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
152 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
154 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
155 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
157 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
158 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
159 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
160 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
161 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
162 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
163 XBT_PUBLIC(int) MSG_process_self_PID(void);
164 XBT_PUBLIC(int) MSG_process_self_PPID(void);
165 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
166 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
167 XBT_PUBLIC(int) MSG_process_get_number(void);
169 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
171 /*property handlers*/
172 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
173 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
177 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
178 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
179 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
180 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_t fun, void *data);
181 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
183 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
185 /************************** Task handling ************************************/
186 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
187 double compute_duration,
188 double message_size, void *data);
189 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
190 double compute_duration,
191 double dispatch_latency,
192 double collect_latency);
193 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
195 const msg_host_t * host_list,
196 double *computation_amount,
197 double *communication_amount,
199 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
200 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
201 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
202 msg_task_t task, msg_process_t src, msg_process_t dst));
203 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
204 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
205 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
206 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
207 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
208 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
210 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
212 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
213 msg_host_t host, double rate);
215 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
216 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
217 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
219 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
221 XBT_PUBLIC(double) MSG_task_get_compute_duration(msg_task_t task);
222 XBT_PUBLIC(void) MSG_task_set_compute_duration(msg_task_t task,
223 double compute_duration);
224 XBT_PUBLIC(void) MSG_task_set_data_size(msg_task_t task,
227 XBT_PUBLIC(double) MSG_task_get_remaining_computation(msg_task_t task);
228 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
229 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
230 XBT_PUBLIC(double) MSG_task_get_data_size(msg_task_t task);
233 XBT_PUBLIC(msg_error_t)
234 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
237 XBT_PUBLIC(msg_error_t)
238 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
241 XBT_PUBLIC(msg_error_t)
242 MSG_task_receive(msg_task_t * task, const char *alias);
243 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
247 XBT_PUBLIC(msg_error_t)
248 MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
249 msg_host_t host, double rate);
251 XBT_PUBLIC(msg_error_t)
252 MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
253 double timeout, double rate);
255 XBT_PUBLIC(msg_error_t)
256 MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
257 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
259 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
260 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
261 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
263 int (*match_fun)(void*,void*, smx_action_t),
266 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
267 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
268 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
269 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
270 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
271 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
272 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
273 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
274 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
276 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
277 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
278 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
280 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
282 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
285 XBT_PUBLIC(msg_error_t)
286 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
289 XBT_PUBLIC(msg_error_t)
290 MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
291 double timeout, double maxrate);
293 XBT_PUBLIC(msg_error_t)
294 MSG_task_send(msg_task_t task, const char *alias);
296 XBT_PUBLIC(msg_error_t)
297 MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
299 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
301 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
302 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
304 /************************** Task handling ************************************/
305 XBT_PUBLIC(msg_error_t)
306 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
307 msg_host_t host, double timeout);
309 XBT_PUBLIC(msg_error_t)
310 MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
311 msg_host_t host, double timeout, double rate);
313 XBT_PUBLIC(msg_error_t)
314 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
317 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
320 /************************** Action handling **********************************/
321 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
323 #ifdef MSG_USE_DEPRECATED
325 typedef msg_error_t MSG_error_t;
327 #define MSG_global_init(argc, argv) MSG_init(argc,argv)
328 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
330 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
331 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
333 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
334 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
335 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
336 MSG_mailbox_put_with_timeout(mailbox, task, timeout)
338 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
339 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
341 XBT_PUBLIC(msg_error_t) MSG_clean(void);
343 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
344 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
346 double max_duration);
347 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
348 int channel, msg_host_t host);
349 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
352 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
353 m_channel_t channel);
354 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
358 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
361 double max_duration);
362 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
363 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
364 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
366 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
367 XBT_PUBLIC(int) MSG_get_channel_number(void);
370 /** @brief Opaque type representing a semaphore
371 * @ingroup msg_synchro
374 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
375 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
376 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
377 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
378 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
379 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
380 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
381 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
383 /** @brief Opaque type describing a Virtual Machine.
386 * All this is highly experimental and the interface will probably change in the future.
387 * Please don't depend on this yet (although testing is welcomed if you feel so).
388 * Usual lack of guaranty of any kind applies here, and is even increased.
391 /* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/
392 XBT_PUBLIC(msg_vm_t) MSG_vm_start(msg_host_t location, const char *name, int coreAmount);
394 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
395 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
397 XBT_PUBLIC(void) MSG_vm_bind(msg_vm_t vm, msg_process_t process);
398 XBT_PUBLIC(void) MSG_vm_unbind(msg_vm_t vm, msg_process_t process); // simple wrapper over process_kill
400 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
402 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
403 // \forall p in VM, MSG_process_suspend(p) // Freeze the processes
405 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm); // Simulate the fact of reading the processes from disk and resuming them
406 // \forall p in VM, MSG_process_resume(p) // unfreeze them
408 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); // killall
410 XBT_PUBLIC(void) MSG_vm_reboot(msg_vm_t vm);
412 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
414 XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
417 void* MSG_process_get_property(msg_process_t, char* key)
418 void MSG_process_set_property(msg_process_t, char* key, void* data)
419 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
421 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
422 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
423 // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
424 // <100 si c'est pas CPU intensive)
425 // Contraintes à poser:
426 // HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
427 // VM_coreAmount >= Load de toutes les tasks
431 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
432 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
433 + des fonctions de filtrage sur les dynar
435 #include "instr/instr.h"
439 /* ****************************************************************************************** */
440 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
441 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
443 /* ****************************************************************************************** */
444 /* TUTORIAL: New API */
445 /* Declare all functions for the API */
446 /* ****************************************************************************************** */
447 XBT_PUBLIC(int) MSG_new_API_fct(const char* param1, double param2);